@botpress/webchat 1.1.1 → 1.2.0

package/dist/gen/client/base.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Webchat API
+ * API for the Webchat Integration
+ *
+ * The version of the OpenAPI document: 0.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from './configuration';
+import type { AxiosInstance, AxiosRequestConfig } from 'axios';
+export declare const BASE_PATH: string;
+/**
+ *
+ * @export
+ */
+export declare const COLLECTION_FORMATS: {
+    csv: string;
+    ssv: string;
+    tsv: string;
+    pipes: string;
+};
+/**
+ *
+ * @export
+ * @interface RequestArgs
+ */
+export interface RequestArgs {
+    url: string;
+    options: AxiosRequestConfig;
+}
+/**
+ *
+ * @export
+ * @class BaseAPI
+ */
+export declare class BaseAPI {
+    protected basePath: string;
+    protected axios: AxiosInstance;
+    protected configuration: Configuration | undefined;
+    constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
+}
+/**
+ *
+ * @export
+ * @class RequiredError
+ * @extends {Error}
+ */
+export declare class RequiredError extends Error {
+    field: string;
+    constructor(field: string, msg?: string);
+}

package/dist/gen/client/client.d.ts

@@ -0,0 +1,57 @@
+import { AxiosInstance } from 'axios';
+import { Configuration, DefaultApiGetConversationRequest, DefaultApiCreateConversationRequest, DefaultApiDeleteConversationRequest, DefaultApiListConversationsRequest, DefaultApiListenConversationRequest, DefaultApiListConversationMessagesRequest, DefaultApiAddParticipantRequest, DefaultApiRemoveParticipantRequest, DefaultApiGetParticipantRequest, DefaultApiListParticipantsRequest, DefaultApiGetMessageRequest, DefaultApiCreateMessageRequest, DefaultApiDeleteMessageRequest, DefaultApiGetUserRequest, DefaultApiCreateUserRequest, DefaultApiUpdateUserRequest, DefaultApiDeleteUserRequest } from '.';
+type SimplifyOptions = {
+    deep?: boolean;
+};
+type Flatten<AnyType, Options extends SimplifyOptions = {}> = Options['deep'] extends true ? {
+    [KeyType in keyof AnyType]: Simplify<AnyType[KeyType], Options>;
+} : {
+    [KeyType in keyof AnyType]: AnyType[KeyType];
+};
+type Simplify<AnyType, Options extends SimplifyOptions = {}> = Flatten<AnyType> extends AnyType ? Flatten<AnyType, Options> : AnyType;
+type Merge_<FirstType, SecondType> = Except<FirstType, Extract<keyof FirstType, keyof SecondType>> & SecondType;
+type IsEqual<T, U> = (<G>() => G extends T ? 1 : 2) extends (<G>() => G extends U ? 1 : 2) ? true : false;
+type Filter<KeyType, ExcludeType> = IsEqual<KeyType, ExcludeType> extends true ? never : (KeyType extends ExcludeType ? never : KeyType);
+type Merge<FirstType, SecondType> = Simplify<Merge_<FirstType, SecondType>>;
+type Except<ObjectType, KeysType extends keyof ObjectType> = {
+    [KeyType in keyof ObjectType as Filter<KeyType, KeysType>]: ObjectType[KeyType];
+};
+export declare class ApiClient {
+    private _innerClient;
+    constructor(configuration?: Configuration, basePath?: string, axiosInstance?: AxiosInstance);
+    getConversation: (props: GetConversationProps) => Promise<import("./api").GetConversationResponse>;
+    createConversation: ({ xUserKey, ...createConversationBody }: CreateConversationProps) => Promise<import("./api").CreateConversationResponse>;
+    deleteConversation: (props: DeleteConversationProps) => Promise<object>;
+    listConversations: (props: ListConversationsProps) => Promise<import("./api").ListConversationsResponse>;
+    listenConversation: (props: ListenConversationProps) => Promise<object>;
+    listConversationMessages: (props: ListConversationMessagesProps) => Promise<import("./api").ListConversationMessagesResponse>;
+    addParticipant: ({ id, xUserKey, ...addParticipantBody }: AddParticipantProps) => Promise<import("./api").AddParticipantResponse>;
+    removeParticipant: (props: RemoveParticipantProps) => Promise<object>;
+    getParticipant: (props: GetParticipantProps) => Promise<import("./api").GetParticipantResponse>;
+    listParticipants: (props: ListParticipantsProps) => Promise<import("./api").ListParticipantsResponse>;
+    getMessage: (props: GetMessageProps) => Promise<import("./api").GetMessageResponse>;
+    createMessage: ({ xUserKey, ...createMessageBody }: CreateMessageProps) => Promise<import("./api").CreateMessageResponse>;
+    deleteMessage: (props: DeleteMessageProps) => Promise<object>;
+    getUser: (props: GetUserProps) => Promise<import("./api").GetUserResponse>;
+    createUser: (createUserBody: CreateUserProps) => Promise<import("./api").CreateUserResponse>;
+    updateUser: ({ xUserKey, ...updateUserBody }: UpdateUserProps) => Promise<import("./api").UpdateUserResponse>;
+    deleteUser: (props: DeleteUserProps) => Promise<object>;
+}
+export type GetConversationProps = Merge<DefaultApiGetConversationRequest, {}>;
+export type CreateConversationProps = Merge<Except<DefaultApiCreateConversationRequest, 'createConversationBody'>, NonNullable<DefaultApiCreateConversationRequest['createConversationBody']>>;
+export type DeleteConversationProps = Merge<DefaultApiDeleteConversationRequest, {}>;
+export type ListConversationsProps = Merge<DefaultApiListConversationsRequest, {}>;
+export type ListenConversationProps = Merge<DefaultApiListenConversationRequest, {}>;
+export type ListConversationMessagesProps = Merge<DefaultApiListConversationMessagesRequest, {}>;
+export type AddParticipantProps = Merge<Except<DefaultApiAddParticipantRequest, 'addParticipantBody'>, NonNullable<DefaultApiAddParticipantRequest['addParticipantBody']>>;
+export type RemoveParticipantProps = Merge<DefaultApiRemoveParticipantRequest, {}>;
+export type GetParticipantProps = Merge<DefaultApiGetParticipantRequest, {}>;
+export type ListParticipantsProps = Merge<DefaultApiListParticipantsRequest, {}>;
+export type GetMessageProps = Merge<DefaultApiGetMessageRequest, {}>;
+export type CreateMessageProps = Merge<Except<DefaultApiCreateMessageRequest, 'createMessageBody'>, NonNullable<DefaultApiCreateMessageRequest['createMessageBody']>>;
+export type DeleteMessageProps = Merge<DefaultApiDeleteMessageRequest, {}>;
+export type GetUserProps = Merge<DefaultApiGetUserRequest, {}>;
+export type CreateUserProps = Merge<Except<DefaultApiCreateUserRequest, 'createUserBody'>, NonNullable<DefaultApiCreateUserRequest['createUserBody']>>;
+export type UpdateUserProps = Merge<Except<DefaultApiUpdateUserRequest, 'updateUserBody'>, NonNullable<DefaultApiUpdateUserRequest['updateUserBody']>>;
+export type DeleteUserProps = Merge<DefaultApiDeleteUserRequest, {}>;
+export {};

