@botpress/api 1.18.0 → 1.18.2

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 (18) hide show
  1. package/dist/index.js +247 -83
  2. package/dist/src/gen/admin/state.d.ts +102 -32
  3. package/dist/src/gen/runtime/state.d.ts +0 -3
  4. package/dist/src/gen/state.d.ts +102 -35
  5. package/dist/src/index.d.ts +2 -2
  6. package/package.json +1 -1
  7. package/src/gen/admin/metadata.json +1 -1
  8. package/src/gen/admin/openapi.json +1 -1
  9. package/src/gen/admin/state.ts +122 -37
  10. package/src/gen/files/openapi.json +1 -1
  11. package/src/gen/files/state.ts +1 -1
  12. package/src/gen/metadata.json +1 -1
  13. package/src/gen/openapi.json +1 -1
  14. package/src/gen/runtime/openapi.json +1 -1
  15. package/src/gen/runtime/state.ts +1 -4
  16. package/src/gen/state.ts +122 -40
  17. package/src/gen/tables/openapi.json +1 -1
  18. package/src/gen/tables/state.ts +1 -1
package/dist/index.js CHANGED
@@ -284084,9 +284084,6 @@ var state = {
284084
284084
  "description": "Add an event to the analytics",
284085
284085
  "method": "post",
284086
284086
  "path": "/v1/chat/analytics",
284087
- "disableDefaultParameters": {
284088
- "x-integration-id": true
284089
- },
284090
284087
  "requestBody": {
284091
284088
  "description": "Add an event to the analytics",
284092
284089
  "schema": {
@@ -284126,7 +284123,7 @@ var state = {
284126
284123
  "title": "Botpress API",
284127
284124
  "description": "API for Botpress Cloud",
284128
284125
  "server": "https://api.botpress.cloud",
284129
- "version": "1.18.0",
284126
+ "version": "1.18.2",
284130
284127
  "prefix": "v1"
284131
284128
  },
284132
284129
  "errors": [
@@ -292965,7 +292962,7 @@ var state2 = {
292965
292962
  },
292966
292963
  "endDate": {
292967
292964
  "in": "query",
292968
- "description": "End date/time (exclusive)",
292965
+ "description": "End date/time (inclusive)",
292969
292966
  "type": "string",
292970
292967
  "required": true
292971
292968
  }
@@ -292986,7 +292983,7 @@ var state2 = {
292986
292983
  },
292987
292984
  "endDateTimeUtc": {
292988
292985
  "type": "string",
292989
- "description": "ISO 8601 date string of the end (exclusive) of the period"
292986
+ "description": "ISO 8601 date string of the end (inclusive) of the period"
292990
292987
  },
292991
292988
  "returningUsers": {
292992
292989
  "type": "integer"
@@ -293150,6 +293147,121 @@ var state2 = {
293150
293147
  }
293151
293148
  }
293152
293149
  },
293150
+ "listActionRuns": {
293151
+ "name": "listActionRuns",
293152
+ "description": "List action runs for a specific integration of a bot",
293153
+ "method": "get",
293154
+ "path": "/v1/admin/bots/{id}/action-runs",
293155
+ "section": "bot",
293156
+ "parameters": {
293157
+ "id": {
293158
+ "type": "string",
293159
+ "description": "Bot ID",
293160
+ "in": "path"
293161
+ },
293162
+ "integrationName": {
293163
+ "in": "query",
293164
+ "description": "Integration name",
293165
+ "type": "string",
293166
+ "required": true
293167
+ },
293168
+ "timestampFrom": {
293169
+ "in": "query",
293170
+ "description": "Start timestamp (inclusive)",
293171
+ "type": "string"
293172
+ },
293173
+ "timestampUntil": {
293174
+ "in": "query",
293175
+ "description": "End timestamp (inclusive)",
293176
+ "type": "string"
293177
+ },
293178
+ "nextToken": {
293179
+ "in": "query",
293180
+ "description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
293181
+ "type": "string"
293182
+ }
293183
+ },
293184
+ "response": {
293185
+ "description": "Success",
293186
+ "schema": {
293187
+ "type": "object",
293188
+ "properties": {
293189
+ "data": {
293190
+ "type": "array",
293191
+ "items": {
293192
+ "type": "object",
293193
+ "properties": {
293194
+ "timestamp": {
293195
+ "type": "string",
293196
+ "description": "ISO 8601 timestamp of the action run"
293197
+ },
293198
+ "integrationName": {
293199
+ "type": "string"
293200
+ },
293201
+ "actionType": {
293202
+ "type": "string"
293203
+ },
293204
+ "input": {
293205
+ "type": "object",
293206
+ "properties": {},
293207
+ "additionalProperties": true,
293208
+ "description": "Input of the action"
293209
+ },
293210
+ "output": {
293211
+ "type": "object",
293212
+ "properties": {},
293213
+ "additionalProperties": true,
293214
+ "nullable": true,
293215
+ "description": "Output of the action"
293216
+ },
293217
+ "status": {
293218
+ "type": "string",
293219
+ "enum": [
293220
+ "SUCCESS",
293221
+ "FAILURE"
293222
+ ]
293223
+ },
293224
+ "durationMs": {
293225
+ "type": "number"
293226
+ },
293227
+ "cached": {
293228
+ "type": "boolean"
293229
+ },
293230
+ "errorMessage": {
293231
+ "type": "string",
293232
+ "nullable": true
293233
+ }
293234
+ },
293235
+ "required": [
293236
+ "timestamp",
293237
+ "actionType",
293238
+ "input",
293239
+ "output",
293240
+ "status",
293241
+ "durationMs",
293242
+ "cached"
293243
+ ]
293244
+ }
293245
+ },
293246
+ "meta": {
293247
+ "type": "object",
293248
+ "properties": {
293249
+ "nextToken": {
293250
+ "type": "string"
293251
+ }
293252
+ },
293253
+ "additionalProperties": false
293254
+ }
293255
+ },
293256
+ "required": [
293257
+ "data",
293258
+ "meta"
293259
+ ],
293260
+ "title": "listActionRunsResponse",
293261
+ "additionalProperties": false
293262
+ }
293263
+ }
293264
+ },
293153
293265
  "getBotIssue": {
293154
293266
  "name": "getBotIssue",
293155
293267
  "description": "Get Bot Issue",
@@ -297619,22 +297731,6 @@ var state2 = {
297619
297731
  "additionalProperties": false
297620
297732
  }
297621
297733
  },
297622
- "sandbox": {
297623
- "type": "object",
297624
- "properties": {
297625
- "identifierExtractScript": {
297626
- "type": "string",
297627
- "maxLength": 2e3,
297628
- "nullable": true
297629
- },
297630
- "messageExtractScript": {
297631
- "type": "string",
297632
- "maxLength": 2e3,
297633
- "nullable": true
297634
- }
297635
- },
297636
- "additionalProperties": false
297637
- },
297638
297734
  "attributes": {
297639
297735
  "type": "object",
297640
297736
  "additionalProperties": {
@@ -298227,22 +298323,6 @@ var state2 = {
298227
298323
  "additionalProperties": false
298228
298324
  }
298229
298325
  },
298230
- "sandbox": {
298231
- "type": "object",
298232
- "properties": {
298233
- "identifierExtractScript": {
298234
- "type": "string",
298235
- "maxLength": 2e3,
298236
- "nullable": true
298237
- },
298238
- "messageExtractScript": {
298239
- "type": "string",
298240
- "maxLength": 2e3,
298241
- "nullable": true
298242
- }
298243
- },
298244
- "additionalProperties": false
298245
- },
298246
298326
  "attributes": {
298247
298327
  "type": "object",
298248
298328
  "additionalProperties": {
@@ -300647,7 +300727,7 @@ var state2 = {
300647
300727
  },
300648
300728
  "timestampUntil": {
300649
300729
  "in": "query",
300650
- "description": "Timestamp until (exclusive)",
300730
+ "description": "Timestamp until (inclusive)",
300651
300731
  "type": "string"
300652
300732
  },
300653
300733
  "nextToken": {
@@ -300749,7 +300829,7 @@ var state2 = {
300749
300829
  },
300750
300830
  "dateUntil": {
300751
300831
  "in": "query",
300752
- "description": "Date until (exclusive)",
300832
+ "description": "Date until (inclusive)",
300753
300833
  "type": "string"
300754
300834
  },
300755
300835
  "nextToken": {
@@ -300976,7 +301056,7 @@ var state2 = {
300976
301056
  "title": "Botpress API",
300977
301057
  "description": "API for Botpress Cloud",
300978
301058
  "server": "https://api.botpress.cloud",
300979
- "version": "1.18.0",
301059
+ "version": "1.18.2",
300980
301060
  "prefix": "v1"
300981
301061
  },
300982
301062
  "errors": [
@@ -301162,6 +301242,7 @@ var state2 = {
301162
301242
  "getBotLogsResponse": true,
301163
301243
  "getBotWebchatResponse": true,
301164
301244
  "getBotAnalyticsResponse": true,
301245
+ "listActionRunsResponse": true,
301165
301246
  "getBotIssueResponse": true,
301166
301247
  "listBotIssuesResponse": true,
301167
301248
  "deleteBotIssueResponse": true,
@@ -304780,6 +304861,7 @@ var state2 = {
304780
304861
  "getBotLogs",
304781
304862
  "getBotWebchat",
304782
304863
  "getBotAnalytics",
304864
+ "listActionRuns",
304783
304865
  "getBotIssue",
304784
304866
  "listBotIssues",
304785
304867
  "deleteBotIssue",
@@ -306608,7 +306690,7 @@ var state3 = {
306608
306690
  "title": "Botpress API",
306609
306691
  "description": "API for Botpress Cloud",
306610
306692
  "server": "https://api.botpress.cloud",
306611
- "version": "1.18.0",
306693
+ "version": "1.18.2",
306612
306694
  "prefix": "v1"
306613
306695
  },
306614
306696
  "errors": [
@@ -311612,7 +311694,7 @@ var state4 = {
311612
311694
  "title": "Botpress API",
311613
311695
  "description": "API for Botpress Cloud",
311614
311696
  "server": "https://api.botpress.cloud",
311615
- "version": "1.18.0",
311697
+ "version": "1.18.2",
311616
311698
  "prefix": "v1"
311617
311699
  },
311618
311700
  "errors": [
@@ -317967,9 +318049,6 @@ var state5 = {
317967
318049
  "description": "Add an event to the analytics",
317968
318050
  "method": "post",
317969
318051
  "path": "/v1/chat/analytics",
317970
- "disableDefaultParameters": {
317971
- "x-integration-id": true
317972
- },
317973
318052
  "requestBody": {
317974
318053
  "description": "Add an event to the analytics",
317975
318054
  "schema": {
@@ -322969,7 +323048,7 @@ var state5 = {
322969
323048
  },
322970
323049
  "endDate": {
322971
323050
  "in": "query",
322972
- "description": "End date/time (exclusive)",
323051
+ "description": "End date/time (inclusive)",
322973
323052
  "type": "string",
322974
323053
  "required": true
322975
323054
  }
@@ -322990,7 +323069,7 @@ var state5 = {
322990
323069
  },
322991
323070
  "endDateTimeUtc": {
322992
323071
  "type": "string",
322993
- "description": "ISO 8601 date string of the end (exclusive) of the period"
323072
+ "description": "ISO 8601 date string of the end (inclusive) of the period"
322994
323073
  },
322995
323074
  "returningUsers": {
322996
323075
  "type": "integer"
@@ -323154,6 +323233,121 @@ var state5 = {
323154
323233
  }
323155
323234
  }
323156
323235
  },
323236
+ "listActionRuns": {
323237
+ "name": "listActionRuns",
323238
+ "description": "List action runs for a specific integration of a bot",
323239
+ "method": "get",
323240
+ "path": "/v1/admin/bots/{id}/action-runs",
323241
+ "section": "bot",
323242
+ "parameters": {
323243
+ "id": {
323244
+ "type": "string",
323245
+ "description": "Bot ID",
323246
+ "in": "path"
323247
+ },
323248
+ "integrationName": {
323249
+ "in": "query",
323250
+ "description": "Integration name",
323251
+ "type": "string",
323252
+ "required": true
323253
+ },
323254
+ "timestampFrom": {
323255
+ "in": "query",
323256
+ "description": "Start timestamp (inclusive)",
323257
+ "type": "string"
323258
+ },
323259
+ "timestampUntil": {
323260
+ "in": "query",
323261
+ "description": "End timestamp (inclusive)",
323262
+ "type": "string"
323263
+ },
323264
+ "nextToken": {
323265
+ "in": "query",
323266
+ "description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
323267
+ "type": "string"
323268
+ }
323269
+ },
323270
+ "response": {
323271
+ "description": "Success",
323272
+ "schema": {
323273
+ "type": "object",
323274
+ "properties": {
323275
+ "data": {
323276
+ "type": "array",
323277
+ "items": {
323278
+ "type": "object",
323279
+ "properties": {
323280
+ "timestamp": {
323281
+ "type": "string",
323282
+ "description": "ISO 8601 timestamp of the action run"
323283
+ },
323284
+ "integrationName": {
323285
+ "type": "string"
323286
+ },
323287
+ "actionType": {
323288
+ "type": "string"
323289
+ },
323290
+ "input": {
323291
+ "type": "object",
323292
+ "properties": {},
323293
+ "additionalProperties": true,
323294
+ "description": "Input of the action"
323295
+ },
323296
+ "output": {
323297
+ "type": "object",
323298
+ "properties": {},
323299
+ "additionalProperties": true,
323300
+ "nullable": true,
323301
+ "description": "Output of the action"
323302
+ },
323303
+ "status": {
323304
+ "type": "string",
323305
+ "enum": [
323306
+ "SUCCESS",
323307
+ "FAILURE"
323308
+ ]
323309
+ },
323310
+ "durationMs": {
323311
+ "type": "number"
323312
+ },
323313
+ "cached": {
323314
+ "type": "boolean"
323315
+ },
323316
+ "errorMessage": {
323317
+ "type": "string",
323318
+ "nullable": true
323319
+ }
323320
+ },
323321
+ "required": [
323322
+ "timestamp",
323323
+ "actionType",
323324
+ "input",
323325
+ "output",
323326
+ "status",
323327
+ "durationMs",
323328
+ "cached"
323329
+ ]
323330
+ }
323331
+ },
323332
+ "meta": {
323333
+ "type": "object",
323334
+ "properties": {
323335
+ "nextToken": {
323336
+ "type": "string"
323337
+ }
323338
+ },
323339
+ "additionalProperties": false
323340
+ }
323341
+ },
323342
+ "required": [
323343
+ "data",
323344
+ "meta"
323345
+ ],
323346
+ "title": "listActionRunsResponse",
323347
+ "additionalProperties": false
323348
+ }
323349
+ }
323350
+ },
323157
323351
  "getBotIssue": {
323158
323352
  "name": "getBotIssue",
323159
323353
  "description": "Get Bot Issue",
@@ -327624,22 +327818,6 @@ var state5 = {
327624
327818
  "additionalProperties": false
327625
327819
  }
327626
327820
  },
327627
- "sandbox": {
327628
- "type": "object",
327629
- "properties": {
327630
- "identifierExtractScript": {
327631
- "type": "string",
327632
- "maxLength": 2e3,
327633
- "nullable": true
327634
- },
327635
- "messageExtractScript": {
327636
- "type": "string",
327637
- "maxLength": 2e3,
327638
- "nullable": true
327639
- }
327640
- },
327641
- "additionalProperties": false
327642
- },
327643
327821
  "attributes": {
327644
327822
  "type": "object",
327645
327823
  "additionalProperties": {
@@ -328232,22 +328410,6 @@ var state5 = {
328232
328410
  "additionalProperties": false
328233
328411
  }
328234
328412
  },
328235
- "sandbox": {
328236
- "type": "object",
328237
- "properties": {
328238
- "identifierExtractScript": {
328239
- "type": "string",
328240
- "maxLength": 2e3,
328241
- "nullable": true
328242
- },
328243
- "messageExtractScript": {
328244
- "type": "string",
328245
- "maxLength": 2e3,
328246
- "nullable": true
328247
- }
328248
- },
328249
- "additionalProperties": false
328250
- },
328251
328413
  "attributes": {
328252
328414
  "type": "object",
328253
328415
  "additionalProperties": {
@@ -330652,7 +330814,7 @@ var state5 = {
330652
330814
  },
330653
330815
  "timestampUntil": {
330654
330816
  "in": "query",
330655
- "description": "Timestamp until (exclusive)",
330817
+ "description": "Timestamp until (inclusive)",
330656
330818
  "type": "string"
330657
330819
  },
330658
330820
  "nextToken": {
@@ -330754,7 +330916,7 @@ var state5 = {
330754
330916
  },
330755
330917
  "dateUntil": {
330756
330918
  "in": "query",
330757
- "description": "Date until (exclusive)",
330919
+ "description": "Date until (inclusive)",
330758
330920
  "type": "string"
330759
330921
  },
330760
330922
  "nextToken": {
@@ -333826,7 +333988,7 @@ var state5 = {
333826
333988
  "title": "Botpress API",
333827
333989
  "description": "API for Botpress Cloud",
333828
333990
  "server": "https://api.botpress.cloud",
333829
- "version": "1.18.0",
333991
+ "version": "1.18.2",
333830
333992
  "prefix": "v1"
333831
333993
  },
333832
333994
  "errors": [
@@ -334097,6 +334259,7 @@ var state5 = {
334097
334259
  "getBotLogsResponse": true,
334098
334260
  "getBotWebchatResponse": true,
334099
334261
  "getBotAnalyticsResponse": true,
334262
+ "listActionRunsResponse": true,
334100
334263
  "getBotIssueResponse": true,
334101
334264
  "listBotIssuesResponse": true,
334102
334265
  "deleteBotIssueResponse": true,
@@ -337801,6 +337964,7 @@ var state5 = {
337801
337964
  "getBotLogs",
337802
337965
  "getBotWebchat",
337803
337966
  "getBotAnalytics",
337967
+ "listActionRuns",
337804
337968
  "getBotIssue",
337805
337969
  "listBotIssues",
337806
337970
  "deleteBotIssue",
package/dist/src/gen/admin/state.d.ts CHANGED
@@ -4520,6 +4520,107 @@ export declare const state: {
4520
4520
  };
4521
4521
  };
4522
4522
  };
4523
+ listActionRuns: {
4524
+ name: string;
4525
+ description: string;
4526
+ method: "get";
4527
+ path: string;
4528
+ section: "bot";
4529
+ parameters: {
4530
+ id: {
4531
+ type: "string";
4532
+ description: string;
4533
+ in: "path";
4534
+ };
4535
+ integrationName: {
4536
+ in: "query";
4537
+ description: string;
4538
+ type: "string";
4539
+ required: true;
4540
+ };
4541
+ timestampFrom: {
4542
+ in: "query";
4543
+ description: string;
4544
+ type: "string";
4545
+ };
4546
+ timestampUntil: {
4547
+ in: "query";
4548
+ description: string;
4549
+ type: "string";
4550
+ };
4551
+ nextToken: {
4552
+ in: "query";
4553
+ description: string;
4554
+ type: "string";
4555
+ };
4556
+ };
4557
+ response: {
4558
+ description: string;
4559
+ schema: {
4560
+ type: "object";
4561
+ properties: {
4562
+ data: {
4563
+ type: "array";
4564
+ items: {
4565
+ type: "object";
4566
+ properties: {
4567
+ timestamp: {
4568
+ type: "string";
4569
+ description: string;
4570
+ };
4571
+ integrationName: {
4572
+ type: "string";
4573
+ };
4574
+ actionType: {
4575
+ type: "string";
4576
+ };
4577
+ input: {
4578
+ type: "object";
4579
+ properties: {};
4580
+ additionalProperties: true;
4581
+ description: string;
4582
+ };
4583
+ output: {
4584
+ type: "object";
4585
+ properties: {};
4586
+ additionalProperties: true;
4587
+ nullable: true;
4588
+ description: string;
4589
+ };
4590
+ status: {
4591
+ type: "string";
4592
+ enum: string[];
4593
+ };
4594
+ durationMs: {
4595
+ type: "number";
4596
+ };
4597
+ cached: {
4598
+ type: "boolean";
4599
+ };
4600
+ errorMessage: {
4601
+ type: "string";
4602
+ nullable: true;
4603
+ };
4604
+ };
4605
+ required: string[];
4606
+ };
4607
+ };
4608
+ meta: {
4609
+ type: "object";
4610
+ properties: {
4611
+ nextToken: {
4612
+ type: "string";
4613
+ };
4614
+ };
4615
+ additionalProperties: false;
4616
+ };
4617
+ };
4618
+ required: string[];
4619
+ title: string;
4620
+ additionalProperties: false;
4621
+ };
4622
+ };
4623
+ };
4523
4624
  getBotIssue: {
4524
4625
  name: string;
4525
4626
  description: string;
@@ -8419,22 +8520,6 @@ export declare const state: {
8419
8520
  additionalProperties: false;
8420
8521
  };
8421
8522
  };
8422
- sandbox: {
8423
- type: "object";
8424
- properties: {
8425
- identifierExtractScript: {
8426
- type: "string";
8427
- maxLength: number;
8428
- nullable: true;
8429
- };
8430
- messageExtractScript: {
8431
- type: "string";
8432
- maxLength: number;
8433
- nullable: true;
8434
- };
8435
- };
8436
- additionalProperties: false;
8437
- };
8438
8523
  attributes: {
8439
8524
  type: "object";
8440
8525
  additionalProperties: {
@@ -8989,22 +9074,6 @@ export declare const state: {
8989
9074
  additionalProperties: false;
8990
9075
  };
8991
9076
  };
8992
- sandbox: {
8993
- type: "object";
8994
- properties: {
8995
- identifierExtractScript: {
8996
- type: "string";
8997
- maxLength: number;
8998
- nullable: true;
8999
- };
9000
- messageExtractScript: {
9001
- type: "string";
9002
- maxLength: number;
9003
- nullable: true;
9004
- };
9005
- };
9006
- additionalProperties: false;
9007
- };
9008
9077
  attributes: {
9009
9078
  type: "object";
9010
9079
  additionalProperties: {
@@ -11553,6 +11622,7 @@ export declare const state: {
11553
11622
  getBotLogsResponse: true;
11554
11623
  getBotWebchatResponse: true;
11555
11624
  getBotAnalyticsResponse: true;
11625
+ listActionRunsResponse: true;
11556
11626
  getBotIssueResponse: true;
11557
11627
  listBotIssuesResponse: true;
11558
11628
  deleteBotIssueResponse: true;
package/dist/src/gen/runtime/state.d.ts CHANGED
@@ -2317,9 +2317,6 @@ export declare const state: {
2317
2317
  description: string;
2318
2318
  method: "post";
2319
2319
  path: string;
2320
- disableDefaultParameters: {
2321
- "x-integration-id": boolean;
2322
- };
2323
2320
  requestBody: {
2324
2321
  description: string;
2325
2322
  schema: {