@botpress/api 0.3.2 → 0.4.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 (5) hide show
  1. package/dist/gen/state.d.ts +203 -5
  2. package/dist/index.js +237 -11
  3. package/package.json +1 -1
  4. package/src/gen/openapi.json +1 -1
  5. package/src/gen/state.ts +238 -6
package/dist/gen/state.d.ts CHANGED
@@ -1784,7 +1784,6 @@ export declare const state: {
1784
1784
  additionalProperties: true;
1785
1785
  };
1786
1786
  };
1787
- required: string[];
1788
1787
  nullable: true;
1789
1788
  additionalProperties: false;
1790
1789
  };
@@ -2132,6 +2131,69 @@ export declare const state: {
2132
2131
  };
2133
2132
  };
2134
2133
  };
2134
+ createWorkspace: {
2135
+ name: string;
2136
+ description: string;
2137
+ method: "post";
2138
+ path: string;
2139
+ disableDefaultParameters: {
2140
+ "x-workspace-id": boolean;
2141
+ };
2142
+ requestBody: {
2143
+ description: string;
2144
+ schema: {
2145
+ type: "object";
2146
+ properties: {
2147
+ name: {
2148
+ type: "string";
2149
+ };
2150
+ };
2151
+ required: string[];
2152
+ title: string;
2153
+ additionalProperties: false;
2154
+ };
2155
+ };
2156
+ response: {
2157
+ description: string;
2158
+ schema: {
2159
+ type: "object";
2160
+ properties: {
2161
+ id: {
2162
+ type: "string";
2163
+ };
2164
+ name: {
2165
+ type: "string";
2166
+ };
2167
+ ownerId: {
2168
+ type: "string";
2169
+ };
2170
+ createdAt: {
2171
+ type: "string";
2172
+ };
2173
+ updatedAt: {
2174
+ type: "string";
2175
+ };
2176
+ botCount: {
2177
+ type: "number";
2178
+ };
2179
+ accountType: {
2180
+ type: "string";
2181
+ enum: string[];
2182
+ };
2183
+ blocked: {
2184
+ type: "boolean";
2185
+ };
2186
+ spendingLimit: {
2187
+ type: "number";
2188
+ };
2189
+ };
2190
+ required: string[];
2191
+ title: string;
2192
+ additionalProperties: false;
2193
+ };
2194
+ };
2195
+ parameters: {};
2196
+ };
2135
2197
  getWorkspace: {
2136
2198
  name: string;
2137
2199
  description: string;
@@ -2192,6 +2254,9 @@ export declare const state: {
2192
2254
  description: string;
2193
2255
  method: "put";
2194
2256
  path: string;
2257
+ disableDefaultParameters: {
2258
+ "x-workspace-id": boolean;
2259
+ };
2195
2260
  parameters: {
2196
2261
  id: {
2197
2262
  type: "string";
@@ -2209,10 +2274,6 @@ export declare const state: {
2209
2274
  minLength: number;
2210
2275
  maxLength: number;
2211
2276
  };
2212
- accountType: {
2213
- type: "string";
2214
- enum: string[];
2215
- };
2216
2277
  spendingLimit: {
2217
2278
  type: "number";
2218
2279
  minimum: number;
@@ -2310,8 +2371,15 @@ export declare const state: {
2310
2371
  type: "string";
2311
2372
  enum: string[];
2312
2373
  };
2374
+ blocked: {
2375
+ type: "boolean";
2376
+ };
2377
+ spendingLimit: {
2378
+ type: "number";
2379
+ };
2313
2380
  };
2314
2381
  required: string[];
2382
+ title: string;
2315
2383
  };
2316
2384
  };
2317
2385
  meta: {
@@ -2331,6 +2399,100 @@ export declare const state: {
2331
2399
  };
2332
2400
  };
2333
2401
  };
2402
+ changeWorkspacePlan: {
2403
+ name: string;
2404
+ description: string;
2405
+ method: "put";
2406
+ path: string;
2407
+ disableDefaultParameters: {
2408
+ "x-workspace-id": boolean;
2409
+ };
2410
+ parameters: {
2411
+ id: {
2412
+ type: "string";
2413
+ description: string;
2414
+ in: "path";
2415
+ };
2416
+ };
2417
+ requestBody: {
2418
+ description: string;
2419
+ schema: {
2420
+ type: "object";
2421
+ properties: {
2422
+ plan: {
2423
+ type: "string";
2424
+ enum: string[];
2425
+ };
2426
+ };
2427
+ required: string[];
2428
+ title: string;
2429
+ additionalProperties: false;
2430
+ };
2431
+ };
2432
+ response: {
2433
+ description: string;
2434
+ schema: {
2435
+ type: "object";
2436
+ properties: {
2437
+ id: {
2438
+ type: "string";
2439
+ };
2440
+ name: {
2441
+ type: "string";
2442
+ };
2443
+ ownerId: {
2444
+ type: "string";
2445
+ };
2446
+ createdAt: {
2447
+ type: "string";
2448
+ };
2449
+ updatedAt: {
2450
+ type: "string";
2451
+ };
2452
+ botCount: {
2453
+ type: "number";
2454
+ };
2455
+ accountType: {
2456
+ type: "string";
2457
+ enum: string[];
2458
+ };
2459
+ blocked: {
2460
+ type: "boolean";
2461
+ };
2462
+ spendingLimit: {
2463
+ type: "number";
2464
+ };
2465
+ };
2466
+ required: string[];
2467
+ title: string;
2468
+ additionalProperties: false;
2469
+ };
2470
+ };
2471
+ };
2472
+ deleteWorkspace: {
2473
+ name: string;
2474
+ description: string;
2475
+ method: "delete";
2476
+ path: string;
2477
+ disableDefaultParameters: {
2478
+ "x-workspace-id": boolean;
2479
+ };
2480
+ parameters: {
2481
+ id: {
2482
+ type: "string";
2483
+ description: string;
2484
+ in: "path";
2485
+ };
2486
+ };
2487
+ response: {
2488
+ description: string;
2489
+ schema: {
2490
+ type: "object";
2491
+ title: string;
2492
+ additionalProperties: false;
2493
+ };
2494
+ };
2495
+ };
2334
2496
  createIntegration: {
2335
2497
  name: string;
2336
2498
  description: string;
@@ -3661,7 +3823,9 @@ export declare const state: {
3661
3823
  createBotBody: true;
3662
3824
  updateBotBody: true;
3663
3825
  transferBotBody: true;
3826
+ createWorkspaceBody: true;
3664
3827
  updateWorkspaceBody: true;
3828
+ changeWorkspacePlanBody: true;
3665
3829
  createIntegrationBody: true;
3666
3830
  updateIntegrationBody: true;
3667
3831
  createWorkspaceMemberBody: true;
@@ -3708,9 +3872,12 @@ export declare const state: {
3708
3872
  getBotLogsResponse: true;
3709
3873
  getBotWebchatResponse: true;
3710
3874
  getBotAnalyticsResponse: true;
3875
+ createWorkspaceResponse: true;
3711
3876
  getWorkspaceResponse: true;
3712
3877
  updateWorkspaceResponse: true;
3713
3878
  listWorkspacesResponse: true;
3879
+ changeWorkspacePlanResponse: true;
3880
+ deleteWorkspaceResponse: true;
3714
3881
  createIntegrationResponse: true;
3715
3882
  updateIntegrationResponse: true;
3716
3883
  listIntegrationsResponse: true;
@@ -3776,9 +3943,11 @@ export declare const state: {
3776
3943
  };
3777
3944
  name: {
3778
3945
  type: "string";
3946
+ description: string;
3779
3947
  };
3780
3948
  version: {
3781
3949
  type: "string";
3950
+ description: string;
3782
3951
  };
3783
3952
  webhookUrl: {
3784
3953
  type: "string";
@@ -3795,6 +3964,35 @@ export declare const state: {
3795
3964
  type: "string";
3796
3965
  nullable: true;
3797
3966
  };
3967
+ id: {
3968
+ type: "string";
3969
+ description: string;
3970
+ };
3971
+ createdAt: {
3972
+ type: "string";
3973
+ format: string;
3974
+ description: string;
3975
+ };
3976
+ updatedAt: {
3977
+ type: "string";
3978
+ format: string;
3979
+ description: string;
3980
+ };
3981
+ title: {
3982
+ type: "string";
3983
+ minLength: number;
3984
+ maxLength: number;
3985
+ description: string;
3986
+ };
3987
+ description: {
3988
+ type: "string";
3989
+ maxLength: number;
3990
+ description: string;
3991
+ };
3992
+ iconUrl: {
3993
+ type: "string";
3994
+ description: string;
3995
+ };
3798
3996
  };
3799
3997
  required: string[];
3800
3998
  additionalProperties: false;
package/dist/index.js CHANGED
@@ -227243,7 +227243,6 @@ var state = {
227243
227243
  additionalProperties: true
227244
227244
  }
227245
227245
  },
227246
- required: ["enabled", "configuration"],
227247
227246
  nullable: true,
227248
227247
  additionalProperties: false
227249
227248
  }
@@ -227598,6 +227597,79 @@ var state = {
227598
227597
  }
227599
227598
  }
227600
227599
  },
