@botpress/api 0.18.4 → 0.19.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.js CHANGED
@@ -259140,7 +259140,7 @@ __export(src_exports, {
259140
259140
  });
259141
259141
  module.exports = __toCommonJS(src_exports);
259142
259142
 
259143
- // ../../node_modules/.pnpm/@bpinternal+opapi@0.7.10_openapi-types@12.1.3/node_modules/@bpinternal/opapi/dist/index.mjs
259143
+ // ../../node_modules/.pnpm/@bpinternal+opapi@0.8.0_openapi-types@12.1.3/node_modules/@bpinternal/opapi/dist/index.mjs
259144
259144
  var import_zod_openapi = __toESM(require_src(), 1);
259145
259145
  var import_zod_openapi2 = __toESM(require_src(), 1);
259146
259146
  var import_chalk = __toESM(require_source(), 1);
@@ -259184,7 +259184,7 @@ var title = (str2) => {
259184
259184
  return str2.split(/(?=[A-Z])|[\.\-\s_]/).map((s) => s.trim()).filter((s) => !!s).map((s) => capitalize(s.toLowerCase())).join(" ");
259185
259185
  };
259186
259186
 
259187
- // ../../node_modules/.pnpm/@bpinternal+opapi@0.7.10_openapi-types@12.1.3/node_modules/@bpinternal/opapi/dist/index.mjs
259187
+ // ../../node_modules/.pnpm/@bpinternal+opapi@0.8.0_openapi-types@12.1.3/node_modules/@bpinternal/opapi/dist/index.mjs
259188
259188
  var import_decompress = __toESM(require_decompress(), 1);
259189
259189
  var import_fs2 = __toESM(require("fs"), 1);
259190
259190
  var import_promises = __toESM(require("fs/promises"), 1);
@@ -266418,7 +266418,7 @@ async function openapiTS(schema3, options = {}) {
266418
266418
  }
266419
266419
  var dist_default = openapiTS;
266420
266420
 
266421
- // ../../node_modules/.pnpm/@bpinternal+opapi@0.7.10_openapi-types@12.1.3/node_modules/@bpinternal/opapi/dist/index.mjs
266421
+ // ../../node_modules/.pnpm/@bpinternal+opapi@0.8.0_openapi-types@12.1.3/node_modules/@bpinternal/opapi/dist/index.mjs
266422
266422
  var import_zod_openapi3 = __toESM(require_src(), 1);
266423
266423
  var import_openapi3_ts = __toESM(require_dist3(), 1);
266424
266424
  var import_verror2 = __toESM(require_verror(), 1);
@@ -270060,7 +270060,7 @@ var z = /* @__PURE__ */ Object.freeze({
270060
270060
  ZodError
270061
270061
  });
270062
270062
 
270063
- // ../../node_modules/.pnpm/@bpinternal+opapi@0.7.10_openapi-types@12.1.3/node_modules/@bpinternal/opapi/dist/index.mjs
270063
+ // ../../node_modules/.pnpm/@bpinternal+opapi@0.8.0_openapi-types@12.1.3/node_modules/@bpinternal/opapi/dist/index.mjs
270064
270064
  var import_openapi_parser = __toESM(require_lib10(), 1);
270065
270065
  var import_json_schema_to_typescript = __toESM(require_src3(), 1);
270066
270066
  var import_zod_openapi4 = __toESM(require_src(), 1);
@@ -270165,16 +270165,17 @@ ${generateParameterFields(props)}
270165
270165
  res.status(${props.status}).json(output)
270166
270166
  }
270167
270167
  `;
270168
- var generateBodyField = (operationName) => ` ...req.body as NonNullable<components['requestBodies']['${operationName}Body']>['content']['application/json'],`;
270168
+ var generateBodyField = (operationName, contentType) => ` ...req.body as NonNullable<components['requestBodies']['${operationName}Body']>['content']['${contentType}'],`;
270169
270169
  var generateParameterFields = ({
270170
270170
  cookies,
270171
270171
  headers,
270172
270172
  params,
270173
270173
  queries,
270174
270174
  body,
270175
- operationName
270175
+ operationName,
270176
+ contentType
270176
270177
  }) => [
270177
- body ? generateBodyField(operationName) : void 0,
270178
+ body ? generateBodyField(operationName, contentType) : void 0,
270178
270179
  ...cookies.map(
270179
270180
  (cookie) => generateField(cookie.name, "cookies", cookie.parameter, cookie.parameter.required !== false)
270180
270181
  ),
@@ -270379,7 +270380,10 @@ function getParameters({ params, headers, queries, cookies }) {
270379
270380
  }
270380
270381
  var typesCode = `
270381
270382
 
270382
- type RequestBody = { requestBody?: { content: { 'application/json': {} } } }
270383
+ type JsonRequestBody = { requestBody?: { content: { 'application/json': {} } } }
270384
+ type BinaryRequestBody = { requestBody?: { content: { '*/*': {} } } }
270385
+
270386
+ type RequestBody = JsonRequestBody | BinaryRequestBody
270383
270387
  type Responses = { responses: { default: { content: { 'application/json': {} } } } }
270384
270388
  type Parameters = { parameters?: {} }
270385
270389
 
