@botpress/api 0.24.0 → 0.25.1
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 +129 -52
- package/dist/src/gen/state.d.ts +88 -38
- package/package.json +1 -1
- package/src/gen/openapi.json +1 -1
- package/src/gen/state.ts +129 -52
package/src/gen/state.ts
CHANGED
|
@@ -2469,6 +2469,11 @@ export const state = {
|
|
|
2469
2469
|
"description": "Global identifier configuration of the [Integration](#schema_integration)",
|
|
2470
2470
|
"additionalProperties": false
|
|
2471
2471
|
},
|
|
2472
|
+
"url": {
|
|
2473
|
+
"type": "string",
|
|
2474
|
+
"maxLength": 2000,
|
|
2475
|
+
"description": "Title describing the task"
|
|
2476
|
+
},
|
|
2472
2477
|
"name": {
|
|
2473
2478
|
"type": "string",
|
|
2474
2479
|
"maxLength": 200,
|
|
@@ -2883,6 +2888,7 @@ export const state = {
|
|
|
2883
2888
|
"createdAt",
|
|
2884
2889
|
"updatedAt",
|
|
2885
2890
|
"identifier",
|
|
2891
|
+
"url",
|
|
2886
2892
|
"name",
|
|
2887
2893
|
"version",
|
|
2888
2894
|
"configuration",
|
|
@@ -2974,6 +2980,11 @@ export const state = {
|
|
|
2974
2980
|
"description": "Global identifier configuration of the [Integration](#schema_integration)",
|
|
2975
2981
|
"additionalProperties": false
|
|
2976
2982
|
},
|
|
2983
|
+
"url": {
|
|
2984
|
+
"type": "string",
|
|
2985
|
+
"maxLength": 2000,
|
|
2986
|
+
"description": "Title describing the task"
|
|
2987
|
+
},
|
|
2977
2988
|
"name": {
|
|
2978
2989
|
"type": "string",
|
|
2979
2990
|
"maxLength": 200,
|
|
@@ -3388,6 +3399,7 @@ export const state = {
|
|
|
3388
3399
|
"createdAt",
|
|
3389
3400
|
"updatedAt",
|
|
3390
3401
|
"identifier",
|
|
3402
|
+
"url",
|
|
3391
3403
|
"name",
|
|
3392
3404
|
"version",
|
|
3393
3405
|
"configuration",
|
|
@@ -6605,9 +6617,9 @@ export const state = {
|
|
|
6605
6617
|
"section": "integration",
|
|
6606
6618
|
"path": "/v1/admin/integrations/iaks",
|
|
6607
6619
|
"parameters": {
|
|
6608
|
-
"
|
|
6620
|
+
"integrationId": {
|
|
6609
6621
|
"in": "query",
|
|
6610
|
-
"description": "ID of the integration
|
|
6622
|
+
"description": "ID of the integration",
|
|
6611
6623
|
"type": "string",
|
|
6612
6624
|
"required": true
|
|
6613
6625
|
}
|
|
@@ -6660,7 +6672,7 @@ export const state = {
|
|
|
6660
6672
|
"schema": {
|
|
6661
6673
|
"type": "object",
|
|
6662
6674
|
"properties": {
|
|
6663
|
-
"
|
|
6675
|
+
"integrationId": {
|
|
6664
6676
|
"type": "string"
|
|
6665
6677
|
},
|
|
6666
6678
|
"note": {
|
|
@@ -6668,7 +6680,7 @@ export const state = {
|
|
|
6668
6680
|
}
|
|
6669
6681
|
},
|
|
6670
6682
|
"required": [
|
|
6671
|
-
"
|
|
6683
|
+
"integrationId"
|
|
6672
6684
|
],
|
|
6673
6685
|
"title": "createIntegrationApiKeyBody",
|
|
6674
6686
|
"additionalProperties": false
|
|
@@ -7096,7 +7108,7 @@ export const state = {
|
|
|
7096
7108
|
},
|
|
7097
7109
|
"url": {
|
|
7098
7110
|
"type": "string",
|
|
7099
|
-
"description": "URL of the integration
|
|
7111
|
+
"description": "URL of the integration"
|
|
7100
7112
|
},
|
|
7101
7113
|
"dev": {
|
|
7102
7114
|
"type": "boolean",
|
|
@@ -7546,7 +7558,8 @@ export const state = {
|
|
|
7546
7558
|
},
|
|
7547
7559
|
"url": {
|
|
7548
7560
|
"type": "string",
|
|
7549
|
-
"description": "URL of the integration
|
|
7561
|
+
"description": "URL of the integration",
|
|
7562
|
+
"nullable": true
|
|
7550
7563
|
},
|
|
7551
7564
|
"public": {
|
|
7552
7565
|
"type": "boolean",
|
|
@@ -8110,48 +8123,44 @@ export const state = {
|
|
|
8110
8123
|
"schema": {
|
|
8111
8124
|
"type": "object",
|
|
8112
8125
|
"properties": {
|
|
8113
|
-
"
|
|
8114
|
-
"
|
|
8126
|
+
"name": {
|
|
8127
|
+
"type": "string",
|
|
8128
|
+
"description": "File name"
|
|
8129
|
+
},
|
|
8130
|
+
"tags": {
|
|
8131
|
+
"type": "object",
|
|
8132
|
+
"additionalProperties": {
|
|
8133
|
+
"type": "string",
|
|
8134
|
+
"maxLength": 1000
|
|
8135
|
+
},
|
|
8136
|
+
"description": "File tags as an object of key/value pairs"
|
|
8137
|
+
},
|
|
8138
|
+
"index": {
|
|
8139
|
+
"default": false,
|
|
8140
|
+
"type": "boolean",
|
|
8141
|
+
"description": "Set to a value of 'true' to index the file in vector storage. Only PDFs, Office documents, and text-based files are currently supported. Note that if a file is indexed, it will count towards the Vector Storage quota of the workspace rather than the File Storage quota."
|
|
8142
|
+
},
|
|
8143
|
+
"accessPolicies": {
|
|
8144
|
+
"type": "array",
|
|
8145
|
+
"items": {
|
|
8146
|
+
"type": "string",
|
|
8147
|
+
"enum": [
|
|
8148
|
+
"public_content",
|
|
8149
|
+
"integrations"
|
|
8150
|
+
]
|
|
8151
|
+
},
|
|
8152
|
+
"description": "File access policies. Add \"public_content\" to allow public access to the file content. Add \"integrations\" to allow read, search and list operations for any integration installed in the bot."
|
|
8153
|
+
},
|
|
8154
|
+
"contentType": {
|
|
8155
|
+
"type": "string",
|
|
8156
|
+
"description": "File content type. If omitted, the content type will be inferred from the file extension. If a type cannot be inferred, the default is \"application/octet-stream\"."
|
|
8115
8157
|
}
|
|
8116
8158
|
},
|
|
8117
8159
|
"title": "createFileBody",
|
|
8118
|
-
"format": "binary",
|
|
8119
8160
|
"additionalProperties": false
|
|
8120
8161
|
}
|
|
8121
8162
|
},
|
|
8122
|
-
"
|
|
8123
|
-
"x-name": {
|
|
8124
|
-
"type": "string",
|
|
8125
|
-
"description": "File name",
|
|
8126
|
-
"in": "header"
|
|
8127
|
-
},
|
|
8128
|
-
"x-tags": {
|
|
8129
|
-
"type": "string",
|
|
8130
|
-
"description": "File tags as URL-encoded JSON string representing an object of key-value pairs.",
|
|
8131
|
-
"in": "header"
|
|
8132
|
-
},
|
|
8133
|
-
"x-access-policies": {
|
|
8134
|
-
"type": "string",
|
|
8135
|
-
"description": "File access policies, comma-separated. Add \"public_content\" to allow public access to the file content. Add \"integrations\" to allo read, search and list operations for any integration installed in the bot.",
|
|
8136
|
-
"in": "header"
|
|
8137
|
-
},
|
|
8138
|
-
"x-index": {
|
|
8139
|
-
"type": "boolean",
|
|
8140
|
-
"description": "Set to a value of \"true\" to index the file in vector storage (default: false). Only PDFs, Office documents, and text-based files are currently supported. Note that if a file is indexed, it will count towards the Vector Storage quota of the workspace rather than the File Storage quota.",
|
|
8141
|
-
"in": "header"
|
|
8142
|
-
},
|
|
8143
|
-
"Content-Type": {
|
|
8144
|
-
"type": "string",
|
|
8145
|
-
"description": "File content type. If omitted, the content type will be inferred from the file extension. If a type cannot be inferred, the default is \"application/octet-stream\".",
|
|
8146
|
-
"in": "header"
|
|
8147
|
-
},
|
|
8148
|
-
"Content-Length": {
|
|
8149
|
-
"type": "string",
|
|
8150
|
-
"description": "File content length",
|
|
8151
|
-
"in": "header"
|
|
8152
|
-
}
|
|
8153
|
-
},
|
|
8154
|
-
"contentType": "*/*",
|
|
8163
|
+
"contentType": "application/json",
|
|
8155
8164
|
"section": "files",
|
|
8156
8165
|
"response": {
|
|
8157
8166
|
"description": "The file metadata.",
|
|
@@ -8176,7 +8185,7 @@ export const state = {
|
|
|
8176
8185
|
},
|
|
8177
8186
|
"size": {
|
|
8178
8187
|
"type": "number",
|
|
8179
|
-
"description": "File size in bytes",
|
|
8188
|
+
"description": "File size in bytes. Non-null if file upload status is \"COMPLETE\".",
|
|
8180
8189
|
"nullable": true
|
|
8181
8190
|
},
|
|
8182
8191
|
"contentType": {
|
|
@@ -8219,6 +8228,23 @@ export const state = {
|
|
|
8219
8228
|
"indexingFailureReason": {
|
|
8220
8229
|
"type": "string",
|
|
8221
8230
|
"description": "Last failure reason of the file indexing if the indexing status is \"FAILED\"."
|
|
8231
|
+
},
|
|
8232
|
+
"uploadStatus": {
|
|
8233
|
+
"type": "string",
|
|
8234
|
+
"enum": [
|
|
8235
|
+
"PENDING",
|
|
8236
|
+
"COMPLETE",
|
|
8237
|
+
"FAILED"
|
|
8238
|
+
],
|
|
8239
|
+
"description": "Status of the file upload process. If the status is \"PENDING\", the file content has not been uploaded yet. \nThe status will be set to \"COMPLETE\" once the file content has been uploaded successfully. \nIf the status is \"FAILED\", the file content could not be uploaded. See \"uploadFailureReason\" for more details."
|
|
8240
|
+
},
|
|
8241
|
+
"uploadFailureReason": {
|
|
8242
|
+
"type": "string",
|
|
8243
|
+
"description": "Failure reason of the file upload if the upload status is \"FAILED\"."
|
|
8244
|
+
},
|
|
8245
|
+
"uploadUrl": {
|
|
8246
|
+
"type": "string",
|
|
8247
|
+
"description": "URL to upload the file content. File content needs to be sent to this URL via a POST request."
|
|
8222
8248
|
}
|
|
8223
8249
|
},
|
|
8224
8250
|
"required": [
|
|
@@ -8230,7 +8256,9 @@ export const state = {
|
|
|
8230
8256
|
"tags",
|
|
8231
8257
|
"createdAt",
|
|
8232
8258
|
"updatedAt",
|
|
8233
|
-
"accessPolicies"
|
|
8259
|
+
"accessPolicies",
|
|
8260
|
+
"uploadStatus",
|
|
8261
|
+
"uploadUrl"
|
|
8234
8262
|
],
|
|
8235
8263
|
"additionalProperties": false
|
|
8236
8264
|
}
|
|
@@ -8241,7 +8269,8 @@ export const state = {
|
|
|
8241
8269
|
"title": "createFileResponse",
|
|
8242
8270
|
"additionalProperties": false
|
|
8243
8271
|
}
|
|
8244
|
-
}
|
|
8272
|
+
},
|
|
8273
|
+
"parameters": {}
|
|
8245
8274
|
},
|
|
8246
8275
|
"deleteFile": {
|
|
8247
8276
|
"name": "deleteFile",
|
|
@@ -8319,7 +8348,7 @@ export const state = {
|
|
|
8319
8348
|
},
|
|
8320
8349
|
"size": {
|
|
8321
8350
|
"type": "number",
|
|
8322
|
-
"description": "File size in bytes",
|
|
8351
|
+
"description": "File size in bytes. Non-null if file upload status is \"COMPLETE\".",
|
|
8323
8352
|
"nullable": true
|
|
8324
8353
|
},
|
|
8325
8354
|
"contentType": {
|
|
@@ -8362,6 +8391,19 @@ export const state = {
|
|
|
8362
8391
|
"indexingFailureReason": {
|
|
8363
8392
|
"type": "string",
|
|
8364
8393
|
"description": "Last failure reason of the file indexing if the indexing status is \"FAILED\"."
|
|
8394
|
+
},
|
|
8395
|
+
"uploadStatus": {
|
|
8396
|
+
"type": "string",
|
|
8397
|
+
"enum": [
|
|
8398
|
+
"PENDING",
|
|
8399
|
+
"COMPLETE",
|
|
8400
|
+
"FAILED"
|
|
8401
|
+
],
|
|
8402
|
+
"description": "Status of the file upload process. If the status is \"PENDING\", the file content has not been uploaded yet. \nThe status will be set to \"COMPLETE\" once the file content has been uploaded successfully. \nIf the status is \"FAILED\", the file content could not be uploaded. See \"uploadFailureReason\" for more details."
|
|
8403
|
+
},
|
|
8404
|
+
"uploadFailureReason": {
|
|
8405
|
+
"type": "string",
|
|
8406
|
+
"description": "Failure reason of the file upload if the upload status is \"FAILED\"."
|
|
8365
8407
|
}
|
|
8366
8408
|
},
|
|
8367
8409
|
"required": [
|
|
@@ -8373,7 +8415,8 @@ export const state = {
|
|
|
8373
8415
|
"tags",
|
|
8374
8416
|
"createdAt",
|
|
8375
8417
|
"updatedAt",
|
|
8376
|
-
"accessPolicies"
|
|
8418
|
+
"accessPolicies",
|
|
8419
|
+
"uploadStatus"
|
|
8377
8420
|
]
|
|
8378
8421
|
}
|
|
8379
8422
|
},
|
|
@@ -8433,7 +8476,7 @@ export const state = {
|
|
|
8433
8476
|
},
|
|
8434
8477
|
"size": {
|
|
8435
8478
|
"type": "number",
|
|
8436
|
-
"description": "File size in bytes",
|
|
8479
|
+
"description": "File size in bytes. Non-null if file upload status is \"COMPLETE\".",
|
|
8437
8480
|
"nullable": true
|
|
8438
8481
|
},
|
|
8439
8482
|
"contentType": {
|
|
@@ -8476,6 +8519,19 @@ export const state = {
|
|
|
8476
8519
|
"indexingFailureReason": {
|
|
8477
8520
|
"type": "string",
|
|
8478
8521
|
"description": "Last failure reason of the file indexing if the indexing status is \"FAILED\"."
|
|
8522
|
+
},
|
|
8523
|
+
"uploadStatus": {
|
|
8524
|
+
"type": "string",
|
|
8525
|
+
"enum": [
|
|
8526
|
+
"PENDING",
|
|
8527
|
+
"COMPLETE",
|
|
8528
|
+
"FAILED"
|
|
8529
|
+
],
|
|
8530
|
+
"description": "Status of the file upload process. If the status is \"PENDING\", the file content has not been uploaded yet. \nThe status will be set to \"COMPLETE\" once the file content has been uploaded successfully. \nIf the status is \"FAILED\", the file content could not be uploaded. See \"uploadFailureReason\" for more details."
|
|
8531
|
+
},
|
|
8532
|
+
"uploadFailureReason": {
|
|
8533
|
+
"type": "string",
|
|
8534
|
+
"description": "Failure reason of the file upload if the upload status is \"FAILED\"."
|
|
8479
8535
|
}
|
|
8480
8536
|
},
|
|
8481
8537
|
"required": [
|
|
@@ -8487,7 +8543,8 @@ export const state = {
|
|
|
8487
8543
|
"tags",
|
|
8488
8544
|
"createdAt",
|
|
8489
8545
|
"updatedAt",
|
|
8490
|
-
"accessPolicies"
|
|
8546
|
+
"accessPolicies",
|
|
8547
|
+
"uploadStatus"
|
|
8491
8548
|
],
|
|
8492
8549
|
"additionalProperties": false
|
|
8493
8550
|
}
|
|
@@ -9552,7 +9609,7 @@ export const state = {
|
|
|
9552
9609
|
"title": "Botpress API",
|
|
9553
9610
|
"description": "API for Botpress Cloud",
|
|
9554
9611
|
"server": "https://api.botpress.cloud",
|
|
9555
|
-
"version": "0.
|
|
9612
|
+
"version": "0.25.1",
|
|
9556
9613
|
"prefix": "v1"
|
|
9557
9614
|
},
|
|
9558
9615
|
"errors": [
|
|
@@ -10413,6 +10470,11 @@ export const state = {
|
|
|
10413
10470
|
"description": "Global identifier configuration of the [Integration](#schema_integration)",
|
|
10414
10471
|
"additionalProperties": false
|
|
10415
10472
|
},
|
|
10473
|
+
"url": {
|
|
10474
|
+
"type": "string",
|
|
10475
|
+
"maxLength": 2000,
|
|
10476
|
+
"description": "Title describing the task"
|
|
10477
|
+
},
|
|
10416
10478
|
"name": {
|
|
10417
10479
|
"type": "string",
|
|
10418
10480
|
"maxLength": 200,
|
|
@@ -10806,6 +10868,7 @@ export const state = {
|
|
|
10806
10868
|
"createdAt",
|
|
10807
10869
|
"updatedAt",
|
|
10808
10870
|
"identifier",
|
|
10871
|
+
"url",
|
|
10809
10872
|
"name",
|
|
10810
10873
|
"version",
|
|
10811
10874
|
"configuration",
|
|
@@ -11880,7 +11943,7 @@ export const state = {
|
|
|
11880
11943
|
},
|
|
11881
11944
|
"size": {
|
|
11882
11945
|
"type": "number",
|
|
11883
|
-
"description": "File size in bytes",
|
|
11946
|
+
"description": "File size in bytes. Non-null if file upload status is \"COMPLETE\".",
|
|
11884
11947
|
"nullable": true
|
|
11885
11948
|
},
|
|
11886
11949
|
"contentType": {
|
|
@@ -11923,6 +11986,19 @@ export const state = {
|
|
|
11923
11986
|
"indexingFailureReason": {
|
|
11924
11987
|
"type": "string",
|
|
11925
11988
|
"description": "Last failure reason of the file indexing if the indexing status is \"FAILED\"."
|
|
11989
|
+
},
|
|
11990
|
+
"uploadStatus": {
|
|
11991
|
+
"type": "string",
|
|
11992
|
+
"enum": [
|
|
11993
|
+
"PENDING",
|
|
11994
|
+
"COMPLETE",
|
|
11995
|
+
"FAILED"
|
|
11996
|
+
],
|
|
11997
|
+
"description": "Status of the file upload process. If the status is \"PENDING\", the file content has not been uploaded yet. \nThe status will be set to \"COMPLETE\" once the file content has been uploaded successfully. \nIf the status is \"FAILED\", the file content could not be uploaded. See \"uploadFailureReason\" for more details."
|
|
11998
|
+
},
|
|
11999
|
+
"uploadFailureReason": {
|
|
12000
|
+
"type": "string",
|
|
12001
|
+
"description": "Failure reason of the file upload if the upload status is \"FAILED\"."
|
|
11926
12002
|
}
|
|
11927
12003
|
},
|
|
11928
12004
|
"required": [
|
|
@@ -11934,7 +12010,8 @@ export const state = {
|
|
|
11934
12010
|
"tags",
|
|
11935
12011
|
"createdAt",
|
|
11936
12012
|
"updatedAt",
|
|
11937
|
-
"accessPolicies"
|
|
12013
|
+
"accessPolicies",
|
|
12014
|
+
"uploadStatus"
|
|
11938
12015
|
],
|
|
11939
12016
|
"additionalProperties": false
|
|
11940
12017
|
}
|