@botpress/client 0.23.2 → 0.24.1

package/dist/gen/operations/getState.d.ts

@@ -1,66 +0,0 @@
-export interface GetStateRequestHeaders {
-}
-export interface GetStateRequestQuery {
-}
-export interface GetStateRequestParams {
-    type: "conversation" | "user" | "bot" | "integration" | "task";
-    id: string;
-    name: string;
-}
-export interface GetStateRequestBody {
-}
-export type GetStateInput = GetStateRequestBody & GetStateRequestHeaders & GetStateRequestQuery & GetStateRequestParams;
-export type GetStateRequest = {
-    headers: GetStateRequestHeaders;
-    query: GetStateRequestQuery;
-    params: GetStateRequestParams;
-    body: GetStateRequestBody;
-};
-export declare const parseReq: (input: GetStateInput) => GetStateRequest & {
-    path: string;
-};
-export interface GetStateResponse {
-    /**
-     * The state object represents the current payload. A state is always linked to either a bot, a conversation or a user.
-     */
-    state: {
-        /**
-         * Id of the [State](#schema_state)
-         */
-        id: string;
-        /**
-         * Creation date of the [State](#schema_state) in ISO 8601 format
-         */
-        createdAt: string;
-        /**
-         * Updating date of the [State](#schema_state) in ISO 8601 format
-         */
-        updatedAt: string;
-        /**
-         * Id of the [Bot](#schema_bot)
-         */
-        botId: string;
-        /**
-         * Id of the [Conversation](#schema_conversation)
-         */
-        conversationId?: string;
-        /**
-         * Id of the [User](#schema_user)
-         */
-        userId?: string;
-        /**
-         * Name of the [State](#schema_state) which is declared inside the bot definition
-         */
-        name: string;
-        /**
-         * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task` or `integration`) that the state is related to
-         */
-        type: "conversation" | "user" | "bot" | "task" | "integration";
-        /**
-         * Payload is the content of the state defined by your bot.
-         */
-        payload: {
-            [k: string]: any;
-        };
-    };
-}

package/dist/gen/operations/getTable.d.ts

@@ -1,136 +0,0 @@
-export interface GetTableRequestHeaders {
-}
-export interface GetTableRequestQuery {
-}
-export interface GetTableRequestParams {
-    table: string;
-}
-export interface GetTableRequestBody {
-}
-export type GetTableInput = GetTableRequestBody & GetTableRequestHeaders & GetTableRequestQuery & GetTableRequestParams;
-export type GetTableRequest = {
-    headers: GetTableRequestHeaders;
-    query: GetTableRequestQuery;
-    params: GetTableRequestParams;
-    body: GetTableRequestBody;
-};
-export declare const parseReq: (input: GetTableInput) => GetTableRequest & {
-    path: string;
-};
-export interface GetTableResponse {
-    table: {
-        /**
-         * Unique identifier for the table
-         */
-        id: string;
-        /**
-         * Required. This name is used to identify your table.
-         */
-        name: string;
-        /**
-         * The 'factor' multiplies the row's data storage limit by 4KB and its quota count, but can only be set at table creation and not modified later. For instance, a factor of 2 increases storage to 8KB but counts as 2 rows in your quota. The default factor is 1.
-         */
-        factor?: number;
-        /**
-         * A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.
-         */
-        frozen?: boolean;
-        schema: {
-            $schema: string;
-            /**
-             * List of keys/columns in the table.
-             */
-            properties: {
-                [k: string]: {
-                    type: "string" | "number" | "boolean" | "object" | "null";
-                    format?: "date-time";
-                    description?: string;
-                    nullable?: boolean;
-                    "x-zui": {
-                        index: number;
-                        /**
-                         * [deprecated] ID of the column.
-                         */
-                        id?: string;
-                        /**
-                         * Indicates if the column is vectorized and searchable.
-                         */
-                        searchable?: boolean;
-                        /**
-                         * Indicates if the field is hidden in the UI
-                         */
-                        hidden?: boolean;
-                        /**
-                         * Order of the column in the UI
-                         */
-                        order?: number;
-                        /**
-                         * Width of the column in the UI
-                         */
-                        width?: number;
-                        computed?: {
-                            action: "ai" | "code";
-                            dependencies?: string[];
-                            /**
-                             * Prompt when action is "ai"
-                             */
-                            prompt?: string;
-                            /**
-                             * Model to use when action is "ai"
-                             */
-                            model?: "gpt-3.5-turbo" | "gpt-3.5-turbo-0125" | "gpt-3.5-turbo-1106" | "gpt-3.5-turbo-16k" | "gpt-4o" | "gpt-4" | "gpt-4-turbo" | "gpt-4-0125-preview" | "gpt-4-1106-preview";
-                            /**
-                             * Code to execute when action is "code"
-                             */
-                            code?: string;
-                            enabled?: boolean;
-                        };
-                        /**
-                         * TypeScript typings for the column. Recommended if the type is "object", ex: "\{ foo: string; bar: number \}"
-                         */
-                        typings?: string;
-                    };
-                };
-            };
-            /**
-             * Additional properties can be provided, but they will be ignored if no column matches.
-             */
-            additionalProperties: true;
-            /**
-             * Array of required properties.
-             */
-            required?: string[];
-            type: "object";
-        };
-        /**
-         * Optional tags to help organize your tables. These should be passed here as an object representing key/value pairs.
-         */
-        tags?: {
-            [k: string]: string;
-        };
-        /**
-         * Indicates if the table is enabled for computation.
-         */
-        isComputeEnabled?: boolean;
-        /**
-         * Timestamp of table creation.
-         */
-        createdAt?: string;
-        /**
-         * Timestamp of the last table update.
-         */
-        updatedAt?: string;
-    };
-    /**
-     * The total number of rows present in the table.
-     */
-    rows: number;
-    /**
-     * The number of stale rows that are waiting to be processed
-     */
-    stale: number;
-    /**
-     * The number of rows that are waiting to be indexed (for search)
-     */
-    indexing: number;
-}

