@botpress/client 1.3.0 → 1.4.0

package/dist/index.d.ts

@@ -3210,7 +3210,7 @@ interface ListPublicIntegrationsResponse$1 {
          */
         iconUrl: string;
         /**
-         * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
+         * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
          */
         public: boolean;
         /**
@@ -3621,7 +3621,7 @@ interface GetPublicIntegrationByIdResponse$1 {
          */
         readmeUrl: string;
         /**
-         * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
+         * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
          */
         public: boolean;
         /**
@@ -4006,7 +4006,7 @@ interface GetPublicIntegrationResponse$1 {
          */
         readmeUrl: string;
         /**
-         * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
+         * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
          */
         public: boolean;
         /**
@@ -4292,7 +4292,7 @@ interface CreateBotResponse$1 {
                  */
                 iconUrl: string;
                 /**
-                 * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
+                 * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
                  */
                 public: boolean;
                 /**
@@ -4727,6 +4727,7 @@ interface UpdateBotRequestBody$1 {
         url: string;
         name: string;
     }[];
+    layers?: string[];
 }
 type UpdateBotInput$1 = UpdateBotRequestBody$1 & UpdateBotRequestHeaders$1 & UpdateBotRequestQuery$1 & UpdateBotRequestParams$1;
 interface UpdateBotResponse$1 {
@@ -4795,7 +4796,7 @@ interface UpdateBotResponse$1 {
                  */
                 iconUrl: string;
                 /**
-                 * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
+                 * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
                  */
                 public: boolean;
                 /**
@@ -5172,7 +5173,7 @@ interface GetBotResponse$1 {
                  */
                 iconUrl: string;
                 /**
-                 * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
+                 * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
                  */
                 public: boolean;
                 /**
@@ -5426,7 +5427,7 @@ interface GetBotLogsRequestHeaders$1 {
 }
 interface GetBotLogsRequestQuery$1 {
     timeStart: string;
-    timeEnd: string;
+    timeEnd?: string;
     level?: string;
     userId?: string;
     workflowId?: string;
@@ -6745,7 +6746,7 @@ interface CreateIntegrationRequestBody$1 {
      */
     description?: string;
     /**
-     * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
+     * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
      */
     public?: boolean;
     layers?: string[];
@@ -7102,7 +7103,7 @@ interface CreateIntegrationResponse$1 {
          */
         readmeUrl: string;
         /**
-         * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
+         * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
          */
         public: boolean;
         /**
@@ -7425,7 +7426,7 @@ interface ValidateIntegrationCreationRequestBody$1 {
      */
     description?: string;
     /**
-     * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
+     * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
      */
     public?: boolean;
     layers?: string[];
@@ -7736,7 +7737,7 @@ interface UpdateIntegrationRequestBody$1 {
      */
     url?: string | null;
     /**
-     * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
+     * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
      */
     public?: boolean;
     layers?: string[];
@@ -8093,7 +8094,7 @@ interface UpdateIntegrationResponse$1 {
          */
         readmeUrl: string;
         /**
-         * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
+         * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
          */
         public: boolean;
         /**
@@ -8409,7 +8410,7 @@ interface ValidateIntegrationUpdateRequestBody$1 {
      */
     url?: string | null;
     /**
-     * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
+     * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
      */
     public?: boolean;
     layers?: string[];
@@ -8475,7 +8476,7 @@ interface ListIntegrationsResponse$1 {
          */
         iconUrl: string;
         /**
-         * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
+         * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
          */
         public: boolean;
         /**
@@ -8882,7 +8883,7 @@ interface GetIntegrationResponse$1 {
          */
         readmeUrl: string;
         /**
-         * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
+         * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
          */
         public: boolean;
         /**
@@ -8900,7 +8901,7 @@ interface GetIntegrationLogsRequestHeaders$1 {
 }
 interface GetIntegrationLogsRequestQuery$1 {
     timeStart: string;
-    timeEnd: string;
+    timeEnd?: string;
     level?: string;
     userId?: string;
     conversationId?: string;
@@ -9286,7 +9287,7 @@ interface GetIntegrationByNameResponse$1 {
          */
         readmeUrl: string;
         /**
-         * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
+         * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
          */
         public: boolean;
         /**
@@ -10256,6 +10257,10 @@ interface CreatePluginRequestBody$1 {
      * Description of the plugin. This is the description that will be displayed in the UI
      */
     description?: string;
+    /**
+     * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
+     */
+    public?: boolean;
 }
 type CreatePluginInput$1 = CreatePluginRequestBody$1 & CreatePluginRequestHeaders$1 & CreatePluginRequestQuery$1 & CreatePluginRequestParams$1;
 interface CreatePluginResponse$1 {
@@ -10434,6 +10439,10 @@ interface CreatePluginResponse$1 {
          * URL of the readme of the plugin. This is the readme that will be displayed in the UI
          */
         readmeUrl: string;
+        /**
+         * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
+         */
+        public: boolean;
     };
 }
 
@@ -10623,6 +10632,10 @@ interface GetPluginResponse$1 {
          * URL of the readme of the plugin. This is the readme that will be displayed in the UI
          */
         readmeUrl: string;
+        /**
+         * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
+         */
+        public: boolean;
     };
 }
 
@@ -10813,6 +10826,10 @@ interface GetPluginByNameResponse$1 {
          * URL of the readme of the plugin. This is the readme that will be displayed in the UI
          */
         readmeUrl: string;
+        /**
+         * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
+         */
+        public: boolean;
     };
 }
 
@@ -10978,6 +10995,10 @@ interface UpdatePluginRequestBody$1 {
      * Description of the plugin. This is the description that will be displayed in the UI
      */
     description?: string;
+    /**
+     * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
+     */
+    public?: boolean;
 }
 type UpdatePluginInput$1 = UpdatePluginRequestBody$1 & UpdatePluginRequestHeaders$1 & UpdatePluginRequestQuery$1 & UpdatePluginRequestParams$1;
 interface UpdatePluginResponse$1 {
@@ -11156,6 +11177,10 @@ interface UpdatePluginResponse$1 {
          * URL of the readme of the plugin. This is the readme that will be displayed in the UI
          */
         readmeUrl: string;
+        /**
+         * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
+         */
+        public: boolean;
     };
 }
 
@@ -11221,6 +11246,10 @@ interface ListPluginsResponse$1 {
          * URL of the readme of the plugin. This is the readme that will be displayed in the UI
          */
         readmeUrl: string;
+        /**
+         * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
+         */
+        public: boolean;
     }[];
     meta: {
         /**
@@ -11861,6 +11890,10 @@ interface UpsertFileRequestBody$1 {
                  */
                 generateMasterSummary?: boolean;
             };
+            /**
+             * Internal setting, cannot be set manually.
+             */
+            stack?: "realtime-v1";
             vision?: {
                 /**
                  * (Team/Enterprise plan only, charged as AI Spend) For PDF files, set this option to `true` or pass an array with specific page numbers to use a vision-enabled LLM to transcribe each page of the PDF as standalone vectors and index them.
@@ -12487,6 +12520,18 @@ interface SearchFilesResponse$1 {
              */
             updatedAt: string;
         };
+        context?: {
+            id: string;
+            text: string;
+            /**
+             * Position of the context passage relative to the current passage. Negative for preceding passages, positive for subsequent, ommited for breadcrumbs.
+             */
+            offset?: number;
+            /**
+             * The type of context passage
+             */
+            type: "preceding" | "subsequent" | "breadcrumb";
+        }[];
     }[];
 }
 
