Class BlueprintClient

Blueprint client.

Hierarchy (View Summary)

ChatBotKitClient
- BlueprintClient

Index

Constructors

Methods

clientProxy clone create createBulletin delete exportResources extend fetch importResources list listBulletins listResources update

Constructors

constructor

new BlueprintClient(options: ChatBotKitClientOptions): BlueprintClient
Parameters
- options: ChatBotKitClientOptions
Returns BlueprintClient
Overrides ChatBotKitClient.constructor
- Defined in blueprint/index.js:29

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

clone

clone(blueprintId: string): Promise<{}>
Clones a blueprint.
Parameters
- blueprintId: string
Returns Promise<{}>
- Defined in blueprint/index.js:91

create

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

createBulletin

createBulletin(blueprintId: string, request: {}): Promise<{}>
Posts a bulletin to a blueprint's shared board.
Parameters
- blueprintId: string
- request: {}
Returns Promise<{}>
- Defined in blueprint/index.js:145

delete

delete(blueprintId: string, request?: {}): Promise<{}>
Deletes the blueprint.
Parameters
- blueprintId: string
- Optionalrequest: {}
Returns Promise<{}>
- Defined in blueprint/index.js:81

exportResources

exportResources(blueprintId: string): Promise<BlueprintExportResourcesResponse>
Exports a blueprint's resources as a transportable document.
Parameters
- blueprintId: string
Returns Promise<BlueprintExportResourcesResponse>
- Defined in blueprint/index.js:123

extend

extend(extensionOptions: Partial<ChatBotKitClientOptions>): BlueprintClient
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 BlueprintClient
A new instance of the same client class with extended options
Inherited from ChatBotKitClient.extend
- Defined in client.js:442

fetch

fetch(blueprintId: string): ResponsePromise<{}, never>
Fetches a blueprint.
Parameters
- blueprintId: string
Returns ResponsePromise<{}, never>
- Defined in blueprint/index.js:49

importResources

importResources(
blueprintId: string,
request: BlueprintImportResourcesRequest,
): Promise<BlueprintImportResourcesResponse>
Imports (reconciles) resources into a blueprint. The blueprint may be addressed by id or @alias; pass ensure: true to create it on miss.
Parameters
- blueprintId: string
- request: BlueprintImportResourcesRequest
Returns Promise<BlueprintImportResourcesResponse>
- Defined in blueprint/index.js:113

list

list(request?: BlueprintListRequest): ResponsePromise<{}, {}>
Retrieves a list of all blueprints.
Parameters
- Optionalrequest: BlueprintListRequest
Returns ResponsePromise<{}, {}>
- Defined in blueprint/index.js:39

listBulletins

listBulletins(
blueprintId: string,
request?: BlueprintBulletinListRequest,
): ResponsePromise<{}, {}>
Lists the bulletins on a blueprint's shared board.
Parameters
- blueprintId: string
- Optionalrequest: BlueprintBulletinListRequest
Returns ResponsePromise<{}, {}>
- Defined in blueprint/index.js:134

listResources

listResources(blueprintId: string): Promise<{}>
Lists all resources for a blueprint.
Parameters
- blueprintId: string
Returns Promise<{}>
- Defined in blueprint/index.js:101

update

update(blueprintId: string, request: {}): Promise<{}>
Updates a blueprint.
Parameters
- blueprintId: string
- request: {}
Returns Promise<{}>
- Defined in blueprint/index.js:70

Class BlueprintClient

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns BlueprintClient

Methods

clientProxy

Parameters

Returns Promise<Response>

clone

Parameters

Returns Promise<{}>

create

Parameters

Returns Promise<{}>

createBulletin

Parameters

Returns Promise<{}>

delete

Parameters

Returns Promise<{}>

exportResources

Parameters

Returns Promise<BlueprintExportResourcesResponse>

extend

Parameters

Returns BlueprintClient

fetch

Parameters

Returns ResponsePromise<{}, never>

importResources

Parameters

Returns Promise<BlueprintImportResourcesResponse>

list

Parameters

Returns ResponsePromise<{}, {}>

listBulletins

Parameters

Returns ResponsePromise<{}, {}>

listResources

Parameters

Returns Promise<{}>

update

Parameters

Returns Promise<{}>

Settings

On This Page