@botpress/api 0.10.0 → 0.11.0

package/dist/index.js

@@ -428180,16 +428180,32 @@ var state = {
                     description: "ISO 8601 date string of the end (exclusive) of the period"
                   },
                   returningUsers: {
-                    type: "number"
+                    type: "integer"
                   },
                   newUsers: {
-                    type: "number"
+                    type: "integer"
                   },
                   sessions: {
-                    type: "number"
+                    type: "integer"
                   },
                   messages: {
-                    type: "number"
+                    type: "integer",
+                    description: "Deprecated. Use `userMessages` instead."
+                  },
+                  userMessages: {
+                    type: "integer"
+                  },
+                  botMessages: {
+                    type: "integer"
+                  },
+                  events: {
+                    type: "integer"
+                  },
+                  eventTypes: {
+                    type: "object",
+                    additionalProperties: {
+                      type: "number"
+                    }
                   }
                 },
                 required: [
@@ -428198,7 +428214,11 @@ var state = {
                   "returningUsers",
                   "newUsers",
                   "sessions",
-                  "messages"
+                  "messages",
+                  "userMessages",
+                  "botMessages",
+                  "events",
+                  "eventTypes"
                 ]
               }
             }
@@ -428381,6 +428401,356 @@ var state = {
         }
       }
     },
