@botpress/api 0.12.6 → 0.13.1

package/dist/gen/state.d.ts

@@ -252,6 +252,155 @@ export declare const state: {
                 };
             };
         };
+        listParticipants: {
+            name: string;
+            description: string;
+            method: "get";
+            path: string;
+            parameters: {
+                nextToken: {
+                    in: "query";
+                    description: string;
+                    type: "string";
+                };
+                id: {
+                    in: "path";
+                    type: "string";
+                    description: string;
+                };
+            };
+            section: "conversation";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        participants: {
+                            type: "array";
+                            items: {
+                                $ref: string;
+                            };
+                        };
+                        meta: {
+                            type: "object";
+                            properties: {
+                                nextToken: {
+                                    type: "string";
+                                    description: string;
+                                };
+                            };
+                            additionalProperties: false;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        addParticipant: {
+            name: string;
+            description: string;
+            method: "post";
+            path: string;
+            parameters: {
+                id: {
+                    in: "path";
+                    type: "string";
+                    description: string;
+                };
+            };
+            requestBody: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        userId: {
+                            type: "string";
+                            description: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            section: "conversation";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        participant: {
+                            $ref: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        getParticipant: {
+            name: string;
+            description: string;
+            method: "get";
+            path: string;
+            parameters: {
+                id: {
+                    in: "path";
+                    type: "string";
+                    description: string;
+                };
+                userId: {
+                    in: "path";
+                    type: "string";
+                    description: string;
+                };
+            };
+            section: "conversation";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        participant: {
+                            $ref: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        removeParticipant: {
+            name: string;
+            description: string;
+            method: "delete";
+            path: string;
+            parameters: {
+                id: {
+                    in: "path";
+                    type: "string";
+                    description: string;
+                };
+                userId: {
+                    in: "path";
+                    type: "string";
+                    description: string;
+                };
+            };
+            section: "conversation";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
         createEvent: {
             name: string;
             description: string;
@@ -4991,6 +5140,7 @@ export declare const state: {
             createConversationBody: true;
             getOrCreateConversationBody: true;
             updateConversationBody: true;
+            addParticipantBody: true;
             createEventBody: true;
             createMessageBody: true;
             getOrCreateMessageBody: true;
@@ -5025,6 +5175,10 @@ export declare const state: {
             getOrCreateConversationResponse: true;
             updateConversationResponse: true;
             deleteConversationResponse: true;
+            listParticipantsResponse: true;
+            addParticipantResponse: true;
+            getParticipantResponse: true;
+            removeParticipantResponse: true;
             createEventResponse: true;
             getEventResponse: true;
             listEventsResponse: true;

package/dist/index.js

@@ -425908,7 +425908,7 @@ var state = {
             },
             integrationName: {
               type: "string",
-              description: "Name of the integration to which the conversation creation will be delegated"
+              description: "[DEPRECATED] To create a conversation from within a bot, call an action of the integration instead."
             }
           },
           required: ["channel", "tags"],
@@ -426043,7 +426043,7 @@ var state = {
             },
             integrationName: {
               type: "string",
-              description: "Name of the integration to which the conversation creation will be delegated"
+              description: "[DEPRECATED] To create a conversation from within a bot, call an action of the integration instead."
             }
           },
           required: ["channel", "tags"],
@@ -426136,6 +426136,155 @@ var state = {
         }
       }
     },
+    listParticipants: {
+      name: "listParticipants",
+      description: "Retrieves a list of [Participant](#schema_participant) for a given [Conversation](#schema_conversation).",
+      method: "get",
+      path: "/v1/chat/conversations/{id}/participants",
+      parameters: {
+        nextToken: {
+          in: "query",
+          description: "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
+          type: "string"
+        },
+        id: {
+          in: "path",
+          type: "string",
+          description: "Conversation id"
+        }
+      },
+      section: "conversation",
+      response: {
+        description: "Returns a list of [Participant](#schema_participant) objects",
+        schema: {
+          type: "object",
+          properties: {
+            participants: {
+              type: "array",
+              items: {
+                $ref: "#/components/schemas/User"
+              }
+            },
+            meta: {
+              type: "object",
+              properties: {
+                nextToken: {
+                  type: "string",
+                  description: "The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint."
+                }
+              },
+              additionalProperties: false
+            }
+          },
+          required: ["participants", "meta"],
+          title: "listParticipantsResponse",
+          additionalProperties: false
+        }
+      }
+    },
+    addParticipant: {
+      name: "addParticipant",
+      description: "Add a [Participant](#schema_participant) to a [Conversation](#schema_conversation).",
+      method: "post",
+      path: "/v1/chat/conversations/{id}/participants",
+      parameters: {
+        id: {
+          in: "path",
+          type: "string",
+          description: "Conversation id"
+        }
+      },
+      requestBody: {
+        description: "Participant data",
+        schema: {
+          type: "object",
+          properties: {
+            userId: {
+              type: "string",
+              description: "User id"
+            }
+          },
+          required: ["userId"],
+          title: "addParticipantBody",
+          additionalProperties: false
+        }
+      },
+      section: "conversation",
+      response: {
+        description: "Returns the [Participant](#schema_participant) object",
+        schema: {
+          type: "object",
+          properties: {
+            participant: {
+              $ref: "#/components/schemas/User"
+            }
+          },
+          required: ["participant"],
+          title: "addParticipantResponse",
+          additionalProperties: false
+        }
+      }
+    },
+    getParticipant: {
+      name: "getParticipant",
+      description: "Retrieves a [Participant](#schema_participant) from a [Conversation](#schema_conversation).",
+      method: "get",
+      path: "/v1/chat/conversations/{id}/participants/{userId}",
+      parameters: {
+        id: {
+          in: "path",
+          type: "string",
+          description: "Conversation id"
+        },
+        userId: {
+          in: "path",
+          type: "string",
+          description: "User id"
+        }
+      },
+      section: "conversation",
+      response: {
+        description: "Returns the [Participant](#schema_participant) object",
+        schema: {
+          type: "object",
+          properties: {
+            participant: {
+              $ref: "#/components/schemas/User"
+            }
+          },
+          required: ["participant"],
+          title: "getParticipantResponse",
+          additionalProperties: false
+        }
+      }
+    },
+    removeParticipant: {
+      name: "removeParticipant",
+      description: "Remove a [Participant](#schema_participant) from a [Conversation](#schema_conversation).",
+      method: "delete",
+      path: "/v1/chat/conversations/{id}/participants/{userId}",
+      parameters: {
+        id: {
+          in: "path",
+          type: "string",
+          description: "Conversation id"
+        },
+        userId: {
+          in: "path",
+          type: "string",
+          description: "User id"
+        }
+      },
+      section: "conversation",
+      response: {
+        description: "Returns an empty object",
+        schema: {
+          type: "object",
+          title: "removeParticipantResponse",
+          additionalProperties: false
+        }
+      }
+    },
     createEvent: {
       name: "createEvent",
       description: "Creates a new [Event](#schema_event). When creating a new [Event](#schema_event), the required tags must be provided. See the specific integration for more details.",
@@ -426615,7 +426764,7 @@ var state = {
             },
             integrationName: {
               type: "string",
-              description: "Name of the integration to which the user creation will be delegated"
+              description: "[DEPRECATED] To create a user from within a bot, call an action of the integration instead."
             },
             name: {
               type: "string",
@@ -426754,7 +426903,7 @@ var state = {
             },
             integrationName: {
               type: "string",
-              description: "Name of the integration to which the user creation will be delegated"
+              description: "[DEPRECATED] To create a user from within a bot, call an action of the integration instead."
             },
             name: {
               type: "string",
@@ -429007,7 +429156,8 @@ var state = {
             "workspace_member_count",
             "integrations_owned_count",
             "cognitive_calls",
-            "model_credit"
+            "model_credit",
+            "token_spend"
           ],
           required: true
         },
@@ -429066,7 +429216,8 @@ var state = {
             "workspace_member_count",
             "integrations_owned_count",
             "cognitive_calls",
-            "model_credit"
+            "model_credit",
+            "token_spend"
           ],
           required: true
         },
@@ -429106,7 +429257,8 @@ var state = {
                     "workspace_member_count",
                     "integrations_owned_count",
                     "cognitive_calls",
-                    "model_credit"
+                    "model_credit",
+                    "token_spend"
                   ],
                   description: "Usage type that can be used"
                 }
@@ -429174,7 +429326,8 @@ var state = {
                       "workspace_member_count",
                       "integrations_owned_count",
                       "cognitive_calls",
-                      "model_credit"
+                      "model_credit",
+                      "token_spend"
                     ],
                     description: "Usage type that can be used"
                   }
@@ -430774,7 +430927,8 @@ var state = {
             "workspace_member_count",
             "integrations_owned_count",
             "cognitive_calls",
-            "model_credit"
+            "model_credit",
+            "token_spend"
           ],
           required: true
         },
@@ -430826,7 +430980,8 @@ var state = {
             "workspace_member_count",
             "integrations_owned_count",
             "cognitive_calls",
-            "model_credit"
+            "model_credit",
+            "token_spend"
           ],
           required: true
         },
@@ -431072,7 +431227,7 @@ var state = {
     title: "Botpress API",
     description: "API for Botpress Cloud",
     server: "https://api.botpress.cloud",
-    version: "0.12.6",
+    version: "0.13.1",
     prefix: "v1"
   },
   errors: [
@@ -431188,6 +431343,7 @@ var state = {
       createConversationBody: true,
       getOrCreateConversationBody: true,
       updateConversationBody: true,
+      addParticipantBody: true,
       createEventBody: true,
       createMessageBody: true,
       getOrCreateMessageBody: true,
@@ -431222,6 +431378,10 @@ var state = {
       getOrCreateConversationResponse: true,
       updateConversationResponse: true,
       deleteConversationResponse: true,
+      listParticipantsResponse: true,
+      addParticipantResponse: true,
+      getParticipantResponse: true,
+      removeParticipantResponse: true,
       createEventResponse: true,
       getEventResponse: true,
       listEventsResponse: true,
@@ -432170,7 +432330,8 @@ var state = {
               "workspace_member_count",
               "integrations_owned_count",
               "cognitive_calls",
-              "model_credit"
+              "model_credit",
+              "token_spend"
             ],
             description: "Usage type that can be used"
           }
@@ -432591,7 +432752,11 @@ var state = {
         "listConversations",
         "getOrCreateConversation",
         "updateConversation",
-        "deleteConversation"
+        "deleteConversation",
+        "listParticipants",
+        "addParticipant",
+        "getParticipant",
+        "removeParticipant"
       ],
       schema: "Conversation"
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/api",
-  "version": "0.12.6",
+  "version": "0.13.1",
   "main": "dist/index.js",
   "types": "dist/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"],"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"},{"description":"","title":"Hub","name":"hub","operations":["listPublicIntegrations","getPublicIntegrationById","getPublicIntegration"]},{"description":"","title":"Action","name":"action","operations":["callAction"]},{"description":"","title":"Bot","name":"bot","operations":["createBot","updateBot","transferBot","listBots","getBot","deleteBot","getBotLogs","getBotWebchat","getBotAnalytics","listBotIssues","deleteBotIssue","listBotIssueEvents"],"schema":"Bot"},{"description":"","title":"Integration","name":"integration","operations":["createIntegration","updateIntegration","listIntegrations","getIntegration","getIntegrationLogs","getIntegrationByName","deleteIntegration"],"schema":"Integration"},{"description":"","title":"Workspace","name":"workspace","operations":["getWorkspaceBillingDetails","setWorkspacePaymentMethod","listWorkspaceInvoices","chargeWorkspaceUnpaidInvoices","createWorkspace","getWorkspace","listWorkspaceUsages","getWorkspaceQuota","listWorkspaceQuotas","updateWorkspace","listWorkspaces","changeWorkspacePlan","deleteWorkspace","getAuditRecords"],"schema":"Workspace"},{"description":"","title":"Workspace Member","name":"workspaceMember","operations":["listWorkspaceMembers","deleteWorkspaceMember","createWorkspaceMember","updateWorkspaceMember"],"schema":"WorkspaceMember"},{"description":"","title":"Account","name":"account","operations":["getAccount","listPersonalAccessTokens","createPersonalAccessToken","deletePersonalAccessToken"],"schema":"Account"},{"description":"","title":"Usage","name":"usage","operations":["getUsage"],"schema":"Usage"}],"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","patchState"],"schema":"State"},{"description":"","title":"Hub","name":"hub","operations":["listPublicIntegrations","getPublicIntegrationById","getPublicIntegration"]},{"description":"","title":"Action","name":"action","operations":["callAction"]},{"description":"","title":"Bot","name":"bot","operations":["createBot","updateBot","transferBot","listBots","getBot","deleteBot","getBotLogs","getBotWebchat","getBotAnalytics","listBotIssues","deleteBotIssue","listBotIssueEvents"],"schema":"Bot"},{"description":"","title":"Integration","name":"integration","operations":["createIntegration","updateIntegration","listIntegrations","getIntegration","getIntegrationLogs","getIntegrationByName","deleteIntegration"],"schema":"Integration"},{"description":"","title":"Workspace","name":"workspace","operations":["getWorkspaceBillingDetails","setWorkspacePaymentMethod","listWorkspaceInvoices","chargeWorkspaceUnpaidInvoices","createWorkspace","getWorkspace","listWorkspaceUsages","getWorkspaceQuota","listWorkspaceQuotas","updateWorkspace","listWorkspaces","changeWorkspacePlan","deleteWorkspace","getAuditRecords"],"schema":"Workspace"},{"description":"","title":"Workspace Member","name":"workspaceMember","operations":["listWorkspaceMembers","deleteWorkspaceMember","createWorkspaceMember","updateWorkspaceMember"],"schema":"WorkspaceMember"},{"description":"","title":"Account","name":"account","operations":["getAccount","listPersonalAccessTokens","createPersonalAccessToken","deletePersonalAccessToken"],"schema":"Account"},{"description":"","title":"Usage","name":"usage","operations":["getUsage"],"schema":"Usage"}],"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."}]}