@botpress/api 1.5.1 → 1.6.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.
Files changed (16) hide show
  1. package/dist/index.js +281 -7
  2. package/dist/src/gen/admin/state.d.ts +121 -0
  3. package/dist/src/gen/state.d.ts +121 -0
  4. package/package.json +1 -1
  5. package/src/gen/admin/metadata.json +1 -1
  6. package/src/gen/admin/openapi.json +1 -1
  7. package/src/gen/admin/state.ts +139 -2
  8. package/src/gen/files/openapi.json +1 -1
  9. package/src/gen/files/state.ts +1 -1
  10. package/src/gen/metadata.json +1 -1
  11. package/src/gen/openapi.json +1 -1
  12. package/src/gen/runtime/openapi.json +1 -1
  13. package/src/gen/runtime/state.ts +1 -1
  14. package/src/gen/state.ts +139 -2
  15. package/src/gen/tables/openapi.json +1 -1
  16. package/src/gen/tables/state.ts +1 -1
package/dist/index.js CHANGED
@@ -284643,7 +284643,7 @@ var state = {
284643
284643
  "title": "Botpress API",
284644
284644
  "description": "API for Botpress Cloud",
284645
284645
  "server": "https://api.botpress.cloud",
284646
- "version": "1.5.1",
284646
+ "version": "1.6.0",
284647
284647
  "prefix": "v1"
284648
284648
  },
284649
284649
  "errors": [
@@ -293196,6 +293196,136 @@ var state2 = {
293196
293196
  }
293197
293197
  }
293198
293198
  },
