Class ESPRMUser

constructor

• new ESPRMUser(tokens: UserTokensData): ESPRMUser

  Initializes the ESPRMUser instance and stores tokens in local storage.

  Parameters

  • tokens: UserTokensData

    Object containing the access token, id token, and refresh token.

  Returns ESPRMUser

eventCallbacks

StaticuserId

addDaylightBasedAutomation

• addDaylightBasedAutomation(
      automationDetails: ESPDaylightAutomationDetails,
  ): Promise<ESPAutomation>

  Adds a new daylight-based automation trigger for particular nodes.

  Parameters

  • automationDetails: ESPDaylightAutomationDetails

    The details of the daylight-based automation trigger and action to add.

  Returns Promise<ESPAutomation>

  A promise that resolves to an ESPAutomation instance containing details of the newly created automation.

addTags

• addTags(tags: string[]): Promise<ESPAPIResponse>

  Adds tags to the current user.

  This method sends a request to associate the provided tags with the currently logged-in user.

  Parameters

  • tags: string[]

    An array of strings representing the tags to be added.

  Returns Promise<ESPAPIResponse>

  A promise that resolves to an ESPAPIResponse containing the result of the operation.

addWeatherBasedAutomation

• addWeatherBasedAutomation(
      automationDetails: ESPWeatherAutomationDetails,
  ): Promise<ESPAutomation>

  Adds a weather-based automation trigger for specific nodes.

  Parameters

  • automationDetails: ESPWeatherAutomationDetails

    The details of the automation to be added.

  Returns Promise<ESPAutomation>

  A promise that resolves to an ESPAutomation instance containing details of the newly created automation.

changePassword

• changePassword(
      oldPassword: string,
      newPassword: string,
  ): Promise<ESPAPIResponse>

  Changes the user's password by providing their old password and a new password.

  Parameters

  • oldPassword: string

    The user's current password.
  • newPassword: string

    The new password to set for the user.

  Returns Promise<ESPAPIResponse>

  A promise that resolves to an ESPAPIResponse indicating the success of the password change.

cleanUpResources

• cleanUpResources(): Promise<void>

  Cleans up resources associated with the user.

  This method retrieves the device token map from storage, deletes the endpoint associated with the user's device token, and clears all tokens from storage.

  Returns Promise<void>

  A promise that resolves when the resources are cleaned up.

configureMFA

• configureMFA(enabled: boolean): Promise<ESPAPIResponse>

  Enables or disables multi-factor authentication (MFA) for the current user.

  Parameters

  • enabled: boolean

    A boolean indicating whether MFA should be enabled (true) or not (false).

  Returns Promise<ESPAPIResponse>

  A promise that resolves to an ESPAPIResponse object containing the result of the operation.

confirmAccountDeletion

• confirmAccountDeletion(verificationCode: string): Promise<ESPAPIResponse>

  Confirms the account deletion request by providing a verification code.

  Parameters

  • verificationCode: string

    The verification code sent to the user for account deletion confirmation.

  Returns Promise<ESPAPIResponse>

  A promise that resolves to an ESPAPIResponse indicating the success of the account deletion confirmation.

confirmPhoneNumber

• confirmPhoneNumber(verificationCode: string): Promise<ESPAPIResponse>

  Confirms the phone number associated with the user by providing a verification code.

  Parameters

  • verificationCode: string

    The verification code sent to the user for confirming the phone number.

  Returns Promise<ESPAPIResponse>

  A promise that resolves to an ESPAPIResponse indicating the success of the phone number confirmation.

confirmTagAssignment

• confirmTagAssignment(verificationCode: string): Promise<ESPAPIResponse>

  Confirms the assignment of tags to the user by providing a verification code.

  Parameters

  • verificationCode: string

    The verification code for confirming the tag assignment.

  Returns Promise<ESPAPIResponse>

  A promise that resolves to an ESPAPIResponse indicating the success of the tag assignment confirmation.

createESPDevice

