Inheritance

• Object
• ChopperService
• EnergyManagementApi

Available extensions

• EnergyManagementApiExtensions

Annotations

• @ChopperApi()

Constructors

EnergyManagementApi()

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

kemproApiV2AdminAnalyticsGet() → Future<Response<AnalyticsV2>>

kemproApiV2AdminDealersDealerIdUsersGet({required int? dealerId}) → Future<Response<List<DealerUserV2>>>

@param dealerId

kemproApiV2AdminDealersGet() → Future<Response<List<DealerInfoV2>>>

kemproApiV2AdminDealersIdAnalyticsGet({required String? id}) → Future<Response<DealerOrgAnalyticsV2>>

@param id

kemproApiV2AdminDealersIdDelete({required int? id}) → Future<Response>

@param id

kemproApiV2AdminDealersIdDevicesGet({required String? id, String? filterText, int? limit, int? offset, bool? includeUnapprovedDevices}) → Future<Response<List<DeviceV2>>>

@param id @param filterText @param limit @param offset @param includeUnapprovedDevices

kemproApiV2AdminDealersIdGet({required String? id}) → Future<Response<DealerOrgV2>>

@param id

kemproApiV2AdminDealersIdPut({required int? id, required DealerOrgV2? body}) → Future<Response>

@param id

kemproApiV2AdminDealersIdResendInvitePost({required int? id}) → Future<Response>

Resend a marketing cloud invitation to the admins of a dealer org, to allow them to login and access the Energy Management platform.

kemproApiV2AdminDealersPost({required DealerOrgV2? body}) → Future<Response>

kemproApiV2AdminDevicesGet({String? filterText, int? limit, int? offset, bool? includeUnapprovedDevices}) → Future<Response<List<DeviceV2>>>

@param filterText @param limit @param offset @param includeUnapprovedDevices

kemproApiV2AdminRolesGet() → Future<Response<List<GroupV2>>>

kemproApiV2AdminRolesRoleIdUsersGet({required String? roleId}) → Future<Response<List<DealerUserV2>>>

@param roleId

kemproApiV2AdminUsersEmailGet({required String? email}) → Future<Response<DealerUserV2>>

@param email

kemproApiV2AdminUsersGet() → Future<Response<List<DealerUserV2>>>

kemproApiV2AdminUsersIdDelete({required int? id}) → Future<Response>

@param id

kemproApiV2AdminUsersIdPut({required int? id, required AdminUserV2Body? body}) → Future<Response>

@param id

kemproApiV2AdminUsersPost({required AdminUserV2Body? body}) → Future<Response>

kemproApiV2AdminUsersUpdatestatusPost({required List<AdminUserV2EmailDto>? body}) → Future<Response>

call to refresh db invitation status from the Okata User(s) status.

kemproApiV2AdminUsersUserIdGet({required int? userId}) → Future<Response<DealerUserV2>>

@param userId

kemproApiV2AdminUsersUserIdResendInvitePost({required int? userId}) → Future<Response>

Resend a marketing cloud invitation to a user, to allow them to login and access the Energy Management platform.

kemproApiV2AdminUsersUserIdRolesGet({required int? userId}) → Future<Response<List<GroupV2>>>

@param userId

kemproApiV2ConsentAcceptPost({String? code}) → Future<Response>

Indicates that the homeowner consents to allowing dealers to view identifying information such as the address of the homeowner's device.

kemproApiV2ConsentRejectPost({String? code}) → Future<Response>

Indicates that the homeowner does not consent to allowing dealers to view identifying information such as the address of the homeowner's device.

kemproApiV2DevicesGet() → Future<Response<List<DeviceV2>>>

Get the device list of the currently logged-in user.

kemproApiV2DevicesIdAlertsGet({required String? id}) → Future<Response<List<ActiveAlertV2>>>

Get the active alerts of the device with the given ID @param id

kemproApiV2DevicesIdAlertsResetPost({required int? id}) → Future<Response>

Resets shutdown faults of the device with the given ID @param id

kemproApiV2DevicesIdEventsGet({required String? id}) → Future<Response<List<EventV2>>>

Get the events log of the device with the given ID @param id

kemproApiV2DevicesIdExerciseDelete({required int? id}) → Future<Response>

Deletes the exercise schedule of the device with the given ID @param id

kemproApiV2DevicesIdExerciseGet({required int? id}) → Future<Response<ExerciseInfoV2>>

Get the exercise information of the device with the given ID @param id

