@botpress/api 0.23.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.
package/dist/index.js CHANGED
@@ -272140,6 +272140,11 @@ var state = {
272140
272140
  "in": "query",
272141
272141
  "type": "string",
272142
272142
  "description": "Filter by message id"
272143
+ },
272144
+ "status": {
272145
+ "in": "query",
272146
+ "type": "string",
272147
+ "description": "Filter by status. Allowed values: pending, ignored, processed, failed."
272143
272148
  }
272144
272149
  },
272145
272150
  "response": {
@@ -279658,48 +279663,44 @@ var state = {
279658
279663
  "schema": {
279659
279664
  "type": "object",
279660
279665
  "properties": {
279661
- "data": {
279662
- "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".'
279663
279697
  }
279664
279698
  },
279665
279699
  "title": "createFileBody",
279666
- "format": "binary",
279667
279700
  "additionalProperties": false
279668
279701
  }
279669
279702
  },
279670
- "parameters": {
279671
- "x-name": {
279672
- "type": "string",
279673
- "description": "File name",
279674
- "in": "header"
279675
- },
279676
- "x-tags": {
279677
- "type": "string",
279678
- "description": "File tags as URL-encoded JSON string representing an object of key-value pairs.",
279679
- "in": "header"
279680
- },
279681
- "x-access-policies": {
279682
- "type": "string",
279683
- "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.',
279684
- "in": "header"
279685
- },
279686
- "x-index": {
279687
- "type": "boolean",
279688
- "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.',
279689
- "in": "header"
279690
- },
279691
- "Content-Type": {
279692
- "type": "string",
279693
- "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".',
279694
- "in": "header"
279695
- },
279696
- "Content-Length": {
279697
- "type": "string",
279698
- "description": "File content length",
279699
- "in": "header"
279700
- }
279701
- },
279702
- "contentType": "*/*",
279703
+ "contentType": "application/json",
279703
279704
  "section": "files",
279704
279705
  "response": {
279705
279706
  "description": "The file metadata.",
@@ -279724,7 +279725,7 @@ var state = {
279724
279725
  },
279725
279726
  "size": {
279726
279727
  "type": "number",
279727
- "description": "File size in bytes",
279728
+ "description": 'File size in bytes. Non-null if file upload status is "COMPLETE".',
279728
279729
  "nullable": true
279729
279730
  },
279730
279731
  "contentType": {
@@ -279767,6 +279768,23 @@ var state = {
279767
279768
  "indexingFailureReason": {
279768
279769
  "type": "string",
279769
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."
279770
279788
  }
279771
279789
  },
279772
279790
  "required": [
@@ -279778,7 +279796,9 @@ var state = {
279778
279796
  "tags",
279779
279797
  "createdAt",
279780
279798
  "updatedAt",
279781
- "accessPolicies"
279799
+ "accessPolicies",
279800
+ "uploadStatus",
279801
+ "uploadUrl"
279782
279802
  ],
279783
279803
  "additionalProperties": false
279784
279804
  }
@@ -279789,7 +279809,8 @@ var state = {
279789
279809
  "title": "createFileResponse",
279790
279810
  "additionalProperties": false
279791
279811
  }
279792
- }
279812
+ },
279813
+ "parameters": {}
279793
279814
  },
