@botpress/api 0.9.0 → 0.11.0

package/dist/index.js

@@ -427321,7 +427321,7 @@ var state = {
       parameters: {
         id: {
           type: "string",
-          description: "Integration Id",
+          description: "Integration ID",
           in: "path"
         }
       },
@@ -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"
                 ]
               }
             }
@@ -428209,6 +428229,528 @@ var state = {
         }
       }
     },
+    listBotIssues: {
+      name: "listBotIssues",
+      description: "List Bot Issues",
+      method: "get",
+      path: "/v1/admin/bots/{id}/issues",
+      section: "bot",
+      parameters: {
+        id: {
+          type: "string",
+          description: "Bot ID",
+          in: "path"
+        },
+        nextToken: {
+          in: "query",
+          description: "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
+          type: "string"
+        }
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            issues: {
+              type: "array",
+              items: {
+                type: "object",
+                properties: {
+                  id: {
+                    type: "string"
+                  },
+                  code: {
+                    type: "string"
+                  },
+                  createdAt: {
+                    type: "string",
+                    format: "date-time"
+                  },
+                  lastSeenAt: {
+                    type: "string",
+                    format: "date-time"
+                  },
+                  title: {
+                    type: "string"
+                  },
+                  description: {
+                    type: "string"
+                  },
+                  groupedData: {
+                    type: "object",
+                    properties: {}
+                  },
+                  eventsCount: {
+                    type: "number"
+                  },
+                  category: {
+                    type: "string",
+                    enum: ["user_code", "limits", "configuration", "other"]
+                  },
+                  resolutionLink: {
+                    type: "string",
+                    nullable: true
+                  }
+                },
+                required: [
+                  "id",
+                  "code",
+                  "createdAt",
+                  "lastSeenAt",
+                  "title",
+                  "description",
+                  "groupedData",
+                  "eventsCount",
+                  "category",
+                  "resolutionLink"
+                ]
+              }
+            },
+            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: ["issues", "meta"],
+          title: "listBotIssuesResponse",
+          additionalProperties: false
+        }
+      }
+    },
+    deleteBotIssue: {
+      name: "deleteBotIssue",
+      description: "Delete Bot Issue",
+      method: "delete",
+      path: "/v1/admin/bots/{id}/issues/{issueId}",
+      section: "bot",
+      parameters: {
+        id: {
+          type: "string",
+          description: "Bot ID",
+          in: "path"
+        },
+        issueId: {
+          in: "path",
+          description: "Issue ID",
+          type: "string"
+        }
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          title: "deleteBotIssueResponse",
+          additionalProperties: false
+        }
+      }
+    },
+    listBotIssueEvents: {
+      name: "listBotIssueEvents",
+      description: "List Events for a Bot Issue",
+      method: "get",
+      path: "/v1/admin/bots/{id}/issues/{issueId}/events",
+      section: "bot",
+      parameters: {
+        id: {
+          type: "string",
+          description: "Bot ID",
+          in: "path"
+        },
+        issueId: {
+          in: "path",
+          description: "Issue ID",
+          type: "string"
+        }
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            issueEvents: {
+              type: "array",
+              items: {
+                type: "object",
+                properties: {
+                  id: {
+                    type: "string"
+                  },
+                  createdAt: {
+                    type: "string",
+                    format: "date-time"
+                  },
+                  data: {
+                    type: "object",
+                    properties: {}
+                  }
+                },
+                required: ["id", "createdAt", "data"]
+              }
+            }
+          },
+          required: ["issueEvents"],
+          title: "listBotIssueEventsResponse",
+          additionalProperties: false
+        }
+      }
+    },
+    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",
@@ -428377,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
         },
@@ -428434,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
         },
@@ -428472,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"
                 }
@@ -428538,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"
                   }
