Skip to Content

CustomerClient

A client for one customer of one project, created with createCustomerClient: its session, and one property per resource. Every request is made on the customer’s behalf; when the customer’s access ends, the session is cleared and requests reject with CustomerAccessInvalidatedError.

Constructors

Constructor

protected new CustomerClient(config): CustomerClient;

Use createCustomerClient.

Parameters

config

CreateCustomerClientConfig

Properties

chat

readonly chat: ChatResource;

checkoutSessions

readonly checkoutSessions: CheckoutSessionsResource;

customServer

readonly customServer: CustomServerResource;

gateway

readonly gateway: GatewayResource;

models

readonly models: ModelsResource;

oauth

readonly oauth: OAuthSignInResource;

products

readonly products: ProductsResource;

session

readonly session: CustomerSessionResource;

usage

readonly usage: UsageResource;

Accessors

projectId

Get Signature

get projectId(): string | null;

The project the client acts in: the session’s, or the configured one.

Workflow guides

Last updated on