Class SeamHttpCustomers

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpCustomers

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>

createPortal

• createPortal(
      parameters?: CustomersCreatePortalParameters,
      options?: CustomersCreatePortalOptions,
  ): CustomersCreatePortalRequest

  Parameters

  • Optionalparameters: CustomersCreatePortalParameters
  • options: CustomersCreatePortalOptions = {}

  Returns CustomersCreatePortalRequest

deleteData

• deleteData(
      parameters?: {
          access_grant_keys?: string[];
          booking_keys?: string[];
          building_keys?: string[];
          common_area_keys?: string[];
          customer_keys?: string[];
          facility_keys?: string[];
          guest_keys?: string[];
          listing_keys?: string[];
          property_keys?: string[];
          property_listing_keys?: string[];
          reservation_keys?: string[];
          resident_keys?: string[];
          room_keys?: string[];
          space_keys?: string[];
          tenant_keys?: string[];
          unit_keys?: string[];
          user_identity_keys?: string[];
          user_keys?: string[];
      },
      options?: CustomersDeleteDataOptions,
  ): CustomersDeleteDataRequest

  Parameters

  • Optionalparameters: {
        access_grant_keys?: string[];
        booking_keys?: string[];
        building_keys?: string[];
        common_area_keys?: string[];
        customer_keys?: string[];
        facility_keys?: string[];
        guest_keys?: string[];
        listing_keys?: string[];
        property_keys?: string[];
        property_listing_keys?: string[];
        reservation_keys?: string[];
        resident_keys?: string[];
        room_keys?: string[];
        space_keys?: string[];
        tenant_keys?: string[];
        unit_keys?: string[];
        user_identity_keys?: string[];
        user_keys?: string[];
    }

    • Optionalaccess_grant_keys?: string[]

      List of access grant keys to delete.

    • Optionalbooking_keys?: string[]

      List of booking keys to delete.

    • Optionalbuilding_keys?: string[]

      List of building keys to delete.

    • Optionalcommon_area_keys?: string[]

      List of common area keys to delete.

    • Optionalcustomer_keys?: string[]

      List of customer keys to delete all data for.

    • Optionalfacility_keys?: string[]

      List of facility keys to delete.

    • Optionalguest_keys?: string[]

      List of guest keys to delete.

    • Optionallisting_keys?: string[]

      List of listing keys to delete.

    • Optionalproperty_keys?: string[]

      List of property keys to delete.

    • Optionalproperty_listing_keys?: string[]

      List of property listing keys to delete.

    • Optionalreservation_keys?: string[]

      List of reservation keys to delete.

    • Optionalresident_keys?: string[]

      List of resident keys to delete.

    • Optionalroom_keys?: string[]

      List of room keys to delete.

    • Optionalspace_keys?: string[]

      List of space keys to delete.

    • Optionaltenant_keys?: string[]

      List of tenant keys to delete.

    • Optionalunit_keys?: string[]

      List of unit keys to delete.

    • Optionaluser_identity_keys?: string[]

      List of user identity keys to delete.

    • Optionaluser_keys?: string[]

      List of user keys to delete.
  • options: CustomersDeleteDataOptions = {}

  Returns CustomersDeleteDataRequest

pushData

