Class SeamHttpDevicesSimulate

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpDevicesSimulate

client

Readonlydefaults

connect

• connect(
      parameters: DevicesSimulateConnectParameters,
      options?: DevicesSimulateConnectOptions,
  ): DevicesSimulateConnectRequest

  Simulates connecting a device to Seam. Only applicable for sandbox devices. See also Testing Your App Against Device Disconnection and Removal.

  Parameters

  • parameters: DevicesSimulateConnectParameters
  • options: DevicesSimulateConnectOptions = {}

  Returns DevicesSimulateConnectRequest

connectToHub

• connectToHub(
      parameters: DevicesSimulateConnectToHubParameters,
      options?: DevicesSimulateConnectToHubOptions,
  ): DevicesSimulateConnectToHubRequest

  Simulates bringing the Wi‑Fi hub (bridge) back online for a device. Only applicable for sandbox workspaces and currently implemented for August and TTLock locks. This will clear the hub_disconnected error on the device.

  Parameters

  • parameters: DevicesSimulateConnectToHubParameters
  • options: DevicesSimulateConnectToHubOptions = {}

  Returns DevicesSimulateConnectToHubRequest

createPaginator

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

  Creates a new SeamPaginator to iterate over the paginated results of the request.

  Type Parameters

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

  Parameters

  • request: SeamHttpRequest<TResponse, TResponseKey>

  Returns SeamPaginator<TResponse, TResponseKey>

disconnect

• disconnect(
      parameters: DevicesSimulateDisconnectParameters,
      options?: DevicesSimulateDisconnectOptions,
  ): DevicesSimulateDisconnectRequest

  Simulates disconnecting a device from Seam. Only applicable for sandbox devices. See also Testing Your App Against Device Disconnection and Removal.

  Parameters

  • parameters: DevicesSimulateDisconnectParameters
  • options: DevicesSimulateDisconnectOptions = {}

  Returns DevicesSimulateDisconnectRequest

disconnectFromHub

• disconnectFromHub(
      parameters: DevicesSimulateDisconnectFromHubParameters,
      options?: DevicesSimulateDisconnectFromHubOptions,
  ): DevicesSimulateDisconnectFromHubRequest

  Simulates taking the Wi‑Fi hub (bridge) offline for a device. Only applicable for sandbox workspaces and currently implemented for August, TTLock, and IglooHome devices. This will set the hub_disconnected error on the device, or mark the IglooHome bridge offline in sandbox.

  Parameters

  • parameters: DevicesSimulateDisconnectFromHubParameters
  • options: DevicesSimulateDisconnectFromHubOptions = {}

  Returns DevicesSimulateDisconnectFromHubRequest

paidSubscription

• paidSubscription(
      parameters: DevicesSimulatePaidSubscriptionParameters,
      options?: DevicesSimulatePaidSubscriptionOptions,
  ): DevicesSimulatePaidSubscriptionRequest

  Toggle the simulated Nuki Smart Hosting subscription for a device (sandbox only). Send is_expired: true to simulate an expired subscription, or false to simulate an active subscription. The actual device error is created/cleared by the poller after this state change.

  Parameters

  • parameters: DevicesSimulatePaidSubscriptionParameters
  • options: DevicesSimulatePaidSubscriptionOptions = {}

  Returns DevicesSimulatePaidSubscriptionRequest

remove

• remove(
      parameters: DevicesSimulateRemoveParameters,
      options?: DevicesSimulateRemoveOptions,
  ): DevicesSimulateRemoveRequest

  Simulates removing a device from Seam. Only applicable for sandbox devices. See also Testing Your App Against Device Disconnection and Removal.

  Parameters

  • parameters: DevicesSimulateRemoveParameters
  • options: DevicesSimulateRemoveOptions = {}

  Returns DevicesSimulateRemoveRequest

updateClientSessionToken

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

  Updates the client session token used by this client for authentication.

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

  Throws

  If this client was not created with a client session token.

StaticfromApiKey

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

  Creates a new SeamHttpDevicesSimulate authenticated with an API key.

  Parameters

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

  Returns SeamHttpDevicesSimulate

StaticfromClient

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

  Creates a new SeamHttpDevicesSimulate from an existing HTTP client.

  Parameters

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

  Returns SeamHttpDevicesSimulate

StaticfromClientSessionToken

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

  Creates a new SeamHttpDevicesSimulate authenticated with a client session token.

  Parameters

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

  Returns SeamHttpDevicesSimulate

StaticfromConsoleSessionToken

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

  Creates a new SeamHttpDevicesSimulate authenticated with a console session token and scoped to a workspace.

  Parameters

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

  Returns SeamHttpDevicesSimulate

StaticfromPersonalAccessToken

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

  Creates a new SeamHttpDevicesSimulate authenticated with a personal access token and scoped to a workspace.

  Parameters

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

  Returns SeamHttpDevicesSimulate

StaticfromPublishableKey

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

  Creates a new SeamHttpDevicesSimulate authenticated with a client session token for the user identified by the user identifier key. The client session is created with the publishable key if it does not exist.

  Parameters

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

  Returns Promise<SeamHttpDevicesSimulate>