package/dist/gen/operations/getTableRow.d.ts

@@ -1,53 +0,0 @@
-export interface GetTableRowRequestHeaders {
-}
-export interface GetTableRowRequestQuery {
-    id: number;
-}
-export interface GetTableRowRequestParams {
-    table: string;
-}
-export interface GetTableRowRequestBody {
-}
-export type GetTableRowInput = GetTableRowRequestBody & GetTableRowRequestHeaders & GetTableRowRequestQuery & GetTableRowRequestParams;
-export type GetTableRowRequest = {
-    headers: GetTableRowRequestHeaders;
-    query: GetTableRowRequestQuery;
-    params: GetTableRowRequestParams;
-    body: GetTableRowRequestBody;
-};
-export declare const parseReq: (input: GetTableRowInput) => GetTableRowRequest & {
-    path: string;
-};
-export interface GetTableRowResponse {
-    row: {
-        /**
-         * Unique identifier for the row.
-         */
-        id: number;
-        /**
-         * Timestamp of row creation.
-         */
-        createdAt?: string;
-        /**
-         * Timestamp of the last row update.
-         */
-        updatedAt?: string;
-        computed: {
-            [k: string]: {
-                status: string;
-                error?: string;
-                updatedBy?: string;
-                updatedAt?: string;
-            };
-        };
-        /**
-         * [Read-only] List of stale values that are waiting to be recomputed.
-         */
-        stale?: string[];
-        /**
-         * Optional numeric value indicating similarity, when using findTableRows.
-         */
-        similarity?: number;
-        [k: string]: any;
-    };
-}

package/dist/gen/operations/getTask.d.ts

