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: SeamHttpRequest<TResponse, TResponseKey>,
  ): SeamPaginator<TResponse, TResponseKey>

  Creates a new SeamPaginator to iterate over the paginated results of the request.

  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

  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).

  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>

  Updates the client session token used by this client for authentication.

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

  Throws

  If this client was not created with a client session token.

StaticfromApiKey

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

  Creates a new SeamHttpCustomers authenticated with an API key.

  Parameters

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

  Returns SeamHttpCustomers

StaticfromClient

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

  Creates a new SeamHttpCustomers from an existing HTTP client.

  Parameters

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

  Returns SeamHttpCustomers

StaticfromClientSessionToken

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

  Creates a new SeamHttpCustomers authenticated with a client session token.

  Parameters

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

  Returns SeamHttpCustomers

StaticfromConsoleSessionToken

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

  Creates a new SeamHttpCustomers authenticated with a console session token and scoped to a workspace.

  Parameters

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

  Returns SeamHttpCustomers

StaticfromPersonalAccessToken

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

  Creates a new SeamHttpCustomers authenticated with a personal access token and scoped to a workspace.

  Parameters

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

  Returns SeamHttpCustomers

StaticfromPublishableKey

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

  Creates a new SeamHttpCustomers authenticated with a client session token for the user identified by the user identifier key. The client session is created with the publishable key if it does not exist.

  Parameters

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

  Returns Promise<SeamHttpCustomers>