Class SeamHttpSpaces

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpSpaces

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

addAcsEntrances

• addAcsEntrances(
      parameters: { acs_entrance_ids: string[]; space_id: string },
      options?: SpacesAddAcsEntrancesOptions,
  ): SpacesAddAcsEntrancesRequest

  Parameters

  • parameters: { acs_entrance_ids: string[]; space_id: string }

    • acs_entrance_ids: string[]

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

    • space_id: string

      ID of the space to which you want to add entrances.

  • options: SpacesAddAcsEntrancesOptions = {}

  Returns SpacesAddAcsEntrancesRequest

addConnectedAccount

• addConnectedAccount(
      parameters: { connected_account_id: string; space_id: string },
      options?: SpacesAddConnectedAccountOptions,
  ): SpacesAddConnectedAccountRequest

  Parameters

  • parameters: { connected_account_id: string; space_id: string }

    • connected_account_id: string

      ID of the connected account that you want to add to the space.

    • space_id: string

      ID of the space to which you want to add the connected account.

  • options: SpacesAddConnectedAccountOptions = {}

  Returns SpacesAddConnectedAccountRequest

addDevices

• addDevices(
      parameters: { device_ids: string[]; space_id: string },
      options?: SpacesAddDevicesOptions,
  ): SpacesAddDevicesRequest

  Parameters

  • parameters: { device_ids: string[]; space_id: string }

    • device_ids: string[]

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

    • space_id: string

      ID of the space to which you want to add devices.

  • options: SpacesAddDevicesOptions = {}

  Returns SpacesAddDevicesRequest

create

• create(
      parameters: {
          acs_entrance_ids?: string[];
          connected_account_ids?: string[];
          customer_data?: {
              address?: string | null;
              default_checkin_time?: string | null;
              default_checkout_time?: string | null;
              time_zone?: string | null;
          };
          customer_key?: string;
          device_ids?: string[];
          name: string;
          space_key?: string;
      },
      options?: SpacesCreateOptions,
  ): SpacesCreateRequest

  Parameters

  • parameters: {
        acs_entrance_ids?: string[];
        connected_account_ids?: string[];
        customer_data?: {
            address?: string | null;
            default_checkin_time?: string | null;
            default_checkout_time?: string | null;
            time_zone?: string | null;
        };
        customer_key?: string;
        device_ids?: string[];
        name: string;
        space_key?: string;
    }

    • Optionalacs_entrance_ids?: string[]

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

    • Optionalconnected_account_ids?: string[]

      IDs of connected accounts to associate with the new space. Persisted on seam.location_third_party_account so the UI can show which provider account(s) a space came from.

    • Optionalcustomer_data?: {
          address?: string | null;
          default_checkin_time?: string | null;
          default_checkout_time?: string | null;
          time_zone?: string | null;
      }

      Reservation/stay-related defaults for the space.

      • Optionaladdress?: string | null

        Postal address for the space.

      • Optionaldefault_checkin_time?: string | null

        Default check-in time for reservations at the space, as HH:mm or HH:mm:ss.

      • Optionaldefault_checkout_time?: string | null

        Default check-out time for reservations at the space, as HH:mm or HH:mm:ss.

      • Optionaltime_zone?: string | null

        IANA time zone for the space, e.g. America/Los_Angeles.

    • Optionalcustomer_key?: string

      Customer key for which you want to create the 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.

    • Optionalspace_key?: string

      Unique key for the space within the workspace.

  • options: SpacesCreateOptions = {}

  Returns SpacesCreateRequest

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: { space_id: string },
      options?: SpacesDeleteOptions,
  ): SpacesDeleteRequest

  Parameters

  • parameters: { space_id: string }

    • space_id: string

      ID of the space that you want to delete.

  • options: SpacesDeleteOptions = {}

  Returns SpacesDeleteRequest

get

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

  Parameters

  • Optionalparameters: SpacesGetParameters
  • options: SpacesGetOptions = {}

  Returns SpacesGetRequest

getRelated

• getRelated(
      parameters?: {
          exclude?: (
              | "access_methods"
              | "acs_entrances"
              | "acs_systems"
              | "connected_accounts"
              | "devices"
              | "spaces"
          )[];
          include?: (
              | "access_methods"
              | "acs_entrances"
              | "acs_systems"
              | "connected_accounts"
              | "devices"
              | "spaces"
          )[];
          space_ids?: string[];
          space_keys?: string[];
      },
      options?: SpacesGetRelatedOptions,
  ): SpacesGetRelatedRequest

  Parameters

  • Optionalparameters: {
        exclude?: (
            | "access_methods"
            | "acs_entrances"
            | "acs_systems"
            | "connected_accounts"
            | "devices"
            | "spaces"
        )[];
        include?: (
            | "access_methods"
            | "acs_entrances"
            | "acs_systems"
            | "connected_accounts"
            | "devices"
            | "spaces"
        )[];
        space_ids?: string[];
        space_keys?: string[];
    }

    • Optionalexclude?: (
          | "access_methods"
          | "acs_entrances"
          | "acs_systems"
          | "connected_accounts"
          | "devices"
          | "spaces"
      )[]

    • Optionalinclude?: (
          | "access_methods"
          | "acs_entrances"
          | "acs_systems"
          | "connected_accounts"
          | "devices"
          | "spaces"
      )[]

    • Optionalspace_ids?: string[]

      IDs of the spaces that you want to get along with their related resources.

    • Optionalspace_keys?: string[]

      Keys of the spaces that you want to get along with their related resources.

  • options: SpacesGetRelatedOptions = {}

  Returns SpacesGetRelatedRequest

list