@@ -17417,7 +17462,7 @@ interface ListPublicIntegrationsResponse {
          */
         iconUrl: string;
         /**
-         * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
+         * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
          */
         public: boolean;
         /**
@@ -17828,7 +17873,7 @@ interface GetPublicIntegrationByIdResponse {
          */
         readmeUrl: string;
         /**
-         * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
+         * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
          */
         public: boolean;
         /**
@@ -18213,7 +18258,7 @@ interface GetPublicIntegrationResponse {
          */
         readmeUrl: string;
         /**
-         * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
+         * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
          */
         public: boolean;
         /**
@@ -18499,7 +18544,7 @@ interface CreateBotResponse {
                  */
                 iconUrl: string;
                 /**
-                 * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
+                 * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
                  */
                 public: boolean;
                 /**
@@ -18934,6 +18979,7 @@ interface UpdateBotRequestBody {
         url: string;
         name: string;
     }[];
+    layers?: string[];
 }
 type UpdateBotInput = UpdateBotRequestBody & UpdateBotRequestHeaders & UpdateBotRequestQuery & UpdateBotRequestParams;
 interface UpdateBotResponse {
@@ -19002,7 +19048,7 @@ interface UpdateBotResponse {
                  */
                 iconUrl: string;
                 /**
-                 * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
+                 * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
                  */
                 public: boolean;
                 /**
@@ -19379,7 +19425,7 @@ interface GetBotResponse {
                  */
                 iconUrl: string;
                 /**
-                 * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
+                 * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
                  */
                 public: boolean;
                 /**
@@ -19633,7 +19679,7 @@ interface GetBotLogsRequestHeaders {
 }
 interface GetBotLogsRequestQuery {
     timeStart: string;
-    timeEnd: string;
+    timeEnd?: string;
     level?: string;
     userId?: string;
     workflowId?: string;
@@ -20953,7 +20999,7 @@ interface CreateIntegrationRequestBody {
      */
     description?: string;
     /**
-     * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
+     * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
      */
     public?: boolean;
     layers?: string[];
@@ -21310,7 +21356,7 @@ interface CreateIntegrationResponse {
          */
         readmeUrl: string;
         /**
-         * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
+         * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
          */
         public: boolean;
         /**
@@ -21633,7 +21679,7 @@ interface ValidateIntegrationCreationRequestBody {
      */
     description?: string;
     /**
-     * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
+     * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
      */
     public?: boolean;
     layers?: string[];
@@ -21944,7 +21990,7 @@ interface UpdateIntegrationRequestBody {
      */
     url?: string | null;
     /**
-     * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
+     * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
      */
     public?: boolean;
     layers?: string[];
@@ -22301,7 +22347,7 @@ interface UpdateIntegrationResponse {
          */
         readmeUrl: string;
         /**
-         * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
+         * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
          */
         public: boolean;
         /**
@@ -22617,7 +22663,7 @@ interface ValidateIntegrationUpdateRequestBody {
      */
     url?: string | null;
     /**
-     * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
+     * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
      */
     public?: boolean;
     layers?: string[];
@@ -22683,7 +22729,7 @@ interface ListIntegrationsResponse {
          */
         iconUrl: string;
         /**
-         * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
+         * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
          */
         public: boolean;
         /**
@@ -23090,7 +23136,7 @@ interface GetIntegrationResponse {
          */
         readmeUrl: string;
         /**
-         * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
+         * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
          */
         public: boolean;
         /**
@@ -23108,7 +23154,7 @@ interface GetIntegrationLogsRequestHeaders {
 }
 interface GetIntegrationLogsRequestQuery {
     timeStart: string;
-    timeEnd: string;
+    timeEnd?: string;
     level?: string;
     userId?: string;
     conversationId?: string;
@@ -23494,7 +23540,7 @@ interface GetIntegrationByNameResponse {
          */
         readmeUrl: string;
         /**
-         * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
+         * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
          */
         public: boolean;
         /**
@@ -24464,6 +24510,10 @@ interface CreatePluginRequestBody {
      * Description of the plugin. This is the description that will be displayed in the UI
      */
     description?: string;
+    /**
+     * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
+     */
+    public?: boolean;
 }
 type CreatePluginInput = CreatePluginRequestBody & CreatePluginRequestHeaders & CreatePluginRequestQuery & CreatePluginRequestParams;
 interface CreatePluginResponse {
@@ -24642,6 +24692,10 @@ interface CreatePluginResponse {
          * URL of the readme of the plugin. This is the readme that will be displayed in the UI
          */
         readmeUrl: string;
+        /**
+         * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
+         */
+        public: boolean;
     };
 }
 
@@ -24831,6 +24885,10 @@ interface GetPluginResponse {
          * URL of the readme of the plugin. This is the readme that will be displayed in the UI
          */
         readmeUrl: string;
+        /**
+         * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
+         */
+        public: boolean;
     };
 }
 
@@ -25021,6 +25079,10 @@ interface GetPluginByNameResponse {
          * URL of the readme of the plugin. This is the readme that will be displayed in the UI
          */
         readmeUrl: string;
+        /**
+         * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
+         */
+        public: boolean;
     };
 }
 
@@ -25186,6 +25248,10 @@ interface UpdatePluginRequestBody {
      * Description of the plugin. This is the description that will be displayed in the UI
      */
     description?: string;
+    /**
+     * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
+     */
+    public?: boolean;
 }
 type UpdatePluginInput = UpdatePluginRequestBody & UpdatePluginRequestHeaders & UpdatePluginRequestQuery & UpdatePluginRequestParams;
 interface UpdatePluginResponse {
@@ -25364,6 +25430,10 @@ interface UpdatePluginResponse {
          * URL of the readme of the plugin. This is the readme that will be displayed in the UI
          */
         readmeUrl: string;
+        /**
+         * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
+         */
+        public: boolean;
     };
 }
 
@@ -25429,6 +25499,10 @@ interface ListPluginsResponse {
          * URL of the readme of the plugin. This is the readme that will be displayed in the UI
          */
         readmeUrl: string;
+        /**
+         * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
+         */
+        public: boolean;
     }[];
     meta: {
         /**
@@ -25764,6 +25838,10 @@ interface UpsertFileRequestBody {
                  */
                 generateMasterSummary?: boolean;
             };
+            /**
+             * Internal setting, cannot be set manually.
+             */
+            stack?: "realtime-v1";
             vision?: {
                 /**
                  * (Team/Enterprise plan only, charged as AI Spend) For PDF files, set this option to `true` or pass an array with specific page numbers to use a vision-enabled LLM to transcribe each page of the PDF as standalone vectors and index them.
@@ -26390,6 +26468,18 @@ interface SearchFilesResponse {
              */
             updatedAt: string;
         };
+        context?: {
+            id: string;
+            text: string;
+            /**
+             * Position of the context passage relative to the current passage. Negative for preceding passages, positive for subsequent, ommited for breadcrumbs.
+             */
+            offset?: number;
+            /**
+             * The type of context passage
+             */
+            type: "preceding" | "subsequent" | "breadcrumb";
+        }[];
     }[];
 }
 
@@ -28280,7 +28370,7 @@ interface Bot {
              */
             iconUrl: string;
             /**
-             * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
+             * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
              */
             public: boolean;
             /**
@@ -28865,7 +28955,7 @@ interface Integration {
      */
     readmeUrl: string;
     /**
-     * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
+     * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
      */
     public: boolean;
     /**
@@ -29166,6 +29256,10 @@ interface Plugin {
      * URL of the readme of the plugin. This is the readme that will be displayed in the UI
      */
     readmeUrl: string;
+    /**
+     * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
+     */
+    public: boolean;
 }
 interface Workspace {
     id: string;