+    getWorkspaceBillingDetails: {
+      name: "getWorkspaceBillingDetails",
+      description: "Get billing details of workspace",
+      method: "get",
+      path: "/v1/admin/workspaces/{id}/billing/details",
+      disableDefaultParameters: {
+        "x-workspace-id": true
+      },
+      parameters: {
+        id: {
+          type: "string",
+          description: "Workspace ID",
+          in: "path"
+        }
+      },
+      section: "workspace",
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            currentPeriod: {
+              type: "object",
+              properties: {
+                start: {
+                  type: "string"
+                },
+                end: {
+                  type: "string"
+                },
+                usage: {
+                  type: "object",
+                  properties: {
+                    userMessages: {
+                      type: "object",
+                      properties: {
+                        status: {
+                          type: "string",
+                          enum: ["OK", "Warning", "LimitReached"]
+                        },
+                        quantity: {
+                          type: "number"
+                        },
+                        price: {
+                          type: "number"
+                        },
+                        minimum: {
+                          type: "number"
+                        },
+                        maximum: {
+                          type: "number"
+                        }
+                      },
+                      required: [
+                        "status",
+                        "quantity",
+                        "price",
+                        "minimum",
+                        "maximum"
+                      ],
+                      additionalProperties: false
+                    }
+                  },
+                  required: ["userMessages"],
+                  additionalProperties: false
+                }
+              },
+              required: ["start", "end", "usage"],
+              additionalProperties: false
+            },
+            paymentMethod: {
+              type: "object",
+              properties: {
+                type: {
+                  type: "string"
+                },
+                lastDigits: {
+                  type: "string"
+                }
+              },
+              required: ["type", "lastDigits"],
+              nullable: true,
+              additionalProperties: false
+            }
+          },
+          required: ["currentPeriod", "paymentMethod"],
+          title: "getWorkspaceBillingDetailsResponse",
+          additionalProperties: false
+        }
+      }
+    },
+    setWorkspacePaymentMethod: {
+      name: "setWorkspacePaymentMethod",
+      description: "Set the Stripe PaymentMethod to use for billing the workspace. To create a PaymentMethod, use the Stripe API or SDK with our Stripe Publishable Key which is listed in this documentation.",
+      method: "put",
+      path: "/v1/admin/workspaces/{id}/billing/payment-method",
+      disableDefaultParameters: {
+        "x-workspace-id": true
+      },
+      parameters: {
+        id: {
+          type: "string",
+          description: "Workspace ID",
+          in: "path"
+        }
+      },
+      section: "workspace",
+      requestBody: {
+        description: "",
+        schema: {
+          type: "object",
+          properties: {
+            stripePaymentMethodId: {
+              type: "string",
+              description: "ID of the Stripe PaymentMethod to attach to the workspace."
+            }
+          },
+          required: ["stripePaymentMethodId"],
+          title: "setWorkspacePaymentMethodBody",
+          additionalProperties: false
+        }
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            stripePaymentMethodId: {
+              type: "string"
+            },
+            paymentMethod: {
+              type: "object",
+              properties: {
+                type: {
+                  type: "string"
+                },
+                lastDigits: {
+                  type: "string"
+                }
+              },
+              required: ["type", "lastDigits"],
+              nullable: true,
+              additionalProperties: false
+            },
+            status: {
+              type: "string",
+              enum: [
+                "succeeded",
+                "processing",
+                "canceled",
+                "requires_confirmation",
+                "requires_action",
+                "requires_payment_method"
+              ]
+            },
+            nextAction: {
+              type: "object",
+              properties: {
+                redirectToUrl: {
+                  type: "string",
+                  format: "uri"
+                }
+              },
+              required: ["redirectToUrl"],
+              description: "If the payment needs to be confirmed, this will contain a URL to redirect the user to so they can complete the verification process to confirm it.",
+              additionalProperties: false
+            }
+          },
+          required: ["stripePaymentMethodId", "paymentMethod", "status"],
+          title: "setWorkspacePaymentMethodResponse",
+          additionalProperties: false
+        }
+      }
+    },
+    listWorkspaceInvoices: {
+      name: "listWorkspaceInvoices",
+      description: "List invoices billed to workspace",
+      method: "get",
+      path: "/v1/admin/workspaces/{id}/billing/invoices",
+      disableDefaultParameters: {
+        "x-workspace-id": true
+      },
+      parameters: {
+        id: {
+          type: "string",
+          description: "Workspace ID",
+          in: "path"
+        }
+      },
+      section: "workspace",
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            invoices: {
+              type: "array",
+              items: {
+                type: "object",
+                properties: {
+                  id: {
+                    type: "string"
+                  },
+                  period: {
+                    type: "object",
+                    properties: {
+                      month: {
+                        type: "number"
+                      },
+                      year: {
+                        type: "number"
+                      }
+                    },
+                    required: ["month", "year"]
+                  },
+                  date: {
+                    type: "string",
+                    format: "date-time",
+                    description: "Date on which the invoice was generated."
+                  },
+                  amount: {
+                    type: "number",
+                    description: "Total amount to pay of the invoice."
+                  },
+                  currency: {
+                    type: "string",
+                    maxLength: 3,
+                    description: "Currency of the invoice amount."
+                  },
+                  paymentStatus: {
+                    type: "string",
+                    enum: ["paid", "unpaid"]
+                  },
+                  paymentAttemptCount: {
+                    type: "number",
+                    description: "Number of times payment has been unsuccessfully attempted on the invoice.",
+                    nullable: true
+                  },
+                  nextPaymentAttemptDate: {
+                    type: "string",
+                    format: "date-time",
+                    description: "Date on which the next payment attempt will be made.",
+                    nullable: true
+                  },
+                  pdfUrl: {
+                    type: "string",
+                    format: "uri",
+                    description: "URL to download the PDF file of the invoice."
+                  }
+                },
+                required: [
+                  "id",
+                  "period",
+                  "date",
+                  "amount",
+                  "currency",
+                  "paymentStatus",
+                  "paymentAttemptCount",
+                  "nextPaymentAttemptDate",
+                  "pdfUrl"
+                ]
+              }
+            }
+          },
+          required: ["invoices"],
+          title: "listWorkspaceInvoicesResponse",
+          additionalProperties: false
+        }
+      }
+    },
+    chargeWorkspaceUnpaidInvoices: {
+      name: "chargeWorkspaceUnpaidInvoices",
+      description: "Charge unpaid invoices of a workspace.",
+      method: "post",
+      path: "/v1/admin/workspaces/{id}/billing/invoices/charge-unpaid",
+      disableDefaultParameters: {
+        "x-workspace-id": true
+      },
+      parameters: {
+        id: {
+          type: "string",
+          description: "Workspace ID",
+          in: "path"
+        }
+      },
+      section: "workspace",
+      requestBody: {
+        description: "",
+        schema: {
+          type: "object",
+          properties: {
+            invoiceIds: {
+              type: "array",
+              items: {
+                type: "string"
+              },
+              minItems: 1
+            }
+          },
+          title: "chargeWorkspaceUnpaidInvoicesBody",
+          additionalProperties: false
+        }
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            chargedInvoices: {
+              type: "array",
+              items: {
+                type: "object",
+                properties: {
+                  id: {
+                    type: "string"
+                  },
+                  amount: {
+                    type: "number"
+                  }
+                },
+                required: ["id", "amount"]
+              },
+              description: "Invoices that were successfully charged by this request."
+            },
+            failedInvoices: {
+              type: "array",
+              items: {
+                type: "object",
+                properties: {
+                  id: {
+                    type: "string"
+                  },
+                  amount: {
+                    type: "number"
+                  },
+                  failedReason: {
+                    type: "string"
+                  }
+                },
+                required: ["id", "amount", "failedReason"]
+              },
+              description: "Invoices that failed to be charged by this request."
+            }
+          },
+          required: ["chargedInvoices", "failedInvoices"],
+          title: "chargeWorkspaceUnpaidInvoicesResponse",
+          additionalProperties: false
+        }
+      }
+    },
     createWorkspace: {
       name: "createWorkspace",
       description: "Create workspace",
@@ -428549,7 +428919,9 @@ var state = {
             "bot_ratelimit",
             "table_row_count",
             "workspace_member_count",
-            "integrations_owned_count"
+            "integrations_owned_count",
+            "cognitive_calls",
+            "model_credit"
           ],
           required: true
         },
