Class SeamHttpSeamPartnerV1BuildingBlocksSpaces

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpSeamPartnerV1BuildingBlocksSpaces

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

autoMap

• autoMap(
      parameters?: {
          collection_key?: string;
          connected_account_id?: string;
          customer_key?: string;
      },
      options?: SeamPartnerV1BuildingBlocksSpacesAutoMapOptions,
  ): SeamPartnerV1BuildingBlocksSpacesAutoMapRequest

  Parameters

  • Optionalparameters: {
        collection_key?: string;
        connected_account_id?: string;
        customer_key?: string;
    }

    • Optionalcollection_key?: string

      Collection key.

    • Optionalconnected_account_id?: string

      Connected account to scope auto-mapping to. Filters partner resources by the matching connector and limits available devices/entrances to this account.

    • Optionalcustomer_key?: string

      Customer key for which to auto-map spaces.

  • options: SeamPartnerV1BuildingBlocksSpacesAutoMapOptions = {}

  Returns SeamPartnerV1BuildingBlocksSpacesAutoMapRequest

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>

updateClientSessionToken

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

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

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

  Parameters

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

  Returns SeamHttpSeamPartnerV1BuildingBlocksSpaces

StaticfromClient

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

  Parameters

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

  Returns SeamHttpSeamPartnerV1BuildingBlocksSpaces

StaticfromClientSessionToken

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

  Parameters

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

  Returns SeamHttpSeamPartnerV1BuildingBlocksSpaces

StaticfromConsoleSessionToken

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

  Parameters

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

  Returns SeamHttpSeamPartnerV1BuildingBlocksSpaces

StaticfromPersonalAccessToken

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

  Parameters

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

  Returns SeamHttpSeamPartnerV1BuildingBlocksSpaces

StaticfromPublishableKey

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

  Parameters

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

  Returns Promise<SeamHttpSeamPartnerV1BuildingBlocksSpaces>