@botpress/client 0.44.0 → 0.45.0

package/dist/index.d.ts

@@ -9714,12 +9714,25 @@ interface CreatePluginRequestBody {
          */
         browser: string;
     };
+    /**
+     * Base64 encoded svg of the plugin icon. This icon is global to the plugin each versions will be updated when this changes.
+     */
+    icon?: string;
+    /**
+     * Base64 encoded markdown of the plugin readme. The readme is specific to each plugin versions.
+     */
+    readme?: string;
+    /**
+     * Title of the plugin. This is the name that will be displayed in the UI
+     */
+    title?: string;
+    /**
+     * Description of the plugin. This is the description that will be displayed in the UI
+     */
+    description?: string;
 }
 type CreatePluginInput = CreatePluginRequestBody & CreatePluginRequestHeaders & CreatePluginRequestQuery & CreatePluginRequestParams;
 interface CreatePluginResponse {
-    /**
-     * Plugin definition
-     */
     plugin: {
         /**
          * ID of the [Plugin](#schema_plugin)
@@ -9879,6 +9892,22 @@ interface CreatePluginResponse {
                 };
             };
         };
+        /**
+         * Title of the plugin. This is the name that will be displayed in the UI
+         */
+        title: string;
+        /**
+         * Description of the plugin. This is the description that will be displayed in the UI
+         */
+        description: string;
+        /**
+         * URL of the icon of the plugin. This is the icon that will be displayed in the UI
+         */
+        iconUrl: string;
+        /**
+         * URL of the readme of the plugin. This is the readme that will be displayed in the UI
+         */
+        readmeUrl: string;
     };
 }
 
@@ -9893,9 +9922,6 @@ interface GetPluginRequestBody {
 }
 type GetPluginInput = GetPluginRequestBody & GetPluginRequestHeaders & GetPluginRequestQuery & GetPluginRequestParams;
 interface GetPluginResponse {
-    /**
-     * Plugin definition
-     */
     plugin: {
         /**
          * ID of the [Plugin](#schema_plugin)
@@ -10055,6 +10081,22 @@ interface GetPluginResponse {
                 };
             };
         };
+        /**
+         * Title of the plugin. This is the name that will be displayed in the UI
+         */
+        title: string;
+        /**
+         * Description of the plugin. This is the description that will be displayed in the UI
+         */
+        description: string;
+        /**
+         * URL of the icon of the plugin. This is the icon that will be displayed in the UI
+         */
+        iconUrl: string;
+        /**
+         * URL of the readme of the plugin. This is the readme that will be displayed in the UI
+         */
+        readmeUrl: string;
     };
 }
 
@@ -10070,9 +10112,6 @@ interface GetPluginByNameRequestBody {
 }
 type GetPluginByNameInput = GetPluginByNameRequestBody & GetPluginByNameRequestHeaders & GetPluginByNameRequestQuery & GetPluginByNameRequestParams;
 interface GetPluginByNameResponse {
-    /**
-     * Plugin definition
-     */
     plugin: {
         /**
          * ID of the [Plugin](#schema_plugin)
@@ -10232,6 +10271,22 @@ interface GetPluginByNameResponse {
                 };
             };
         };
+        /**
+         * Title of the plugin. This is the name that will be displayed in the UI
+         */
+        title: string;
+        /**
+         * Description of the plugin. This is the description that will be displayed in the UI
+         */
+        description: string;
+        /**
+         * URL of the icon of the plugin. This is the icon that will be displayed in the UI
+         */
+        iconUrl: string;
+        /**
+         * URL of the readme of the plugin. This is the readme that will be displayed in the UI
+         */
+        readmeUrl: string;
     };
 }
 
@@ -10381,12 +10436,25 @@ interface UpdatePluginRequestBody {
          */
         browser?: string;
     };
