@botpress/api 1.18.1 → 1.19.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 (20) hide show
  1. package/dist/index.js +650 -34
  2. package/dist/src/gen/admin/state.d.ts +121 -0
  3. package/dist/src/gen/files/state.d.ts +113 -0
  4. package/dist/src/gen/runtime/state.d.ts +19 -3
  5. package/dist/src/gen/state.d.ts +215 -3
  6. package/dist/src/gen/tables/state.d.ts +19 -0
  7. package/dist/src/index.d.ts +2 -2
  8. package/package.json +1 -1
  9. package/src/gen/admin/metadata.json +1 -1
  10. package/src/gen/admin/openapi.json +1 -1
  11. package/src/gen/admin/state.ts +149 -6
  12. package/src/gen/files/openapi.json +1 -1
  13. package/src/gen/files/state.ts +162 -7
  14. package/src/gen/metadata.json +1 -1
  15. package/src/gen/openapi.json +1 -1
  16. package/src/gen/runtime/openapi.json +1 -1
  17. package/src/gen/runtime/state.ts +28 -5
  18. package/src/gen/state.ts +283 -14
  19. package/src/gen/tables/openapi.json +1 -1
  20. package/src/gen/tables/state.ts +28 -2
package/src/gen/runtime/state.ts CHANGED
@@ -2562,9 +2562,6 @@ export const state = {
2562
2562
  "description": "Add an event to the analytics",
2563
2563
  "method": "post",
2564
2564
  "path": "/v1/chat/analytics",
2565
- "disableDefaultParameters": {
2566
- "x-integration-id": true
2567
- },
2568
2565
  "requestBody": {
2569
2566
  "description": "Add an event to the analytics",
2570
2567
  "schema": {
@@ -2604,7 +2601,7 @@ export const state = {
2604
2601
  "title": "Botpress API",
2605
2602
  "description": "API for Botpress Cloud",
2606
2603
  "server": "https://api.botpress.cloud",
2607
- "version": "1.18.1",
2604
+ "version": "1.19.0",
2608
2605
  "prefix": "v1"
2609
2606
  },
2610
2607
  "errors": [
@@ -6235,6 +6232,31 @@ export const state = {
6235
6232
  "expiresAt": {
6236
6233
  "type": "string",
6237
6234
  "description": "File expiry timestamp in ISO 8601 format"
6235
+ },
6236
+ "owner": {
6237
+ "type": "object",
6238
+ "properties": {
6239
+ "type": {
6240
+ "type": "string",
6241
+ "enum": [
6242
+ "bot",
6243
+ "integration",
6244
+ "user"
6245
+ ]
6246
+ },
6247
+ "id": {
6248
+ "type": "string",
6249
+ "description": "This field is present if `type` is \"user\" or \"bot\". If `type` is \"user\", this is the user ID. If `type` is \"bot\", this is the bot ID."
6250
+ },
6251
+ "name": {
6252
+ "type": "string",
6253
+ "description": "This field is present if the `type` is \"integration\". If `type` is \"integration\", this is the integration name."
6254
+ }
6255
+ },
6256
+ "required": [
6257
+ "type"
6258
+ ],
6259
+ "additionalProperties": false
6238
6260
  }
6239
6261
  },
6240
6262
  "required": [
@@ -6250,7 +6272,8 @@ export const state = {
6250
6272
  "updatedAt",
6251
6273
  "accessPolicies",
6252
6274
  "index",
6253
- "status"
6275
+ "status",
6276
+ "owner"
6254
6277
  ],
6255
6278
  "additionalProperties": false
6256
6279
  }
package/src/gen/state.ts CHANGED
@@ -2562,9 +2562,6 @@ export const state = {
2562
2562
  "description": "Add an event to the analytics",
2563
2563
  "method": "post",
2564
2564
  "path": "/v1/chat/analytics",
2565
- "disableDefaultParameters": {
2566
- "x-integration-id": true
2567
- },
2568
2565
  "requestBody": {
2569
2566
  "description": "Add an event to the analytics",
2570
2567
  "schema": {
@@ -7564,7 +7561,7 @@ export const state = {
7564
7561
  },
7565
7562
  "endDate": {
7566
7563
  "in": "query",
7567
- "description": "End date/time (exclusive)",
7564
+ "description": "End date/time (inclusive)",
7568
7565
  "type": "string",
7569
7566
  "required": true
7570
7567
  }
@@ -7585,7 +7582,7 @@ export const state = {
7585
7582
  },
7586
7583
  "endDateTimeUtc": {
7587
7584
  "type": "string",
7588
- "description": "ISO 8601 date string of the end (exclusive) of the period"
7585
+ "description": "ISO 8601 date string of the end (inclusive) of the period"
7589
7586
  },
7590
7587
  "returningUsers": {
7591
7588
  "type": "integer"
@@ -7749,6 +7746,121 @@ export const state = {
7749
7746
  }
7750
7747
  }
7751
7748
  },
7749
+ "listActionRuns": {
7750
+ "name": "listActionRuns",
7751
+ "description": "List action runs for a specific integration of a bot",
7752
+ "method": "get",
7753
+ "path": "/v1/admin/bots/{id}/action-runs",
7754
+ "section": "bot",
7755
+ "parameters": {
7756
+ "id": {
7757
+ "type": "string",
7758
+ "description": "Bot ID",
7759
+ "in": "path"
7760
+ },
7761
+ "integrationName": {
7762
+ "in": "query",
7763
+ "description": "Integration name",
7764
+ "type": "string",
7765
+ "required": true
7766
+ },
7767
+ "timestampFrom": {
7768
+ "in": "query",
7769
+ "description": "Start timestamp (inclusive)",
7770
+ "type": "string"
7771
+ },
7772
+ "timestampUntil": {
7773
+ "in": "query",
7774
+ "description": "End timestamp (inclusive)",
7775
+ "type": "string"
7776
+ },
7777
+ "nextToken": {
7778
+ "in": "query",
7779
+ "description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
7780
+ "type": "string"
7781
+ }
7782
+ },
7783
+ "response": {
7784
+ "description": "Success",
7785
+ "schema": {
7786
+ "type": "object",
7787
+ "properties": {
7788
+ "data": {
7789
+ "type": "array",
7790
+ "items": {
7791
+ "type": "object",
7792
+ "properties": {
7793
+ "timestamp": {
7794
+ "type": "string",
7795
+ "description": "ISO 8601 timestamp of the action run"
7796
+ },
7797
+ "integrationName": {
7798
+ "type": "string"
7799
+ },
7800
+ "actionType": {
7801
+ "type": "string"
7802
+ },
7803
+ "input": {
7804
+ "type": "object",
7805
+ "properties": {},
7806
+ "additionalProperties": true,
7807
+ "description": "Input of the action"
7808
+ },
7809
+ "output": {
7810
+ "type": "object",
7811
+ "properties": {},
7812
+ "additionalProperties": true,
7813
+ "nullable": true,
7814
+ "description": "Output of the action"
7815
+ },
7816
+ "status": {
7817
+ "type": "string",
7818
+ "enum": [
7819
+ "SUCCESS",
7820
+ "FAILURE"
7821
+ ]
7822
+ },
7823
+ "durationMs": {
7824
+ "type": "number"
7825
+ },
7826
+ "cached": {
7827
+ "type": "boolean"
7828
+ },
7829
+ "errorMessage": {
7830
+ "type": "string",
7831
+ "nullable": true
7832
+ }
7833
+ },
7834
+ "required": [
7835
+ "timestamp",
7836
+ "actionType",
7837
+ "input",
7838
+ "output",
7839
+ "status",
7840
+ "durationMs",
7841
+ "cached"
7842
+ ]
7843
+ }
7844
+ },
7845
+ "meta": {
7846
+ "type": "object",
7847
+ "properties": {
7848
+ "nextToken": {
7849
+ "type": "string"
7850
+ }
7851
+ },
7852
+ "additionalProperties": false
7853
+ }
7854
+ },
7855
+ "required": [
7856
+ "data",
7857
+ "meta"
7858
+ ],
7859
+ "title": "listActionRunsResponse",
7860
+ "additionalProperties": false
7861
+ }
7862
+ }
7863
+ },
7752
7864
  "getBotIssue": {
7753
7865
  "name": "getBotIssue",
7754
7866
  "description": "Get Bot Issue",
@@ -15215,7 +15327,7 @@ export const state = {
15215
15327
  },
15216
15328
  "timestampUntil": {
15217
15329
  "in": "query",
15218
- "description": "Timestamp until (exclusive)",
15330
+ "description": "Timestamp until (inclusive)",
15219
15331
  "type": "string"
15220
15332
  },
15221
15333
  "nextToken": {
@@ -15317,7 +15429,7 @@ export const state = {
15317
15429
  },
15318
15430
  "dateUntil": {
15319
15431
  "in": "query",
15320
- "description": "Date until (exclusive)",
15432
+ "description": "Date until (inclusive)",
15321
15433
  "type": "string"
15322
15434
  },
15323
15435
  "nextToken": {
@@ -15568,7 +15680,7 @@ export const state = {
15568
15680
  "index": {
15569
15681
  "default": false,
15570
15682
  "type": "boolean",
15571
- "description": "Set to a value of 'true' to index the file in vector storage. Only certain file formats are currently supported for indexing. Note that if a file is indexed, it will count towards both the Vector DB Storage quota and the File Storage quota of the workspace."
15683
+ "description": "Set to a value of 'true' to index the file in vector storage. Only certain file formats are currently supported for indexing. Files larger than 95 MB cannot be indexed. Note that if a file is indexed, it will count towards both the Vector DB Storage quota and the File Storage quota of the workspace."
15572
15684
  },
15573
15685
  "indexing": {
15574
15686
  "type": "object",
@@ -15809,6 +15921,31 @@ export const state = {
15809
15921
  "type": "string",
15810
15922
  "description": "File expiry timestamp in ISO 8601 format"
15811
15923
  },
15924
+ "owner": {
15925
+ "type": "object",
15926
+ "properties": {
15927
+ "type": {
15928
+ "type": "string",
15929
+ "enum": [
15930
+ "bot",
15931
+ "integration",
15932
+ "user"
15933
+ ]
15934
+ },
15935
+ "id": {
15936
+ "type": "string",
15937
+ "description": "This field is present if `type` is \"user\" or \"bot\". If `type` is \"user\", this is the user ID. If `type` is \"bot\", this is the bot ID."
15938
+ },
15939
+ "name": {
15940
+ "type": "string",
15941
+ "description": "This field is present if the `type` is \"integration\". If `type` is \"integration\", this is the integration name."
15942
+ }
15943
+ },
15944
+ "required": [
15945
+ "type"
15946
+ ],
15947
+ "additionalProperties": false
15948
+ },
15812
15949
  "uploadUrl": {
15813
15950
  "type": "string",
15814
15951
  "description": "URL to upload the file content. File content needs to be sent to this URL via a PUT request."
@@ -15828,6 +15965,7 @@ export const state = {
15828
15965
  "accessPolicies",
15829
15966
  "index",
15830
15967
  "status",
15968
+ "owner",
15831
15969
  "uploadUrl"
15832
15970
  ],
15833
15971
  "additionalProperties": false
@@ -16008,6 +16146,30 @@ export const state = {
16008
16146
  "expiresAt": {
16009
16147
  "type": "string",
16010
16148
  "description": "File expiry timestamp in ISO 8601 format"
16149
+ },
16150
+ "owner": {
16151
+ "type": "object",
16152
+ "properties": {
16153
+ "type": {
16154
+ "type": "string",
16155
+ "enum": [
16156
+ "bot",
16157
+ "integration",
16158
+ "user"
16159
+ ]
16160
+ },
16161
+ "id": {
16162
+ "type": "string",
16163
+ "description": "This field is present if `type` is \"user\" or \"bot\". If `type` is \"user\", this is the user ID. If `type` is \"bot\", this is the bot ID."
16164
+ },
16165
+ "name": {
16166
+ "type": "string",
16167
+ "description": "This field is present if the `type` is \"integration\". If `type` is \"integration\", this is the integration name."
16168
+ }
16169
+ },
16170
+ "required": [
16171
+ "type"
16172
+ ]
16011
16173
  }
16012
16174
  },
16013
16175
  "required": [
@@ -16023,7 +16185,8 @@ export const state = {
16023
16185
  "updatedAt",
16024
16186
  "accessPolicies",
16025
16187
  "index",
16026
- "status"
16188
+ "status",
16189
+ "owner"
16027
16190
  ]
16028
16191
  }
16029
16192
  },
@@ -16150,6 +16313,31 @@ export const state = {
16150
16313
  "expiresAt": {
16151
16314
  "type": "string",
16152
16315
  "description": "File expiry timestamp in ISO 8601 format"
16316
+ },
16317
+ "owner": {
16318
+ "type": "object",
16319
+ "properties": {
16320
+ "type": {
16321
+ "type": "string",
16322
+ "enum": [
16323
+ "bot",
16324
+ "integration",
16325
+ "user"
16326
+ ]
16327
+ },
16328
+ "id": {
16329
+ "type": "string",
16330
+ "description": "This field is present if `type` is \"user\" or \"bot\". If `type` is \"user\", this is the user ID. If `type` is \"bot\", this is the bot ID."
16331
+ },
16332
+ "name": {
16333
+ "type": "string",
16334
+ "description": "This field is present if the `type` is \"integration\". If `type` is \"integration\", this is the integration name."
16335
+ }
16336
+ },
16337
+ "required": [
16338
+ "type"
16339
+ ],
16340
+ "additionalProperties": false
16153
16341
  }
16154
16342
  },
16155
16343
  "required": [
@@ -16165,7 +16353,8 @@ export const state = {
16165
16353
  "updatedAt",
16166
16354
  "accessPolicies",
16167
16355
  "index",
16168
- "status"
16356
+ "status",
16357
+ "owner"
16169
16358
  ],
16170
16359
  "additionalProperties": false
16171
16360
  }
@@ -16320,6 +16509,31 @@ export const state = {
16320
16509
  "expiresAt": {
16321
16510
  "type": "string",
16322
16511
  "description": "File expiry timestamp in ISO 8601 format"
16512
+ },
16513
+ "owner": {
16514
+ "type": "object",
16515
+ "properties": {
16516
+ "type": {
16517
+ "type": "string",
16518
+ "enum": [
16519
+ "bot",
16520
+ "integration",
16521
+ "user"
16522
+ ]
16523
+ },
16524
+ "id": {
16525
+ "type": "string",
16526
+ "description": "This field is present if `type` is \"user\" or \"bot\". If `type` is \"user\", this is the user ID. If `type` is \"bot\", this is the bot ID."
16527
+ },
16528
+ "name": {
16529
+ "type": "string",
16530
+ "description": "This field is present if the `type` is \"integration\". If `type` is \"integration\", this is the integration name."
16531
+ }
16532
+ },
16533
+ "required": [
16534
+ "type"
16535
+ ],
16536
+ "additionalProperties": false
16323
16537
  }
16324
16538
  },
16325
16539
  "required": [
@@ -16335,7 +16549,8 @@ export const state = {
16335
16549
  "updatedAt",
16336
16550
  "accessPolicies",
16337
16551
  "index",
16338
- "status"
16552
+ "status",
16553
+ "owner"
16339
16554
  ],
16340
16555
  "additionalProperties": false
16341
16556
  }
@@ -16475,6 +16690,31 @@ export const state = {
16475
16690
  "expiresAt": {
16476
16691
  "type": "string",
16477
16692
  "description": "File expiry timestamp in ISO 8601 format"
16693
+ },
16694
+ "owner": {
16695
+ "type": "object",
16696
+ "properties": {
16697
+ "type": {
16698
+ "type": "string",
16699
+ "enum": [
16700
+ "bot",
16701
+ "integration",
16702
+ "user"
16703
+ ]
16704
+ },
16705
+ "id": {
16706
+ "type": "string",
16707
+ "description": "This field is present if `type` is \"user\" or \"bot\". If `type` is \"user\", this is the user ID. If `type` is \"bot\", this is the bot ID."
16708
+ },
16709
+ "name": {
16710
+ "type": "string",
16711
+ "description": "This field is present if the `type` is \"integration\". If `type` is \"integration\", this is the integration name."
16712
+ }
16713
+ },
16714
+ "required": [
16715
+ "type"
16716
+ ],
16717
+ "additionalProperties": false
16478
16718
  }
16479
16719
  },
16480
16720
  "required": [
@@ -16490,7 +16730,8 @@ export const state = {
16490
16730
  "updatedAt",
16491
16731
  "accessPolicies",
16492
16732
  "index",
16493
- "status"
16733
+ "status",
16734
+ "owner"
16494
16735
  ],
16495
16736
  "additionalProperties": false
16496
16737
  }
@@ -18389,7 +18630,7 @@ export const state = {
18389
18630
  "title": "Botpress API",
18390
18631
  "description": "API for Botpress Cloud",
18391
18632
  "server": "https://api.botpress.cloud",
18392
- "version": "1.18.1",
18633
+ "version": "1.19.0",
18393
18634
  "prefix": "v1"
18394
18635
  },
18395
18636
  "errors": [
@@ -18660,6 +18901,7 @@ export const state = {
18660
18901
  "getBotLogsResponse": true,
18661
18902
  "getBotWebchatResponse": true,
18662
18903
  "getBotAnalyticsResponse": true,
18904
+ "listActionRunsResponse": true,
18663
18905
  "getBotIssueResponse": true,
18664
18906
  "listBotIssuesResponse": true,
18665
18907
  "deleteBotIssueResponse": true,
@@ -22198,6 +22440,31 @@ export const state = {
22198
22440
  "expiresAt": {
22199
22441
  "type": "string",
22200
22442
  "description": "File expiry timestamp in ISO 8601 format"
22443
+ },
22444
+ "owner": {
22445
+ "type": "object",
22446
+ "properties": {
22447
+ "type": {
22448
+ "type": "string",
22449
+ "enum": [
22450
+ "bot",
22451
+ "integration",
22452
+ "user"
22453
+ ]
22454
+ },
22455
+ "id": {
22456
+ "type": "string",
22457
+ "description": "This field is present if `type` is \"user\" or \"bot\". If `type` is \"user\", this is the user ID. If `type` is \"bot\", this is the bot ID."
22458
+ },
22459
+ "name": {
22460
+ "type": "string",
22461
+ "description": "This field is present if the `type` is \"integration\". If `type` is \"integration\", this is the integration name."
22462
+ }
22463
+ },
22464
+ "required": [
22465
+ "type"
22466
+ ],
22467
+ "additionalProperties": false
22201
22468
  }
22202
22469
  },
22203
22470
  "required": [
@@ -22213,7 +22480,8 @@ export const state = {
22213
22480
  "updatedAt",
22214
22481
  "accessPolicies",
22215
22482
  "index",
22216
- "status"
22483
+ "status",
22484
+ "owner"
22217
22485
  ],
22218
22486
  "additionalProperties": false
22219
22487
  }
@@ -22364,6 +22632,7 @@ export const state = {
22364
22632
  "getBotLogs",
22365
22633
  "getBotWebchat",
22366
22634
  "getBotAnalytics",
22635
+ "listActionRuns",
22367
22636
  "getBotIssue",
22368
22637
  "listBotIssues",
22369
22638
  "deleteBotIssue",