@@ -270388,7 +270392,7 @@ type GetHeaderParameters<T> = T extends { header?: any } ? NonNullable<T['header
270388
270392
  type GetCookieParameters<T> = T extends { cookie?: any } ? NonNullable<T['cookie']> : {}
270389
270393
  type GetQueryParameters<T> = T extends { query?: any } ? NonNullable<T['query']> : {}
270390
270394
 
270391
- type GetRequestBody<T> = T extends RequestBody ? NonNullable<T['requestBody']>['content']['application/json'] : {}
270395
+ type GetRequestBody<T> = T extends JsonRequestBody ? NonNullable<T['requestBody']>['content']['application/json'] : T extends BinaryRequestBody ? NonNullable<T['requestBody']>['content']['*/*'] : {}
270392
270396
  type GetParameters<T> = T extends Parameters
270393
270397
  ? GetPathParameters<NonNullable<T['parameters']>> &
270394
270398
  GetHeaderParameters<NonNullable<T['parameters']>> &
@@ -270895,10 +270899,11 @@ var createOpenapi = (state2) => {
270895
270899
  };
270896
270900
  if (isOperationWithBodyProps(operationObject)) {
270897
270901
  const requestBody = operationObject.requestBody;
270902
+ const contentType = operationObject.contentType ?? "application/json";
270898
270903
  openapi.addRequestBody(bodyName, {
270899
270904
  description: requestBody.description,
270900
270905
  content: {
270901
- "application/json": {
270906
+ [contentType]: {
270902
270907
  schema: requestBody.schema
270903
270908
  }
270904
270909
  }
@@ -271338,7 +271343,8 @@ function mapOperationPropsToHandlerProps(operationName, operation) {
271338
271343
  queries: [],
271339
271344
  params: [],
271340
271345
  body: isOperationWithBodyProps(operation) ? true : false,
271341
- isEmptyBody: isOperationWithBodyProps(operation) ? schemaIsEmptyObject(operation.requestBody.schema) : true
271346
+ isEmptyBody: isOperationWithBodyProps(operation) ? schemaIsEmptyObject(operation.requestBody.schema) : true,
271347
+ contentType: isOperationWithBodyProps(operation) ? operation.contentType ?? "application/json" : "application/json"
271342
271348
  };
271343
271349
  if (operation.parameters) {
271344
271350
  (_a = Object.entries(operation.parameters)) == null ? void 0 : _a.forEach(([name, parameter]) => {
@@ -271364,7 +271370,7 @@ function mapOperationPropsToHandlerProps(operationName, operation) {
271364
271370
  return generateHandlerProps;
271365
271371
  }
271366
271372
  var addOperation = (state2, operationProps) => {
271367
- var _a, _b;
271373
+ var _a, _b, _c;
271368
271374
  const { name } = operationProps;
271369
271375
  const responseName = formatResponseName(name);
271370
271376
  const bodyName = formatBodyName(name);
@@ -271387,7 +271393,10 @@ var addOperation = (state2, operationProps) => {
271387
271393
  const response = {
271388
271394
  description: operationProps.response.description,
271389
271395
  status: operationProps.response.status,
271390
- schema: generateSchemaFromZod((0, import_zod_openapi4.extendApi)(operationProps.response.schema, { title: responseName }), state2.options)
271396
+ schema: generateSchemaFromZod(
271397
+ (0, import_zod_openapi4.extendApi)(operationProps.response.schema, { title: responseName, format: operationProps.response.format }),
271398
+ state2.options
271399
+ )
271391
271400
  };
271392
271401
  let operation;
271393
271402
  if (isOperationWithBodyProps(operationProps)) {
@@ -271399,7 +271408,10 @@ var addOperation = (state2, operationProps) => {
271399
271408
  response,
271400
271409
  requestBody: {
271401
271410
  description: operationProps.requestBody.description,
271402
- schema: generateSchemaFromZod((0, import_zod_openapi4.extendApi)(operationProps.requestBody.schema, { title: bodyName }), state2.options)
271411
+ schema: generateSchemaFromZod(
271412
+ (0, import_zod_openapi4.extendApi)(operationProps.requestBody.schema, { title: bodyName, format: (_a = operationProps.requestBody) == null ? void 0 : _a.format }),
271413
+ state2.options
271414
+ )
271403
271415
  }
271404
271416
  };
271405
271417
  } else {
@@ -271413,7 +271425,7 @@ var addOperation = (state2, operationProps) => {
271413
271425
  }
271414
271426
  validateParametersInPath(path2, parameters);
271415
271427
  state2.operations[name] = operation;
271416
- (_b = (_a = state2.sections.find((section) => section.name === operationProps.section)) == null ? void 0 : _a.operations) == null ? void 0 : _b.push(name);
271428
+ (_c = (_b = state2.sections.find((section) => section.name === operationProps.section)) == null ? void 0 : _b.operations) == null ? void 0 : _c.push(name);
271417
271429
  };
271418
271430
  function createParameters(parameters = {}, defaultParameters = {}, disableDefaultParameters = {}) {
271419
271431
  const params = parameters;
@@ -274088,6 +274100,57 @@ var state = {
274088
274100
  "description": "Subscriptions of the bot",
274089
274101
  "additionalProperties": false
274090
274102
  },
274103
+ "actions": {
274104
+ "type": "object",
274105
+ "additionalProperties": {
274106
+ "type": "object",
274107
+ "properties": {
274108
+ "title": {
274109
+ "type": "string",
274110
+ "maxLength": 64,
274111
+ "description": "Title of the action"
274112
+ },
274113
+ "description": {
274114
+ "type": "string",
274115
+ "maxLength": 256,
274116
+ "description": "Description of the action"
274117
+ },
274118
+ "input": {
274119
+ "type": "object",
274120
+ "properties": {
274121
+ "schema": {
274122
+ "type": "object",
274123
+ "additionalProperties": true
274124
+ }
274125
+ },
274126
+ "required": [
274127
+ "schema"
274128
+ ],
274129
+ "additionalProperties": false
274130
+ },
274131
+ "output": {
274132
+ "type": "object",
274133
+ "properties": {
274134
+ "schema": {
274135
+ "type": "object",
274136
+ "additionalProperties": true
274137
+ }
274138
+ },
274139
+ "required": [
274140
+ "schema"
274141
+ ],
274142
+ "additionalProperties": false
274143
+ }
274144
+ },
274145
+ "required": [
274146
+ "input",
274147
+ "output"
274148
+ ],
274149
+ "description": "Action definition",
274150
+ "additionalProperties": false
274151
+ },
274152
+ "description": "Actions definition"
274153
+ },
274091
274154
  "configuration": {
274092
274155
  "type": "object",
274093
274156
  "properties": {
@@ -274402,6 +274465,57 @@ var state = {
274402
274465
  "additionalProperties": false
274403
274466
  }
274404
274467
  },
274468
+ "actions": {
274469
+ "type": "object",
274470
+ "additionalProperties": {
274471
+ "type": "object",
274472
+ "properties": {
274473
+ "title": {
274474
+ "type": "string",
274475
+ "maxLength": 64,
274476
+ "description": "Title of the action"
274477
+ },
274478
+ "description": {
274479
+ "type": "string",
274480
+ "maxLength": 256,
274481
+ "description": "Description of the action"
274482
+ },
274483
+ "input": {
274484
+ "type": "object",
274485
+ "properties": {
274486
+ "schema": {
274487
+ "type": "object",
274488
+ "additionalProperties": true
274489
+ }
274490
+ },
274491
+ "required": [
274492
+ "schema"
274493
+ ],
274494
+ "additionalProperties": false
274495
+ },
274496
+ "output": {
274497
+ "type": "object",
274498
+ "properties": {
274499
+ "schema": {
274500
+ "type": "object",
274501
+ "additionalProperties": true
274502
+ }
274503
+ },
274504
+ "required": [
274505
+ "schema"
274506
+ ],
274507
+ "additionalProperties": false
274508
+ }
274509
+ },
274510
+ "required": [
274511
+ "input",
274512
+ "output"
274513
+ ],
274514
+ "description": "Action definition",
274515
+ "nullable": true,
274516
+ "additionalProperties": false
274517
+ }
274518
+ },
274405
274519
  "states": {
274406
274520
  "type": "object",
274407
274521
  "additionalProperties": {
@@ -275458,6 +275572,45 @@ var state = {
275458
275572
  }
275459
275573
  }
275460
275574
  },
275575
+ "getUpcomingInvoice": {
275576
+ "name": "getUpcomingInvoice",
275577
+ "description": "Get upcoming invoice for workspace",
275578
+ "method": "get",
275579
+ "path": "/v1/admin/workspaces/{id}/billing/upcoming-invoice",
275580
+ "disableDefaultParameters": {
275581
+ "x-workspace-id": true
275582
+ },
275583
+ "parameters": {
275584
+ "id": {
275585
+ "type": "string",
275586
+ "description": "Workspace ID",
275587
+ "in": "path"
275588
+ }
275589
+ },
275590
+ "section": "workspace",
275591
+ "response": {
275592
+ "description": "Success",
275593
+ "schema": {
275594
+ "type": "object",
275595
+ "properties": {
275596
+ "id": {
275597
+ "type": "string",
275598
+ "description": "ID of the invoice."
275599
+ },
275600
+ "total": {
275601
+ "type": "number",
275602
+ "description": "Total amount to pay of the invoice."
275603
+ }
275604
+ },
275605
+ "required": [
275606
+ "id",
275607
+ "total"
275608
+ ],
275609
+ "title": "getUpcomingInvoiceResponse",
275610
+ "additionalProperties": false
275611
+ }
275612
+ }
275613
+ },
275461
275614
  "chargeWorkspaceUnpaidInvoices": {
275462
275615
  "name": "chargeWorkspaceUnpaidInvoices",
275463
275616
  "description": "Charge unpaid invoices of a workspace.",
@@ -278465,131 +278618,179 @@ var state = {
278465
278618
  },
278466
278619
  "createFile": {
278467
278620
  "name": "createFile",
278468
- "description": "Create File",
278621
+ "path": "/v1/files",
278622
+ "description": "Creates a file.",
278469
278623
  "method": "post",
278470
- "path": "/v1/storage/files",
278471
- "section": "file",
278472
278624
  "requestBody": {
278473
- "description": "Create File",
278625
+ "description": "The file to upload.",
278474
278626
  "schema": {
278475
278627
  "type": "object",
278476
278628
  "properties": {
278477
- "botId": {
278478
- "type": "string",
278479
- "format": "uuid",
278480
- "description": "ID of the bot the file will be used for"
278481
- },
278482
- "contents": {
278483
- "type": "string",
278484
- "description": "Base64-encoded file contents"
278485
- },
278486
- "name": {
278487
- "type": "string",
278488
- "description": "Optional arbitrary file name (e.g. my-image.jpg), will be used for display purposes only."
278489
- },
278490
- "accessType": {
278491
- "type": "string",
278492
- "enum": [
278493
- "private",
278494
- "public"
278495
- ],
278496
- "description": "Accepted values: private, public"
278629
+ "data": {
278630
+ "nullable": true
278497
278631
  }
278498
278632
  },
278499
- "required": [
278500
- "botId",
278501
- "contents",
278502
- "name",
278503
- "accessType"
278504
- ],
278505
278633
  "title": "createFileBody",
278634
+ "format": "binary",
278506
278635
  "additionalProperties": false
278507
278636
  }
278508
278637
  },
278509
- "response": {
278510
- "description": "Success",
278511
- "schema": {
278512
- "type": "object",
278513
- "properties": {
278514
- "file": {
278515
- "$ref": "#/components/schemas/File"
278516
- }
278517
- },
278518
- "required": [
278519
- "file"
278520
- ],
278521
- "title": "createFileResponse",
278522
- "additionalProperties": false
278523
- }
278524
- },
278525
- "parameters": {}
278526
- },
278527
- "getFile": {
278528
- "name": "getFile",
278529
- "description": "Get File",
278530
- "method": "get",
278531
- "path": "/v1/storage/files/{id}",
278532
- "section": "file",
278533
278638
  "parameters": {
278534
- "id": {
278639
+ "x-filename": {
278535
278640
  "type": "string",
278536
- "description": "File ID",
278537
- "in": "path"
278641
+ "description": "File name",
278642
+ "in": "header",
278643
+ "required": true
278644
+ },
278645
+ "x-tags": {
278646
+ "type": "string",
278647
+ "description": "File tags as URL-encoded JSON string representing an object of key-value pairs.",
278648
+ "in": "header"
278649
+ },
278650
+ "x-access-policies": {
278651
+ "type": "string",
278652
+ "description": "File access policies",
278653
+ "in": "header"
278654
+ },
278655
+ "Content-Type": {
278656
+ "type": "string",
278657
+ "description": "File content type",
278658
+ "in": "header"
278659
+ },
278660
+ "Content-Length": {
278661
+ "type": "string",
278662
+ "description": "File content length",
278663
+ "in": "header"
278664
+ },
278665
+ "x-bot-id": {
278666
+ "in": "header",
278667
+ "description": "Bot id",
278668
+ "type": "string",
278669
+ "required": true
278670
+ },
278671
+ "x-integration-id": {
278672
+ "in": "header",
278673
+ "description": "Integration id",
278674
+ "type": "string",
278675
+ "required": false
278676
+ },
278677
+ "x-user-id": {
278678
+ "in": "header",
278679
+ "description": "User id",
278680
+ "type": "string",
278681
+ "required": false
278682
+ },
278683
+ "x-user-role": {
278684
+ "in": "header",
278685
+ "description": "User role",
278686
+ "type": "string",
278687
+ "required": false
278538
278688
  }
278539
278689
  },
278690
+ "contentType": "*/*",
278691
+ "section": "files",
278540
278692
  "response": {
278541
- "description": "Success",
278693
+ "description": "The file metadata.",
278542
278694
  "schema": {
278543
278695
  "type": "object",
278544
278696
  "properties": {
278545
278697
  "file": {
278546
- "$ref": "#/components/schemas/File"
278698
+ "type": "object",
278699
+ "properties": {
278700
+ "id": {
278701
+ "type": "string"
278702
+ },
278703
+ "botId": {
278704
+ "type": "string"
278705
+ },
278706
+ "filename": {
278707
+ "type": "string"
278708
+ },
278709
+ "bytes": {
278710
+ "type": "number",
278711
+ "nullable": true
278712
+ },
278713
+ "tags": {
278714
+ "type": "object",
278715
+ "additionalProperties": {
278716
+ "type": "string",
278717
+ "maxLength": 1e3
278718
+ },
278719
+ "description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
278720
+ },
278721
+ "createdAt": {
278722
+ "type": "string"
278723
+ },
278724
+ "updatedAt": {
278725
+ "type": "string"
278726
+ },
278727
+ "accessPolicies": {
278728
+ "type": "array",
278729
+ "items": {
278730
+ "type": "string"
278731
+ }
278732
+ }
278733
+ },
278734
+ "required": [
278735
+ "id",
278736
+ "botId",
278737
+ "filename",
278738
+ "bytes",
278739
+ "tags",
278740
+ "createdAt",
278741
+ "updatedAt",
278742
+ "accessPolicies"
278743
+ ],
278744
+ "additionalProperties": false
278547
278745
  }
278548
278746
  },
278549
278747
  "required": [
278550
278748
  "file"
278551
278749
  ],
278552
- "title": "getFileResponse",
278750
+ "title": "createFileResponse",
278553
278751
  "additionalProperties": false
278554
278752
  }
278555
278753
  }
278556
278754
  },
278557
- "downloadFile": {
278558
- "name": "downloadFile",
278559
- "description": "Download File",
278560
- "method": "get",
278561
- "path": "/v1/storage/files/{id}/download",
278562
- "section": "file",
278563
- "parameters": {
278564
- "id": {
278565
- "type": "string",
278566
- "description": "File ID",
278567
- "in": "path"
278568
- }
278569
- },
278570
- "response": {
278571
- "description": "Raw file contents",
278572
- "schema": {
278573
- "nullable": true,
278574
- "title": "downloadFileResponse"
278575
- }
278576
- }
278577
- },
278578
278755
  "deleteFile": {
278579
278756
  "name": "deleteFile",
278580
- "description": "Delete File",
278757
+ "path": "/v1/files/{id}",
278758
+ "description": "Deletes a file.",
278581
278759
  "method": "delete",
278582
- "path": "/v1/storage/files/{id}",
278583
- "section": "file",
278760
+ "section": "files",
278584
278761
  "parameters": {
278585
278762
  "id": {
278586
278763
  "type": "string",
278587
278764
  "description": "File ID",
278588
278765
  "in": "path"
278766
+ },
278767
+ "x-bot-id": {
278768
+ "in": "header",
278769
+ "description": "Bot id",
278770
+ "type": "string",
278771
+ "required": true
278772
+ },
278773
+ "x-integration-id": {
278774
+ "in": "header",
278775
+ "description": "Integration id",
278776
+ "type": "string",
278777
+ "required": false
278778
+ },
278779
+ "x-user-id": {
278780
+ "in": "header",
278781
+ "description": "User id",
278782
+ "type": "string",
278783
+ "required": false
278784
+ },
278785
+ "x-user-role": {
278786
+ "in": "header",
278787
+ "description": "User role",
278788
+ "type": "string",
278789
+ "required": false
278589
278790
  }
278590
278791
  },
278591
278792
  "response": {
278592
- "description": "Success",
278793
+ "description": "Empty response.",
278593
278794
  "schema": {
278594
278795
  "type": "object",
278595
278796
  "title": "deleteFileResponse",
@@ -278599,32 +278800,96 @@ var state = {
278599
278800
  },
278600
278801
  "listFiles": {
278601
278802
  "name": "listFiles",
278602
- "description": "List Files",
278803
+ "path": "/v1/files/bot/{botId}",
278804
+ "description": "List files for bot",
278603
278805
  "method": "get",
278604
- "path": "/v1/storage/files",
278605
- "section": "file",
278806
+ "section": "files",
278606
278807
  "parameters": {
278607
278808
  "nextToken": {
278608
278809
  "in": "query",
278609
278810
  "description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
278610
278811
  "type": "string"
278611
278812
  },
278612
- "botId": {
278613
- "in": "query",
278813
+ "x-bot-id": {
278814
+ "in": "header",
278815
+ "description": "Bot id",
278614
278816
  "type": "string",
278615
- "description": "Bot ID",
278616
278817
  "required": true
278818
+ },
278819
+ "x-integration-id": {
278820
+ "in": "header",
278821
+ "description": "Integration id",
278822
+ "type": "string",
278823
+ "required": false
278824
+ },
278825
+ "x-user-id": {
278826
+ "in": "header",
278827
+ "description": "User id",
278828
+ "type": "string",
278829
+ "required": false
278830
+ },
278831
+ "x-user-role": {
278832
+ "in": "header",
278833
+ "description": "User role",
278834
+ "type": "string",
278835
+ "required": false
278836
+ },
278837
+ "botId": {
278838
+ "type": "string",
278839
+ "description": "Bot ID",
278840
+ "in": "path"
278841
+ },
278842
+ "tags": {
278843
+ "in": "query",
278844
+ "type": "string",
278845
+ "description": "Tags to filter files by as a JSON string representing an object of key-value pairs to match files' tags against."
278617
278846
  }
278618
278847
  },
278619
278848
  "response": {
278620
- "description": "Success",
278849
+ "description": "Returns the list of files related to the bot.",
278621
278850
  "schema": {
278622
278851
  "type": "object",
278623
278852
  "properties": {
278624
278853
  "files": {
278625
278854
  "type": "array",
278626
278855
  "items": {
278627
- "$ref": "#/components/schemas/File"
278856
+ "type": "object",
278857
+ "properties": {
278858
+ "id": {
278859
+ "type": "string"
278860
+ },
278861
+ "botId": {
278862
+ "type": "string"
278863
+ },
278864
+ "filename": {
278865
+ "type": "string"
278866
+ },
278867
+ "bytes": {
278868
+ "type": "number",
278869
+ "nullable": true
278870
+ },
278871
+ "createdAt": {
278872
+ "type": "string"
278873
+ },
278874
+ "updatedAt": {
278875
+ "type": "string"
278876
+ },
278877
+ "accessPolicies": {
278878
+ "type": "array",
278879
+ "items": {
278880
+ "type": "string"
278881
+ }
278882
+ }
278883
+ },
278884
+ "required": [
278885
+ "id",
278886
+ "botId",
278887
+ "filename",
278888
+ "bytes",
278889
+ "createdAt",
278890
+ "updatedAt",
278891
+ "accessPolicies"
278892
+ ]
278628
278893
  }
278629
278894
  },
278630
278895
  "meta": {
@@ -278647,6 +278912,239 @@ var state = {
278647
278912
  }
278648
278913
  }
278649
278914
  },
278915
+ "getFileMetadata": {
278916
+ "name": "getFileMetadata",
278917
+ "path": "/v1/files/{id}/metadata",
278918
+ "description": "Get file metadata",
278919
+ "method": "get",
278920
+ "section": "files",
278921
+ "parameters": {
278922
+ "id": {
278923
+ "type": "string",
278924
+ "description": "File ID",
278925
+ "in": "path"
278926
+ },
278927
+ "x-bot-id": {
278928
+ "in": "header",
278929
+ "description": "Bot id",
278930
+ "type": "string",
278931
+ "required": true
278932
+ },
278933
+ "x-integration-id": {
278934
+ "in": "header",
278935
+ "description": "Integration id",
278936
+ "type": "string",
278937
+ "required": false
278938
+ },
278939
+ "x-user-id": {
278940
+ "in": "header",
278941
+ "description": "User id",
278942
+ "type": "string",
278943
+ "required": false
278944
+ },
278945
+ "x-user-role": {
278946
+ "in": "header",
278947
+ "description": "User role",
278948
+ "type": "string",
278949
+ "required": false
278950
+ }
278951
+ },
278952
+ "response": {
278953
+ "description": "The metadata of the file.",
278954
+ "schema": {
278955
+ "type": "object",
278956
+ "properties": {
278957
+ "file": {
278958
+ "type": "object",
278959
+ "properties": {
278960
+ "id": {
278961
+ "type": "string"
278962
+ },
278963
+ "botId": {
278964
+ "type": "string"
278965
+ },
278966
+ "filename": {
278967
+ "type": "string"
278968
+ },
278969
+ "bytes": {
278970
+ "type": "number",
278971
+ "nullable": true
278972
+ },
278973
+ "tags": {
278974
+ "type": "object",
278975
+ "additionalProperties": {
278976
+ "type": "string",
278977
+ "maxLength": 1e3
278978
+ },
278979
+ "description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
278980
+ },
278981
+ "createdAt": {
278982
+ "type": "string"
278983
+ },
278984
+ "updatedAt": {
278985
+ "type": "string"
278986
+ },
278987
+ "accessPolicies": {
278988
+ "type": "array",
278989
+ "items": {
278990
+ "type": "string"
278991
+ }
278992
+ }
278993
+ },
278994
+ "required": [
278995
+ "id",
278996
+ "botId",
278997
+ "filename",
278998
+ "bytes",
278999
+ "tags",
279000
+ "createdAt",
279001
+ "updatedAt",
279002
+ "accessPolicies"
279003
+ ],
279004
+ "additionalProperties": false
279005
+ }
279006
+ },
279007
+ "required": [
279008
+ "file"
279009
+ ],
279010
+ "title": "getFileMetadataResponse",
279011
+ "additionalProperties": false
279012
+ }
279013
+ }
279014
+ },
279015
+ "getFileContent": {
279016
+ "name": "getFileContent",
279017
+ "path": "/v1/files/{id}/content",
279018
+ "description": "Gets a file content",
279019
+ "method": "get",
279020
+ "section": "files",
279021
+ "parameters": {
279022
+ "id": {
279023
+ "type": "string",
279024
+ "description": "File ID",
279025
+ "in": "path"
279026
+ },
279027
+ "x-bot-id": {
279028
+ "in": "header",
279029
+ "description": "Bot id",
279030
+ "type": "string",
279031
+ "required": true
279032
+ },
279033
+ "x-integration-id": {
279034
+ "in": "header",
279035
+ "description": "Integration id",
279036
+ "type": "string",
279037
+ "required": false
279038
+ },
279039
+ "x-user-id": {
279040
+ "in": "header",
279041
+ "description": "User id",
279042
+ "type": "string",
279043
+ "required": false
279044
+ },
279045
+ "x-user-role": {
279046
+ "in": "header",
279047
+ "description": "User role",
279048
+ "type": "string",
279049
+ "required": false
279050
+ }
279051
+ },
279052
+ "response": {
279053
+ "description": "Redirects to a presigned URL to download the file content.",
279054
+ "status": 302,
279055
+ "schema": {
279056
+ "type": "object",
279057
+ "properties": {
279058
+ "data": {
279059
+ "nullable": true
279060
+ }
279061
+ },
279062
+ "title": "getFileContentResponse",
279063
+ "format": "binary",
279064
+ "additionalProperties": false
279065
+ }
279066
+ }
279067
+ },
279068
+ "updateFileMetadata": {
279069
+ "name": "updateFileMetadata",
279070
+ "path": "/v1/files/{id}/metadata",
279071
+ "description": "Update file metadata",
279072
+ "method": "put",
279073
+ "section": "files",
279074
+ "parameters": {
279075
+ "id": {
279076
+ "type": "string",
279077
+ "description": "File ID",
279078
+ "in": "path"
279079
+ },
279080
+ "x-bot-id": {
279081
+ "in": "header",
279082
+ "description": "Bot id",
279083
+ "type": "string",
279084
+ "required": true
279085
+ },
279086
+ "x-integration-id": {
279087
+ "in": "header",
279088
+ "description": "Integration id",
279089
+ "type": "string",
279090
+ "required": false
279091
+ },
279092
+ "x-user-id": {
279093
+ "in": "header",
279094
+ "description": "User id",
279095
+ "type": "string",
279096
+ "required": false
279097
+ },
279098
+ "x-user-role": {
279099
+ "in": "header",
279100
+ "description": "User role",
279101
+ "type": "string",
279102
+ "required": false
279103
+ }
279104
+ },
279105
+ "requestBody": {
279106
+ "description": "File metadata to update.",
279107
+ "schema": {
279108
+ "type": "object",
279109
+ "properties": {
279110
+ "tags": {
279111
+ "type": "object",
279112
+ "additionalProperties": {
279113
+ "type": "string",
279114
+ "maxLength": 1e3
279115
+ },
279116
+ "description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
279117
+ }
279118
+ },
279119
+ "required": [
279120
+ "tags"
279121
+ ],
279122
+ "title": "updateFileMetadataBody",
279123
+ "additionalProperties": false
279124
+ }
279125
+ },
279126
+ "response": {
279127
+ "description": "An object containing the updated metadata of the file.",
279128
+ "schema": {
279129
+ "type": "object",
279130
+ "properties": {
279131
+ "tags": {
279132
+ "type": "object",
279133
+ "additionalProperties": {
279134
+ "type": "string",
279135
+ "maxLength": 1e3
279136
+ },
279137
+ "description": "The tags to update as an object of key/value pairs. A tag key can be set to a null value to delete it."
279138
+ }
279139
+ },
279140
+ "required": [
279141
+ "tags"
279142
+ ],
279143
+ "title": "updateFileMetadataResponse",
279144
+ "additionalProperties": false
279145
+ }
279146
+ }
279147
+ },
278650
279148
  "listTables": {
278651
279149
  "name": "listTables",
278652
279150
  "path": "/v1/tables",
@@ -279355,7 +279853,7 @@ var state = {
279355
279853
  "title": "Botpress API",
279356
279854
  "description": "API for Botpress Cloud",
279357
279855
  "server": "https://api.botpress.cloud",
279358
- "version": "0.18.4",
279856
+ "version": "0.19.0",
279359
279857
  "prefix": "v1"
279360
279858
  },
279361
279859
  "errors": [
@@ -279511,6 +280009,7 @@ var state = {
279511
280009
  "changeAISpendQuotaBody": true,
279512
280010
  "introspectBody": true,
279513
280011
  "createFileBody": true,
280012
+ "updateFileMetadataBody": true,
279514
280013
  "createTableBody": true,
279515
280014
  "updateTableBody": true,
279516
280015
  "renameTableColumnBody": true,
@@ -279583,6 +280082,7 @@ var state = {
279583
280082
  "getWorkspaceBillingDetailsResponse": true,
279584
280083
  "setWorkspacePaymentMethodResponse": true,
279585
280084
  "listWorkspaceInvoicesResponse": true,
280085
+ "getUpcomingInvoiceResponse": true,
279586
280086
  "chargeWorkspaceUnpaidInvoicesResponse": true,
279587
280087
  "createWorkspaceResponse": true,
279588
280088
  "getPublicWorkspaceResponse": true,
@@ -279615,10 +280115,11 @@ var state = {
279615
280115
  "listActivitiesResponse": true,
279616
280116
  "introspectResponse": true,
279617
280117
  "createFileResponse": true,
279618
- "getFileResponse": true,
279619
- "downloadFileResponse": true,
279620
280118
  "deleteFileResponse": true,
279621
280119
  "listFilesResponse": true,
280120
+ "getFileMetadataResponse": true,
280121
+ "getFileContentResponse": true,
280122
+ "updateFileMetadataResponse": true,
279622
280123
  "listTablesResponse": true,
279623
280124
  "getTableResponse": true,
279624
280125
  "createTableResponse": true,
@@ -279648,10 +280149,10 @@ var state = {
279648
280149
  "Message": true,
279649
280150
  "State": true,
279650
280151
  "Task": true,
279651
- "File": true,
279652
280152
  "Table": true,
279653
280153
  "Column": true,
279654
- "Row": true
280154
+ "Row": true,
280155
+ "File": true
279655
280156
  }
279656
280157
  },
279657
280158
  "schemas": {
@@ -280031,6 +280532,57 @@ var state = {
280031
280532
  "description": "Subscriptions of the bot",
280032
280533
  "additionalProperties": false
280033
280534
  },
280535
+ "actions": {
280536
+ "type": "object",
280537
+ "additionalProperties": {
280538
+ "type": "object",
280539
+ "properties": {
280540
+ "title": {
280541
+ "type": "string",
280542
+ "maxLength": 64,
280543
+ "description": "Title of the action"
280544
+ },
280545
+ "description": {
280546
+ "type": "string",
280547
+ "maxLength": 256,
280548
+ "description": "Description of the action"
280549
+ },
280550
+ "input": {
280551
+ "type": "object",
280552
+ "properties": {
280553
+ "schema": {
280554
+ "type": "object",
280555
+ "additionalProperties": true
280556
+ }
280557
+ },
280558
+ "required": [
280559
+ "schema"
280560
+ ],
280561
+ "additionalProperties": false
280562
+ },
280563
+ "output": {
280564
+ "type": "object",
280565
+ "properties": {
280566
+ "schema": {
280567
+ "type": "object",
280568
+ "additionalProperties": true
280569
+ }
280570
+ },
280571
+ "required": [
280572
+ "schema"
280573
+ ],
280574
+ "additionalProperties": false
280575
+ }
280576
+ },
280577
+ "required": [
280578
+ "input",
280579
+ "output"
280580
+ ],
280581
+ "description": "Action definition",
280582
+ "additionalProperties": false
280583
+ },
280584
+ "description": "Actions definition"
280585
+ },
280034
280586
  "name": {
280035
280587
  "type": "string",
280036
280588
  "description": "Name of the [Bot](#schema_bot)"
@@ -280096,6 +280648,7 @@ var state = {
280096
280648
  "events",
280097
280649
  "recurringEvents",
280098
280650
  "subscriptions",
280651
+ "actions",
280099
280652
  "name",
280100
280653
  "dev",
280101
280654
  "alwaysAlive",
@@ -281358,56 +281911,6 @@ var state = {
281358
281911
  "additionalProperties": false
281359
281912
  }
281360
281913
  },
281361
- "File": {
281362
- "section": "file",
281363
- "schema": {
281364
- "type": "object",
281365
- "properties": {
281366
- "botId": {
281367
- "type": "string",
281368
- "format": "uuid",
281369
- "description": "ID of the bot the file will be used for"
281370
- },
281371
- "name": {
281372
- "type": "string",
281373
- "description": "Optional arbitrary file name (e.g. my-image.jpg), will be used for display purposes only."
281374
- },
281375
- "accessType": {
281376
- "type": "string",
281377
- "enum": [
281378
- "private",
281379
- "public"
281380
- ],
281381
- "description": "Accepted values: private, public"
281382
- },
281383
- "id": {
281384
- "type": "string",
281385
- "description": "ID of the [File](#schema_file)"
281386
- },
281387
- "createdAt": {
281388
- "type": "string",
281389
- "description": "Creation date of the [File](#schema_file) in ISO 8601 format"
281390
- },
281391
- "size": {
281392
- "type": "number",
281393
- "description": "Size of the file in bytes"
281394
- },
281395
- "publicUrl": {
281396
- "type": "string",
281397
- "description": "Public URL to the file contents, available only if the access type is public. If the file is private, use the Download endpoint to retrieve the file contents."
281398
- }
281399
- },
281400
- "required": [
281401
- "botId",
281402
- "name",
281403
- "accessType",
281404
- "id",
281405
- "createdAt",
281406
- "size"
281407
- ],
281408
- "additionalProperties": false
281409
- }
281410
- },
281411
281914
  "Table": {
281412
281915
  "section": "tables",
281413
281916
  "schema": {
@@ -281630,6 +282133,58 @@ var state = {
281630
282133
  ],
281631
282134
  "additionalProperties": true
281632
282135
  }
282136
+ },
282137
+ "File": {
282138
+ "section": "files",
282139
+ "schema": {
282140
+ "type": "object",
282141
+ "properties": {
282142
+ "id": {
282143
+ "type": "string"
282144
+ },
282145
+ "botId": {
282146
+ "type": "string"
282147
+ },
282148
+ "filename": {
282149
+ "type": "string"
282150
+ },
282151
+ "bytes": {
282152
+ "type": "number",
282153
+ "nullable": true
282154
+ },
282155
+ "tags": {
282156
+ "type": "object",
282157
+ "additionalProperties": {
282158
+ "type": "string",
282159
+ "maxLength": 1e3
282160
+ },
282161
+ "description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
282162
+ },
282163
+ "createdAt": {
282164
+ "type": "string"
282165
+ },
282166
+ "updatedAt": {
282167
+ "type": "string"
282168
+ },
282169
+ "accessPolicies": {
282170
+ "type": "array",
282171
+ "items": {
282172
+ "type": "string"
282173
+ }
282174
+ }
282175
+ },
282176
+ "required": [
282177
+ "id",
282178
+ "botId",
282179
+ "filename",
282180
+ "bytes",
282181
+ "tags",
282182
+ "createdAt",
282183
+ "updatedAt",
282184
+ "accessPolicies"
282185
+ ],
282186
+ "additionalProperties": false
282187
+ }
281633
282188
  }
281634
282189
  },
281635
282190
  "sections": [
@@ -281694,14 +282249,7 @@ var state = {
281694
282249
  "description": "",
281695
282250
  "title": "File",
281696
282251
  "name": "file",
281697
- "operations": [
281698
- "createFile",
281699
- "getFile",
281700
- "downloadFile",
281701
- "deleteFile",
281702
- "listFiles"
281703
- ],
281704
- "schema": "File"
282252
+ "operations": []
281705
282253
  },
281706
282254
  {
281707
282255
  "description": "",
@@ -281789,6 +282337,7 @@ var state = {
281789
282337
  "getWorkspaceBillingDetails",
281790
282338
  "setWorkspacePaymentMethod",
281791
282339
  "listWorkspaceInvoices",
282340
+ "getUpcomingInvoice",
281792
282341
  "chargeWorkspaceUnpaidInvoices",
281793
282342
  "createWorkspace",
281794
282343
  "getPublicWorkspace",
@@ -281887,6 +282436,20 @@ var state = {
281887
282436
  "upsertTableRows"
281888
282437
  ],
281889
282438
  "schema": "Table"
282439
+ },
282440
+ {
282441
+ "title": "Files",
282442
+ "description": "Operations related to file management.",
282443
+ "name": "files",
282444
+ "operations": [
282445
+ "createFile",
282446
+ "deleteFile",
282447
+ "listFiles",
282448
+ "getFileMetadata",
282449
+ "getFileContent",
282450
+ "updateFileMetadata"
282451
+ ],
282452
+ "schema": "File"
281890
282453
  }
281891
282454
  ],
281892
282455
  "options": {