@botpress/client 0.30.1 → 0.31.0

package/dist/index.d.ts

@@ -1333,6 +1333,68 @@ type DeleteUserInput = DeleteUserRequestBody & DeleteUserRequestHeaders & Delete
 interface DeleteUserResponse {
 }
 
+interface SetStateExpiryRequestHeaders {
+}
+interface SetStateExpiryRequestQuery {
+}
+interface SetStateExpiryRequestParams {
+    type: "conversation" | "user" | "bot" | "integration" | "task";
+    id: string;
+    name: string;
+}
+interface SetStateExpiryRequestBody {
+    /**
+     * Expiry of the [State](#schema_state) in milliseconds. The state will expire if it is idle for the configured value. By default, a state doesn't expire.
+     */
+    expiry: number | null;
+}
+type SetStateExpiryInput = SetStateExpiryRequestBody & SetStateExpiryRequestHeaders & SetStateExpiryRequestQuery & SetStateExpiryRequestParams;
+interface SetStateExpiryResponse {
+    /**
+     * The state object represents the current payload. A state is always linked to either a bot, a conversation or a user.
+     */
+    state: {
+        /**
+         * Id of the [State](#schema_state)
+         */
+        id: string;
+        /**
+         * Creation date of the [State](#schema_state) in ISO 8601 format
+         */
+        createdAt: string;
+        /**
+         * Updating date of the [State](#schema_state) in ISO 8601 format
+         */
+        updatedAt: string;
+        /**
+         * Id of the [Bot](#schema_bot)
+         */
+        botId: string;
+        /**
+         * Id of the [Conversation](#schema_conversation)
+         */
+        conversationId?: string;
+        /**
+         * Id of the [User](#schema_user)
+         */
+        userId?: string;
+        /**
+         * Name of the [State](#schema_state) which is declared inside the bot definition
+         */
+        name: string;
+        /**
+         * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task` or `integration`) that the state is related to
+         */
+        type: "conversation" | "user" | "bot" | "task" | "integration";
+        /**
+         * Payload is the content of the state defined by your bot.
+         */
+        payload: {
+            [k: string]: any;
+        };
+    };
+}
+
 interface GetStateRequestHeaders {
 }
 interface GetStateRequestQuery {
@@ -1413,7 +1475,7 @@ interface SetStateRequestBody {
     /**
      * Expiry of the [State](#schema_state) in milliseconds. The state will expire if it is idle for the configured value. By default, a state doesn't expire.
      */
-    expiry?: number;
+    expiry?: number | null;
 }
 type SetStateInput = SetStateRequestBody & SetStateRequestHeaders & SetStateRequestQuery & SetStateRequestParams;
 interface SetStateResponse {
@@ -1481,7 +1543,7 @@ interface GetOrSetStateRequestBody {
     /**
      * Expiry of the [State](#schema_state) in milliseconds. The state will expire if it is idle for the configured value. By default, a state doesn't expire.
      */
-    expiry?: number;
+    expiry?: number | null;
 }
 type GetOrSetStateInput = GetOrSetStateRequestBody & GetOrSetStateRequestHeaders & GetOrSetStateRequestQuery & GetOrSetStateRequestParams;
 interface GetOrSetStateResponse {
@@ -5106,7 +5168,7 @@ interface GetAuditRecordsResponse {
         resourceId: string | null;
         resourceName?: string | null;
         value?: string | null;
-        action: "UNKNOWN" | "ADD_WORKSPACE_MEMBER" | "REMOVE_WORKSPACE_MEMBER" | "UPDATE_WORKSPACE_MEMBER" | "CLOSE_WORKSPACE" | "CREATE_BOT" | "CREATE_WORKSPACE" | "DELETE_BOT" | "DEPLOY_BOT" | "TRANSFER_BOT" | "DOWNLOAD_BOT_ARCHIVE" | "UPDATE_BOT" | "UPDATE_BOT_CHANNEL" | "UPDATE_BOT_CONFIG" | "UPDATE_PAYMENT_METHOD" | "UPDATE_WORKSPACE" | "SET_SPENDING_LIMIT" | "SET_AI_SPENDING_LIMIT";
+        action: "UNKNOWN" | "ADD_WORKSPACE_MEMBER" | "REMOVE_WORKSPACE_MEMBER" | "UPDATE_WORKSPACE_MEMBER" | "CLOSE_WORKSPACE" | "CREATE_BOT" | "CREATE_WORKSPACE" | "DELETE_BOT" | "DEPLOY_BOT" | "TRANSFER_BOT" | "DOWNLOAD_BOT_ARCHIVE" | "UPDATE_BOT" | "UPDATE_BOT_CHANNEL" | "UPDATE_BOT_CONFIG" | "UPDATE_PAYMENT_METHOD" | "UPDATE_WORKSPACE" | "SET_SPENDING_LIMIT" | "SET_AI_SPENDING_LIMIT" | "UPDATE_WORKSPACE_BILLING_READONLY";
     }[];
     meta: {
         /**
@@ -8537,6 +8599,7 @@ interface SearchFilesRequestQuery {
     query: string;
     contextDepth?: number;
     limit?: number;
+    consolidate?: boolean;
     includeBreadcrumb?: boolean;
 }
 interface SearchFilesRequestParams {
@@ -8561,7 +8624,7 @@ interface SearchFilesResponse {
             /**
              * The type of passage
              */
-            type?: "chunk";
+            type?: "chunk" | "summary" | "consolidated";
             /**
              * The subtype of passage, if available.
              */
@@ -8635,7 +8698,7 @@ interface ListFilePassagesResponse {
             /**
              * The type of passage
              */
-            type?: "chunk";
+            type?: "chunk" | "summary" | "consolidated";
             /**
              * The subtype of passage, if available.
              */
@@ -8695,10 +8758,31 @@ interface ListTablesResponse {
              */
             properties: {
                 [k: string]: {
-                    type: "string" | "number" | "boolean" | "object" | "null";
+                    type: "string" | "number" | "boolean" | "object" | "array" | "null";
                     format?: "date-time";
                     description?: string;
+                    /**
+                     * String properties must match this pattern
+                     */
+                    pattern?: string;
+                    /**
+                     * String properties must be one of these values
+                     */
+                    enum?: string[];
+                    /**
+                     * Defines the shape of items in an array
+                     */
+                    items?: {
+                        type: "string" | "number" | "boolean" | "object" | "array" | "null";
+                        [k: string]: any;
+                    };
                     nullable?: boolean;
+                    properties?: {
+                        [k: string]: {
+                            type: "string" | "number" | "boolean" | "object" | "array" | "null";
+                            [k: string]: any;
+                        };
+                    };
                     "x-zui": {
                         index: number;
                         /**
@@ -8815,10 +8899,31 @@ interface GetTableResponse {
              */
             properties: {
                 [k: string]: {
-                    type: "string" | "number" | "boolean" | "object" | "null";
+                    type: "string" | "number" | "boolean" | "object" | "array" | "null";
                     format?: "date-time";
                     description?: string;
+                    /**
+                     * String properties must match this pattern
+                     */
+                    pattern?: string;
+                    /**
+                     * String properties must be one of these values
+                     */
+                    enum?: string[];
+                    /**
+                     * Defines the shape of items in an array
+                     */
+                    items?: {
+                        type: "string" | "number" | "boolean" | "object" | "array" | "null";
+                        [k: string]: any;
+                    };
                     nullable?: boolean;
+                    properties?: {
+                        [k: string]: {
+                            type: "string" | "number" | "boolean" | "object" | "array" | "null";
+                            [k: string]: any;
+                        };
+                    };
                     "x-zui": {
                         index: number;
                         /**
@@ -8971,10 +9076,31 @@ interface GetOrCreateTableResponse {
              */
             properties: {
                 [k: string]: {
-                    type: "string" | "number" | "boolean" | "object" | "null";
+                    type: "string" | "number" | "boolean" | "object" | "array" | "null";
                     format?: "date-time";
                     description?: string;
+                    /**
+                     * String properties must match this pattern
+                     */
+                    pattern?: string;
+                    /**
+                     * String properties must be one of these values
+                     */
+                    enum?: string[];
+                    /**
+                     * Defines the shape of items in an array
+                     */
+                    items?: {
+                        type: "string" | "number" | "boolean" | "object" | "array" | "null";
+                        [k: string]: any;
+                    };
                     nullable?: boolean;
+                    properties?: {
+                        [k: string]: {
+                            type: "string" | "number" | "boolean" | "object" | "array" | "null";
+                            [k: string]: any;
+                        };
+                    };
                     "x-zui": {
                         index: number;
                         /**
@@ -9134,10 +9260,31 @@ interface CreateTableResponse {
              */
             properties: {
                 [k: string]: {
-                    type: "string" | "number" | "boolean" | "object" | "null";
+                    type: "string" | "number" | "boolean" | "object" | "array" | "null";
                     format?: "date-time";
                     description?: string;
+                    /**
+                     * String properties must match this pattern
+                     */
+                    pattern?: string;
+                    /**
+                     * String properties must be one of these values
+                     */
+                    enum?: string[];
+                    /**
+                     * Defines the shape of items in an array
+                     */
+                    items?: {
+                        type: "string" | "number" | "boolean" | "object" | "array" | "null";
+                        [k: string]: any;
+                    };
                     nullable?: boolean;
+                    properties?: {
+                        [k: string]: {
+                            type: "string" | "number" | "boolean" | "object" | "array" | "null";
+                            [k: string]: any;
+                        };
+                    };
                     "x-zui": {
                         index: number;
                         /**
@@ -9263,10 +9410,31 @@ interface DuplicateTableResponse {
              */
             properties: {
                 [k: string]: {
-                    type: "string" | "number" | "boolean" | "object" | "null";
+                    type: "string" | "number" | "boolean" | "object" | "array" | "null";
                     format?: "date-time";
                     description?: string;
+                    /**
+                     * String properties must match this pattern
+                     */
+                    pattern?: string;
+                    /**
+                     * String properties must be one of these values
+                     */
+                    enum?: string[];
+                    /**
+                     * Defines the shape of items in an array
+                     */
+                    items?: {
+                        type: "string" | "number" | "boolean" | "object" | "array" | "null";
+                        [k: string]: any;
+                    };
                     nullable?: boolean;
+                    properties?: {
+                        [k: string]: {
+                            type: "string" | "number" | "boolean" | "object" | "array" | "null";
+                            [k: string]: any;
+                        };
+                    };
                     "x-zui": {
                         index: number;
                         /**
@@ -9411,10 +9579,31 @@ interface UpdateTableResponse {
              */
             properties: {
                 [k: string]: {
-                    type: "string" | "number" | "boolean" | "object" | "null";
+                    type: "string" | "number" | "boolean" | "object" | "array" | "null";
                     format?: "date-time";
                     description?: string;
+                    /**
+                     * String properties must match this pattern
+                     */
+                    pattern?: string;
+                    /**
+                     * String properties must be one of these values
+                     */
+                    enum?: string[];
+                    /**
+                     * Defines the shape of items in an array
+                     */
+                    items?: {
+                        type: "string" | "number" | "boolean" | "object" | "array" | "null";
+                        [k: string]: any;
+                    };
                     nullable?: boolean;
+                    properties?: {
+                        [k: string]: {
+                            type: "string" | "number" | "boolean" | "object" | "array" | "null";
+                            [k: string]: any;
+                        };
+                    };
                     "x-zui": {
                         index: number;
                         /**
@@ -9543,10 +9732,31 @@ interface RenameTableColumnResponse {
              */
             properties: {
                 [k: string]: {
-                    type: "string" | "number" | "boolean" | "object" | "null";
+                    type: "string" | "number" | "boolean" | "object" | "array" | "null";
                     format?: "date-time";
                     description?: string;
+                    /**
+                     * String properties must match this pattern
+                     */
+                    pattern?: string;
+                    /**
+                     * String properties must be one of these values
+                     */
+                    enum?: string[];
+                    /**
+                     * Defines the shape of items in an array
+                     */
+                    items?: {
+                        type: "string" | "number" | "boolean" | "object" | "array" | "null";
+                        [k: string]: any;
+                    };
                     nullable?: boolean;
+                    properties?: {
+                        [k: string]: {
+                            type: "string" | "number" | "boolean" | "object" | "array" | "null";
+                            [k: string]: any;
+                        };
+                    };
                     "x-zui": {
                         index: number;
                         /**
@@ -11049,10 +11259,31 @@ interface Table {
          */
         properties: {
             [k: string]: {
-                type: "string" | "number" | "boolean" | "object" | "null";
+                type: "string" | "number" | "boolean" | "object" | "array" | "null";
                 format?: "date-time";
                 description?: string;
+                /**
+                 * String properties must match this pattern
+                 */
+                pattern?: string;
+                /**
+                 * String properties must be one of these values
+                 */
+                enum?: string[];
+                /**
+                 * Defines the shape of items in an array
+                 */
+                items?: {
+                    type: "string" | "number" | "boolean" | "object" | "array" | "null";
+                    [k: string]: any;
+                };
                 nullable?: boolean;
+                properties?: {
+                    [k: string]: {
+                        type: "string" | "number" | "boolean" | "object" | "array" | "null";
+                        [k: string]: any;
+                    };
+                };
                 "x-zui": {
                     index: number;
                     /**
@@ -11314,6 +11545,7 @@ declare class Client$1 {
     readonly getOrCreateUser: (input: GetOrCreateUserInput) => Promise<GetOrCreateUserResponse>;
     readonly updateUser: (input: UpdateUserInput) => Promise<UpdateUserResponse>;
     readonly deleteUser: (input: DeleteUserInput) => Promise<DeleteUserResponse>;
+    readonly setStateExpiry: (input: SetStateExpiryInput) => Promise<SetStateExpiryResponse>;
     readonly getState: (input: GetStateInput) => Promise<GetStateResponse>;
     readonly setState: (input: SetStateInput) => Promise<SetStateResponse>;
     readonly getOrSetState: (input: GetOrSetStateInput) => Promise<GetOrSetStateResponse>;
@@ -11749,8 +11981,8 @@ declare class AsyncCollection<T> {
     }): Promise<T[]>;
 }
 declare class Lister {
-    private client;
-    constructor(client: Client$1);
+    private _client;
+    constructor(_client: Client$1);
     readonly conversations: (props: ListInputs['listConversations']) => AsyncCollection<{
         id: string;
         currentTaskId?: string | undefined;
@@ -11932,7 +12164,7 @@ declare class Lister {
         id: string;
         content: string;
         meta: {
-            type?: "chunk" | undefined;
+            type?: "chunk" | "summary" | "consolidated" | undefined;
             subtype?: "code" | "title" | "subtitle" | "paragraph" | "list" | "blockquote" | "table" | undefined;
             pageNumber?: number | undefined;
             position?: number | undefined;