@@ -429491,7 +430041,7 @@ var state = {
       parameters: {
         id: {
           type: "string",
-          description: "Integration Id",
+          description: "Integration ID",
           in: "path"
         }
       },
@@ -429916,7 +430466,7 @@ var state = {
       parameters: {
         id: {
           type: "string",
-          description: "Integration Id",
+          description: "Integration ID",
           in: "path"
         }
       },
@@ -429944,7 +430494,7 @@ var state = {
       parameters: {
         id: {
           type: "string",
-          description: "Integration Id",
+          description: "Integration ID",
           in: "path"
         },
         timeStart: {
@@ -430041,7 +430591,7 @@ var state = {
       parameters: {
         id: {
           type: "string",
-          description: "Integration Id",
+          description: "Integration ID",
           in: "path"
         }
       },
@@ -430074,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
         },
@@ -430124,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
         },
@@ -430370,7 +430924,7 @@ var state = {
     title: "Botpress API",
     description: "API for Botpress Cloud",
     server: "https://api.botpress.cloud",
-    version: "0.9.0",
+    version: "0.11.0",
     prefix: "v1"
   },
   errors: [
@@ -430501,6 +431055,8 @@ var state = {
       createBotBody: true,
       updateBotBody: true,
       transferBotBody: true,
+      setWorkspacePaymentMethodBody: true,
+      chargeWorkspaceUnpaidInvoicesBody: true,
       createWorkspaceBody: true,
       updateWorkspaceBody: true,
       changeWorkspacePlanBody: true,
@@ -430554,6 +431110,13 @@ var state = {
       getBotLogsResponse: true,
       getBotWebchatResponse: true,
       getBotAnalyticsResponse: true,
+      listBotIssuesResponse: true,
+      deleteBotIssueResponse: true,
+      listBotIssueEventsResponse: true,
+      getWorkspaceBillingDetailsResponse: true,
+      setWorkspacePaymentMethodResponse: true,
+      listWorkspaceInvoicesResponse: true,
+      chargeWorkspaceUnpaidInvoicesResponse: true,
       createWorkspaceResponse: true,
       getWorkspaceResponse: true,
       listWorkspaceUsagesResponse: true,
@@ -430591,6 +431154,8 @@ var state = {
       WorkspaceMember: true,
       Account: true,
       Usage: true,
+      Issue: true,
+      IssueEvent: true,
       User: true,
       Conversation: true,
       Event: true,
@@ -430643,6 +431208,9 @@ var state = {
                 webhookUrl: {
                   type: "string"
                 },
+                webhookId: {
+                  type: "string"
+                },
                 configuration: {
                   type: "object",
                   additionalProperties: true
@@ -430697,6 +431265,7 @@ var state = {
                 "name",
                 "version",
                 "webhookUrl",
+                "webhookId",
                 "configuration",
                 "status",
                 "statusReason",
@@ -431413,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"
           }
@@ -431422,6 +431993,83 @@ var state = {
         additionalProperties: false
       }
     },
+    Issue: {
+      section: "bot",
+      schema: {
+        type: "object",
+        properties: {
+          id: {
+            type: "string"
+          },
+          code: {
+            type: "string"
+          },
+          createdAt: {
+            type: "string",
+            format: "date-time"
+          },
+          lastSeenAt: {
+            type: "string",
+            format: "date-time"
+          },
+          title: {
+            type: "string"
+          },
+          description: {
+            type: "string"
+          },
+          groupedData: {
+            type: "object",
+            additionalProperties: false
+          },
+          eventsCount: {
+            type: "number"
+          },
+          category: {
+            type: "string",
+            enum: ["user_code", "limits", "configuration", "other"]
+          },
+          resolutionLink: {
+            type: "string",
+            nullable: true
+          }
+        },
+        required: [
+          "id",
+          "code",
+          "createdAt",
+          "lastSeenAt",
+          "title",
+          "description",
+          "groupedData",
+          "eventsCount",
+          "category",
+          "resolutionLink"
+        ],
+        additionalProperties: false
+      }
+    },
+    IssueEvent: {
+      section: "bot",
+      schema: {
+        type: "object",
+        properties: {
+          id: {
+            type: "string"
+          },
+          createdAt: {
+            type: "string",
+            format: "date-time"
+          },
+          data: {
+            type: "object",
+            additionalProperties: false
+          }
+        },
+        required: ["id", "createdAt", "data"],
+        additionalProperties: false
+      }
+    },
     User: {
       section: "user",
       schema: {
@@ -431787,7 +432435,10 @@ var state = {
         "deleteBot",
         "getBotLogs",
         "getBotWebchat",
-        "getBotAnalytics"
+        "getBotAnalytics",
+        "listBotIssues",
+        "deleteBotIssue",
+        "listBotIssueEvents"
       ],
       schema: "Bot"
     },
@@ -431811,6 +432462,10 @@ var state = {
       title: "Workspace",
       name: "workspace",
       operations: [
+        "getWorkspaceBillingDetails",
+        "setWorkspacePaymentMethod",
+        "listWorkspaceInvoices",
+        "chargeWorkspaceUnpaidInvoices",
         "createWorkspace",
         "getWorkspace",
         "listWorkspaceUsages",