Variable NodeMappingHelperConst

Type declaration

• addNodeMapping:function

  • addNodeMapping(nodeId: string, secretKey: string): Promise<string>

  • Associates a node with a user by mapping the provided node ID to a secret key.

    Parameters

    • nodeId: string

      The unique identifier of the node to be mapped. This parameter is required.
    • secretKey: string

      The secret key corresponding to the node. This parameter is required.

    Returns Promise<string>

    A promise that resolves to the request_id generated for this operation.

    Throws

    If the nodeId or secretKey is missing.

    Throws

    If the API request fails.

• getNodeMappingStatus:function

  • getNodeMappingStatus(requestID: string): Promise<string>

  • Retrieves the status of a node mapping request.

    Parameters

    • requestID: string

      The unique identifier of the node mapping request. This parameter is required.

    Returns Promise<string>

    A promise that resolves to the status of the node mapping request.

    Throws

    If the API request fails.

• initiateUserNodeMapping:function

  • initiateUserNodeMapping(requestBody?: Record<string, any>): Promise<any>

  • Initiates a user node mapping request.

    Parameters

    • requestBody: Record<string, any> = {}

      The request body for the user node mapping.

    Returns Promise<any>

    A promise that resolves to the response from the API.

• verifyUserNodeMapping:function

  • verifyUserNodeMapping(
        requestBody?: Record<string, any>,
    ): Promise<ESPAPIResponse>

  • Verifies the mapping between a user and a node.

    Parameters

    • requestBody: Record<string, any> = {}

      The request body for the user node mapping verification.

    Returns Promise<ESPAPIResponse>

    A promise that resolves to the response from the API.