• createESPDevice(
      name: string,
      transport: ESPTransport,
      security?: ESPSecurity,
      proofOfPossession?: string,
      softAPPassword?: string,
      username?: string,
  ): Promise<ESPDevice>

  Creates an ESP device with the given parameters.

  Parameters

  • name: string

    The name of the device.
  • transport: ESPTransport

    The transport type to use.
  • Optionalsecurity: ESPSecurity

    The security type to use (optional).
  • OptionalproofOfPossession: string

    The proof of possession string (optional).
  • OptionalsoftAPPassword: string

    The SoftAP password (optional).
  • Optionalusername: string

    The username (optional).

  Returns Promise<ESPDevice>

  A promise that resolves to an ESPDevice instance.

createGroup

• createGroup(groupInfo: CreateGroupRequest): Promise<ESPRMGroup>

  Creates a new group with the specified parameters.

  Parameters

  • groupInfo: CreateGroupRequest

    The details of the group to be created, including name, node IDs, description, and other optional fields.

  Returns Promise<ESPRMGroup>

  A promise that resolves to an instance of the newly created ESPRMGroup.

createPlatformEndpoint

• createPlatformEndpoint(
      createPlatformEndpointRequestParams: CreatePlatformEndpointRequest,
  ): Promise<string>

  Creates a platform endpoint for push notifications.

  Parameters

  • createPlatformEndpointRequestParams: CreatePlatformEndpointRequest

    The parameters required to create the platform endpoint.

  Returns Promise<string>

  A promise resolving to the platform endpoint.

deleteCustomData

• deleteCustomData(forKey: string): Promise<ESPAPIResponse>

  Deletes the custom data value associated with the specified key for the current user. This method sends a request to delete the custom data value for the given key associated with the currently logged-in user.

  Parameters

  • forKey: string

    The key for which the custom data value is to be deleted.

  Returns Promise<ESPAPIResponse>

  A promise that resolves to a success response upon deleting the custom data.

deleteCustomDataKey

• deleteCustomDataKey(name: string): Promise<ESPAPIResponse>

  Deletes the custom data entry associated with the specified key for the current user. This method sends a request to delete the custom data entry for the specified key associated with the currently logged-in user.

  Parameters

  • name: string

    The key of the custom data entry to be deleted.

  Returns Promise<ESPAPIResponse>

  A promise that resolves to an ESPAPIResponse indicating the success or failure of the operation.

deleteCustomDataPermissions

• deleteCustomDataPermissions(forKey: string): Promise<ESPAPIResponse>

  Deletes the custom data pemissions associated with the specified key for the current user. This method sends a request to delete the custom data permissions for the given key associated with the currently logged-in user.

  Parameters

  • forKey: string

    The key for which the custom data permissions is to be deleted.

  Returns Promise<ESPAPIResponse>

  A promise that resolves to a success response upon deleting the custom data permissions.

deleteEndpoint

• deleteEndpoint(deviceToken?: string, endpoint?: string): Promise<ESPAPIResponse>

  Deletes a platform endpoint associated with the specified device token or endpoint.

  Parameters

  • OptionaldeviceToken: string

    The mobile device token used for identifying the platform endpoint.
  • Optionalendpoint: string

    The unique endpoint identifier to delete.

  Returns Promise<ESPAPIResponse>

  A promise resolving to the API response, indicating success or failure.

  Throws

  ESPAPICallValidationError - Throws an error if both deviceToken and endpoint are missing.

getAutomationDetail

• getAutomationDetail(automationId: string): Promise<ESPAutomation>

  Retrieves an automation based on the provided automation ID.

  Parameters

  • automationId: string

    The ID of the automation to be fetched.

  Returns Promise<ESPAutomation>

  A promise that resolves to an ESPAutomation instance containing the automation details.

getAutomations

• getAutomations(): Promise<ESPPaginatedAutomationsResponse>

  Retrieves a list of all automations with optional pagination.

  Returns Promise<ESPPaginatedAutomationsResponse>

  A promise that resolves to a paginated response containing automation data.

getCustomData

