@botpress/client 0.40.0 → 0.41.1

package/dist/index.d.ts

@@ -1721,7 +1721,11 @@ interface ConfigureIntegrationRequestBody {
     /**
      * Unique identifier of the integration that was installed on the bot
      */
-    identifier: string;
+    identifier?: string;
+    /**
+     * Recurring schedule on which `register()` will be called on the integration
+     */
+    scheduleRegisterCall?: "hourly" | "daily" | "weekly" | "bi-weekly" | "monthly" | "bi-monthly" | "quarterly" | "yearly";
 }
 type ConfigureIntegrationInput = ConfigureIntegrationRequestBody & ConfigureIntegrationRequestHeaders & ConfigureIntegrationRequestQuery & ConfigureIntegrationRequestParams;
 interface ConfigureIntegrationResponse {
@@ -2658,6 +2662,30 @@ interface GetOrCreateWorkflowResponse {
     };
 }
 
+interface ListTagValuesRequestHeaders {
+}
+interface ListTagValuesRequestQuery {
+    nextToken?: string;
+    type: "user" | "conversation" | "message";
+}
+interface ListTagValuesRequestParams {
+    key: string;
+}
+interface ListTagValuesRequestBody {
+}
+type ListTagValuesInput = ListTagValuesRequestBody & ListTagValuesRequestHeaders & ListTagValuesRequestQuery & ListTagValuesRequestParams;
+interface ListTagValuesResponse {
+    tags: {
+        value: 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;
+    };
+}
+
 interface TrackAnalyticsRequestHeaders {
 }
 interface TrackAnalyticsRequestQuery {
@@ -6271,6 +6299,7 @@ interface CreateIntegrationRequestBody {
      * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
      */
     public?: boolean;
+    layers?: string[];
 }
 type CreateIntegrationInput = CreateIntegrationRequestBody & CreateIntegrationRequestHeaders & CreateIntegrationRequestQuery & CreateIntegrationRequestParams;
 interface CreateIntegrationResponse {
@@ -6929,6 +6958,7 @@ interface UpdateIntegrationRequestBody {
      * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
      */
     public?: boolean;
+    layers?: string[];
 }
 type UpdateIntegrationInput = UpdateIntegrationRequestBody & UpdateIntegrationRequestHeaders & UpdateIntegrationRequestQuery & UpdateIntegrationRequestParams;
 interface UpdateIntegrationResponse {
@@ -9007,7 +9037,48 @@ interface CreatePluginRequestBody {
             };
         };
     };
-    code: 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;
+            };
+        };
+    };
+    dependencies?: {
+        interfaces?: {
+            [k: string]: {
+                id: string;
+            };
+        };
+        integrations?: {
+            [k: string]: {
+                id: string;
+            };
+        };
+    };
+    code: {
+        /**
+         * Code of plugin bundled for Node.JS
+         */
+        node: string;
+        /**
+         * Code of plugin bundled for the browser
+         */
+        browser: string;
+    };
 }
 type CreatePluginInput = CreatePluginRequestBody & CreatePluginRequestHeaders & CreatePluginRequestQuery & CreatePluginRequestParams;
 interface CreatePluginResponse {
@@ -9117,6 +9188,22 @@ interface CreatePluginResponse {
                 };
             };
         };
+        dependencies: {
+            interfaces: {
+                [k: string]: {
+                    id: string;
+                    name: string;
+                    version: string;
+                };
+            };
+            integrations: {
+                [k: string]: {
+                    id: string;
+                    name: string;
+                    version: string;
+                };
+            };
+        };
         /**
          * User object configuration
          */
@@ -9137,7 +9224,26 @@ interface CreatePluginResponse {
                 };
             };
         };
-        code: 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;
+                };
+            };
+        };
     };
 }
 
@@ -9258,6 +9364,22 @@ interface GetPluginResponse {
                 };
             };
         };
+        dependencies: {
+            interfaces: {
+                [k: string]: {
+                    id: string;
+                    name: string;
+                    version: string;
+                };
+            };
+            integrations: {
+                [k: string]: {
+                    id: string;
+                    name: string;
+                    version: string;
+                };
+            };
+        };
         /**
          * User object configuration
          */
@@ -9278,7 +9400,26 @@ interface GetPluginResponse {
                 };
             };
         };
