@botpress/api 0.26.4 → 0.27.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 (5) hide show
  1. package/dist/index.js +62 -86
  2. package/dist/src/gen/state.d.ts +16 -36
  3. package/package.json +1 -1
  4. package/src/gen/openapi.json +1 -1
  5. package/src/gen/state.ts +62 -86
package/dist/index.js CHANGED
@@ -280846,36 +280846,29 @@ var state = {
280846
280846
  },
280847
280847
  "description": "Access policies configured for the file."
280848
280848
  },
280849
- "indexingStatus": {
280850
- "type": "string",
280851
- "enum": [
280852
- "PENDING",
280853
- "IN_PROGRESS",
280854
- "COMPLETE",
280855
- "FAILED"
280856
- ],
280857
- "description": "Status of the file indexing process. No value will be set if indexing was not enabled for the file when it was created."
280858
- },
280859
- "indexingFailureReason": {
280860
- "type": "string",
280861
- "description": 'Last failure reason of the file indexing if the indexing status is "FAILED".'
280849
+ "index": {
280850
+ "type": "boolean",
280851
+ "description": "Whether the file was requested to be indexed for search or not."
280862
280852
  },
280863
- "uploadStatus": {
280853
+ "status": {
280864
280854
  "type": "string",
280865
280855
  "enum": [
280866
- "PENDING",
280867
- "COMPLETE",
280868
- "FAILED"
280856
+ "UPLOAD_PENDING",
280857
+ "UPLOAD_FAILED",
280858
+ "UPLOAD_COMPLETED",
280859
+ "INDEXING_PENDING",
280860
+ "INDEXING_FAILED",
280861
+ "INDEXING_COMPLETED"
280869
280862
  ],
280870
- "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.'
280863
+ "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.'
280871
280864
  },
280872
- "uploadFailureReason": {
280865
+ "failedStatusReason": {
280873
280866
  "type": "string",
280874
- "description": 'Failure reason of the file upload if the upload status is "FAILED".'
280867
+ "description": 'If the file status is "UPLOAD_FAILED" or "INDEXING_FAILED" this will contain the reason of the failure.'
280875
280868
  },
280876
280869
  "uploadUrl": {
280877
280870
  "type": "string",
280878
- "description": "URL to upload the file content. File content needs to be sent to this URL via a POST request."
280871
+ "description": "URL to upload the file content. File content needs to be sent to this URL via a PUT request."
280879
280872
  }
280880
280873
  },
280881
280874
  "required": [
@@ -280888,7 +280881,8 @@ var state = {
280888
280881
  "createdAt",
280889
280882
  "updatedAt",
280890
280883
  "accessPolicies",
280891
- "uploadStatus",
280884
+ "index",
280885
+ "status",
280892
280886
  "uploadUrl"
280893
280887
  ],
280894
280888
  "additionalProperties": false
@@ -281009,32 +281003,25 @@ var state = {
281009
281003
  },
281010
281004
  "description": "Access policies configured for the file."
281011
281005
  },
281012
- "indexingStatus": {
281013
- "type": "string",
281014
- "enum": [
281015
- "PENDING",
281016
- "IN_PROGRESS",
281017
- "COMPLETE",
281018
- "FAILED"
281019
- ],
281020
- "description": "Status of the file indexing process. No value will be set if indexing was not enabled for the file when it was created."
281021
- },
281022
- "indexingFailureReason": {
281023
- "type": "string",
281024
- "description": 'Last failure reason of the file indexing if the indexing status is "FAILED".'
281006
+ "index": {
281007
+ "type": "boolean",
281008
+ "description": "Whether the file was requested to be indexed for search or not."
281025
281009
  },
281026
- "uploadStatus": {
281010
+ "status": {
281027
281011
  "type": "string",
281028
281012
  "enum": [
281029
- "PENDING",
281030
- "COMPLETE",
281031
- "FAILED"
281013
+ "UPLOAD_PENDING",
281014
+ "UPLOAD_FAILED",
281015
+ "UPLOAD_COMPLETED",
281016
+ "INDEXING_PENDING",
281017
+ "INDEXING_FAILED",
281018
+ "INDEXING_COMPLETED"
281032
281019
  ],
281033
- "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.'
281020
+ "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.'
281034
281021
  },
281035
- "uploadFailureReason": {
281022
+ "failedStatusReason": {
281036
281023
  "type": "string",
281037
- "description": 'Failure reason of the file upload if the upload status is "FAILED".'
281024
+ "description": 'If the file status is "UPLOAD_FAILED" or "INDEXING_FAILED" this will contain the reason of the failure.'
281038
281025
  }
281039
281026
  },
281040
281027
  "required": [
@@ -281047,7 +281034,8 @@ var state = {
281047
281034
  "createdAt",
281048
281035
  "updatedAt",
281049
281036
  "accessPolicies",
281050
- "uploadStatus"
281037
+ "index",
281038
+ "status"
281051
281039
  ]
281052
281040
  }
281053
281041
  },
@@ -281137,32 +281125,25 @@ var state = {
281137
281125
  },
281138
281126
  "description": "Access policies configured for the file."
281139
281127
  },
281140
- "indexingStatus": {
281141
- "type": "string",
281142
- "enum": [
281143
- "PENDING",
281144
- "IN_PROGRESS",
281145
- "COMPLETE",
281146
- "FAILED"
281147
- ],
281148
- "description": "Status of the file indexing process. No value will be set if indexing was not enabled for the file when it was created."
281149
- },
281150
- "indexingFailureReason": {
281151
- "type": "string",
281152
- "description": 'Last failure reason of the file indexing if the indexing status is "FAILED".'
281128
+ "index": {
281129
+ "type": "boolean",
281130
+ "description": "Whether the file was requested to be indexed for search or not."
281153
281131
  },
281154
- "uploadStatus": {
281132
+ "status": {
281155
281133
  "type": "string",
281156
281134
  "enum": [
281157
- "PENDING",
281158
- "COMPLETE",
281159
- "FAILED"
281135
+ "UPLOAD_PENDING",
281136
+ "UPLOAD_FAILED",
281137
+ "UPLOAD_COMPLETED",
281138
+ "INDEXING_PENDING",
281139
+ "INDEXING_FAILED",
281140
+ "INDEXING_COMPLETED"
281160
281141
  ],
281161
- "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.'
281142
+ "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.'
281162
281143
  },
281163
- "uploadFailureReason": {
281144
+ "failedStatusReason": {
281164
281145
  "type": "string",
281165
- "description": 'Failure reason of the file upload if the upload status is "FAILED".'
281146
+ "description": 'If the file status is "UPLOAD_FAILED" or "INDEXING_FAILED" this will contain the reason of the failure.'
281166
281147
  }
281167
281148
  },
281168
281149
  "required": [
@@ -281175,7 +281156,8 @@ var state = {
281175
281156
  "createdAt",
281176
281157
  "updatedAt",
281177
281158
  "accessPolicies",
281178
- "uploadStatus"
281159
+ "index",
281160
+ "status"
281179
281161
  ],
281180
281162
  "additionalProperties": false
281181
281163
  }
@@ -282248,7 +282230,7 @@ var state = {
282248
282230
  "title": "Botpress API",
282249
282231
  "description": "API for Botpress Cloud",
282250
282232
  "server": "https://api.botpress.cloud",
282251
- "version": "0.26.4",
282233
+ "version": "0.27.0",
282252
282234
  "prefix": "v1"
282253
282235
  },
282254
282236
  "errors": [
@@ -284610,32 +284592,25 @@ var state = {
284610
284592
  },
284611
284593
  "description": "Access policies configured for the file."
284612
284594
  },
284613
- "indexingStatus": {
284614
- "type": "string",
284615
- "enum": [
284616
- "PENDING",
284617
- "IN_PROGRESS",
284618
- "COMPLETE",
284619
- "FAILED"
284620
- ],
284621
- "description": "Status of the file indexing process. No value will be set if indexing was not enabled for the file when it was created."
284622
- },
284623
- "indexingFailureReason": {
284624
- "type": "string",
284625
- "description": 'Last failure reason of the file indexing if the indexing status is "FAILED".'
284595
+ "index": {
284596
+ "type": "boolean",
284597
+ "description": "Whether the file was requested to be indexed for search or not."
284626
284598
  },
284627
- "uploadStatus": {
284599
+ "status": {
284628
284600
  "type": "string",
284629
284601
  "enum": [
284630
- "PENDING",
284631
- "COMPLETE",
284632
- "FAILED"
284602
+ "UPLOAD_PENDING",
284603
+ "UPLOAD_FAILED",
284604
+ "UPLOAD_COMPLETED",
284605
+ "INDEXING_PENDING",
284606
+ "INDEXING_FAILED",
284607
+ "INDEXING_COMPLETED"
284633
284608
  ],
284634
- "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.'
284609
+ "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.'
284635
284610
  },
284636
- "uploadFailureReason": {
284611
+ "failedStatusReason": {
284637
284612
  "type": "string",
284638
- "description": 'Failure reason of the file upload if the upload status is "FAILED".'
284613
+ "description": 'If the file status is "UPLOAD_FAILED" or "INDEXING_FAILED" this will contain the reason of the failure.'
284639
284614
  }
284640
284615
  },
284641
284616
  "required": [
@@ -284648,7 +284623,8 @@ var state = {
284648
284623
  "createdAt",
284649
284624
  "updatedAt",
284650
284625
  "accessPolicies",
284651
- "uploadStatus"
284626
+ "index",
284627
+ "status"
284652
284628
  ],
284653
284629
  "additionalProperties": false
284654
284630
  }
package/dist/src/gen/state.d.ts CHANGED
@@ -7158,21 +7158,16 @@ export declare const state: {
7158
7158
  };
7159
7159
  description: string;
7160
7160
  };
7161
- indexingStatus: {
7162
- type: "string";
7163
- enum: string[];
7164
- description: string;
7165
- };
7166
- indexingFailureReason: {
7167
- type: "string";
7161
+ index: {
7162
+ type: "boolean";
7168
7163
  description: string;
7169
7164
  };
7170
- uploadStatus: {
7165
+ status: {
7171
7166
  type: "string";
7172
7167
  enum: string[];
7173
7168
  description: string;
7174
7169
  };
7175
- uploadFailureReason: {
7170
+ failedStatusReason: {
7176
7171
  type: "string";
7177
7172
  description: string;
7178
7173
  };
@@ -7298,21 +7293,16 @@ export declare const state: {
7298
7293
  };
7299
7294
  description: string;
7300
7295
  };
7301
- indexingStatus: {
7302
- type: "string";
7303
- enum: string[];
7304
- description: string;
7305
- };
7306
- indexingFailureReason: {
7307
- type: "string";
7296
+ index: {
7297
+ type: "boolean";
7308
7298
  description: string;
7309
7299
  };
7310
- uploadStatus: {
7300
+ status: {
7311
7301
  type: "string";
7312
7302
  enum: string[];
7313
7303
  description: string;
7314
7304
  };
7315
- uploadFailureReason: {
7305
+ failedStatusReason: {
7316
7306
  type: "string";
7317
7307
  description: string;
7318
7308
  };
@@ -7403,21 +7393,16 @@ export declare const state: {
7403
7393
  };
7404
7394
  description: string;
7405
7395
  };
7406
- indexingStatus: {
7407
- type: "string";
7408
- enum: string[];
7409
- description: string;
7410
- };
7411
- indexingFailureReason: {
7412
- type: "string";
7396
+ index: {
7397
+ type: "boolean";
7413
7398
  description: string;
7414
7399
  };
7415
- uploadStatus: {
7400
+ status: {
7416
7401
  type: "string";
7417
7402
  enum: string[];
7418
7403
  description: string;
7419
7404
  };
7420
- uploadFailureReason: {
7405
+ failedStatusReason: {
7421
7406
  type: "string";
7422
7407
  description: string;
7423
7408
  };
@@ -10353,21 +10338,16 @@ export declare const state: {
10353
10338
  };
10354
10339
  description: string;
10355
10340
  };
10356
- indexingStatus: {
10357
- type: "string";
10358
- enum: string[];
10359
- description: string;
10360
- };
10361
- indexingFailureReason: {
10362
- type: "string";
10341
+ index: {
10342
+ type: "boolean";
10363
10343
  description: string;
10364
10344
  };
10365
- uploadStatus: {
10345
+ status: {
10366
10346
  type: "string";
10367
10347
  enum: string[];
10368
10348
  description: string;
10369
10349
  };
10370
- uploadFailureReason: {
10350
+ failedStatusReason: {
10371
10351
  type: "string";
10372
10352
  description: string;
10373
10353
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@botpress/api",
3
- "version": "0.26.4",
3
+ "version": "0.27.0",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/src/index.d.ts",
6
6
  "scripts": {