• getCustomData(): Promise<UserCustomDataResponse>

  Fetches custom data associated with the current user. This method sends a request to fetch custom data associated with the currently logged-in user.

  Returns Promise<UserCustomDataResponse>

  A promise that resolves with the custom data associated with the user.

getGeoCoordinates

• getGeoCoordinates(): Promise<ESPGeoCoordinates>

  Retrieves the user's geographical coordinates from the custom data.

  Returns Promise<ESPGeoCoordinates>

  A promise that resolves to an ESPGeoCoordinates object containing the latitude and longitude.

  Throws

  If the coordinates are not found in the custom data.

getGroupById

• getGroupById(
      getGroupByIdRequestParams: GetGroupByIdRequestParams,
  ): Promise<ESPRMGroup>

  Retrieves a group by its ID.

  Parameters

  • getGroupByIdRequestParams: GetGroupByIdRequestParams

    Parameters to filter the group data by ID.

  Returns Promise<ESPRMGroup>

  A promise that resolves to an instance of ESPRMGroup.

  Throws

  ESPAPICallValidationError if the group ID is missing in the request parameters.

getGroupByName

• getGroupByName(
      getGroupByNameRequestParams: GetGroupByNameRequestParams,
  ): Promise<ESPRMGroup>

  Retrieves a group by its name.

  Parameters

  • getGroupByNameRequestParams: GetGroupByNameRequestParams

    Parameters to filter the group data by name.

  Returns Promise<ESPRMGroup>

  A promise that resolves to an instance of ESPRMGroup.

  Throws

  ESPAPICallValidationError if the group name is missing in the request parameters.

getGroups

• getGroups(
      getGroupsRequestParams: GetGroupsRequestParams,
  ): Promise<ESPPaginatedGroupsResponse>

  Retrieves a list of groups with optional filters and pagination.

  Parameters

  • getGroupsRequestParams: GetGroupsRequestParams

    Parameters to filter and paginate the group data.

  Returns Promise<ESPPaginatedGroupsResponse>

  A promise that resolves to a paginated response containing group data.

getIssuedGroupSharingRequests

• getIssuedGroupSharingRequests(count?: number): Promise<ESPGroupSharingResponse>

  Parameters

  • Optionalcount: number

  Returns Promise<ESPGroupSharingResponse>

getIssuedNodeSharingRequests

• getIssuedNodeSharingRequests(
      pageCount?: number,
  ): Promise<ESPNodeSharingResponse>

  Fetches node sharing requests for the user with optional pagination.

  Parameters

  • OptionalpageCount: number

    The number of results to fetch per request. If not provided, the default value is used.

  Returns Promise<ESPNodeSharingResponse>

  A promise that resolves to a paginated response containing node sharing requests.

getNodeDetails

• getNodeDetails(nodeId: string): Promise<ESPRMNode>

  Parameters

  • nodeId: string

  Returns Promise<ESPRMNode>

getPlatformEndpoints

• getPlatformEndpoints(): Promise<ESPPlatformEndpoint[]>

  Fetches a list of registered platform endpoints associated with the user.

  Returns Promise<ESPPlatformEndpoint[]>

  A promise that resolves to an array of ESPPlatformEndpoint instances.

getReceivedGroupSharingRequests

• getReceivedGroupSharingRequests(
      count?: number,
  ): Promise<ESPGroupSharingResponse>

  Parameters

  • Optionalcount: number

  Returns Promise<ESPGroupSharingResponse>

getReceivedNodeSharingRequests

• getReceivedNodeSharingRequests(
      resultCount?: number,
  ): Promise<ESPNodeSharingResponse>

  Fetches node sharing invitations for the user with optional pagination.

  Parameters

  • OptionalresultCount: number

    The number of results to fetch per request. If not provided, the default value is used.

  Returns Promise<ESPNodeSharingResponse>

  A promise that resolves to a paginated response containing node sharing invitations.

getUserInfo

