Class ESPSigV4APIManager

Base API manager: plain HTTP calls with no signing. Use for unauthenticated endpoints (e.g. token/refresh) and endpoints that carry a Cognito bearer token in the Authorization header. ESPSigV4APIManager extends this and adds SigV4 for authenticated calls.

Hierarchy (View Summary)

Methods

delete get getUserApiWithBearer patch post postUserApi postUserApiWithBearer put putUserApiWithBearer request _construct _constructSigV4 getInstance getIotMqttWebSocketSignedUrl

Methods

delete

  • delete<T>(path: string, headers?: { [key: string]: string }): Promise<T>

    Type Parameters

    • T

    Parameters

    • path: string
    • headers: { [key: string]: string } = {}

    Returns Promise<T>

get

  • get<T>(path: string, headers?: { [key: string]: string }): Promise<T>

    Type Parameters

    • T

    Parameters

    • path: string
    • headers: { [key: string]: string } = {}

    Returns Promise<T>

getUserApiWithBearer

patch

  • patch<T>(
        path: string,
        data: any,
        headers?: { [key: string]: string },
    ): Promise<T>

    Type Parameters

    • T

    Parameters

    • path: string
    • data: any
    • headers: { [key: string]: string } = {}

    Returns Promise<T>

post

  • post<T>(
        path: string,
        data: any,
        headers?: { [key: string]: string },
    ): Promise<T>

    Type Parameters

    • T

    Parameters

    • path: string
    • data: any
    • headers: { [key: string]: string } = {}

    Returns Promise<T>

postUserApi

postUserApiWithBearer

put

  • put<T>(path: string, data: any, headers?: { [key: string]: string }): Promise<T>

    Type Parameters

    • T

    Parameters

    • path: string
    • data: any
    • headers: { [key: string]: string } = {}

    Returns Promise<T>

putUserApiWithBearer

request

  • request<T>(
        method: string,
        path: string,
        data?: any,
        headers?: { [key: string]: string },
    ): Promise<T>

    Orchestrates fetch + parse for User API calls.

    Type Parameters

    • T

    Parameters

    • method: string
    • path: string
    • Optionaldata: any
    • headers: { [key: string]: string } = {}

    Returns Promise<T>

Static_construct

Static_constructSigV4

StaticgetInstance

StaticgetIotMqttWebSocketSignedUrl

  • getIotMqttWebSocketSignedUrl(
        credentials: {
            accessKey: string;
            secretKey: string;
            sessionToken?: string;
        },
        iotEndpointOrHost: string,
        awsRegion: string,
        options?: { expiresSeconds?: number },
    ): string

    Presigned wss://…/mqtt?… URL for AWS IoT Core MQTT over WebSocket (SigV4 query signing, service iotdevicegateway). Uses the same signing primitives as ESPSigV4APIManager._signedRequest.

    Parameters

    • credentials: { accessKey: string; secretKey: string; sessionToken?: string }

      Temporary AWS credentials (e.g. from ESPRMNeoUser.getTemporaryAWSCredentials).

    • iotEndpointOrHost: string

      Raw config.iotEndpoint, a full wss://…/mqtt URL, or hostname only.

    • awsRegion: string

      AWS region for signing (e.g. "us-east-1"). Required; passed explicitly so this helper stays pure and doesn't reach back to global SDK config.

    • Optionaloptions: { expiresSeconds?: number }

      Optional URL expiry (default 86400s).

    Returns string

Settings

Member Visibility

On This Page

Methods