kemproApiV2DevicesIdExercisePut({required int? id, required ExerciseScheduleV2Body? body}) → Future<Response<ExerciseInfoV2>>

Update the exercise schedule of the device with the given ID @param id

kemproApiV2DevicesIdExerciseStartPost({required int? id, required ExerciseStartV2Body? body}) → Future<Response>

Start a remote exercise cycle on device with the given ID @param id

kemproApiV2DevicesIdExerciseStopPost({required int? id}) → Future<Response>

Stops a remote exercise cycle on device with the given ID @param id

kemproApiV2DevicesIdGet({required int? id}) → Future<Response<DeviceDetailsV2>>

Get the device details for the device with the given ID.

kemproApiV2DevicesIdMaintenanceGet({required String? id}) → Future<Response<MaintenanceDetailsV2>>

Get the maintenance details of the device with the given ID @param id

kemproApiV2DevicesIdMaintenanceNotesGet({required String? id}) → Future<Response<List<MaintenanceNoteV2>>>

Get the maintenance notes of the device with the given ID @param id

kemproApiV2DevicesIdMaintenanceNotesPost({required String? id, required MaintenanceNoteV2Body? body}) → Future<Response<MaintenanceNoteV2>>

Create a maintenance note to be added to the maintenance log of the device with the given ID @param id

kemproApiV2DevicesIdPeripheralsPeripheralGet({required int? id, required PeripheralV2PathParam? peripheral}) → Future<Response<PeripheralV2>>

Get the peripheral data for the given peripheral of the device with the given ID @param id @param peripheral Path parameter for a peripheral of a device

kemproApiV2DevicesIdPeripheralsRenamePost({required int? id, required PeripheralRenameV2Body? body}) → Future<Response>

Rename the display name of a peripheral entry for a device with the given ID. @param id

kemproApiV2DevicesIdPeripheralsSetValuePost({required int? id, required PeripheralValueUpdateV2Body? body}) → Future<Response>

Set the value of a peripheral entry within the device with the given ID. @param id

kemproApiV2DevicesIdPut({required int? id, required DeviceV2Body? body}) → Future<Response<DeviceV2>>

Update the device display name and address information @param id

kemproApiV2DevicesIdServiceagreementPut({required int? id, required ServiceAgreementUpdateV2Body? body}) → Future<Response>

Update the device's service agreement information

kemproApiV2DevicesIdSignaturesEmailGet({required String? email, required String? id}) → Future<Response<String>>

Get the signature file the given email.