package/dist/gen/client/common.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Webchat API
+ * API for the Webchat Integration
+ *
+ * The version of the OpenAPI document: 0.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from "./configuration";
+import type { RequestArgs } from "./base";
+import type { AxiosInstance, AxiosResponse } from 'axios';
+/**
+ *
+ * @export
+ */
+export declare const DUMMY_BASE_URL = "https://example.com";
+/**
+ *
+ * @throws {RequiredError}
+ * @export
+ */
+export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
+/**
+ *
+ * @export
+ */
+export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
+/**
+ *
+ * @export
+ */
+export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
+/**
+ *
+ * @export
+ */
+export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
+/**
+ *
+ * @export
+ */
+export declare const toPathString: (url: URL) => string;
+/**
+ *
+ * @export
+ */
+export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T, any>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;

package/dist/gen/client/configuration.d.ts

@@ -0,0 +1,83 @@
+/**
+ * Webchat API
+ * API for the Webchat Integration
+ *
+ * The version of the OpenAPI document: 0.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export interface ConfigurationParameters {
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    username?: string;
+    password?: string;
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    basePath?: string;
+    baseOptions?: any;
+    formDataCtor?: new () => any;
+}
+export declare class Configuration {
+    /**
+     * parameter for apiKey security
+     * @param name security name
+     * @memberof Configuration
+     */
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    username?: string;
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    password?: string;
+    /**
+     * parameter for oauth2 security
+     * @param name security name
+     * @param scopes oauth2 scope
+     * @memberof Configuration
+     */
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    /**
+     * override base path
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    basePath?: string;
+    /**
+     * base options for axios calls
+     *
+     * @type {any}
+     * @memberof Configuration
+     */
+    baseOptions?: any;
+    /**
+     * The FormData constructor that will be used to create multipart form data
+     * requests. You can inject this here so that execution environments that
+     * do not support the FormData class can still run the generated client.
+     *
+     * @type {new () => FormData}
+     */
+    formDataCtor?: new () => any;
+    constructor(param?: ConfigurationParameters);
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    isJsonMime(mime: string): boolean;
+}