+    /**
+     * Base64 encoded svg of the plugin icon. This icon is global to the plugin each versions will be updated when this changes.
+     */
+    icon?: string;
+    /**
+     * Base64 encoded markdown of the plugin readme. The readme is specific to each plugin versions.
+     */
+    readme?: string;
+    /**
+     * Title of the plugin. This is the name that will be displayed in the UI
+     */
+    title?: string;
+    /**
+     * Description of the plugin. This is the description that will be displayed in the UI
+     */
+    description?: string;
 }
 type UpdatePluginInput = UpdatePluginRequestBody & UpdatePluginRequestHeaders & UpdatePluginRequestQuery & UpdatePluginRequestParams;
 interface UpdatePluginResponse {
-    /**
-     * Plugin definition
-     */
     plugin: {
         /**
          * ID of the [Plugin](#schema_plugin)
@@ -10546,6 +10614,22 @@ interface UpdatePluginResponse {
                 };
             };
         };
+        /**
+         * Title of the plugin. This is the name that will be displayed in the UI
+         */
+        title: string;
+        /**
+         * Description of the plugin. This is the description that will be displayed in the UI
+         */
+        description: string;
+        /**
+         * URL of the icon of the plugin. This is the icon that will be displayed in the UI
+         */
+        iconUrl: string;
+        /**
+         * URL of the readme of the plugin. This is the readme that will be displayed in the UI
+         */
+        readmeUrl: string;
     };
 }
 
@@ -10939,7 +11023,7 @@ interface UpsertFileRequestBody {
                  * Notes:
                  * - This feature is only available in Team and Enterprise plans.
                  * - Enabling this feature will incur in AI Spend cost to use a vision-enabled LLM to index the PDF pages.
-                 * - This is limited to a maximum of 30 pages of the PDF. If the file has more pages then the rest of the pages will NOT be transcribed using this vision feature, and will be processed using the default text-based indexing instead. If you need to transcribe the entire file using vision, please split it into smaller files.
+                 * - This is limited to a maximum of 100 pages of the PDF. If the file has more pages then the rest of the pages will NOT be transcribed using this vision feature, and will be processed using the default text-based indexing instead. If you need to transcribe the entire file using vision, please split it into smaller files.
                  * - Pages that are vision-transcribed will not be processed by the default text-based indexing to avoid duplicate content in the index.
                  * - This feature is only available for PDF files. If the file isn't a PDF, this setting will be ignored and no AI Spend will be incurred.
                  */
@@ -10960,7 +11044,7 @@ interface UpsertFileRequestBody {
                  * - This feature is only available in Team and Enterprise plans.
                  * - Enabling this will incur in extra AI Spend cost and additional File Storage usage, in order to use a vision-enabled LLM to visually index the PDF pages and store them as standalone page images in the bot's file storage.
                  * - Enabling this may increase the overall AI Spend cost of your bot as your bot may pass one or more indexed page images to a vision-enabled LLM for answering user queries.
-                 * - This is limited to the first 30 pages of the PDF. If the file has more pages then the rest of the pages will NOT be vision-indexed. If you need to visually index the entire file, please split it into smaller files.
+                 * - This is limited to the first 100 pages of the PDF. If the file has more pages then the rest of the pages will NOT be vision-indexed. If you need to visually index the entire file, please split it into smaller files.
                  * - This feature is only available for PDF files. If the file isn't a PDF, this setting will be ignored and no AI Spend will be incurred.
                  */
                 indexPages?: {
@@ -11394,7 +11478,9 @@ interface CopyFileRequestParams {
 }
 interface CopyFileRequestBody {
     /**
-     * Set to `true` to overwrite the file if it already exists, otherwise an error will be returned. If overwriting, the existing file must be owned by the same user making the file copy request, otherwise an error will be returned.
+     * Set to `true` to overwrite the file if it already exists, otherwise an error will be returned.
+     *
+     * When this endpoint is called using bot authentication, the existing file must have been originally created by the same bot making the file copy request in order to overwrite it.
      */
     overwrite?: boolean;
 }
@@ -14046,9 +14132,6 @@ interface Interface {
         language: string;
     };
 }
-/**
- * Plugin definition
- */
 interface Plugin {
     /**
      * ID of the [Plugin](#schema_plugin)
@@ -14208,6 +14291,22 @@ interface Plugin {
             };
         };
     };
+    /**
+     * Title of the plugin. This is the name that will be displayed in the UI
+     */
+    title: string;
+    /**
+     * Description of the plugin. This is the description that will be displayed in the UI
+     */
+    description: string;
+    /**
+     * URL of the icon of the plugin. This is the icon that will be displayed in the UI
+     */
+    iconUrl: string;
+    /**
+     * URL of the readme of the plugin. This is the readme that will be displayed in the UI
+     */
+    readmeUrl: string;
 }
 interface Workspace {
     id: string;