@botpress/api 0.24.0 → 0.25.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 +104 -46
  2. package/dist/src/gen/state.d.ts +70 -36
  3. package/package.json +1 -1
  4. package/src/gen/openapi.json +1 -1
  5. package/src/gen/state.ts +104 -46
package/dist/index.js CHANGED
@@ -279663,48 +279663,44 @@ var state = {
279663
279663
  "schema": {
279664
279664
  "type": "object",
279665
279665
  "properties": {
279666
- "data": {
279667
- "nullable": true
279666
+ "name": {
279667
+ "type": "string",
279668
+ "description": "File name"
279669
+ },
279670
+ "tags": {
279671
+ "type": "object",
279672
+ "additionalProperties": {
279673
+ "type": "string",
279674
+ "maxLength": 1e3
279675
+ },
279676
+ "description": "File tags as an object of key/value pairs"
279677
+ },
279678
+ "index": {
279679
+ "default": false,
279680
+ "type": "boolean",
279681
+ "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."
279682
+ },
279683
+ "accessPolicies": {
279684
+ "type": "array",
279685
+ "items": {
279686
+ "type": "string",
279687
+ "enum": [
279688
+ "public_content",
279689
+ "integrations"
279690
+ ]
279691
+ },
279692
+ "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.'
279693
+ },
279694
+ "contentType": {
279695
+ "type": "string",
279696
+ "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".'
279668
279697
  }
279669
279698
  },
279670
279699
  "title": "createFileBody",
279671
- "format": "binary",
279672
279700
  "additionalProperties": false
279673
279701
  }
279674
279702
  },
279675
- "parameters": {
279676
- "x-name": {
279677
- "type": "string",
279678
- "description": "File name",
279679
- "in": "header"
279680
- },
279681
- "x-tags": {
279682
- "type": "string",
279683
- "description": "File tags as URL-encoded JSON string representing an object of key-value pairs.",
279684
- "in": "header"
279685
- },
279686
- "x-access-policies": {
279687
- "type": "string",
279688
- "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.',
279689
- "in": "header"
279690
- },
279691
- "x-index": {
279692
- "type": "boolean",
279693
- "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.',
279694
- "in": "header"
279695
- },
279696
- "Content-Type": {
279697
- "type": "string",
279698
- "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".',
279699
- "in": "header"
279700
- },
279701
- "Content-Length": {
279702
- "type": "string",
279703
- "description": "File content length",
279704
- "in": "header"
279705
- }
279706
- },
279707
- "contentType": "*/*",
279703
+ "contentType": "application/json",
279708
279704
  "section": "files",
279709
279705
  "response": {
279710
279706
  "description": "The file metadata.",
@@ -279729,7 +279725,7 @@ var state = {
279729
279725
  },
279730
279726
  "size": {
279731
279727
  "type": "number",
279732
- "description": "File size in bytes",
279728
+ "description": 'File size in bytes. Non-null if file upload status is "COMPLETE".',
279733
279729
  "nullable": true
279734
279730
  },
279735
279731
  "contentType": {
@@ -279772,6 +279768,23 @@ var state = {
279772
279768
  "indexingFailureReason": {
279773
279769
  "type": "string",
279774
279770
  "description": 'Last failure reason of the file indexing if the indexing status is "FAILED".'
279771
+ },
279772
+ "uploadStatus": {
279773
+ "type": "string",
279774
+ "enum": [
279775
+ "PENDING",
279776
+ "COMPLETE",
279777
+ "FAILED"
279778
+ ],
279779
+ "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.'
279780
+ },
279781
+ "uploadFailureReason": {
279782
+ "type": "string",
279783
+ "description": 'Failure reason of the file upload if the upload status is "FAILED".'
279784
+ },
279785
+ "uploadUrl": {
279786
+ "type": "string",
279787
+ "description": "URL to upload the file content. File content needs to be sent to this URL via a POST request."
279775
279788
  }
279776
279789
  },
279777
279790
  "required": [
@@ -279783,7 +279796,9 @@ var state = {
279783
279796
  "tags",
279784
279797
  "createdAt",
279785
279798
  "updatedAt",
279786
- "accessPolicies"
279799
+ "accessPolicies",
279800
+ "uploadStatus",
279801
+ "uploadUrl"
279787
279802
  ],
279788
279803
  "additionalProperties": false
279789
279804
  }
@@ -279794,7 +279809,8 @@ var state = {
279794
279809
  "title": "createFileResponse",
279795
279810
  "additionalProperties": false
279796
279811
  }
279797
- }
279812
+ },
279813
+ "parameters": {}
279798
279814
  },
