Class UserClient

User client.

Hierarchy (View Summary)

ChatBotKitClient
- UserClient

Index

Constructors

Properties

context session token

Methods

clientProxy create delete extend fetch list update

Constructors

constructor

new UserClient(options: ChatBotKitClientOptions): UserClient
Parameters
- options: ChatBotKitClientOptions
Returns UserClient
Overrides ChatBotKitClient.constructor
- Defined in user/index.js:26

Properties

context

context: UserContextClient

session

session: UserSessionClient

token

token: UserTokenClient

Methods

clientProxy

clientProxy(
    path: string,
    options?: {
        buffer?: ArrayBuffer;
        endpoint?: string;
        external?: boolean;
        fetchFn?: FetchFunction;
        file?: { data: string | ArrayBuffer; name?: string; type?: string };
        headers?: Record<string, any>;
        method?: string;
        query?: Record<string, any>;
        record?: Record<string, any>;
        retries?: number;
        retryDelay?: number;
        retryTimeout?: boolean;
        timeout?: number;
    },
): Promise<Response>
Proxies a request and resolves the upstream Response. Successful and upstream-error responses pass through untouched - streaming, binary and large bodies are preserved (the body is never read on the success path). The one exception is a CBK authorization_required signal, which is thrown as an AuthorizationRequiredError carrying the url the user must visit to authenticate.
Parameters
- path: string
- Optionaloptions: {
      buffer?: ArrayBuffer;
      endpoint?: string;
      external?: boolean;
      fetchFn?: FetchFunction;
      file?: { data: string | ArrayBuffer; name?: string; type?: string };
      headers?: Record<string, any>;
      method?: string;
      query?: Record<string, any>;
      record?: Record<string, any>;
      retries?: number;
      retryDelay?: number;
      retryTimeout?: boolean;
      timeout?: number;
  }
Returns Promise<Response>
Inherited from ChatBotKitClient.clientProxy
- Defined in client.js:646

create

create(request: {}): Promise<{}>
Creates a new user.
Parameters
- request: {}
Returns Promise<{}>
- Defined in user/index.js:71

delete

delete(userId: string): Promise<{}>
Deletes the user.
Parameters
- userId: string
Returns Promise<{}>
- Defined in user/index.js:92

extend

extend(extensionOptions: Partial<ChatBotKitClientOptions>): UserClient
Creates a new instance of the same client type with extended options.

This is useful when you need to create a client with modified configuration (e.g., different endpoint, token, or headers) without affecting the original.

Note: This method creates a completely new instance rather than cloning, which is necessary because private class fields cannot be copied.
Parameters
- extensionOptions: Partial<ChatBotKitClientOptions>
  Options to merge with current options
Returns UserClient
A new instance of the same client class with extended options
Inherited from ChatBotKitClient.extend
- Defined in client.js:442

fetch

fetch(userId: string): ResponsePromise<{}, never>
Fetches a user.
Parameters
- userId: string
Returns ResponsePromise<{}, never>
- Defined in user/index.js:61

list

list(request?: UserListRequest): ResponsePromise<{}, {}>
Retrieves a list of all users.
Parameters
- Optionalrequest: UserListRequest
Returns ResponsePromise<{}, {}>
- Defined in user/index.js:51

update

update(userId: string, request: {}): Promise<{}>
Updates the user.
Parameters
- userId: string
- request: {}
Returns Promise<{}>
- Defined in user/index.js:82