@botpress/api 0.12.5 → 0.13.0

package/src/gen/state.ts

@@ -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:
@@ -1502,7 +1658,7 @@ export const state = {
                 properties: {
                   id: {
                     type: "string",
-                    description: "Id of the [Integration](#schema_integration)",
+                    description: "ID of the [Integration](#schema_integration)",
                   },
                   name: {
                     type: "string",
@@ -4202,6 +4358,9 @@ export const state = {
             identifier: {
               type: "object",
               properties: {
+                fallbackHandlerScript: {
+                  type: "string",
+                },
                 extractScript: {
                   type: "string",
                 },
@@ -4588,6 +4747,10 @@ export const state = {
                   type: "string",
                   nullable: true,
                 },
+                fallbackHandlerScript: {
+                  type: "string",
+                  nullable: true,
+                },
               },
               additionalProperties: false,
             },
@@ -4823,7 +4986,7 @@ export const state = {
                 properties: {
                   id: {
                     type: "string",
-                    description: "Id of the [Integration](#schema_integration)",
+                    description: "ID of the [Integration](#schema_integration)",
                   },
                   name: {
                     type: "string",
@@ -5367,7 +5530,7 @@ export const state = {
     title: "Botpress API",
     description: "API for Botpress Cloud",
     server: "https://api.botpress.cloud",
-    version: "0.12.5",
+    version: "0.13.0",
     prefix: "v1",
   },
   errors: [
@@ -5492,6 +5655,7 @@ export const state = {
       createConversationBody: true,
       getOrCreateConversationBody: true,
       updateConversationBody: true,
+      addParticipantBody: true,
       createEventBody: true,
       createMessageBody: true,
       getOrCreateMessageBody: true,
@@ -5526,6 +5690,10 @@ export const state = {
       getOrCreateConversationResponse: true,
       updateConversationResponse: true,
       deleteConversationResponse: true,
+      listParticipantsResponse: true,
+      addParticipantResponse: true,
+      getParticipantResponse: true,
+      removeParticipantResponse: true,
       createEventResponse: true,
       getEventResponse: true,
       listEventsResponse: true,
@@ -5690,7 +5858,7 @@ export const state = {
                 },
                 id: {
                   type: "string",
-                  description: "Id of the [Integration](#schema_integration)",
+                  description: "ID of the [Integration](#schema_integration)",
                 },
                 createdAt: {
                   type: "string",
@@ -5997,7 +6165,7 @@ export const state = {
         properties: {
           id: {
             type: "string",
-            description: "Id of the [Integration](#schema_integration)",
+            description: "ID of the [Integration](#schema_integration)",
           },
           createdAt: {
             type: "string",
@@ -6014,6 +6182,11 @@ export const state = {
           identifier: {
             type: "object",
             properties: {
+              fallbackHandlerScript: {
+                type: "string",
+                description:
+                  "VRL Script of the [Integration](#schema_integration) to handle incoming requests for a request that doesn't have an identifier",
+              },
               extractScript: {
                 type: "string",
                 description:
@@ -6959,6 +7132,10 @@ export const state = {
         "getOrCreateConversation",
         "updateConversation",
         "deleteConversation",
+        "listParticipants",
+        "addParticipant",
+        "getParticipant",
+        "removeParticipant",
       ],
       schema: "Conversation",
     },