@@ -1,86 +0,0 @@
-export interface GetTaskRequestHeaders {
-}
-export interface GetTaskRequestQuery {
-}
-export interface GetTaskRequestParams {
-    id: string;
-}
-export interface GetTaskRequestBody {
-}
-export type GetTaskInput = GetTaskRequestBody & GetTaskRequestHeaders & GetTaskRequestQuery & GetTaskRequestParams;
-export type GetTaskRequest = {
-    headers: GetTaskRequestHeaders;
-    query: GetTaskRequestQuery;
-    params: GetTaskRequestParams;
-    body: GetTaskRequestBody;
-};
-export declare const parseReq: (input: GetTaskInput) => GetTaskRequest & {
-    path: string;
-};
-export interface GetTaskResponse {
-    /**
-     * Task definition
-     */
-    task: {
-        /**
-         * Id of the [Task](#schema_task)
-         */
-        id: string;
-        /**
-         * Title describing the task
-         */
-        title: string;
-        /**
-         * All the notes related to the execution of the current task
-         */
-        description: string;
-        /**
-         * Type of the task
-         */
-        type: string;
-        /**
-         * Content related to the task
-         */
-        data: {
-            [k: string]: any;
-        };
-        /**
-         * Status of the task
-         */
-        status: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
-        /**
-         * Parent task id is the parent task that created this task
-         */
-        parentTaskId?: string;
-        /**
-         * Conversation id related to this task
-         */
-        conversationId?: string;
-        /**
-         * Specific user related to this task
-         */
-        userId?: string;
-        /**
-         * The timeout date where the task should be failed in the ISO 8601 format
-         */
-        timeoutAt: string;
-        /**
-         * Creation date of the task in ISO 8601 format
-         */
-        createdAt: string;
-        /**
-         * Updating date of the task in ISO 8601 format
-         */
-        updatedAt: string;
-        /**
-         * If the task fails this is the reason behind it
-         */
-        failureReason?: string;
-        /**
-         * Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Task](#schema_task). Individual keys can be unset by posting an empty value to them.
-         */
-        tags: {
-            [k: string]: string;
-        };
-    };
-}

package/dist/gen/operations/getUpcomingInvoice.d.ts

@@ -1,29 +0,0 @@
-export interface GetUpcomingInvoiceRequestHeaders {
-}
-export interface GetUpcomingInvoiceRequestQuery {
-}
-export interface GetUpcomingInvoiceRequestParams {
-    id: string;
-}
-export interface GetUpcomingInvoiceRequestBody {
-}
-export type GetUpcomingInvoiceInput = GetUpcomingInvoiceRequestBody & GetUpcomingInvoiceRequestHeaders & GetUpcomingInvoiceRequestQuery & GetUpcomingInvoiceRequestParams;
-export type GetUpcomingInvoiceRequest = {
-    headers: GetUpcomingInvoiceRequestHeaders;
-    query: GetUpcomingInvoiceRequestQuery;
-    params: GetUpcomingInvoiceRequestParams;
-    body: GetUpcomingInvoiceRequestBody;
-};
-export declare const parseReq: (input: GetUpcomingInvoiceInput) => GetUpcomingInvoiceRequest & {
-    path: string;
-};
-export interface GetUpcomingInvoiceResponse {
-    /**
-     * ID of the invoice.
-     */
-    id: string;
-    /**
-     * Total amount to pay of the invoice.
-     */
-    total: number;
-}

package/dist/gen/operations/getUsage.d.ts

@@ -1,45 +0,0 @@
-export interface GetUsageRequestHeaders {
-}
-export interface GetUsageRequestQuery {
-    type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive";
-    period?: string;
-}
-export interface GetUsageRequestParams {
-    id: string;
-}
-export interface GetUsageRequestBody {
-}
-export type GetUsageInput = GetUsageRequestBody & GetUsageRequestHeaders & GetUsageRequestQuery & GetUsageRequestParams;
-export type GetUsageRequest = {
-    headers: GetUsageRequestHeaders;
-    query: GetUsageRequestQuery;
-    params: GetUsageRequestParams;
-    body: GetUsageRequestBody;
-};
-export declare const parseReq: (input: GetUsageInput) => GetUsageRequest & {
-    path: string;
-};
-export interface GetUsageResponse {
-    usage: {
-        /**
-         * Id of the usage that it is linked to. It can either be a workspace id or a bot id
-         */
-        id: string;
-        /**
-         * Period of the quota that it is applied to
-         */
-        period: string;
-        /**
-         * Value of the current usage
-         */
-        value: number;
-        /**
-         * Quota of the current usage
-         */
-        quota: number;
-        /**
-         * Usage type that can be used
-         */
-        type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive";
-    };
-}

package/dist/gen/operations/getUser.d.ts

