Class SeamHttpSeamPartnerV1BuildingBlocksSpaces

constructor

• new SeamHttpSeamPartnerV1BuildingBlocksSpaces(apiKeyOrOptions?): SeamHttpSeamPartnerV1BuildingBlocksSpaces

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpSeamPartnerV1BuildingBlocksSpaces

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

autoMap

• autoMap(params?): SeamHttpRequest<SetNonNullable<Required<{
      spaces: {
          acs_entrances: {
              acs_entrance_id: string;
              name: string;
          }[];
          devices: {
              device_id: string;
              device_type: "lock" | "thermostat" | "sensor";
              name: string;
          }[];
          name: string;
          needs_review?: boolean;
          partner_resource_key: string;
      }[];
  }>, "spaces">, "spaces">

• Parameters

  • Optionalparams: {
        collection_key: string;
    }

    • collection_key: string

      Collection key.

  Returns SeamHttpRequest<SetNonNullable<Required<{
      spaces: {
          acs_entrances: {
              acs_entrance_id: string;
              name: string;
          }[];
          devices: {
              device_id: string;
              device_type: "lock" | "thermostat" | "sensor";
              name: string;
          }[];
          name: string;
          needs_review?: boolean;
          partner_resource_key: string;
      }[];
  }>, "spaces">, "spaces">

createPaginator

• createPaginator<const TResponse, const TResponseKey>(request): 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): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(apiKey, options?): SeamHttpSeamPartnerV1BuildingBlocksSpaces

• Parameters

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

  Returns SeamHttpSeamPartnerV1BuildingBlocksSpaces

StaticfromClient

• fromClient(client, options?): SeamHttpSeamPartnerV1BuildingBlocksSpaces

• Parameters

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

  Returns SeamHttpSeamPartnerV1BuildingBlocksSpaces

StaticfromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpSeamPartnerV1BuildingBlocksSpaces

• Parameters

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

  Returns SeamHttpSeamPartnerV1BuildingBlocksSpaces

StaticfromConsoleSessionToken

• fromConsoleSessionToken(consoleSessionToken, workspaceId, options?): SeamHttpSeamPartnerV1BuildingBlocksSpaces

• Parameters

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

  Returns SeamHttpSeamPartnerV1BuildingBlocksSpaces

StaticfromPersonalAccessToken

• fromPersonalAccessToken(personalAccessToken, workspaceId, options?): SeamHttpSeamPartnerV1BuildingBlocksSpaces

• Parameters

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

  Returns SeamHttpSeamPartnerV1BuildingBlocksSpaces

StaticfromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpSeamPartnerV1BuildingBlocksSpaces>