@botpress/client 0.23.1 → 0.24.0

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

@@ -1,94 +0,0 @@
-export interface FindTableRowsRequestHeaders {
-}
-export interface FindTableRowsRequestQuery {
-}
-export interface FindTableRowsRequestParams {
-    table: string;
-}
-export interface FindTableRowsRequestBody {
-    /**
-     * Limit for pagination, specifying the maximum number of rows to return.
-     */
-    limit?: number;
-    /**
-     * Offset for pagination, specifying where to start returning rows from.
-     */
-    offset?: number;
-    /**
-     * Provide a mongodb-like filter to apply to the query. Example: \{ "name": \{ "$eq": "John" \} \}
-     */
-    filter?: {
-        [k: string]: any;
-    };
-    /**
-     * Group the rows by a specific column and apply aggregations to them. Allowed values: key, avg, max, min, sum, count. Example: \{ "someId": "key", "orders": ["sum", "avg"] \}
-     */
-    group?: {
-        [k: string]: any;
-    };
-    /**
-     * Search term to apply to the row search. When using this parameter, some rows which doesn't match the search term will be returned, use the similarity field to know how much the row matches the search term.
-     */
-    search?: string;
-    /**
-     * Specifies the column by which to order the results. By default it is ordered by id. Build-in columns: id, createdAt, updatedAt
-     */
-    orderBy?: string;
-    /**
-     * Specifies the direction of sorting, either ascending or descending.
-     */
-    orderDirection?: "asc" | "desc";
-}
-export type FindTableRowsInput = FindTableRowsRequestBody & FindTableRowsRequestHeaders & FindTableRowsRequestQuery & FindTableRowsRequestParams;
-export type FindTableRowsRequest = {
-    headers: FindTableRowsRequestHeaders;
-    query: FindTableRowsRequestQuery;
-    params: FindTableRowsRequestParams;
-    body: FindTableRowsRequestBody;
-};
-export declare const parseReq: (input: FindTableRowsInput) => FindTableRowsRequest & {
-    path: string;
-};
-export interface FindTableRowsResponse {
-    rows: {
-        /**
-         * 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;
-    }[];
-    /**
-     * Flag indicating if there are more rows to fetch.
-     */
-    hasMore: boolean;
-    offset: number;
-    limit: number;
-    /**
-     * Alerts for minor issues that don't block the operation but suggest possible improvements.
-     */
-    warnings?: string[];
-}

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

@@ -1,31 +0,0 @@
-export interface GetAccountRequestHeaders {
-}
-export interface GetAccountRequestQuery {
-}
-export interface GetAccountRequestParams {
-}
-export interface GetAccountRequestBody {
-}
-export type GetAccountInput = GetAccountRequestBody & GetAccountRequestHeaders & GetAccountRequestQuery & GetAccountRequestParams;
-export type GetAccountRequest = {
-    headers: GetAccountRequestHeaders;
-    query: GetAccountRequestQuery;
-    params: GetAccountRequestParams;
-    body: GetAccountRequestBody;
-};
-export declare const parseReq: (_: GetAccountInput) => GetAccountRequest & {
-    path: string;
-};
-export interface GetAccountResponse {
-    account: {
-        id: string;
-        email: string;
-        displayName?: string;
-        emailVerified: boolean;
-        profilePicture?: string;
-        /**
-         * Creation date of the [Account](#schema_account) in ISO 8601 format
-         */
-        createdAt: string;
-    };
-}

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

@@ -1,22 +0,0 @@
-export interface GetAccountPreferenceRequestHeaders {
-}
-export interface GetAccountPreferenceRequestQuery {
-}
-export interface GetAccountPreferenceRequestParams {
-    key: string;
-}
-export interface GetAccountPreferenceRequestBody {
-}
-export type GetAccountPreferenceInput = GetAccountPreferenceRequestBody & GetAccountPreferenceRequestHeaders & GetAccountPreferenceRequestQuery & GetAccountPreferenceRequestParams;
-export type GetAccountPreferenceRequest = {
-    headers: GetAccountPreferenceRequestHeaders;
-    query: GetAccountPreferenceRequestQuery;
-    params: GetAccountPreferenceRequestParams;
-    body: GetAccountPreferenceRequestBody;
-};
-export declare const parseReq: (input: GetAccountPreferenceInput) => GetAccountPreferenceRequest & {
-    path: string;
-};
-export interface GetAccountPreferenceResponse {
-    value?: any;
-}

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

@@ -1,24 +0,0 @@
-export interface GetAllWorkspaceQuotaCompletionRequestHeaders {
-}
-export interface GetAllWorkspaceQuotaCompletionRequestQuery {
-}
-export interface GetAllWorkspaceQuotaCompletionRequestParams {
-}
-export interface GetAllWorkspaceQuotaCompletionRequestBody {
-}
-export type GetAllWorkspaceQuotaCompletionInput = GetAllWorkspaceQuotaCompletionRequestBody & GetAllWorkspaceQuotaCompletionRequestHeaders & GetAllWorkspaceQuotaCompletionRequestQuery & GetAllWorkspaceQuotaCompletionRequestParams;
-export type GetAllWorkspaceQuotaCompletionRequest = {
-    headers: GetAllWorkspaceQuotaCompletionRequestHeaders;
-    query: GetAllWorkspaceQuotaCompletionRequestQuery;
-    params: GetAllWorkspaceQuotaCompletionRequestParams;
-    body: GetAllWorkspaceQuotaCompletionRequestBody;
-};
-export declare const parseReq: (_: GetAllWorkspaceQuotaCompletionInput) => GetAllWorkspaceQuotaCompletionRequest & {
-    path: string;
-};
-export interface GetAllWorkspaceQuotaCompletionResponse {
-    [k: string]: {
-        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";
-        completion: number;
-    };
-}

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

@@ -1,38 +0,0 @@
-export interface GetAuditRecordsRequestHeaders {
-}
-export interface GetAuditRecordsRequestQuery {
-    nextToken?: string;
-}
-export interface GetAuditRecordsRequestParams {
-    id: string;
-}
-export interface GetAuditRecordsRequestBody {
-}
-export type GetAuditRecordsInput = GetAuditRecordsRequestBody & GetAuditRecordsRequestHeaders & GetAuditRecordsRequestQuery & GetAuditRecordsRequestParams;
-export type GetAuditRecordsRequest = {
-    headers: GetAuditRecordsRequestHeaders;
-    query: GetAuditRecordsRequestQuery;
-    params: GetAuditRecordsRequestParams;
-    body: GetAuditRecordsRequestBody;
-};
-export declare const parseReq: (input: GetAuditRecordsInput) => GetAuditRecordsRequest & {
-    path: string;
-};
-export interface GetAuditRecordsResponse {
-    records: {
-        id: string;
-        recordedAt: string;
-        userId: string | null;
-        userEmail?: string | null;
-        resourceId: string | null;
-        resourceName?: string | null;
-        value?: string | null;
-        action: "UNKNOWN" | "ADD_WORKSPACE_MEMBER" | "REMOVE_WORKSPACE_MEMBER" | "UPDATE_WORKSPACE_MEMBER" | "CLOSE_WORKSPACE" | "CREATE_BOT" | "CREATE_WORKSPACE" | "DELETE_BOT" | "DEPLOY_BOT" | "TRANSFER_BOT" | "DOWNLOAD_BOT_ARCHIVE" | "UPDATE_BOT" | "UPDATE_BOT_CHANNEL" | "UPDATE_BOT_CONFIG" | "UPDATE_PAYMENT_METHOD" | "UPDATE_WORKSPACE" | "SET_SPENDING_LIMIT" | "SET_AI_SPENDING_LIMIT";
-    }[];
-    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/getBot.d.ts

@@ -1,308 +0,0 @@
-export interface GetBotRequestHeaders {
-}
-export interface GetBotRequestQuery {
-}
-export interface GetBotRequestParams {
-    id: string;
-}
-export interface GetBotRequestBody {
-}
-export type GetBotInput = GetBotRequestBody & GetBotRequestHeaders & GetBotRequestQuery & GetBotRequestParams;
-export type GetBotRequest = {
-    headers: GetBotRequestHeaders;
-    query: GetBotRequestQuery;
-    params: GetBotRequestParams;
-    body: GetBotRequestBody;
-};
-export declare const parseReq: (input: GetBotInput) => GetBotRequest & {
-    path: string;
-};
-export interface GetBotResponse {
-    bot: {
-        /**
-         * Id of the [Bot](#schema_bot)
-         */
-        id: string;
-        /**
-         * Creation date of the [Bot](#schema_bot) in ISO 8601 format
-         */
-        createdAt: string;
-        /**
-         * Updating date of the [Bot](#schema_bot) in ISO 8601 format
-         */
-        updatedAt: string;
-        /**
-         * Signing secret of the [Bot](#schema_bot)
-         */
-        signingSecret: string;
-        /**
-         * A mapping of integrations to their configuration
-         */
-        integrations: {
-            [k: string]: {
-                enabled: boolean;
-                /**
-                 * Name of the [Integration](#schema_integration)
-                 */
-                name: string;
-                /**
-                 * Version of the [Integration](#schema_integration)
-                 */
-                version: string;
-                webhookUrl: string;
-                webhookId: string;
-                identifier?: string;
-                configuration: {
-                    [k: string]: any;
-                };
-                status: "registration_pending" | "registered" | "registration_failed" | "unregistration_pending" | "unregistered" | "unregistration_failed";
-                statusReason: string | null;
-                /**
-                 * ID of the [Integration](#schema_integration)
-                 */
-                id: string;
-                /**
-                 * Creation date of the [Integration](#schema_integration) in ISO 8601 format
-                 */
-                createdAt: string;
-                /**
-                 * Updating date of the [Integration](#schema_integration) in ISO 8601 format
-                 */
-                updatedAt: string;
-                /**
-                 * Title of the integration. This is the name that will be displayed in the UI
-                 */
-                title: string;
-                /**
-                 * Description of the integration. This is the description that will be displayed in the UI
-                 */
-                description: string;
-                /**
-                 * URL of the icon of the integration. This is the icon that will be displayed in the UI
-                 */
-                iconUrl: string;
-                /**
-                 * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
-                 */
-                public: boolean;
-            };
-        };
-        /**
-         * User object configuration
-         */
-        user: {
-            tags: {
-                /**
-                 * Definition of a tag that can be provided on the object
-                 */
-                [k: string]: {
-                    /**
-                     * Title of the tag
-                     */
-                    title?: string;
-                    /**
-                     * Description of the tag
-                     */
-                    description?: string;
-                };
-            };
-        };
-        /**
-         * Conversation object configuration
-         */
-        conversation: {
-            tags: {
-                /**
-                 * Definition of a tag that can be provided on the object
-                 */
-                [k: string]: {
-                    /**
-                     * Title of the tag
-                     */
-                    title?: string;
-                    /**
-                     * Description of the tag
-                     */
-                    description?: string;
-                };
-            };
-        };
-        /**
-         * Message object configuration
-         */
-        message: {
-            tags: {
-                /**
-                 * Definition of a tag that can be provided on the object
-                 */
-                [k: string]: {
-                    /**
-                     * Title of the tag
-                     */
-                    title?: string;
-                    /**
-                     * Description of the tag
-                     */
-                    description?: string;
-                };
-            };
-        };
-        /**
-         * A mapping of states to their definition
-         */
-        states: {
-            [k: string]: {
-                /**
-                 * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
-                 */
-                type: "conversation" | "user" | "bot" | "task";
-                /**
-                 * Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
-                 */
-                schema: {
-                    [k: string]: any;
-                };
-                /**
-                 * Expiry of the [State](#schema_state) in milliseconds. The state will expire if it is idle for the configured value. By default, a state doesn't expire.
-                 */
-                expiry?: number;
-            };
-        };
-        /**
-         * Configuration of the bot
-         */
-        configuration: {
-            /**
-             * Configuration data
-             */
-            data: {
-                [k: string]: any;
-            };
-            /**
-             * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
-             */
-            schema: {
-                [k: string]: any;
-            };
-        };
-        /**
-         * Events definition
-         */
-        events: {
-            /**
-             * Event Definition
-             */
-            [k: string]: {
-                /**
-                 * Title of the event
-                 */
-                title?: string;
-                /**
-                 * Description of the event
-                 */
-                description?: string;
-                schema: {
-                    [k: string]: any;
-                };
-            };
-        };
-        /**
-         * Recurring events
-         */
-        recurringEvents: {
-            [k: string]: {
-                schedule: {
-                    cron: string;
-                };
-                type: string;
-                payload: {
-                    [k: string]: any;
-                };
-                /**
-                 * The number of times the recurring event failed to run. This counter resets once the recurring event runs successfully.
-                 */
-                failedAttempts: number;
-                /**
-                 * The reason why the recurring event failed to run in the last attempt.
-                 */
-                lastFailureReason: string | null;
-            };
-        };
-        /**
-         * Subscriptions of the bot
-         */
-        subscriptions: {
-            /**
-             * Events that the bot is currently subscribed on (ex: "slack:reactionAdded"). If null, the bot is subscribed to all events.
-             */
-            events: {
-                [k: string]: {};
-            } | null;
-        };
-        /**
-         * Actions definition
-         */
-        actions: {
-            /**
-             * Action definition
-             */
-            [k: string]: {
-                /**
-                 * Title of the action
-                 */
-                title?: string;
-                /**
-                 * Description of the action
-                 */
-                description?: string;
-                input: {
-                    schema: {
-                        [k: string]: any;
-                    };
-                };
-                output: {
-                    schema: {
-                        [k: string]: any;
-                    };
-                };
-            };
-        };
-        /**
-         * Name of the [Bot](#schema_bot)
-         */
-        name: string;
-        /**
-         * Last deployment date of the [Bot](#schema_bot) in the ISO 8601 format
-         */
-        deployedAt?: string;
-        /**
-         * Indicates if the [Bot](#schema_bot) is a development bot; Development bots run locally and can install dev integrations
-         */
-        dev: boolean;
-        /**
-         * Id of the user that created the bot
-         */
-        createdBy?: string;
-        /**
-         * Indicates if the [Bot](#schema_bot) should be in always alive mode
-         */
-        alwaysAlive: boolean;
-        /**
-         * Status of the bot
-         */
-        status: "active" | "deploying";
-        /**
-         * Media files associated with the [Bot](#schema_bot)
-         */
-        medias: {
-            /**
-             * URL of the media file
-             */
-            url: string;
-            /**
-             * Name of the media file
-             */
-            name: string;
-        }[];
-    };
-}

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

@@ -1,49 +0,0 @@
-export interface GetBotAnalyticsRequestHeaders {
-}
-export interface GetBotAnalyticsRequestQuery {
-    startDate: string;
-    endDate: string;
-}
-export interface GetBotAnalyticsRequestParams {
-    id: string;
-}
-export interface GetBotAnalyticsRequestBody {
-}
-export type GetBotAnalyticsInput = GetBotAnalyticsRequestBody & GetBotAnalyticsRequestHeaders & GetBotAnalyticsRequestQuery & GetBotAnalyticsRequestParams;
-export type GetBotAnalyticsRequest = {
-    headers: GetBotAnalyticsRequestHeaders;
-    query: GetBotAnalyticsRequestQuery;
-    params: GetBotAnalyticsRequestParams;
-    body: GetBotAnalyticsRequestBody;
-};
-export declare const parseReq: (input: GetBotAnalyticsInput) => GetBotAnalyticsRequest & {
-    path: string;
-};
-export interface GetBotAnalyticsResponse {
-    records: {
-        /**
-         * ISO 8601 date string of the beginning (inclusive) of the period
-         */
-        startDateTimeUtc: string;
-        /**
-         * ISO 8601 date string of the end (exclusive) of the period
-         */
-        endDateTimeUtc: string;
-        returningUsers: number;
-        newUsers: number;
-        sessions: number;
-        /**
-         * Deprecated. Use `userMessages` instead.
-         */
-        messages: number;
-        userMessages: number;
-        botMessages: number;
-        events: number;
-        eventTypes: {
-            [k: string]: number;
-        };
-        customEvents: {
-            [k: string]: number;
-        };
-    }[];
-}

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

@@ -1,39 +0,0 @@
-export interface GetBotIssueRequestHeaders {
-}
-export interface GetBotIssueRequestQuery {
-}
-export interface GetBotIssueRequestParams {
-    id: string;
-    issueId: string;
-}
-export interface GetBotIssueRequestBody {
-}
-export type GetBotIssueInput = GetBotIssueRequestBody & GetBotIssueRequestHeaders & GetBotIssueRequestQuery & GetBotIssueRequestParams;
-export type GetBotIssueRequest = {
-    headers: GetBotIssueRequestHeaders;
-    query: GetBotIssueRequestQuery;
-    params: GetBotIssueRequestParams;
-    body: GetBotIssueRequestBody;
-};
-export declare const parseReq: (input: GetBotIssueInput) => GetBotIssueRequest & {
-    path: string;
-};
-export interface GetBotIssueResponse {
-    issue: {
-        id: string;
-        code: string;
-        createdAt: string;
-        lastSeenAt: string;
-        title: string;
-        description: string;
-        groupedData: {
-            [k: string]: {
-                raw: string;
-                pretty?: string;
-            };
-        };
-        eventsCount: number;
-        category: "user_code" | "limits" | "configuration" | "other";
-        resolutionLink: string | null;
-    };
-}

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

@@ -1,30 +0,0 @@
-export interface GetBotLogsRequestHeaders {
-}
-export interface GetBotLogsRequestQuery {
-    timeStart: string;
-    timeEnd: string;
-    nextToken?: string;
-}
-export interface GetBotLogsRequestParams {
-    id: string;
-}
-export interface GetBotLogsRequestBody {
-}
-export type GetBotLogsInput = GetBotLogsRequestBody & GetBotLogsRequestHeaders & GetBotLogsRequestQuery & GetBotLogsRequestParams;
-export type GetBotLogsRequest = {
-    headers: GetBotLogsRequestHeaders;
-    query: GetBotLogsRequestQuery;
-    params: GetBotLogsRequestParams;
-    body: GetBotLogsRequestBody;
-};
-export declare const parseReq: (input: GetBotLogsInput) => GetBotLogsRequest & {
-    path: string;
-};
-export interface GetBotLogsResponse {
-    logs: {
-        timestamp: string;
-        level: string;
-        message: string;
-    }[];
-    nextToken?: string;
-}

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

@@ -1,23 +0,0 @@
-export interface GetBotWebchatRequestHeaders {
-}
-export interface GetBotWebchatRequestQuery {
-    type: "preconfigured" | "configurable" | "fullscreen" | "sharableUrl";
-}
-export interface GetBotWebchatRequestParams {
-    id: string;
-}
-export interface GetBotWebchatRequestBody {
-}
-export type GetBotWebchatInput = GetBotWebchatRequestBody & GetBotWebchatRequestHeaders & GetBotWebchatRequestQuery & GetBotWebchatRequestParams;
-export type GetBotWebchatRequest = {
-    headers: GetBotWebchatRequestHeaders;
-    query: GetBotWebchatRequestQuery;
-    params: GetBotWebchatRequestParams;
-    body: GetBotWebchatRequestBody;
-};
-export declare const parseReq: (input: GetBotWebchatInput) => GetBotWebchatRequest & {
-    path: string;
-};
-export interface GetBotWebchatResponse {
-    code: string;
-}