@botpress/api 0.18.5 → 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.
@@ -1,5 +1,5 @@
1
1
  import * as opapi from '@bpinternal/opapi';
2
- export type State = opapi.State<'Bot' | 'Integration' | 'Workspace' | 'WorkspaceMember' | 'Account' | 'Usage' | 'Issue' | 'IssueEvent' | 'Activity' | 'User' | 'Conversation' | 'Event' | 'Message' | 'State' | 'Task' | 'File' | 'Table' | 'Column' | 'Row', never, 'user' | 'conversation' | 'event' | 'message' | 'file' | 'state' | 'hub' | 'action' | 'task' | 'bot' | 'integration' | 'workspace' | 'workspaceMember' | 'account' | 'usage' | 'quotas' | 'helper' | 'activity' | 'tables'>;
2
+ export type State = opapi.State<'Bot' | 'Integration' | 'Workspace' | 'WorkspaceMember' | 'Account' | 'Usage' | 'Issue' | 'IssueEvent' | 'Activity' | 'User' | 'Conversation' | 'Event' | 'Message' | 'State' | 'Task' | 'Table' | 'Column' | 'Row' | 'File', never, 'user' | 'conversation' | 'event' | 'message' | 'file' | 'state' | 'hub' | 'action' | 'task' | 'bot' | 'integration' | 'workspace' | 'workspaceMember' | 'account' | 'usage' | 'quotas' | 'helper' | 'activity' | 'tables' | 'files'>;
3
3
  export declare const state: {
4
4
  operations: {
5
5
  createConversation: {
@@ -6253,46 +6253,121 @@ export declare const state: {
6253
6253
  };
6254
6254
  createFile: {
6255
6255
  name: string;
6256
+ path: string;
6256
6257
  description: string;
6257
6258
  method: "post";
6258
- path: string;
6259
- section: "file";
6260
6259
  requestBody: {
6261
6260
  description: string;
6262
6261
  schema: {
6263
6262
  type: "object";
6264
6263
  properties: {
6265
- botId: {
6266
- type: "string";
6267
- format: string;
6268
- description: string;
6269
- };
6270
- contents: {
6271
- type: "string";
6272
- description: string;
6273
- };
6274
- name: {
6275
- type: "string";
6276
- description: string;
6277
- };
6278
- accessType: {
6279
- type: "string";
6280
- enum: string[];
6281
- description: string;
6264
+ data: {
6265
+ nullable: true;
6282
6266
  };
6283
6267
  };
6284
- required: string[];
6285
6268
  title: string;
6269
+ format: string;
6286
6270
  additionalProperties: false;
6287
6271
  };
6288
6272
  };
6273
+ parameters: {
6274
+ "x-filename": {
6275
+ type: "string";
6276
+ description: string;
6277
+ in: "header";
6278
+ required: true;
6279
+ };
6280
+ "x-tags": {
6281
+ type: "string";
6282
+ description: string;
6283
+ in: "header";
6284
+ };
6285
+ "x-access-policies": {
6286
+ type: "string";
6287
+ description: string;
6288
+ in: "header";
6289
+ };
6290
+ "Content-Type": {
6291
+ type: "string";
6292
+ description: string;
6293
+ in: "header";
6294
+ };
6295
+ "Content-Length": {
6296
+ type: "string";
6297
+ description: string;
6298
+ in: "header";
6299
+ };
6300
+ "x-bot-id": {
6301
+ in: "header";
6302
+ description: string;
6303
+ type: "string";
6304
+ required: true;
6305
+ };
6306
+ "x-integration-id": {
6307
+ in: "header";
6308
+ description: string;
6309
+ type: "string";
6310
+ required: false;
6311
+ };
6312
+ "x-user-id": {
6313
+ in: "header";
6314
+ description: string;
6315
+ type: "string";
6316
+ required: false;
6317
+ };
6318
+ "x-user-role": {
6319
+ in: "header";
6320
+ description: string;
6321
+ type: "string";
6322
+ required: false;
6323
+ };
6324
+ };
6325
+ contentType: "*/*";
6326
+ section: "files";
6289
6327
  response: {
6290
6328
  description: string;
6291
6329
  schema: {
6292
6330
  type: "object";
6293
6331
  properties: {
6294
6332
  file: {
6295
- $ref: string;
6333
+ type: "object";
6334
+ properties: {
6335
+ id: {
6336
+ type: "string";
6337
+ };
6338
+ botId: {
6339
+ type: "string";
6340
+ };
6341
+ filename: {
6342
+ type: "string";
6343
+ };
6344
+ bytes: {
6345
+ type: "number";
6346
+ nullable: true;
6347
+ };
6348
+ tags: {
6349
+ type: "object";
6350
+ additionalProperties: {
6351
+ type: "string";
6352
+ maxLength: number;
6353
+ };
6354
+ description: string;
6355
+ };
6356
+ createdAt: {
6357
+ type: "string";
6358
+ };
6359
+ updatedAt: {
6360
+ type: "string";
6361
+ };
6362
+ accessPolicies: {
6363
+ type: "array";
6364
+ items: {
6365
+ type: "string";
6366
+ };
6367
+ };
6368
+ };
6369
+ required: string[];
6370
+ additionalProperties: false;
6296
6371
  };
6297
6372
  };
6298
6373
  required: string[];
@@ -6300,28 +6375,148 @@ export declare const state: {
6300
6375
  additionalProperties: false;
6301
6376
  };
6302
6377
  };
6303
- parameters: {};
6304
6378
  };
6305
- getFile: {
6379
+ deleteFile: {
6306
6380
  name: string;
6307
- description: string;
6308
- method: "get";
6309
6381
  path: string;
6310
- section: "file";
6382
+ description: string;
6383
+ method: "delete";
6384
+ section: "files";
6311
6385
  parameters: {
6312
6386
  id: {
6313
6387
  type: "string";
6314
6388
  description: string;
6315
6389
  in: "path";
6316
6390
  };
6391
+ "x-bot-id": {
6392
+ in: "header";
6393
+ description: string;
6394
+ type: "string";
6395
+ required: true;
6396
+ };
6397
+ "x-integration-id": {
6398
+ in: "header";
6399
+ description: string;
6400
+ type: "string";
6401
+ required: false;
6402
+ };
6403
+ "x-user-id": {
6404
+ in: "header";
6405
+ description: string;
6406
+ type: "string";
6407
+ required: false;
6408
+ };
6409
+ "x-user-role": {
6410
+ in: "header";
6411
+ description: string;
6412
+ type: "string";
6413
+ required: false;
6414
+ };
6415
+ };
6416
+ response: {
6417
+ description: string;
6418
+ schema: {
6419
+ type: "object";
6420
+ title: string;
6421
+ additionalProperties: false;
6422
+ };
6423
+ };
6424
+ };
6425
+ listFiles: {
6426
+ name: string;
6427
+ path: string;
6428
+ description: string;
6429
+ method: "get";
6430
+ section: "files";
6431
+ parameters: {
6432
+ nextToken: {
6433
+ in: "query";
6434
+ description: string;
6435
+ type: "string";
6436
+ };
6437
+ "x-bot-id": {
6438
+ in: "header";
6439
+ description: string;
6440
+ type: "string";
6441
+ required: true;
6442
+ };
6443
+ "x-integration-id": {
6444
+ in: "header";
6445
+ description: string;
6446
+ type: "string";
6447
+ required: false;
6448
+ };
6449
+ "x-user-id": {
6450
+ in: "header";
6451
+ description: string;
6452
+ type: "string";
6453
+ required: false;
6454
+ };
6455
+ "x-user-role": {
6456
+ in: "header";
6457
+ description: string;
6458
+ type: "string";
6459
+ required: false;
6460
+ };
6461
+ botId: {
6462
+ type: "string";
6463
+ description: string;
6464
+ in: "path";
6465
+ };
6466
+ tags: {
6467
+ in: "query";
6468
+ type: "string";
6469
+ description: string;
6470
+ };
6317
6471
  };
6318
6472
  response: {
6319
6473
  description: string;
6320
6474
  schema: {
6321
6475
  type: "object";
6322
6476
  properties: {
6323
- file: {
6324
- $ref: string;
6477
+ files: {
6478
+ type: "array";
6479
+ items: {
6480
+ type: "object";
6481
+ properties: {
6482
+ id: {
6483
+ type: "string";
6484
+ };
6485
+ botId: {
6486
+ type: "string";
6487
+ };
6488
+ filename: {
6489
+ type: "string";
6490
+ };
6491
+ bytes: {
6492
+ type: "number";
6493
+ nullable: true;
6494
+ };
6495
+ createdAt: {
6496
+ type: "string";
6497
+ };
6498
+ updatedAt: {
6499
+ type: "string";
6500
+ };
6501
+ accessPolicies: {
6502
+ type: "array";
6503
+ items: {
6504
+ type: "string";
6505
+ };
6506
+ };
6507
+ };
6508
+ required: string[];
6509
+ };
6510
+ };
6511
+ meta: {
6512
+ type: "object";
6513
+ properties: {
6514
+ nextToken: {
6515
+ type: "string";
6516
+ description: string;
6517
+ };
6518
+ };
6519
+ additionalProperties: false;
6325
6520
  };
6326
6521
  };
6327
6522
  required: string[];
@@ -6330,88 +6525,216 @@ export declare const state: {
6330
6525
  };
6331
6526
  };
6332
6527
  };
6333
- downloadFile: {
6528
+ getFileMetadata: {
6334
6529
  name: string;
6530
+ path: string;
6335
6531
  description: string;
6336
6532
  method: "get";
6337
- path: string;
6338
- section: "file";
6533
+ section: "files";
6339
6534
  parameters: {
6340
6535
  id: {
6341
6536
  type: "string";
6342
6537
  description: string;
6343
6538
  in: "path";
6344
6539
  };
6540
+ "x-bot-id": {
6541
+ in: "header";
6542
+ description: string;
6543
+ type: "string";
6544
+ required: true;
6545
+ };
6546
+ "x-integration-id": {
6547
+ in: "header";
6548
+ description: string;
6549
+ type: "string";
6550
+ required: false;
6551
+ };
6552
+ "x-user-id": {
6553
+ in: "header";
6554
+ description: string;
6555
+ type: "string";
6556
+ required: false;
6557
+ };
6558
+ "x-user-role": {
6559
+ in: "header";
6560
+ description: string;
6561
+ type: "string";
6562
+ required: false;
6563
+ };
6345
6564
  };
6346
6565
  response: {
6347
6566
  description: string;
6348
6567
  schema: {
6349
- nullable: true;
6568
+ type: "object";
6569
+ properties: {
6570
+ file: {
6571
+ type: "object";
6572
+ properties: {
6573
+ id: {
6574
+ type: "string";
6575
+ };
6576
+ botId: {
6577
+ type: "string";
6578
+ };
6579
+ filename: {
6580
+ type: "string";
6581
+ };
6582
+ bytes: {
6583
+ type: "number";
6584
+ nullable: true;
6585
+ };
6586
+ tags: {
6587
+ type: "object";
6588
+ additionalProperties: {
6589
+ type: "string";
6590
+ maxLength: number;
6591
+ };
6592
+ description: string;
6593
+ };
6594
+ createdAt: {
6595
+ type: "string";
6596
+ };
6597
+ updatedAt: {
6598
+ type: "string";
6599
+ };
6600
+ accessPolicies: {
6601
+ type: "array";
6602
+ items: {
6603
+ type: "string";
6604
+ };
6605
+ };
6606
+ };
6607
+ required: string[];
6608
+ additionalProperties: false;
6609
+ };
6610
+ };
6611
+ required: string[];
6350
6612
  title: string;
6613
+ additionalProperties: false;
6351
6614
  };
6352
6615
  };
6353
6616
  };
6354
- deleteFile: {
6617
+ getFileContent: {
6355
6618
  name: string;
6356
- description: string;
6357
- method: "delete";
6358
6619
  path: string;
6359
- section: "file";
6620
+ description: string;
6621
+ method: "get";
6622
+ section: "files";
6360
6623
  parameters: {
6361
6624
  id: {
6362
6625
  type: "string";
6363
6626
  description: string;
6364
6627
  in: "path";
6365
6628
  };
6629
+ "x-bot-id": {
6630
+ in: "header";
6631
+ description: string;
6632
+ type: "string";
6633
+ required: true;
6634
+ };
6635
+ "x-integration-id": {
6636
+ in: "header";
6637
+ description: string;
6638
+ type: "string";
6639
+ required: false;
6640
+ };
6641
+ "x-user-id": {
6642
+ in: "header";
6643
+ description: string;
6644
+ type: "string";
6645
+ required: false;
6646
+ };
6647
+ "x-user-role": {
6648
+ in: "header";
6649
+ description: string;
6650
+ type: "string";
6651
+ required: false;
6652
+ };
6366
6653
  };
6367
6654
  response: {
6368
6655
  description: string;
6656
+ status: 302;
6369
6657
  schema: {
6370
6658
  type: "object";
6659
+ properties: {
6660
+ data: {
6661
+ nullable: true;
6662
+ };
6663
+ };
6371
6664
  title: string;
6665
+ format: string;
6372
6666
  additionalProperties: false;
6373
6667
  };
6374
6668
  };
6375
6669
  };
6376
- listFiles: {
6670
+ updateFileMetadata: {
6377
6671
  name: string;
6378
- description: string;
6379
- method: "get";
6380
6672
  path: string;
6381
- section: "file";
6673
+ description: string;
6674
+ method: "put";
6675
+ section: "files";
6382
6676
  parameters: {
6383
- nextToken: {
6384
- in: "query";
6677
+ id: {
6678
+ type: "string";
6679
+ description: string;
6680
+ in: "path";
6681
+ };
6682
+ "x-bot-id": {
6683
+ in: "header";
6385
6684
  description: string;
6386
6685
  type: "string";
6686
+ required: true;
6387
6687
  };
6388
- botId: {
6389
- in: "query";
6688
+ "x-integration-id": {
6689
+ in: "header";
6690
+ description: string;
6390
6691
  type: "string";
6692
+ required: false;
6693
+ };
6694
+ "x-user-id": {
6695
+ in: "header";
6391
6696
  description: string;
6392
- required: true;
6697
+ type: "string";
6698
+ required: false;
6699
+ };
6700
+ "x-user-role": {
6701
+ in: "header";
6702
+ description: string;
6703
+ type: "string";
6704
+ required: false;
6393
6705
  };
6394
6706
  };
6395
- response: {
6707
+ requestBody: {
6396
6708
  description: string;
6397
6709
  schema: {
6398
6710
  type: "object";
6399
6711
  properties: {
6400
- files: {
6401
- type: "array";
6402
- items: {
6403
- $ref: string;
6712
+ tags: {
6713
+ type: "object";
6714
+ additionalProperties: {
6715
+ type: "string";
6716
+ maxLength: number;
6404
6717
  };
6718
+ description: string;
6405
6719
  };
6406
- meta: {
6720
+ };
6721
+ required: string[];
6722
+ title: string;
6723
+ additionalProperties: false;
6724
+ };
6725
+ };
6726
+ response: {
6727
+ description: string;
6728
+ schema: {
6729
+ type: "object";
6730
+ properties: {
6731
+ tags: {
6407
6732
  type: "object";
6408
- properties: {
6409
- nextToken: {
6410
- type: "string";
6411
- description: string;
6412
- };
6733
+ additionalProperties: {
6734
+ type: "string";
6735
+ maxLength: number;
6413
6736
  };
6414
- additionalProperties: false;
6737
+ description: string;
6415
6738
  };
6416
6739
  };
6417
6740
  required: string[];
@@ -7172,6 +7495,7 @@ export declare const state: {
7172
7495
  changeAISpendQuotaBody: true;
7173
7496
  introspectBody: true;
7174
7497
  createFileBody: true;
7498
+ updateFileMetadataBody: true;
7175
7499
  createTableBody: true;
7176
7500
  updateTableBody: true;
7177
7501
  renameTableColumnBody: true;
@@ -7277,10 +7601,11 @@ export declare const state: {
7277
7601
  listActivitiesResponse: true;
7278
7602
  introspectResponse: true;
7279
7603
  createFileResponse: true;
7280
- getFileResponse: true;
7281
- downloadFileResponse: true;
7282
7604
  deleteFileResponse: true;
7283
7605
  listFilesResponse: true;
7606
+ getFileMetadataResponse: true;
7607
+ getFileContentResponse: true;
7608
+ updateFileMetadataResponse: true;
7284
7609
  listTablesResponse: true;
7285
7610
  getTableResponse: true;
7286
7611
  createTableResponse: true;
@@ -7310,10 +7635,10 @@ export declare const state: {
7310
7635
  Message: true;
7311
7636
  State: true;
7312
7637
  Task: true;
7313
- File: true;
7314
7638
  Table: true;
7315
7639
  Column: true;
7316
7640
  Row: true;
7641
+ File: true;
7317
7642
  };
7318
7643
  };
7319
7644
  schemas: {
@@ -8756,46 +9081,6 @@ export declare const state: {
8756
9081
  additionalProperties: false;
8757
9082
  };
8758
9083
  };
8759
- File: {
8760
- section: "file";
8761
- schema: {
8762
- type: "object";
8763
- properties: {
8764
- botId: {
8765
- type: "string";
8766
- format: string;
8767
- description: string;
8768
- };
8769
- name: {
8770
- type: "string";
8771
- description: string;
8772
- };
8773
- accessType: {
8774
- type: "string";
8775
- enum: string[];
8776
- description: string;
8777
- };
8778
- id: {
8779
- type: "string";
8780
- description: string;
8781
- };
8782
- createdAt: {
8783
- type: "string";
8784
- description: string;
8785
- };
8786
- size: {
8787
- type: "number";
8788
- description: string;
8789
- };
8790
- publicUrl: {
8791
- type: "string";
8792
- description: string;
8793
- };
8794
- };
8795
- required: string[];
8796
- additionalProperties: false;
8797
- };
8798
- };
8799
9084
  Table: {
8800
9085
  section: "tables";
8801
9086
  schema: {
@@ -8982,6 +9267,49 @@ export declare const state: {
8982
9267
  additionalProperties: true;
8983
9268
  };
8984
9269
  };
9270
+ File: {
9271
+ section: "files";
9272
+ schema: {
9273
+ type: "object";
9274
+ properties: {
9275
+ id: {
9276
+ type: "string";
9277
+ };
9278
+ botId: {
9279
+ type: "string";
9280
+ };
9281
+ filename: {
9282
+ type: "string";
9283
+ };
9284
+ bytes: {
9285
+ type: "number";
9286
+ nullable: true;
9287
+ };
9288
+ tags: {
9289
+ type: "object";
9290
+ additionalProperties: {
9291
+ type: "string";
9292
+ maxLength: number;
9293
+ };
9294
+ description: string;
9295
+ };
9296
+ createdAt: {
9297
+ type: "string";
9298
+ };
9299
+ updatedAt: {
9300
+ type: "string";
9301
+ };
9302
+ accessPolicies: {
9303
+ type: "array";
9304
+ items: {
9305
+ type: "string";
9306
+ };
9307
+ };
9308
+ };
9309
+ required: string[];
9310
+ additionalProperties: false;
9311
+ };
9312
+ };
8985
9313
  };
8986
9314
  sections: ({
8987
9315
  description: string;
@@ -9011,8 +9339,8 @@ export declare const state: {
9011
9339
  description: string;
9012
9340
  title: string;
9013
9341
  name: "file";
9014
- operations: string[];
9015
- schema: string;
9342
+ operations: never[];
9343
+ schema?: undefined;
9016
9344
  } | {
9017
9345
  description: string;
9018
9346
  title: string;
@@ -9097,6 +9425,12 @@ export declare const state: {
9097
9425
  name: "tables";
9098
9426
  operations: string[];
9099
9427
  schema: string;
9428
+ } | {
9429
+ title: string;
9430
+ description: string;
9431
+ name: "files";
9432
+ operations: string[];
9433
+ schema: string;
9100
9434
  })[];
9101
9435
  options: {
9102
9436
  allowUnions: false;