@botpress/client 0.30.0 → 0.30.2

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 {
@@ -11314,6 +11376,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>;