@botpress/client 0.29.2 → 0.29.4

package/dist/index.d.ts

@@ -2333,6 +2333,10 @@ interface GetPublicIntegrationByIdResponse {
         interfaces: {
             [k: string]: {
                 id: string;
+                /**
+                 * Name of the interface
+                 */
+                name: string;
                 entities: {
                     [k: string]: {
                         name: string;
@@ -2354,6 +2358,14 @@ interface GetPublicIntegrationByIdResponse {
          * Configuration definition
          */
         configuration: {
+            /**
+             * Title of the configuration
+             */
+            title?: string;
+            /**
+             * Description of the configuration
+             */
+            description?: string;
             /**
              * Identifier configuration of the [Integration](#schema_integration)
              */
@@ -2368,6 +2380,34 @@ interface GetPublicIntegrationByIdResponse {
                 [k: string]: any;
             };
         };
+        configurations: {
+            /**
+             * Configuration definition
+             */
+            [k: string]: {
+                /**
+                 * Title of the configuration
+                 */
+                title?: string;
+                /**
+                 * Description of the configuration
+                 */
+                description?: string;
+                /**
+                 * Identifier configuration of the [Integration](#schema_integration)
+                 */
+                identifier: {
+                    linkTemplateScript?: string;
+                    required: boolean;
+                };
+                /**
+                 * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
+                 */
+                schema?: {
+                    [k: string]: any;
+                };
+            };
+        };
         channels: {
             /**
              * Channel definition
@@ -2494,6 +2534,8 @@ interface GetPublicIntegrationByIdResponse {
                  * Description of the action
                  */
                 description?: string;
+                billable?: boolean;
+                cacheable?: boolean;
                 input: {
                     schema: {
                         [k: string]: any;
@@ -2650,6 +2692,10 @@ interface GetPublicIntegrationResponse {
         interfaces: {
             [k: string]: {
                 id: string;
+                /**
+                 * Name of the interface
+                 */
+                name: string;
                 entities: {
                     [k: string]: {
                         name: string;
@@ -2671,6 +2717,14 @@ interface GetPublicIntegrationResponse {
          * Configuration definition
          */
         configuration: {
+            /**
+             * Title of the configuration
+             */
+            title?: string;
+            /**
+             * Description of the configuration
+             */
+            description?: string;
             /**
              * Identifier configuration of the [Integration](#schema_integration)
              */
@@ -2685,6 +2739,34 @@ interface GetPublicIntegrationResponse {
                 [k: string]: any;
             };
         };
+        configurations: {
+            /**
+             * Configuration definition
+             */
+            [k: string]: {
+                /**
+                 * Title of the configuration
+                 */
+                title?: string;
+                /**
+                 * Description of the configuration
+                 */
+                description?: string;
+                /**
+                 * Identifier configuration of the [Integration](#schema_integration)
+                 */
+                identifier: {
+                    linkTemplateScript?: string;
+                    required: boolean;
+                };
+                /**
+                 * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
+                 */
+                schema?: {
+                    [k: string]: any;
+                };
+            };
+        };
         channels: {
             /**
              * Channel definition
@@ -2811,6 +2893,8 @@ interface GetPublicIntegrationResponse {
                  * Description of the action
                  */
                 description?: string;
+                billable?: boolean;
+                cacheable?: boolean;
                 input: {
                     schema: {
                         [k: string]: any;
@@ -3001,6 +3085,8 @@ interface CreateBotRequestBody {
              * Description of the action
              */
             description?: string;
+            billable?: boolean;
+            cacheable?: boolean;
             input: {
                 schema: {
                     [k: string]: any;
@@ -3138,6 +3224,7 @@ interface CreateBotResponse {
                 webhookUrl: string;
                 webhookId: string;
                 identifier?: string;
+                configurationType: string | null;
                 configuration: {
                     [k: string]: any;
                 };
@@ -3345,6 +3432,8 @@ interface CreateBotResponse {
                  * Description of the action
                  */
                 description?: string;
+                billable?: boolean;
+                cacheable?: boolean;
                 input: {
                     schema: {
                         [k: string]: any;
@@ -3514,6 +3603,8 @@ interface UpdateBotRequestBody {
              * Description of the action
              */
             description?: string;
+            billable?: boolean;
+            cacheable?: boolean;
             input: {
                 schema: {
                     [k: string]: any;
@@ -3558,6 +3649,10 @@ interface UpdateBotRequestBody {
     integrations?: {
         [k: string]: {
             enabled?: boolean;
+            /**
+             * Integration's configuration type. Set to default if null.
+             */
+            configurationType?: string | null;
             configuration?: {
                 [k: string]: any;
             };
@@ -3620,6 +3715,7 @@ interface UpdateBotResponse {
                 webhookUrl: string;
                 webhookId: string;
                 identifier?: string;
+                configurationType: string | null;
                 configuration: {
                     [k: string]: any;
                 };
@@ -3827,6 +3923,8 @@ interface UpdateBotResponse {
                  * Description of the action
                  */
                 description?: string;
+                billable?: boolean;
+                cacheable?: boolean;
                 input: {
                     schema: {
                         [k: string]: any;
@@ -3979,6 +4077,7 @@ interface GetBotResponse {
                 webhookUrl: string;
                 webhookId: string;
                 identifier?: string;
+                configurationType: string | null;
                 configuration: {
                     [k: string]: any;
                 };
@@ -4186,6 +4285,8 @@ interface GetBotResponse {
                  * Description of the action
                  */
                 description?: string;
+                billable?: boolean;
+                cacheable?: boolean;
                 input: {
                     schema: {
                         [k: string]: any;
@@ -4591,10 +4692,6 @@ interface GetUpcomingInvoiceRequestBody {
 }
 type GetUpcomingInvoiceInput = GetUpcomingInvoiceRequestBody & GetUpcomingInvoiceRequestHeaders & GetUpcomingInvoiceRequestQuery & GetUpcomingInvoiceRequestParams;
 interface GetUpcomingInvoiceResponse {
-    /**
-     * ID of the invoice.
-     */
-    id: string;
     /**
      * Total amount to pay of the invoice.
      */
@@ -5188,27 +5285,18 @@ interface CreateIntegrationRequestBody {
      * 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;
-                };
-            };
-        };
-    };
+    /**
+     * Default configuration definition of the integration
+     */
     configuration?: {
+        /**
+         * Title of the configuration
+         */
+        title?: string;
+        /**
+         * Description of the configuration
+         */
+        description?: string;
         /**
          * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
          */
@@ -5220,6 +5308,31 @@ interface CreateIntegrationRequestBody {
             linkTemplateScript?: string;
         };
     };
+    /**
+     * Additional configuration definitions of the integration
+     */
+    configurations?: {
+        [k: string]: {
+            /**
+             * Title of the configuration
+             */
+            title?: string;
+            /**
+             * Description of the configuration
+             */
+            description?: string;
+            /**
+             * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
+             */
+            schema?: {
+                [k: string]: any;
+            };
+            identifier?: {
+                required?: boolean;
+                linkTemplateScript?: string;
+            };
+        };
+    };
     states?: {
         /**
          * State definition
@@ -5268,6 +5381,8 @@ interface CreateIntegrationRequestBody {
              * Description of the action
              */
             description?: string;
+            billable?: boolean;
+            cacheable?: boolean;
             input: {
                 schema: {
                     [k: string]: any;
@@ -5401,6 +5516,26 @@ interface CreateIntegrationRequestBody {
             };
         };
     };
+    interfaces?: {
+        [k: string]: {
+            id: string;
+            entities: {
+                [k: string]: {
+                    name: string;
+                };
+            };
+            actions: {
+                [k: string]: {
+                    name: string;
+                };
+            };
+            events: {
+                [k: string]: {
+                    name: string;
+                };
+            };
+        };
+    };
     /**
      * 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.
      */
@@ -5483,6 +5618,10 @@ interface CreateIntegrationResponse {
         interfaces: {
             [k: string]: {
                 id: string;
+                /**
+                 * Name of the interface
+                 */
+                name: string;
                 entities: {
                     [k: string]: {
                         name: string;
@@ -5504,6 +5643,14 @@ interface CreateIntegrationResponse {
          * Configuration definition
          */
         configuration: {
+            /**
+             * Title of the configuration
+             */
+            title?: string;
+            /**
+             * Description of the configuration
+             */
+            description?: string;
             /**
              * Identifier configuration of the [Integration](#schema_integration)
              */
@@ -5518,6 +5665,34 @@ interface CreateIntegrationResponse {
                 [k: string]: any;
             };
         };
+        configurations: {
+            /**
+             * Configuration definition
+             */
+            [k: string]: {
+                /**
+                 * Title of the configuration
+                 */
+                title?: string;
+                /**
+                 * Description of the configuration
+                 */
+                description?: string;
+                /**
+                 * Identifier configuration of the [Integration](#schema_integration)
+                 */
+                identifier: {
+                    linkTemplateScript?: string;
+                    required: boolean;
+                };
+                /**
+                 * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
+                 */
+                schema?: {
+                    [k: string]: any;
+                };
+            };
+        };
         channels: {
             /**
              * Channel definition
@@ -5644,6 +5819,8 @@ interface CreateIntegrationResponse {
                  * Description of the action
                  */
                 description?: string;
+                billable?: boolean;
+                cacheable?: boolean;
                 input: {
                     schema: {
                         [k: string]: any;
@@ -5750,7 +5927,18 @@ interface UpdateIntegrationRequestParams {
     id: string;
 }
 interface UpdateIntegrationRequestBody {
+    /**
+     * Default configuration definition of the integration
+     */
     configuration?: {
+        /**
+         * Title of the configuration
+         */
+        title?: string;
+        /**
+         * Description of the configuration
+         */
+        description?: string;
         /**
          * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
          */
@@ -5762,6 +5950,31 @@ interface UpdateIntegrationRequestBody {
             required?: boolean;
         };
     };
+    /**
+     * Additional configuration definitions of the integration
+     */
+    configurations?: {
+        [k: string]: {
+            /**
+             * Title of the configuration
+             */
+            title?: string;
+            /**
+             * Description of the configuration
+             */
+            description?: string;
+            /**
+             * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
+             */
+            schema?: {
+                [k: string]: any;
+            };
+            identifier?: {
+                linkTemplateScript?: string | null;
+                required?: boolean;
+            };
+        } | null;
+    };
     channels?: {
         [k: string]: {
             /**
@@ -5848,6 +6061,8 @@ interface UpdateIntegrationRequestBody {
              * Description of the action
              */
             description?: string;
+            billable?: boolean;
+            cacheable?: boolean;
             input: {
                 schema: {
                     [k: string]: any;
@@ -6041,6 +6256,10 @@ interface UpdateIntegrationResponse {
         interfaces: {
             [k: string]: {
                 id: string;
+                /**
+                 * Name of the interface
+                 */
+                name: string;
                 entities: {
                     [k: string]: {
                         name: string;
@@ -6062,6 +6281,14 @@ interface UpdateIntegrationResponse {
          * Configuration definition
          */
         configuration: {
+            /**
+             * Title of the configuration
+             */
+            title?: string;
+            /**
+             * Description of the configuration
+             */
+            description?: string;
             /**
              * Identifier configuration of the [Integration](#schema_integration)
              */
@@ -6076,6 +6303,34 @@ interface UpdateIntegrationResponse {
                 [k: string]: any;
             };
         };
+        configurations: {
+            /**
+             * Configuration definition
+             */
+            [k: string]: {
+                /**
+                 * Title of the configuration
+                 */
+                title?: string;
+                /**
+                 * Description of the configuration
+                 */
+                description?: string;
+                /**
+                 * Identifier configuration of the [Integration](#schema_integration)
+                 */
+                identifier: {
+                    linkTemplateScript?: string;
+                    required: boolean;
+                };
+                /**
+                 * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
+                 */
+                schema?: {
+                    [k: string]: any;
+                };
+            };
+        };
         channels: {
             /**
              * Channel definition
@@ -6202,6 +6457,8 @@ interface UpdateIntegrationResponse {
                  * Description of the action
                  */
                 description?: string;
+                billable?: boolean;
+                cacheable?: boolean;
                 input: {
                     schema: {
                         [k: string]: any;
@@ -6416,6 +6673,10 @@ interface GetIntegrationResponse {
         interfaces: {
             [k: string]: {
                 id: string;
+                /**
+                 * Name of the interface
+                 */
+                name: string;
                 entities: {
                     [k: string]: {
                         name: string;
@@ -6437,6 +6698,14 @@ interface GetIntegrationResponse {
          * Configuration definition
          */
         configuration: {
+            /**
+             * Title of the configuration
+             */
+            title?: string;
+            /**
+             * Description of the configuration
+             */
+            description?: string;
             /**
              * Identifier configuration of the [Integration](#schema_integration)
              */
@@ -6451,6 +6720,34 @@ interface GetIntegrationResponse {
                 [k: string]: any;
             };
         };
+        configurations: {
+            /**
+             * Configuration definition
+             */
+            [k: string]: {
+                /**
+                 * Title of the configuration
+                 */
+                title?: string;
+                /**
+                 * Description of the configuration
+                 */
+                description?: string;
+                /**
+                 * Identifier configuration of the [Integration](#schema_integration)
+                 */
+                identifier: {
+                    linkTemplateScript?: string;
+                    required: boolean;
+                };
+                /**
+                 * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
+                 */
+                schema?: {
+                    [k: string]: any;
+                };
+            };
+        };
         channels: {
             /**
              * Channel definition
@@ -6577,6 +6874,8 @@ interface GetIntegrationResponse {
                  * Description of the action
                  */
                 description?: string;
+                billable?: boolean;
+                cacheable?: boolean;
                 input: {
                     schema: {
                         [k: string]: any;
@@ -6750,6 +7049,10 @@ interface GetIntegrationByNameResponse {
         interfaces: {
             [k: string]: {
                 id: string;
+                /**
+                 * Name of the interface
+                 */
+                name: string;
                 entities: {
                     [k: string]: {
                         name: string;
@@ -6771,6 +7074,14 @@ interface GetIntegrationByNameResponse {
          * Configuration definition
          */
         configuration: {
+            /**
+             * Title of the configuration
+             */
+            title?: string;
+            /**
+             * Description of the configuration
+             */
+            description?: string;
             /**
              * Identifier configuration of the [Integration](#schema_integration)
              */
@@ -6785,6 +7096,34 @@ interface GetIntegrationByNameResponse {
                 [k: string]: any;
             };
         };
+        configurations: {
+            /**
+             * Configuration definition
+             */
+            [k: string]: {
+                /**
+                 * Title of the configuration
+                 */
+                title?: string;
+                /**
+                 * Description of the configuration
+                 */
+                description?: string;
+                /**
+                 * Identifier configuration of the [Integration](#schema_integration)
+                 */
+                identifier: {
+                    linkTemplateScript?: string;
+                    required: boolean;
+                };
+                /**
+                 * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
+                 */
+                schema?: {
+                    [k: string]: any;
+                };
+            };
+        };
         channels: {
             /**
              * Channel definition
@@ -6911,6 +7250,8 @@ interface GetIntegrationByNameResponse {
                  * Description of the action
                  */
                 description?: string;
+                billable?: boolean;
+                cacheable?: boolean;
                 input: {
                     schema: {
                         [k: string]: any;
@@ -7081,6 +7422,8 @@ interface CreateInterfaceRequestBody {
              * Description of the action
              */
             description?: string;
+            billable?: boolean;
+            cacheable?: boolean;
             input: {
                 schema: {
                     [k: string]: any;
@@ -7166,6 +7509,8 @@ interface CreateInterfaceResponse {
                  * Description of the action
                  */
                 description?: string;
+                billable?: boolean;
+                cacheable?: boolean;
                 input: {
                     schema: {
                         [k: string]: any;
@@ -7262,6 +7607,8 @@ interface GetInterfaceResponse {
                  * Description of the action
                  */
                 description?: string;
+                billable?: boolean;
+                cacheable?: boolean;
                 input: {
                     schema: {
                         [k: string]: any;
@@ -7359,6 +7706,8 @@ interface GetInterfaceByNameResponse {
                  * Description of the action
                  */
                 description?: string;
+                billable?: boolean;
+                cacheable?: boolean;
                 input: {
                     schema: {
                         [k: string]: any;
@@ -7431,6 +7780,8 @@ interface UpdateInterfaceRequestBody {
              * Description of the action
              */
             description?: string;
+            billable?: boolean;
+            cacheable?: boolean;
             input: {
                 schema: {
                     [k: string]: any;
@@ -7516,6 +7867,8 @@ interface UpdateInterfaceResponse {
                  * Description of the action
                  */
                 description?: string;
+                billable?: boolean;
+                cacheable?: boolean;
                 input: {
                     schema: {
                         [k: string]: any;
@@ -9703,6 +10056,7 @@ interface Bot {
             webhookUrl: string;
             webhookId: string;
             identifier?: string;
+            configurationType: string | null;
             configuration: {
                 [k: string]: any;
             };
@@ -9910,6 +10264,8 @@ interface Bot {
              * Description of the action
              */
             description?: string;
+            billable?: boolean;
+            cacheable?: boolean;
             input: {
                 schema: {
                     [k: string]: any;
@@ -10001,6 +10357,10 @@ interface Integration {
     interfaces: {
         [k: string]: {
             id: string;
+            /**
+             * Name of the interface
+             */
+            name: string;
             entities: {
                 [k: string]: {
                     name: string;
@@ -10022,6 +10382,14 @@ interface Integration {
      * Configuration definition
      */
     configuration: {
+        /**
+         * Title of the configuration
+         */
+        title?: string;
+        /**
+         * Description of the configuration
+         */
+        description?: string;
         /**
          * Identifier configuration of the [Integration](#schema_integration)
          */
@@ -10036,6 +10404,34 @@ interface Integration {
             [k: string]: any;
         };
     };
+    configurations: {
+        /**
+         * Configuration definition
+         */
+        [k: string]: {
+            /**
+             * Title of the configuration
+             */
+            title?: string;
+            /**
+             * Description of the configuration
+             */
+            description?: string;
+            /**
+             * Identifier configuration of the [Integration](#schema_integration)
+             */
+            identifier: {
+                linkTemplateScript?: string;
+                required: boolean;
+            };
+            /**
+             * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
+             */
+            schema?: {
+                [k: string]: any;
+            };
+        };
+    };
     channels: {
         /**
          * Channel definition
@@ -10162,6 +10558,8 @@ interface Integration {
              * Description of the action
              */
             description?: string;
+            billable?: boolean;
+            cacheable?: boolean;
             input: {
                 schema: {
                     [k: string]: any;
@@ -10310,6 +10708,8 @@ interface Interface {
              * Description of the action
              */
             description?: string;
+            billable?: boolean;
+            cacheable?: boolean;
             input: {
                 schema: {
                     [k: string]: any;