@botpress/api 1.59.0 → 1.61.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.
package/dist/index.js CHANGED
@@ -277050,6 +277050,43 @@ var state = {
277050
277050
  },
277051
277051
  "description": "Filter by tags"
277052
277052
  },
277053
+ "afterDate": {
277054
+ "in": "query",
277055
+ "description": "Date in ISO 8601 string with UTC timezone after which the user was created or updated (inclusive)",
277056
+ "type": "string"
277057
+ },
277058
+ "beforeDate": {
277059
+ "in": "query",
277060
+ "description": "Date in ISO 8601 string with UTC timezone before which the user was created or updated (inclusive)",
277061
+ "type": "string"
277062
+ },
277063
+ "rangeField": {
277064
+ "in": "query",
277065
+ "description": 'Field used for range filtering. Allowed values are "updatedAt" or "createdAt". Defaults to "createdAt" if omitted.',
277066
+ "type": "string",
277067
+ "enum": [
277068
+ "updatedAt",
277069
+ "createdAt"
277070
+ ]
277071
+ },
277072
+ "sortField": {
277073
+ "in": "query",
277074
+ "description": "Sort results by this field",
277075
+ "type": "string",
277076
+ "enum": [
277077
+ "updatedAt",
277078
+ "createdAt"
277079
+ ]
277080
+ },
277081
+ "sortDirection": {
277082
+ "in": "query",
277083
+ "description": "Sort results in this direction",
277084
+ "type": "string",
277085
+ "enum": [
277086
+ "asc",
277087
+ "desc"
277088
+ ]
277089
+ },
277053
277090
  "x-bot-id": {
277054
277091
  "in": "header",
277055
277092
  "description": "Bot id",
@@ -279006,7 +279043,7 @@ var state = {
279006
279043
  "title": "Botpress Runtime API",
279007
279044
  "description": "API for Botpress Runtime",
279008
279045
  "server": "https://api.botpress.cloud",
279009
- "version": "1.59.0",
279046
+ "version": "1.61.0",
279010
279047
  "prefix": "v1"
279011
279048
  },
279012
279049
  "defaultParameters": {
@@ -279915,6 +279952,12 @@ var state = {
279915
279952
  "operations": [
279916
279953
  "listTagValues"
279917
279954
  ]
279955
+ },
279956
+ {
279957
+ "description": "",
279958
+ "title": "Rate Limit",
279959
+ "name": "ratelimit",
279960
+ "operations": []
279918
279961
  }
279919
279962
  ],
279920
279963
  "options": {
@@ -284755,6 +284798,11 @@ var state2 = {
284755
284798
  "minLength": 1,
284756
284799
  "description": "Optional name for the bot, if not provided will be auto-generated"
284757
284800
  },
284801
+ "description": {
284802
+ "type": "string",
284803
+ "maxLength": 2e3,
284804
+ "description": "Optional description for the bot"
284805
+ },
284758
284806
  "medias": {
284759
284807
  "type": "array",
284760
284808
  "items": {
@@ -285278,6 +285326,11 @@ var state2 = {
285278
285326
  "minLength": 1,
285279
285327
  "description": "Optional name for the bot, if not provided will be auto-generated"
285280
285328
  },
285329
+ "description": {
285330
+ "type": "string",
285331
+ "maxLength": 2e3,
285332
+ "description": "Optional description for the bot"
285333
+ },
285281
285334
  "medias": {
285282
285335
  "type": "array",
285283
285336
  "items": {
@@ -295385,7 +295438,7 @@ var state2 = {
295385
295438
  "title": "Botpress Admin API",
295386
295439
  "description": "API for Botpress Cloud Manager",
295387
295440
  "server": "https://api.botpress.cloud",
295388
- "version": "1.59.0",
295441
+ "version": "1.61.0",
295389
295442
  "prefix": "v1"
295390
295443
  },
295391
295444
  "defaultParameters": {
@@ -296355,6 +296408,10 @@ var state2 = {
296355
296408
  "type": "string",
296356
296409
  "description": "Name of the [Bot](#schema_bot)"
296357
296410
  },
296411
+ "description": {
296412
+ "type": "string",
296413
+ "description": "Description of the [Bot](#schema_bot)"
296414
+ },
296358
296415
  "deployedAt": {
296359
296416
  "type": "string",
296360
296417
  "format": "date-time",
@@ -300877,7 +300934,7 @@ var state3 = {
300877
300934
  "title": "Botpress Files API",
300878
300935
  "description": "API for Botpress Files",
300879
300936
  "server": "https://api.botpress.cloud",
300880
- "version": "1.59.0",
300937
+ "version": "1.61.0",
300881
300938
  "prefix": "v1"
300882
300939
  },
300883
300940
  "defaultParameters": {
@@ -303162,7 +303219,7 @@ var state4 = {
303162
303219
  "title": "Botpress Tables API",
303163
303220
  "description": "API for Botpress Tables",
303164
303221
  "server": "https://api.botpress.cloud",
303165
- "version": "1.59.0",
303222
+ "version": "1.61.0",
303166
303223
  "prefix": "v1"
303167
303224
  },
303168
303225
  "defaultParameters": {
@@ -305105,6 +305162,43 @@ var state5 = {
305105
305162
  }
305106
305163
  },
305107
305164
  "description": "Filter by tags"
305165
+ },
305166
+ "afterDate": {
305167
+ "in": "query",
305168
+ "description": "Date in ISO 8601 string with UTC timezone after which the user was created or updated (inclusive)",
305169
+ "type": "string"
305170
+ },
305171
+ "beforeDate": {
305172
+ "in": "query",
305173
+ "description": "Date in ISO 8601 string with UTC timezone before which the user was created or updated (inclusive)",
305174
+ "type": "string"
305175
+ },
305176
+ "rangeField": {
305177
+ "in": "query",
305178
+ "description": 'Field used for range filtering. Allowed values are "updatedAt" or "createdAt". Defaults to "createdAt" if omitted.',
305179
+ "type": "string",
305180
+ "enum": [
305181
+ "updatedAt",
305182
+ "createdAt"
305183
+ ]
305184
+ },
305185
+ "sortField": {
305186
+ "in": "query",
305187
+ "description": "Sort results by this field",
305188
+ "type": "string",
305189
+ "enum": [
305190
+ "updatedAt",
305191
+ "createdAt"
305192
+ ]
305193
+ },
305194
+ "sortDirection": {
305195
+ "in": "query",
305196
+ "description": "Sort results in this direction",
305197
+ "type": "string",
305198
+ "enum": [
305199
+ "asc",
305200
+ "desc"
305201
+ ]
305108
305202
  }
305109
305203
  },
305110
305204
  "section": "user",
@@ -311309,6 +311403,11 @@ var state5 = {
311309
311403
  "minLength": 1,
311310
311404
  "description": "Optional name for the bot, if not provided will be auto-generated"
311311
311405
  },
311406
+ "description": {
311407
+ "type": "string",
311408
+ "maxLength": 2e3,
311409
+ "description": "Optional description for the bot"
311410
+ },
311312
311411
  "medias": {
311313
311412
  "type": "array",
311314
311413
  "items": {
@@ -311807,6 +311906,11 @@ var state5 = {
311807
311906
  "minLength": 1,
311808
311907
  "description": "Optional name for the bot, if not provided will be auto-generated"
311809
311908
  },
311909
+ "description": {
311910
+ "type": "string",
311911
+ "maxLength": 2e3,
311912
+ "description": "Optional description for the bot"
311913
+ },
311810
311914
  "medias": {
311811
311915
  "type": "array",
311812
311916
  "items": {
@@ -324206,7 +324310,7 @@ var state5 = {
324206
324310
  "title": "Botpress API",
324207
324311
  "description": "API for Botpress Cloud",
324208
324312
  "server": "https://api.botpress.cloud",
324209
- "version": "1.59.0",
324313
+ "version": "1.61.0",
324210
324314
  "prefix": "v1"
324211
324315
  },
324212
324316
  "errors": [
@@ -325291,6 +325395,10 @@ var state5 = {
325291
325395
  "type": "string",
325292
325396
  "description": "Name of the [Bot](#schema_bot)"
325293
325397
  },
325398
+ "description": {
325399
+ "type": "string",
325400
+ "description": "Description of the [Bot](#schema_bot)"
325401
+ },
325294
325402
  "deployedAt": {
325295
325403
  "type": "string",
325296
325404
  "format": "date-time",
@@ -328390,6 +328498,12 @@ var state5 = {
328390
328498
  "listTagValues"
328391
328499
  ]
328392
328500
  },
328501
+ {
328502
+ "description": "",
328503
+ "title": "Rate Limit",
328504
+ "name": "ratelimit",
328505
+ "operations": []
328506
+ },
328393
328507
  {
328394
328508
  "title": "Bot",
328395
328509
  "description": "",
@@ -4176,6 +4176,11 @@ export declare const state: {
4176
4176
  minLength: number;
4177
4177
  description: string;
4178
4178
  };
4179
+ description: {
4180
+ type: "string";
4181
+ maxLength: number;
4182
+ description: string;
4183
+ };
4179
4184
  medias: {
4180
4185
  type: "array";
4181
4186
  items: {
@@ -4658,6 +4663,11 @@ export declare const state: {
4658
4663
  minLength: number;
4659
4664
  description: string;
4660
4665
  };
4666
+ description: {
4667
+ type: "string";
4668
+ maxLength: number;
4669
+ description: string;
4670
+ };
4661
4671
  medias: {
4662
4672
  type: "array";
4663
4673
  items: {
@@ -14414,6 +14424,10 @@ export declare const state: {
14414
14424
  type: "string";
14415
14425
  description: string;
14416
14426
  };
14427
+ description: {
14428
+ type: "string";
14429
+ description: string;
14430
+ };
14417
14431
  deployedAt: {
14418
14432
  type: "string";
14419
14433
  format: string;
@@ -1,5 +1,5 @@
1
1
  import * as opapi from '@bpinternal/opapi';
2
- export type State = opapi.State<'User' | 'Conversation' | 'Event' | 'Message' | 'State' | 'Task' | 'Workflow', 'x-bot-id' | 'x-integration-id' | 'x-integration-alias', 'user' | 'conversation' | 'event' | 'message' | 'state' | 'hub' | 'action' | 'task' | 'workflow' | 'tag'>;
2
+ export type State = opapi.State<'User' | 'Conversation' | 'Event' | 'Message' | 'State' | 'Task' | 'Workflow', 'x-bot-id' | 'x-integration-id' | 'x-integration-alias', 'user' | 'conversation' | 'event' | 'message' | 'state' | 'hub' | 'action' | 'task' | 'workflow' | 'tag' | 'ratelimit'>;
3
3
  export declare const state: {
4
4
  operations: {
5
5
  createConversation: {
@@ -1542,6 +1542,34 @@ export declare const state: {
1542
1542
  };
1543
1543
  description: string;
1544
1544
  };
1545
+ afterDate: {
1546
+ in: "query";
1547
+ description: string;
1548
+ type: "string";
1549
+ };
1550
+ beforeDate: {
1551
+ in: "query";
1552
+ description: string;
1553
+ type: "string";
1554
+ };
1555
+ rangeField: {
1556
+ in: "query";
1557
+ description: string;
1558
+ type: "string";
1559
+ enum: string[];
1560
+ };
1561
+ sortField: {
1562
+ in: "query";
1563
+ description: string;
1564
+ type: "string";
1565
+ enum: string[];
1566
+ };
1567
+ sortDirection: {
1568
+ in: "query";
1569
+ description: string;
1570
+ type: "string";
1571
+ enum: string[];
1572
+ };
1545
1573
  "x-bot-id": {
1546
1574
  in: "header";
1547
1575
  description: string;
@@ -3979,6 +4007,12 @@ export declare const state: {
3979
4007
  name: "tag";
3980
4008
  operations: string[];
3981
4009
  schema?: undefined;
4010
+ } | {
4011
+ description: string;
4012
+ title: string;
4013
+ name: "ratelimit";
4014
+ operations: never[];
4015
+ schema?: undefined;
3982
4016
  })[];
3983
4017
  options: {
3984
4018
  allowUnions: false;
@@ -1,5 +1,5 @@
1
1
  import * as opapi from '@bpinternal/opapi';
2
- export type State = opapi.State<'Bot' | 'Integration' | 'Interface' | 'Plugin' | 'Workspace' | 'WorkspaceMember' | 'Account' | 'Usage' | 'Issue' | 'IssueEvent' | 'Activity' | 'Version' | 'User' | 'Conversation' | 'Event' | 'Message' | 'State' | 'Task' | 'Workflow' | 'Table' | 'Column' | 'Row' | 'File', never, 'user' | 'conversation' | 'event' | 'message' | 'state' | 'hub' | 'action' | 'task' | 'workflow' | 'tag' | 'bot' | 'integration' | 'interface' | 'plugin' | 'workspace' | 'workspaceMember' | 'account' | 'usage' | 'quotas' | 'helper' | 'activity' | 'tables' | 'files'>;
2
+ export type State = opapi.State<'Bot' | 'Integration' | 'Interface' | 'Plugin' | 'Workspace' | 'WorkspaceMember' | 'Account' | 'Usage' | 'Issue' | 'IssueEvent' | 'Activity' | 'Version' | 'User' | 'Conversation' | 'Event' | 'Message' | 'State' | 'Task' | 'Workflow' | 'Table' | 'Column' | 'Row' | 'File', never, 'user' | 'conversation' | 'event' | 'message' | 'state' | 'hub' | 'action' | 'task' | 'workflow' | 'tag' | 'ratelimit' | 'bot' | 'integration' | 'interface' | 'plugin' | 'workspace' | 'workspaceMember' | 'account' | 'usage' | 'quotas' | 'helper' | 'activity' | 'tables' | 'files'>;
3
3
  export declare const state: {
4
4
  operations: {
5
5
  createConversation: {
@@ -1140,6 +1140,34 @@ export declare const state: {
1140
1140
  };
1141
1141
  description: string;
1142
1142
  };
1143
+ afterDate: {
1144
+ in: "query";
1145
+ description: string;
1146
+ type: "string";
1147
+ };
1148
+ beforeDate: {
1149
+ in: "query";
1150
+ description: string;
1151
+ type: "string";
1152
+ };
1153
+ rangeField: {
1154
+ in: "query";
1155
+ description: string;
1156
+ type: "string";
1157
+ enum: string[];
1158
+ };
1159
+ sortField: {
1160
+ in: "query";
1161
+ description: string;
1162
+ type: "string";
1163
+ enum: string[];
1164
+ };
1165
+ sortDirection: {
1166
+ in: "query";
1167
+ description: string;
1168
+ type: "string";
1169
+ enum: string[];
1170
+ };
1143
1171
  };
1144
1172
  section: "user";
1145
1173
  response: {
@@ -6499,6 +6527,11 @@ export declare const state: {
6499
6527
  minLength: number;
6500
6528
  description: string;
6501
6529
  };
6530
+ description: {
6531
+ type: "string";
6532
+ maxLength: number;
6533
+ description: string;
6534
+ };
6502
6535
  medias: {
6503
6536
  type: "array";
6504
6537
  items: {
@@ -6956,6 +6989,11 @@ export declare const state: {
6956
6989
  minLength: number;
6957
6990
  description: string;
6958
6991
  };
6992
+ description: {
6993
+ type: "string";
6994
+ maxLength: number;
6995
+ description: string;
6996
+ };
6959
6997
  medias: {
6960
6998
  type: "array";
6961
6999
  items: {
@@ -18631,6 +18669,10 @@ export declare const state: {
18631
18669
  type: "string";
18632
18670
  description: string;
18633
18671
  };
18672
+ description: {
18673
+ type: "string";
18674
+ description: string;
18675
+ };
18634
18676
  deployedAt: {
18635
18677
  type: "string";
18636
18678
  format: string;
@@ -21129,6 +21171,12 @@ export declare const state: {
21129
21171
  name: "tag";
21130
21172
  operations: string[];
21131
21173
  schema?: undefined;
21174
+ } | {
21175
+ description: string;
21176
+ title: string;
21177
+ name: "ratelimit";
21178
+ operations: never[];
21179
+ schema?: undefined;
21132
21180
  } | {
21133
21181
  title: string;
21134
21182
  description: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@botpress/api",
3
- "version": "1.59.0",
3
+ "version": "1.61.0",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/src/index.d.ts",
6
6
  "devDependencies": {