@botpress/client 0.23.1 → 0.24.0

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

@@ -1,42 +0,0 @@
-export interface ListPublicWorkspacesRequestHeaders {
-}
-export interface ListPublicWorkspacesRequestQuery {
-    nextToken?: string;
-    workspaceIds?: string[];
-    search?: string;
-}
-export interface ListPublicWorkspacesRequestParams {
-}
-export interface ListPublicWorkspacesRequestBody {
-}
-export type ListPublicWorkspacesInput = ListPublicWorkspacesRequestBody & ListPublicWorkspacesRequestHeaders & ListPublicWorkspacesRequestQuery & ListPublicWorkspacesRequestParams;
-export type ListPublicWorkspacesRequest = {
-    headers: ListPublicWorkspacesRequestHeaders;
-    query: ListPublicWorkspacesRequestQuery;
-    params: ListPublicWorkspacesRequestParams;
-    body: ListPublicWorkspacesRequestBody;
-};
-export declare const parseReq: (input: ListPublicWorkspacesInput) => ListPublicWorkspacesRequest & {
-    path: string;
-};
-export interface ListPublicWorkspacesResponse {
-    workspaces: GetPublicWorkspaceResponse[];
-    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;
-    };
-}
-export interface GetPublicWorkspaceResponse {
-    id: string;
-    name: string;
-    createdAt: string;
-    updatedAt: string;
-    about?: string;
-    profilePicture?: string;
-    contactEmail?: string;
-    website?: string;
-    socialAccounts?: string[];
-    handle?: string;
-}

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

