Class ESPRMNode

constructor

• new ESPRMNode(data: ESPRMNodeInterface): ESPRMNode

  Creates an instance of ESPRMNode.

  Parameters

  • data: ESPRMNodeInterface

    An object containing the node details.

  Returns ESPRMNode

availableTransports

OptionalconnectivityStatus

id

OptionalisPrimaryUser

Optionalmetadata

OptionalnodeConfig

Optionalrole

Optionaltags

transportOrder

Optionaltype

addAutomation

• addAutomation(automationDetails: ESPAutomationDetails): Promise<ESPAutomation>

  Adds a new automation trigger for the node.

  Parameters

  • automationDetails: ESPAutomationDetails

    The details of the automation trigger and action to add.

  Returns Promise<ESPAutomation>

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

attachTags

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

  Attaches tags to the node.

  Parameters

  • tags: string[]

    An array of tags to attach to the node.

  Returns Promise<ESPAPIResponse>

  A promise that resolves to the API response.

checkOTAUpdate

• checkOTAUpdate(): Promise<ESPOTAUpdateResponse>

  Checks if there is an Over-The-Air (OTA) update available for the node.

  Returns Promise<ESPOTAUpdateResponse>

  A promise that resolves to an ESPOTAUpdateResponse object containing details about the OTA update availability.

delete

• delete(): Promise<ESPAPIResponse>

  Deletes the mapping of current node with user.

  Returns Promise<ESPAPIResponse>

  A promise that resolves to the API success response.

deleteMetadata

• deleteMetadata(): Promise<ESPAPIResponse>

  Returns Promise<ESPAPIResponse>

getAutomations

• getAutomations(): Promise<ESPPaginatedAutomationsResponse>

  Retrieves a list of all automations for this node with optional pagination.

  Returns Promise<ESPPaginatedAutomationsResponse>

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

getConnectivityStatus

• getConnectivityStatus(): Promise<ESPRMConnectivityStatus>

  Returns Promise<ESPRMConnectivityStatus>

getNodeConfig

• getNodeConfig(): Promise<ESPRMNodeConfig>

  Returns Promise<ESPRMNodeConfig>

getOTAUpdateStatus

• getOTAUpdateStatus(otaJobId: string): Promise<ESPOTAUpdateStatusResponse>

  Checks the status of a previously initiated Over-The-Air (OTA) update for the node.

  Parameters

  • otaJobId: string

    The ID of the OTA job for which the status is being checked.

  Returns Promise<ESPOTAUpdateStatusResponse>

  A promise that resolves to an ESPOTAUpdateStatusResponse object containing details about the OTA update status.

  Throws

  If the OTA job ID is missing or invalid.

getServices

• getServices(): Promise<ESPRMService[]>

  Fetches the services for the current node.

  Returns Promise<ESPRMService[]>

  A promise that resolves to an array of updated services.

pushOTAUpdate

• pushOTAUpdate(otaJobId: string): Promise<ESPAPIResponse>

  Initiates an Over-The-Air (OTA) update for the node using a specified OTA job ID.

  Parameters

  • otaJobId: string

    The ID of the OTA job to be used for the update.

  Returns Promise<ESPAPIResponse>

  A promise that resolves to an ESPAPIResponse object confirming the successful initiation of the OTA update.

  Throws

  If the OTA job ID is missing or invalid.

removeSharingFor

• removeSharingFor(username: string): Promise<ESPAPIResponse>

  Remove sharing of the current node for a specified user.

  Parameters

  • username: string

    The username of the user for whom the sharing is to be removed.

  Returns Promise<ESPAPIResponse>

  A promise that resolves to a success response upon successful removal.

removeTags

• removeTags(): Promise<ESPAPIResponse>

  Returns Promise<ESPAPIResponse>

setMultipleParams

• setMultipleParams(payload: NodePayload): Promise<ESPAPIResponse>

  Sets multiple parameters for the node.

  Parameters

  • payload: NodePayload

    The payload containing the parameters to be set.

  Returns Promise<ESPAPIResponse>

  A promise that resolves to the API response.

setTimeZone

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

  Set the timeZone for the node.

  Parameters

  • timeZoneString: string

    The timeZone string to set.

  Returns Promise<ESPAPIResponse>

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

shareWith

• shareWith(shareNodeWithRequestParams: ShareWithRequest): Promise<string>

  Parameters

  • shareNodeWithRequestParams: ShareWithRequest

  Returns Promise<string>

transferNode

• transferNode(transferNodeRequestParams: TransferNodeRequest): Promise<string>

  Create Transfer request of the current node to a specified user.

  Parameters

  • transferNodeRequestParams: TransferNodeRequest

    Parameters specifying the user and transfer options.

  Returns Promise<string>

  A promise that resolves to a requestId upon successful transfer request creation.

updateMetadata

• updateMetadata(metadata: Record<string, any>): Promise<ESPAPIResponse>

  Parameters

  • metadata: Record<string, any>

  Returns Promise<ESPAPIResponse>