Class SeamHttpDevicesSimulate

constructor

• new SeamHttpDevicesSimulate(
      apiKeyOrOptions?: string | SeamHttpOptions,
  ): SeamHttpDevicesSimulate

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpDevicesSimulate

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

connect

• connect(
      parameters: { device_id: string },
      options?: DevicesSimulateConnectOptions,
  ): DevicesSimulateConnectRequest

  Parameters

  • parameters: { device_id: string }

    • device_id: string

      ID of the device that you want to simulate connecting to Seam.

  • options: DevicesSimulateConnectOptions = {}

  Returns DevicesSimulateConnectRequest

connectToHub

• connectToHub(
      parameters: { device_id: string },
      options?: DevicesSimulateConnectToHubOptions,
  ): DevicesSimulateConnectToHubRequest

  Parameters

  • parameters: { device_id: string }

    • device_id: string

      ID of the device whose hub you want to reconnect.

  • options: DevicesSimulateConnectToHubOptions = {}

  Returns DevicesSimulateConnectToHubRequest

createPaginator

• createPaginator<
      const TResponse,
      const TResponseKey extends string | number | symbol,
  >(
      request: SeamHttpRequest<TResponse, TResponseKey>,
  ): SeamPaginator<TResponse, TResponseKey>

  Type Parameters

  • const TResponse
  • const TResponseKey extends string | number | symbol

  Parameters

  • request: SeamHttpRequest<TResponse, TResponseKey>

  Returns SeamPaginator<TResponse, TResponseKey>

disconnect

• disconnect(
      parameters: { device_id: string },
      options?: DevicesSimulateDisconnectOptions,
  ): DevicesSimulateDisconnectRequest

  Parameters

  • parameters: { device_id: string }

    • device_id: string

      ID of the device that you want to simulate disconnecting from Seam.

  • options: DevicesSimulateDisconnectOptions = {}

  Returns DevicesSimulateDisconnectRequest

disconnectFromHub

• disconnectFromHub(
      parameters: { device_id: string },
      options?: DevicesSimulateDisconnectFromHubOptions,
  ): DevicesSimulateDisconnectFromHubRequest

  Parameters

  • parameters: { device_id: string }

    • device_id: string

      ID of the device whose hub you want to disconnect.

  • options: DevicesSimulateDisconnectFromHubOptions = {}

  Returns DevicesSimulateDisconnectFromHubRequest

paidSubscription

• paidSubscription(
      parameters: { device_id: string; is_expired: boolean },
      options?: DevicesSimulatePaidSubscriptionOptions,
  ): DevicesSimulatePaidSubscriptionRequest

  Parameters

  • parameters: { device_id: string; is_expired: boolean }
  • options: DevicesSimulatePaidSubscriptionOptions = {}

  Returns DevicesSimulatePaidSubscriptionRequest

remove

• remove(
      parameters: { device_id: string },
      options?: DevicesSimulateRemoveOptions,
  ): DevicesSimulateRemoveRequest

  Parameters

  • parameters: { device_id: string }

    • device_id: string

      ID of the device that you want to simulate removing from Seam.

  • options: DevicesSimulateRemoveOptions = {}

  Returns DevicesSimulateRemoveRequest

updateClientSessionToken

• updateClientSessionToken(clientSessionToken: string): Promise<void>

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(
      apiKey: string,
      options?: Omit<SeamHttpOptionsWithApiKey, "apiKey">,
  ): SeamHttpDevicesSimulate

  Parameters

  • apiKey: string
  • options: Omit<SeamHttpOptionsWithApiKey, "apiKey"> = {}

  Returns SeamHttpDevicesSimulate

StaticfromClient

• fromClient(
      client: AxiosInstance,
      options?: Omit<SeamHttpOptionsWithClient, "client">,
  ): SeamHttpDevicesSimulate

  Parameters

  • client: AxiosInstance
  • options: Omit<SeamHttpOptionsWithClient, "client"> = {}

  Returns SeamHttpDevicesSimulate

StaticfromClientSessionToken

• fromClientSessionToken(
      clientSessionToken: string,
      options?: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken">,
  ): SeamHttpDevicesSimulate

  Parameters

  • clientSessionToken: string
  • options: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken"> = {}

  Returns SeamHttpDevicesSimulate

StaticfromConsoleSessionToken

• fromConsoleSessionToken(
      consoleSessionToken: string,
      workspaceId: string,
      options?: Omit<
          SeamHttpOptionsWithConsoleSessionToken,
          "consoleSessionToken"
          | "workspaceId",
      >,
  ): SeamHttpDevicesSimulate

  Parameters

  • consoleSessionToken: string
  • workspaceId: string
  • options: Omit<
        SeamHttpOptionsWithConsoleSessionToken,
        "consoleSessionToken"
        | "workspaceId",
    > = {}

  Returns SeamHttpDevicesSimulate

StaticfromPersonalAccessToken

• fromPersonalAccessToken(
      personalAccessToken: string,
      workspaceId: string,
      options?: Omit<
          SeamHttpOptionsWithPersonalAccessToken,
          "personalAccessToken"
          | "workspaceId",
      >,
  ): SeamHttpDevicesSimulate

  Parameters

  • personalAccessToken: string
  • workspaceId: string
  • options: Omit<
        SeamHttpOptionsWithPersonalAccessToken,
        "personalAccessToken"
        | "workspaceId",
    > = {}

  Returns SeamHttpDevicesSimulate

StaticfromPublishableKey

• fromPublishableKey(
      publishableKey: string,
      userIdentifierKey: string,
      options?: SeamHttpFromPublishableKeyOptions,
  ): Promise<SeamHttpDevicesSimulate>

  Parameters

  • publishableKey: string
  • userIdentifierKey: string
  • options: SeamHttpFromPublishableKeyOptions = {}

  Returns Promise<SeamHttpDevicesSimulate>