@@ -1,126 +0,0 @@
-export interface ListTablesRequestHeaders {
-}
-export interface ListTablesRequestQuery {
-    tags?: {
-        [k: string]: string;
-    };
-}
-export interface ListTablesRequestParams {
-}
-export interface ListTablesRequestBody {
-}
-export type ListTablesInput = ListTablesRequestBody & ListTablesRequestHeaders & ListTablesRequestQuery & ListTablesRequestParams;
-export type ListTablesRequest = {
-    headers: ListTablesRequestHeaders;
-    query: ListTablesRequestQuery;
-    params: ListTablesRequestParams;
-    body: ListTablesRequestBody;
-};
-export declare const parseReq: (input: ListTablesInput) => ListTablesRequest & {
-    path: string;
-};
-export interface ListTablesResponse {
-    tables: {
-        /**
-         * 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;
-    }[];
-}

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

@@ -1,97 +0,0 @@
-export interface ListTasksRequestHeaders {
-}
-export interface ListTasksRequestQuery {
-    nextToken?: string;
-    tags?: {
-        [k: string]: string;
-    };
-    conversationId?: string;
-    userId?: string;
-    parentTaskId?: string;
-    status?: ("pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled")[];
-    type?: string;
-}
-export interface ListTasksRequestParams {
-}
-export interface ListTasksRequestBody {
-}
-export type ListTasksInput = ListTasksRequestBody & ListTasksRequestHeaders & ListTasksRequestQuery & ListTasksRequestParams;
-export type ListTasksRequest = {
-    headers: ListTasksRequestHeaders;
-    query: ListTasksRequestQuery;
-    params: ListTasksRequestParams;
-    body: ListTasksRequestBody;
-};
-export declare const parseReq: (input: ListTasksInput) => ListTasksRequest & {
-    path: string;
-};
-export interface ListTasksResponse {
-    tasks: {
-        /**
-         * 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;
-        };
-    }[];
-    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/listUsageHistory.d.ts

@@ -1,44 +0,0 @@
-export interface ListUsageHistoryRequestHeaders {
-}
-export interface ListUsageHistoryRequestQuery {
-    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";
-}
-export interface ListUsageHistoryRequestParams {
-    id: string;
-}
-export interface ListUsageHistoryRequestBody {
-}
-export type ListUsageHistoryInput = ListUsageHistoryRequestBody & ListUsageHistoryRequestHeaders & ListUsageHistoryRequestQuery & ListUsageHistoryRequestParams;
-export type ListUsageHistoryRequest = {
-    headers: ListUsageHistoryRequestHeaders;
-    query: ListUsageHistoryRequestQuery;
-    params: ListUsageHistoryRequestParams;
-    body: ListUsageHistoryRequestBody;
-};
-export declare const parseReq: (input: ListUsageHistoryInput) => ListUsageHistoryRequest & {
-    path: string;
-};
-export interface ListUsageHistoryResponse {
-    usages: {
-        /**
-         * 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/listUsers.d.ts

@@ -1,59 +0,0 @@
-export interface ListUsersRequestHeaders {
-}
-export interface ListUsersRequestQuery {
-    nextToken?: string;
-    conversationId?: string;
-    tags?: {
-        [k: string]: string;
-    };
-}
-export interface ListUsersRequestParams {
-}
-export interface ListUsersRequestBody {
-}
-export type ListUsersInput = ListUsersRequestBody & ListUsersRequestHeaders & ListUsersRequestQuery & ListUsersRequestParams;
-export type ListUsersRequest = {
-    headers: ListUsersRequestHeaders;
-    query: ListUsersRequestQuery;
-    params: ListUsersRequestParams;
-    body: ListUsersRequestBody;
-};
-export declare const parseReq: (input: ListUsersInput) => ListUsersRequest & {
-    path: string;
-};
-export interface ListUsersResponse {
-    users: {
-        /**
-         * 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;
-    }[];
-    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/listWorkspaceInvoices.d.ts

@@ -1,57 +0,0 @@
-export interface ListWorkspaceInvoicesRequestHeaders {
-}
-export interface ListWorkspaceInvoicesRequestQuery {
-}
-export interface ListWorkspaceInvoicesRequestParams {
-    id: string;
-}
-export interface ListWorkspaceInvoicesRequestBody {
-}
-export type ListWorkspaceInvoicesInput = ListWorkspaceInvoicesRequestBody & ListWorkspaceInvoicesRequestHeaders & ListWorkspaceInvoicesRequestQuery & ListWorkspaceInvoicesRequestParams;
-export type ListWorkspaceInvoicesRequest = {
-    headers: ListWorkspaceInvoicesRequestHeaders;
-    query: ListWorkspaceInvoicesRequestQuery;
-    params: ListWorkspaceInvoicesRequestParams;
-    body: ListWorkspaceInvoicesRequestBody;
-};
-export declare const parseReq: (input: ListWorkspaceInvoicesInput) => ListWorkspaceInvoicesRequest & {
-    path: string;
-};
-export interface ListWorkspaceInvoicesResponse {
-    invoices: {
-        id: string;
-        period: {
-            month: number;
-            year: number;
-        };
-        /**
-         * Date on which the invoice was generated.
-         */
-        date: string;
-        /**
-         * Total amount to pay of the invoice.
-         */
-        amount: number;
-        /**
-         * Currency of the invoice amount.
-         */
-        currency: string;
-        paymentStatus: ("deleted" | "draft" | "open" | "paid" | "uncollectible" | "void") | null;
-        /**
-         * Date on which the invoice is due.
-         */
-        dueDate?: string;
-        /**
-         * Number of times payment has been unsuccessfully attempted on the invoice.
-         */
-        paymentAttemptCount: number | null;
-        /**
-         * Date on which the next payment attempt will be made.
-         */
-        nextPaymentAttemptDate: string | null;
-        /**
-         * URL to download the PDF file of the invoice.
-         */
-        pdfUrl: string;
-    }[];
-}

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

