@botpress/api 0.31.0 → 0.32.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' | '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'>;
2
+ export type State = opapi.State<'Bot' | 'Integration' | 'Interface' | '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' | 'interface' | 'workspace' | 'workspaceMember' | 'account' | 'usage' | 'quotas' | 'helper' | 'activity' | 'tables' | 'files'>;
3
3
  export declare const state: {
4
4
  operations: {
5
5
  createConversation: {
@@ -7321,6 +7321,429 @@ export declare const state: {
7321
7321
  };
7322
7322
  };
7323
7323
  };
7324
+ createInterface: {
7325
+ name: string;
7326
+ description: string;
7327
+ method: "post";
7328
+ path: string;
7329
+ parameters: {};
7330
+ requestBody: {
7331
+ description: string;
7332
+ schema: {
7333
+ type: "object";
7334
+ properties: {
7335
+ name: {
7336
+ type: "string";
7337
+ maxLength: number;
7338
+ description: string;
7339
+ };
7340
+ version: {
7341
+ type: "string";
7342
+ maxLength: number;
7343
+ description: string;
7344
+ };
7345
+ events: {
7346
+ type: "object";
7347
+ additionalProperties: {
7348
+ type: "object";
7349
+ properties: {
7350
+ title: {
7351
+ type: "string";
7352
+ maxLength: number;
7353
+ description: string;
7354
+ };
7355
+ description: {
7356
+ type: "string";
7357
+ maxLength: number;
7358
+ description: string;
7359
+ };
7360
+ schema: {
7361
+ type: "object";
7362
+ additionalProperties: true;
7363
+ };
7364
+ };
7365
+ required: string[];
7366
+ description: string;
7367
+ additionalProperties: false;
7368
+ };
7369
+ };
7370
+ actions: {
7371
+ type: "object";
7372
+ additionalProperties: {
7373
+ type: "object";
7374
+ properties: {
7375
+ title: {
7376
+ type: "string";
7377
+ maxLength: number;
7378
+ description: string;
7379
+ };
7380
+ description: {
7381
+ type: "string";
7382
+ maxLength: number;
7383
+ description: string;
7384
+ };
7385
+ input: {
7386
+ type: "object";
7387
+ properties: {
7388
+ schema: {
7389
+ type: "object";
7390
+ additionalProperties: true;
7391
+ };
7392
+ };
7393
+ required: string[];
7394
+ additionalProperties: false;
7395
+ };
7396
+ output: {
7397
+ type: "object";
7398
+ properties: {
7399
+ schema: {
7400
+ type: "object";
7401
+ additionalProperties: true;
7402
+ };
7403
+ };
7404
+ required: string[];
7405
+ additionalProperties: false;
7406
+ };
7407
+ };
7408
+ required: string[];
7409
+ description: string;
7410
+ additionalProperties: false;
7411
+ };
7412
+ };
7413
+ entities: {
7414
+ type: "object";
7415
+ additionalProperties: {
7416
+ type: "object";
7417
+ properties: {
7418
+ title: {
7419
+ type: "string";
7420
+ maxLength: number;
7421
+ description: string;
7422
+ };
7423
+ description: {
7424
+ type: "string";
7425
+ maxLength: number;
7426
+ description: string;
7427
+ };
7428
+ schema: {
7429
+ type: "object";
7430
+ additionalProperties: true;
7431
+ };
7432
+ };
7433
+ required: string[];
7434
+ description: string;
7435
+ additionalProperties: false;
7436
+ };
7437
+ };
7438
+ };
7439
+ required: string[];
7440
+ title: string;
7441
+ additionalProperties: false;
7442
+ };
7443
+ };
7444
+ section: "interface";
7445
+ response: {
7446
+ description: string;
7447
+ schema: {
7448
+ type: "object";
7449
+ properties: {
7450
+ interface: {
7451
+ $ref: string;
7452
+ };
7453
+ };
7454
+ required: string[];
7455
+ title: string;
7456
+ additionalProperties: false;
7457
+ };
7458
+ };
7459
+ };
7460
+ getInterface: {
7461
+ name: string;
7462
+ description: string;
7463
+ method: "get";
7464
+ path: string;
7465
+ parameters: {
7466
+ id: {
7467
+ in: "path";
7468
+ type: "string";
7469
+ description: string;
7470
+ };
7471
+ };
7472
+ section: "interface";
7473
+ response: {
7474
+ description: string;
7475
+ schema: {
7476
+ type: "object";
7477
+ properties: {
7478
+ interface: {
7479
+ $ref: string;
7480
+ };
7481
+ };
7482
+ required: string[];
7483
+ title: string;
7484
+ additionalProperties: false;
7485
+ };
7486
+ };
7487
+ };
7488
+ getInterfaceByName: {
7489
+ name: string;
7490
+ description: string;
7491
+ method: "get";
7492
+ path: string;
7493
+ parameters: {
7494
+ name: {
7495
+ in: "path";
7496
+ type: "string";
7497
+ description: string;
7498
+ };
7499
+ version: {
7500
+ in: "path";
7501
+ type: "string";
7502
+ description: string;
7503
+ };
7504
+ };
7505
+ section: "interface";
7506
+ response: {
7507
+ description: string;
7508
+ schema: {
7509
+ type: "object";
7510
+ properties: {
7511
+ interface: {
7512
+ $ref: string;
7513
+ };
7514
+ };
7515
+ required: string[];
7516
+ title: string;
7517
+ additionalProperties: false;
7518
+ };
7519
+ };
7520
+ };
7521
+ updateInterface: {
7522
+ name: string;
7523
+ description: string;
7524
+ method: "put";
7525
+ path: string;
7526
+ parameters: {
7527
+ id: {
7528
+ in: "path";
7529
+ type: "string";
7530
+ description: string;
7531
+ };
7532
+ };
7533
+ requestBody: {
7534
+ description: string;
7535
+ schema: {
7536
+ type: "object";
7537
+ properties: {
7538
+ events: {
7539
+ type: "object";
7540
+ additionalProperties: {
7541
+ type: "object";
7542
+ properties: {
7543
+ title: {
7544
+ type: "string";
7545
+ maxLength: number;
7546
+ description: string;
7547
+ };
7548
+ description: {
7549
+ type: "string";
7550
+ maxLength: number;
7551
+ description: string;
7552
+ };
7553
+ schema: {
7554
+ type: "object";
7555
+ additionalProperties: true;
7556
+ };
7557
+ };
7558
+ required: string[];
7559
+ description: string;
7560
+ nullable: true;
7561
+ additionalProperties: false;
7562
+ };
7563
+ };
7564
+ actions: {
7565
+ type: "object";
7566
+ additionalProperties: {
7567
+ type: "object";
7568
+ properties: {
7569
+ title: {
7570
+ type: "string";
7571
+ maxLength: number;
7572
+ description: string;
7573
+ };
7574
+ description: {
7575
+ type: "string";
7576
+ maxLength: number;
7577
+ description: string;
7578
+ };
7579
+ input: {
7580
+ type: "object";
7581
+ properties: {
7582
+ schema: {
7583
+ type: "object";
7584
+ additionalProperties: true;
7585
+ };
7586
+ };
7587
+ required: string[];
7588
+ additionalProperties: false;
7589
+ };
7590
+ output: {
7591
+ type: "object";
7592
+ properties: {
7593
+ schema: {
7594
+ type: "object";
7595
+ additionalProperties: true;
7596
+ };
7597
+ };
7598
+ required: string[];
7599
+ additionalProperties: false;
7600
+ };
7601
+ };
7602
+ required: string[];
7603
+ description: string;
7604
+ nullable: true;
7605
+ additionalProperties: false;
7606
+ };
7607
+ };
7608
+ entities: {
7609
+ type: "object";
7610
+ additionalProperties: {
7611
+ type: "object";
7612
+ properties: {
7613
+ title: {
7614
+ type: "string";
7615
+ maxLength: number;
7616
+ description: string;
7617
+ };
7618
+ description: {
7619
+ type: "string";
7620
+ maxLength: number;
7621
+ description: string;
7622
+ };
7623
+ schema: {
7624
+ type: "object";
7625
+ additionalProperties: true;
7626
+ };
7627
+ };
7628
+ required: string[];
7629
+ description: string;
7630
+ nullable: true;
7631
+ additionalProperties: false;
7632
+ };
7633
+ };
7634
+ };
7635
+ title: string;
7636
+ additionalProperties: false;
7637
+ };
7638
+ };
7639
+ section: "interface";
7640
+ response: {
7641
+ description: string;
7642
+ schema: {
7643
+ type: "object";
7644
+ properties: {
7645
+ interface: {
7646
+ $ref: string;
7647
+ };
7648
+ };
7649
+ required: string[];
7650
+ title: string;
7651
+ additionalProperties: false;
7652
+ };
7653
+ };
7654
+ };
7655
+ deleteInterface: {
7656
+ name: string;
7657
+ description: string;
7658
+ method: "delete";
7659
+ path: string;
7660
+ parameters: {
7661
+ id: {
7662
+ in: "path";
7663
+ type: "string";
7664
+ description: string;
7665
+ };
7666
+ };
7667
+ section: "interface";
7668
+ response: {
7669
+ description: string;
7670
+ schema: {
7671
+ type: "object";
7672
+ title: string;
7673
+ additionalProperties: false;
7674
+ };
7675
+ };
7676
+ };
7677
+ listInterfaces: {
7678
+ name: string;
7679
+ description: string;
7680
+ method: "get";
7681
+ path: string;
7682
+ section: "interface";
7683
+ parameters: {
7684
+ nextToken: {
7685
+ in: "query";
7686
+ description: string;
7687
+ type: "string";
7688
+ };
7689
+ };
7690
+ response: {
7691
+ description: string;
7692
+ schema: {
7693
+ type: "object";
7694
+ properties: {
7695
+ interfaces: {
7696
+ type: "array";
7697
+ items: {
7698
+ type: "object";
7699
+ properties: {
7700
+ id: {
7701
+ type: "string";
7702
+ minLength: number;
7703
+ maxLength: number;
7704
+ description: string;
7705
+ };
7706
+ createdAt: {
7707
+ type: "string";
7708
+ format: string;
7709
+ description: string;
7710
+ };
7711
+ updatedAt: {
7712
+ type: "string";
7713
+ format: string;
7714
+ description: string;
7715
+ };
7716
+ name: {
7717
+ type: "string";
7718
+ maxLength: number;
7719
+ description: string;
7720
+ };
7721
+ version: {
7722
+ type: "string";
7723
+ maxLength: number;
7724
+ description: string;
7725
+ };
7726
+ };
7727
+ required: string[];
7728
+ };
7729
+ };
7730
+ meta: {
7731
+ type: "object";
7732
+ properties: {
7733
+ nextToken: {
7734
+ type: "string";
7735
+ description: string;
7736
+ };
7737
+ };
7738
+ additionalProperties: false;
7739
+ };
7740
+ };
7741
+ required: string[];
7742
+ title: string;
7743
+ additionalProperties: false;
7744
+ };
7745
+ };
7746
+ };
7324
7747
  getUsage: {
7325
7748
  name: string;
7326
7749
  path: string;
@@ -9087,6 +9510,8 @@ export declare const state: {
9087
9510
  createIntegrationApiKeyBody: true;
9088
9511
  createIntegrationBody: true;
9089
9512
  updateIntegrationBody: true;
9513
+ createInterfaceBody: true;
9514
+ updateInterfaceBody: true;
9090
9515
  changeAISpendQuotaBody: true;
9091
9516
  introspectBody: true;
9092
9517
  upsertFileBody: true;
@@ -9197,6 +9622,12 @@ export declare const state: {
9197
9622
  getIntegrationLogsResponse: true;
9198
9623
  getIntegrationByNameResponse: true;
9199
9624
  deleteIntegrationResponse: true;
9625
+ createInterfaceResponse: true;
9626
+ getInterfaceResponse: true;
9627
+ getInterfaceByNameResponse: true;
9628
+ updateInterfaceResponse: true;
9629
+ deleteInterfaceResponse: true;
9630
+ listInterfacesResponse: true;
9200
9631
  getUsageResponse: true;
9201
9632
  getMultipleUsagesResponse: true;
9202
9633
  listUsageHistoryResponse: true;
@@ -9227,6 +9658,7 @@ export declare const state: {
9227
9658
  schemas: {
9228
9659
  Bot: true;
9229
9660
  Integration: true;
9661
+ Interface: true;
9230
9662
  Workspace: true;
9231
9663
  WorkspaceMember: true;
9232
9664
  Account: true;
@@ -10110,6 +10542,135 @@ export declare const state: {
10110
10542
  additionalProperties: false;
10111
10543
  };
10112
10544
  };
10545
+ Interface: {
10546
+ section: "interface";
10547
+ schema: {
10548
+ type: "object";
10549
+ properties: {
10550
+ id: {
10551
+ type: "string";
10552
+ minLength: number;
10553
+ maxLength: number;
10554
+ description: string;
10555
+ };
10556
+ createdAt: {
10557
+ type: "string";
10558
+ format: string;
10559
+ description: string;
10560
+ };
10561
+ updatedAt: {
10562
+ type: "string";
10563
+ format: string;
10564
+ description: string;
10565
+ };
10566
+ name: {
10567
+ type: "string";
10568
+ maxLength: number;
10569
+ description: string;
10570
+ };
10571
+ version: {
10572
+ type: "string";
10573
+ maxLength: number;
10574
+ description: string;
10575
+ };
10576
+ events: {
10577
+ type: "object";
10578
+ additionalProperties: {
10579
+ type: "object";
10580
+ properties: {
10581
+ title: {
10582
+ type: "string";
10583
+ maxLength: number;
10584
+ description: string;
10585
+ };
10586
+ description: {
10587
+ type: "string";
10588
+ maxLength: number;
10589
+ description: string;
10590
+ };
10591
+ schema: {
10592
+ type: "object";
10593
+ additionalProperties: true;
10594
+ };
10595
+ };
10596
+ required: string[];
10597
+ description: string;
10598
+ additionalProperties: false;
10599
+ };
10600
+ };
10601
+ actions: {
10602
+ type: "object";
10603
+ additionalProperties: {
10604
+ type: "object";
10605
+ properties: {
10606
+ title: {
10607
+ type: "string";
10608
+ maxLength: number;
10609
+ description: string;
10610
+ };
10611
+ description: {
10612
+ type: "string";
10613
+ maxLength: number;
10614
+ description: string;
10615
+ };
10616
+ input: {
10617
+ type: "object";
10618
+ properties: {
10619
+ schema: {
10620
+ type: "object";
10621
+ additionalProperties: true;
10622
+ };
10623
+ };
10624
+ required: string[];
10625
+ additionalProperties: false;
10626
+ };
10627
+ output: {
10628
+ type: "object";
10629
+ properties: {
10630
+ schema: {
10631
+ type: "object";
10632
+ additionalProperties: true;
10633
+ };
10634
+ };
10635
+ required: string[];
10636
+ additionalProperties: false;
10637
+ };
10638
+ };
10639
+ required: string[];
10640
+ description: string;
10641
+ additionalProperties: false;
10642
+ };
10643
+ };
10644
+ entities: {
10645
+ type: "object";
10646
+ additionalProperties: {
10647
+ type: "object";
10648
+ properties: {
10649
+ title: {
10650
+ type: "string";
10651
+ maxLength: number;
10652
+ description: string;
10653
+ };
10654
+ description: {
10655
+ type: "string";
10656
+ maxLength: number;
10657
+ description: string;
10658
+ };
10659
+ schema: {
10660
+ type: "object";
10661
+ additionalProperties: true;
10662
+ };
10663
+ };
10664
+ required: string[];
10665
+ description: string;
10666
+ additionalProperties: false;
10667
+ };
10668
+ };
10669
+ };
10670
+ required: string[];
10671
+ additionalProperties: false;
10672
+ };
10673
+ };
10113
10674
  Workspace: {
10114
10675
  section: "workspace";
10115
10676
  schema: {
@@ -11199,6 +11760,12 @@ export declare const state: {
11199
11760
  name: "integration";
11200
11761
  operations: string[];
11201
11762
  schema: string;
11763
+ } | {
11764
+ title: string;
11765
+ description: string;
11766
+ name: "interface";
11767
+ operations: string[];
11768
+ schema: string;
11202
11769
  } | {
11203
11770
  title: string;
11204
11771
  description: string;
@@ -1,7 +1,7 @@
1
1
  export * from './gen/state';
2
2
  export declare const api: {
3
- getModelRef: (name: "Bot" | "Integration" | "Workspace" | "WorkspaceMember" | "Account" | "Usage" | "Issue" | "IssueEvent" | "Activity" | "User" | "Conversation" | "Event" | "Message" | "State" | "Task" | "Table" | "Column" | "Row" | "File") => import("@bpinternal/opapi").OpenApiZodAny;
4
- addOperation: <Path extends string>(operationProps: import("@bpinternal/opapi").Operation<"x-integration-id" | "x-workspace-id", "user" | "conversation" | "event" | "message" | "file" | "state" | "hub" | "action" | "task" | "bot" | "integration" | "workspace" | "workspaceMember" | "account" | "usage" | "quotas" | "helper" | "activity" | "tables" | "files", Path, "zod-schema">) => void;
3
+ getModelRef: (name: "Bot" | "Integration" | "Interface" | "Workspace" | "WorkspaceMember" | "Account" | "Usage" | "Issue" | "IssueEvent" | "Activity" | "User" | "Conversation" | "Event" | "Message" | "State" | "Task" | "Table" | "Column" | "Row" | "File") => import("@bpinternal/opapi").OpenApiZodAny;
4
+ addOperation: <Path extends string>(operationProps: import("@bpinternal/opapi").Operation<"x-integration-id" | "x-workspace-id", "user" | "conversation" | "event" | "message" | "file" | "state" | "hub" | "action" | "task" | "bot" | "integration" | "interface" | "workspace" | "workspaceMember" | "account" | "usage" | "quotas" | "helper" | "activity" | "tables" | "files", Path, "zod-schema">) => void;
5
5
  exportClient: {
6
6
  (dir: string, openapiGeneratorEndpoint: string, postProcessors?: import("@bpinternal/opapi").OpenApiPostProcessors | undefined): Promise<void>;
7
7
  (dir: string, props: import("@bpinternal/opapi").GenerateClientProps): Promise<void>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@botpress/api",
3
- "version": "0.31.0",
3
+ "version": "0.32.0",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/src/index.d.ts",
6
6
  "scripts": {