-        code: 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;
+                };
+            };
+        };
     };
 }
 
@@ -9400,6 +9541,22 @@ interface GetPluginByNameResponse {
                 };
             };
         };
+        dependencies: {
+            interfaces: {
+                [k: string]: {
+                    id: string;
+                    name: string;
+                    version: string;
+                };
+            };
+            integrations: {
+                [k: string]: {
+                    id: string;
+                    name: string;
+                    version: string;
+                };
+            };
+        };
         /**
          * User object configuration
          */
@@ -9420,7 +9577,26 @@ interface GetPluginByNameResponse {
                 };
             };
         };
-        code: 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;
+                };
+            };
+        };
     };
 }
 
@@ -9514,9 +9690,6 @@ interface UpdatePluginRequestBody {
             };
         } | null;
     };
-    /**
-     * User object configuration
-     */
     user?: {
         tags: {
             /**
@@ -9531,10 +9704,48 @@ interface UpdatePluginRequestBody {
                  * Description of the tag
                  */
                 description?: string;
-            };
+            } | null;
         };
-    } | null;
-    code?: string;
+    };
+    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;
+            } | null;
+        };
+    };
+    dependencies?: {
+        interfaces?: {
+            [k: string]: {
+                id: string;
+            } | null;
+        };
+        integrations?: {
+            [k: string]: {
+                id: string;
+            } | null;
+        };
+    };
+    code?: {
+        /**
+         * Code of plugin bundled for Node.JS
+         */
+        node?: string;
+        /**
+         * Code of plugin bundled for the browser
+         */
+        browser?: string;
+    };
 }
 type UpdatePluginInput = UpdatePluginRequestBody & UpdatePluginRequestHeaders & UpdatePluginRequestQuery & UpdatePluginRequestParams;
 interface UpdatePluginResponse {
@@ -9644,6 +9855,22 @@ interface UpdatePluginResponse {
                 };
             };
         };
+        dependencies: {
+            interfaces: {
+                [k: string]: {
+                    id: string;
+                    name: string;
+                    version: string;
+                };
+            };
+            integrations: {
+                [k: string]: {
+                    id: string;
+                    name: string;
+                    version: string;
+                };
+            };
+        };
         /**
          * User object configuration
          */
@@ -9664,7 +9891,26 @@ interface UpdatePluginResponse {
                 };
             };
         };
-        code: 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;
+                };
+            };
+        };
     };
 }
 
@@ -9723,6 +9969,21 @@ interface ListPluginsResponse {
     };
 }
 
