@botpress/api 0.16.4 → 0.18.0

package/dist/index.js

@@ -428169,6 +428169,67 @@ var 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: 2592e6,
+              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: "Updates the [State](#schema_state) object by setting the values of the parameters passed.",
@@ -432000,6 +432061,31 @@ var 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: {
@@ -432536,6 +432622,32 @@ var 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: {
@@ -433258,7 +433370,7 @@ var 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: [
@@ -433383,6 +433495,7 @@ var state = {
       getOrCreateUserBody: true,
       updateUserBody: true,
       setStateBody: true,
+      getOrSetStateBody: true,
       patchStateBody: true,
       callActionBody: true,
       configureIntegrationBody: true,
@@ -433436,6 +433549,7 @@ var state = {
       deleteUserResponse: true,
       getStateResponse: true,
       setStateResponse: true,
+      getOrSetStateResponse: true,
       patchStateResponse: true,
       callActionResponse: true,
       configureIntegrationResponse: true,
@@ -434273,6 +434387,31 @@ var 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: "Indicates if the integration is a development integration; Dev integrations run locally"
@@ -434317,6 +434456,7 @@ var state = {
           "events",
           "actions",
           "user",
+          "entities",
           "dev",
           "title",
           "description",
@@ -435364,7 +435504,7 @@ var state = {
       description: "",
       title: "State",
       name: "state",
-      operations: ["getState", "setState", "patchState"],
+      operations: ["getState", "setState", "getOrSetState", "patchState"],
       schema: "State"
     },
     {

package/dist/src/gen/state.d.ts

@@ -1275,6 +1275,67 @@ export declare const state: {
                 };
             };
         };
+        getOrSetState: {
+            name: string;
+            description: string;
+            method: "post";
+            path: string;
+            parameters: {
+                type: {
+                    in: "path";
+                    type: "string";
+                    description: string;
+                    enum: string[];
+                };
+                id: {
+                    in: "path";
+                    type: "string";
+                    description: string;
+                };
+                name: {
+                    in: "path";
+                    type: "string";
+                    description: string;
+                };
+            };
+            requestBody: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        payload: {
+                            type: "object";
+                            additionalProperties: true;
+                            description: string;
+                        };
+                        expiry: {
+                            type: "number";
+                            minimum: number;
+                            maximum: number;
+                            description: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            section: "state";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        state: {
+                            $ref: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
         patchState: {
             name: string;
             description: string;
@@ -4829,6 +4890,31 @@ export declare const state: {
                                 additionalProperties: false;
                             };
                         };
+                        entities: {
+                            type: "object";
+                            additionalProperties: {
+                                type: "object";
+                                properties: {
+                                    title: {
+                                        type: "string";
+                                        maxLength: number;
+                                        description: string;
+                                    };
+                                    description: {
+                                        type: "string";
+                                        maxLength: number;
+                                        description: string;
+                                    };
+                                    schema: {
+                                        type: "object";
+                                        additionalProperties: true;
+                                    };
+                                };
+                                required: string[];
+                                description: string;
+                                additionalProperties: false;
+                            };
+                        };
                         identifier: {
                             type: "object";
                             properties: {
@@ -5365,6 +5451,32 @@ export declare const state: {
                             };
                             additionalProperties: false;
                         };
+                        entities: {
+                            type: "object";
+                            additionalProperties: {
+                                type: "object";
+                                properties: {
+                                    title: {
+                                        type: "string";
+                                        maxLength: number;
+                                        description: string;
+                                    };
+                                    description: {
+                                        type: "string";
+                                        maxLength: number;
+                                        description: string;
+                                    };
+                                    schema: {
+                                        type: "object";
+                                        additionalProperties: true;
+                                    };
+                                };
+                                required: string[];
+                                description: string;
+                                nullable: true;
+                                additionalProperties: false;
+                            };
+                        };
                         secrets: {
                             type: "object";
                             additionalProperties: {
@@ -6113,6 +6225,7 @@ export declare const state: {
             getOrCreateUserBody: true;
             updateUserBody: true;
             setStateBody: true;
+            getOrSetStateBody: true;
             patchStateBody: true;
             callActionBody: true;
             configureIntegrationBody: true;
@@ -6166,6 +6279,7 @@ export declare const state: {
             deleteUserResponse: true;
             getStateResponse: true;
             setStateResponse: true;
+            getOrSetStateResponse: true;
             patchStateResponse: true;
             callActionResponse: true;
             configureIntegrationResponse: true;
@@ -6956,6 +7070,31 @@ export declare const state: {
                         description: string;
                         additionalProperties: false;
                     };
+                    entities: {
+                        type: "object";
+                        additionalProperties: {
+                            type: "object";
+                            properties: {
+                                title: {
+                                    type: "string";
+                                    maxLength: number;
+                                    description: string;
+                                };
+                                description: {
+                                    type: "string";
+                                    maxLength: number;
+                                    description: string;
+                                };
+                                schema: {
+                                    type: "object";
+                                    additionalProperties: true;
+                                };
+                            };
+                            required: string[];
+                            description: string;
+                            additionalProperties: false;
+                        };
+                    };
                     dev: {
                         type: "boolean";
                         description: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/api",
-  "version": "0.16.4",
+  "version": "0.18.0",
   "main": "dist/index.js",
   "types": "dist/src/index.d.ts",
   "scripts": {

package/src/gen/metadata.json

@@ -1 +1 @@
-{"sections":[{"description":"","title":"User","name":"user","operations":["createUser","getUser","listUsers","getOrCreateUser","updateUser","deleteUser"],"schema":"User"},{"description":"","title":"Conversation","name":"conversation","operations":["createConversation","getConversation","listConversations","getOrCreateConversation","updateConversation","deleteConversation","listParticipants","addParticipant","getParticipant","removeParticipant"],"schema":"Conversation"},{"description":"","title":"Event","name":"event","operations":["createEvent","getEvent","listEvents"],"schema":"Event"},{"description":"","title":"Message","name":"message","operations":["createMessage","getOrCreateMessage","getMessage","updateMessage","listMessages","deleteMessage"],"schema":"Message"},{"description":"","title":"File","name":"file","operations":["createFile","getFile","downloadFile","deleteFile","listFiles"],"schema":"File"},{"description":"","title":"State","name":"state","operations":["getState","setState","patchState"],"schema":"State"},{"title":"Hub","description":"","name":"hub","operations":["listPublicIntegrations","getPublicIntegrationById","getPublicIntegration"]},{"description":"","title":"Action","name":"action","operations":["callAction"]},{"description":"","title":"Task","name":"task","operations":["getTask","createTask","updateTask","deleteTask","listTasks"],"schema":"Task"},{"title":"Bot","description":"","name":"bot","operations":["createBot","updateBot","transferBot","listBots","getBot","deleteBot","getBotLogs","getBotWebchat","getBotAnalytics","listBotIssues","deleteBotIssue","listBotIssueEvents"],"schema":"Bot"},{"title":"Integration","description":"","name":"integration","operations":["createIntegration","updateIntegration","listIntegrations","getIntegration","getIntegrationLogs","getIntegrationByName","deleteIntegration"],"schema":"Integration"},{"title":"Workspace","description":"","name":"workspace","operations":["getWorkspaceBillingDetails","setWorkspacePaymentMethod","listWorkspaceInvoices","chargeWorkspaceUnpaidInvoices","createWorkspace","getWorkspace","listWorkspaceUsages","breakDownWorkspaceUsageByBot","getAllWorkspaceQuotaCompletion","getWorkspaceQuota","listWorkspaceQuotas","updateWorkspace","checkHandleAvailability","listWorkspaces","changeWorkspacePlan","deleteWorkspace","getAuditRecords"],"schema":"Workspace"},{"title":"Workspace Member","description":"","name":"workspaceMember","operations":["listWorkspaceMembers","deleteWorkspaceMember","createWorkspaceMember","updateWorkspaceMember"],"schema":"WorkspaceMember"},{"title":"Account","description":"","name":"account","operations":["getAccount","listPersonalAccessTokens","createPersonalAccessToken","deletePersonalAccessToken","setAccountPreference","getAccountPreference"],"schema":"Account"},{"title":"Usage","description":"","name":"usage","operations":["getUsage"],"schema":"Usage"},{"title":"Quotas","description":"","name":"quotas","operations":["changeAISpendQuota"]},{"title":"Helper","description":"","name":"helper","operations":["runVrl"]},{"title":"Activity","description":"","name":"activity","operations":["listActivities"],"schema":"Activity"},{"title":"Tables","description":"Operations related to table management.","name":"tables","operations":[],"schema":"Table"}],"errors":[{"status":500,"type":"Unknown","description":"An unknown error occurred"},{"status":500,"type":"Internal","description":"An internal error occurred"},{"status":401,"type":"Unauthorized","description":"The request requires to be authenticated."},{"status":403,"type":"Forbidden","description":"The requested action can't be peform by this resource."},{"status":413,"type":"PayloadTooLarge","description":"The request payload is too large."},{"status":400,"type":"InvalidPayload","description":"The request payload is invalid."},{"status":415,"type":"UnsupportedMediaType","description":"The request is invalid because the content-type is not supported."},{"status":405,"type":"MethodNotFound","description":"The requested method does not exist."},{"status":404,"type":"ResourceNotFound","description":"The requested resource does not exist."},{"status":400,"type":"InvalidJsonSchema","description":"The provided JSON schema is invalid."},{"status":400,"type":"InvalidDataFormat","description":"The provided data doesn't respect the provided JSON schema."},{"status":400,"type":"InvalidIdentifier","description":"The provided identifier is not valid. An identifier must start with a lowercase letter, be between 2 and 100 characters long and use only alphanumeric characters."},{"status":409,"type":"RelationConflict","description":"The resource is not related with another resource. This is usually caused when providing two resources that aren't linked together."},{"status":400,"type":"ReferenceNotFound","description":"The provided resource reference is missing. This is usually caused when providing an invalid id inside the payload of a request."},{"status":400,"type":"InvalidQuery","description":"The provided query is invalid. This is usually caused when providing an invalid parameter for querying a resource."},{"status":400,"type":"Runtime","description":"An error happened during the execution of a runtime (bot or integration)."},{"status":409,"type":"AlreadyExists","description":"The record attempted to be created already exists."},{"status":429,"type":"RateLimited","description":"The request has been rate limited."},{"status":402,"type":"PaymentRequired","description":"A payment is required to perform this request."},{"status":403,"type":"QuotaExceeded","description":"The request exceeds the allowed quota. Quotas are a soft limit that can be increased."},{"status":413,"type":"LimitExceeded","description":"The request exceeds the allowed limit. Limits are a hard limit that cannot be increased."}]}
+{"sections":[{"description":"","title":"User","name":"user","operations":["createUser","getUser","listUsers","getOrCreateUser","updateUser","deleteUser"],"schema":"User"},{"description":"","title":"Conversation","name":"conversation","operations":["createConversation","getConversation","listConversations","getOrCreateConversation","updateConversation","deleteConversation","listParticipants","addParticipant","getParticipant","removeParticipant"],"schema":"Conversation"},{"description":"","title":"Event","name":"event","operations":["createEvent","getEvent","listEvents"],"schema":"Event"},{"description":"","title":"Message","name":"message","operations":["createMessage","getOrCreateMessage","getMessage","updateMessage","listMessages","deleteMessage"],"schema":"Message"},{"description":"","title":"File","name":"file","operations":["createFile","getFile","downloadFile","deleteFile","listFiles"],"schema":"File"},{"description":"","title":"State","name":"state","operations":["getState","setState","getOrSetState","patchState"],"schema":"State"},{"title":"Hub","description":"","name":"hub","operations":["listPublicIntegrations","getPublicIntegrationById","getPublicIntegration"]},{"description":"","title":"Action","name":"action","operations":["callAction"]},{"description":"","title":"Task","name":"task","operations":["getTask","createTask","updateTask","deleteTask","listTasks"],"schema":"Task"},{"title":"Bot","description":"","name":"bot","operations":["createBot","updateBot","transferBot","listBots","getBot","deleteBot","getBotLogs","getBotWebchat","getBotAnalytics","listBotIssues","deleteBotIssue","listBotIssueEvents"],"schema":"Bot"},{"title":"Integration","description":"","name":"integration","operations":["createIntegration","updateIntegration","listIntegrations","getIntegration","getIntegrationLogs","getIntegrationByName","deleteIntegration"],"schema":"Integration"},{"title":"Workspace","description":"","name":"workspace","operations":["getWorkspaceBillingDetails","setWorkspacePaymentMethod","listWorkspaceInvoices","chargeWorkspaceUnpaidInvoices","createWorkspace","getWorkspace","listWorkspaceUsages","breakDownWorkspaceUsageByBot","getAllWorkspaceQuotaCompletion","getWorkspaceQuota","listWorkspaceQuotas","updateWorkspace","checkHandleAvailability","listWorkspaces","changeWorkspacePlan","deleteWorkspace","getAuditRecords"],"schema":"Workspace"},{"title":"Workspace Member","description":"","name":"workspaceMember","operations":["listWorkspaceMembers","deleteWorkspaceMember","createWorkspaceMember","updateWorkspaceMember"],"schema":"WorkspaceMember"},{"title":"Account","description":"","name":"account","operations":["getAccount","listPersonalAccessTokens","createPersonalAccessToken","deletePersonalAccessToken","setAccountPreference","getAccountPreference"],"schema":"Account"},{"title":"Usage","description":"","name":"usage","operations":["getUsage"],"schema":"Usage"},{"title":"Quotas","description":"","name":"quotas","operations":["changeAISpendQuota"]},{"title":"Helper","description":"","name":"helper","operations":["runVrl"]},{"title":"Activity","description":"","name":"activity","operations":["listActivities"],"schema":"Activity"},{"title":"Tables","description":"Operations related to table management.","name":"tables","operations":[],"schema":"Table"}],"errors":[{"status":500,"type":"Unknown","description":"An unknown error occurred"},{"status":500,"type":"Internal","description":"An internal error occurred"},{"status":401,"type":"Unauthorized","description":"The request requires to be authenticated."},{"status":403,"type":"Forbidden","description":"The requested action can't be peform by this resource."},{"status":413,"type":"PayloadTooLarge","description":"The request payload is too large."},{"status":400,"type":"InvalidPayload","description":"The request payload is invalid."},{"status":415,"type":"UnsupportedMediaType","description":"The request is invalid because the content-type is not supported."},{"status":405,"type":"MethodNotFound","description":"The requested method does not exist."},{"status":404,"type":"ResourceNotFound","description":"The requested resource does not exist."},{"status":400,"type":"InvalidJsonSchema","description":"The provided JSON schema is invalid."},{"status":400,"type":"InvalidDataFormat","description":"The provided data doesn't respect the provided JSON schema."},{"status":400,"type":"InvalidIdentifier","description":"The provided identifier is not valid. An identifier must start with a lowercase letter, be between 2 and 100 characters long and use only alphanumeric characters."},{"status":409,"type":"RelationConflict","description":"The resource is not related with another resource. This is usually caused when providing two resources that aren't linked together."},{"status":400,"type":"ReferenceNotFound","description":"The provided resource reference is missing. This is usually caused when providing an invalid id inside the payload of a request."},{"status":400,"type":"InvalidQuery","description":"The provided query is invalid. This is usually caused when providing an invalid parameter for querying a resource."},{"status":400,"type":"Runtime","description":"An error happened during the execution of a runtime (bot or integration)."},{"status":409,"type":"AlreadyExists","description":"The record attempted to be created already exists."},{"status":429,"type":"RateLimited","description":"The request has been rate limited."},{"status":402,"type":"PaymentRequired","description":"A payment is required to perform this request."},{"status":403,"type":"QuotaExceeded","description":"The request exceeds the allowed quota. Quotas are a soft limit that can be increased."},{"status":413,"type":"LimitExceeded","description":"The request exceeds the allowed limit. Limits are a hard limit that cannot be increased."}]}