• getUserInfo(withCustomData?: boolean): Promise<ESPRMUserInfo>

  Retrieves user information, optionally including custom data.

  Parameters

  • OptionalwithCustomData: boolean

    Optional flag indicating whether to include custom data in the response. Defaults to false.

  Returns Promise<ESPRMUserInfo>

  A promise that resolves to an ESPRMUserInfo object containing the user information.

getUserNodes

• getUserNodes(resultCount?: number): Promise<ESPPaginatedNodesResponse>

  Fetches user nodes with optional pagination.

  Parameters

  • OptionalresultCount: number

    An optional parameter to specify the number of results to retrieve. If not provided, all available results will be fetched.

  Returns Promise<ESPPaginatedNodesResponse>

  A promise that resolves to a paginated response containing the user nodes.

getUserNodesWith

• getUserNodesWith(
      getUserNodesWithRequestParams: GetUserNodesRequestParams,
  ): Promise<ESPPaginatedNodesResponse>

  Retrieves user nodes based on the provided request parameters.

  Parameters

  • getUserNodesWithRequestParams: GetUserNodesRequestParams

    The parameters for the request to get user nodes.

  Returns Promise<ESPPaginatedNodesResponse>

  A promise that resolves to a paginated response containing the user nodes.

logout

• logout(shouldLogoutFromAllSessions?: boolean): Promise<ESPAPIResponse>

  Logs out the current user, with an option to log out from all sessions.

  Parameters

  • OptionalshouldLogoutFromAllSessions: boolean

    Optional flag indicating whether to log out from all sessions. Defaults to false.

  Returns Promise<ESPAPIResponse>

  A promise that resolves to an ESPAPIResponse object containing the result of the logout operation.

removeAllCallbacks

• removeAllCallbacks(event?: ESPRMEventType): void

  Removes all callbacks for a specified event or all events.

  Parameters

  • Optionalevent: ESPRMEventType

    (Optional) The event for which to remove callbacks. If omitted, all callbacks for all events are removed.

  Returns void

removeTags

• removeTags(tags: string[]): Promise<ESPAPIResponse>

  Removes tags to the current user.

  This method sends a request to remove the provided tags with the currently logged-in user.

  Parameters

  • tags: string[]

    An array of strings representing the tags to be removed.

  Returns Promise<ESPAPIResponse>

  A promise that resolves to an ESPAPIResponse containing the result of the operation.

requestAccountDeletion

• requestAccountDeletion(): Promise<ESPAPIResponse>

  Sends a request to initiate the account deletion process.

  Returns Promise<ESPAPIResponse>

  A promise that resolves to an ESPAPIResponse indicating the success of the account deletion request.

searchESPBLEDevices

• searchESPBLEDevices(customerId: number): Promise<ESPDevice[]>

  Searches for ESP BLE devices with the given customer ID.

  Parameters

  • customerId: number

    The customer ID to search for.

  Returns Promise<ESPDevice[]>

  A promise that resolves to an array of ESPDevice instances.

searchESPDevices

• searchESPDevices(
      devicePrefix: string,
      transport: ESPTransport,
  ): Promise<ESPDevice[]>

  Searches for ESP devices with the given prefix.

  Parameters

  • devicePrefix: string

    The prefix of the device name to search for.
  • transport: ESPTransport

  Returns Promise<ESPDevice[]>

  A promise that resolves to an array of ESPDevice instances.

setCustomData

• setCustomData(data: UserCustomDataRequest): Promise<ESPAPIResponse>

  Sets custom data associated with the current user. This method sends a request to set custom data for the currently logged-in user.

  Parameters

  • data: UserCustomDataRequest

    The custom data to be set for the user.

  Returns Promise<ESPAPIResponse>

  A promise that resolves to an ESPAPIResponse indicating the success of the operation.

setGeoCoordinates

• setGeoCoordinates(geoCoordinates: ESPGeoCoordinates): Promise<ESPAPIResponse>

  Stores the user's geographical coordinates in the custom data.

  Parameters

  • geoCoordinates: ESPGeoCoordinates

    An object containing the latitude and longitude to be stored.

  Returns Promise<ESPAPIResponse>

  A promise that resolves to an ESPAPIResponse indicating the success of the operation.