+interface GetPluginCodeRequestHeaders {
+}
+interface GetPluginCodeRequestQuery {
+}
+interface GetPluginCodeRequestParams {
+    id: string;
+    platform: "node" | "browser";
+}
+interface GetPluginCodeRequestBody {
+}
+type GetPluginCodeInput = GetPluginCodeRequestBody & GetPluginCodeRequestHeaders & GetPluginCodeRequestQuery & GetPluginCodeRequestParams;
+interface GetPluginCodeResponse {
+    code: string;
+}
+
 interface GetUsageRequestHeaders {
 }
 interface GetUsageRequestQuery {
@@ -9837,6 +10098,8 @@ interface ListUsageActivityRequestHeaders {
 }
 interface ListUsageActivityRequestQuery {
     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";
+    timestampFrom?: string;
+    timestampUntil?: string;
     nextToken?: string;
 }
 interface ListUsageActivityRequestParams {
@@ -9859,6 +10122,30 @@ interface ListUsageActivityResponse {
     };
 }
 
+interface ListUsageActivityDailyRequestHeaders {
+}
+interface ListUsageActivityDailyRequestQuery {
+    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";
+    dateFrom?: string;
+    dateUntil?: string;
+    nextToken?: string;
+}
+interface ListUsageActivityDailyRequestParams {
+    id: string;
+}
+interface ListUsageActivityDailyRequestBody {
+}
+type ListUsageActivityDailyInput = ListUsageActivityDailyRequestBody & ListUsageActivityDailyRequestHeaders & ListUsageActivityDailyRequestQuery & ListUsageActivityDailyRequestParams;
+interface ListUsageActivityDailyResponse {
+    data: {
+        date: string;
+        value: number;
+    }[];
+    meta: {
+        nextToken?: string;
+    };
+}
+
 interface ChangeAispendQuotaRequestHeaders {
 }
 interface ChangeAispendQuotaRequestQuery {
@@ -10459,6 +10746,96 @@ interface UpdateFileMetadataResponse {
     };
 }
 
+interface CopyFileRequestHeaders {
+    "x-destination-bot-id"?: string;
+}
+interface CopyFileRequestQuery {
+}
+interface CopyFileRequestParams {
+    idOrKey: string;
+    destinationKey: string;
+}
+interface CopyFileRequestBody {
+    i?: boolean;
+}
+type CopyFileInput = CopyFileRequestBody & CopyFileRequestHeaders & CopyFileRequestQuery & CopyFileRequestParams;
+interface CopyFileResponse {
+    file: {
+        /**
+         * File ID
+         */
+        id: string;
+        /**
+         * The ID of the bot the file belongs to
+         */
+        botId: string;
+        /**
+         * Unique key for the file. Must be unique across the bot (and the integration, when applicable).
+         */
+        key: string;
+        /**
+         * URL to retrieve the file content. This URL will be ready to use once the file is uploaded.
+         *
+         * If the file has a `public_content` policy, this will contain the permanent public URL to retrieve the file, otherwise this will contain a temporary pre-signed URL to download the file which should be used shortly after retrieving and should not be stored long-term as the URL will expire after a short timeframe.
+         */
+        url: string;
+        /**
+         * File size in bytes. Non-null if file upload status is "COMPLETE".
+         */
+        size: number | null;
+        /**
+         * MIME type of the file's content
+         */
+        contentType: string;
+        /**
+         * The tags of the file as an object of key/value pairs
+         */
+        tags: {
+            [k: string]: string;
+        };
+        /**
+         * Metadata of the file as an object of key/value pairs. The values can be of any type.
+         */
+        metadata: {
+            [k: string]: any;
+        };
+        /**
+         * File creation timestamp in ISO 8601 format
+         */
+        createdAt: string;
+        /**
+         * File last update timestamp in ISO 8601 format
+         */
+        updatedAt: string;
+        /**
+         * Access policies configured for the file.
+         */
+        accessPolicies: ("integrations" | "public_content")[];
+        /**
+         * Whether the file was requested to be indexed for search or not.
+         */
+        index: boolean;
+        /**
+         * Status of the file. If the status is `upload_pending`, the file content has not been uploaded yet. The status will be set to `upload_completed` once the file content has been uploaded successfully.
+         *
+         * If the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to `upload_failed` and the reason for the failure will be available in the `failedStatusReason` field of the file.
+         *
+         * However, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the `indexing_pending` status (the `upload_completed` status step will be skipped).
+         *
+         * Once the indexing is completed and the file is ready to be used for searching its status will be set to `indexing_completed`. If the indexing failed the status will be set to `indexing_failed` and the reason for the failure will be available in the `failedStatusReason` field.
+         */
+        status: "upload_pending" | "upload_failed" | "upload_completed" | "indexing_pending" | "indexing_failed" | "indexing_completed";
+        /**
+         * If the file status is `upload_failed` or `indexing_failed` this will contain the reason of the failure.
+         */
+        failedStatusReason?: string;
+        /**
+         * File expiry timestamp in ISO 8601 format
+         */
+        expiresAt?: string;
+    };
+}
+
 interface SearchFilesRequestHeaders {
 }
 interface SearchFilesRequestQuery {
@@ -10596,6 +10973,47 @@ interface ListFilePassagesResponse {
     };
 }
 
+interface ListFileTagsRequestHeaders {
+}
+interface ListFileTagsRequestQuery {
+    nextToken?: string;
+}
+interface ListFileTagsRequestParams {
+}
+interface ListFileTagsRequestBody {
+}
+type ListFileTagsInput = ListFileTagsRequestBody & ListFileTagsRequestHeaders & ListFileTagsRequestQuery & ListFileTagsRequestParams;
+interface ListFileTagsResponse {
+    tags: 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;
+    };
+}
+
+interface ListFileTagValuesRequestHeaders {
+}
+interface ListFileTagValuesRequestQuery {
+    nextToken?: string;
+}
+interface ListFileTagValuesRequestParams {
+    tag: string;
+}
+interface ListFileTagValuesRequestBody {
+}
+type ListFileTagValuesInput = ListFileTagValuesRequestBody & ListFileTagValuesRequestHeaders & ListFileTagValuesRequestQuery & ListFileTagValuesRequestParams;
+interface ListFileTagValuesResponse {
+    values: 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;
+    };
+}
+
 interface ListTablesRequestHeaders {
 }
 interface ListTablesRequestQuery {
@@ -13094,6 +13512,22 @@ interface Plugin {
             };
         };
     };
