Class SeamHttpSpaces

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpSpaces

client

Readonlydefaults

addAcsEntrances

• addAcsEntrances(
      parameters: SpacesAddAcsEntrancesParameters,
      options?: SpacesAddAcsEntrancesOptions,
  ): SpacesAddAcsEntrancesRequest

  Adds entrances to a specific space.

  Parameters

  • parameters: SpacesAddAcsEntrancesParameters
  • options: SpacesAddAcsEntrancesOptions = {}

  Returns SpacesAddAcsEntrancesRequest

addConnectedAccount

• addConnectedAccount(
      parameters: SpacesAddConnectedAccountParameters,
      options?: SpacesAddConnectedAccountOptions,
  ): SpacesAddConnectedAccountRequest

  Adds a connected account to a specific space.

  Parameters

  • parameters: SpacesAddConnectedAccountParameters
  • options: SpacesAddConnectedAccountOptions = {}

  Returns SpacesAddConnectedAccountRequest

addDevices

• addDevices(
      parameters: SpacesAddDevicesParameters,
      options?: SpacesAddDevicesOptions,
  ): SpacesAddDevicesRequest

  Adds devices to a specific space.

  Parameters

  • parameters: SpacesAddDevicesParameters
  • options: SpacesAddDevicesOptions = {}

  Returns SpacesAddDevicesRequest

create

• create(
      parameters: SpacesCreateParameters,
      options?: SpacesCreateOptions,
  ): SpacesCreateRequest

  Creates a new space.

  Parameters

  • parameters: SpacesCreateParameters
  • options: SpacesCreateOptions = {}

  Returns SpacesCreateRequest

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>

delete

• delete(
      parameters: SpacesDeleteParameters,
      options?: SpacesDeleteOptions,
  ): SpacesDeleteRequest

  Deletes a space.

  Parameters

  • parameters: SpacesDeleteParameters
  • options: SpacesDeleteOptions = {}

  Returns SpacesDeleteRequest

get

• get(
      parameters?: SpacesGetParameters,
      options?: SpacesGetOptions,
  ): SpacesGetRequest

  Gets a space.

  Parameters

  • Optionalparameters: SpacesGetParameters
  • options: SpacesGetOptions = {}

  Returns SpacesGetRequest

getRelated

• getRelated(
      parameters?: SpacesGetRelatedParameters,
      options?: SpacesGetRelatedOptions,
  ): SpacesGetRelatedRequest

  Gets all related resources for one or more Spaces.

  Parameters

  • Optionalparameters: SpacesGetRelatedParameters
  • options: SpacesGetRelatedOptions = {}

  Returns SpacesGetRelatedRequest

list

• list(
      parameters?: SpacesListParameters,
      options?: SpacesListOptions,
  ): SpacesListRequest

  Returns a list of all spaces.

  Parameters

  • Optionalparameters: SpacesListParameters
  • options: SpacesListOptions = {}

  Returns SpacesListRequest

removeAcsEntrances

• removeAcsEntrances(
      parameters: SpacesRemoveAcsEntrancesParameters,
      options?: SpacesRemoveAcsEntrancesOptions,
  ): SpacesRemoveAcsEntrancesRequest

  Removes entrances from a specific space.

  Parameters

  • parameters: SpacesRemoveAcsEntrancesParameters
  • options: SpacesRemoveAcsEntrancesOptions = {}

  Returns SpacesRemoveAcsEntrancesRequest

removeConnectedAccount

• removeConnectedAccount(
      parameters: SpacesRemoveConnectedAccountParameters,
      options?: SpacesRemoveConnectedAccountOptions,
  ): SpacesRemoveConnectedAccountRequest

  Removes a connected account from a specific space.

  Parameters

  • parameters: SpacesRemoveConnectedAccountParameters
  • options: SpacesRemoveConnectedAccountOptions = {}

  Returns SpacesRemoveConnectedAccountRequest

removeDevices

• removeDevices(
      parameters: SpacesRemoveDevicesParameters,
      options?: SpacesRemoveDevicesOptions,
  ): SpacesRemoveDevicesRequest

  Removes devices from a specific space.

  Parameters

  • parameters: SpacesRemoveDevicesParameters
  • options: SpacesRemoveDevicesOptions = {}

  Returns SpacesRemoveDevicesRequest

update

• update(
      parameters?: SpacesUpdateParameters,
      options?: SpacesUpdateOptions,
  ): SpacesUpdateRequest

  Updates an existing space.

  Parameters

  • Optionalparameters: SpacesUpdateParameters
  • options: SpacesUpdateOptions = {}

  Returns SpacesUpdateRequest

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

  Creates a new SeamHttpSpaces authenticated with an API key.

  Parameters

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

  Returns SeamHttpSpaces

StaticfromClient

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

  Creates a new SeamHttpSpaces from an existing HTTP client.

  Parameters

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

  Returns SeamHttpSpaces

StaticfromClientSessionToken

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

  Creates a new SeamHttpSpaces authenticated with a client session token.

  Parameters

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

  Returns SeamHttpSpaces

StaticfromConsoleSessionToken

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

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

  Parameters

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

  Returns SeamHttpSpaces

StaticfromPersonalAccessToken

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

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

  Parameters

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

  Returns SeamHttpSpaces

StaticfromPublishableKey

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

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