@botpress/api 0.12.6 → 0.13.1

package/src/gen/state.ts

@@ -30,7 +30,7 @@ export const state = {
             integrationName: {
               type: "string",
               description:
-                "Name of the integration to which the conversation creation will be delegated",
+                "[DEPRECATED] To create a conversation from within a bot, call an action of the integration instead.",
             },
           },
           required: ["channel", "tags"],
@@ -174,7 +174,7 @@ export const state = {
             integrationName: {
               type: "string",
               description:
-                "Name of the integration to which the conversation creation will be delegated",
+                "[DEPRECATED] To create a conversation from within a bot, call an action of the integration instead.",
             },
           },
           required: ["channel", "tags"],
@@ -272,6 +272,162 @@ export const 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:
@@ -791,7 +947,7 @@ export const state = {
             integrationName: {
               type: "string",
               description:
-                "Name of the integration to which the user creation will be delegated",
+                "[DEPRECATED] To create a user from within a bot, call an action of the integration instead.",
             },
             name: {
               type: "string",
@@ -939,7 +1095,7 @@ export const state = {
             integrationName: {
               type: "string",
               description:
-                "Name of the integration to which the user creation will be delegated",
+                "[DEPRECATED] To create a user from within a bot, call an action of the integration instead.",
             },
             name: {
               type: "string",
@@ -3258,6 +3414,7 @@ export const state = {
             "integrations_owned_count",
             "cognitive_calls",
             "model_credit",
+            "token_spend",
           ],
           required: true,
         },
@@ -3317,6 +3474,7 @@ export const state = {
             "integrations_owned_count",
             "cognitive_calls",
             "model_credit",
+            "token_spend",
           ],
           required: true,
         },
@@ -3357,6 +3515,7 @@ export const state = {
                     "integrations_owned_count",
                     "cognitive_calls",
                     "model_credit",
+                    "token_spend",
                   ],
                   description: "Usage type that can be used",
                 },
@@ -3425,6 +3584,7 @@ export const state = {
                       "integrations_owned_count",
                       "cognitive_calls",
                       "model_credit",
+                      "token_spend",
                     ],
                     description: "Usage type that can be used",
                   },
@@ -5074,6 +5234,7 @@ export const state = {
             "integrations_owned_count",
             "cognitive_calls",
             "model_credit",
+            "token_spend",
           ],
           required: true,
         },
@@ -5126,6 +5287,7 @@ export const state = {
             "integrations_owned_count",
             "cognitive_calls",
             "model_credit",
+            "token_spend",
           ],
           required: true,
         },
@@ -5374,7 +5536,7 @@ export const 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: [
@@ -5499,6 +5661,7 @@ export const state = {
       createConversationBody: true,
       getOrCreateConversationBody: true,
       updateConversationBody: true,
+      addParticipantBody: true,
       createEventBody: true,
       createMessageBody: true,
       getOrCreateMessageBody: true,
@@ -5533,6 +5696,10 @@ export const state = {
       getOrCreateConversationResponse: true,
       updateConversationResponse: true,
       deleteConversationResponse: true,
+      listParticipantsResponse: true,
+      addParticipantResponse: true,
+      getParticipantResponse: true,
+      removeParticipantResponse: true,
       createEventResponse: true,
       getEventResponse: true,
       listEventsResponse: true,
@@ -6522,6 +6689,7 @@ export const state = {
               "integrations_owned_count",
               "cognitive_calls",
               "model_credit",
+              "token_spend",
             ],
             description: "Usage type that can be used",
           },
@@ -6971,6 +7139,10 @@ export const state = {
         "getOrCreateConversation",
         "updateConversation",
         "deleteConversation",
+        "listParticipants",
+        "addParticipant",
+        "getParticipant",
+        "removeParticipant",
       ],
       schema: "Conversation",
     },