+    dependencies: {
+        interfaces: {
+            [k: string]: {
+                id: string;
+                name: string;
+                version: string;
+            };
+        };
+        integrations: {
+            [k: string]: {
+                id: string;
+                name: string;
+                version: string;
+            };
+        };
+    };
     /**
      * User object configuration
      */
@@ -13114,7 +13548,26 @@ interface Plugin {
             };
         };
     };
-    code: 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;
+            };
+        };
+    };
 }
 interface Workspace {
     id: string;
@@ -13803,6 +14256,7 @@ declare class Client$1 {
     readonly deleteWorkflow: (input: DeleteWorkflowInput) => Promise<DeleteWorkflowResponse>;
     readonly listWorkflows: (input: ListWorkflowsInput) => Promise<ListWorkflowsResponse>;
     readonly getOrCreateWorkflow: (input: GetOrCreateWorkflowInput) => Promise<GetOrCreateWorkflowResponse>;
+    readonly listTagValues: (input: ListTagValuesInput) => Promise<ListTagValuesResponse>;
     readonly trackAnalytics: (input: TrackAnalyticsInput) => Promise<TrackAnalyticsResponse>;
     readonly runVrl: (input: RunVrlInput) => Promise<RunVrlResponse>;
     readonly getAccount: (input: GetAccountInput) => Promise<GetAccountResponse>;
@@ -13877,10 +14331,12 @@ declare class Client$1 {
     readonly updatePlugin: (input: UpdatePluginInput) => Promise<UpdatePluginResponse>;
     readonly deletePlugin: (input: DeletePluginInput) => Promise<DeletePluginResponse>;
     readonly listPlugins: (input: ListPluginsInput) => Promise<ListPluginsResponse>;
+    readonly getPluginCode: (input: GetPluginCodeInput) => Promise<GetPluginCodeResponse>;
     readonly getUsage: (input: GetUsageInput) => Promise<GetUsageResponse>;
     readonly getMultipleUsages: (input: GetMultipleUsagesInput) => Promise<GetMultipleUsagesResponse>;
     readonly listUsageHistory: (input: ListUsageHistoryInput) => Promise<ListUsageHistoryResponse>;
     readonly listUsageActivity: (input: ListUsageActivityInput) => Promise<ListUsageActivityResponse>;
+    readonly listUsageActivityDaily: (input: ListUsageActivityDailyInput) => Promise<ListUsageActivityDailyResponse>;
     readonly changeAISpendQuota: (input: ChangeAispendQuotaInput) => Promise<ChangeAispendQuotaResponse>;
     readonly listActivities: (input: ListActivitiesInput) => Promise<ListActivitiesResponse>;
     readonly introspect: (input: IntrospectInput) => Promise<IntrospectResponse>;
@@ -13889,8 +14345,11 @@ declare class Client$1 {
     readonly listFiles: (input: ListFilesInput) => Promise<ListFilesResponse>;
     readonly getFile: (input: GetFileInput) => Promise<GetFileResponse>;
     readonly updateFileMetadata: (input: UpdateFileMetadataInput) => Promise<UpdateFileMetadataResponse>;
+    readonly copyFile: (input: CopyFileInput) => Promise<CopyFileResponse>;
     readonly searchFiles: (input: SearchFilesInput) => Promise<SearchFilesResponse>;
     readonly listFilePassages: (input: ListFilePassagesInput) => Promise<ListFilePassagesResponse>;
+    readonly listFileTags: (input: ListFileTagsInput) => Promise<ListFileTagsResponse>;
+    readonly listFileTagValues: (input: ListFileTagValuesInput) => Promise<ListFileTagValuesResponse>;
     readonly listTables: (input: ListTablesInput) => Promise<ListTablesResponse>;
     readonly getTable: (input: GetTableInput) => Promise<GetTableResponse>;
     readonly getOrCreateTable: (input: GetOrCreateTableInput) => Promise<GetOrCreateTableResponse>;