Class SeamHttpSeamCustomerV1Portals

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpSeamCustomerV1Portals

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

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>

get

• get(
      parameters?: { customer_portal_id: string },
      options?: SeamCustomerV1PortalsGetOptions,
  ): SeamCustomerV1PortalsGetRequest

  Parameters

  • Optionalparameters: { customer_portal_id: string }

    • customer_portal_id: string

      Customer portal ID.

  • options: SeamCustomerV1PortalsGetOptions = {}

  Returns SeamCustomerV1PortalsGetRequest

update

• update(
      parameters?: {
          customer_portal_id: string;
          portal_configuration: {
              customer_resources_filters?: {
                  field: string;
                  operation: "=";
                  value: string | boolean;
              }[];
              customization_profile_id?: string;
              deep_link?: {
                  resource_key: string;
                  resource_type: "reservation"
                  | "space";
              };
              exclude_locale_picker?: boolean;
              features?: {
                  configure?: {
                      allow_access_automation_rule_customization?: boolean;
                      allow_climate_automation_rule_customization?: boolean;
                      allow_instant_key_customization?: boolean;
                      exclude?: boolean;
                  };
                  connect?: {
                      accepted_providers?: string[];
                      exclude?: boolean;
                      excluded_providers?: string[];
                  };
                  manage?: {
                      events?: { allowed_events?: (...)[]; default_events?: (...)[] };
                      exclude?: boolean;
                      exclude_reservation_management?: boolean;
                      exclude_reservation_technical_details?: boolean;
                      exclude_staff_management?: boolean;
                  };
                  manage_devices?: { exclude?: boolean };
                  organize?: { exclude?: boolean };
              };
              is_embedded?: boolean;
              landing_page?: {
                  manage?: | { space_key: string }
                  | { property_key: string }
                  | { room_key: string }
                  | { common_area_key: string }
                  | { unit_key: string }
                  | { facility_key: string }
                  | { building_key: string }
                  | { listing_key: string }
                  | { property_listing_key: string }
                  | { site_key: string }
                  | { reservation_key: string }
                  | { booking_key: string }
                  | { access_grant_key: string };
              };
              locale?: "en-US"
              | "pt-PT"
              | "fr-FR"
              | "it-IT"
              | "es-ES";
              navigation_mode?: "full" | "restricted";
          };
      },
      options?: SeamCustomerV1PortalsUpdateOptions,
  ): SeamCustomerV1PortalsUpdateRequest

  Parameters

  • Optionalparameters: {
        customer_portal_id: string;
        portal_configuration: {
            customer_resources_filters?: {
                field: string;
                operation: "=";
                value: string | boolean;
            }[];
            customization_profile_id?: string;
            deep_link?: {
                resource_key: string;
                resource_type: "reservation"
                | "space";
            };
            exclude_locale_picker?: boolean;
            features?: {
                configure?: {
                    allow_access_automation_rule_customization?: boolean;
                    allow_climate_automation_rule_customization?: boolean;
                    allow_instant_key_customization?: boolean;
                    exclude?: boolean;
                };
                connect?: {
                    accepted_providers?: string[];
                    exclude?: boolean;
                    excluded_providers?: string[];
                };
                manage?: {
                    events?: { allowed_events?: (...)[]; default_events?: (...)[] };
                    exclude?: boolean;
                    exclude_reservation_management?: boolean;
                    exclude_reservation_technical_details?: boolean;
                    exclude_staff_management?: boolean;
                };
                manage_devices?: { exclude?: boolean };
                organize?: { exclude?: boolean };
            };
            is_embedded?: boolean;
            landing_page?: {
                manage?: | { space_key: string }
                | { property_key: string }
                | { room_key: string }
                | { common_area_key: string }
                | { unit_key: string }
                | { facility_key: string }
                | { building_key: string }
                | { listing_key: string }
                | { property_listing_key: string }
                | { site_key: string }
                | { reservation_key: string }
                | { booking_key: string }
                | { access_grant_key: string };
            };
            locale?: "en-US"
            | "pt-PT"
            | "fr-FR"
            | "it-IT"
            | "es-ES";
            navigation_mode?: "full" | "restricted";
        };
    }

    • customer_portal_id: string

      ID of the customer portal to update.

    • portal_configuration: {
          customer_resources_filters?: {
              field: string;
              operation: "=";
              value: string | boolean;
          }[];
          customization_profile_id?: string;
          deep_link?: {
              resource_key: string;
              resource_type: "reservation"
              | "space";
          };
          exclude_locale_picker?: boolean;
          features?: {
              configure?: {
                  allow_access_automation_rule_customization?: boolean;
                  allow_climate_automation_rule_customization?: boolean;
                  allow_instant_key_customization?: boolean;
                  exclude?: boolean;
              };
              connect?: {
                  accepted_providers?: string[];
                  exclude?: boolean;
                  excluded_providers?: string[];
              };
              manage?: {
                  events?: { allowed_events?: (...)[]; default_events?: (...)[] };
                  exclude?: boolean;
                  exclude_reservation_management?: boolean;
                  exclude_reservation_technical_details?: boolean;
                  exclude_staff_management?: boolean;
              };
              manage_devices?: { exclude?: boolean };
              organize?: { exclude?: boolean };
          };
          is_embedded?: boolean;
          landing_page?: {
              manage?: | { space_key: string }
              | { property_key: string }
              | { room_key: string }
              | { common_area_key: string }
              | { unit_key: string }
              | { facility_key: string }
              | { building_key: string }
              | { listing_key: string }
              | { property_listing_key: string }
              | { site_key: string }
              | { reservation_key: string }
              | { booking_key: string }
              | { access_grant_key: string };
          };
          locale?: "en-US"
          | "pt-PT"
          | "fr-FR"
          | "it-IT"
          | "es-ES";
          navigation_mode?: "full" | "restricted";
      }

      Partial portal configuration to merge with the existing configuration.

      • Optionalcustomer_resources_filters?: { field: string; operation: "="; value: string | boolean }[]

        Filter configuration for resources based on their custom_metadata. Each filter specifies a field, operation, and value to match against resource custom_metadata.

      • Optionalcustomization_profile_id?: string

        The ID of the customization profile to use for the portal.

      • Optionaldeep_link?: { resource_key: string; resource_type: "reservation" | "space" }

        Deep link target resource for initial redirect. When set, the portal will navigate directly to the specified resource.

      • Optionalexclude_locale_picker?: boolean

        Whether to exclude the option to select a locale within the portal UI.

      • Optionalfeatures?: {
            configure?: {
                allow_access_automation_rule_customization?: boolean;
                allow_climate_automation_rule_customization?: boolean;
                allow_instant_key_customization?: boolean;
                exclude?: boolean;
            };
            connect?: {
                accepted_providers?: string[];
                exclude?: boolean;
                excluded_providers?: string[];
            };
            manage?: {
                events?: { allowed_events?: (...)[]; default_events?: (...)[] };
                exclude?: boolean;
                exclude_reservation_management?: boolean;
                exclude_reservation_technical_details?: boolean;
                exclude_staff_management?: boolean;
            };
            manage_devices?: { exclude?: boolean };
            organize?: { exclude?: boolean };
        }

        • Optionalconfigure?: {
              allow_access_automation_rule_customization?: boolean;
              allow_climate_automation_rule_customization?: boolean;
              allow_instant_key_customization?: boolean;
              exclude?: boolean;
          }

          Configuration for the configure feature.

          • Optionalallow_access_automation_rule_customization?: boolean

            Indicates whether the customer can customize the access automation rules for their properties.

          • Optionalallow_climate_automation_rule_customization?: boolean

            Indicates whether the customer can customize the climate automation rules for their properties.

          • Optionalallow_instant_key_customization?: boolean

            Indicates whether the customer can customize the Instant Key profile for their properties.

          • Optionalexclude?: boolean

            Whether to exclude this feature from the portal.

        • Optionalconnect?: {
              accepted_providers?: string[];
              exclude?: boolean;
              excluded_providers?: string[];
          }

          Configuration for the connect accounts feature.

          • Optionalaccepted_providers?: string[]

            List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.

          • Optionalexclude?: boolean

            Whether to exclude this feature from the portal.

          • Optionalexcluded_providers?: string[]

            List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account.

        • Optionalmanage?: {
              events?: { allowed_events?: (...)[]; default_events?: (...)[] };
              exclude?: boolean;
              exclude_reservation_management?: boolean;
              exclude_reservation_technical_details?: boolean;
              exclude_staff_management?: boolean;
          }

          Configuration for the manage feature.

          • Optionalevents?: { allowed_events?: (...)[]; default_events?: (...)[] }

            Configuration for event type filtering in the manage feature.

            • Optionalallowed_events?: (...)[]

              List of event types to show in the events filter. When set, only these event types will be available. Leave empty to show all events.

            • Optionaldefault_events?: (...)[]

              List of event types that are pre-selected in the events filter when the user first loads the events tab.

          • Optionalexclude?: boolean

            Whether to exclude this feature from the portal.

          • Optionalexclude_reservation_management?: boolean

            Indicates whether the customer can manage reservations for their properties.

          • Optionalexclude_reservation_technical_details?: boolean

            Indicates whether to exclude technical details from reservation views.

          • Optionalexclude_staff_management?: boolean

            Indicates whether the customer can manage staff for their properties.

        • Optionalmanage_devices?: { exclude?: boolean }

          Configuration for the manage devices feature.

          deprecated: Use manage instead.

          • Optionalexclude?: boolean

            Whether to exclude this feature from the portal.

        • Optionalorganize?: { exclude?: boolean }

          Configuration for the organize feature.

          • Optionalexclude?: boolean

            Whether to exclude this feature from the portal.

      • Optionalis_embedded?: boolean

        Whether the portal is embedded in another application.

      • Optionallanding_page?: {
            manage?:
                | { space_key: string }
                | { property_key: string }
                | { room_key: string }
                | { common_area_key: string }
                | { unit_key: string }
                | { facility_key: string }
                | { building_key: string }
                | { listing_key: string }
                | { property_listing_key: string }
                | { site_key: string }
                | { reservation_key: string }
                | { booking_key: string }
                | { access_grant_key: string };
        }

        Configuration for the landing page when the portal loads.

      • Optionallocale?: "en-US" | "pt-PT" | "fr-FR" | "it-IT" | "es-ES"

        The locale to use for the portal.

      • Optionalnavigation_mode?: "full" | "restricted"

        Navigation mode for the portal. 'restricted' tells frontend to hide navigation UI, typically used for embedded deep links.

  • options: SeamCustomerV1PortalsUpdateOptions = {}

  Returns SeamCustomerV1PortalsUpdateRequest

updateClientSessionToken

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

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

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

  Parameters

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

  Returns SeamHttpSeamCustomerV1Portals

StaticfromClient

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

  Parameters

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

  Returns SeamHttpSeamCustomerV1Portals

StaticfromClientSessionToken

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

  Parameters

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

  Returns SeamHttpSeamCustomerV1Portals

StaticfromConsoleSessionToken

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

  Parameters

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

  Returns SeamHttpSeamCustomerV1Portals

StaticfromPersonalAccessToken

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

  Parameters

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

  Returns SeamHttpSeamCustomerV1Portals

StaticfromPublishableKey

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

  Parameters

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

  Returns Promise<SeamHttpSeamCustomerV1Portals>