kemproApiV2DevicesIdSignaturesPost({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

kemproApiV2DevicesIdTrendsTrendGet({required int? id, required TrendV2PathParam? trend, DateTime? since}) → Future<Response<List<TrendValueV2>>>

Get the historical trends for the given parameter of the device with the given ID @param id @param trend @param since

kemproApiV2HomeownerAddDevicePost({required HomeownerDeviceAdditionV2Body? body}) → Future<Response>

Add the device to the currently logged-in user's account

kemproApiV2HomeownerHomesGet() → Future<Response<List<HomeV2>>>

Get the home list of the currently logged-in user.

kemproApiV2HomeownerHomesIdDelete({required int? id}) → Future<Response>

Remove the device from the currently logged-in user's account @param id

kemproApiV2HomeownerHomesIdGet({required int? id}) → Future<Response<HomeV2>>

Get the home with the given ID belonging to the currently logged-in user. @param id

kemproApiV2HomeownerHomesPost({required List<HomeAdditionV2Body>? body}) → Future<Response>

Add the list of homes to the currently logged-in user's account

kemproApiV2HomeownerMeGet() → Future<Response<HomeownerV2>>

Get homeowner related information about the currently logged-in user.

kemproApiV2HomeownerOncueImportPost({required OncueImportV2Body? body}) → Future<Response>

Import devices from an OnCue account

kemproApiV2HomeownerOncueVerifyPost({required OncueVerificationV2Body? body}) → Future<Response<OncueVerificationV2>>

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.

kemproApiV2InternalConsentPost({required ConsentUpdateV2Body? body}) → Future<Response>

Update the consent of a user.

kemproApiV2InternalDealerOrgsIdsGet() → Future<Response<List<String>>>

Get a list of all dealer IDs within the PRO system database

kemproApiV2InternalDevicesIdMetadataGet({required int? id}) → Future<Response<InternalDeviceMetadataV2>>

Get metadata about the device, notably whether the device has been approved by its assigned dealer or whether it has been deleted @param id

kemproApiV2InternalNotificationsPost({required NotificationInsertV2Body? body}) → Future<Response>

Insert a notification entry into the database

kemproApiV2InternalNotificationsTokensGet({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

kemproApiV2NotificationsGet({int? deviceId, bool? isUnRead, bool? isDeleted, int? offset, int? limit}) → Future<Response<List<NotificationV2>>>

Get the notifications of the currently logged-in user.

kemproApiV2NotificationsRegisterPost({required NotificationTokenV2Body? body}) → Future<Response>

Register the given notification token so it is associated with the currently logged-in user.

kemproApiV2OktaeventsHomeownersUpsertGet() → Future<Response<OktaVerificationV2>>

Verify that the service supports the homeowner upsert event hook

kemproApiV2OktaeventsHomeownersUpsertPost({required OktaEventV2Body? body}) → Future<Response>

Event hook endpoint that should be called by Okta when a homeowner has been created or updated.

kemproApiV2OktaeventsUsersActivatedGet() → Future<Response<OktaVerificationV2>>

Verify that the service supports the pro user activated event hook

kemproApiV2OktaeventsUsersActivatedPost({required OktaEventV2Body? 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.

kemproApiV2OrgDevicesAddressGet({String? address}) → Future<Response<List<DeviceAddressV2>>>

Search and return a list of address results based on an input value of Address (partial or complete) @param address

kemproApiV2OrgDevicesBulkPost({required List<int>? body}) → Future<Response>

Add devices to a dealer's organization in bulk.

kemproApiV2OrgDevicesDealerIdGet({required String? dealerId}) → Future<Response<List<DeviceDataV2>>>

Get users for a dealer organization. If no dealer ID is provided, return users for the logged-in dealer. @param dealerId

kemproApiV2OrgDevicesDeviceIdDelete({required int? deviceId}) → Future<Response>

@param deviceId

kemproApiV2OrgDevicesDeviceIdPut({required String? deviceId, required DeviceUpdateV2Body? body}) → Future<Response>

Begins the process for updating a device to a dealer organization's fleet.

kemproApiV2OrgDevicesPost({required DeviceAdditionV2Body? body}) → Future<Response>

Begins the process for adding a device to a dealer organization's fleet.

kemproApiV2OrgDevicesSearchGet({String? deviceText, String? userText, String? addressText, String? serialNumber, String? displayName, String? username, String? email, bool? excludeDevicesWithDealers}) → Future<Response<List<DeviceDataV2>>>

Search all devices and return a list of device data that contain text from the given input values. Fields are case insensitive. Multiple fields can be provided to make the search more precise.

kemproApiV2OrgDevicesVerifyGet({String? serialNumber, String? controllerPin}) → Future<Response<DeviceVerificationV2>>

Get verification information on the given serial number and controller PIN. @param serialNumber @param controllerPin

kemproApiV2OrgInfoGet() → Future<Response<DealerOrgV2>>

Get authentication information about the currently logged-in dealer

kemproApiV2OrgMeGet() → Future<Response<DealerV2>>

Get authentication information about the currently logged-in dealer

kemproApiV2OrgUserEmailGet({required String? email}) → Future<Response<DealerUserV2>>

Get user info by email. @param email

kemproApiV2OrgUsersDealerIdGet({required String? dealerId}) → Future<Response<List<DealerUserV2>>>

Get users for a dealer organization. If no dealer ID is provided, return users for the logged-in dealer. @param dealerId

kemproApiV2OrgUsersIdPut({required int? id, required UserAdditionV2Body? body}) → Future<Response>

@param id

kemproApiV2OrgUsersPost({required UserAdditionV2Body? body}) → Future<Response>

Add a user to a dealer organizations fleet.

kemproApiV2OrgUsersUserIdDelete({required int? userId}) → Future<Response>

@param userId

kemproApiV2OrgUsersUserIdResendInvitePost({required int? userId}) → Future<Response>

Resend a marketing cloud invitation to a user, to allow them to login and access the Energy Management platform.

kemproApiV2WizardDealerIdGet({required String? dealerId}) → Future<Response<WizardDetailsV2>>

Get the Wizard progess for the dealer of the logged-in user.

kemproApiV2WizardDealerIdPut({required String? dealerId, required WizardUpdateV2Body? body}) → Future<Response>

Update the dealer Wizard progress. @param dealerId

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}) → EnergyManagementApi