@@ -1,52 +0,0 @@
-export interface GetUserRequestHeaders {
-}
-export interface GetUserRequestQuery {
-}
-export interface GetUserRequestParams {
-    id: string;
-}
-export interface GetUserRequestBody {
-}
-export type GetUserInput = GetUserRequestBody & GetUserRequestHeaders & GetUserRequestQuery & GetUserRequestParams;
-export type GetUserRequest = {
-    headers: GetUserRequestHeaders;
-    query: GetUserRequestQuery;
-    params: GetUserRequestParams;
-    body: GetUserRequestBody;
-};
-export declare const parseReq: (input: GetUserInput) => GetUserRequest & {
-    path: string;
-};
-export interface GetUserResponse {
-    /**
-     * The user object represents someone interacting with the bot within a specific integration. The same person interacting with a bot in slack and messenger will be represented with two different users.
-     */
-    user: {
-        /**
-         * Id of the [User](#schema_user)
-         */
-        id: string;
-        /**
-         * Creation date of the [User](#schema_user) in ISO 8601 format
-         */
-        createdAt: string;
-        /**
-         * Updating date of the [User](#schema_user) in ISO 8601 format
-         */
-        updatedAt: string;
-        /**
-         * Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [User](#schema_user). The set of [Tags](/docs/developers/concepts/tags) available on a [User](#schema_user) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
-         */
-        tags: {
-            [k: string]: string;
-        };
-        /**
-         * Name of the [User](#schema_user)
-         */
-        name?: string;
-        /**
-         * Picture URL of the [User](#schema_user)
-         */
-        pictureUrl?: string;
-    };
-}

package/dist/gen/operations/getWorkspace.d.ts

@@ -1,38 +0,0 @@
-export interface GetWorkspaceRequestHeaders {
-}
-export interface GetWorkspaceRequestQuery {
-}
-export interface GetWorkspaceRequestParams {
-    id: string;
-}
-export interface GetWorkspaceRequestBody {
-}
-export type GetWorkspaceInput = GetWorkspaceRequestBody & GetWorkspaceRequestHeaders & GetWorkspaceRequestQuery & GetWorkspaceRequestParams;
-export type GetWorkspaceRequest = {
-    headers: GetWorkspaceRequestHeaders;
-    query: GetWorkspaceRequestQuery;
-    params: GetWorkspaceRequestParams;
-    body: GetWorkspaceRequestBody;
-};
-export declare const parseReq: (input: GetWorkspaceInput) => GetWorkspaceRequest & {
-    path: string;
-};
-export interface GetWorkspaceResponse {
-    id: string;
-    name: string;
-    ownerId: string;
-    createdAt: string;
-    updatedAt: string;
-    botCount: number;
-    billingVersion: "v1" | "v2";
-    plan: "community" | "team" | "enterprise";
-    blocked: boolean;
-    spendingLimit: number;
-    about?: string;
-    profilePicture?: string;
-    contactEmail?: string;
-    website?: string;
-    socialAccounts?: string[];
-    isPublic?: boolean;
-    handle?: string;
-}

package/dist/gen/operations/getWorkspaceMember.d.ts

@@ -1,27 +0,0 @@
-export interface GetWorkspaceMemberRequestHeaders {
-}
-export interface GetWorkspaceMemberRequestQuery {
-}
-export interface GetWorkspaceMemberRequestParams {
-}
-export interface GetWorkspaceMemberRequestBody {
-}
-export type GetWorkspaceMemberInput = GetWorkspaceMemberRequestBody & GetWorkspaceMemberRequestHeaders & GetWorkspaceMemberRequestQuery & GetWorkspaceMemberRequestParams;
-export type GetWorkspaceMemberRequest = {
-    headers: GetWorkspaceMemberRequestHeaders;
-    query: GetWorkspaceMemberRequestQuery;
-    params: GetWorkspaceMemberRequestParams;
-    body: GetWorkspaceMemberRequestBody;
-};
-export declare const parseReq: (_: GetWorkspaceMemberInput) => GetWorkspaceMemberRequest & {
-    path: string;
-};
-export interface GetWorkspaceMemberResponse {
-    id: string;
-    userId?: string;
-    email: string;
-    createdAt: string;
-    role: "viewer" | "billing" | "developer" | "manager" | "administrator" | "owner";
-    profilePicture?: string;
-    displayName?: string;
-}

package/dist/gen/operations/getWorkspaceQuota.d.ts