@@ -428606,7 +428978,9 @@ var state = {
             "bot_ratelimit",
             "table_row_count",
             "workspace_member_count",
-            "integrations_owned_count"
+            "integrations_owned_count",
+            "cognitive_calls",
+            "model_credit"
           ],
           required: true
         },
@@ -428644,7 +429018,9 @@ var state = {
                     "bot_ratelimit",
                     "table_row_count",
                     "workspace_member_count",
-                    "integrations_owned_count"
+                    "integrations_owned_count",
+                    "cognitive_calls",
+                    "model_credit"
                   ],
                   description: "Usage type that can be used"
                 }
@@ -428710,7 +429086,9 @@ var state = {
                       "bot_ratelimit",
                       "table_row_count",
                       "workspace_member_count",
-                      "integrations_owned_count"
+                      "integrations_owned_count",
+                      "cognitive_calls",
+                      "model_credit"
                     ],
                     description: "Usage type that can be used"
                   }
@@ -430246,7 +430624,9 @@ var state = {
             "bot_ratelimit",
             "table_row_count",
             "workspace_member_count",
-            "integrations_owned_count"
+            "integrations_owned_count",
+            "cognitive_calls",
+            "model_credit"
           ],
           required: true
         },
@@ -430296,7 +430676,9 @@ var state = {
             "bot_ratelimit",
             "table_row_count",
             "workspace_member_count",
-            "integrations_owned_count"
+            "integrations_owned_count",
+            "cognitive_calls",
+            "model_credit"
           ],
           required: true
         },
@@ -430542,7 +430924,7 @@ var state = {
     title: "Botpress API",
     description: "API for Botpress Cloud",
     server: "https://api.botpress.cloud",
-    version: "0.10.0",
+    version: "0.11.0",
     prefix: "v1"
   },
   errors: [
@@ -430673,6 +431055,8 @@ var state = {
       createBotBody: true,
       updateBotBody: true,
       transferBotBody: true,
+      setWorkspacePaymentMethodBody: true,
+      chargeWorkspaceUnpaidInvoicesBody: true,
       createWorkspaceBody: true,
       updateWorkspaceBody: true,
       changeWorkspacePlanBody: true,
@@ -430729,6 +431113,10 @@ var state = {
       listBotIssuesResponse: true,
       deleteBotIssueResponse: true,
       listBotIssueEventsResponse: true,
+      getWorkspaceBillingDetailsResponse: true,
+      setWorkspacePaymentMethodResponse: true,
+      listWorkspaceInvoicesResponse: true,
+      chargeWorkspaceUnpaidInvoicesResponse: true,
       createWorkspaceResponse: true,
       getWorkspaceResponse: true,
       listWorkspaceUsagesResponse: true,
@@ -430820,6 +431208,9 @@ var state = {
                 webhookUrl: {
                   type: "string"
                 },
+                webhookId: {
+                  type: "string"
+                },
                 configuration: {
                   type: "object",
                   additionalProperties: true
@@ -430874,6 +431265,7 @@ var state = {
                 "name",
                 "version",
                 "webhookUrl",
+                "webhookId",
                 "configuration",
                 "status",
                 "statusReason",
@@ -431590,7 +431982,9 @@ var state = {
               "bot_ratelimit",
               "table_row_count",
               "workspace_member_count",
-              "integrations_owned_count"
+              "integrations_owned_count",
+              "cognitive_calls",
+              "model_credit"
             ],
             description: "Usage type that can be used"
           }
@@ -432068,6 +432462,10 @@ var state = {
       title: "Workspace",
       name: "workspace",
       operations: [
+        "getWorkspaceBillingDetails",
+        "setWorkspacePaymentMethod",
+        "listWorkspaceInvoices",
+        "chargeWorkspaceUnpaidInvoices",
         "createWorkspace",
         "getWorkspace",
         "listWorkspaceUsages",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/api",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "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":["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"],"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."}]}