@@ -1,36 +0,0 @@
-export interface ListWorkspaceMembersRequestHeaders {
-}
-export interface ListWorkspaceMembersRequestQuery {
-    nextToken?: string;
-}
-export interface ListWorkspaceMembersRequestParams {
-}
-export interface ListWorkspaceMembersRequestBody {
-}
-export type ListWorkspaceMembersInput = ListWorkspaceMembersRequestBody & ListWorkspaceMembersRequestHeaders & ListWorkspaceMembersRequestQuery & ListWorkspaceMembersRequestParams;
-export type ListWorkspaceMembersRequest = {
-    headers: ListWorkspaceMembersRequestHeaders;
-    query: ListWorkspaceMembersRequestQuery;
-    params: ListWorkspaceMembersRequestParams;
-    body: ListWorkspaceMembersRequestBody;
-};
-export declare const parseReq: (input: ListWorkspaceMembersInput) => ListWorkspaceMembersRequest & {
-    path: string;
-};
-export interface ListWorkspaceMembersResponse {
-    members: {
-        id: string;
-        userId?: string;
-        email: string;
-        createdAt: string;
-        role: "viewer" | "billing" | "developer" | "manager" | "administrator" | "owner";
-        profilePicture?: string;
-        displayName?: 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/listWorkspaceQuotas.d.ts

@@ -1,36 +0,0 @@
-export interface ListWorkspaceQuotasRequestHeaders {
-}
-export interface ListWorkspaceQuotasRequestQuery {
-    period?: string;
-}
-export interface ListWorkspaceQuotasRequestParams {
-    id: string;
-}
-export interface ListWorkspaceQuotasRequestBody {
-}
-export type ListWorkspaceQuotasInput = ListWorkspaceQuotasRequestBody & ListWorkspaceQuotasRequestHeaders & ListWorkspaceQuotasRequestQuery & ListWorkspaceQuotasRequestParams;
-export type ListWorkspaceQuotasRequest = {
-    headers: ListWorkspaceQuotasRequestHeaders;
-    query: ListWorkspaceQuotasRequestQuery;
-    params: ListWorkspaceQuotasRequestParams;
-    body: ListWorkspaceQuotasRequestBody;
-};
-export declare const parseReq: (input: ListWorkspaceQuotasInput) => ListWorkspaceQuotasRequest & {
-    path: string;
-};
-export interface ListWorkspaceQuotasResponse {
-    quotas: {
-        /**
-         * 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/listWorkspaceUsages.d.ts

@@ -1,45 +0,0 @@
-export interface ListWorkspaceUsagesRequestHeaders {
-}
-export interface ListWorkspaceUsagesRequestQuery {
-    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 ListWorkspaceUsagesRequestParams {
-    id: string;
-}
-export interface ListWorkspaceUsagesRequestBody {
-}
-export type ListWorkspaceUsagesInput = ListWorkspaceUsagesRequestBody & ListWorkspaceUsagesRequestHeaders & ListWorkspaceUsagesRequestQuery & ListWorkspaceUsagesRequestParams;
-export type ListWorkspaceUsagesRequest = {
-    headers: ListWorkspaceUsagesRequestHeaders;
-    query: ListWorkspaceUsagesRequestQuery;
-    params: ListWorkspaceUsagesRequestParams;
-    body: ListWorkspaceUsagesRequestBody;
-};
-export declare const parseReq: (input: ListWorkspaceUsagesInput) => ListWorkspaceUsagesRequest & {
-    path: string;
-};
-export interface ListWorkspaceUsagesResponse {
-    usages: {
-        /**
-         * 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/listWorkspaces.d.ts

@@ -1,47 +0,0 @@
-export interface ListWorkspacesRequestHeaders {
-}
-export interface ListWorkspacesRequestQuery {
-    nextToken?: string;
-}
-export interface ListWorkspacesRequestParams {
-}
-export interface ListWorkspacesRequestBody {
-}
-export type ListWorkspacesInput = ListWorkspacesRequestBody & ListWorkspacesRequestHeaders & ListWorkspacesRequestQuery & ListWorkspacesRequestParams;
-export type ListWorkspacesRequest = {
-    headers: ListWorkspacesRequestHeaders;
-    query: ListWorkspacesRequestQuery;
-    params: ListWorkspacesRequestParams;
-    body: ListWorkspacesRequestBody;
-};
-export declare const parseReq: (input: ListWorkspacesInput) => ListWorkspacesRequest & {
-    path: string;
-};
-export interface ListWorkspacesResponse {
-    workspaces: UpdateWorkspaceResponse[];
-    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;
-    };
-}
-export interface UpdateWorkspaceResponse {
-    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/patchState.d.ts

@@ -1,72 +0,0 @@
-export interface PatchStateRequestHeaders {
-}
-export interface PatchStateRequestQuery {
-}
-export interface PatchStateRequestParams {
-    type: "conversation" | "user" | "bot" | "integration" | "task";
-    id: string;
-    name: string;
-}
-export interface PatchStateRequestBody {
-    /**
-     * Payload is the content of the state defined by your bot.
-     */
-    payload: {
-        [k: string]: any;
-    };
-}
-export type PatchStateInput = PatchStateRequestBody & PatchStateRequestHeaders & PatchStateRequestQuery & PatchStateRequestParams;
-export type PatchStateRequest = {
-    headers: PatchStateRequestHeaders;
-    query: PatchStateRequestQuery;
-    params: PatchStateRequestParams;
-    body: PatchStateRequestBody;
-};
-export declare const parseReq: (input: PatchStateInput) => PatchStateRequest & {
-    path: string;
-};
-export interface PatchStateResponse {
-    /**
-     * 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;
-        };
-    };
-}