@botpress/api 1.28.2 → 1.30.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
 
2
- > @botpress/api@1.28.2 openapi /home/runner/work/skynet/skynet/packages/public-api
2
+ > @botpress/api@1.30.0 openapi /home/runner/work/skynet/skynet/packages/public-api
3
3
  > es-node openapi/generator.ts && pnpm run build
4
4
 
5
5
  Generating openapi content
@@ -34,18 +34,18 @@ Saving openapi.json file
34
34
 
35
35
  info: Exit with code {"category":"system","code":0,"label":"Shutdown"}
36
36
 
37
- > @botpress/api@1.28.2 build /home/runner/work/skynet/skynet/packages/public-api
37
+ > @botpress/api@1.30.0 build /home/runner/work/skynet/skynet/packages/public-api
38
38
  > pnpm run build:type && pnpm run build:impl
39
39
 
40
40
 
41
- > @botpress/api@1.28.2 build:type /home/runner/work/skynet/skynet/packages/public-api
41
+ > @botpress/api@1.30.0 build:type /home/runner/work/skynet/skynet/packages/public-api
42
42
  > tsc -p tsconfig.package.json --emitDeclarationOnly
43
43
 
44
44
 
45
- > @botpress/api@1.28.2 build:impl /home/runner/work/skynet/skynet/packages/public-api
45
+ > @botpress/api@1.30.0 build:impl /home/runner/work/skynet/skynet/packages/public-api
46
46
  > esbuild --bundle --platform=node --outfile=dist/index.js src/index.ts
47
47
 
48
48
 
49
49
  dist/index.js 14.1mb ⚠️
50
50
 
51
- ⚡ Done in 1023ms
51
+ ⚡ Done in 1006ms
package/dist/index.js CHANGED
@@ -285326,7 +285326,7 @@ var state = {
285326
285326
  "title": "Botpress API",
285327
285327
  "description": "API for Botpress Cloud",
285328
285328
  "server": "https://api.botpress.cloud",
285329
- "version": "1.28.2",
285329
+ "version": "1.30.0",
285330
285330
  "prefix": "v1"
285331
285331
  },
285332
285332
  "errors": [
@@ -285739,11 +285739,19 @@ var state = {
285739
285739
  "type": "object",
285740
285740
  "properties": {
285741
285741
  "integrationId": {
285742
- "type": "string"
285742
+ "type": "string",
285743
+ "minLength": 28,
285744
+ "maxLength": 36
285745
+ },
285746
+ "interfaceId": {
285747
+ "type": "string",
285748
+ "minLength": 28,
285749
+ "maxLength": 36
285743
285750
  }
285744
285751
  },
285745
285752
  "required": [
285746
- "integrationId"
285753
+ "integrationId",
285754
+ "interfaceId"
285747
285755
  ],
285748
285756
  "additionalProperties": false
285749
285757
  },
@@ -297379,6 +297387,72 @@ var state2 = {
297379
297387
  }
297380
297388
  }
297381
297389
  },