293199
+ "listBotApiKeys": {
293200
+ "name": "listBotApiKeys",
293201
+ "description": "List BAKs (Bot Api Keys) of a bot",
293202
+ "method": "get",
293203
+ "section": "bot",
293204
+ "path": "/v1/admin/bots/baks",
293205
+ "parameters": {
293206
+ "botId": {
293207
+ "in": "query",
293208
+ "description": "ID of the bot",
293209
+ "type": "string",
293210
+ "required": true
293211
+ }
293212
+ },
293213
+ "response": {
293214
+ "description": "Success",
293215
+ "schema": {
293216
+ "type": "object",
293217
+ "properties": {
293218
+ "baks": {
293219
+ "type": "array",
293220
+ "items": {
293221
+ "type": "object",
293222
+ "properties": {
293223
+ "id": {
293224
+ "type": "string"
293225
+ },
293226
+ "createdAt": {
293227
+ "type": "string",
293228
+ "format": "date-time"
293229
+ },
293230
+ "note": {
293231
+ "type": "string"
293232
+ }
293233
+ },
293234
+ "required": [
293235
+ "id",
293236
+ "createdAt",
293237
+ "note"
293238
+ ]
293239
+ }
293240
+ }
293241
+ },
293242
+ "required": [
293243
+ "baks"
293244
+ ],
293245
+ "title": "listBotApiKeysResponse",
293246
+ "additionalProperties": false
293247
+ }
293248
+ }
293249
+ },
293250
+ "createBotApiKey": {
293251
+ "name": "createBotApiKey",
293252
+ "description": "Create a BAK",
293253
+ "method": "post",
293254
+ "section": "bot",
293255
+ "path": "/v1/admin/bots/baks",
293256
+ "requestBody": {
293257
+ "description": "BAK body",
293258
+ "schema": {
293259
+ "type": "object",
293260
+ "properties": {
293261
+ "botId": {
293262
+ "type": "string"
293263
+ },
293264
+ "note": {
293265
+ "type": "string"
293266
+ }
293267
+ },
293268
+ "required": [
293269
+ "botId"
293270
+ ],
293271
+ "title": "createBotApiKeyBody",
293272
+ "additionalProperties": false
293273
+ }
293274
+ },
293275
+ "response": {
293276
+ "description": "Success",
293277
+ "schema": {
293278
+ "type": "object",
293279
+ "properties": {
293280
+ "id": {
293281
+ "type": "string"
293282
+ },
293283
+ "createdAt": {
293284
+ "type": "string",
293285
+ "format": "date-time"
293286
+ },
293287
+ "note": {
293288
+ "type": "string"
293289
+ },
293290
+ "value": {
293291
+ "type": "string",
293292
+ "description": "The BAK value. This will only be returned here when created and cannot be retrieved later."
293293
+ }
293294
+ },
293295
+ "required": [
293296
+ "id",
293297
+ "createdAt",
293298
+ "note",
293299
+ "value"
293300
+ ],
293301
+ "title": "createBotApiKeyResponse",
293302
+ "additionalProperties": false
293303
+ }
293304
+ },
293305
+ "parameters": {}
293306
+ },
293307
+ "deleteBotApiKey": {
293308
+ "name": "deleteBotApiKey",
293309
+ "description": "Delete a BAK",
293310
+ "method": "delete",
293311
+ "section": "bot",
293312
+ "path": "/v1/admin/bots/baks/{id}",
293313
+ "parameters": {
293314
+ "id": {
293315
+ "type": "string",
293316
+ "description": "ID of Bot Api Key",
293317
+ "in": "path"
293318
+ }
293319
+ },
293320
+ "response": {
293321
+ "description": "Success",
293322
+ "schema": {
293323
+ "type": "object",
293324
+ "title": "deleteBotApiKeyResponse",
293325
+ "additionalProperties": false
293326
+ }
293327
+ }
293328
+ },
293199
293329
  "listWorkspaceInvoices": {
293200
293330
  "name": "listWorkspaceInvoices",
293201
293331
  "description": "List invoices billed to workspace",
@@ -299942,7 +300072,7 @@ var state2 = {
299942
300072
  "title": "Botpress API",
299943
300073
  "description": "API for Botpress Cloud",
299944
300074
  "server": "https://api.botpress.cloud",
299945
- "version": "1.5.1",
300075
+ "version": "1.6.0",
299946
300076
  "prefix": "v1"
299947
300077
  },
299948
300078
  "errors": [
@@ -300080,6 +300210,7 @@ var state2 = {
300080
300210
  "createBotVersionBody": true,
300081
300211
  "deployBotVersionBody": true,
300082
300212
  "createIntegrationShareableIdBody": true,
300213
+ "createBotApiKeyBody": true,
300083
300214
  "chargeWorkspaceUnpaidInvoicesBody": true,
300084
300215
  "createWorkspaceBody": true,
300085
300216
  "updateWorkspaceBody": true,
@@ -300135,6 +300266,9 @@ var state2 = {
300135
300266
  "createIntegrationShareableIdResponse": true,
300136
300267
  "deleteIntegrationShareableIdResponse": true,
300137
300268
  "getIntegrationShareableIdResponse": true,
300269
+ "listBotApiKeysResponse": true,
300270
+ "createBotApiKeyResponse": true,
300271
+ "deleteBotApiKeyResponse": true,
300138
300272
  "listWorkspaceInvoicesResponse": true,
300139
300273
  "getUpcomingInvoiceResponse": true,
300140
300274
  "chargeWorkspaceUnpaidInvoicesResponse": true,
@@ -303539,7 +303673,10 @@ var state2 = {
303539
303673
  "deployBotVersion",
303540
303674
  "createIntegrationShareableId",
303541
303675
  "deleteIntegrationShareableId",
303542
- "getIntegrationShareableId"
303676
+ "getIntegrationShareableId",
303677
+ "listBotApiKeys",
303678
+ "createBotApiKey",
303679
+ "deleteBotApiKey"
303543
303680
  ],
303544
303681
  "schema": "Bot"
303545
303682
  },
@@ -305283,7 +305420,7 @@ var state3 = {
305283
305420
  "title": "Botpress API",
305284
305421
  "description": "API for Botpress Cloud",
305285
305422
  "server": "https://api.botpress.cloud",
305286
- "version": "1.5.1",
305423
+ "version": "1.6.0",
305287
305424
  "prefix": "v1"
305288
305425
  },
305289
305426
  "errors": [
@@ -310078,7 +310215,7 @@ var state4 = {
310078
310215
  "title": "Botpress API",
310079
310216
  "description": "API for Botpress Cloud",
310080
310217
  "server": "https://api.botpress.cloud",
310081
- "version": "1.5.1",
310218
+ "version": "1.6.0",
310082
310219
  "prefix": "v1"
310083
310220
  },
310084
310221
  "errors": [
@@ -321152,6 +321289,136 @@ var state5 = {
321152
321289
  }
321153
321290
  }
321154
321291
  },
321292
+ "listBotApiKeys": {
321293
+ "name": "listBotApiKeys",
321294
+ "description": "List BAKs (Bot Api Keys) of a bot",
321295
+ "method": "get",
321296
+ "section": "bot",
321297
+ "path": "/v1/admin/bots/baks",
321298
+ "parameters": {
321299
+ "botId": {
321300
+ "in": "query",
321301
+ "description": "ID of the bot",
321302
+ "type": "string",
321303
+ "required": true
321304
+ }
321305
+ },
321306
+ "response": {
321307
+ "description": "Success",
321308
+ "schema": {
321309
+ "type": "object",
321310
+ "properties": {
321311
+ "baks": {
321312
+ "type": "array",
321313
+ "items": {
321314
+ "type": "object",
321315
+ "properties": {
321316
+ "id": {
321317
+ "type": "string"
321318
+ },
321319
+ "createdAt": {
321320
+ "type": "string",
321321
+ "format": "date-time"
321322
+ },
321323
+ "note": {
321324
+ "type": "string"
321325
+ }
321326
+ },
321327
+ "required": [
321328
+ "id",
321329
+ "createdAt",
321330
+ "note"
321331
+ ]
321332
+ }
321333
+ }
321334
+ },
321335
+ "required": [
321336
+ "baks"
321337
+ ],
321338
+ "title": "listBotApiKeysResponse",
321339
+ "additionalProperties": false
321340
+ }
321341
+ }
321342
+ },
321343
+ "createBotApiKey": {
321344
+ "name": "createBotApiKey",
321345
+ "description": "Create a BAK",
321346
+ "method": "post",
321347
+ "section": "bot",
321348
+ "path": "/v1/admin/bots/baks",
321349
+ "requestBody": {
321350
+ "description": "BAK body",
321351
+ "schema": {
321352
+ "type": "object",
321353
+ "properties": {
321354
+ "botId": {
321355
+ "type": "string"
321356
+ },
321357
+ "note": {
321358
+ "type": "string"
321359
+ }
321360
+ },
321361
+ "required": [
321362
+ "botId"
321363
+ ],
321364
+ "title": "createBotApiKeyBody",
321365
+ "additionalProperties": false
321366
+ }
321367
+ },
321368
+ "response": {
321369
+ "description": "Success",
321370
+ "schema": {
321371
+ "type": "object",
321372
+ "properties": {
321373
+ "id": {
321374
+ "type": "string"
321375
+ },
321376
+ "createdAt": {
321377
+ "type": "string",
321378
+ "format": "date-time"
321379
+ },
321380
+ "note": {
321381
+ "type": "string"
321382
+ },
321383
+ "value": {
321384
+ "type": "string",
321385
+ "description": "The BAK value. This will only be returned here when created and cannot be retrieved later."
321386
+ }
321387
+ },
321388
+ "required": [
321389
+ "id",
321390
+ "createdAt",
321391
+ "note",
321392
+ "value"
321393
+ ],
321394
+ "title": "createBotApiKeyResponse",
321395
+ "additionalProperties": false
321396
+ }
321397
+ },
321398
+ "parameters": {}
321399
+ },
321400
+ "deleteBotApiKey": {
321401
+ "name": "deleteBotApiKey",
321402
+ "description": "Delete a BAK",
321403
+ "method": "delete",
321404
+ "section": "bot",
321405
+ "path": "/v1/admin/bots/baks/{id}",
321406
+ "parameters": {
321407
+ "id": {
321408
+ "type": "string",
321409
+ "description": "ID of Bot Api Key",
321410
+ "in": "path"
321411
+ }
321412
+ },
321413
+ "response": {
321414
+ "description": "Success",
321415
+ "schema": {
321416
+ "type": "object",
321417
+ "title": "deleteBotApiKeyResponse",
321418
+ "additionalProperties": false
321419
+ }
321420
+ }
321421
+ },
321155
321422
  "listWorkspaceInvoices": {
321156
321423
  "name": "listWorkspaceInvoices",
321157
321424
  "description": "List invoices billed to workspace",
@@ -330674,7 +330941,7 @@ var state5 = {
330674
330941
  "title": "Botpress API",
330675
330942
  "description": "API for Botpress Cloud",
330676
330943
  "server": "https://api.botpress.cloud",
330677
- "version": "1.5.1",
330944
+ "version": "1.6.0",
330678
330945
  "prefix": "v1"
330679
330946
  },
330680
330947
  "errors": [
@@ -330835,6 +331102,7 @@ var state5 = {
330835
331102
  "createBotVersionBody": true,
330836
331103
  "deployBotVersionBody": true,
330837
331104
  "createIntegrationShareableIdBody": true,
331105
+ "createBotApiKeyBody": true,
330838
331106
  "chargeWorkspaceUnpaidInvoicesBody": true,
330839
331107
  "createWorkspaceBody": true,
330840
331108
  "updateWorkspaceBody": true,
@@ -330951,6 +331219,9 @@ var state5 = {
330951
331219
  "createIntegrationShareableIdResponse": true,
330952
331220
  "deleteIntegrationShareableIdResponse": true,
330953
331221
  "getIntegrationShareableIdResponse": true,
331222
+ "listBotApiKeysResponse": true,
331223
+ "createBotApiKeyResponse": true,
331224
+ "deleteBotApiKeyResponse": true,
330954
331225
  "listWorkspaceInvoicesResponse": true,
330955
331226
  "getUpcomingInvoiceResponse": true,
330956
331227
  "chargeWorkspaceUnpaidInvoicesResponse": true,
@@ -334440,7 +334711,10 @@ var state5 = {
334440
334711
  "deployBotVersion",
334441
334712
  "createIntegrationShareableId",
334442
334713
  "deleteIntegrationShareableId",
334443
- "getIntegrationShareableId"
334714
+ "getIntegrationShareableId",
334715
+ "listBotApiKeys",
334716
+ "createBotApiKey",
334717
+ "deleteBotApiKey"
334444
334718
  ],
334445
334719
  "schema": "Bot"
334446
334720
  },
package/dist/src/gen/admin/state.d.ts CHANGED
@@ -4271,6 +4271,123 @@ export declare const state: {
4271
4271
  };
4272
4272
  };
4273
4273
  };
4274
+ listBotApiKeys: {
4275
+ name: string;
4276
+ description: string;
4277
+ method: "get";
4278
+ section: "bot";
4279
+ path: string;
4280
+ parameters: {
4281
+ botId: {
4282
+ in: "query";
4283
+ description: string;
4284
+ type: "string";
4285
+ required: true;
4286
+ };
4287
+ };
4288
+ response: {
4289
+ description: string;
4290
+ schema: {
4291
+ type: "object";
4292
+ properties: {
4293
+ baks: {
4294
+ type: "array";
4295
+ items: {
4296
+ type: "object";
4297
+ properties: {
4298
+ id: {
4299
+ type: "string";
4300
+ };
4301
+ createdAt: {
4302
+ type: "string";
4303
+ format: string;
4304
+ };
4305
+ note: {
4306
+ type: "string";
4307
+ };
4308
+ };
4309
+ required: string[];
4310
+ };
4311
+ };
4312
+ };
4313
+ required: string[];
4314
+ title: string;
4315
+ additionalProperties: false;
4316
+ };
4317
+ };
4318
+ };
4319
+ createBotApiKey: {
4320
+ name: string;
4321
+ description: string;
4322
+ method: "post";
4323
+ section: "bot";
4324
+ path: string;
4325
+ requestBody: {
4326
+ description: string;
4327
+ schema: {
4328
+ type: "object";
4329
+ properties: {
4330
+ botId: {
4331
+ type: "string";
4332
+ };
4333
+ note: {
4334
+ type: "string";
4335
+ };
4336
+ };
4337
+ required: string[];
4338
+ title: string;
4339
+ additionalProperties: false;
4340
+ };
4341
+ };
4342
+ response: {
4343
+ description: string;
4344
+ schema: {
4345
+ type: "object";
4346
+ properties: {
4347
+ id: {
4348
+ type: "string";
4349
+ };
4350
+ createdAt: {
4351
+ type: "string";
4352
+ format: string;
4353
+ };
4354
+ note: {
4355
+ type: "string";
4356
+ };
4357
+ value: {
4358
+ type: "string";
4359
+ description: string;
4360
+ };
4361
+ };
4362
+ required: string[];
4363
+ title: string;
4364
+ additionalProperties: false;
4365
+ };
4366
+ };
4367
+ parameters: {};
4368
+ };
4369
+ deleteBotApiKey: {
4370
+ name: string;
4371
+ description: string;
4372
+ method: "delete";
4373
+ section: "bot";
4374
+ path: string;
4375
+ parameters: {
4376
+ id: {
4377
+ type: "string";
4378
+ description: string;
4379
+ in: "path";
4380
+ };
4381
+ };
4382
+ response: {
4383
+ description: string;
4384
+ schema: {
4385
+ type: "object";
4386
+ title: string;
4387
+ additionalProperties: false;
4388
+ };
4389
+ };
4390
+ };
4274
4391
  listWorkspaceInvoices: {
4275
4392
  name: string;
4276
4393
  description: string;
@@ -10272,6 +10389,7 @@ export declare const state: {
10272
10389
  createBotVersionBody: true;
10273
10390
  deployBotVersionBody: true;
10274
10391
  createIntegrationShareableIdBody: true;
10392
+ createBotApiKeyBody: true;
10275
10393
  chargeWorkspaceUnpaidInvoicesBody: true;
10276
10394
  createWorkspaceBody: true;
10277
10395
  updateWorkspaceBody: true;
@@ -10327,6 +10445,9 @@ export declare const state: {
10327
10445
  createIntegrationShareableIdResponse: true;
10328
10446
  deleteIntegrationShareableIdResponse: true;
10329
10447
  getIntegrationShareableIdResponse: true;
10448
+ listBotApiKeysResponse: true;
10449
+ createBotApiKeyResponse: true;
10450
+ deleteBotApiKeyResponse: true;
10330
10451
  listWorkspaceInvoicesResponse: true;
10331
10452
  getUpcomingInvoiceResponse: true;
10332
10453
  chargeWorkspaceUnpaidInvoicesResponse: true;
package/dist/src/gen/state.d.ts CHANGED
@@ -6623,6 +6623,123 @@ export declare const state: {
6623
6623
  };
6624
6624
  };
6625
6625
  };
6626
+ listBotApiKeys: {
6627
+ name: string;
6628
+ description: string;
6629
+ method: "get";
6630
+ section: "bot";
6631
+ path: string;
6632
+ parameters: {
6633
+ botId: {
6634
+ in: "query";
6635
+ description: string;
6636
+ type: "string";
6637
+ required: true;
6638
+ };
6639
+ };
6640
+ response: {
6641
+ description: string;
6642
+ schema: {
6643
+ type: "object";
6644
+ properties: {
6645
+ baks: {
6646
+ type: "array";
6647
+ items: {
6648
+ type: "object";
6649
+ properties: {
6650
+ id: {
6651
+ type: "string";
6652
+ };
6653
+ createdAt: {
6654
+ type: "string";
6655
+ format: string;
6656
+ };
6657
+ note: {
6658
+ type: "string";
6659
+ };
6660
+ };
6661
+ required: string[];
6662
+ };
6663
+ };
6664
+ };
6665
+ required: string[];
6666
+ title: string;
6667
+ additionalProperties: false;
6668
+ };
6669
+ };
6670
+ };
6671
+ createBotApiKey: {
6672
+ name: string;
6673
+ description: string;
6674
+ method: "post";
6675
+ section: "bot";
6676
+ path: string;
6677
+ requestBody: {
6678
+ description: string;
6679
+ schema: {
6680
+ type: "object";
6681
+ properties: {
6682
+ botId: {
6683
+ type: "string";
6684
+ };
6685
+ note: {
6686
+ type: "string";
6687
+ };
6688
+ };
6689
+ required: string[];
6690
+ title: string;
6691
+ additionalProperties: false;
6692
+ };
6693
+ };
6694
+ response: {
6695
+ description: string;
6696
+ schema: {
6697
+ type: "object";
6698
+ properties: {
6699
+ id: {
6700
+ type: "string";
6701
+ };
6702
+ createdAt: {
6703
+ type: "string";
6704
+ format: string;
6705
+ };
6706
+ note: {
6707
+ type: "string";
6708
+ };
6709
+ value: {
6710
+ type: "string";
6711
+ description: string;
6712
+ };
6713
+ };
6714
+ required: string[];
6715
+ title: string;
6716
+ additionalProperties: false;
6717
+ };
6718
+ };
6719
+ parameters: {};
6720
+ };
6721
+ deleteBotApiKey: {
6722
+ name: string;
6723
+ description: string;
6724
+ method: "delete";
6725
+ section: "bot";
6726
+ path: string;
6727
+ parameters: {
6728
+ id: {
6729
+ type: "string";
6730
+ description: string;
6731
+ in: "path";
6732
+ };
6733
+ };
6734
+ response: {
6735
+ description: string;
6736
+ schema: {
6737
+ type: "object";
6738
+ title: string;
6739
+ additionalProperties: false;
6740
+ };
6741
+ };
6742
+ };
6626
6743
  listWorkspaceInvoices: {
6627
6744
  name: string;
6628
6745
  description: string;
@@ -15054,6 +15171,7 @@ export declare const state: {
15054
15171
  createBotVersionBody: true;
15055
15172
  deployBotVersionBody: true;
15056
15173
  createIntegrationShareableIdBody: true;
15174
+ createBotApiKeyBody: true;
15057
15175
  chargeWorkspaceUnpaidInvoicesBody: true;
15058
15176
  createWorkspaceBody: true;
15059
15177
  updateWorkspaceBody: true;
@@ -15170,6 +15288,9 @@ export declare const state: {
15170
15288
  createIntegrationShareableIdResponse: true;
15171
15289
  deleteIntegrationShareableIdResponse: true;
15172
15290
  getIntegrationShareableIdResponse: true;
15291
+ listBotApiKeysResponse: true;
15292
+ createBotApiKeyResponse: true;
15293
+ deleteBotApiKeyResponse: true;
15173
15294
  listWorkspaceInvoicesResponse: true;
15174
15295
  getUpcomingInvoiceResponse: true;
15175
15296
  chargeWorkspaceUnpaidInvoicesResponse: true;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@botpress/api",
3
- "version": "1.5.1",
3
+ "version": "1.6.0",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/src/index.d.ts",
6
6
  "scripts": {