279794
279815
  "deleteFile": {
279795
279816
  "name": "deleteFile",
@@ -279867,7 +279888,7 @@ var state = {
279867
279888
  },
279868
279889
  "size": {
279869
279890
  "type": "number",
279870
- "description": "File size in bytes",
279891
+ "description": 'File size in bytes. Non-null if file upload status is "COMPLETE".',
279871
279892
  "nullable": true
279872
279893
  },
279873
279894
  "contentType": {
@@ -279910,6 +279931,19 @@ var state = {
279910
279931
  "indexingFailureReason": {
279911
279932
  "type": "string",
279912
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".'
279913
279947
  }
279914
279948
  },
279915
279949
  "required": [
@@ -279921,7 +279955,8 @@ var state = {
279921
279955
  "tags",
279922
279956
  "createdAt",
279923
279957
  "updatedAt",
279924
- "accessPolicies"
279958
+ "accessPolicies",
279959
+ "uploadStatus"
279925
279960
  ]
279926
279961
  }
279927
279962
  },
@@ -279981,7 +280016,7 @@ var state = {
279981
280016
  },
279982
280017
  "size": {
279983
280018
  "type": "number",
279984
- "description": "File size in bytes",
280019
+ "description": 'File size in bytes. Non-null if file upload status is "COMPLETE".',
279985
280020
  "nullable": true
279986
280021
  },
279987
280022
  "contentType": {
@@ -280024,6 +280059,19 @@ var state = {
280024
280059
  "indexingFailureReason": {
280025
280060
  "type": "string",
280026
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".'
280027
280075
  }
280028
280076
  },
280029
280077
  "required": [
@@ -280035,7 +280083,8 @@ var state = {
280035
280083
  "tags",
280036
280084
  "createdAt",
280037
280085
  "updatedAt",
280038
- "accessPolicies"
280086
+ "accessPolicies",
280087
+ "uploadStatus"
280039
280088
  ],
280040
280089
  "additionalProperties": false
280041
280090
  }
@@ -281100,7 +281149,7 @@ var state = {
281100
281149
  "title": "Botpress API",
281101
281150
  "description": "API for Botpress Cloud",
281102
281151
  "server": "https://api.botpress.cloud",
281103
- "version": "0.23.0",
281152
+ "version": "0.25.0",
281104
281153
  "prefix": "v1"
281105
281154
  },
281106
281155
  "errors": [
@@ -283428,7 +283477,7 @@ var state = {
283428
283477
  },
283429
283478
  "size": {
283430
283479
  "type": "number",
283431
- "description": "File size in bytes",
283480
+ "description": 'File size in bytes. Non-null if file upload status is "COMPLETE".',
283432
283481
  "nullable": true
283433
283482
  },
283434
283483
  "contentType": {
@@ -283471,6 +283520,19 @@ var state = {
283471
283520
  "indexingFailureReason": {
283472
283521
  "type": "string",
283473
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".'
283474
283536
  }
283475
283537
  },
283476
283538
  "required": [
@@ -283482,7 +283544,8 @@ var state = {
283482
283544
  "tags",
283483
283545
  "createdAt",
283484
283546
  "updatedAt",
283485
- "accessPolicies"
283547
+ "accessPolicies",
283548
+ "uploadStatus"
283486
283549
  ],
283487
283550
  "additionalProperties": false
283488
283551
  }
@@ -552,6 +552,11 @@ export declare const state: {
552
552
  type: "string";
553
553
  description: string;
554
554
  };
555
+ status: {
556
+ in: "query";
557
+ type: "string";
558
+ description: string;
559
+ };
555
560
  };
556
561
  response: {
557
562
  description: string;
@@ -7121,48 +7126,41 @@ export declare const state: {
7121
7126
  schema: {
7122
7127
  type: "object";
7123
7128
  properties: {
7124
- data: {
7125
- 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;
7126
7157
  };
7127
7158
  };
7128
7159
  title: string;
7129
- format: string;
7130
7160
  additionalProperties: false;
7131
7161
  };
7132
7162
  };
7133
- parameters: {
7134
- "x-name": {
7135
- type: "string";
7136
- description: string;
7137
- in: "header";
7138
- };
7139
- "x-tags": {
7140
- type: "string";
7141
- description: string;
7142
- in: "header";
7143
- };
7144
- "x-access-policies": {
7145
- type: "string";
7146
- description: string;
7147
- in: "header";
7148
- };
7149
- "x-index": {
7150
- type: "boolean";
7151
- description: string;
7152
- in: "header";
7153
- };
7154
- "Content-Type": {
7155
- type: "string";
7156
- description: string;
7157
- in: "header";
7158
- };
7159
- "Content-Length": {
7160
- type: "string";
7161
- description: string;
7162
- in: "header";
7163
- };
7164
- };
7165
- contentType: "*/*";
7163
+ contentType: "application/json";
7166
7164
  section: "files";
7167
7165
  response: {
7168
7166
  description: string;
@@ -7226,6 +7224,19 @@ export declare const state: {
7226
7224
  type: "string";
7227
7225
  description: string;
7228
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
+ };
7229
7240
  };
7230
7241
  required: string[];
7231
7242
  additionalProperties: false;
@@ -7236,6 +7247,7 @@ export declare const state: {
7236
7247
  additionalProperties: false;
7237
7248
  };
7238
7249
  };
7250
+ parameters: {};
7239
7251
  };
7240
7252
  deleteFile: {
7241
7253
  name: string;
@@ -7352,6 +7364,15 @@ export declare const state: {
7352
7364
  type: "string";
7353
7365
  description: string;
7354
7366
  };
7367
+ uploadStatus: {
7368
+ type: "string";
7369
+ enum: string[];
7370
+ description: string;
7371
+ };
7372
+ uploadFailureReason: {
7373
+ type: "string";
7374
+ description: string;
7375
+ };
7355
7376
  };
7356
7377
  required: string[];
7357
7378
  };
@@ -7448,6 +7469,15 @@ export declare const state: {
7448
7469
  type: "string";
7449
7470
  description: string;
7450
7471
  };
7472
+ uploadStatus: {
7473
+ type: "string";
7474
+ enum: string[];
7475
+ description: string;
7476
+ };
7477
+ uploadFailureReason: {
7478
+ type: "string";
7479
+ description: string;
7480
+ };
7451
7481
  };
7452
7482
  required: string[];
7453
7483
  additionalProperties: false;
@@ -10378,6 +10408,15 @@ export declare const state: {
10378
10408
  type: "string";
10379
10409
  description: string;
10380
10410
  };
10411
+ uploadStatus: {
10412
+ type: "string";
10413
+ enum: string[];
10414
+ description: string;
10415
+ };
10416
+ uploadFailureReason: {
10417
+ type: "string";
10418
+ description: string;
10419
+ };
10381
10420
  };
10382
10421
  required: string[];
10383
10422
  additionalProperties: false;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@botpress/api",
3
- "version": "0.23.0",
3
+ "version": "0.25.0",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/src/index.d.ts",
6
6
  "scripts": {