package/dist/gen/client/errors.d.ts

@@ -0,0 +1,197 @@
+declare const codes: {
+    readonly HTTP_STATUS_BAD_REQUEST: 400;
+    readonly HTTP_STATUS_UNAUTHORIZED: 401;
+    readonly HTTP_STATUS_PAYMENT_REQUIRED: 402;
+    readonly HTTP_STATUS_FORBIDDEN: 403;
+    readonly HTTP_STATUS_NOT_FOUND: 404;
+    readonly HTTP_STATUS_METHOD_NOT_ALLOWED: 405;
+    readonly HTTP_STATUS_REQUEST_TIMEOUT: 408;
+    readonly HTTP_STATUS_CONFLICT: 409;
+    readonly HTTP_STATUS_PAYLOAD_TOO_LARGE: 413;
+    readonly HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE: 415;
+    readonly HTTP_STATUS_TOO_MANY_REQUESTS: 429;
+    readonly HTTP_STATUS_INTERNAL_SERVER_ERROR: 500;
+    readonly HTTP_STATUS_NOT_IMPLEMENTED: 501;
+    readonly HTTP_STATUS_BAD_GATEWAY: 502;
+    readonly HTTP_STATUS_SERVICE_UNAVAILABLE: 503;
+    readonly HTTP_STATUS_GATEWAY_TIMEOUT: 504;
+};
+type ErrorCode = typeof codes[keyof typeof codes];
+declare abstract class BaseApiError<Code extends ErrorCode, Type extends string, Description extends string> extends Error {
+    readonly code: Code;
+    readonly description: Description;
+    readonly type: Type;
+    readonly message: string;
+    readonly error?: Error | undefined;
+    readonly id?: string | undefined;
+    readonly isApiError = true;
+    constructor(code: Code, description: Description, type: Type, message: string, error?: Error | undefined, id?: string | undefined);
+    format(): string;
+    toJSON(): {
+        id: string | undefined;
+        code: Code;
+        type: Type;
+        message: string;
+    };
+    static generateId(): string;
+    private static getPrefix;
+}
+export declare const isApiError: (thrown: unknown) => thrown is ApiError;
+type UnknownType = 'Unknown';
+/**
+ *  An unknown error occurred
+ */
+export declare class UnknownError extends BaseApiError<500, UnknownType, 'An unknown error occurred'> {
+    constructor(message: string, error?: Error, id?: string);
+}
+type InternalType = 'Internal';
+/**
+ *  An internal error occurred
+ */
+export declare class InternalError extends BaseApiError<500, InternalType, 'An internal error occurred'> {
+    constructor(message: string, error?: Error, id?: string);
+}
+type UnauthorizedType = 'Unauthorized';
+/**
+ *  The request requires to be authenticated.
+ */
+export declare class UnauthorizedError extends BaseApiError<401, UnauthorizedType, 'The request requires to be authenticated.'> {
+    constructor(message: string, error?: Error, id?: string);
+}
+type ForbiddenType = 'Forbidden';
+/**
+ *  The requested action can\'t be peform by this resource.
+ */
+export declare class ForbiddenError extends BaseApiError<403, ForbiddenType, 'The requested action can\'t be peform by this resource.'> {
+    constructor(message: string, error?: Error, id?: string);
+}
+type PayloadTooLargeType = 'PayloadTooLarge';
+/**
+ *  The request payload is too large.
+ */
+export declare class PayloadTooLargeError extends BaseApiError<413, PayloadTooLargeType, 'The request payload is too large.'> {
+    constructor(message: string, error?: Error, id?: string);
+}
+type InvalidPayloadType = 'InvalidPayload';
+/**
+ *  The request payload is invalid.
+ */
+export declare class InvalidPayloadError extends BaseApiError<400, InvalidPayloadType, 'The request payload is invalid.'> {
+    constructor(message: string, error?: Error, id?: string);
+}
+type UnsupportedMediaTypeType = 'UnsupportedMediaType';
+/**
+ *  The request is invalid because the content-type is not supported.
+ */
+export declare class UnsupportedMediaTypeError extends BaseApiError<415, UnsupportedMediaTypeType, 'The request is invalid because the content-type is not supported.'> {
+    constructor(message: string, error?: Error, id?: string);
+}
+type MethodNotFoundType = 'MethodNotFound';
+/**
+ *  The requested method does not exist.
+ */
+export declare class MethodNotFoundError extends BaseApiError<405, MethodNotFoundType, 'The requested method does not exist.'> {
+    constructor(message: string, error?: Error, id?: string);
+}
+type ResourceNotFoundType = 'ResourceNotFound';
+/**
+ *  The requested resource does not exist.
+ */
+export declare class ResourceNotFoundError extends BaseApiError<404, ResourceNotFoundType, 'The requested resource does not exist.'> {
+    constructor(message: string, error?: Error, id?: string);
+}
+type InvalidJsonSchemaType = 'InvalidJsonSchema';
+/**
+ *  The provided JSON schema is invalid.
+ */
+export declare class InvalidJsonSchemaError extends BaseApiError<400, InvalidJsonSchemaType, 'The provided JSON schema is invalid.'> {
+    constructor(message: string, error?: Error, id?: string);
+}
+type InvalidDataFormatType = 'InvalidDataFormat';
+/**
+ *  The provided data doesn\'t respect the provided JSON schema.
+ */
+export declare class InvalidDataFormatError extends BaseApiError<400, InvalidDataFormatType, 'The provided data doesn\'t respect the provided JSON schema.'> {
+    constructor(message: string, error?: Error, id?: string);
+}
+type InvalidIdentifierType = 'InvalidIdentifier';
+/**
+ *  The provided identifier is not valid. An identifier must start with a lowercase letter, be between 2 and 100 characters long and use only alphanumeric characters.
+ */
+export declare class InvalidIdentifierError extends BaseApiError<400, InvalidIdentifierType, 'The provided identifier is not valid. An identifier must start with a lowercase letter, be between 2 and 100 characters long and use only alphanumeric characters.'> {
+    constructor(message: string, error?: Error, id?: string);
+}
+type RelationConflictType = 'RelationConflict';
+/**
+ *  The resource is related with a different resource that the one referenced in the request. This is usually caused when providing two resource identifiers that aren\'t linked together.
+ */
+export declare class RelationConflictError extends BaseApiError<409, RelationConflictType, 'The resource is related with a different resource that the one referenced in the request. This is usually caused when providing two resource identifiers that aren\'t linked together.'> {
+    constructor(message: string, error?: Error, id?: string);
+}
+type ReferenceConstraintType = 'ReferenceConstraint';
+/**
+ *  The resource cannot be deleted because it\'s referenced by another resource
+ */
+export declare class ReferenceConstraintError extends BaseApiError<409, ReferenceConstraintType, 'The resource cannot be deleted because it\'s referenced by another resource'> {
+    constructor(message: string, error?: Error, id?: string);
+}
+type ReferenceNotFoundType = 'ReferenceNotFound';
+/**
+ *  The provided resource reference is missing. This is usually caused when providing an invalid id inside the payload of a request.
+ */
+export declare class ReferenceNotFoundError extends BaseApiError<400, ReferenceNotFoundType, 'The provided resource reference is missing. This is usually caused when providing an invalid id inside the payload of a request.'> {
+    constructor(message: string, error?: Error, id?: string);
+}
+type InvalidQueryType = 'InvalidQuery';
+/**
+ *  The provided query is invalid. This is usually caused when providing an invalid parameter for querying a resource.
+ */
+export declare class InvalidQueryError extends BaseApiError<400, InvalidQueryType, 'The provided query is invalid. This is usually caused when providing an invalid parameter for querying a resource.'> {
+    constructor(message: string, error?: Error, id?: string);
+}
+type RuntimeType = 'Runtime';
+/**
+ *  An error happened during the execution of a runtime (bot or integration).
+ */
+export declare class RuntimeError extends BaseApiError<400, RuntimeType, 'An error happened during the execution of a runtime (bot or integration).'> {
+    constructor(message: string, error?: Error, id?: string);
+}
+type AlreadyExistsType = 'AlreadyExists';
+/**
+ *  The record attempted to be created already exists.
+ */
+export declare class AlreadyExistsError extends BaseApiError<409, AlreadyExistsType, 'The record attempted to be created already exists.'> {
+    constructor(message: string, error?: Error, id?: string);
+}
+type RateLimitedType = 'RateLimited';
+/**
+ *  The request has been rate limited.
+ */
+export declare class RateLimitedError extends BaseApiError<429, RateLimitedType, 'The request has been rate limited.'> {
+    constructor(message: string, error?: Error, id?: string);
+}
+type PaymentRequiredType = 'PaymentRequired';
+/**
+ *  A payment is required to perform this request.
+ */
+export declare class PaymentRequiredError extends BaseApiError<402, PaymentRequiredType, 'A payment is required to perform this request.'> {
+    constructor(message: string, error?: Error, id?: string);
+}
+type QuotaExceededType = 'QuotaExceeded';
+/**
+ *  The request exceeds the allowed quota. Quotas are a soft limit that can be increased.
+ */
+export declare class QuotaExceededError extends BaseApiError<403, QuotaExceededType, 'The request exceeds the allowed quota. Quotas are a soft limit that can be increased.'> {
+    constructor(message: string, error?: Error, id?: string);
+}
+type LimitExceededType = 'LimitExceeded';
+/**
+ *  The request exceeds the allowed limit. Limits are a hard limit that cannot be increased.
+ */
+export declare class LimitExceededError extends BaseApiError<413, LimitExceededType, 'The request exceeds the allowed limit. Limits are a hard limit that cannot be increased.'> {
+    constructor(message: string, error?: Error, id?: string);
+}
+export type ErrorType = 'Unknown' | 'Internal' | 'Unauthorized' | 'Forbidden' | 'PayloadTooLarge' | 'InvalidPayload' | 'UnsupportedMediaType' | 'MethodNotFound' | 'ResourceNotFound' | 'InvalidJsonSchema' | 'InvalidDataFormat' | 'InvalidIdentifier' | 'RelationConflict' | 'ReferenceConstraint' | 'ReferenceNotFound' | 'InvalidQuery' | 'Runtime' | 'AlreadyExists' | 'RateLimited' | 'PaymentRequired' | 'QuotaExceeded' | 'LimitExceeded';
+export type ApiError = UnknownError | InternalError | UnauthorizedError | ForbiddenError | PayloadTooLargeError | InvalidPayloadError | UnsupportedMediaTypeError | MethodNotFoundError | ResourceNotFoundError | InvalidJsonSchemaError | InvalidDataFormatError | InvalidIdentifierError | RelationConflictError | ReferenceConstraintError | ReferenceNotFoundError | InvalidQueryError | RuntimeError | AlreadyExistsError | RateLimitedError | PaymentRequiredError | QuotaExceededError | LimitExceededError;
+export declare const errorFrom: (err: unknown) => ApiError;
+export {};

package/dist/gen/client/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Webchat API
+ * API for the Webchat Integration
+ *
+ * The version of the OpenAPI document: 0.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export * from "./api";
+export * from "./configuration";

package/dist/gen/models/conversation.j.d.ts

@@ -0,0 +1,20 @@
+declare const _default: {
+    type: string;
+    properties: {
+        id: {
+            type: string;
+        };
+        createdAt: {
+            type: string;
+            format: string;
+        };
+        updatedAt: {
+            type: string;
+            format: string;
+        };
+    };
+    required: string[];
+    additionalProperties: boolean;
+    $schema: string;
+};
+export default _default;

package/dist/gen/models/conversation.t.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+export interface Conversation {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+}

package/dist/gen/models/conversation.z.d.ts

@@ -0,0 +1,15 @@
+import { z } from "zod";
+declare const _default: z.ZodObject<{
+    id: z.ZodString;
+    createdAt: z.ZodString;
+    updatedAt: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+}, {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+}>;
+export default _default;