@@ -1,37 +0,0 @@
-export interface GetWorkspaceQuotaRequestHeaders {
-}
-export interface GetWorkspaceQuotaRequestQuery {
-    type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive";
-    period?: string;
-}
-export interface GetWorkspaceQuotaRequestParams {
-    id: string;
-}
-export interface GetWorkspaceQuotaRequestBody {
-}
-export type GetWorkspaceQuotaInput = GetWorkspaceQuotaRequestBody & GetWorkspaceQuotaRequestHeaders & GetWorkspaceQuotaRequestQuery & GetWorkspaceQuotaRequestParams;
-export type GetWorkspaceQuotaRequest = {
-    headers: GetWorkspaceQuotaRequestHeaders;
-    query: GetWorkspaceQuotaRequestQuery;
-    params: GetWorkspaceQuotaRequestParams;
-    body: GetWorkspaceQuotaRequestBody;
-};
-export declare const parseReq: (input: GetWorkspaceQuotaInput) => GetWorkspaceQuotaRequest & {
-    path: string;
-};
-export interface GetWorkspaceQuotaResponse {
-    quota: {
-        /**
-         * Period of the quota that it is applied to
-         */
-        period: string;
-        /**
-         * Value of the quota that is used
-         */
-        value: number;
-        /**
-         * Usage type that can be used
-         */
-        type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive";
-    };
-}

package/dist/gen/operations/introspect.d.ts

@@ -1,24 +0,0 @@
-export interface IntrospectRequestHeaders {
-}
-export interface IntrospectRequestQuery {
-}
-export interface IntrospectRequestParams {
-}
-export interface IntrospectRequestBody {
-    botId: string;
-}
-export type IntrospectInput = IntrospectRequestBody & IntrospectRequestHeaders & IntrospectRequestQuery & IntrospectRequestParams;
-export type IntrospectRequest = {
-    headers: IntrospectRequestHeaders;
-    query: IntrospectRequestQuery;
-    params: IntrospectRequestParams;
-    body: IntrospectRequestBody;
-};
-export declare const parseReq: (input: IntrospectInput) => IntrospectRequest & {
-    path: string;
-};
-export interface IntrospectResponse {
-    workspaceId: string;
-    botId: string;
-    userId: string;
-}

package/dist/gen/operations/listActivities.d.ts

@@ -1,42 +0,0 @@
-export interface ListActivitiesRequestHeaders {
-}
-export interface ListActivitiesRequestQuery {
-    nextToken?: string;
-    taskId: string;
-    botId: string;
-}
-export interface ListActivitiesRequestParams {
-}
-export interface ListActivitiesRequestBody {
-}
-export type ListActivitiesInput = ListActivitiesRequestBody & ListActivitiesRequestHeaders & ListActivitiesRequestQuery & ListActivitiesRequestParams;
-export type ListActivitiesRequest = {
-    headers: ListActivitiesRequestHeaders;
-    query: ListActivitiesRequestQuery;
-    params: ListActivitiesRequestParams;
-    body: ListActivitiesRequestBody;
-};
-export declare const parseReq: (input: ListActivitiesInput) => ListActivitiesRequest & {
-    path: string;
-};
-export interface ListActivitiesResponse {
-    activities: {
-        id: string;
-        description: string;
-        taskId: string;
-        category: "unknown" | "capture" | "bot_message" | "user_message" | "agent_message" | "event" | "action" | "task_status" | "subtask_status" | "exception";
-        data: {
-            [k: string]: any;
-        };
-        /**
-         * Creation date of the activity in ISO 8601 format
-         */
-        createdAt: string;
-    }[];
-    meta: {
-        /**
-         * The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint.
-         */
-        nextToken?: string;
-    };
-}

package/dist/gen/operations/listBotIssueEvents.d.ts

@@ -1,32 +0,0 @@
-export interface ListBotIssueEventsRequestHeaders {
-}
-export interface ListBotIssueEventsRequestQuery {
-}
-export interface ListBotIssueEventsRequestParams {
-    id: string;
-    issueId: string;
-}
-export interface ListBotIssueEventsRequestBody {
-}
-export type ListBotIssueEventsInput = ListBotIssueEventsRequestBody & ListBotIssueEventsRequestHeaders & ListBotIssueEventsRequestQuery & ListBotIssueEventsRequestParams;
-export type ListBotIssueEventsRequest = {
-    headers: ListBotIssueEventsRequestHeaders;
-    query: ListBotIssueEventsRequestQuery;
-    params: ListBotIssueEventsRequestParams;
-    body: ListBotIssueEventsRequestBody;
-};
-export declare const parseReq: (input: ListBotIssueEventsInput) => ListBotIssueEventsRequest & {
-    path: string;
-};
-export interface ListBotIssueEventsResponse {
-    issueEvents: {
-        id: string;
-        createdAt: string;
-        data: {
-            [k: string]: {
-                raw: string;
-                pretty?: string;
-            };
-        };
-    }[];
-}