Class SeamHttpCustomers

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpCustomers

client

Readonlydefaults

createPaginator

• createPaginator<
      const TResponse,
      const TResponseKey extends string | number | symbol,
  >(
      request: SeamPaginatedRequest<TResponse, TResponseKey>,
  ): SeamPaginator<TResponse, TResponseKey>

  Type Parameters

  • const TResponse
  • const TResponseKey extends string | number | symbol

  Parameters

  • request: SeamPaginatedRequest<TResponse, TResponseKey>

  Returns SeamPaginator<TResponse, TResponseKey>

createPortal

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

  Creates a new customer portal magic link with configurable features.

  Parameters

  • Optionalparameters: CustomersCreatePortalParameters
  • options: CustomersCreatePortalOptions = {}

  Returns CustomersCreatePortalRequest

deleteData

• deleteData(
      parameters?: CustomersDeleteDataParameters,
      options?: CustomersDeleteDataOptions,
  ): CustomersDeleteDataRequest

  Deletes customer data including resources like spaces, properties, rooms, users, etc. This will delete the partner resources and any related Seam resources (user identities, access grants, spaces). Space keys also match spaces created directly with a space_key (for example, through /spaces/create).

  Parameters

  • Optionalparameters: CustomersDeleteDataParameters
  • options: CustomersDeleteDataOptions = {}

  Returns CustomersDeleteDataRequest

pushData

• pushData(
      parameters: CustomersPushDataParameters,
      options?: CustomersPushDataOptions,
  ): CustomersPushDataRequest

  Pushes customer data including resources like spaces, properties, rooms, users, etc.

  Parameters

  • parameters: CustomersPushDataParameters
  • 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>