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[];
          connected_account_ids?: string[];
          customer_data?: {
              default_checkin_time?: string | null;
              default_checkout_time?: string | null;
              time_zone?: string | null;
          };
          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[];
        connected_account_ids?: string[];
        customer_data?: {
            default_checkin_time?: string | null;
            default_checkout_time?: string | null;
            time_zone?: string | null;
        };
        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.

    • Optionalconnected_account_ids?: string[]

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

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

      Reservation/stay-related defaults for the space. When omitted and connected_account_ids is provided, default_checkin_time / default_checkout_time / time_zone are auto-inherited from the first connected account's connector configuration.

      • 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 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

listReservations

• listReservations(
      parameters?: { issued_status?: "pending" | "issued"; space_key: string },
      options?: SeamCustomerV1SpacesListReservationsOptions,
  ): SeamCustomerV1SpacesListReservationsRequest

  Parameters

  • Optionalparameters: { issued_status?: "pending" | "issued"; space_key: string }

    • Optionalissued_status?: "pending" | "issued"

      Filter reservations by issued status.

    • space_key: string

      Filter reservations by space key.

  • options: SeamCustomerV1SpacesListReservationsOptions = {}

  Returns SeamCustomerV1SpacesListReservationsRequest

pushCommonAreas

• pushCommonAreas(
      parameters?: {
          common_areas?: { name: string }[];
          spaces?: { common_areas: { name: string }[]; name: string }[];
      },
      options?: SeamCustomerV1SpacesPushCommonAreasOptions,
  ): SeamCustomerV1SpacesPushCommonAreasRequest

  Parameters

  • Optionalparameters: {
        common_areas?: { name: string }[];
        spaces?: { common_areas: { name: string }[]; name: string }[];
    }
  • options: SeamCustomerV1SpacesPushCommonAreasOptions = {}

  Returns SeamCustomerV1SpacesPushCommonAreasRequest

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>