@botpress/client 0.29.3 → 0.30.0

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)
              */
@@ -2373,6 +2385,14 @@ interface GetPublicIntegrationByIdResponse {
              * Configuration definition
              */
             [k: string]: {
+                /**
+                 * Title of the configuration
+                 */
+                title?: string;
+                /**
+                 * Description of the configuration
+                 */
+                description?: string;
                 /**
                  * Identifier configuration of the [Integration](#schema_integration)
                  */
@@ -2514,6 +2534,8 @@ interface GetPublicIntegrationByIdResponse {
                  * Description of the action
                  */
                 description?: string;
+                billable?: boolean;
+                cacheable?: boolean;
                 input: {
                     schema: {
                         [k: string]: any;
@@ -2670,6 +2692,10 @@ interface GetPublicIntegrationResponse {
         interfaces: {
             [k: string]: {
                 id: string;
+                /**
+                 * Name of the interface
+                 */
+                name: string;
                 entities: {
                     [k: string]: {
                         name: string;
@@ -2691,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)
              */
@@ -2710,6 +2744,14 @@ interface GetPublicIntegrationResponse {
              * Configuration definition
              */
             [k: string]: {
+                /**
+                 * Title of the configuration
+                 */
+                title?: string;
+                /**
+                 * Description of the configuration
+                 */
+                description?: string;
                 /**
                  * Identifier configuration of the [Integration](#schema_integration)
                  */
@@ -2851,6 +2893,8 @@ interface GetPublicIntegrationResponse {
                  * Description of the action
                  */
                 description?: string;
+                billable?: boolean;
+                cacheable?: boolean;
                 input: {
                     schema: {
                         [k: string]: any;
@@ -3041,6 +3085,8 @@ interface CreateBotRequestBody {
              * Description of the action
              */
             description?: string;
+            billable?: boolean;
+            cacheable?: boolean;
             input: {
                 schema: {
                     [k: string]: any;
@@ -3178,6 +3224,7 @@ interface CreateBotResponse {
                 webhookUrl: string;
                 webhookId: string;
                 identifier?: string;
+                configurationType: string | null;
                 configuration: {
                     [k: string]: any;
                 };
@@ -3385,6 +3432,8 @@ interface CreateBotResponse {
                  * Description of the action
                  */
                 description?: string;
+                billable?: boolean;
+                cacheable?: boolean;
                 input: {
                     schema: {
                         [k: string]: any;
@@ -3554,6 +3603,8 @@ interface UpdateBotRequestBody {
              * Description of the action
              */
             description?: string;
+            billable?: boolean;
+            cacheable?: boolean;
             input: {
                 schema: {
                     [k: string]: any;
@@ -3664,6 +3715,7 @@ interface UpdateBotResponse {
                 webhookUrl: string;
                 webhookId: string;
                 identifier?: string;
+                configurationType: string | null;
                 configuration: {
                     [k: string]: any;
                 };
@@ -3871,6 +3923,8 @@ interface UpdateBotResponse {
                  * Description of the action
                  */
                 description?: string;
+                billable?: boolean;
+                cacheable?: boolean;
                 input: {
                     schema: {
                         [k: string]: any;
@@ -4023,6 +4077,7 @@ interface GetBotResponse {
                 webhookUrl: string;
                 webhookId: string;
                 identifier?: string;
+                configurationType: string | null;
                 configuration: {
                     [k: string]: any;
                 };
@@ -4230,6 +4285,8 @@ interface GetBotResponse {
                  * Description of the action
                  */
                 description?: string;
+                billable?: boolean;
+                cacheable?: boolean;
                 input: {
                     schema: {
                         [k: string]: any;
@@ -4635,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.
      */
@@ -5232,30 +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`.
          */
@@ -5272,6 +5313,14 @@ interface CreateIntegrationRequestBody {
      */
     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`.
              */
@@ -5332,6 +5381,8 @@ interface CreateIntegrationRequestBody {
              * Description of the action
              */
             description?: string;
+            billable?: boolean;
+            cacheable?: boolean;
             input: {
                 schema: {
                     [k: string]: any;
@@ -5465,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.
      */
@@ -5547,6 +5618,10 @@ interface CreateIntegrationResponse {
         interfaces: {
             [k: string]: {
                 id: string;
+                /**
+                 * Name of the interface
+                 */
+                name: string;
                 entities: {
                     [k: string]: {
                         name: string;
@@ -5568,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)
              */
@@ -5587,6 +5670,14 @@ interface CreateIntegrationResponse {
              * Configuration definition
              */
             [k: string]: {
+                /**
+                 * Title of the configuration
+                 */
+                title?: string;
+                /**
+                 * Description of the configuration
+                 */
+                description?: string;
                 /**
                  * Identifier configuration of the [Integration](#schema_integration)
                  */
@@ -5728,6 +5819,8 @@ interface CreateIntegrationResponse {
                  * Description of the action
                  */
                 description?: string;
+                billable?: boolean;
+                cacheable?: boolean;
                 input: {
                     schema: {
                         [k: string]: any;
@@ -5838,6 +5931,14 @@ 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`.
          */
@@ -5854,6 +5955,14 @@ interface UpdateIntegrationRequestBody {
      */
     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`.
              */
@@ -5952,6 +6061,8 @@ interface UpdateIntegrationRequestBody {
              * Description of the action
              */
             description?: string;
+            billable?: boolean;
+            cacheable?: boolean;
             input: {
                 schema: {
                     [k: string]: any;
@@ -6145,6 +6256,10 @@ interface UpdateIntegrationResponse {
         interfaces: {
             [k: string]: {
                 id: string;
+                /**
+                 * Name of the interface
+                 */
+                name: string;
                 entities: {
                     [k: string]: {
                         name: string;
@@ -6166,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)
              */
@@ -6185,6 +6308,14 @@ interface UpdateIntegrationResponse {
              * Configuration definition
              */
             [k: string]: {
+                /**
+                 * Title of the configuration
+                 */
+                title?: string;
+                /**
+                 * Description of the configuration
+                 */
+                description?: string;
                 /**
                  * Identifier configuration of the [Integration](#schema_integration)
                  */
@@ -6326,6 +6457,8 @@ interface UpdateIntegrationResponse {
                  * Description of the action
                  */
                 description?: string;
+                billable?: boolean;
+                cacheable?: boolean;
                 input: {
                     schema: {
                         [k: string]: any;
@@ -6540,6 +6673,10 @@ interface GetIntegrationResponse {
         interfaces: {
             [k: string]: {
                 id: string;
+                /**
+                 * Name of the interface
+                 */
+                name: string;
                 entities: {
                     [k: string]: {
                         name: string;
@@ -6561,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)
              */
@@ -6580,6 +6725,14 @@ interface GetIntegrationResponse {
              * Configuration definition
              */
             [k: string]: {
+                /**
+                 * Title of the configuration
+                 */
+                title?: string;
+                /**
+                 * Description of the configuration
+                 */
+                description?: string;
                 /**
                  * Identifier configuration of the [Integration](#schema_integration)
                  */
@@ -6721,6 +6874,8 @@ interface GetIntegrationResponse {
                  * Description of the action
                  */
                 description?: string;
+                billable?: boolean;
+                cacheable?: boolean;
                 input: {
                     schema: {
                         [k: string]: any;
@@ -6894,6 +7049,10 @@ interface GetIntegrationByNameResponse {
         interfaces: {
             [k: string]: {
                 id: string;
+                /**
+                 * Name of the interface
+                 */
+                name: string;
                 entities: {
                     [k: string]: {
                         name: string;
@@ -6915,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)
              */
@@ -6934,6 +7101,14 @@ interface GetIntegrationByNameResponse {
              * Configuration definition
              */
             [k: string]: {
+                /**
+                 * Title of the configuration
+                 */
+                title?: string;
+                /**
+                 * Description of the configuration
+                 */
+                description?: string;
                 /**
                  * Identifier configuration of the [Integration](#schema_integration)
                  */
@@ -7075,6 +7250,8 @@ interface GetIntegrationByNameResponse {
                  * Description of the action
                  */
                 description?: string;
+                billable?: boolean;
+                cacheable?: boolean;
                 input: {
                     schema: {
                         [k: string]: any;
@@ -7245,6 +7422,8 @@ interface CreateInterfaceRequestBody {
              * Description of the action
              */
             description?: string;
+            billable?: boolean;
+            cacheable?: boolean;
             input: {
                 schema: {
                     [k: string]: any;
@@ -7330,6 +7509,8 @@ interface CreateInterfaceResponse {
                  * Description of the action
                  */
                 description?: string;
+                billable?: boolean;
+                cacheable?: boolean;
                 input: {
                     schema: {
                         [k: string]: any;
@@ -7426,6 +7607,8 @@ interface GetInterfaceResponse {
                  * Description of the action
                  */
                 description?: string;
+                billable?: boolean;
+                cacheable?: boolean;
                 input: {
                     schema: {
                         [k: string]: any;
@@ -7523,6 +7706,8 @@ interface GetInterfaceByNameResponse {
                  * Description of the action
                  */
                 description?: string;
+                billable?: boolean;
+                cacheable?: boolean;
                 input: {
                     schema: {
                         [k: string]: any;
@@ -7595,6 +7780,8 @@ interface UpdateInterfaceRequestBody {
              * Description of the action
              */
             description?: string;
+            billable?: boolean;
+            cacheable?: boolean;
             input: {
                 schema: {
                     [k: string]: any;
@@ -7680,6 +7867,8 @@ interface UpdateInterfaceResponse {
                  * Description of the action
                  */
                 description?: string;
+                billable?: boolean;
+                cacheable?: boolean;
                 input: {
                     schema: {
                         [k: string]: any;
@@ -7977,6 +8166,12 @@ interface UpsertFileRequestBody {
      * Expiry timestamp in ISO 8601 format with UTC timezone. After expiry, the File will be deleted. Must be in the future. Cannot be more than 90 days from now. The value up to minutes is considered. Seconds and milliseconds are ignored.
      */
     expiresAt?: string;
+    /**
+     * Use when your file has "public_content" in its access policy and you need the file\'s content to be immediately accessible through its URL after the file has been uploaded without having to wait for the upload to be processed by our system.
+     *
+     * If set to `true`, the `x-amz-tagging` HTTP header with a value of `public=true` will need to be sent in the HTTP PUT request to the `uploadUrl` in order for the upload request to work.
+     */
+    publicContentImmediatelyAccessible?: boolean;
 }
 type UpsertFileInput = UpsertFileRequestBody & UpsertFileRequestHeaders & UpsertFileRequestQuery & UpsertFileRequestParams;
 interface UpsertFileResponse {
@@ -9867,6 +10062,7 @@ interface Bot {
             webhookUrl: string;
             webhookId: string;
             identifier?: string;
+            configurationType: string | null;
             configuration: {
                 [k: string]: any;
             };
@@ -10074,6 +10270,8 @@ interface Bot {
              * Description of the action
              */
             description?: string;
+            billable?: boolean;
+            cacheable?: boolean;
             input: {
                 schema: {
                     [k: string]: any;
@@ -10165,6 +10363,10 @@ interface Integration {
     interfaces: {
         [k: string]: {
             id: string;
+            /**
+             * Name of the interface
+             */
+            name: string;
             entities: {
                 [k: string]: {
                     name: string;
@@ -10186,6 +10388,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)
          */
@@ -10205,6 +10415,14 @@ interface Integration {
          * Configuration definition
          */
         [k: string]: {
+            /**
+             * Title of the configuration
+             */
+            title?: string;
+            /**
+             * Description of the configuration
+             */
+            description?: string;
             /**
              * Identifier configuration of the [Integration](#schema_integration)
              */
@@ -10346,6 +10564,8 @@ interface Integration {
              * Description of the action
              */
             description?: string;
+            billable?: boolean;
+            cacheable?: boolean;
             input: {
                 schema: {
                     [k: string]: any;
@@ -10494,6 +10714,8 @@ interface Interface {
              * Description of the action
              */
             description?: string;
+            billable?: boolean;
+            cacheable?: boolean;
             input: {
                 schema: {
                     [k: string]: any;
@@ -11725,7 +11947,7 @@ declare class Client extends Client$1 implements IClient {
     /**
      * Create/update and upload a file in a single step. Returns an object containing the file metadata and the URL to retrieve the file.
      */
-    readonly uploadFile: ({ key, index, tags, contentType, accessPolicies, content, url, expiresAt, }: ClientInputs['uploadFile']) => Promise<ClientOutputs['uploadFile']>;
+    readonly uploadFile: ({ key, index, tags, contentType, accessPolicies, content, url, expiresAt, publicContentImmediatelyAccessible, }: ClientInputs['uploadFile']) => Promise<ClientOutputs['uploadFile']>;
 }
 
 export { type Account, AlreadyExistsError, type ApiError, type Bot, BreakingChangesError, Client, type ClientConfig, type ClientInputs, type ClientOutputs, type ClientParams, type ClientProps, type ClientReturn, type Column, type Conversation, type ErrorType, type Event, type File, ForbiddenError, type IClient, type Integration, type Interface, InternalError, InvalidDataFormatError, InvalidIdentifierError, InvalidJsonSchemaError, InvalidPayloadError, InvalidQueryError, type Issue, type IssueEvent, LimitExceededError, type Message, MethodNotFoundError, type Operation, PayloadTooLargeError, PaymentRequiredError, QuotaExceededError, RateLimitedError, ReferenceConstraintError, ReferenceNotFoundError, RelationConflictError, ResourceLockedConflictError, ResourceNotFoundError, type RetryConfig, type Row, RuntimeError, type State, type Table, UnauthorizedError, UnknownError, UnsupportedMediaTypeError, UploadFileError, type Usage, type User, type Workspace, type WorkspaceMember, errorFrom, isApiError };