@botpress/client 0.33.0 → 0.33.1

package/dist/index.d.ts

@@ -2346,7 +2346,7 @@ interface UpdateWorkflowRequestBody {
     /**
      * Status of the workflow
      */
-    status?: "completed" | "cancelled" | "listening" | "paused" | "failed";
+    status?: "completed" | "cancelled" | "listening" | "paused" | "failed" | "in_progress";
     /**
      * Reason why the workflow failed
      */
@@ -2361,6 +2361,10 @@ interface UpdateWorkflowRequestBody {
      * Specific user related to this workflow
      */
     userId?: string;
+    /**
+     * Event id must be specified if the workflow is updated with the status in_progress
+     */
+    eventId?: string;
 }
 type UpdateWorkflowInput = UpdateWorkflowRequestBody & UpdateWorkflowRequestHeaders & UpdateWorkflowRequestQuery & UpdateWorkflowRequestParams;
 interface UpdateWorkflowResponse {
@@ -2938,6 +2942,9 @@ interface GetPublicIntegrationByIdResponse {
         version: string;
         interfaces: {
             [k: string]: {
+                /**
+                 * ID of the interface
+                 */
                 id: string;
                 /**
                  * Name of the interface
@@ -2958,6 +2965,11 @@ interface GetPublicIntegrationByIdResponse {
                         name: string;
                     };
                 };
+                channels: {
+                    [k: string]: {
+                        name: string;
+                    };
+                };
             };
         };
         /**
@@ -3297,6 +3309,9 @@ interface GetPublicIntegrationResponse {
         version: string;
         interfaces: {
             [k: string]: {
+                /**
+                 * ID of the interface
+                 */
                 id: string;
                 /**
                  * Name of the interface
@@ -3317,6 +3332,11 @@ interface GetPublicIntegrationResponse {
                         name: string;
                     };
                 };
+                channels: {
+                    [k: string]: {
+                        name: string;
+                    };
+                };
             };
         };
         /**
@@ -5033,6 +5053,40 @@ interface GetBotAnalyticsResponse {
         customEvents: {
             [k: string]: number;
         };
+        llm: {
+            calls: number;
+            errors: number;
+            inputTokens: number;
+            outputTokens: number;
+            /**
+             * The time it took for the LLM to complete its response. Values are expressed in milliseconds
+             */
+            latency: {
+                mean: number;
+                sd: number;
+                min: number;
+                max: number;
+            };
+            /**
+             * LLM response generation speed expressed in output tokens per second.
+             */
+            tokensPerSecond: {
+                mean: number;
+                sd: number;
+                min: number;
+                max: number;
+            };
+            /**
+             * Values are expressed in U.S. dollars
+             */
+            cost: {
+                sum: number;
+                mean: number;
+                sd: number;
+                min: number;
+                max: number;
+            };
+        };
     }[];
 }
 
@@ -6124,18 +6178,26 @@ interface CreateIntegrationRequestBody {
     };
     interfaces?: {
         [k: string]: {
+            /**
+             * ID of the interface
+             */
             id: string;
-            entities: {
+            entities?: {
                 [k: string]: {
                     name: string;
                 };
             };
-            actions: {
+            actions?: {
                 [k: string]: {
                     name: string;
                 };
             };
-            events: {
+            events?: {
+                [k: string]: {
+                    name: string;
+                };
+            };
+            channels?: {
                 [k: string]: {
                     name: string;
                 };
@@ -6223,6 +6285,9 @@ interface CreateIntegrationResponse {
         version: string;
         interfaces: {
             [k: string]: {
+                /**
+                 * ID of the interface
+                 */
                 id: string;
                 /**
                  * Name of the interface
@@ -6243,6 +6308,11 @@ interface CreateIntegrationResponse {
                         name: string;
                     };
                 };
+                channels: {
+                    [k: string]: {
+                        name: string;
+                    };
+                };
             };
         };
         /**
@@ -6766,18 +6836,26 @@ interface UpdateIntegrationRequestBody {
     };
     interfaces?: {
         [k: string]: {
+            /**
+             * ID of the interface
+             */
             id: string;
-            entities: {
+            entities?: {
                 [k: string]: {
                     name: string;
                 };
             };
-            actions: {
+            actions?: {
                 [k: string]: {
                     name: string;
                 };
             };
-            events: {
+            events?: {
+                [k: string]: {
+                    name: string;
+                };
+            };
+            channels?: {
                 [k: string]: {
                     name: string;
                 };
@@ -6861,6 +6939,9 @@ interface UpdateIntegrationResponse {
         version: string;
         interfaces: {
             [k: string]: {
+                /**
+                 * ID of the interface
+                 */
                 id: string;
                 /**
                  * Name of the interface
@@ -6881,6 +6962,11 @@ interface UpdateIntegrationResponse {
                         name: string;
                     };
                 };
+                channels: {
+                    [k: string]: {
+                        name: string;
+                    };
+                };
             };
         };
         /**
@@ -7278,6 +7364,9 @@ interface GetIntegrationResponse {
         version: string;
         interfaces: {
             [k: string]: {
+                /**
+                 * ID of the interface
+                 */
                 id: string;
                 /**
                  * Name of the interface
@@ -7298,6 +7387,11 @@ interface GetIntegrationResponse {
                         name: string;
                     };
                 };
+                channels: {
+                    [k: string]: {
+                        name: string;
+                    };
+                };
             };
         };
         /**
@@ -7654,6 +7748,9 @@ interface GetIntegrationByNameResponse {
         version: string;
         interfaces: {
             [k: string]: {
+                /**
+                 * ID of the interface
+                 */
                 id: string;
                 /**
                  * Name of the interface
@@ -7674,6 +7771,11 @@ interface GetIntegrationByNameResponse {
                         name: string;
                     };
                 };
+                channels: {
+                    [k: string]: {
+                        name: string;
+                    };
+                };
             };
         };
         /**
@@ -7997,7 +8099,25 @@ interface CreateInterfaceRequestBody {
      * Version of the [Interface](#schema_interface)
      */
     version: string;
-    events: {
+    entities?: {
+        /**
+         * Entity definition
+         */
+        [k: string]: {
+            /**
+             * Title of the entity
+             */
+            title?: string;
+            /**
+             * Description of the entity
+             */
+            description?: string;
+            schema: {
+                [k: string]: any;
+            };
+        };
+    };
+    events?: {
         /**
          * Event Definition
          */
@@ -8015,7 +8135,7 @@ interface CreateInterfaceRequestBody {
             };
         };
     };
-    actions: {
+    actions?: {
         /**
          * Action definition
          */
@@ -8042,21 +8162,25 @@ interface CreateInterfaceRequestBody {
             };
         };
     };
-    entities: {
-        /**
-         * Entity definition
-         */
+    channels?: {
         [k: string]: {
             /**
-             * Title of the entity
+             * Title of the channel
              */
             title?: string;
             /**
-             * Description of the entity
+             * Description of the channel
              */
             description?: string;
-            schema: {
-                [k: string]: any;
+            messages: {
+                /**
+                 * Message definition
+                 */
+                [k: string]: {
+                    schema: {
+                        [k: string]: any;
+                    };
+                };
             };
         };
     };
@@ -8091,6 +8215,24 @@ interface CreateInterfaceResponse {
          * Version of the [Interface](#schema_interface)
          */
         version: string;
+        entities: {
+            /**
+             * Entity definition
+             */
+            [k: string]: {
+                /**
+                 * Title of the entity
+                 */
+                title?: string;
+                /**
+                 * Description of the entity
+                 */
+                description?: string;
+                schema: {
+                    [k: string]: any;
+                };
+            };
+        };
         events: {
             /**
              * Event Definition
@@ -8136,21 +8278,25 @@ interface CreateInterfaceResponse {
                 };
             };
         };
-        entities: {
-            /**
-             * Entity definition
-             */
+        channels: {
             [k: string]: {
                 /**
-                 * Title of the entity
+                 * Title of the channel
                  */
                 title?: string;
                 /**
-                 * Description of the entity
+                 * Description of the channel
                  */
                 description?: string;
-                schema: {
-                    [k: string]: any;
+                messages: {
+                    /**
+                     * Message definition
+                     */
+                    [k: string]: {
+                        schema: {
+                            [k: string]: any;
+                        };
+                    };
                 };
             };
         };
@@ -8196,6 +8342,24 @@ interface GetInterfaceResponse {
          * Version of the [Interface](#schema_interface)
          */
         version: string;
+        entities: {
+            /**
+             * Entity definition
+             */
+            [k: string]: {
+                /**
+                 * Title of the entity
+                 */
+                title?: string;
+                /**
+                 * Description of the entity
+                 */
+                description?: string;
+                schema: {
+                    [k: string]: any;
+                };
+            };
+        };
         events: {
             /**
              * Event Definition
@@ -8241,21 +8405,25 @@ interface GetInterfaceResponse {
                 };
             };
         };
-        entities: {
-            /**
-             * Entity definition
-             */
+        channels: {
             [k: string]: {
                 /**
-                 * Title of the entity
+                 * Title of the channel
                  */
                 title?: string;
                 /**
-                 * Description of the entity
+                 * Description of the channel
                  */
                 description?: string;
-                schema: {
-                    [k: string]: any;
+                messages: {
+                    /**
+                     * Message definition
+                     */
+                    [k: string]: {
+                        schema: {
+                            [k: string]: any;
+                        };
+                    };
                 };
             };
         };
@@ -8302,6 +8470,24 @@ interface GetInterfaceByNameResponse {
          * Version of the [Interface](#schema_interface)
          */
         version: string;
+        entities: {
+            /**
+             * Entity definition
+             */
+            [k: string]: {
+                /**
+                 * Title of the entity
+                 */
+                title?: string;
+                /**
+                 * Description of the entity
+                 */
+                description?: string;
+                schema: {
+                    [k: string]: any;
+                };
+            };
+        };
         events: {
             /**
              * Event Definition
@@ -8347,21 +8533,25 @@ interface GetInterfaceByNameResponse {
                 };
             };
         };
-        entities: {
-            /**
-             * Entity definition
-             */
+        channels: {
             [k: string]: {
                 /**
-                 * Title of the entity
+                 * Title of the channel
                  */
                 title?: string;
                 /**
-                 * Description of the entity
+                 * Description of the channel
                  */
                 description?: string;
-                schema: {
-                    [k: string]: any;
+                messages: {
+                    /**
+                     * Message definition
+                     */
+                    [k: string]: {
+                        schema: {
+                            [k: string]: any;
+                        };
+                    };
                 };
             };
         };
@@ -8383,6 +8573,24 @@ interface UpdateInterfaceRequestParams {
     id: string;
 }
 interface UpdateInterfaceRequestBody {
+    entities?: {
+        /**
+         * Entity definition
+         */
+        [k: string]: {
+            /**
+             * Title of the entity
+             */
+            title?: string;
+            /**
+             * Description of the entity
+             */
+            description?: string;
+            schema: {
+                [k: string]: any;
+            };
+        } | null;
+    };
     events?: {
         /**
          * Event Definition
@@ -8428,21 +8636,25 @@ interface UpdateInterfaceRequestBody {
             };
         } | null;
     };
-    entities?: {
-        /**
-         * Entity definition
-         */
+    channels?: {
         [k: string]: {
             /**
-             * Title of the entity
+             * Title of the channel
              */
             title?: string;
             /**
-             * Description of the entity
+             * Description of the channel
              */
             description?: string;
-            schema: {
-                [k: string]: any;
+            messages?: {
+                /**
+                 * Message definition
+                 */
+                [k: string]: {
+                    schema: {
+                        [k: string]: any;
+                    };
+                } | null;
             };
         } | null;
     };
@@ -8477,6 +8689,24 @@ interface UpdateInterfaceResponse {
          * Version of the [Interface](#schema_interface)
          */
         version: string;
+        entities: {
+            /**
+             * Entity definition
+             */
+            [k: string]: {
+                /**
+                 * Title of the entity
+                 */
+                title?: string;
+                /**
+                 * Description of the entity
+                 */
+                description?: string;
+                schema: {
+                    [k: string]: any;
+                };
+            };
+        };
         events: {
             /**
              * Event Definition
@@ -8522,21 +8752,25 @@ interface UpdateInterfaceResponse {
                 };
             };
         };
-        entities: {
-            /**
-             * Entity definition
-             */
+        channels: {
             [k: string]: {
                 /**
-                 * Title of the entity
+                 * Title of the channel
                  */
                 title?: string;
                 /**
-                 * Description of the entity
+                 * Description of the channel
                  */
                 description?: string;
-                schema: {
-                    [k: string]: any;
+                messages: {
+                    /**
+                     * Message definition
+                     */
+                    [k: string]: {
+                        schema: {
+                            [k: string]: any;
+                        };
+                    };
                 };
             };
         };
@@ -11212,6 +11446,9 @@ interface Integration {
     version: string;
     interfaces: {
         [k: string]: {
+            /**
+             * ID of the interface
+             */
             id: string;
             /**
              * Name of the interface
@@ -11232,6 +11469,11 @@ interface Integration {
                     name: string;
                 };
             };
+            channels: {
+                [k: string]: {
+                    name: string;
+                };
+            };
         };
     };
     /**
@@ -11533,6 +11775,24 @@ interface Interface {
      * Version of the [Interface](#schema_interface)
      */
     version: string;
+    entities: {
+        /**
+         * Entity definition
+         */
+        [k: string]: {
+            /**
+             * Title of the entity
+             */
+            title?: string;
+            /**
+             * Description of the entity
+             */
+            description?: string;
+            schema: {
+                [k: string]: any;
+            };
+        };
+    };
     events: {
         /**
          * Event Definition
@@ -11578,21 +11838,25 @@ interface Interface {
             };
         };
     };
-    entities: {
-        /**
-         * Entity definition
-         */
+    channels: {
         [k: string]: {
             /**
-             * Title of the entity
+             * Title of the channel
              */
             title?: string;
             /**
-             * Description of the entity
+             * Description of the channel
              */
             description?: string;
-            schema: {
-                [k: string]: any;
+            messages: {
+                /**
+                 * Message definition
+                 */
+                [k: string]: {
+                    schema: {
+                        [k: string]: any;
+                    };
+                };
             };
         };
     };