Class SeamHttpSeamCustomerV1Spaces

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpSeamCustomerV1Spaces

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

create

• create(
      parameters?: {
          acs_entrance_ids?: string[];
          device_ids?: string[];
          name: string;
          parent_space_key?: string;
          parent_space_name?: string;
          space_key?: string;
      },
      options?: SeamCustomerV1SpacesCreateOptions,
  ): SeamCustomerV1SpacesCreateRequest

  Parameters

  • Optionalparameters: {
        acs_entrance_ids?: string[];
        device_ids?: string[];
        name: string;
        parent_space_key?: string;
        parent_space_name?: string;
        space_key?: string;
    }

    • Optionalacs_entrance_ids?: string[]

      IDs of the entrances that you want to add to the new space.

    • Optionaldevice_ids?: string[]

      IDs of the devices that you want to add to the new space.

    • name: string

      Name of the space that you want to create.

    • Optionalparent_space_key?: string

      Space key of the parent space for this space.

    • Optionalparent_space_name?: string

      Name of the parent space for this space.

    • Optionalspace_key?: string

      Unique key for the space within the workspace.
  • options: SeamCustomerV1SpacesCreateOptions = {}

  Returns SeamCustomerV1SpacesCreateRequest

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>

list

• list(
      parameters?: {
          connected_account_id?: string;
          search?: string;
          space_key?: string;
      },
      options?: SeamCustomerV1SpacesListOptions,
  ): SeamCustomerV1SpacesListRequest

  Parameters

  • Optionalparameters: { connected_account_id?: string; search?: string; space_key?: string }

    • Optionalconnected_account_id?: string

      Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account.

    • Optionalsearch?: string

      String for which to search. Filters returned spaces to include all records that satisfy a partial match using name.

    • Optionalspace_key?: string

      Filter spaces by space_key.
  • options: SeamCustomerV1SpacesListOptions = {}

  Returns SeamCustomerV1SpacesListRequest

updateClientSessionToken

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

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

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

  Parameters

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

  Returns SeamHttpSeamCustomerV1Spaces

StaticfromClient

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

  Parameters

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

  Returns SeamHttpSeamCustomerV1Spaces

StaticfromClientSessionToken

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

  Parameters

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

  Returns SeamHttpSeamCustomerV1Spaces

StaticfromConsoleSessionToken

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

  Parameters

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

  Returns SeamHttpSeamCustomerV1Spaces

StaticfromPersonalAccessToken

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

  Parameters

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

  Returns SeamHttpSeamCustomerV1Spaces

StaticfromPublishableKey

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

  Parameters

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

  Returns Promise<SeamHttpSeamCustomerV1Spaces>