@botpress/client 0.20.1 → 0.21.0

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

@@ -199,6 +199,26 @@ export interface UpdateIntegrationRequestBody {
             };
         } | null;
     };
+    interfaces?: {
+        [k: string]: {
+            id: string;
+            entities: {
+                [k: string]: {
+                    name: string;
+                };
+            };
+            actions: {
+                [k: string]: {
+                    name: string;
+                };
+            };
+            events: {
+                [k: string]: {
+                    name: string;
+                };
+            };
+        } | null;
+    };
     /**
      * Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing.
      */
@@ -283,6 +303,26 @@ export interface UpdateIntegrationResponse {
          * Version of the [Integration](#schema_integration)
          */
         version: string;
+        interfaces: {
+            [k: string]: {
+                id: string;
+                entities: {
+                    [k: string]: {
+                        name: string;
+                    };
+                };
+                actions: {
+                    [k: string]: {
+                        name: string;
+                    };
+                };
+                events: {
+                    [k: string]: {
+                        name: string;
+                    };
+                };
+            };
+        };
         /**
          * Configuration definition
          */

package/dist/gen/operations/{createFile.d.ts → upsertFile.d.ts}

@@ -1,26 +1,26 @@
-export interface CreateFileRequestHeaders {
+export interface UpsertFileRequestHeaders {
 }
-export interface CreateFileRequestQuery {
+export interface UpsertFileRequestQuery {
 }
-export interface CreateFileRequestParams {
+export interface UpsertFileRequestParams {
 }
-export interface CreateFileRequestBody {
+export interface UpsertFileRequestBody {
     /**
-     * File name
+     * Unique key for the file. Must be unique across the bot (and the integration, when applicable).
      */
-    name?: string;
+    key: string;
     /**
-     * File tags as an object of key/value pairs
+     * File tags as an object of key-value pairs. Tag values should be of `string` (text) type.
      */
     tags?: {
         [k: string]: string;
     };
     /**
-     * File size in bytes. This will count against your file storage quota. If the `index` parameter is set to `true`, this will also count against your vector database storage quota.
+     * File size in bytes. This will count against your File Storage quota. If the `index` parameter is set to `true`, this will also count against your Vector DB Storage quota.
      */
     size: number;
     /**
-     * Set to a value of 'true' to index the file in vector storage. Only PDFs, Office documents, and text-based files are currently supported. Note that if a file is indexed, it will count towards the Vector Storage quota of the workspace rather than the File Storage quota.
+     * Set to a value of 'true' to index the file in vector storage. Only PDFs, Office documents, and text-based files are currently supported. Note that if a file is indexed, it will count towards both the Vector DB Storage quota and the File Storage quota of the workspace.
      */
     index?: boolean;
     /**
@@ -28,21 +28,21 @@ export interface CreateFileRequestBody {
      */
     accessPolicies?: ("public_content" | "integrations")[];
     /**
-     * File content type. If omitted, the content type will be inferred from the file extension. If a type cannot be inferred, the default is "application/octet-stream".
+     * File content type. If omitted, the content type will be inferred from the file extension (if any) specified in `key`. If a content type cannot be inferred, the default is "application/octet-stream".
      */
     contentType?: string;
 }
-export type CreateFileInput = CreateFileRequestBody & CreateFileRequestHeaders & CreateFileRequestQuery & CreateFileRequestParams;
-export type CreateFileRequest = {
-    headers: CreateFileRequestHeaders;
-    query: CreateFileRequestQuery;
-    params: CreateFileRequestParams;
-    body: CreateFileRequestBody;
+export type UpsertFileInput = UpsertFileRequestBody & UpsertFileRequestHeaders & UpsertFileRequestQuery & UpsertFileRequestParams;
+export type UpsertFileRequest = {
+    headers: UpsertFileRequestHeaders;
+    query: UpsertFileRequestQuery;
+    params: UpsertFileRequestParams;
+    body: UpsertFileRequestBody;
 };
-export declare const parseReq: (input: CreateFileInput) => CreateFileRequest & {
+export declare const parseReq: (input: UpsertFileInput) => UpsertFileRequest & {
     path: string;
 };
-export interface CreateFileResponse {
+export interface UpsertFileResponse {
     file: {
         /**
          * File ID
@@ -53,9 +53,9 @@ export interface CreateFileResponse {
          */
         botId: string;
         /**
-         * File name
+         * Unique key for the file. Must be unique across the bot (and the integration, when applicable).
          */
-        name: string | null;
+        key: string;
         /**
          * File size in bytes. Non-null if file upload status is "COMPLETE".
          */
@@ -87,17 +87,17 @@ export interface CreateFileResponse {
          */
         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.
+         * 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.
+         * 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).
+         * 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.
+         * 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.
+         * If the file status is `upload_failed` or `indexing_failed` this will contain the reason of the failure.
          */
         failedStatusReason?: string;
         /**