EnergyManagementV3Api class abstract
- Inheritance
-
- Object
- ChopperService
- EnergyManagementV3Api
- Available extensions
- Annotations
-
- @ChopperApi()
Constructors
Properties
- client ↔ ChopperClient
-
getter/setter pairinherited
- definitionType → Type
-
Used internally to retrieve the service from ChopperClient.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
kemApiV31nceEventsPost(
{required List< OnceEventV3Body> ? body}) → Future<Response> - Event hook endpoint that should be called by 1NCE to get event records.
-
kemApiV3DealerAppFeedbackStatusGet(
) → Future< Response< FeedbackStatusDTO> > - Returns whether the currently logged-in dealer user can submit app feedback.
-
kemApiV3DealerAppSubmitFeedbackPost(
{required FeedbackSubmissionV3Body? body}) → Future< Response> - Submit feedback and rating from the dealer app.
-
kemApiV3DealerAppUpdatePlanGet(
{String? version, int? buildNumber}) → Future< Response< AppUpdatePlanDTO> > - Get the current app update plan, including whether an upgrade is recommended or required. @param version App version (e.g., 1.4.3) @param buildNumber App build number (e.g., 20301)
-
kemApiV3DealerCellkitRenewalOrdersGet(
{String? requestId}) → Future< Response< List< >CellKitOrderDTO> > - @param requestId
-
kemApiV3DealerCellkitRenewalRequestsPost(
{required List< String> ? body}) → Future<Response< CellKitRenewalDTO> > -
kemApiV3DealerDevicesApprovePost(
{required DeviceBulkV3Body? body}) → Future< Response> - Approve a list of device that already exists within the dealer's fleet.
-
kemApiV3DealerDevicesBulkPost(
{required DeviceBulkV3Body? body}) → Future< Response> - Add devices to a dealer's organization in bulk.
-
kemApiV3DealerDevicesGet(
{String? filterText, List< String> ? serialNumbers, List<int> ? ids, int? limit, int? offset}) → Future<Response< List< >DeviceDTO> > - Get the list of devices assigned to the dealer organization of the logged-in user.
-
kemApiV3DealerDevicesIdApprovePost(
{required int? id}) → Future< Response> - Approve an device that already exists within the dealer's fleet.
-
kemApiV3DealerDevicesIdDelete(
{required int? id}) → Future< Response> - Delete the device with the given user ID from the fleet of the dealer organization of the currently logged-in user.
-
kemApiV3DealerDevicesPost(
{required DealerDeviceAdditionV3Body? body}) → Future< Response> - Add a device to the fleet of the dealer organization of the currently logged-in user.
-
kemApiV3DealerDevicesSearchPost(
{required DealerDeviceSearchV3Body? body}) → Future< Response< List< >DeviceDTO> > - Search and return a list of devices based on input search parameters.
-
kemApiV3DealerMeGet(
) → Future< Response< DealerUserDTO> > - Get dealer user information for the currently logged-in user.
-
kemApiV3DealerOrgGet(
) → Future< Response< DealerOrgDTO> > - Get dealer organization information for the org of the currently logged-in user.
-
kemApiV3DealerOrgPut(
{required DealerOrgUpdateV3Body? body}) → Future< Response< DealerOrgDTO> > - Update the details of the dealer organization of the currently logged-in user
-
kemApiV3DealerSettingsNotificationGet(
) → Future< Response< DealerNotificationSettingsDTO> > - Get notification settings for the currently logged-in dealer user.
-
kemApiV3DealerSettingsNotificationPost(
{required DealerNotificationSettingsUpdateV3Body? body}) → Future< Response> - Update notification settings for the currently logged-in dealer user.
-
kemApiV3DealerUnapprovedDevicesGet(
{String? filterText, List< String> ? serialNumbers, List<int> ? ids, int? limit, int? offset}) → Future<Response< List< >DeviceDTO> > - Get the list of unapproved devices assigned to the dealer organization of the logged-in user. @param filterText @param serialNumbers @param ids @param limit @param offset
-
kemApiV3DealerUsersGet(
{List< String> ? emails, List<int> ? ids, RoleDTO? role}) → Future<Response< List< >DealerUserDTO> > - Get the list of dealer users within the dealer org of the currently logged-in user.
-
kemApiV3DealerUsersIdDelete(
{required int? id}) → Future< Response> - Delete the user with the given user ID.
-
kemApiV3DealerUsersIdGet(
{required int? id}) → Future< Response< DealerUserDTO> > - Get dealer user information for the user with the given user ID.
-
kemApiV3DealerUsersIdPut(
{required int? id, required DealerUserUpdateV3Body? body}) → Future< Response< DealerUserDTO> > - Update the details of a user with the given user ID.
-
kemApiV3DealerUsersIdResendInvitePost(
{required int? id}) → Future< Response> - Resend a marketing cloud invitation to a user, to allow them to login and access the Energy Management platform.
-
kemApiV3DealerUsersPost(
{required DealerUserCreateV3Body? body}) → Future< Response< DealerUserDTO> > - Create a user and add the user to the dealer organization of the currently logged-in user.
-
kemApiV3DevicesAddressGet(
{String? address}) → Future< Response< List< >AddressDTO> > - Search and return a list of address results based on an input partial address string. @param address
-
kemApiV3DevicesHomehubConfigureConnectionPost(
{required UpdateHomeHubConnectionV3Body? body}) → Future< Response> -
kemApiV3DevicesIdAlertsGet(
{required int? id, DeviceHostDTO? sourceDeviceHost}) → Future< Response< List< >AlertDTO> > - @param id @param sourceDeviceHost The cloud architecture which the device is connected to.
-
kemApiV3DevicesIdAlertsResetPost(
{required int? id}) → Future< Response> - Resets shutdown faults of the device with the given ID @param id
-
kemApiV3DevicesIdConnectionHistoryGet(
{required int? id}) → Future< Response< List< >ConnectionLogDTO> > - Get list of connection history for a device @param id
-
kemApiV3DevicesIdConnectionResetPost(
{required int? id}) → Future< Response> - Resets connection for the device with the given ID @param id
-
kemApiV3DevicesIdDevicehostPost(
{required int? id, required DeviceHostUpdateV3Body? body}) → Future< Response> - setting the device host of a device given ID. @param id
-
kemApiV3DevicesIdEventsGet(
{required int? id, DeviceHostDTO? sourceDeviceHost}) → Future< Response< List< >EventDTO> > - @param id @param sourceDeviceHost The cloud architecture which the device is connected to.
-
kemApiV3DevicesIdEventsSendNotificationPost(
{required int? id, required EventSendV3Body? body}) → Future< Response> - Set the value of a peripheral entry within the device with the given ID. @param id
-
kemApiV3DevicesIdExerciseDelete(
{required int? id}) → Future< Response> - Deletes the exercise schedule of the device with the given ID @param id
-
kemApiV3DevicesIdExercisePut(
{required int? id, required ExerciseScheduleV3Body? body}) → Future< Response< ExerciseInfoDTO> > - Update the exercise schedule of the device with the given ID @param id
-
kemApiV3DevicesIdExerciseStartPost(
{required int? id, required StartExerciseV3Body? body}) → Future< Response> - Start a remote exercise cycle on device with the given ID @param id
-
kemApiV3DevicesIdExerciseStopPost(
{required int? id}) → Future< Response> - Stops a remote exercise cycle on device with the given ID @param id
-
kemApiV3DevicesIdGet(
{required int? id, DeviceHostDTO? sourceDeviceHost}) → Future< Response< DeviceDetailsDTO> > - Get the device details for the device with the given ID.
-
kemApiV3DevicesIdMaintenanceNotesGet(
{required int? id}) → Future< Response< List< >MaintenanceNoteDTO> > - Get list of maintenance notes for a device @param id
-
kemApiV3DevicesIdMaintenanceNotesNoteIdDelete(
{required int? id, required int? noteId}) → Future< Response> - Delete an existing maintenance note. @param id @param noteId
-
kemApiV3DevicesIdMaintenanceNotesNoteIdPut(
{required int? id, required int? noteId, required MaintenanceNoteUpsertV3Body? body}) → Future< Response< MaintenanceNoteDTO> > - Update an existing maintenance note's contents. @param id @param noteId
-
kemApiV3DevicesIdMaintenanceNotesPost(
{required int? id, required MaintenanceNoteUpsertV3Body? body}) → Future< Response< MaintenanceNoteDTO> > - Add a new maintenance note to the device. @param id
-
kemApiV3DevicesIdPeripheralsDefinitionIdPut(
{required int? id, required int? definitionId, required PeripheralRenameV3Body? body}) → Future< Response< PeripheralDTO> > - Rename the display name of a peripheral entry for a device with the given ID. @param id @param definitionId
-
kemApiV3DevicesIdPeripheralsDefinitionIdSetValuePost(
{required int? id, required int? definitionId, required PeripheralValueUpdateV3Body? body}) → Future< Response> - Set the value of a peripheral entry within the device with the given ID. @param id @param definitionId
-
kemApiV3DevicesIdPut(
{required int? id, required DeviceUpdateV3Body? body}) → Future< Response< DeviceDTO> > - Update the device display name and address information @param id
-
kemApiV3DevicesIdServiceagreementPut(
{required int? id, required ServiceAgreementUpdateV3Body? body}) → Future< Response> - Update the device's service agreement information
-
kemApiV3DevicesIdSetControllerClockPost(
{required int? id, required SetControllerClockV3Body? body}) → Future< Response> - Set Controller Clock of the device with the given ID @param id
-
kemApiV3DevicesIdSetparameterPost(
{required int? id, required ParameterUpdateV3Body? body}) → Future< Response> - @param id
-
kemApiV3DevicesIdSignaturesEmailGet(
{required String? email, required String? id}) → Future< Response< String> > - Get the signature file the given email.
-
kemApiV3DevicesIdSignaturesGet(
{required int? id}) → Future< Response< List< >HomeownerConsentDTO> > - @param id
-
kemApiV3DevicesIdSignaturesPost(
{required int? id, List< int> ? file, String? email, dynamic action, String? firstName, String? lastName}) → Future<Response> - Upload signature file to Blob Storage. Update DB with file name and email. @param id
-
kemApiV3DevicesIdTrendsTrendGet(
{required int? id, required TrendPathParam? trend, DateTime? since}) → Future< Response< List< >TrendValueDTO> > - Get the historical trends for the given parameter of the device with the given ID @param id @param trend @param since
-
kemApiV3DevicesSearchGet(
{String? deviceText, String? userText, String? addressText, String? serialNumber, String? displayName, String? oncueUsername, String? email, bool? excludeDevicesWithDealers}) → Future< Response< List< >String> > - Search all devices and return a list of serial numbers for devices that contain text from the given input values. Fields are case insensitive. Multiple fields can be provided to make the search more precise.
-
kemApiV3DevicesVerificationGet(
{String? serialNumber, String? controllerPin}) → Future< Response< DeviceVerificationDTO> > - Get verification information on the given serial number and controller PIN. @param serialNumber @param controllerPin
-
kemApiV3HomeownerAppFeedbackStatusGet(
) → Future< Response< FeedbackStatusDTO> > - Returns whether the currently logged-in homeowner can submit app feedback.
-
kemApiV3HomeownerAppSubmitFeedbackPost(
{required FeedbackSubmissionV3Body? body}) → Future< Response> - Submit feedback and rating from the dealer app.
-
kemApiV3HomeownerAppUpdatePlanGet(
{String? version, int? buildNumber}) → Future< Response< AppUpdatePlanDTO> > - Get the current app update plan, including whether an upgrade is recommended or required. @param version App version (e.g., 1.4.3) @param buildNumber App build number (e.g., 20301)
-
kemApiV3HomeownerHomesGet(
) → Future< Response< List< >HomeDTO> > - Get the home list of the currently logged-in user.
-
kemApiV3HomeownerHomesIdDelete(
{required int? id}) → Future< Response> - Remove the device from the currently logged-in user's account @param id
-
kemApiV3HomeownerHomesIdUsersInvitePost(
{required int? id}) → Future< Response< HomeInviteDTO> > - @param id
-
kemApiV3HomeownerHomesIdUsersUserIdDelete(
{required int? id, required String? userId}) → Future< Response> - @param id @param userId
-
kemApiV3HomeownerHomesPost(
{required HomeownerDeviceAdditionV3Body? body}) → Future< Response> - Add the list of homes to the currently logged-in user's account
-
kemApiV3HomeownerInvitesCodeClaimPost(
{required String? code}) → Future< Response< HomeownerDTO> > - @param code
-
kemApiV3HomeownerInvitesCodeGet(
{required String? code}) → Future< Response< HomeInviteDTO> > - @param code
-
kemApiV3HomeownerMeDelete(
) → Future< Response> - Delete the currently logged-in homeowner.
-
kemApiV3HomeownerMeGet(
) → Future< Response< HomeownerDTO> > - Get homeowner related information about the currently logged-in user.
-
kemApiV3HomeownerMePut(
{required HomeownerUpdateV3Body? body}) → Future< Response< HomeownerDTO> > - Update homeowner related information about the currently logged-in user.
-
kemApiV3HomeownerOncueImportPost(
{required OncueImportV3Body? body}) → Future< Response> - Import devices from an OnCue account
-
kemApiV3HomeownerOncueVerifyPost(
{required OncueVerificationV3Body? body}) → Future< Response< OncueVerificationDTO> > - Verify the given OnCue login information and return whether the login info is valid and the OnCue user's devices can be imported into the logged-in user's account.
-
kemApiV3HomeownerSettingsNotificationGet(
) → Future< Response< HomeownerNotificationSettingDTO> > - Get notification settings related information about the currently logged-in user.
-
kemApiV3HomeownerSettingsNotificationPost(
{required HomeownerNotificationSettingsUpdateV3Body? body}) → Future< Response> - homeowner to update their notification settings of currently logged-in user's account
-
kemApiV3InternalCellkitSyncPost(
) → Future< Response> -
kemApiV3InternalConsentPost(
{required ConsentUpdateV3Body? body}) → Future< Response> - Update the consent of a user.
-
kemApiV3InternalDealerAppVersionsPost(
{required AppVersionUpdateV3Body? body}) → Future< Response> -
kemApiV3InternalDealerOrgsIdsGet(
) → Future< Response< List< >String> > - Get a list of all dealer IDs within the PRO system database
-
kemApiV3InternalDealerUsersEmailsGet(
{int? limit, int? offset}) → Future< Response< InternalDeviceMetadataDTO> > - Get emailIds of dealers @param limit @param offset
-
kemApiV3InternalDevicesAnalyticsGet(
) → Future< Response< DeviceAnalyticsDTO> > - Get current and historical (30-min average) device connection counts for analytics.
-
kemApiV3InternalDevicesConnectionHistoryPost(
{required DeviceConnectionHistoryInsertV3Body? body}) → Future< Response> - Record the current device connection counts, as called by HEP Azure function.
-
kemApiV3InternalDevicesDeviceGet(
{int? id, String? serialNumber, String? iccid, int? oncueDeviceId, bool? includeDealerOrgs, bool? includeUptime, DeviceHostDTO? sourceDeviceHost}) → Future< Response< DeviceDTO> > - Get data about a device, based on one of the given identifiers. This may be useful for debugging purposes.
-
kemApiV3InternalDevicesGet(
{String? businessPartnerNo, String? homeownerEmail, String? filterText, List< String> ? serialNumbers, List<int> ? ids, int? limit, int? offset, ApprovalDTO? dealerOrgApproval, ApprovalDTO? homeownerApproval, bool? includeDealerOrgs, bool? includeUptime, VisibilityDTO? visibility, DeviceSortDTO? sort, SortDirectionDTO? sortDirection, ConnectionTypeDTO? connectionType, ServiceAgreementStatusDTO? serviceAgreementStatus, CellularDataStatusDTO? cellularDataStatus, DateTime? cellularExpiryBefore, DateTime? cellularExpiryAfter, CellularExpiryStatusDTO? cellularExpiryStatus}) → Future<Response< List< >DeviceListingDTO> > - Get a list of devicetags based on the given serialNumber and notificationType @param BusinessPartnerNo If provided, only devices assigned to the dealer org with the given business partner no will be included. @param HomeownerEmail If provided, only devices assigned to the homeowner with the given email no will be included. @param FilterText If provided, only devices whose device information, dealer org, or homeowner information contain the given filter text will be included @param SerialNumbers If provided, only devices with the matching serial numbers will be included. @param ids If provided, only devices with the matching device IDs will be included. @param Limit Number of devices to return @param Offset Number of devices to skip @param DealerOrgApproval Only devices with the provided approval level to their dealer org will be included. Defaults to "Approved", meaning only devices that are approved and monitored by a dealer org will be included. @param HomeownerApproval Only devices with the provided approval level to their homeowner will be included. Defaults to "Any", meaning a device will be included whether it has a homeowner monitoring it or not. @param IncludeDealerOrgs Whether to include dealer org information in the device response @param IncludeUptime Whether to include uptime information in the device response @param Visibility Whether to include only visible, hidden, or all devices. Defaults to visible devices. @param Sort If provided, this parameter provides the column name by which the data is going to be sorted by. Defaults to null. @param SortDirection Along with sort, this parameter provides the direction by which the data is going to be sorted by. Defaults to Ascending @param ConnectionType If provided, this parameter provides the column name by which the data is going to be Filtered by. Defaults to null. @param ServiceAgreementStatus If provided, this parameter provides the column name by which the data is going to be Filtered by. Defaults to null. @param CellularDataStatus If provided, filters results by the specified cellular data status. Defaults to null (no status filtering). @param CellularExpiryBefore If provided, filters results to only include devices whose cellular data expires before this date. Defaults to null @param CellularExpiryAfter If provided, filters results to only include devices whose cellular data expires after this date. Defaults to null @param CellularExpiryStatus If provided, filters results based on the cellular expiration status
-
kemApiV3InternalDevicesIdMetadataGet(
{required int? id}) → Future< Response< InternalDeviceMetadataDTO> > - Get metadata about the device, notably whether the device has been approved by its assigned dealer or whether it has been deleted @param id
-
kemApiV3InternalDevicesMigrateMissingParamsPost(
{required DeviceHostMigrateParamsV3Body? body}) → Future< Response> - Migrate known missing parameter data of a generator from the old device host to the new device host.
-
kemApiV3InternalDevicesMigrationLogsIdVerifyPost(
{required int? id}) → Future< Response> - Verify that a previous device migration was successful and update the given device migration log status accordingly. @param id
-
kemApiV3InternalDevicesMigrationRequestsIdMigratePost(
{required int? id, required DeviceHostMigrationV3Body? body}) → Future< Response< DeviceMigrationLogDTO> > - Migrate a device to a different device host, as part of on an existing migration request. @param id
-
kemApiV3InternalDevicesPost(
{required CreateDeviceIfNotExistV3Body? body}) → Future< Response> - Checks if device with the given serial number exists in the database. Creates a new device if it does not exist.
-
kemApiV3InternalDevicesSyncPost(
{required DeviceSyncV3Body? body}) → Future< Response> -
kemApiV3InternalHomeownerAppVersionsPost(
{required AppVersionUpdateV3Body? body}) → Future< Response> -
kemApiV3InternalHomeownerEmailsGet(
{int? limit, int? offset}) → Future< Response< InternalDeviceMetadataDTO> > - Get emailIds of homeowners @param limit @param offset
-
kemApiV3InternalInhandSyncPost(
) → Future< Response> - Get a list of devicetags based on the given serialNumber and notificationType @param serialNumber @param notificationType Type of the notification @param includeDealerTokens @param deviceHost The cloud architecture which the device is connected to.
-
kemApiV3InternalNotificationsHistoryPost(
{required NotificationHistoryInsertV3Body? body}) → Future< Response> - Insert a notification history entry into the database
-
kemApiV3InternalNotificationsPost(
{required NotificationInsertV3Body? body}) → Future< Response> - Insert a notification entry into the database
-
kemApiV3InternalNotificationsTokensGet(
{String? email, String? dealerId}) → Future< Response< List< >String> > - Get a list of notification FCM tokens based on the given email or dealer ID @param email @param dealerId
-
kemApiV3InternalUnassignedDevicesGet(
{String? filterText, int? limit, int? offset, bool? includeDealerOrgs, VisibilityDTO? visibility, DeviceSortDTO? sort, SortDirectionDTO? sortDirection}) → Future< Response< List< >DeviceListingDTO> > - Get a list of unassigned Devices @param FilterText If provided, only devices whose device information, dealer org, or homeowner information contain the given filter text will be included @param Limit Number of devices to return @param Offset Number of devices to skip @param IncludeDealerOrgs Whether to include dealer org information in the device response @param Visibility Whether to include only visible, hidden, or all devices. Defaults to visible devices. @param Sort If provided, this parameter provides the column name by which the data is going to be sorted by. Defaults to null. @param SortDirection Along with sort, this parameter provides the direction by which the data is going to be sorted by. Defaults to Ascending
-
kemApiV3KohleradminAnalyticsGet(
{VisibilityDTO? deviceVisibility}) → Future< Response< AnalyticsDTO> > - @param deviceVisibility
-
kemApiV3KohleradminDealerAppVersionsPost(
{required AppVersionUpdateV3Body? body}) → Future< Response> -
kemApiV3KohleradminDealerEmailsGet(
{String? email, String? after}) → Future< Response< EmailLogsResultDTO> > - @param email @param after
-
kemApiV3KohleradminDealerEmailsUnblockPost(
{required UnblockEmailV3Body? body}) → Future< Response> -
kemApiV3KohleradminDealerOrgGet(
{List< String> ? businessPartnerNos, List<int> ? ids, String? filterText, int? limit, int? offset, bool? exportAll, DealerOrgSortDTO? sort, SortDirectionDTO? sortDirection}) → Future<Response< List< >DealerOrgDTO> > - @param businessPartnerNos @param ids @param filterText @param limit @param offset @param exportAll @param sort Various values based on the columns in the Pro Analytics dealer org table @param sortDirection
-
kemApiV3KohleradminDealerOrgIdAnalyticsGet(
{required int? id, VisibilityDTO? deviceVisibility}) → Future< Response< DealerOrgAnalyticsDTO> > - @param id @param deviceVisibility
-
kemApiV3KohleradminDealerOrgIdDelete(
{required int? id}) → Future< Response> - @param id
-
kemApiV3KohleradminDealerOrgIdDevicesGet(
{required int? id, String? filterText, List< String> ? serialNumbers, List<int> ? ids, int? limit, int? offset, ApprovalDTO? approval, bool? includeDealerOrgs, VisibilityDTO? visibility, DeviceHostDTO? sourceDeviceHost}) → Future<Response< List< >DeviceDTO> > - @param id @param filterText @param serialNumbers @param ids @param limit @param offset @param approval Various states of the relationship between a device and a dealer org or homeowner. @param includeDealerOrgs @param visibility @param sourceDeviceHost The cloud architecture which the device is connected to.
-
kemApiV3KohleradminDealerOrgIdGet(
{required int? id}) → Future< Response< DealerOrgDTO> > - @param id
-
kemApiV3KohleradminDealerOrgIdPut(
{required int? id, required AdminDealerOrgUpdateV3Body? body}) → Future< Response< DealerOrgDTO> > - @param id
-
kemApiV3KohleradminDealerOrgIdResendInvitePost(
{required int? id}) → Future< Response> - @param id
-
kemApiV3KohleradminDealerOrgIdUsersGet(
{required int? id, List< String> ? emails, List<int> ? ids, RoleDTO? role}) → Future<Response< List< >DealerUserDTO> > - @param id @param emails @param ids @param role Supported roles of a Pro user Based on User role definitions per https://kohler.atlassian.net/wiki/spaces/XR/pages/1952645122/PRO+-+Defining+User+Roles+and+Permissions
-
kemApiV3KohleradminDealerOrgListingGet(
{List< String> ? businessPartnerNos, List<int> ? ids, String? filterText, int? limit, int? offset, bool? exportAll, DealerOrgSortDTO? sort, SortDirectionDTO? sortDirection}) → Future<Response< DealerOrgListingDTO> > - @param businessPartnerNos @param ids @param filterText @param limit @param offset @param exportAll @param sort Various values based on the columns in the Pro Analytics dealer org table @param sortDirection
-
kemApiV3KohleradminDealerOrgPost(
{required AdminDealerOrgCreateV3Body? body}) → Future< Response< DealerOrgDTO> > -
kemApiV3KohleradminDealerUsersGet(
{String? businessPartnerNo, List< String> ? emails, List<int> ? ids, RoleDTO? role}) → Future<Response< List< >DealerUserDTO> > - @param businessPartnerNo @param emails @param ids @param role Supported roles of a Pro user Based on User role definitions per https://kohler.atlassian.net/wiki/spaces/XR/pages/1952645122/PRO+-+Defining+User+Roles+and+Permissions
-
kemApiV3KohleradminDealerUsersIdDelete(
{required int? id}) → Future< Response> - @param id
-
kemApiV3KohleradminDealerUsersIdGet(
{required int? id}) → Future< Response< DealerUserDTO> > - @param id
-
kemApiV3KohleradminDealerUsersIdPut(
{required int? id, required AdminDealerUserUpdateV3Body? body}) → Future< Response< DealerUserDTO> > - @param id
-
kemApiV3KohleradminDealerUsersIdResendInvitePost(
{required int? id}) → Future< Response> - @param id
-
kemApiV3KohleradminDealerUsersPost(
{required AdminDealerUserCreateV3Body? body}) → Future< Response< DealerUserDTO> > -
kemApiV3KohleradminDealerUsersUpdatestatusPost(
{required List< String> ? body}) → Future<Response> -
kemApiV3KohleradminDevicesAnalyticsGet(
) → Future< Response< DeviceAnalyticsDTO> > - Returns analytics for total generator/device count cards for the Device Connection History page.
-
kemApiV3KohleradminDevicesConnectionHistoryGet(
{TimeRangeDTO? timeRange, TimeGranularityDTO? timeGranularity, AggregationTypeDTO? aggregation}) → Future< Response< List< >DeviceCountLogDTO> > - Returns generator connection history for Device connection history page graph. @param timeRange @param timeGranularity @param aggregation
-
kemApiV3KohleradminDevicesExportPost(
{required DeviceExportV3Body? body}) → Future< Response> - Returns 202 https status on successful queuing device export request.
-
kemApiV3KohleradminDevicesGet(
{String? businessPartnerNo, String? homeownerEmail, String? filterText, List< String> ? serialNumbers, List<int> ? ids, int? limit, int? offset, ApprovalDTO? dealerOrgApproval, ApprovalDTO? homeownerApproval, bool? includeDealerOrgs, bool? includeUptime, VisibilityDTO? visibility, DeviceSortDTO? sort, SortDirectionDTO? sortDirection, ConnectionTypeDTO? connectionType, ServiceAgreementStatusDTO? serviceAgreementStatus, CellularDataStatusDTO? cellularDataStatus, DateTime? cellularExpiryBefore, DateTime? cellularExpiryAfter, CellularExpiryStatusDTO? cellularExpiryStatus, DeviceHostDTO? sourceDeviceHost}) → Future<Response< List< >DeviceDTO> > - Returns a list of all devices within the Pro system. The device list can be further filtered based on any given query parameters. @param BusinessPartnerNo If provided, only devices assigned to the dealer org with the given business partner no will be included. @param HomeownerEmail If provided, only devices assigned to the homeowner with the given email no will be included. @param FilterText If provided, only devices whose device information, dealer org, or homeowner information contain the given filter text will be included @param SerialNumbers If provided, only devices with the matching serial numbers will be included. @param ids If provided, only devices with the matching device IDs will be included. @param Limit Number of devices to return @param Offset Number of devices to skip @param DealerOrgApproval Only devices with the provided approval level to their dealer org will be included. Defaults to "Approved", meaning only devices that are approved and monitored by a dealer org will be included. @param HomeownerApproval Only devices with the provided approval level to their homeowner will be included. Defaults to "Any", meaning a device will be included whether it has a homeowner monitoring it or not. @param IncludeDealerOrgs Whether to include dealer org information in the device response @param IncludeUptime Whether to include uptime information in the device response @param Visibility Whether to include only visible, hidden, or all devices. Defaults to visible devices. @param Sort If provided, this parameter provides the column name by which the data is going to be sorted by. Defaults to null. @param SortDirection Along with sort, this parameter provides the direction by which the data is going to be sorted by. Defaults to Ascending @param ConnectionType If provided, this parameter provides the column name by which the data is going to be Filtered by. Defaults to null. @param ServiceAgreementStatus If provided, this parameter provides the column name by which the data is going to be Filtered by. Defaults to null. @param CellularDataStatus If provided, filters results by the specified cellular data status. Defaults to null (no status filtering). @param CellularExpiryBefore If provided, filters results to only include devices whose cellular data expires before this date. Defaults to null @param CellularExpiryAfter If provided, filters results to only include devices whose cellular data expires after this date. Defaults to null @param CellularExpiryStatus If provided, filters results based on the cellular expiration status @param sourceDeviceHost The cloud architecture which the device is connected to.
-
kemApiV3KohleradminDevicesIdDelete(
{required int? id}) → Future< Response> - @param id
-
kemApiV3KohleradminDevicesIdObtainPinPost(
{required int? id}) → Future< Response< DevicePinDTO> > - Returns the hashed PIN of a device. When unencrypted, this PIN could be used to add a generator to a dealer org or homeowner's device list. @param id
-
kemApiV3KohleradminDevicesListingGet(
{String? businessPartnerNo, String? homeownerEmail, String? filterText, List< String> ? serialNumbers, List<int> ? ids, int? limit, int? offset, ApprovalDTO? dealerOrgApproval, ApprovalDTO? homeownerApproval, bool? includeDealerOrgs, bool? includeUptime, VisibilityDTO? visibility, DeviceSortDTO? sort, SortDirectionDTO? sortDirection, ConnectionTypeDTO? connectionType, ServiceAgreementStatusDTO? serviceAgreementStatus, CellularDataStatusDTO? cellularDataStatus, DateTime? cellularExpiryBefore, DateTime? cellularExpiryAfter, CellularExpiryStatusDTO? cellularExpiryStatus, DeviceHostDTO? sourceDeviceHost}) → Future<Response< DeviceListingDTO> > - Returns a list of all devices within the Pro system. The device list can be further filtered based on any given query parameters. @param BusinessPartnerNo If provided, only devices assigned to the dealer org with the given business partner no will be included. @param HomeownerEmail If provided, only devices assigned to the homeowner with the given email no will be included. @param FilterText If provided, only devices whose device information, dealer org, or homeowner information contain the given filter text will be included @param SerialNumbers If provided, only devices with the matching serial numbers will be included. @param ids If provided, only devices with the matching device IDs will be included. @param Limit Number of devices to return @param Offset Number of devices to skip @param DealerOrgApproval Only devices with the provided approval level to their dealer org will be included. Defaults to "Approved", meaning only devices that are approved and monitored by a dealer org will be included. @param HomeownerApproval Only devices with the provided approval level to their homeowner will be included. Defaults to "Any", meaning a device will be included whether it has a homeowner monitoring it or not. @param IncludeDealerOrgs Whether to include dealer org information in the device response @param IncludeUptime Whether to include uptime information in the device response @param Visibility Whether to include only visible, hidden, or all devices. Defaults to visible devices. @param Sort If provided, this parameter provides the column name by which the data is going to be sorted by. Defaults to null. @param SortDirection Along with sort, this parameter provides the direction by which the data is going to be sorted by. Defaults to Ascending @param ConnectionType If provided, this parameter provides the column name by which the data is going to be Filtered by. Defaults to null. @param ServiceAgreementStatus If provided, this parameter provides the column name by which the data is going to be Filtered by. Defaults to null. @param CellularDataStatus If provided, filters results by the specified cellular data status. Defaults to null (no status filtering). @param CellularExpiryBefore If provided, filters results to only include devices whose cellular data expires before this date. Defaults to null @param CellularExpiryAfter If provided, filters results to only include devices whose cellular data expires after this date. Defaults to null @param CellularExpiryStatus If provided, filters results based on the cellular expiration status @param sourceDeviceHost The cloud architecture which the device is connected to.
-
kemApiV3KohleradminDevicesMigrationLogIdVerifyPost(
{required int? id}) → Future< Response> - Verify that a prior device migration attempt was successful.
-
kemApiV3KohleradminDevicesMigrationLogsGet(
{List< int> ? ids, DeviceHostDTO? deviceHost, DeviceMigrationStatusDTO? status, int? requestId, List<String> ? serialNumbers, List<String> ? businessPartnerNumbers, List<String> ? homeownerEmails, List<int> ? deviceIds, List<int> ? dealerOrgIds, List<int> ? homeownerIds, String? filterText, int? limit, int? offset, bool? includeSnapshots}) → Future<Response< DeviceMigrationLogListingDTO> > - Returns a list of all device migration attempt logs
-
kemApiV3KohleradminDevicesMigrationLogsIdGet(
{required int? id, bool? includeSnapshots}) → Future< Response< DeviceMigrationLogDTO> > - Returns a device migration attempt log based on the given ID
-
kemApiV3KohleradminDevicesMigrationMigratedDevicesListingGet(
{String? filterText, int? limit, int? offset}) → Future< Response< DeviceListingDTO> > - Returns a list of all devices which have been migrated to the new host @param filterText @param limit @param offset
-
kemApiV3KohleradminDevicesMigrationRequestsGet(
{List< int> ? ids, DeviceHostDTO? deviceHost, List<String> ? serialNumbers, List<String> ? businessPartnerNumbers, List<String> ? homeownerEmails, List<int> ? deviceIds, List<int> ? dealerOrgIds, List<int> ? homeownerIds, String? filterText, int? limit, int? offset, bool? includeSerialNumbers}) → Future<Response< DeviceMigrationRequestListingDTO> > - Returns a list of all device migration requests
-
kemApiV3KohleradminDevicesMigrationRequestsIdGet(
{required int? id}) → Future< Response< DeviceMigrationRequestDTO> > - Returns a device migration request based on the given ID
-
kemApiV3KohleradminDevicesMigrationRequestsPost(
{required DeviceMigrationRequestV3Body? body}) → Future< Response> - Request for a migration of devices to a new device host.
-
kemApiV3KohleradminHomeownerAppVersionsPost(
{required AppVersionUpdateV3Body? body}) → Future< Response> -
kemApiV3KohleradminHomeownerEmailsGet(
{String? email, String? after}) → Future< Response< EmailLogsResultDTO> > - @param email @param after
-
kemApiV3KohleradminHomeownerEmailsUnblockPost(
{required UnblockEmailV3Body? body}) → Future< Response> -
kemApiV3KohleradminHomeownersGet(
{List< String> ? emails, List<int> ? ids, List<String> ? serialNumbers, ApprovalDTO? serialNumbersApproval, String? filterText, int? limit, int? offset, HomeownerSortDTO? sort, SortDirectionDTO? sortDirection}) → Future<Response< List< >HomeownerDTO> > - @param emails @param ids @param serialNumbers @param serialNumbersApproval Various states of the relationship between a device and a dealer org or homeowner. @param filterText @param limit @param offset @param sort Various values based on the columns in the Pro Analytics homeowner table @param sortDirection
-
kemApiV3KohleradminHomeownersIdDelete(
{required int? id}) → Future< Response> - @param id
-
kemApiV3KohleradminHomeownersIdDevicesGet(
{required int? id, String? filterText, List< String> ? serialNumbers, List<int> ? ids, int? limit, int? offset, ApprovalDTO? approval, bool? includeDealerOrgs, VisibilityDTO? visibility, DeviceHostDTO? sourceDeviceHost}) → Future<Response< List< >DeviceDTO> > - @param id @param filterText @param serialNumbers @param ids @param limit @param offset @param approval Various states of the relationship between a device and a dealer org or homeowner. @param includeDealerOrgs @param visibility @param sourceDeviceHost The cloud architecture which the device is connected to.
-
kemApiV3KohleradminHomeownersIdGet(
{required int? id}) → Future< Response< HomeownerDTO> > - @param id
-
kemApiV3KohleradminHomeownersListingGet(
{List< String> ? emails, List<int> ? ids, List<String> ? serialNumbers, ApprovalDTO? serialNumbersApproval, String? filterText, int? limit, int? offset, HomeownerSortDTO? sort, SortDirectionDTO? sortDirection}) → Future<Response< HomeownerListingDTO> > - @param emails @param ids @param serialNumbers @param serialNumbersApproval Various states of the relationship between a device and a dealer org or homeowner. @param filterText @param limit @param offset @param sort Various values based on the columns in the Pro Analytics homeowner table @param sortDirection
-
kemApiV3KohleradminMarketingMessagesGet(
{bool? isSent}) → Future< Response< List< >MarketingMessageDTO> > - @param isSent
-
kemApiV3KohleradminMarketingMessagesIdPut(
{required int? id, required MarketingMessageUpsertV3Body? body}) → Future< Response< MarketingMessageDTO> > - @param id
-
kemApiV3KohleradminMarketingMessagesIdSendPost(
{required int? id, required MarketingMessageUpsertV3Body? body}) → Future< Response> - @param id
-
kemApiV3KohleradminMarketingMessagesPost(
{required MarketingMessageUpsertV3Body? body}) → Future< Response< MarketingMessageDTO> > -
kemApiV3KohleradminUnassignedDevicesGet(
{String? filterText, int? limit, int? offset, bool? includeDealerOrgs, VisibilityDTO? visibility, DeviceSortDTO? sort, SortDirectionDTO? sortDirection, DeviceHostDTO? sourceDeviceHost}) → Future< Response< List< >DeviceDTO> > - Returns a list of all devices which are not assigned / monitored by any dealer organization. @param FilterText If provided, only devices whose device information, dealer org, or homeowner information contain the given filter text will be included @param Limit Number of devices to return @param Offset Number of devices to skip @param IncludeDealerOrgs Whether to include dealer org information in the device response @param Visibility Whether to include only visible, hidden, or all devices. Defaults to visible devices. @param Sort If provided, this parameter provides the column name by which the data is going to be sorted by. Defaults to null. @param SortDirection Along with sort, this parameter provides the direction by which the data is going to be sorted by. Defaults to Ascending @param sourceDeviceHost The cloud architecture which the device is connected to.
-
kemApiV3KohleradminUnassignedDevicesListingGet(
{String? filterText, int? limit, int? offset, bool? includeDealerOrgs, VisibilityDTO? visibility, DeviceSortDTO? sort, SortDirectionDTO? sortDirection, DeviceHostDTO? sourceDeviceHost}) → Future< Response< DeviceListingDTO> > - Returns a list of all devices which are not assigned / monitored by any dealer organization, and their total count. @param FilterText If provided, only devices whose device information, dealer org, or homeowner information contain the given filter text will be included @param Limit Number of devices to return @param Offset Number of devices to skip @param IncludeDealerOrgs Whether to include dealer org information in the device response @param Visibility Whether to include only visible, hidden, or all devices. Defaults to visible devices. @param Sort If provided, this parameter provides the column name by which the data is going to be sorted by. Defaults to null. @param SortDirection Along with sort, this parameter provides the direction by which the data is going to be sorted by. Defaults to Ascending @param sourceDeviceHost The cloud architecture which the device is connected to.
-
kemApiV3NotificationsGet(
{String? deviceId, int? offset, int? limit}) → Future< Response< List< >NotificationDTO> > - Get notification history data for the currently logged-in user. @param DeviceId Optional device ID. If provided, only notifications sent to the corresponding end-user device will be returned. If not provided, all notifications sent to any of the end-user's devices will be returned. @param Offset @param Limit
-
kemApiV3NotificationsSendPost(
{required NotificationSendV3Body? body}) → Future< Response< String> > - Send a generic notification to users based on the given tags.
-
kemApiV3NotificationsTagsDeviceIdGet(
{required String? deviceId}) → Future< Response< List< >String> > - Retrieve the logged-in user's notification tags associated with the given device ID. @param deviceId
-
kemApiV3NotificationsTagsPut(
{required NotificationTagUpdateV3Body? body}) → Future< Response> - Update the logged-in user's notification tags.
-
kemApiV3NotificationsTokenDeviceidDeviceIdDelete(
{required String? deviceId}) → Future< Response> - Delete the logged-in user's notification token with the given device ID. @param deviceId
-
kemApiV3NotificationsTokenPost(
{required RegisterNotificationV3Body? body}) → Future< Response> - Register the given notification token information so it is associated with the currently logged-in user.
-
kemApiV3NotificationsTokenRegistrationidRegistrationIdDelete(
{required String? registrationId}) → Future< Response> - Delete the logged-in user's notification token with the given registration ID. @param registrationId
-
kemApiV3OktaeventsGet(
) → Future< Response< OktaEventHooksDTO> > - Returns a list of event hooks for each okta tenant.
-
kemApiV3OktaeventsHomeownersDeleteGet(
) → Future< Response< OktaVerificationDTO> > - Verify that the service supports the homeowner deleted event hook
-
kemApiV3OktaeventsHomeownersDeletePost(
{required OktaEventV3Body? body}) → Future< Response> - Event hook endpoint that should be called by Okta when a homeowner has been deleted.
-
kemApiV3OktaeventsHomeownersUpsertGet(
) → Future< Response< OktaVerificationDTO> > - Verify that the service supports the pro user activated event hook
-
kemApiV3OktaeventsHomeownersUpsertPost(
{required OktaEventV3Body? body}) → Future< Response> - Event hook endpoint that should be called by Okta when a homeowner has been created or updated.
-
kemApiV3OktaeventsUsersActivatedGet(
) → Future< Response< OktaVerificationDTO> > -
kemApiV3OktaeventsUsersActivatedPost(
{required OktaEventV3Body? body}) → Future< Response> - Event hook endpoint that should be called by Okta when a pro user has been activated, or their password has been updated.
-
kemApiV3PhqCellkitRenewalOrderPost(
{required CellKitOrderDTO? body}) → Future< Response> -
kemApiV3PhqCellkitRenewalRequestsRequestIdGet(
{required String? requestId}) → Future< Response< CellKitRenewalDTO> > - @param requestId
-
kemApiV3SalesforceDealerOrgPost(
{required AdminDealerOrgCreateV3Body? body}) → Future< Response< DealerOrgDTO> > - Creates a dealer organization and user in PRO Analytics using information sent from Salesforce.
-
kemApiV3SalesforceDealerUserPost(
{required AdminDealerUserCreateV3Body? body}) → Future< Response< DealerUserDTO> > -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
create(
{ChopperClient? client, Client? httpClient, Authenticator? authenticator, ErrorConverter? errorConverter, Converter? converter, Uri? baseUrl, List< Interceptor> ? interceptors}) → EnergyManagementV3Api