@botpress/api 0.5.1 → 0.5.4

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.
@@ -208,13 +208,6 @@ export declare const state: {
208
208
  };
209
209
  description: string;
210
210
  };
211
- participantIds: {
212
- type: "array";
213
- items: {
214
- type: "string";
215
- };
216
- description: string;
217
- };
218
211
  };
219
212
  required: string[];
220
213
  title: string;
@@ -2134,6 +2127,7 @@ export declare const state: {
2134
2127
  createWorkspace: {
2135
2128
  name: string;
2136
2129
  description: string;
2130
+ section: "workspace";
2137
2131
  method: "post";
2138
2132
  path: string;
2139
2133
  disableDefaultParameters: {
@@ -2197,6 +2191,7 @@ export declare const state: {
2197
2191
  getWorkspace: {
2198
2192
  name: string;
2199
2193
  description: string;
2194
+ section: "workspace";
2200
2195
  method: "get";
2201
2196
  path: string;
2202
2197
  disableDefaultParameters: {
@@ -2252,6 +2247,7 @@ export declare const state: {
2252
2247
  updateWorkspace: {
2253
2248
  name: string;
2254
2249
  description: string;
2250
+ section: "workspace";
2255
2251
  method: "put";
2256
2252
  path: string;
2257
2253
  disableDefaultParameters: {
@@ -2327,6 +2323,7 @@ export declare const state: {
2327
2323
  listWorkspaces: {
2328
2324
  name: string;
2329
2325
  description: string;
2326
+ section: "workspace";
2330
2327
  method: "get";
2331
2328
  path: string;
2332
2329
  disableDefaultParameters: {
@@ -2402,6 +2399,7 @@ export declare const state: {
2402
2399
  changeWorkspacePlan: {
2403
2400
  name: string;
2404
2401
  description: string;
2402
+ section: "workspace";
2405
2403
  method: "put";
2406
2404
  path: string;
2407
2405
  disableDefaultParameters: {
@@ -2472,6 +2470,7 @@ export declare const state: {
2472
2470
  deleteWorkspace: {
2473
2471
  name: string;
2474
2472
  description: string;
2473
+ section: "workspace";
2475
2474
  method: "delete";
2476
2475
  path: string;
2477
2476
  disableDefaultParameters: {
@@ -2496,6 +2495,7 @@ export declare const state: {
2496
2495
  getAuditRecords: {
2497
2496
  name: string;
2498
2497
  description: string;
2498
+ section: "workspace";
2499
2499
  method: "get";
2500
2500
  path: string;
2501
2501
  parameters: {
@@ -2574,6 +2574,191 @@ export declare const state: {
2574
2574
  };
2575
2575
  };
2576
2576
  };
2577
+ listWorkspaceMembers: {
2578
+ name: string;
2579
+ description: string;
2580
+ section: "workspaceMember";
2581
+ method: "get";
2582
+ path: string;
2583
+ parameters: {
2584
+ nextToken: {
2585
+ in: "query";
2586
+ description: string;
2587
+ type: "string";
2588
+ };
2589
+ };
2590
+ response: {
2591
+ description: string;
2592
+ schema: {
2593
+ type: "object";
2594
+ properties: {
2595
+ members: {
2596
+ type: "array";
2597
+ items: {
2598
+ type: "object";
2599
+ properties: {
2600
+ id: {
2601
+ type: "string";
2602
+ };
2603
+ userId: {
2604
+ type: "string";
2605
+ format: string;
2606
+ };
2607
+ email: {
2608
+ type: "string";
2609
+ };
2610
+ role: {
2611
+ type: "string";
2612
+ enum: string[];
2613
+ };
2614
+ };
2615
+ required: string[];
2616
+ };
2617
+ };
2618
+ meta: {
2619
+ type: "object";
2620
+ properties: {
2621
+ nextToken: {
2622
+ type: "string";
2623
+ description: string;
2624
+ };
2625
+ };
2626
+ additionalProperties: false;
2627
+ };
2628
+ };
2629
+ required: string[];
2630
+ title: string;
2631
+ additionalProperties: false;
2632
+ };
2633
+ };
2634
+ };
2635
+ deleteWorkspaceMember: {
2636
+ name: string;
2637
+ description: string;
2638
+ section: "workspaceMember";
2639
+ method: "delete";
2640
+ path: string;
2641
+ parameters: {
2642
+ id: {
2643
+ type: "string";
2644
+ description: string;
2645
+ in: "path";
2646
+ };
2647
+ };
2648
+ response: {
2649
+ description: string;
2650
+ schema: {
2651
+ type: "object";
2652
+ title: string;
2653
+ additionalProperties: false;
2654
+ };
2655
+ };
2656
+ };
2657
+ createWorkspaceMember: {
2658
+ name: string;
2659
+ description: string;
2660
+ section: "workspaceMember";
2661
+ method: "post";
2662
+ path: string;
2663
+ requestBody: {
2664
+ description: string;
2665
+ schema: {
2666
+ type: "object";
2667
+ properties: {
2668
+ email: {
2669
+ type: "string";
2670
+ format: string;
2671
+ };
2672
+ role: {
2673
+ type: "string";
2674
+ enum: string[];
2675
+ };
2676
+ };
2677
+ required: string[];
2678
+ title: string;
2679
+ additionalProperties: false;
2680
+ };
2681
+ };
2682
+ response: {
2683
+ description: string;
2684
+ schema: {
2685
+ type: "object";
2686
+ properties: {
2687
+ id: {
2688
+ type: "string";
2689
+ };
2690
+ userId: {
2691
+ type: "string";
2692
+ format: string;
2693
+ };
2694
+ email: {
2695
+ type: "string";
2696
+ };
2697
+ role: {
2698
+ type: "string";
2699
+ enum: string[];
2700
+ };
2701
+ };
2702
+ required: string[];
2703
+ title: string;
2704
+ additionalProperties: false;
2705
+ };
2706
+ };
2707
+ parameters: {};
2708
+ };
2709
+ updateWorkspaceMember: {
2710
+ name: string;
2711
+ description: string;
2712
+ section: "workspaceMember";
2713
+ method: "put";
2714
+ path: string;
2715
+ parameters: {
2716
+ id: {
2717
+ type: "string";
2718
+ description: string;
2719
+ in: "path";
2720
+ };
2721
+ };
2722
+ requestBody: {
2723
+ description: string;
2724
+ schema: {
2725
+ type: "object";
2726
+ properties: {
2727
+ role: {
2728
+ type: "string";
2729
+ enum: string[];
2730
+ };
2731
+ };
2732
+ title: string;
2733
+ additionalProperties: false;
2734
+ };
2735
+ };
2736
+ response: {
2737
+ description: string;
2738
+ schema: {
2739
+ type: "object";
2740
+ properties: {
2741
+ id: {
2742
+ type: "string";
2743
+ };
2744
+ userId: {
2745
+ type: "string";
2746
+ format: string;
2747
+ };
2748
+ email: {
2749
+ type: "string";
2750
+ };
2751
+ role: {
2752
+ type: "string";
2753
+ enum: string[];
2754
+ };
2755
+ };
2756
+ required: string[];
2757
+ title: string;
2758
+ additionalProperties: false;
2759
+ };
2760
+ };
2761
+ };
2577
2762
  createIntegration: {
2578
2763
  name: string;
2579
2764
  description: string;
@@ -3441,187 +3626,6 @@ export declare const state: {
3441
3626
  };
3442
3627
  };
3443
3628
  };
3444
- listWorkspaceMembers: {
3445
- name: string;
3446
- description: string;
3447
- method: "get";
3448
- path: string;
3449
- parameters: {
3450
- nextToken: {
3451
- in: "query";
3452
- description: string;
3453
- type: "string";
3454
- };
3455
- };
3456
- response: {
3457
- description: string;
3458
- schema: {
3459
- type: "object";
3460
- properties: {
3461
- members: {
3462
- type: "array";
3463
- items: {
3464
- type: "object";
3465
- properties: {
3466
- id: {
3467
- type: "string";
3468
- };
3469
- userId: {
3470
- type: "string";
3471
- format: string;
3472
- };
3473
- email: {
3474
- type: "string";
3475
- };
3476
- role: {
3477
- type: "string";
3478
- enum: string[];
3479
- };
3480
- };
3481
- required: string[];
3482
- };
3483
- };
3484
- meta: {
3485
- type: "object";
3486
- properties: {
3487
- nextToken: {
3488
- type: "string";
3489
- description: string;
3490
- };
3491
- };
3492
- additionalProperties: false;
3493
- };
3494
- };
3495
- required: string[];
3496
- title: string;
3497
- additionalProperties: false;
3498
- };
3499
- };
3500
- };
3501
- deleteWorkspaceMember: {
3502
- name: string;
3503
- description: string;
3504
- method: "delete";
3505
- path: string;
3506
- parameters: {
3507
- id: {
3508
- type: "string";
3509
- description: string;
3510
- in: "path";
3511
- };
3512
- };
3513
- response: {
3514
- description: string;
3515
- schema: {
3516
- type: "object";
3517
- title: string;
3518
- additionalProperties: false;
3519
- };
3520
- };
3521
- };
3522
- createWorkspaceMember: {
3523
- name: string;
3524
- description: string;
3525
- method: "post";
3526
- path: string;
3527
- requestBody: {
3528
- description: string;
3529
- schema: {
3530
- type: "object";
3531
- properties: {
3532
- email: {
3533
- type: "string";
3534
- format: string;
3535
- };
3536
- role: {
3537
- type: "string";
3538
- enum: string[];
3539
- };
3540
- };
3541
- required: string[];
3542
- title: string;
3543
- additionalProperties: false;
3544
- };
3545
- };
3546
- response: {
3547
- description: string;
3548
- schema: {
3549
- type: "object";
3550
- properties: {
3551
- id: {
3552
- type: "string";
3553
- };
3554
- userId: {
3555
- type: "string";
3556
- format: string;
3557
- };
3558
- email: {
3559
- type: "string";
3560
- };
3561
- role: {
3562
- type: "string";
3563
- enum: string[];
3564
- };
3565
- };
3566
- required: string[];
3567
- title: string;
3568
- additionalProperties: false;
3569
- };
3570
- };
3571
- parameters: {};
3572
- };
3573
- updateWorkspaceMember: {
3574
- name: string;
3575
- description: string;
3576
- method: "put";
3577
- path: string;
3578
- parameters: {
3579
- id: {
3580
- type: "string";
3581
- description: string;
3582
- in: "path";
3583
- };
3584
- };
3585
- requestBody: {
3586
- description: string;
3587
- schema: {
3588
- type: "object";
3589
- properties: {
3590
- role: {
3591
- type: "string";
3592
- enum: string[];
3593
- };
3594
- };
3595
- title: string;
3596
- additionalProperties: false;
3597
- };
3598
- };
3599
- response: {
3600
- description: string;
3601
- schema: {
3602
- type: "object";
3603
- properties: {
3604
- id: {
3605
- type: "string";
3606
- };
3607
- userId: {
3608
- type: "string";
3609
- format: string;
3610
- };
3611
- email: {
3612
- type: "string";
3613
- };
3614
- role: {
3615
- type: "string";
3616
- enum: string[];
3617
- };
3618
- };
3619
- required: string[];
3620
- title: string;
3621
- additionalProperties: false;
3622
- };
3623
- };
3624
- };
3625
3629
  introspect: {
3626
3630
  name: string;
3627
3631
  description: string;
@@ -3911,10 +3915,10 @@ export declare const state: {
3911
3915
  createWorkspaceBody: true;
3912
3916
  updateWorkspaceBody: true;
3913
3917
  changeWorkspacePlanBody: true;
3914
- createIntegrationBody: true;
3915
- updateIntegrationBody: true;
3916
3918
  createWorkspaceMemberBody: true;
3917
3919
  updateWorkspaceMemberBody: true;
3920
+ createIntegrationBody: true;
3921
+ updateIntegrationBody: true;
3918
3922
  introspectBody: true;
3919
3923
  createFileBody: true;
3920
3924
  };
@@ -3964,6 +3968,10 @@ export declare const state: {
3964
3968
  changeWorkspacePlanResponse: true;
3965
3969
  deleteWorkspaceResponse: true;
3966
3970
  getAuditRecordsResponse: true;
3971
+ listWorkspaceMembersResponse: true;
3972
+ deleteWorkspaceMemberResponse: true;
3973
+ createWorkspaceMemberResponse: true;
3974
+ updateWorkspaceMemberResponse: true;
3967
3975
  createIntegrationResponse: true;
3968
3976
  updateIntegrationResponse: true;
3969
3977
  listIntegrationsResponse: true;
@@ -3971,10 +3979,6 @@ export declare const state: {
3971
3979
  getIntegrationLogsResponse: true;
3972
3980
  getIntegrationByNameResponse: true;
3973
3981
  deleteIntegrationResponse: true;
3974
- listWorkspaceMembersResponse: true;
3975
- deleteWorkspaceMemberResponse: true;
3976
- createWorkspaceMemberResponse: true;
3977
- updateWorkspaceMemberResponse: true;
3978
3982
  introspectResponse: true;
3979
3983
  createFileResponse: true;
3980
3984
  getFileResponse: true;
@@ -3986,6 +3990,7 @@ export declare const state: {
3986
3990
  Bot: true;
3987
3991
  Integration: true;
3988
3992
  Workspace: true;
3993
+ WorkspaceMember: true;
3989
3994
  User: true;
3990
3995
  Conversation: true;
3991
3996
  Event: true;
@@ -4660,6 +4665,30 @@ export declare const state: {
4660
4665
  additionalProperties: false;
4661
4666
  };
4662
4667
  };
4668
+ WorkspaceMember: {
4669
+ section: "workspaceMember";
4670
+ schema: {
4671
+ type: "object";
4672
+ properties: {
4673
+ id: {
4674
+ type: "string";
4675
+ };
4676
+ userId: {
4677
+ type: "string";
4678
+ format: string;
4679
+ };
4680
+ email: {
4681
+ type: "string";
4682
+ };
4683
+ role: {
4684
+ type: "string";
4685
+ enum: string[];
4686
+ };
4687
+ };
4688
+ required: string[];
4689
+ additionalProperties: false;
4690
+ };
4691
+ };
4663
4692
  User: {
4664
4693
  section: "user";
4665
4694
  schema: {
@@ -4966,7 +4995,13 @@ export declare const state: {
4966
4995
  description: string;
4967
4996
  title: string;
4968
4997
  name: "workspace";
4969
- operations: never[];
4998
+ operations: string[];
4999
+ schema: string;
5000
+ } | {
5001
+ description: string;
5002
+ title: string;
5003
+ name: "workspaceMember";
5004
+ operations: string[];
4970
5005
  schema: string;
4971
5006
  })[];
4972
5007
  };
package/dist/index.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  export declare const api: {
2
- getModelRef: (name: "Bot" | "Integration" | "Workspace" | "User" | "Conversation" | "Event" | "Message" | "State" | "File") => import("@bpinternal/opapi").OpenApiZodAny;
3
- addOperation: <Path extends string>(operationProps: import("@bpinternal/opapi").Operation<"x-workspace-id", "user" | "conversation" | "event" | "message" | "file" | "state" | "hub" | "action" | "bot" | "integration" | "workspace", Path, "zod-schema">) => void;
2
+ getModelRef: (name: "Bot" | "Integration" | "Workspace" | "WorkspaceMember" | "User" | "Conversation" | "Event" | "Message" | "State" | "File") => import("@bpinternal/opapi").OpenApiZodAny;
3
+ addOperation: <Path extends string>(operationProps: import("@bpinternal/opapi").Operation<"x-workspace-id", "user" | "conversation" | "event" | "message" | "file" | "state" | "hub" | "action" | "bot" | "integration" | "workspace" | "workspaceMember", Path, "zod-schema">) => void;
4
4
  exportClient: (dir: string | undefined, openapiGeneratorEndpoint: string, postProcessors?: import("@bpinternal/opapi").OpenApiPostProcessors | undefined) => Promise<void>;
5
5
  exportTypesBySection: (dir?: string | undefined) => Promise<void>;
6
6
  exportServer: (dir: string | undefined, useExpressTypes: boolean) => Promise<void>;