• list(
      parameters?: {
          connected_account_id?: string;
          customer_key?: string;
          limit?: number;
          page_cursor?: string | null;
          parent_space_id?: string;
          parent_space_key?: string;
          search?: string;
          space_key?: string;
      },
      options?: SpacesListOptions,
  ): SpacesListRequest

  Parameters

  • Optionalparameters: {
        connected_account_id?: string;
        customer_key?: string;
        limit?: number;
        page_cursor?: string | null;
        parent_space_id?: string;
        parent_space_key?: 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.

    • Optionalcustomer_key?: string

      Customer key for which you want to list spaces.

    • Optionallimit?: number

      Maximum number of records to return per page.

    • Optionalpage_cursor?: string | null

      Identifies the specific page of results to return, obtained from the previous page's next_page_cursor.

    • Optionalparent_space_id?: string

      Filter spaces to only include those whose parent space has the specified parent_space_id.

    • Optionalparent_space_key?: string

      Filter spaces to only include those whose parent space has the specified parent_space_key.

    • Optionalsearch?: string

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

    • Optionalspace_key?: string

      Filter spaces by space_key.

  • options: SpacesListOptions = {}

  Returns SpacesListRequest

removeAcsEntrances

• removeAcsEntrances(
      parameters: { acs_entrance_ids: string[]; space_id: string },
      options?: SpacesRemoveAcsEntrancesOptions,
  ): SpacesRemoveAcsEntrancesRequest

  Parameters

  • parameters: { acs_entrance_ids: string[]; space_id: string }

    • acs_entrance_ids: string[]

      IDs of the entrances that you want to remove from the space.

    • space_id: string

      ID of the space from which you want to remove entrances.

  • options: SpacesRemoveAcsEntrancesOptions = {}

  Returns SpacesRemoveAcsEntrancesRequest

removeConnectedAccount

• removeConnectedAccount(
      parameters: { connected_account_id: string; space_id: string },
      options?: SpacesRemoveConnectedAccountOptions,
  ): SpacesRemoveConnectedAccountRequest

  Parameters

  • parameters: { connected_account_id: string; space_id: string }

    • connected_account_id: string

      ID of the connected account that you want to remove from the space.

    • space_id: string

      ID of the space from which you want to remove the connected account.

  • options: SpacesRemoveConnectedAccountOptions = {}

  Returns SpacesRemoveConnectedAccountRequest

removeDevices

• removeDevices(
      parameters: { device_ids: string[]; space_id: string },
      options?: SpacesRemoveDevicesOptions,
  ): SpacesRemoveDevicesRequest

  Parameters

  • parameters: { device_ids: string[]; space_id: string }

    • device_ids: string[]

      IDs of the devices that you want to remove from the space.

    • space_id: string

      ID of the space from which you want to remove devices.

  • options: SpacesRemoveDevicesOptions = {}

  Returns SpacesRemoveDevicesRequest

update

• update(
      parameters?: {
          acs_entrance_ids?: string[];
          customer_data?: {
              address?: string | null;
              default_checkin_time?: string | null;
              default_checkout_time?: string | null;
              time_zone?: string | null;
          };
          device_ids?: string[];
          name?: string;
          parent_space_id?: string;
          parent_space_key?: string;
          space_id?: string;
          space_key?: string;
      },
      options?: SpacesUpdateOptions,
  ): SpacesUpdateRequest

  Parameters

  • Optionalparameters: {
        acs_entrance_ids?: string[];
        customer_data?: {
            address?: string | null;
            default_checkin_time?: string | null;
            default_checkout_time?: string | null;
            time_zone?: string | null;
        };
        device_ids?: string[];
        name?: string;
        parent_space_id?: string;
        parent_space_key?: string;
        space_id?: string;
        space_key?: string;
    }

    • Optionalacs_entrance_ids?: string[]

      IDs of the entrances that you want to set for the space. If specified, this will replace all existing entrances.

    • Optionalcustomer_data?: {
          address?: string | null;
          default_checkin_time?: string | null;
          default_checkout_time?: string | null;
          time_zone?: string | null;
      }

      Reservation/stay-related defaults for the space. Only the keys you provide are updated; omit a key to leave it unchanged. Pass null on a key to clear it.

      • Optionaladdress?: string | null

        Postal address for the space.

      • Optionaldefault_checkin_time?: string | null

        Default check-in time for reservations at the space, as HH:mm or HH:mm:ss.

      • Optionaldefault_checkout_time?: string | null

        Default check-out time for reservations at the space, as HH:mm or HH:mm:ss.

      • Optionaltime_zone?: string | null

        IANA time zone for the space, e.g. America/Los_Angeles.

    • Optionaldevice_ids?: string[]

      IDs of the devices that you want to set for the space. If specified, this will replace all existing devices.

    • Optionalname?: string

      Name of the space.

    • Optionalparent_space_id?: string

      Reassign this space to the parent space (site) with this parent_space_id.

    • Optionalparent_space_key?: string

      Reassign this space to the parent space (site) with this parent_space_key.

    • Optionalspace_id?: string

      ID of the space that you want to update.

    • Optionalspace_key?: string

      Unique key of the space that you want to update.

  • options: SpacesUpdateOptions = {}

  Returns SpacesUpdateRequest

updateClientSessionToken

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

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

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

  Parameters

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

  Returns SeamHttpSpaces

StaticfromClient

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

  Parameters

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

  Returns SeamHttpSpaces

StaticfromClientSessionToken

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

  Parameters

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

  Returns SeamHttpSpaces

StaticfromConsoleSessionToken

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

  Parameters

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

  Returns SeamHttpSpaces

StaticfromPersonalAccessToken

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

  Parameters

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

  Returns SeamHttpSpaces

StaticfromPublishableKey

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

  Parameters

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

  Returns Promise<SeamHttpSpaces>