Class PlatformReportClient

Platform Report client.

Hierarchy (View Summary)

ChatBotKitClient
- PlatformReportClient

Index

Constructors

Methods

clientProxy extend generate generateBatch generateTyped list

Constructors

constructor

new PlatformReportClient(options: ChatBotKitClientOptions): PlatformReportClient
Parameters
- options: ChatBotKitClientOptions
Returns PlatformReportClient
Overrides ChatBotKitClient.constructor
- Defined in platform/report/index.js:22

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

extend

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

generate

generate(
reportId: string,
request: { [key: string]: unknown },
): Promise<Record<string, never>>
Generates a specific report.
Parameters
- reportId: string
- request: { [key: string]: unknown }
Returns Promise<Record<string, never>>
- Defined in platform/report/index.js:43

generateBatch

generateBatch(
request: { [key: string]: Record<string, never> },
): Promise<{ [key: string]: Record<string, never> | {} }>
Generates multiple reports in a single request.
Parameters
- request: { [key: string]: Record<string, never> }
Returns Promise<{ [key: string]: Record<string, never> | {} }>
- Defined in platform/report/index.js:65

generateTyped

generateTyped<T extends ReportId>(
reportId: T,
request: ReportInputTypes[T],
): Promise<ReportOutputTypes[T]>
Generates a typed report with full type safety for input and output.
Type Parameters
- T extends ReportId
Parameters
- reportId: T
  The report ID
- request: ReportInputTypes[T]
  The report input
Returns Promise<ReportOutputTypes[T]>
- Defined in platform/report/index.js:55

list

list(request?: PlatformReportListRequest): ResponsePromise<{}, {}>
Retrieves a list of all available reports.
Parameters
- Optionalrequest: PlatformReportListRequest
Returns ResponsePromise<{}, {}>
- Defined in platform/report/index.js:32