@botpress/api 0.26.4 → 0.27.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.
Files changed (6) hide show
  1. package/dist/index.js +75 -126
  2. package/dist/src/gen/state.d.ts +19 -64
  3. package/package.json +1 -1
  4. package/src/gen/metadata.json +1 -1
  5. package/src/gen/openapi.json +1 -1
  6. package/src/gen/state.ts +75 -126
package/src/gen/state.ts CHANGED
@@ -8070,7 +8070,7 @@ export const state = {
8070
8070
  "contentType": "application/json",
8071
8071
  "section": "files",
8072
8072
  "response": {
8073
- "description": "The file metadata.",
8073
+ "description": "The created file",
8074
8074
  "schema": {
8075
8075
  "type": "object",
8076
8076
  "properties": {
@@ -8122,36 +8122,29 @@ export const state = {
8122
8122
  },
8123
8123
  "description": "Access policies configured for the file."
8124
8124
  },
8125
- "indexingStatus": {
8126
- "type": "string",
8127
- "enum": [
8128
- "PENDING",
8129
- "IN_PROGRESS",
8130
- "COMPLETE",
8131
- "FAILED"
8132
- ],
8133
- "description": "Status of the file indexing process. No value will be set if indexing was not enabled for the file when it was created."
8134
- },
8135
- "indexingFailureReason": {
8136
- "type": "string",
8137
- "description": "Last failure reason of the file indexing if the indexing status is \"FAILED\"."
8125
+ "index": {
8126
+ "type": "boolean",
8127
+ "description": "Whether the file was requested to be indexed for search or not."
8138
8128
  },
8139
- "uploadStatus": {
8129
+ "status": {
8140
8130
  "type": "string",
8141
8131
  "enum": [
8142
- "PENDING",
8143
- "COMPLETE",
8144
- "FAILED"
8132
+ "UPLOAD_PENDING",
8133
+ "UPLOAD_FAILED",
8134
+ "UPLOAD_COMPLETED",
8135
+ "INDEXING_PENDING",
8136
+ "INDEXING_FAILED",
8137
+ "INDEXING_COMPLETED"
8145
8138
  ],
8146
- "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."
8139
+ "description": "Status of the file. If the status is \"UPLOAD_PENDING\", the file content has not been uploaded yet. The status will be set to \"UPLOAD_COMPLETED\" once the file content has been uploaded successfully.\n\nIf the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to \"UPLOAD_FAILED\" and the reason for the failure will be available in the `failedStatusReason` field of the file.\n\nHowever, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the \"INDEXING_PENDING\" status (the \"UPLOAD_COMPLETED\" status step will be skipped).\n\nOnce the indexing is completed and the file is ready to be used for searching its status will be set to \"INDEXING_COMPLETED\". If the indexing failed the status will be set to \"INDEXING_FAILED\" and the reason for the failure will be available in the `failedStatusReason` field."
8147
8140
  },
8148
- "uploadFailureReason": {
8141
+ "failedStatusReason": {
8149
8142
  "type": "string",
8150
- "description": "Failure reason of the file upload if the upload status is \"FAILED\"."
8143
+ "description": "If the file status is \"UPLOAD_FAILED\" or \"INDEXING_FAILED\" this will contain the reason of the failure."
8151
8144
  },
8152
8145
  "uploadUrl": {
8153
8146
  "type": "string",
8154
- "description": "URL to upload the file content. File content needs to be sent to this URL via a POST request."
8147
+ "description": "URL to upload the file content. File content needs to be sent to this URL via a PUT request."
8155
8148
  }
8156
8149
  },
8157
8150
  "required": [
@@ -8164,7 +8157,8 @@ export const state = {
8164
8157
  "createdAt",
8165
8158
  "updatedAt",
8166
8159
  "accessPolicies",
8167
- "uploadStatus",
8160
+ "index",
8161
+ "status",
8168
8162
  "uploadUrl"
8169
8163
  ],
8170
8164
  "additionalProperties": false
@@ -8285,32 +8279,25 @@ export const state = {
8285
8279
  },
8286
8280
  "description": "Access policies configured for the file."
8287
8281
  },
8288
- "indexingStatus": {
8289
- "type": "string",
8290
- "enum": [
8291
- "PENDING",
8292
- "IN_PROGRESS",
8293
- "COMPLETE",
8294
- "FAILED"
8295
- ],
8296
- "description": "Status of the file indexing process. No value will be set if indexing was not enabled for the file when it was created."
8297
- },
8298
- "indexingFailureReason": {
8299
- "type": "string",
8300
- "description": "Last failure reason of the file indexing if the indexing status is \"FAILED\"."
8282
+ "index": {
8283
+ "type": "boolean",
8284
+ "description": "Whether the file was requested to be indexed for search or not."
8301
8285
  },
8302
- "uploadStatus": {
8286
+ "status": {
8303
8287
  "type": "string",
8304
8288
  "enum": [
8305
- "PENDING",
8306
- "COMPLETE",
8307
- "FAILED"
8289
+ "UPLOAD_PENDING",
8290
+ "UPLOAD_FAILED",
8291
+ "UPLOAD_COMPLETED",
8292
+ "INDEXING_PENDING",
8293
+ "INDEXING_FAILED",
8294
+ "INDEXING_COMPLETED"
8308
8295
  ],
8309
- "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."
8296
+ "description": "Status of the file. If the status is \"UPLOAD_PENDING\", the file content has not been uploaded yet. The status will be set to \"UPLOAD_COMPLETED\" once the file content has been uploaded successfully.\n\nIf the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to \"UPLOAD_FAILED\" and the reason for the failure will be available in the `failedStatusReason` field of the file.\n\nHowever, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the \"INDEXING_PENDING\" status (the \"UPLOAD_COMPLETED\" status step will be skipped).\n\nOnce the indexing is completed and the file is ready to be used for searching its status will be set to \"INDEXING_COMPLETED\". If the indexing failed the status will be set to \"INDEXING_FAILED\" and the reason for the failure will be available in the `failedStatusReason` field."
8310
8297
  },
8311
- "uploadFailureReason": {
8298
+ "failedStatusReason": {
8312
8299
  "type": "string",
8313
- "description": "Failure reason of the file upload if the upload status is \"FAILED\"."
8300
+ "description": "If the file status is \"UPLOAD_FAILED\" or \"INDEXING_FAILED\" this will contain the reason of the failure."
8314
8301
  }
8315
8302
  },
8316
8303
  "required": [
@@ -8323,7 +8310,8 @@ export const state = {
8323
8310
  "createdAt",
8324
8311
  "updatedAt",
8325
8312
  "accessPolicies",
8326
- "uploadStatus"
8313
+ "index",
8314
+ "status"
8327
8315
  ]
8328
8316
  }
8329
8317
  },
@@ -8347,10 +8335,10 @@ export const state = {
8347
8335
  }
8348
8336
  }
8349
8337
  },
8350
- "getFileMetadata": {
8351
- "name": "getFileMetadata",
8352
- "path": "/v1/files/{id}/metadata",
8353
- "description": "Get file metadata",
8338
+ "getFile": {
8339
+ "name": "getFile",
8340
+ "path": "/v1/files/{id}",
8341
+ "description": "Get file",
8354
8342
  "method": "get",
8355
8343
  "section": "files",
8356
8344
  "parameters": {
@@ -8361,7 +8349,7 @@ export const state = {
8361
8349
  }
8362
8350
  },
8363
8351
  "response": {
8364
- "description": "The metadata of the file.",
8352
+ "description": "File metadata and URL",
8365
8353
  "schema": {
8366
8354
  "type": "object",
8367
8355
  "properties": {
@@ -8413,32 +8401,25 @@ export const state = {
8413
8401
  },
8414
8402
  "description": "Access policies configured for the file."
8415
8403
  },
8416
- "indexingStatus": {
8417
- "type": "string",
8418
- "enum": [
8419
- "PENDING",
8420
- "IN_PROGRESS",
8421
- "COMPLETE",
8422
- "FAILED"
8423
- ],
8424
- "description": "Status of the file indexing process. No value will be set if indexing was not enabled for the file when it was created."
8425
- },
8426
- "indexingFailureReason": {
8427
- "type": "string",
8428
- "description": "Last failure reason of the file indexing if the indexing status is \"FAILED\"."
8404
+ "index": {
8405
+ "type": "boolean",
8406
+ "description": "Whether the file was requested to be indexed for search or not."
8429
8407
  },
8430
- "uploadStatus": {
8408
+ "status": {
8431
8409
  "type": "string",
8432
8410
  "enum": [
8433
- "PENDING",
8434
- "COMPLETE",
8435
- "FAILED"
8411
+ "UPLOAD_PENDING",
8412
+ "UPLOAD_FAILED",
8413
+ "UPLOAD_COMPLETED",
8414
+ "INDEXING_PENDING",
8415
+ "INDEXING_FAILED",
8416
+ "INDEXING_COMPLETED"
8436
8417
  ],
8437
- "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."
8418
+ "description": "Status of the file. If the status is \"UPLOAD_PENDING\", the file content has not been uploaded yet. The status will be set to \"UPLOAD_COMPLETED\" once the file content has been uploaded successfully.\n\nIf the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to \"UPLOAD_FAILED\" and the reason for the failure will be available in the `failedStatusReason` field of the file.\n\nHowever, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the \"INDEXING_PENDING\" status (the \"UPLOAD_COMPLETED\" status step will be skipped).\n\nOnce the indexing is completed and the file is ready to be used for searching its status will be set to \"INDEXING_COMPLETED\". If the indexing failed the status will be set to \"INDEXING_FAILED\" and the reason for the failure will be available in the `failedStatusReason` field."
8438
8419
  },
8439
- "uploadFailureReason": {
8420
+ "failedStatusReason": {
8440
8421
  "type": "string",
8441
- "description": "Failure reason of the file upload if the upload status is \"FAILED\"."
8422
+ "description": "If the file status is \"UPLOAD_FAILED\" or \"INDEXING_FAILED\" this will contain the reason of the failure."
8442
8423
  }
8443
8424
  },
8444
8425
  "required": [
@@ -8451,46 +8432,22 @@ export const state = {
8451
8432
  "createdAt",
8452
8433
  "updatedAt",
8453
8434
  "accessPolicies",
8454
- "uploadStatus"
8435
+ "index",
8436
+ "status"
8455
8437
  ],
8456
8438
  "additionalProperties": false
8457
- }
8458
- },
8459
- "required": [
8460
- "file"
8461
- ],
8462
- "title": "getFileMetadataResponse",
8463
- "additionalProperties": false
8464
- }
8465
- }
8466
- },
8467
- "getFileContent": {
8468
- "name": "getFileContent",
8469
- "path": "/v1/files/{id}/content",
8470
- "description": "Returns a presigned URL to download the file content.",
8471
- "method": "get",
8472
- "section": "files",
8473
- "parameters": {
8474
- "id": {
8475
- "type": "string",
8476
- "description": "File ID",
8477
- "in": "path"
8478
- }
8479
- },
8480
- "response": {
8481
- "description": "Returns a temporary pre-signed URL to download the file content.",
8482
- "schema": {
8483
- "type": "object",
8484
- "properties": {
8439
+ },
8485
8440
  "url": {
8486
8441
  "type": "string",
8487
- "description": "Temporary pre-signed URL to download the file, should be used shortly after retrieving and should not be stored long-term as the URL will expire after a short timeframe."
8442
+ "description": "If the file is not uploaded yet, this will be set to a `null` value.\n\nIf the file has a `public_content` policy, this will contain the permanent public URL to retrieve the file, otherwise this will contain a temporary pre-signed URL to download the file which should be used shortly after retrieving and should not be stored long-term as the URL will expire after a short timeframe.",
8443
+ "nullable": true
8488
8444
  }
8489
8445
  },
8490
8446
  "required": [
8447
+ "file",
8491
8448
  "url"
8492
8449
  ],
8493
- "title": "getFileContentResponse",
8450
+ "title": "getFileResponse",
8494
8451
  "additionalProperties": false
8495
8452
  }
8496
8453
  }
@@ -9524,7 +9481,7 @@ export const state = {
9524
9481
  "title": "Botpress API",
9525
9482
  "description": "API for Botpress Cloud",
9526
9483
  "server": "https://api.botpress.cloud",
9527
- "version": "0.26.4",
9484
+ "version": "0.27.1",
9528
9485
  "prefix": "v1"
9529
9486
  },
9530
9487
  "errors": [
@@ -9798,8 +9755,7 @@ export const state = {
9798
9755
  "createFileResponse": true,
9799
9756
  "deleteFileResponse": true,
9800
9757
  "listFilesResponse": true,
9801
- "getFileMetadataResponse": true,
9802
- "getFileContentResponse": true,
9758
+ "getFileResponse": true,
9803
9759
  "updateFileMetadataResponse": true,
9804
9760
  "searchFilesResponse": true,
9805
9761
  "listTablesResponse": true,
@@ -11886,32 +11842,25 @@ export const state = {
11886
11842
  },
11887
11843
  "description": "Access policies configured for the file."
11888
11844
  },
11889
- "indexingStatus": {
11890
- "type": "string",
11891
- "enum": [
11892
- "PENDING",
11893
- "IN_PROGRESS",
11894
- "COMPLETE",
11895
- "FAILED"
11896
- ],
11897
- "description": "Status of the file indexing process. No value will be set if indexing was not enabled for the file when it was created."
11898
- },
11899
- "indexingFailureReason": {
11900
- "type": "string",
11901
- "description": "Last failure reason of the file indexing if the indexing status is \"FAILED\"."
11845
+ "index": {
11846
+ "type": "boolean",
11847
+ "description": "Whether the file was requested to be indexed for search or not."
11902
11848
  },
11903
- "uploadStatus": {
11849
+ "status": {
11904
11850
  "type": "string",
11905
11851
  "enum": [
11906
- "PENDING",
11907
- "COMPLETE",
11908
- "FAILED"
11852
+ "UPLOAD_PENDING",
11853
+ "UPLOAD_FAILED",
11854
+ "UPLOAD_COMPLETED",
11855
+ "INDEXING_PENDING",
11856
+ "INDEXING_FAILED",
11857
+ "INDEXING_COMPLETED"
11909
11858
  ],
11910
- "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."
11859
+ "description": "Status of the file. If the status is \"UPLOAD_PENDING\", the file content has not been uploaded yet. The status will be set to \"UPLOAD_COMPLETED\" once the file content has been uploaded successfully.\n\nIf the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to \"UPLOAD_FAILED\" and the reason for the failure will be available in the `failedStatusReason` field of the file.\n\nHowever, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the \"INDEXING_PENDING\" status (the \"UPLOAD_COMPLETED\" status step will be skipped).\n\nOnce the indexing is completed and the file is ready to be used for searching its status will be set to \"INDEXING_COMPLETED\". If the indexing failed the status will be set to \"INDEXING_FAILED\" and the reason for the failure will be available in the `failedStatusReason` field."
11911
11860
  },
11912
- "uploadFailureReason": {
11861
+ "failedStatusReason": {
11913
11862
  "type": "string",
11914
- "description": "Failure reason of the file upload if the upload status is \"FAILED\"."
11863
+ "description": "If the file status is \"UPLOAD_FAILED\" or \"INDEXING_FAILED\" this will contain the reason of the failure."
11915
11864
  }
11916
11865
  },
11917
11866
  "required": [
@@ -11924,7 +11873,8 @@ export const state = {
11924
11873
  "createdAt",
11925
11874
  "updatedAt",
11926
11875
  "accessPolicies",
11927
- "uploadStatus"
11876
+ "index",
11877
+ "status"
11928
11878
  ],
11929
11879
  "additionalProperties": false
11930
11880
  }
@@ -12191,8 +12141,7 @@ export const state = {
12191
12141
  "createFile",
12192
12142
  "deleteFile",
12193
12143
  "listFiles",
12194
- "getFileMetadata",
12195
- "getFileContent",
12144
+ "getFile",
12196
12145
  "updateFileMetadata",
12197
12146
  "searchFiles"
12198
12147
  ],