Class SeamHttpDevices

constructor

• new SeamHttpDevices(apiKeyOrOptions?: string | SeamHttpOptions): SeamHttpDevices

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpDevices

client

Readonlydefaults

simulate

• get simulate(): SeamHttpDevicesSimulate

  Client for the Seam API /devices/simulate routes.

  Returns SeamHttpDevicesSimulate

unmanaged

• get unmanaged(): SeamHttpDevicesUnmanaged

  Client for the Seam API /devices/unmanaged routes.

  Returns SeamHttpDevicesUnmanaged

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>

get

• get(
      parameters: DevicesGetParameters,
      options?: DevicesGetOptions,
  ): DevicesGetRequest

  Returns a specified device.

  You must specify either device_id or name.

  Parameters

  • parameters: DevicesGetParameters
  • options: DevicesGetOptions = {}

  Returns DevicesGetRequest

list

• list(
      parameters?: DevicesListParameters,
      options?: DevicesListOptions,
  ): DevicesListRequest

  Returns a list of all devices.

  Parameters

  • Optionalparameters: DevicesListParameters
  • options: DevicesListOptions = {}

  Returns DevicesListRequest

listDeviceProviders

• listDeviceProviders(
      parameters?: DevicesListDeviceProvidersParameters,
      options?: DevicesListDeviceProvidersOptions,
  ): DevicesListDeviceProvidersRequest

  Returns a list of all device providers.

  The information that this endpoint returns for each provider includes a set of capability flags, such as device_provider.can_remotely_unlock. If at least one supported device from a provider has a specific capability, the corresponding capability flag is true.

  When you create a Connect Webview, you can customize the providers—that is, the brands—that it displays. In the /connect_webviews/create request, include the desired set of device provider keys in the accepted_providers parameter. See also Customize the Brands to Display in Your Connect Webviews.

  Parameters

  • Optionalparameters: DevicesListDeviceProvidersParameters
  • options: DevicesListDeviceProvidersOptions = {}

  Returns DevicesListDeviceProvidersRequest

reportProviderMetadata

• reportProviderMetadata(
      parameters: DevicesReportProviderMetadataParameters,
      options?: DevicesReportProviderMetadataOptions,
  ): DevicesReportProviderMetadataRequest

  Updates provider-specific metadata for devices.

  Parameters

  • parameters: DevicesReportProviderMetadataParameters
  • options: DevicesReportProviderMetadataOptions = {}

  Returns DevicesReportProviderMetadataRequest

update

• update(
      parameters: DevicesUpdateParameters,
      options?: DevicesUpdateOptions,
  ): DevicesUpdateRequest

  Updates a specified device.

  You can add or change custom metadata for a device, change the device's name, or convert a managed device to unmanaged.

  Parameters

  • parameters: DevicesUpdateParameters
  • options: DevicesUpdateOptions = {}

  Returns DevicesUpdateRequest

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">,
  ): SeamHttpDevices

  Creates a new SeamHttpDevices authenticated with an API key.

  Parameters

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

  Returns SeamHttpDevices

StaticfromClient

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

  Creates a new SeamHttpDevices from an existing HTTP client.

  Parameters

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

  Returns SeamHttpDevices

StaticfromClientSessionToken

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

  Creates a new SeamHttpDevices authenticated with a client session token.

  Parameters

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

  Returns SeamHttpDevices

StaticfromConsoleSessionToken

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

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

  Parameters

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

  Returns SeamHttpDevices

StaticfromPersonalAccessToken

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

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

  Parameters

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

  Returns SeamHttpDevices

StaticfromPublishableKey

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

  Creates a new SeamHttpDevices 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<SeamHttpDevices>