• pushData(
      parameters?: {
          access_grants?: {
              access_grant_key: string;
              building_keys?: string[];
              common_area_keys?: string[];
              ends_at?: string;
              facility_keys?: string[];
              guest_key?: string;
              listing_keys?: string[];
              name?: string;
              preferred_code?: string;
              property_keys?: string[];
              resident_key?: string;
              room_keys?: string[];
              space_keys?: string[];
              starts_at?: string;
              tenant_key?: string;
              unit_keys?: string[];
              user_identity_key?: string;
              user_key?: string;
          }[];
          bookings?: {
              booking_key: string;
              building_keys?: string[];
              common_area_keys?: string[];
              ends_at?: string;
              facility_keys?: string[];
              guest_key?: string;
              listing_keys?: string[];
              name?: string;
              preferred_code?: string;
              property_keys?: string[];
              resident_key?: string;
              room_keys?: string[];
              space_keys?: string[];
              starts_at?: string;
              tenant_key?: string;
              unit_keys?: string[];
              user_identity_key?: string;
              user_key?: string;
          }[];
          buildings?: { building_key: string; name: string }[];
          common_areas?: { common_area_key: string; name: string }[];
          customer_key: string;
          facilities?: { facility_key: string; name: string }[];
          guests?: {
              email_address?: string;
              guest_key: string;
              name: string;
              phone_number?: string;
          }[];
          listings?: { listing_key: string; name: string }[];
          properties?: { name: string; property_key: string }[];
          property_listings?: { name: string; property_listing_key: string }[];
          reservations?: {
              building_keys?: string[];
              common_area_keys?: string[];
              ends_at?: string;
              facility_keys?: string[];
              guest_key?: string;
              listing_keys?: string[];
              name?: string;
              preferred_code?: string;
              property_keys?: string[];
              reservation_key: string;
              resident_key?: string;
              room_keys?: string[];
              space_keys?: string[];
              starts_at?: string;
              tenant_key?: string;
              unit_keys?: string[];
              user_identity_key?: string;
              user_key?: string;
          }[];
          residents?: {
              email_address?: string;
              name: string;
              phone_number?: string;
              resident_key: string;
          }[];
          rooms?: { name: string; room_key: string }[];
          spaces?: { name: string; space_key: string }[];
          tenants?: {
              email_address?: string;
              name: string;
              phone_number?: string;
              tenant_key: string;
          }[];
          units?: { name: string; unit_key: string }[];
          user_identities?: {
              email_address?: string;
              name: string;
              phone_number?: string;
              user_identity_key: string;
          }[];
          users?: {
              email_address?: string;
              name: string;
              phone_number?: string;
              user_key: string;
          }[];
      },
      options?: CustomersPushDataOptions,
  ): CustomersPushDataRequest

  Parameters

  • Optionalparameters: {
        access_grants?: {
            access_grant_key: string;
            building_keys?: string[];
            common_area_keys?: string[];
            ends_at?: string;
            facility_keys?: string[];
            guest_key?: string;
            listing_keys?: string[];
            name?: string;
            preferred_code?: string;
            property_keys?: string[];
            resident_key?: string;
            room_keys?: string[];
            space_keys?: string[];
            starts_at?: string;
            tenant_key?: string;
            unit_keys?: string[];
            user_identity_key?: string;
            user_key?: string;
        }[];
        bookings?: {
            booking_key: string;
            building_keys?: string[];
            common_area_keys?: string[];
            ends_at?: string;
            facility_keys?: string[];
            guest_key?: string;
            listing_keys?: string[];
            name?: string;
            preferred_code?: string;
            property_keys?: string[];
            resident_key?: string;
            room_keys?: string[];
            space_keys?: string[];
            starts_at?: string;
            tenant_key?: string;
            unit_keys?: string[];
            user_identity_key?: string;
            user_key?: string;
        }[];
        buildings?: { building_key: string; name: string }[];
        common_areas?: { common_area_key: string; name: string }[];
        customer_key: string;
        facilities?: { facility_key: string; name: string }[];
        guests?: {
            email_address?: string;
            guest_key: string;
            name: string;
            phone_number?: string;
        }[];
        listings?: { listing_key: string; name: string }[];
        properties?: { name: string; property_key: string }[];
        property_listings?: { name: string; property_listing_key: string }[];
        reservations?: {
            building_keys?: string[];
            common_area_keys?: string[];
            ends_at?: string;
            facility_keys?: string[];
            guest_key?: string;
            listing_keys?: string[];
            name?: string;
            preferred_code?: string;
            property_keys?: string[];
            reservation_key: string;
            resident_key?: string;
            room_keys?: string[];
            space_keys?: string[];
            starts_at?: string;
            tenant_key?: string;
            unit_keys?: string[];
            user_identity_key?: string;
            user_key?: string;
        }[];
        residents?: {
            email_address?: string;
            name: string;
            phone_number?: string;
            resident_key: string;
        }[];
        rooms?: { name: string; room_key: string }[];
        spaces?: { name: string; space_key: string }[];
        tenants?: {
            email_address?: string;
            name: string;
            phone_number?: string;
            tenant_key: string;
        }[];
        units?: { name: string; unit_key: string }[];
        user_identities?: {
            email_address?: string;
            name: string;
            phone_number?: string;
            user_identity_key: string;
        }[];
        users?: {
            email_address?: string;
            name: string;
            phone_number?: string;
            user_key: string;
        }[];
    }

    • Optionalaccess_grants?: {
          access_grant_key: string;
          building_keys?: string[];
          common_area_keys?: string[];
          ends_at?: string;
          facility_keys?: string[];
          guest_key?: string;
          listing_keys?: string[];
          name?: string;
          preferred_code?: string;
          property_keys?: string[];
          resident_key?: string;
          room_keys?: string[];
          space_keys?: string[];
          starts_at?: string;
          tenant_key?: string;
          unit_keys?: string[];
          user_identity_key?: string;
          user_key?: string;
      }[]

      List of access grants.

    • Optionalbookings?: {
          booking_key: string;
          building_keys?: string[];
          common_area_keys?: string[];
          ends_at?: string;
          facility_keys?: string[];
          guest_key?: string;
          listing_keys?: string[];
          name?: string;
          preferred_code?: string;
          property_keys?: string[];
          resident_key?: string;
          room_keys?: string[];
          space_keys?: string[];
          starts_at?: string;
          tenant_key?: string;
          unit_keys?: string[];
          user_identity_key?: string;
          user_key?: string;
      }[]

      List of bookings.

    • Optionalbuildings?: { building_key: string; name: string }[]

      List of buildings.

    • Optionalcommon_areas?: { common_area_key: string; name: string }[]

      List of shared common areas.

    • customer_key: string

      Your unique identifier for the customer.

    • Optionalfacilities?: { facility_key: string; name: string }[]

      List of gym or fitness facilities.

    • Optionalguests?: {
          email_address?: string;
          guest_key: string;
          name: string;
          phone_number?: string;
      }[]

      List of guests.

    • Optionallistings?: { listing_key: string; name: string }[]

      List of property listings.

    • Optionalproperties?: { name: string; property_key: string }[]

      List of short-term rental properties.

    • Optionalproperty_listings?: { name: string; property_listing_key: string }[]

      List of property listings.

    • Optionalreservations?: {
          building_keys?: string[];
          common_area_keys?: string[];
          ends_at?: string;
          facility_keys?: string[];
          guest_key?: string;
          listing_keys?: string[];
          name?: string;
          preferred_code?: string;
          property_keys?: string[];
          reservation_key: string;
          resident_key?: string;
          room_keys?: string[];
          space_keys?: string[];
          starts_at?: string;
          tenant_key?: string;
          unit_keys?: string[];
          user_identity_key?: string;
          user_key?: string;
      }[]

      List of reservations.

    • Optionalresidents?: {
          email_address?: string;
          name: string;
          phone_number?: string;
          resident_key: string;
      }[]

      List of residents.

    • Optionalrooms?: { name: string; room_key: string }[]

      List of hotel or hospitality rooms.

    • Optionalspaces?: { name: string; space_key: string }[]

      List of general spaces or areas.

    • Optionaltenants?: {
          email_address?: string;
          name: string;
          phone_number?: string;
          tenant_key: string;
      }[]

      List of tenants.

    • Optionalunits?: { name: string; unit_key: string }[]

      List of multi-family residential units.

    • Optionaluser_identities?: {
          email_address?: string;
          name: string;
          phone_number?: string;
          user_identity_key: string;
      }[]

      List of user identities.

    • Optionalusers?: {
          email_address?: string;
          name: string;
          phone_number?: string;
          user_key: string;
      }[]

      List of users.
  • options: CustomersPushDataOptions = {}

  Returns CustomersPushDataRequest

updateClientSessionToken

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

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

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

  Parameters

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

  Returns SeamHttpCustomers

StaticfromClient

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

  Parameters

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

  Returns SeamHttpCustomers

StaticfromClientSessionToken

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

  Parameters

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

  Returns SeamHttpCustomers

StaticfromConsoleSessionToken

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

  Parameters

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

  Returns SeamHttpCustomers

StaticfromPersonalAccessToken

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

  Parameters

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

  Returns SeamHttpCustomers

StaticfromPublishableKey

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

  Parameters

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

  Returns Promise<SeamHttpCustomers>