279799
279815
  "deleteFile": {
279800
279816
  "name": "deleteFile",
@@ -279872,7 +279888,7 @@ var state = {
279872
279888
  },
279873
279889
  "size": {
279874
279890
  "type": "number",
279875
- "description": "File size in bytes",
279891
+ "description": 'File size in bytes. Non-null if file upload status is "COMPLETE".',
279876
279892
  "nullable": true
279877
279893
  },
279878
279894
  "contentType": {
@@ -279915,6 +279931,19 @@ var state = {
279915
279931
  "indexingFailureReason": {
279916
279932
  "type": "string",
279917
279933
  "description": 'Last failure reason of the file indexing if the indexing status is "FAILED".'
279934
+ },
279935
+ "uploadStatus": {
279936
+ "type": "string",
279937
+ "enum": [
279938
+ "PENDING",
279939
+ "COMPLETE",
279940
+ "FAILED"
279941
+ ],
279942
+ "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.'
279943
+ },
279944
+ "uploadFailureReason": {
279945
+ "type": "string",
279946
+ "description": 'Failure reason of the file upload if the upload status is "FAILED".'
279918
279947
  }
279919
279948
  },
279920
279949
  "required": [
@@ -279926,7 +279955,8 @@ var state = {
279926
279955
  "tags",
279927
279956
  "createdAt",
279928
279957
  "updatedAt",
279929
- "accessPolicies"
279958
+ "accessPolicies",
279959
+ "uploadStatus"
279930
279960
  ]
279931
279961
  }
279932
279962
  },
@@ -279986,7 +280016,7 @@ var state = {
279986
280016
  },
279987
280017
  "size": {
279988
280018
  "type": "number",
279989
- "description": "File size in bytes",
280019
+ "description": 'File size in bytes. Non-null if file upload status is "COMPLETE".',
279990
280020
  "nullable": true
279991
280021
  },
279992
280022
  "contentType": {
@@ -280029,6 +280059,19 @@ var state = {
280029
280059
  "indexingFailureReason": {
280030
280060
  "type": "string",
280031
280061
  "description": 'Last failure reason of the file indexing if the indexing status is "FAILED".'
280062
+ },
280063
+ "uploadStatus": {
280064
+ "type": "string",
280065
+ "enum": [
280066
+ "PENDING",
280067
+ "COMPLETE",
280068
+ "FAILED"
280069
+ ],
280070
+ "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.'
280071
+ },
280072
+ "uploadFailureReason": {
280073
+ "type": "string",
280074
+ "description": 'Failure reason of the file upload if the upload status is "FAILED".'
280032
280075
  }
280033
280076
  },
280034
280077
  "required": [
@@ -280040,7 +280083,8 @@ var state = {
280040
280083
  "tags",
280041
280084
  "createdAt",
280042
280085
  "updatedAt",
280043
- "accessPolicies"
280086
+ "accessPolicies",
280087
+ "uploadStatus"
280044
280088
  ],
280045
280089
  "additionalProperties": false
280046
280090
  }
@@ -281105,7 +281149,7 @@ var state = {
281105
281149
  "title": "Botpress API",
281106
281150
  "description": "API for Botpress Cloud",
281107
281151
  "server": "https://api.botpress.cloud",
281108
- "version": "0.24.0",
281152
+ "version": "0.25.0",
281109
281153
  "prefix": "v1"
281110
281154
  },
281111
281155
  "errors": [
@@ -283433,7 +283477,7 @@ var state = {
283433
283477
  },
283434
283478
  "size": {
283435
283479
  "type": "number",
283436
- "description": "File size in bytes",
283480
+ "description": 'File size in bytes. Non-null if file upload status is "COMPLETE".',
283437
283481
  "nullable": true
283438
283482
  },
283439
283483
  "contentType": {
@@ -283476,6 +283520,19 @@ var state = {
283476
283520
  "indexingFailureReason": {
283477
283521
  "type": "string",
283478
283522
  "description": 'Last failure reason of the file indexing if the indexing status is "FAILED".'
283523
+ },
283524
+ "uploadStatus": {
283525
+ "type": "string",
283526
+ "enum": [
283527
+ "PENDING",
283528
+ "COMPLETE",
283529
+ "FAILED"
283530
+ ],
283531
+ "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.'
283532
+ },
283533
+ "uploadFailureReason": {
283534
+ "type": "string",
283535
+ "description": 'Failure reason of the file upload if the upload status is "FAILED".'
283479
283536
  }
283480
283537
  },
283481
283538
  "required": [
@@ -283487,7 +283544,8 @@ var state = {
283487
283544
  "tags",
283488
283545
  "createdAt",
283489
283546
  "updatedAt",
283490
- "accessPolicies"
283547
+ "accessPolicies",
283548
+ "uploadStatus"
283491
283549
  ],
283492
283550
  "additionalProperties": false
283493
283551
  }
package/dist/src/gen/state.d.ts CHANGED
@@ -7126,48 +7126,41 @@ export declare const state: {
7126
7126
  schema: {
7127
7127
  type: "object";
7128
7128
  properties: {
7129
- data: {
7130
- nullable: true;
7129
+ name: {
7130
+ type: "string";
7131
+ description: string;
7132
+ };
7133
+ tags: {
7134
+ type: "object";
7135
+ additionalProperties: {
7136
+ type: "string";
7137
+ maxLength: number;
7138
+ };
7139
+ description: string;
7140
+ };
7141
+ index: {
7142
+ default: boolean;
7143
+ type: "boolean";
7144
+ description: string;
7145
+ };
7146
+ accessPolicies: {
7147
+ type: "array";
7148
+ items: {
7149
+ type: "string";
7150
+ enum: string[];
7151
+ };
7152
+ description: string;
7153
+ };
7154
+ contentType: {
7155
+ type: "string";
7156
+ description: string;
7131
7157
  };
7132
7158
  };
7133
7159
  title: string;
7134
- format: string;
7135
7160
  additionalProperties: false;
7136
7161
  };
7137
7162
  };
7138
- parameters: {
7139
- "x-name": {
7140
- type: "string";
7141
- description: string;
7142
- in: "header";
7143
- };
7144
- "x-tags": {
7145
- type: "string";
7146
- description: string;
7147
- in: "header";
7148
- };
7149
- "x-access-policies": {
7150
- type: "string";
7151
- description: string;
7152
- in: "header";
7153
- };
7154
- "x-index": {
7155
- type: "boolean";
7156
- description: string;
7157
- in: "header";
7158
- };
7159
- "Content-Type": {
7160
- type: "string";
7161
- description: string;
7162
- in: "header";
7163
- };
7164
- "Content-Length": {
7165
- type: "string";
7166
- description: string;
7167
- in: "header";
7168
- };
7169
- };
7170
- contentType: "*/*";
7163
+ contentType: "application/json";
7171
7164
  section: "files";
7172
7165
  response: {
7173
7166
  description: string;
@@ -7231,6 +7224,19 @@ export declare const state: {
7231
7224
  type: "string";
7232
7225
  description: string;
7233
7226
  };
7227
+ uploadStatus: {
7228
+ type: "string";
7229
+ enum: string[];
7230
+ description: string;
7231
+ };
7232
+ uploadFailureReason: {
7233
+ type: "string";
7234
+ description: string;
7235
+ };
7236
+ uploadUrl: {
7237
+ type: "string";
7238
+ description: string;
7239
+ };
7234
7240
  };
7235
7241
  required: string[];
7236
7242
  additionalProperties: false;
@@ -7241,6 +7247,7 @@ export declare const state: {
7241
7247
  additionalProperties: false;
7242
7248
  };
7243
7249
  };
7250
+ parameters: {};
7244
7251
  };
7245
7252
  deleteFile: {
7246
7253
  name: string;
@@ -7357,6 +7364,15 @@ export declare const state: {
7357
7364
  type: "string";
7358
7365
  description: string;
7359
7366
  };
7367
+ uploadStatus: {
7368
+ type: "string";
7369
+ enum: string[];
7370
+ description: string;
7371
+ };
7372
+ uploadFailureReason: {
7373
+ type: "string";
7374
+ description: string;
7375
+ };
7360
7376
  };
7361
7377
  required: string[];
7362
7378
  };
@@ -7453,6 +7469,15 @@ export declare const state: {
7453
7469
  type: "string";
7454
7470
  description: string;
7455
7471
  };
7472
+ uploadStatus: {
7473
+ type: "string";
7474
+ enum: string[];
7475
+ description: string;
7476
+ };
7477
+ uploadFailureReason: {
7478
+ type: "string";
7479
+ description: string;
7480
+ };
7456
7481
  };
7457
7482
  required: string[];
7458
7483
  additionalProperties: false;
@@ -10383,6 +10408,15 @@ export declare const state: {
10383
10408
  type: "string";
10384
10409
  description: string;
10385
10410
  };
10411
+ uploadStatus: {
10412
+ type: "string";
10413
+ enum: string[];
10414
+ description: string;
10415
+ };
10416
+ uploadFailureReason: {
10417
+ type: "string";
10418
+ description: string;
10419
+ };
10386
10420
  };
10387
10421
  required: string[];
10388
10422
  additionalProperties: false;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@botpress/api",
3
- "version": "0.24.0",
3
+ "version": "0.25.0",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/src/index.d.ts",
6
6
  "scripts": {