@botpress/api 0.16.4 → 0.18.0

package/src/gen/state.ts

@@ -1403,6 +1403,71 @@ export const state = {
         },
       },
     },
+    getOrSetState: {
+      name: "getOrSetState",
+      description:
+        "Retrieves the [State](#schema_state) object for a valid identifiers. If the state does not exist, it creates a new state.",
+      method: "post",
+      path: "/v1/chat/states/{type}/{id}/{name}/get-or-set",
+      parameters: {
+        type: {
+          in: "path",
+          type: "string",
+          description: "State type",
+          enum: ["conversation", "user", "bot", "integration", "task"],
+        },
+        id: {
+          in: "path",
+          type: "string",
+          description: "State id",
+        },
+        name: {
+          in: "path",
+          type: "string",
+          description: "State name",
+        },
+      },
+      requestBody: {
+        description: "State content",
+        schema: {
+          type: "object",
+          properties: {
+            payload: {
+              type: "object",
+              additionalProperties: true,
+              description:
+                "Payload is the content of the state defined by your bot.",
+            },
+            expiry: {
+              type: "number",
+              minimum: 1,
+              maximum: 2592000000,
+              description:
+                "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.",
+            },
+          },
+          required: ["payload"],
+          title: "getOrSetStateBody",
+          additionalProperties: false,
+        },
+      },
+      section: "state",
+      response: {
+        description:
+          "Returns the [State](#schema_state) object if a valid identifiers were provided. Returns [an error](#errors) otherwise.",
+        schema: {
+          type: "object",
+          properties: {
+            state: {
+              $ref: "#/components/schemas/State",
+            },
+          },
+          required: ["state"],
+          title: "getOrSetStateResponse",
+          additionalProperties: false,
+        },
+      },
+    },
     patchState: {
       name: "patchState",
       description:
@@ -5326,6 +5391,31 @@ export const state = {
                 additionalProperties: false,
               },
             },
+            entities: {
+              type: "object",
+              additionalProperties: {
+                type: "object",
+                properties: {
+                  title: {
+                    type: "string",
+                    maxLength: 64,
+                    description: "Title of the entity",
+                  },
+                  description: {
+                    type: "string",
+                    maxLength: 256,
+                    description: "Description of the entity",
+                  },
+                  schema: {
+                    type: "object",
+                    additionalProperties: true,
+                  },
+                },
+                required: ["schema"],
+                description: "Entity definition",
+                additionalProperties: false,
+              },
+            },
             identifier: {
               type: "object",
               properties: {
@@ -5886,6 +5976,32 @@ export const state = {
               },
               additionalProperties: false,
             },
+            entities: {
+              type: "object",
+              additionalProperties: {
+                type: "object",
+                properties: {
+                  title: {
+                    type: "string",
+                    maxLength: 64,
+                    description: "Title of the entity",
+                  },
+                  description: {
+                    type: "string",
+                    maxLength: 256,
+                    description: "Description of the entity",
+                  },
+                  schema: {
+                    type: "object",
+                    additionalProperties: true,
+                  },
+                },
+                required: ["schema"],
+                description: "Entity definition",
+                nullable: true,
+                additionalProperties: false,
+              },
+            },
             secrets: {
               type: "object",
               additionalProperties: {
@@ -6633,7 +6749,7 @@ export const state = {
     title: "Botpress API",
     description: "API for Botpress Cloud",
     server: "https://api.botpress.cloud",
-    version: "0.16.4",
+    version: "0.18.0",
     prefix: "v1",
   },
   errors: [
@@ -6767,6 +6883,7 @@ export const state = {
       getOrCreateUserBody: true,
       updateUserBody: true,
       setStateBody: true,
+      getOrSetStateBody: true,
       patchStateBody: true,
       callActionBody: true,
       configureIntegrationBody: true,
@@ -6820,6 +6937,7 @@ export const state = {
       deleteUserResponse: true,
       getStateResponse: true,
       setStateResponse: true,
+      getOrSetStateResponse: true,
       patchStateResponse: true,
       callActionResponse: true,
       configureIntegrationResponse: true,
@@ -7693,6 +7811,31 @@ export const state = {
             description: "User object configuration",
             additionalProperties: false,
           },
+          entities: {
+            type: "object",
+            additionalProperties: {
+              type: "object",
+              properties: {
+                title: {
+                  type: "string",
+                  maxLength: 64,
+                  description: "Title of the entity",
+                },
+                description: {
+                  type: "string",
+                  maxLength: 256,
+                  description: "Description of the entity",
+                },
+                schema: {
+                  type: "object",
+                  additionalProperties: true,
+                },
+              },
+              required: ["schema"],
+              description: "Entity definition",
+              additionalProperties: false,
+            },
+          },
           dev: {
             type: "boolean",
             description:
@@ -7743,6 +7886,7 @@ export const state = {
           "events",
           "actions",
           "user",
+          "entities",
           "dev",
           "title",
           "description",
@@ -8831,7 +8975,7 @@ export const state = {
       description: "",
       title: "State",
       name: "state",
-      operations: ["getState", "setState", "patchState"],
+      operations: ["getState", "setState", "getOrSetState", "patchState"],
       schema: "State",
     },
     {