@botpress/api 1.56.0 → 1.58.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/index.js +93 -5
  2. package/dist/src/gen/files/state.d.ts +24 -0
  3. package/dist/src/gen/state.d.ts +44 -0
  4. package/dist/src/gen/tables/state.d.ts +20 -0
  5. package/package.json +2 -2
package/dist/index.js CHANGED
@@ -286155,7 +286155,7 @@ var state = {
286155
286155
  "title": "Botpress Runtime API",
286156
286156
  "description": "API for Botpress Runtime",
286157
286157
  "server": "https://api.botpress.cloud",
286158
- "version": "1.56.0",
286158
+ "version": "1.58.0",
286159
286159
  "prefix": "v1"
286160
286160
  },
286161
286161
  "defaultParameters": {
@@ -302453,7 +302453,7 @@ var state2 = {
302453
302453
  "title": "Botpress Admin API",
302454
302454
  "description": "API for Botpress Cloud Manager",
302455
302455
  "server": "https://api.botpress.cloud",
302456
- "version": "1.56.0",
302456
+ "version": "1.58.0",
302457
302457
  "prefix": "v1"
302458
302458
  },
302459
302459
  "defaultParameters": {
@@ -305735,6 +305735,10 @@ var state3 = {
305735
305735
  "name": {
305736
305736
  "type": "string",
305737
305737
  "description": 'This field is present if the `type` is "integration". If `type` is "integration", this is the integration name.'
305738
+ },
305739
+ "alias": {
305740
+ "type": "string",
305741
+ "description": 'This field is present if the `type` is "integration". If `type` is "integration", this is the integration instance alias.'
305738
305742
  }
305739
305743
  },
305740
305744
  "required": [
@@ -306084,6 +306088,10 @@ var state3 = {
306084
306088
  "name": {
306085
306089
  "type": "string",
306086
306090
  "description": 'This field is present if the `type` is "integration". If `type` is "integration", this is the integration name.'
306091
+ },
306092
+ "alias": {
306093
+ "type": "string",
306094
+ "description": 'This field is present if the `type` is "integration". If `type` is "integration", this is the integration instance alias.'
306087
306095
  }
306088
306096
  },
306089
306097
  "required": [
@@ -306298,6 +306306,10 @@ var state3 = {
306298
306306
  "name": {
306299
306307
  "type": "string",
306300
306308
  "description": 'This field is present if the `type` is "integration". If `type` is "integration", this is the integration name.'
306309
+ },
306310
+ "alias": {
306311
+ "type": "string",
306312
+ "description": 'This field is present if the `type` is "integration". If `type` is "integration", this is the integration instance alias.'
306301
306313
  }
306302
306314
  },
306303
306315
  "required": [
@@ -306541,6 +306553,10 @@ var state3 = {
306541
306553
  "name": {
306542
306554
  "type": "string",
306543
306555
  "description": 'This field is present if the `type` is "integration". If `type` is "integration", this is the integration name.'
306556
+ },
306557
+ "alias": {
306558
+ "type": "string",
306559
+ "description": 'This field is present if the `type` is "integration". If `type` is "integration", this is the integration instance alias.'
306544
306560
  }
306545
306561
  },
306546
306562
  "required": [
@@ -306769,6 +306785,10 @@ var state3 = {
306769
306785
  "name": {
306770
306786
  "type": "string",
306771
306787
  "description": 'This field is present if the `type` is "integration". If `type` is "integration", this is the integration name.'
306788
+ },
306789
+ "alias": {
306790
+ "type": "string",
306791
+ "description": 'This field is present if the `type` is "integration". If `type` is "integration", this is the integration instance alias.'
306772
306792
  }
306773
306793
  },
306774
306794
  "required": [
@@ -307889,7 +307909,7 @@ var state3 = {
307889
307909
  "title": "Botpress Files API",
307890
307910
  "description": "API for Botpress Files",
307891
307911
  "server": "https://api.botpress.cloud",
307892
- "version": "1.56.0",
307912
+ "version": "1.58.0",
307893
307913
  "prefix": "v1"
307894
307914
  },
307895
307915
  "defaultParameters": {
@@ -308195,6 +308215,10 @@ var state3 = {
308195
308215
  "name": {
308196
308216
  "type": "string",
308197
308217
  "description": 'This field is present if the `type` is "integration". If `type` is "integration", this is the integration name.'
308218
+ },
308219
+ "alias": {
308220
+ "type": "string",
308221
+ "description": 'This field is present if the `type` is "integration". If `type` is "integration", this is the integration instance alias.'
308198
308222
  }
308199
308223
  },
308200
308224
  "required": [
@@ -308497,6 +308521,11 @@ var state4 = {
308497
308521
  "type": "boolean",
308498
308522
  "description": 'A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.'
308499
308523
  },
308524
+ "keyColumn": {
308525
+ "type": "string",
308526
+ "nullable": true,
308527
+ "description": "Designate a column as the primary unique identifier for this table. When set, a unique index is automatically created on this column, enabling significantly faster upsert operations. All values in this column must be unique across the table. When set to null, the key index is removed."
308528
+ },
308500
308529
  "schema": {
308501
308530
  "type": "object",
308502
308531
  "additionalProperties": true,
@@ -308588,6 +308617,11 @@ var state4 = {
308588
308617
  "type": "boolean",
308589
308618
  "description": 'A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.'
308590
308619
  },
308620
+ "keyColumn": {
308621
+ "type": "string",
308622
+ "nullable": true,
308623
+ "description": "Designate a column as the primary unique identifier for this table. When set, a unique index is automatically created on this column, enabling significantly faster upsert operations. All values in this column must be unique across the table. When set to null, the key index is removed."
308624
+ },
308591
308625
  "schema": {
308592
308626
  "type": "object",
308593
308627
  "additionalProperties": true,
@@ -309249,6 +309283,11 @@ var state4 = {
309249
309283
  "type": "boolean",
309250
309284
  "description": 'A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.'
309251
309285
  },
309286
+ "keyColumn": {
309287
+ "type": "string",
309288
+ "nullable": true,
309289
+ "description": "Designate a column as the primary unique identifier for this table. When set, a unique index is automatically created on this column, enabling significantly faster upsert operations. All values in this column must be unique across the table. When set to null, the key index is removed."
309290
+ },
309252
309291
  "schema": {
309253
309292
  "type": "object",
309254
309293
  "additionalProperties": true,
@@ -310155,7 +310194,7 @@ var state4 = {
310155
310194
  "title": "Botpress Tables API",
310156
310195
  "description": "API for Botpress Tables",
310157
310196
  "server": "https://api.botpress.cloud",
310158
- "version": "1.56.0",
310197
+ "version": "1.58.0",
310159
310198
  "prefix": "v1"
310160
310199
  },
310161
310200
  "defaultParameters": {
@@ -310389,6 +310428,11 @@ var state4 = {
310389
310428
  "type": "boolean",
310390
310429
  "description": 'A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.'
310391
310430
  },
310431
+ "keyColumn": {
310432
+ "type": "string",
310433
+ "nullable": true,
310434
+ "description": "Designate a column as the primary unique identifier for this table. When set, a unique index is automatically created on this column, enabling significantly faster upsert operations. All values in this column must be unique across the table. When set to null, the key index is removed."
310435
+ },
310392
310436
  "schema": {
310393
310437
  "type": "object",
310394
310438
  "properties": {
@@ -328200,6 +328244,10 @@ var state5 = {
328200
328244
  "name": {
328201
328245
  "type": "string",
328202
328246
  "description": 'This field is present if the `type` is "integration". If `type` is "integration", this is the integration name.'
328247
+ },
328248
+ "alias": {
328249
+ "type": "string",
328250
+ "description": 'This field is present if the `type` is "integration". If `type` is "integration", this is the integration instance alias.'
328203
328251
  }
328204
328252
  },
328205
328253
  "required": [
@@ -328440,6 +328488,10 @@ var state5 = {
328440
328488
  "name": {
328441
328489
  "type": "string",
328442
328490
  "description": 'This field is present if the `type` is "integration". If `type` is "integration", this is the integration name.'
328491
+ },
328492
+ "alias": {
328493
+ "type": "string",
328494
+ "description": 'This field is present if the `type` is "integration". If `type` is "integration", this is the integration instance alias.'
328443
328495
  }
328444
328496
  },
328445
328497
  "required": [
@@ -328618,6 +328670,10 @@ var state5 = {
328618
328670
  "name": {
328619
328671
  "type": "string",
328620
328672
  "description": 'This field is present if the `type` is "integration". If `type` is "integration", this is the integration name.'
328673
+ },
328674
+ "alias": {
328675
+ "type": "string",
328676
+ "description": 'This field is present if the `type` is "integration". If `type` is "integration", this is the integration instance alias.'
328621
328677
  }
328622
328678
  },
328623
328679
  "required": [
@@ -328825,6 +328881,10 @@ var state5 = {
328825
328881
  "name": {
328826
328882
  "type": "string",
328827
328883
  "description": 'This field is present if the `type` is "integration". If `type` is "integration", this is the integration name.'
328884
+ },
328885
+ "alias": {
328886
+ "type": "string",
328887
+ "description": 'This field is present if the `type` is "integration". If `type` is "integration", this is the integration instance alias.'
328828
328888
  }
328829
328889
  },
328830
328890
  "required": [
@@ -329017,6 +329077,10 @@ var state5 = {
329017
329077
  "name": {
329018
329078
  "type": "string",
329019
329079
  "description": 'This field is present if the `type` is "integration". If `type` is "integration", this is the integration name.'
329080
+ },
329081
+ "alias": {
329082
+ "type": "string",
329083
+ "description": 'This field is present if the `type` is "integration". If `type` is "integration", this is the integration instance alias.'
329020
329084
  }
329021
329085
  },
329022
329086
  "required": [
@@ -329925,6 +329989,11 @@ var state5 = {
329925
329989
  "type": "boolean",
329926
329990
  "description": 'A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.'
329927
329991
  },
329992
+ "keyColumn": {
329993
+ "type": "string",
329994
+ "nullable": true,
329995
+ "description": "Designate a column as the primary unique identifier for this table. When set, a unique index is automatically created on this column, enabling significantly faster upsert operations. All values in this column must be unique across the table. When set to null, the key index is removed."
329996
+ },
329928
329997
  "schema": {
329929
329998
  "type": "object",
329930
329999
  "additionalProperties": true,
@@ -330016,6 +330085,11 @@ var state5 = {
330016
330085
  "type": "boolean",
330017
330086
  "description": 'A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.'
330018
330087
  },
330088
+ "keyColumn": {
330089
+ "type": "string",
330090
+ "nullable": true,
330091
+ "description": "Designate a column as the primary unique identifier for this table. When set, a unique index is automatically created on this column, enabling significantly faster upsert operations. All values in this column must be unique across the table. When set to null, the key index is removed."
330092
+ },
330019
330093
  "schema": {
330020
330094
  "type": "object",
330021
330095
  "additionalProperties": true,
@@ -330460,6 +330534,11 @@ var state5 = {
330460
330534
  "type": "boolean",
330461
330535
  "description": 'A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.'
330462
330536
  },
330537
+ "keyColumn": {
330538
+ "type": "string",
330539
+ "nullable": true,
330540
+ "description": "Designate a column as the primary unique identifier for this table. When set, a unique index is automatically created on this column, enabling significantly faster upsert operations. All values in this column must be unique across the table. When set to null, the key index is removed."
330541
+ },
330463
330542
  "schema": {
330464
330543
  "type": "object",
330465
330544
  "additionalProperties": true,
@@ -331078,7 +331157,7 @@ var state5 = {
331078
331157
  "title": "Botpress API",
331079
331158
  "description": "API for Botpress Cloud",
331080
331159
  "server": "https://api.botpress.cloud",
331081
- "version": "1.56.0",
331160
+ "version": "1.58.0",
331082
331161
  "prefix": "v1"
331083
331162
  },
331084
331163
  "errors": [
@@ -334541,6 +334620,11 @@ var state5 = {
334541
334620
  "type": "boolean",
334542
334621
  "description": 'A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.'
334543
334622
  },
334623
+ "keyColumn": {
334624
+ "type": "string",
334625
+ "nullable": true,
334626
+ "description": "Designate a column as the primary unique identifier for this table. When set, a unique index is automatically created on this column, enabling significantly faster upsert operations. All values in this column must be unique across the table. When set to null, the key index is removed."
334627
+ },
334544
334628
  "schema": {
334545
334629
  "type": "object",
334546
334630
  "properties": {
@@ -335048,6 +335132,10 @@ var state5 = {
335048
335132
  "name": {
335049
335133
  "type": "string",
335050
335134
  "description": 'This field is present if the `type` is "integration". If `type` is "integration", this is the integration name.'
335135
+ },
335136
+ "alias": {
335137
+ "type": "string",
335138
+ "description": 'This field is present if the `type` is "integration". If `type` is "integration", this is the integration instance alias.'
335051
335139
  }
335052
335140
  },
335053
335141
  "required": [
package/dist/src/gen/files/state.d.ts CHANGED
@@ -268,6 +268,10 @@ export declare const state: {
268
268
  type: "string";
269
269
  description: string;
270
270
  };
271
+ alias: {
272
+ type: "string";
273
+ description: string;
274
+ };
271
275
  };
272
276
  required: string[];
273
277
  additionalProperties: false;
@@ -567,6 +571,10 @@ export declare const state: {
567
571
  type: "string";
568
572
  description: string;
569
573
  };
574
+ alias: {
575
+ type: "string";
576
+ description: string;
577
+ };
570
578
  };
571
579
  required: string[];
572
580
  };
@@ -742,6 +750,10 @@ export declare const state: {
742
750
  type: "string";
743
751
  description: string;
744
752
  };
753
+ alias: {
754
+ type: "string";
755
+ description: string;
756
+ };
745
757
  };
746
758
  required: string[];
747
759
  additionalProperties: false;
@@ -944,6 +956,10 @@ export declare const state: {
944
956
  type: "string";
945
957
  description: string;
946
958
  };
959
+ alias: {
960
+ type: "string";
961
+ description: string;
962
+ };
947
963
  };
948
964
  required: string[];
949
965
  additionalProperties: false;
@@ -1134,6 +1150,10 @@ export declare const state: {
1134
1150
  type: "string";
1135
1151
  description: string;
1136
1152
  };
1153
+ alias: {
1154
+ type: "string";
1155
+ description: string;
1156
+ };
1137
1157
  };
1138
1158
  required: string[];
1139
1159
  additionalProperties: false;
@@ -2333,6 +2353,10 @@ export declare const state: {
2333
2353
  type: "string";
2334
2354
  description: string;
2335
2355
  };
2356
+ alias: {
2357
+ type: "string";
2358
+ description: string;
2359
+ };
2336
2360
  };
2337
2361
  required: string[];
2338
2362
  additionalProperties: false;
package/dist/src/gen/state.d.ts CHANGED
@@ -15228,6 +15228,10 @@ export declare const state: {
15228
15228
  type: "string";
15229
15229
  description: string;
15230
15230
  };
15231
+ alias: {
15232
+ type: "string";
15233
+ description: string;
15234
+ };
15231
15235
  };
15232
15236
  required: string[];
15233
15237
  additionalProperties: false;
@@ -15418,6 +15422,10 @@ export declare const state: {
15418
15422
  type: "string";
15419
15423
  description: string;
15420
15424
  };
15425
+ alias: {
15426
+ type: "string";
15427
+ description: string;
15428
+ };
15421
15429
  };
15422
15430
  required: string[];
15423
15431
  };
@@ -15557,6 +15565,10 @@ export declare const state: {
15557
15565
  type: "string";
15558
15566
  description: string;
15559
15567
  };
15568
+ alias: {
15569
+ type: "string";
15570
+ description: string;
15571
+ };
15560
15572
  };
15561
15573
  required: string[];
15562
15574
  additionalProperties: false;
@@ -15723,6 +15735,10 @@ export declare const state: {
15723
15735
  type: "string";
15724
15736
  description: string;
15725
15737
  };
15738
+ alias: {
15739
+ type: "string";
15740
+ description: string;
15741
+ };
15726
15742
  };
15727
15743
  required: string[];
15728
15744
  additionalProperties: false;
@@ -15877,6 +15893,10 @@ export declare const state: {
15877
15893
  type: "string";
15878
15894
  description: string;
15879
15895
  };
15896
+ alias: {
15897
+ type: "string";
15898
+ description: string;
15899
+ };
15880
15900
  };
15881
15901
  required: string[];
15882
15902
  additionalProperties: false;
@@ -16638,6 +16658,11 @@ export declare const state: {
16638
16658
  type: "boolean";
16639
16659
  description: string;
16640
16660
  };
16661
+ keyColumn: {
16662
+ type: "string";
16663
+ nullable: true;
16664
+ description: string;
16665
+ };
16641
16666
  schema: {
16642
16667
  type: "object";
16643
16668
  additionalProperties: true;
@@ -16719,6 +16744,11 @@ export declare const state: {
16719
16744
  type: "boolean";
16720
16745
  description: string;
16721
16746
  };
16747
+ keyColumn: {
16748
+ type: "string";
16749
+ nullable: true;
16750
+ description: string;
16751
+ };
16722
16752
  schema: {
16723
16753
  type: "object";
16724
16754
  additionalProperties: true;
@@ -17083,6 +17113,11 @@ export declare const state: {
17083
17113
  type: "boolean";
17084
17114
  description: string;
17085
17115
  };
17116
+ keyColumn: {
17117
+ type: "string";
17118
+ nullable: true;
17119
+ description: string;
17120
+ };
17086
17121
  schema: {
17087
17122
  type: "object";
17088
17123
  additionalProperties: true;
@@ -20521,6 +20556,11 @@ export declare const state: {
20521
20556
  type: "boolean";
20522
20557
  description: string;
20523
20558
  };
20559
+ keyColumn: {
20560
+ type: "string";
20561
+ nullable: true;
20562
+ description: string;
20563
+ };
20524
20564
  schema: {
20525
20565
  type: "object";
20526
20566
  properties: {
@@ -20945,6 +20985,10 @@ export declare const state: {
20945
20985
  type: "string";
20946
20986
  description: string;
20947
20987
  };
20988
+ alias: {
20989
+ type: "string";
20990
+ description: string;
20991
+ };
20948
20992
  };
20949
20993
  required: string[];
20950
20994
  additionalProperties: false;
package/dist/src/gen/tables/state.d.ts CHANGED
@@ -217,6 +217,11 @@ export declare const state: {
217
217
  type: "boolean";
218
218
  description: string;
219
219
  };
220
+ keyColumn: {
221
+ type: "string";
222
+ nullable: true;
223
+ description: string;
224
+ };
220
225
  schema: {
221
226
  type: "object";
222
227
  additionalProperties: true;
@@ -298,6 +303,11 @@ export declare const state: {
298
303
  type: "boolean";
299
304
  description: string;
300
305
  };
306
+ keyColumn: {
307
+ type: "string";
308
+ nullable: true;
309
+ description: string;
310
+ };
301
311
  schema: {
302
312
  type: "object";
303
313
  additionalProperties: true;
@@ -879,6 +889,11 @@ export declare const state: {
879
889
  type: "boolean";
880
890
  description: string;
881
891
  };
892
+ keyColumn: {
893
+ type: "string";
894
+ nullable: true;
895
+ description: string;
896
+ };
882
897
  schema: {
883
898
  type: "object";
884
899
  additionalProperties: true;
@@ -1889,6 +1904,11 @@ export declare const state: {
1889
1904
  type: "boolean";
1890
1905
  description: string;
1891
1906
  };
1907
+ keyColumn: {
1908
+ type: "string";
1909
+ nullable: true;
1910
+ description: string;
1911
+ };
1892
1912
  schema: {
1893
1913
  type: "object";
1894
1914
  properties: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@botpress/api",
3
- "version": "1.56.0",
3
+ "version": "1.58.0",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/src/index.d.ts",
6
6
  "devDependencies": {
@@ -8,9 +8,9 @@
8
8
  "esbuild": "^0.16.10",
9
9
  "zod": "^3.24.4",
10
10
  "typescript": "5.5.4",
11
+ "@botpress/bridge": "1.8.0",
11
12
  "@botpress/cloud-manager": "0.2.0",
12
13
  "@botpress/common": "0.5.0",
13
- "@botpress/bridge": "1.8.0",
14
14
  "@bpinternal/const": "0.3.9",
15
15
  "@botpress/files-api": "0.18.0",
16
16
  "@bpinternal/tables-api": "0.17.2"