Class SeamHttpDevices

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpDevices

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

simulate

• get simulate(): SeamHttpDevicesSimulate

  Returns SeamHttpDevicesSimulate

unmanaged

• get unmanaged(): SeamHttpDevicesUnmanaged

  Returns SeamHttpDevicesUnmanaged

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>

delete

• delete(
      parameters: { device_id: string },
      options?: DevicesDeleteOptions,
  ): DevicesDeleteRequest

  Parameters

  • parameters: { device_id: string }

    • device_id: string

      ID of the device that you want to delete.

  • options: DevicesDeleteOptions = {}

  Returns DevicesDeleteRequest

get

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

  Parameters

  • Optionalparameters: DevicesGetParameters
  • options: DevicesGetOptions = {}

  Returns DevicesGetRequest

list

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

  Parameters

  • Optionalparameters: DevicesListParameters
  • options: DevicesListOptions = {}

  Returns DevicesListRequest

listDeviceProviders

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

  Parameters

  • Optionalparameters: DevicesListDeviceProvidersParameters
  • options: DevicesListDeviceProvidersOptions = {}

  Returns DevicesListDeviceProvidersRequest

reportProviderMetadata

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

  Parameters

  • parameters: DevicesReportProviderMetadataParameters
  • options: DevicesReportProviderMetadataOptions = {}

  Returns DevicesReportProviderMetadataRequest

update

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

  Parameters

  • parameters: DevicesUpdateParameters
  • options: DevicesUpdateOptions = {}

  Returns DevicesUpdateRequest

updateClientSessionToken

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

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

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

  Parameters

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

  Returns SeamHttpDevices

StaticfromClient

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

  Parameters

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

  Returns SeamHttpDevices

StaticfromClientSessionToken

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

  Parameters

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

  Returns SeamHttpDevices

StaticfromConsoleSessionToken

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

  Parameters

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

  Returns SeamHttpDevices

StaticfromPersonalAccessToken

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

  Parameters

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

  Returns SeamHttpDevices

StaticfromPublishableKey

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

  Parameters

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

  Returns Promise<SeamHttpDevices>