297390
+ "setWorkspacePreference": {
297391
+ "name": "setWorkspacePreference",
297392
+ "description": "Set a preference for the workspace",
297393
+ "method": "post",
297394
+ "path": "/v1/admin/workspaces/preferences/{key}",
297395
+ "section": "workspace",
297396
+ "disableDefaultParameters": {
297397
+ "x-workspace-id": true
297398
+ },
297399
+ "parameters": {
297400
+ "key": {
297401
+ "type": "string",
297402
+ "description": "Preference key",
297403
+ "in": "path"
297404
+ }
297405
+ },
297406
+ "requestBody": {
297407
+ "description": "Preference value",
297408
+ "schema": {
297409
+ "type": "object",
297410
+ "properties": {
297411
+ "value": {}
297412
+ },
297413
+ "title": "setWorkspacePreferenceBody",
297414
+ "additionalProperties": false
297415
+ }
297416
+ },
297417
+ "response": {
297418
+ "description": "Success",
297419
+ "schema": {
297420
+ "type": "object",
297421
+ "title": "setWorkspacePreferenceResponse",
297422
+ "additionalProperties": false
297423
+ }
297424
+ }
297425
+ },
297426
+ "getWorkspacePreference": {
297427
+ "name": "getWorkspacePreference",
297428
+ "description": "Get a preference of the workspace",
297429
+ "method": "get",
297430
+ "path": "/v1/admin/workspaces/preferences/{key}",
297431
+ "section": "workspace",
297432
+ "disableDefaultParameters": {
297433
+ "x-workspace-id": true
297434
+ },
297435
+ "parameters": {
297436
+ "key": {
297437
+ "type": "string",
297438
+ "description": "Preference key",
297439
+ "in": "path"
297440
+ }
297441
+ },
297442
+ "response": {
297443
+ "description": "Success",
297444
+ "schema": {
297445
+ "type": "object",
297446
+ "properties": {
297447
+ "value": {
297448
+ "nullable": true
297449
+ }
297450
+ },
297451
+ "title": "getWorkspacePreferenceResponse",
297452
+ "additionalProperties": false
297453
+ }
297454
+ }
297455
+ },
297382
297456
  "listWorkspaceMembers": {
297383
297457
  "name": "listWorkspaceMembers",
297384
297458
  "description": "Lists all the members in a workspace",
@@ -302963,7 +303037,7 @@ var state2 = {
302963
303037
  "title": "Botpress API",
302964
303038
  "description": "API for Botpress Cloud",
302965
303039
  "server": "https://api.botpress.cloud",
302966
- "version": "1.28.2",
303040
+ "version": "1.30.0",
302967
303041
  "prefix": "v1"
302968
303042
  },
302969
303043
  "errors": [
@@ -303108,6 +303182,7 @@ var state2 = {
303108
303182
  "createWorkspaceBody": true,
303109
303183
  "updateWorkspaceBody": true,
303110
303184
  "checkHandleAvailabilityBody": true,
303185
+ "setWorkspacePreferenceBody": true,
303111
303186
  "createWorkspaceMemberBody": true,
303112
303187
  "updateWorkspaceMemberBody": true,
303113
303188
  "createIntegrationApiKeyBody": true,
@@ -303188,6 +303263,8 @@ var state2 = {
303188
303263
  "listPublicWorkspacesResponse": true,
303189
303264
  "deleteWorkspaceResponse": true,
303190
303265
  "getAuditRecordsResponse": true,
303266
+ "setWorkspacePreferenceResponse": true,
303267
+ "getWorkspacePreferenceResponse": true,
303191
303268
  "listWorkspaceMembersResponse": true,
303192
303269
  "getWorkspaceMemberResponse": true,
303193
303270
  "deleteWorkspaceMemberResponse": true,
@@ -303443,11 +303520,19 @@ var state2 = {
303443
303520
  "type": "object",
303444
303521
  "properties": {
303445
303522
  "integrationId": {
303446
- "type": "string"
303523
+ "type": "string",
303524
+ "minLength": 28,
303525
+ "maxLength": 36
303526
+ },
303527
+ "interfaceId": {
303528
+ "type": "string",
303529
+ "minLength": 28,
303530
+ "maxLength": 36
303447
303531
  }
303448
303532
  },
303449
303533
  "required": [
303450
- "integrationId"
303534
+ "integrationId",
303535
+ "interfaceId"
303451
303536
  ],
303452
303537
  "additionalProperties": false
303453
303538
  },
@@ -306919,7 +307004,9 @@ var state2 = {
306919
307004
  "listWorkspaces",
306920
307005
  "listPublicWorkspaces",
306921
307006
  "deleteWorkspace",
306922
- "getAuditRecords"
307007
+ "getAuditRecords",
307008
+ "setWorkspacePreference",
307009
+ "getWorkspacePreference"
306923
307010
  ],
306924
307011
  "schema": "Workspace"
306925
307012
  },
@@ -308788,7 +308875,7 @@ var state3 = {
308788
308875
  "title": "Botpress API",
308789
308876
  "description": "API for Botpress Cloud",
308790
308877
  "server": "https://api.botpress.cloud",
308791
- "version": "1.28.2",
308878
+ "version": "1.30.0",
308792
308879
  "prefix": "v1"
308793
308880
  },
308794
308881
  "errors": [
@@ -309154,11 +309241,19 @@ var state3 = {
309154
309241
  "type": "object",
309155
309242
  "properties": {
309156
309243
  "integrationId": {
309157
- "type": "string"
309244
+ "type": "string",
309245
+ "minLength": 28,
309246
+ "maxLength": 36
309247
+ },
309248
+ "interfaceId": {
309249
+ "type": "string",
309250
+ "minLength": 28,
309251
+ "maxLength": 36
309158
309252
  }
309159
309253
  },
309160
309254
  "required": [
309161
- "integrationId"
309255
+ "integrationId",
309256
+ "interfaceId"
309162
309257
  ],
309163
309258
  "additionalProperties": false
309164
309259
  },
@@ -313842,7 +313937,7 @@ var state4 = {
313842
313937
  "title": "Botpress API",
313843
313938
  "description": "API for Botpress Cloud",
313844
313939
  "server": "https://api.botpress.cloud",
313845
- "version": "1.28.2",
313940
+ "version": "1.30.0",
313846
313941
  "prefix": "v1"
313847
313942
  },
313848
313943
  "errors": [
@@ -314215,11 +314310,19 @@ var state4 = {
314215
314310
  "type": "object",
314216
314311
  "properties": {
314217
314312
  "integrationId": {
314218
- "type": "string"
314313
+ "type": "string",
314314
+ "minLength": 28,
314315
+ "maxLength": 36
314316
+ },
314317
+ "interfaceId": {
314318
+ "type": "string",
314319
+ "minLength": 28,
314320
+ "maxLength": 36
314219
314321
  }
314220
314322
  },
314221
314323
  "required": [
314222
- "integrationId"
314324
+ "integrationId",
314325
+ "interfaceId"
314223
314326
  ],
314224
314327
  "additionalProperties": false
314225
314328
  },
@@ -328411,6 +328514,72 @@ var state5 = {
328411
328514
  }
328412
328515
  }
328413
328516
  },
328517
+ "setWorkspacePreference": {
328518
+ "name": "setWorkspacePreference",
328519
+ "description": "Set a preference for the workspace",
328520
+ "method": "post",
328521
+ "path": "/v1/admin/workspaces/preferences/{key}",
328522
+ "section": "workspace",
328523
+ "disableDefaultParameters": {
328524
+ "x-workspace-id": true
328525
+ },
328526
+ "parameters": {
328527
+ "key": {
328528
+ "type": "string",
328529
+ "description": "Preference key",
328530
+ "in": "path"
328531
+ }
328532
+ },
328533
+ "requestBody": {
328534
+ "description": "Preference value",
328535
+ "schema": {
328536
+ "type": "object",
328537
+ "properties": {
328538
+ "value": {}
328539
+ },
328540
+ "title": "setWorkspacePreferenceBody",
328541
+ "additionalProperties": false
328542
+ }
328543
+ },
328544
+ "response": {
328545
+ "description": "Success",
328546
+ "schema": {
328547
+ "type": "object",
328548
+ "title": "setWorkspacePreferenceResponse",
328549
+ "additionalProperties": false
328550
+ }
328551
+ }
328552
+ },
328553
+ "getWorkspacePreference": {
328554
+ "name": "getWorkspacePreference",
328555
+ "description": "Get a preference of the workspace",
328556
+ "method": "get",
328557
+ "path": "/v1/admin/workspaces/preferences/{key}",
328558
+ "section": "workspace",
328559
+ "disableDefaultParameters": {
328560
+ "x-workspace-id": true
328561
+ },
328562
+ "parameters": {
328563
+ "key": {
328564
+ "type": "string",
328565
+ "description": "Preference key",
328566
+ "in": "path"
328567
+ }
328568
+ },
328569
+ "response": {
328570
+ "description": "Success",
328571
+ "schema": {
328572
+ "type": "object",
328573
+ "properties": {
328574
+ "value": {
328575
+ "nullable": true
328576
+ }
328577
+ },
328578
+ "title": "getWorkspacePreferenceResponse",
328579
+ "additionalProperties": false
328580
+ }
328581
+ }
328582
+ },
328414
328583
  "listWorkspaceMembers": {
328415
328584
  "name": "listWorkspaceMembers",
328416
328585
  "description": "Lists all the members in a workspace",
@@ -336970,7 +337139,7 @@ var state5 = {
336970
337139
  "title": "Botpress API",
336971
337140
  "description": "API for Botpress Cloud",
336972
337141
  "server": "https://api.botpress.cloud",
336973
- "version": "1.28.2",
337142
+ "version": "1.30.0",
336974
337143
  "prefix": "v1"
336975
337144
  },
336976
337145
  "errors": [
@@ -337138,6 +337307,7 @@ var state5 = {
337138
337307
  "createWorkspaceBody": true,
337139
337308
  "updateWorkspaceBody": true,
337140
337309
  "checkHandleAvailabilityBody": true,
337310
+ "setWorkspacePreferenceBody": true,
337141
337311
  "createWorkspaceMemberBody": true,
337142
337312
  "updateWorkspaceMemberBody": true,
337143
337313
  "createIntegrationApiKeyBody": true,
@@ -337280,6 +337450,8 @@ var state5 = {
337280
337450
  "listPublicWorkspacesResponse": true,
337281
337451
  "deleteWorkspaceResponse": true,
337282
337452
  "getAuditRecordsResponse": true,
337453
+ "setWorkspacePreferenceResponse": true,
337454
+ "getWorkspacePreferenceResponse": true,
337283
337455
  "listWorkspaceMembersResponse": true,
337284
337456
  "getWorkspaceMemberResponse": true,
337285
337457
  "deleteWorkspaceMemberResponse": true,
@@ -337567,11 +337739,19 @@ var state5 = {
337567
337739
  "type": "object",
337568
337740
  "properties": {
337569
337741
  "integrationId": {
337570
- "type": "string"
337742
+ "type": "string",
337743
+ "minLength": 28,
337744
+ "maxLength": 36
337745
+ },
337746
+ "interfaceId": {
337747
+ "type": "string",
337748
+ "minLength": 28,
337749
+ "maxLength": 36
337571
337750
  }
337572
337751
  },
337573
337752
  "required": [
337574
- "integrationId"
337753
+ "integrationId",
337754
+ "interfaceId"
337575
337755
  ],
337576
337756
  "additionalProperties": false
337577
337757
  },
@@ -341097,7 +341277,9 @@ var state5 = {
341097
341277
  "listWorkspaces",
341098
341278
  "listPublicWorkspaces",
341099
341279
  "deleteWorkspace",
341100
- "getAuditRecords"
341280
+ "getAuditRecords",
341281
+ "setWorkspacePreference",
341282
+ "getWorkspacePreference"
341101
341283
  ],
341102
341284
  "schema": "Workspace"
341103
341285
  },
@@ -7058,6 +7058,72 @@ export declare const state: {
7058
7058
  };
7059
7059
  };
7060
7060
  };
7061
+ setWorkspacePreference: {
7062
+ name: string;
7063
+ description: string;
7064
+ method: "post";
7065
+ path: string;
7066
+ section: "workspace";
7067
+ disableDefaultParameters: {
7068
+ "x-workspace-id": boolean;
7069
+ };
7070
+ parameters: {
7071
+ key: {
7072
+ type: "string";
7073
+ description: string;
7074
+ in: "path";
7075
+ };
7076
+ };
7077
+ requestBody: {
7078
+ description: string;
7079
+ schema: {
7080
+ type: "object";
7081
+ properties: {
7082
+ value: {};
7083
+ };
7084
+ title: string;
7085
+ additionalProperties: false;
7086
+ };
7087
+ };
7088
+ response: {
7089
+ description: string;
7090
+ schema: {
7091
+ type: "object";
7092
+ title: string;
7093
+ additionalProperties: false;
7094
+ };
7095
+ };
7096
+ };
7097
+ getWorkspacePreference: {
7098
+ name: string;
7099
+ description: string;
7100
+ method: "get";
7101
+ path: string;
7102
+ section: "workspace";
7103
+ disableDefaultParameters: {
7104
+ "x-workspace-id": boolean;
7105
+ };
7106
+ parameters: {
7107
+ key: {
7108
+ type: "string";
7109
+ description: string;
7110
+ in: "path";
7111
+ };
7112
+ };
7113
+ response: {
7114
+ description: string;
7115
+ schema: {
7116
+ type: "object";
7117
+ properties: {
7118
+ value: {
7119
+ nullable: true;
7120
+ };
7121
+ };
7122
+ title: string;
7123
+ additionalProperties: false;
7124
+ };
7125
+ };
7126
+ };
7061
7127
  listWorkspaceMembers: {
7062
7128
  name: string;
7063
7129
  description: string;
@@ -12166,6 +12232,7 @@ export declare const state: {
12166
12232
  createWorkspaceBody: true;
12167
12233
  updateWorkspaceBody: true;
12168
12234
  checkHandleAvailabilityBody: true;
12235
+ setWorkspacePreferenceBody: true;
12169
12236
  createWorkspaceMemberBody: true;
12170
12237
  updateWorkspaceMemberBody: true;
12171
12238
  createIntegrationApiKeyBody: true;
@@ -12246,6 +12313,8 @@ export declare const state: {
12246
12313
  listPublicWorkspacesResponse: true;
12247
12314
  deleteWorkspaceResponse: true;
12248
12315
  getAuditRecordsResponse: true;
12316
+ setWorkspacePreferenceResponse: true;
12317
+ getWorkspacePreferenceResponse: true;
12249
12318
  listWorkspaceMembersResponse: true;
12250
12319
  getWorkspaceMemberResponse: true;
12251
12320
  deleteWorkspaceMemberResponse: true;
@@ -12471,6 +12540,13 @@ export declare const state: {
12471
12540
  properties: {
12472
12541
  integrationId: {
12473
12542
  type: "string";
12543
+ minLength: number;
12544
+ maxLength: number;
12545
+ };
12546
+ interfaceId: {
12547
+ type: "string";
12548
+ minLength: number;
12549
+ maxLength: number;
12474
12550
  };
12475
12551
  };
12476
12552
  required: string[];
@@ -1742,6 +1742,13 @@ export declare const state: {
1742
1742
  properties: {
1743
1743
  integrationId: {
1744
1744
  type: "string";
1745
+ minLength: number;
1746
+ maxLength: number;
1747
+ };
1748
+ interfaceId: {
1749
+ type: "string";
1750
+ minLength: number;
1751
+ maxLength: number;
1745
1752
  };
1746
1753
  };
1747
1754
  required: string[];
@@ -2660,6 +2660,13 @@ export declare const state: {
2660
2660
  properties: {
2661
2661
  integrationId: {
2662
2662
  type: "string";
2663
+ minLength: number;
2664
+ maxLength: number;
2665
+ };
2666
+ interfaceId: {
2667
+ type: "string";
2668
+ minLength: number;
2669
+ maxLength: number;
2663
2670
  };
2664
2671
  };
2665
2672
  required: string[];
@@ -9405,6 +9405,72 @@ export declare const state: {
9405
9405
  };
9406
9406
  };
9407
9407
  };
9408
+ setWorkspacePreference: {
9409
+ name: string;
9410
+ description: string;
9411
+ method: "post";
9412
+ path: string;
9413
+ section: "workspace";
9414
+ disableDefaultParameters: {
9415
+ "x-workspace-id": boolean;
9416
+ };
9417
+ parameters: {
9418
+ key: {
9419
+ type: "string";
9420
+ description: string;
9421
+ in: "path";
9422
+ };
9423
+ };
9424
+ requestBody: {
9425
+ description: string;
9426
+ schema: {
9427
+ type: "object";
9428
+ properties: {
9429
+ value: {};
9430
+ };
9431
+ title: string;
9432
+ additionalProperties: false;
9433
+ };
9434
+ };
9435
+ response: {
9436
+ description: string;
9437
+ schema: {
9438
+ type: "object";
9439
+ title: string;
9440
+ additionalProperties: false;
9441
+ };
9442
+ };
9443
+ };
9444
+ getWorkspacePreference: {
9445
+ name: string;
9446
+ description: string;
9447
+ method: "get";
9448
+ path: string;
9449
+ section: "workspace";
9450
+ disableDefaultParameters: {
9451
+ "x-workspace-id": boolean;
9452
+ };
9453
+ parameters: {
9454
+ key: {
9455
+ type: "string";
9456
+ description: string;
9457
+ in: "path";
9458
+ };
9459
+ };
9460
+ response: {
9461
+ description: string;
9462
+ schema: {
9463
+ type: "object";
9464
+ properties: {
9465
+ value: {
9466
+ nullable: true;
9467
+ };
9468
+ };
9469
+ title: string;
9470
+ additionalProperties: false;
9471
+ };
9472
+ };
9473
+ };
9408
9474
  listWorkspaceMembers: {
9409
9475
  name: string;
9410
9476
  description: string;
@@ -17094,6 +17160,7 @@ export declare const state: {
17094
17160
  createWorkspaceBody: true;
17095
17161
  updateWorkspaceBody: true;
17096
17162
  checkHandleAvailabilityBody: true;
17163
+ setWorkspacePreferenceBody: true;
17097
17164
  createWorkspaceMemberBody: true;
17098
17165
  updateWorkspaceMemberBody: true;
17099
17166
  createIntegrationApiKeyBody: true;
@@ -17236,6 +17303,8 @@ export declare const state: {
17236
17303
  listPublicWorkspacesResponse: true;
17237
17304
  deleteWorkspaceResponse: true;
17238
17305
  getAuditRecordsResponse: true;
17306
+ setWorkspacePreferenceResponse: true;
17307
+ getWorkspacePreferenceResponse: true;
17239
17308
  listWorkspaceMembersResponse: true;
17240
17309
  getWorkspaceMemberResponse: true;
17241
17310
  deleteWorkspaceMemberResponse: true;
@@ -17493,6 +17562,13 @@ export declare const state: {
17493
17562
  properties: {
17494
17563
  integrationId: {
17495
17564
  type: "string";
17565
+ minLength: number;
17566
+ maxLength: number;
17567
+ };
17568
+ interfaceId: {
17569
+ type: "string";
17570
+ minLength: number;
17571
+ maxLength: number;
17496
17572
  };
17497
17573
  };
17498
17574
  required: string[];
@@ -1354,6 +1354,13 @@ export declare const state: {
1354
1354
  properties: {
1355
1355
  integrationId: {
1356
1356
  type: "string";
1357
+ minLength: number;
1358
+ maxLength: number;
1359
+ };
1360
+ interfaceId: {
1361
+ type: "string";
1362
+ minLength: number;
1363
+ maxLength: number;
1357
1364
  };
1358
1365
  };
1359
1366
  required: string[];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@botpress/api",
3
- "version": "1.28.2",
3
+ "version": "1.30.0",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/src/index.d.ts",
6
6
  "scripts": {