setMultipleNodesParams

• setMultipleNodesParams(payload: MultipleNodePayload[]): Promise<ESPAPIResponse>

  Sets multiple parameters for the nodes.

  Parameters

  • payload: MultipleNodePayload[]

    The payload containing the parameters to be set for multiple nodes.

  Returns Promise<ESPAPIResponse>

  A promise that resolves to the API response.

setPhoneNumber

• setPhoneNumber(phoneNumber: string): Promise<ESPAPIResponse>

  Updates the phone number associated with the current user.

  Parameters

  • phoneNumber: string

    The new phone number to be set for the user.

  Returns Promise<ESPAPIResponse>

  A promise that resolves to an ESPAPIResponse object containing the result of the operation.

setTimeZone

• setTimeZone(timeZoneString: string): Promise<ESPAPIResponse>

  Set the timeZone for the user in the user's custom data.

  Parameters

  • timeZoneString: string

    The timeZone string to set.

  Returns Promise<ESPAPIResponse>

  A promise that resolves to an ESPAPIResponse indicating the success of the operation.

shareGroups

• shareGroups(shareGroupsRequestParams: ShareGroupsRequest): Promise<string>

  Shares the specified groups with a user.

  Parameters

  • shareGroupsRequestParams: ShareGroupsRequest

    The parameters needed for sharing groups.

  Returns Promise<string>

  A promise that resolves to the request ID from the API.

stopESPDevicesSearch

• stopESPDevicesSearch(): Promise<void>

  Stop the search for ESP devices.

  Returns Promise<void>

subscribe

• subscribe(event: ESPRMEventType, callback: Function | Function[]): void

  Subscribes a callback function or an array of callback functions to a specified event.

  Parameters

  • event: ESPRMEventType

    The event to subscribe to, represented by ESPRMEventType.
  • callback: Function | Function[]

    The callback function or an array of callback functions to execute when the event is triggered.

  Returns void

  Throws

  An error if the event type is invalid.

transferGroups

• transferGroups(
      transferGroupsRequestParams: TransferGroupsRequest,
  ): Promise<string>

  Transfers the specified groups to another user.

  Parameters

  • transferGroupsRequestParams: TransferGroupsRequest

    The parameters needed for transferring groups.

  Returns Promise<string>

  A promise that resolves to the request ID from the API.

trigger

• trigger(event: ESPRMEventType, arg: any): void

  Triggers an event and executes all associated callback functions with the provided argument.

  Parameters

  • event: ESPRMEventType

    The event to trigger, represented by ESPRMEventType.
  • arg: any

    The argument to pass to the callback functions.

  Returns void

unsubscribe

• unsubscribe(event: ESPRMEventType, callback: Function): void

  Unsubscribes a specific callback function from a specified event.

  Parameters

  • event: ESPRMEventType

    The event to unsubscribe from, represented by ESPRMEventType.
  • callback: Function

    The callback function to remove.

  Returns void

updateName

• updateName(newName: string): Promise<ESPAPIResponse>

  Updates the name associated with the current user.

  Parameters

  • newName: string

    The new name to be set for the user.

  Returns Promise<ESPAPIResponse>

  A promise that resolves to an ESPAPIResponse object containing the result of the operation.

StaticclearAllTokens

• clearAllTokens(): void

  Clears all tokens from memory and local storage.

  Returns void

StaticextendSession

• extendSession(refreshToken: string): Promise<string>

  Extends the session by exchanging the refresh token for a new access token and id token.

  Parameters

  • refreshToken: string

    The refresh token used to extend the session.

  Returns Promise<string>

  A promise that resolves to the new access token.

  Throws

  Error if session extension fails.

StaticgetAccessToken

• getAccessToken(): Promise<string>

  Retrieves the current access token. If the access token is expired, it attempts to extend the session using the refresh token.

  Returns Promise<string>

  A promise that resolves to the access token or an empty string if no valid token is available.