227600
+ createWorkspace: {
227601
+ name: "createWorkspace",
227602
+ description: "Create workspace",
227603
+ method: "post",
227604
+ path: "/v1/admin/workspaces",
227605
+ disableDefaultParameters: {
227606
+ "x-workspace-id": true
227607
+ },
227608
+ requestBody: {
227609
+ description: "Workspace metadata",
227610
+ schema: {
227611
+ type: "object",
227612
+ properties: {
227613
+ name: {
227614
+ type: "string"
227615
+ }
227616
+ },
227617
+ required: ["name"],
227618
+ title: "createWorkspaceBody",
227619
+ additionalProperties: false
227620
+ }
227621
+ },
227622
+ response: {
227623
+ description: "Success",
227624
+ schema: {
227625
+ type: "object",
227626
+ properties: {
227627
+ id: {
227628
+ type: "string"
227629
+ },
227630
+ name: {
227631
+ type: "string"
227632
+ },
227633
+ ownerId: {
227634
+ type: "string"
227635
+ },
227636
+ createdAt: {
227637
+ type: "string"
227638
+ },
227639
+ updatedAt: {
227640
+ type: "string"
227641
+ },
227642
+ botCount: {
227643
+ type: "number"
227644
+ },
227645
+ accountType: {
227646
+ type: "string",
227647
+ enum: ["free", "premium"]
227648
+ },
227649
+ blocked: {
227650
+ type: "boolean"
227651
+ },
227652
+ spendingLimit: {
227653
+ type: "number"
227654
+ }
227655
+ },
227656
+ required: [
227657
+ "id",
227658
+ "name",
227659
+ "ownerId",
227660
+ "createdAt",
227661
+ "updatedAt",
227662
+ "botCount",
227663
+ "accountType",
227664
+ "blocked",
227665
+ "spendingLimit"
227666
+ ],
227667
+ title: "createWorkspaceResponse",
227668
+ additionalProperties: false
227669
+ }
227670
+ },
227671
+ parameters: {}
227672
+ },
227601
227673
  getWorkspace: {
227602
227674
  name: "getWorkspace",
227603
227675
  description: "Get workspace details",
@@ -227668,6 +227740,9 @@ var state = {
227668
227740
  description: "Update workspace",
227669
227741
  method: "put",
227670
227742
  path: "/v1/admin/workspaces/{id}",
227743
+ disableDefaultParameters: {
227744
+ "x-workspace-id": true
227745
+ },
227671
227746
  parameters: {
227672
227747
  id: {
227673
227748
  type: "string",
@@ -227685,10 +227760,6 @@ var state = {
227685
227760
  minLength: 1,
227686
227761
  maxLength: 64
227687
227762
  },
227688
- accountType: {
227689
- type: "string",
227690
- enum: ["free", "premium"]
227691
- },
227692
227763
  spendingLimit: {
227693
227764
  type: "number",
227694
227765
  minimum: 5,
@@ -227795,6 +227866,12 @@ var state = {
227795
227866
  accountType: {
227796
227867
  type: "string",
227797
227868
  enum: ["free", "premium"]
227869
+ },
227870
+ blocked: {
227871
+ type: "boolean"
227872
+ },
227873
+ spendingLimit: {
227874
+ type: "number"
227798
227875
  }
227799
227876
  },
227800
227877
  required: [
@@ -227804,8 +227881,11 @@ var state = {
227804
227881
  "createdAt",
227805
227882
  "updatedAt",
227806
227883
  "botCount",
227807
- "accountType"
227808
- ]
227884
+ "accountType",
227885
+ "blocked",
227886
+ "spendingLimit"
227887
+ ],
227888
+ title: "updateWorkspaceResponse"
227809
227889
  }
227810
227890
  },
227811
227891
  meta: {
@@ -227825,6 +227905,110 @@ var state = {
227825
227905
  }
227826
227906
  }
227827
227907
  },
227908
+ changeWorkspacePlan: {
227909
+ name: "changeWorkspacePlan",
227910
+ description: "Change workspace billing plan",
227911
+ method: "put",
227912
+ path: "/v1/admin/workspaces/{id}/change-plan",
227913
+ disableDefaultParameters: {
227914
+ "x-workspace-id": true
227915
+ },
227916
+ parameters: {
227917
+ id: {
227918
+ type: "string",
227919
+ description: "Workspace ID",
227920
+ in: "path"
227921
+ }
227922
+ },
227923
+ requestBody: {
227924
+ description: "Billing plan to change the workspace to",
227925
+ schema: {
227926
+ type: "object",
227927
+ properties: {
227928
+ plan: {
227929
+ type: "string",
227930
+ enum: ["free", "premium"]
227931
+ }
227932
+ },
227933
+ required: ["plan"],
227934
+ title: "changeWorkspacePlanBody",
227935
+ additionalProperties: false
227936
+ }
227937
+ },
227938
+ response: {
227939
+ description: "Success",
227940
+ schema: {
227941
+ type: "object",
227942
+ properties: {
227943
+ id: {
227944
+ type: "string"
227945
+ },
227946
+ name: {
227947
+ type: "string"
227948
+ },
227949
+ ownerId: {
227950
+ type: "string"
227951
+ },
227952
+ createdAt: {
227953
+ type: "string"
227954
+ },
227955
+ updatedAt: {
227956
+ type: "string"
227957
+ },
227958
+ botCount: {
227959
+ type: "number"
227960
+ },
227961
+ accountType: {
227962
+ type: "string",
227963
+ enum: ["free", "premium"]
227964
+ },
227965
+ blocked: {
227966
+ type: "boolean"
227967
+ },
227968
+ spendingLimit: {
227969
+ type: "number"
227970
+ }
227971
+ },
227972
+ required: [
227973
+ "id",
227974
+ "name",
227975
+ "ownerId",
227976
+ "createdAt",
227977
+ "updatedAt",
227978
+ "botCount",
227979
+ "accountType",
227980
+ "blocked",
227981
+ "spendingLimit"
227982
+ ],
227983
+ title: "changeWorkspacePlanResponse",
227984
+ additionalProperties: false
227985
+ }
227986
+ }
227987
+ },
227988
+ deleteWorkspace: {
227989
+ name: "deleteWorkspace",
227990
+ description: "Delete workspace",
227991
+ method: "delete",
227992
+ path: "/v1/admin/workspaces/{id}",
227993
+ disableDefaultParameters: {
227994
+ "x-workspace-id": true
227995
+ },
227996
+ parameters: {
227997
+ id: {
227998
+ type: "string",
227999
+ description: "Workspace ID",
228000
+ in: "path"
228001
+ }
228002
+ },
228003
+ response: {
228004
+ description: "Success",
228005
+ schema: {
228006
+ type: "object",
228007
+ title: "deleteWorkspaceResponse",
228008
+ additionalProperties: false
228009
+ }
228010
+ }
228011
+ },
227828
228012
  createIntegration: {
227829
228013
  name: "createIntegration",
227830
228014
  description: "Create integration",
@@ -229135,7 +229319,7 @@ var state = {
229135
229319
  title: "Botpress API",
229136
229320
  description: "API for Botpress Cloud",
229137
229321
  server: "https://api.botpress.cloud",
229138
- version: "0.3.2",
229322
+ version: "0.4.0",
229139
229323
  prefix: "v1"
229140
229324
  },
229141
229325
  errors: [
@@ -229250,7 +229434,9 @@ var state = {
229250
229434
  createBotBody: true,
229251
229435
  updateBotBody: true,
229252
229436
  transferBotBody: true,
229437
+ createWorkspaceBody: true,
229253
229438
  updateWorkspaceBody: true,
229439
+ changeWorkspacePlanBody: true,
229254
229440
  createIntegrationBody: true,
229255
229441
  updateIntegrationBody: true,
229256
229442
  createWorkspaceMemberBody: true,
@@ -229297,9 +229483,12 @@ var state = {
229297
229483
  getBotLogsResponse: true,
229298
229484
  getBotWebchatResponse: true,
229299
229485
  getBotAnalyticsResponse: true,
229486
+ createWorkspaceResponse: true,
229300
229487
  getWorkspaceResponse: true,
229301
229488
  updateWorkspaceResponse: true,
229302
229489
  listWorkspacesResponse: true,
229490
+ changeWorkspacePlanResponse: true,
229491
+ deleteWorkspaceResponse: true,
229303
229492
  createIntegrationResponse: true,
229304
229493
  updateIntegrationResponse: true,
229305
229494
  listIntegrationsResponse: true,
@@ -229364,10 +229553,12 @@ var state = {
229364
229553
  type: "boolean"
229365
229554
  },
229366
229555
  name: {
229367
- type: "string"
229556
+ type: "string",
229557
+ description: "Name of the [Integration](#schema_integration)"
229368
229558
  },
229369
229559
  version: {
229370
- type: "string"
229560
+ type: "string",
229561
+ description: "Version of the [Integration](#schema_integration)"
229371
229562
  },
229372
229563
  webhookUrl: {
229373
229564
  type: "string"
@@ -229390,6 +229581,35 @@ var state = {
229390
229581
  statusReason: {
229391
229582
  type: "string",
229392
229583
  nullable: true
229584
+ },
229585
+ id: {
229586
+ type: "string",
229587
+ description: "Id of the [Integration](#schema_integration)"
229588
+ },
229589
+ createdAt: {
229590
+ type: "string",
229591
+ format: "date-time",
229592
+ description: "Creation date of the [Integration](#schema_integration) in the ISO 8601 format"
229593
+ },
229594
+ updatedAt: {
229595
+ type: "string",
229596
+ format: "date-time",
229597
+ description: "Updating date of the [Integration](#schema_integration) in the ISO 8601 format"
229598
+ },
229599
+ title: {
229600
+ type: "string",
229601
+ minLength: 1,
229602
+ maxLength: 64,
229603
+ description: "Title of the integration. This is the name that will be displayed in the UI"
229604
+ },
229605
+ description: {
229606
+ type: "string",
229607
+ maxLength: 256,
229608
+ description: "Description of the integration. This is the description that will be displayed in the UI"
229609
+ },
229610
+ iconUrl: {
229611
+ type: "string",
229612
+ description: "URL of the icon of the integration. This is the icon that will be displayed in the UI"
229393
229613
  }
229394
229614
  },
229395
229615
  required: [
@@ -229399,7 +229619,13 @@ var state = {
229399
229619
  "webhookUrl",
229400
229620
  "configuration",
229401
229621
  "status",
229402
- "statusReason"
229622
+ "statusReason",
229623
+ "id",
229624
+ "createdAt",
229625
+ "updatedAt",
229626
+ "title",
229627
+ "description",
229628
+ "iconUrl"
229403
229629
  ],
229404
229630
  additionalProperties: false
229405
229631
  },
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@botpress/api",
3
- "version": "0.3.2",
3
+ "version": "0.4.0",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/index.d.ts",
6
6
  "scripts": {