@epilot/file-client 1.20.1 → 1.22.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/openapi.d.ts CHANGED
@@ -25,6 +25,7 @@ declare namespace Components {
25
25
  Schemas.EntityId;
26
26
  export type FillActivityQueryParam = boolean;
27
27
  export type StrictQueryParam = boolean;
28
+ export type VersionOnlyQueryParam = boolean;
28
29
  }
29
30
  export interface PathParameters {
30
31
  EntityIdPathParam?: Parameters.EntityIdPathParam;
@@ -35,14 +36,81 @@ declare namespace Components {
35
36
  FillActivityQueryParam?: Parameters.FillActivityQueryParam;
36
37
  AsyncOperationQueryParam?: Parameters.AsyncOperationQueryParam;
37
38
  DeleteTempFileQueryParam?: Parameters.DeleteTempFileQueryParam;
39
+ VersionOnlyQueryParam?: Parameters.VersionOnlyQueryParam;
38
40
  }
39
41
  namespace Responses {
42
+ /**
43
+ * A generic error returned by the API
44
+ * example:
45
+ * {
46
+ * "status": 400,
47
+ * "error": "Bad Request: filename is required"
48
+ * }
49
+ */
50
+ export interface BadRequestError {
51
+ /**
52
+ * The HTTP status code of the error
53
+ * example:
54
+ * 400
55
+ */
56
+ status?: number;
57
+ /**
58
+ * The error message
59
+ * example:
60
+ * Bad Request
61
+ */
62
+ error?: string;
63
+ }
64
+ /**
65
+ * A generic error returned by the API
66
+ * example:
67
+ * {
68
+ * "status": 403,
69
+ * "error": "Forbidden: You do not have permission to access this file"
70
+ * }
71
+ */
72
+ export interface ForbiddenError {
73
+ /**
74
+ * The HTTP status code of the error
75
+ * example:
76
+ * 400
77
+ */
78
+ status?: number;
79
+ /**
80
+ * The error message
81
+ * example:
82
+ * Bad Request
83
+ */
84
+ error?: string;
85
+ }
86
+ /**
87
+ * A generic error returned by the API
88
+ * example:
89
+ * {
90
+ * "status": 500,
91
+ * "error": "Internal Server Error"
92
+ * }
93
+ */
94
+ export interface InternalServerError {
95
+ /**
96
+ * The HTTP status code of the error
97
+ * example:
98
+ * 400
99
+ */
100
+ status?: number;
101
+ /**
102
+ * The error message
103
+ * example:
104
+ * Bad Request
105
+ */
106
+ error?: string;
107
+ }
40
108
  /**
41
109
  * A generic error returned by the API
42
110
  * example:
43
111
  * {
44
112
  * "status": 404,
45
- * "error": "Not Found"
113
+ * "error": "Not Found: File entity not found"
46
114
  * }
47
115
  */
48
116
  export interface NotFoundError {
@@ -59,6 +127,28 @@ declare namespace Components {
59
127
  */
60
128
  error?: string;
61
129
  }
130
+ /**
131
+ * A generic error returned by the API
132
+ * example:
133
+ * {
134
+ * "status": 401,
135
+ * "error": "Unauthorized: Invalid or expired token"
136
+ * }
137
+ */
138
+ export interface UnauthorizedError {
139
+ /**
140
+ * The HTTP status code of the error
141
+ * example:
142
+ * 400
143
+ */
144
+ status?: number;
145
+ /**
146
+ * The error message
147
+ * example:
148
+ * Bad Request
149
+ */
150
+ error?: string;
151
+ }
62
152
  }
63
153
  namespace Schemas {
64
154
  /**
@@ -234,6 +324,14 @@ declare namespace Components {
234
324
  * Whether the collection is starred / favorited
235
325
  */
236
326
  starred?: boolean;
327
+ /**
328
+ * List of location slugs where the collection is enabled. If empty, enabled for all.
329
+ */
330
+ enabled_locations?: string[];
331
+ /**
332
+ * List of purpose IDs where the collection is enabled. If empty, enabled for all.
333
+ */
334
+ enabled_purposes?: string[];
237
335
  }
238
336
  /**
239
337
  * Request body for creating a file collection
@@ -251,6 +349,14 @@ declare namespace Components {
251
349
  * Whether the collection is starred / favorited
252
350
  */
253
351
  starred?: boolean;
352
+ /**
353
+ * List of location slugs where the collection is enabled. If empty, enabled for all.
354
+ */
355
+ enabled_locations?: string[];
356
+ /**
357
+ * List of purpose IDs where the collection is enabled. If empty, enabled for all.
358
+ */
359
+ enabled_purposes?: string[];
254
360
  }
255
361
  /**
256
362
  * Generated uuid for a file collection
@@ -303,15 +409,19 @@ declare namespace Components {
303
409
  * 0
304
410
  */
305
411
  order?: number;
412
+ /**
413
+ * List of location slugs where the collection is enabled. If empty, enabled for all.
414
+ */
415
+ enabled_locations?: string[];
306
416
  /**
307
417
  * List of purpose slugs where the collection is enabled. If empty, enabled for all.
308
418
  * example:
309
419
  * [
310
- * "purpose:9eefcb98-93cf-4c5b-a040-f1d26d57c177",
311
- * "purpose:5c544c09-a691-43ed-a7fa-0a8b44b5b161"
420
+ * "9eefcb98-93cf-4c5b-a040-f1d26d57c177",
421
+ * "5c544c09-a691-43ed-a7fa-0a8b44b5b161"
312
422
  * ]
313
423
  */
314
- enabled_locations?: string[];
424
+ enabled_purposes?: string[];
315
425
  /**
316
426
  * Timestamp when the collection was created
317
427
  * example:
@@ -804,63 +914,69 @@ declare namespace Components {
804
914
  declare namespace Paths {
805
915
  namespace AccessPublicLink {
806
916
  namespace Parameters {
807
- /**
808
- * Name of the file
809
- * example:
810
- * invoice-2023-12.pdf
811
- */
812
917
  export type Filename = string;
813
- /**
814
- * An optional cache-busting hash for the file
815
- */
816
918
  export type Hash = string;
817
- /**
818
- * Id of the publicly generated link
819
- * example:
820
- * 13d22918-36bd-4227-9ad4-2cb978788c8d
821
- */
822
919
  export type Id = string;
823
920
  }
824
921
  export interface PathParameters {
825
- id: /**
826
- * Id of the publicly generated link
827
- * example:
828
- * 13d22918-36bd-4227-9ad4-2cb978788c8d
829
- */
830
- Parameters.Id;
831
- filename: /**
832
- * Name of the file
833
- * example:
834
- * invoice-2023-12.pdf
835
- */
836
- Parameters.Filename;
922
+ id: Parameters.Id;
923
+ filename: Parameters.Filename;
837
924
  }
838
925
  export interface QueryParameters {
839
- hash?: /* An optional cache-busting hash for the file */ Parameters.Hash;
926
+ hash?: Parameters.Hash;
840
927
  }
841
928
  namespace Responses {
842
929
  export interface $302 {
843
930
  }
931
+ export type $404 = /* A generic error returned by the API */ Components.Schemas.ErrorObject;
932
+ export type $500 = /**
933
+ * A generic error returned by the API
934
+ * example:
935
+ * {
936
+ * "status": 500,
937
+ * "error": "Internal Server Error"
938
+ * }
939
+ */
940
+ Components.Responses.InternalServerError;
844
941
  }
845
942
  }
846
943
  namespace CreateUserSchemaFileCollection {
847
944
  namespace Parameters {
848
- /**
849
- * example:
850
- * opportunity
851
- */
852
945
  export type Slug = string;
853
946
  }
854
947
  export interface PathParameters {
855
- slug: /**
856
- * example:
857
- * opportunity
858
- */
859
- Parameters.Slug;
948
+ slug: Parameters.Slug;
860
949
  }
861
950
  export type RequestBody = /* Request body for creating a file collection */ Components.Schemas.FileCollectionCreateRequest;
862
951
  namespace Responses {
863
952
  export type $201 = /* A file collection with identifiers and timestamps */ Components.Schemas.FileCollectionItem;
953
+ export type $400 = /**
954
+ * A generic error returned by the API
955
+ * example:
956
+ * {
957
+ * "status": 400,
958
+ * "error": "Bad Request: filename is required"
959
+ * }
960
+ */
961
+ Components.Responses.BadRequestError;
962
+ export type $401 = /**
963
+ * A generic error returned by the API
964
+ * example:
965
+ * {
966
+ * "status": 401,
967
+ * "error": "Unauthorized: Invalid or expired token"
968
+ * }
969
+ */
970
+ Components.Responses.UnauthorizedError;
971
+ export type $500 = /**
972
+ * A generic error returned by the API
973
+ * example:
974
+ * {
975
+ * "status": 500,
976
+ * "error": "Internal Server Error"
977
+ * }
978
+ */
979
+ Components.Responses.InternalServerError;
864
980
  }
865
981
  }
866
982
  namespace DeleteFile {
@@ -892,6 +1008,42 @@ declare namespace Paths {
892
1008
  }
893
1009
  namespace Responses {
894
1010
  export type $200 = Components.Schemas.FileEntity;
1011
+ export type $401 = /**
1012
+ * A generic error returned by the API
1013
+ * example:
1014
+ * {
1015
+ * "status": 401,
1016
+ * "error": "Unauthorized: Invalid or expired token"
1017
+ * }
1018
+ */
1019
+ Components.Responses.UnauthorizedError;
1020
+ export type $403 = /**
1021
+ * A generic error returned by the API
1022
+ * example:
1023
+ * {
1024
+ * "status": 403,
1025
+ * "error": "Forbidden: You do not have permission to access this file"
1026
+ * }
1027
+ */
1028
+ Components.Responses.ForbiddenError;
1029
+ export type $404 = /**
1030
+ * A generic error returned by the API
1031
+ * example:
1032
+ * {
1033
+ * "status": 404,
1034
+ * "error": "Not Found: File entity not found"
1035
+ * }
1036
+ */
1037
+ Components.Responses.NotFoundError;
1038
+ export type $500 = /**
1039
+ * A generic error returned by the API
1040
+ * example:
1041
+ * {
1042
+ * "status": 500,
1043
+ * "error": "Internal Server Error"
1044
+ * }
1045
+ */
1046
+ Components.Responses.InternalServerError;
895
1047
  }
896
1048
  }
897
1049
  namespace DeleteSession {
@@ -902,41 +1054,43 @@ declare namespace Paths {
902
1054
  }
903
1055
  namespace DeleteUserSchemaFileCollection {
904
1056
  namespace Parameters {
905
- /**
906
- * example:
907
- * documents
908
- */
909
1057
  export type CollectionSlug = string;
910
- /**
911
- * example:
912
- * opportunity
913
- */
914
1058
  export type Slug = string;
915
1059
  }
916
1060
  export interface PathParameters {
917
- slug: /**
918
- * example:
919
- * opportunity
920
- */
921
- Parameters.Slug;
922
- collectionSlug: /**
923
- * example:
924
- * documents
925
- */
926
- Parameters.CollectionSlug;
1061
+ slug: Parameters.Slug;
1062
+ collectionSlug: Parameters.CollectionSlug;
927
1063
  }
928
1064
  namespace Responses {
929
1065
  export interface $200 {
930
1066
  }
1067
+ export type $401 = /**
1068
+ * A generic error returned by the API
1069
+ * example:
1070
+ * {
1071
+ * "status": 401,
1072
+ * "error": "Unauthorized: Invalid or expired token"
1073
+ * }
1074
+ */
1075
+ Components.Responses.UnauthorizedError;
931
1076
  export type $404 = /**
932
1077
  * A generic error returned by the API
933
1078
  * example:
934
1079
  * {
935
1080
  * "status": 404,
936
- * "error": "Not Found"
1081
+ * "error": "Not Found: File entity not found"
937
1082
  * }
938
1083
  */
939
1084
  Components.Responses.NotFoundError;
1085
+ export type $500 = /**
1086
+ * A generic error returned by the API
1087
+ * example:
1088
+ * {
1089
+ * "status": 500,
1090
+ * "error": "Internal Server Error"
1091
+ * }
1092
+ */
1093
+ Components.Responses.InternalServerError;
940
1094
  }
941
1095
  }
942
1096
  namespace DownloadFile {
@@ -959,11 +1113,48 @@ declare namespace Paths {
959
1113
  namespace Responses {
960
1114
  export interface $200 {
961
1115
  /**
1116
+ * Pre-signed S3 URL valid for downloading the file
962
1117
  * example:
963
1118
  * https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
964
1119
  */
965
1120
  download_url?: string; // uri
966
1121
  }
1122
+ export type $401 = /**
1123
+ * A generic error returned by the API
1124
+ * example:
1125
+ * {
1126
+ * "status": 401,
1127
+ * "error": "Unauthorized: Invalid or expired token"
1128
+ * }
1129
+ */
1130
+ Components.Responses.UnauthorizedError;
1131
+ export type $403 = /**
1132
+ * A generic error returned by the API
1133
+ * example:
1134
+ * {
1135
+ * "status": 403,
1136
+ * "error": "Forbidden: You do not have permission to access this file"
1137
+ * }
1138
+ */
1139
+ Components.Responses.ForbiddenError;
1140
+ export type $404 = /**
1141
+ * A generic error returned by the API
1142
+ * example:
1143
+ * {
1144
+ * "status": 404,
1145
+ * "error": "Not Found: File entity not found"
1146
+ * }
1147
+ */
1148
+ Components.Responses.NotFoundError;
1149
+ export type $500 = /**
1150
+ * A generic error returned by the API
1151
+ * example:
1152
+ * {
1153
+ * "status": 500,
1154
+ * "error": "Internal Server Error"
1155
+ * }
1156
+ */
1157
+ Components.Responses.InternalServerError;
967
1158
  }
968
1159
  }
969
1160
  namespace DownloadFiles {
@@ -971,12 +1162,43 @@ declare namespace Paths {
971
1162
  namespace Responses {
972
1163
  export type $200 = {
973
1164
  /**
1165
+ * Pre-signed S3 URL for downloading the file
974
1166
  * example:
975
1167
  * https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
976
1168
  */
977
1169
  download_url?: string; // uri
1170
+ /**
1171
+ * The file entity ID (matches the requested ID)
1172
+ */
978
1173
  file_entity_id?: string; // uuid
979
1174
  }[];
1175
+ export type $400 = /**
1176
+ * A generic error returned by the API
1177
+ * example:
1178
+ * {
1179
+ * "status": 400,
1180
+ * "error": "Bad Request: filename is required"
1181
+ * }
1182
+ */
1183
+ Components.Responses.BadRequestError;
1184
+ export type $401 = /**
1185
+ * A generic error returned by the API
1186
+ * example:
1187
+ * {
1188
+ * "status": 401,
1189
+ * "error": "Unauthorized: Invalid or expired token"
1190
+ * }
1191
+ */
1192
+ Components.Responses.UnauthorizedError;
1193
+ export type $500 = /**
1194
+ * A generic error returned by the API
1195
+ * example:
1196
+ * {
1197
+ * "status": 500,
1198
+ * "error": "Internal Server Error"
1199
+ * }
1200
+ */
1201
+ Components.Responses.InternalServerError;
980
1202
  }
981
1203
  }
982
1204
  namespace DownloadS3File {
@@ -993,11 +1215,48 @@ declare namespace Paths {
993
1215
  namespace Responses {
994
1216
  export interface $200 {
995
1217
  /**
1218
+ * Pre-signed S3 URL valid for downloading the file
996
1219
  * example:
997
1220
  * https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
998
1221
  */
999
1222
  download_url?: string; // uri
1000
1223
  }
1224
+ export type $400 = /**
1225
+ * A generic error returned by the API
1226
+ * example:
1227
+ * {
1228
+ * "status": 400,
1229
+ * "error": "Bad Request: filename is required"
1230
+ * }
1231
+ */
1232
+ Components.Responses.BadRequestError;
1233
+ export type $401 = /**
1234
+ * A generic error returned by the API
1235
+ * example:
1236
+ * {
1237
+ * "status": 401,
1238
+ * "error": "Unauthorized: Invalid or expired token"
1239
+ * }
1240
+ */
1241
+ Components.Responses.UnauthorizedError;
1242
+ export type $404 = /**
1243
+ * A generic error returned by the API
1244
+ * example:
1245
+ * {
1246
+ * "status": 404,
1247
+ * "error": "Not Found: File entity not found"
1248
+ * }
1249
+ */
1250
+ Components.Responses.NotFoundError;
1251
+ export type $500 = /**
1252
+ * A generic error returned by the API
1253
+ * example:
1254
+ * {
1255
+ * "status": 500,
1256
+ * "error": "Internal Server Error"
1257
+ * }
1258
+ */
1259
+ Components.Responses.InternalServerError;
1001
1260
  }
1002
1261
  }
1003
1262
  namespace GeneratePublicLink {
@@ -1013,26 +1272,61 @@ declare namespace Paths {
1013
1272
  }
1014
1273
  namespace Responses {
1015
1274
  /**
1016
- * example:
1017
- * https://file.sls.epilot.io/v1/files/public/links/3ef5c6d9-818d-45e6-8efb-b1de59079a1c/invoice-2023-12.pdf
1275
+ * The public URL that can be shared externally
1018
1276
  */
1019
1277
  export type $201 = string;
1020
- }
1021
- }
1022
- namespace GetFile {
1023
- namespace Parameters {
1024
- export type Async = boolean;
1025
- export type Id = /**
1278
+ export type $401 = /**
1279
+ * A generic error returned by the API
1026
1280
  * example:
1027
- * ef7d985c-2385-44f4-9c71-ae06a52264f8
1281
+ * {
1282
+ * "status": 401,
1283
+ * "error": "Unauthorized: Invalid or expired token"
1284
+ * }
1028
1285
  */
1029
- Components.Schemas.FileEntityId;
1030
- /**
1031
- * Generate a source_url for the file entity, if it doesn't have one
1286
+ Components.Responses.UnauthorizedError;
1287
+ export type $403 = /**
1288
+ * A generic error returned by the API
1289
+ * example:
1290
+ * {
1291
+ * "status": 403,
1292
+ * "error": "Forbidden: You do not have permission to access this file"
1293
+ * }
1032
1294
  */
1033
- export type SourceUrl = boolean;
1034
- export type Strict = boolean;
1035
- }
1295
+ Components.Responses.ForbiddenError;
1296
+ export type $404 = /**
1297
+ * A generic error returned by the API
1298
+ * example:
1299
+ * {
1300
+ * "status": 404,
1301
+ * "error": "Not Found: File entity not found"
1302
+ * }
1303
+ */
1304
+ Components.Responses.NotFoundError;
1305
+ export type $500 = /**
1306
+ * A generic error returned by the API
1307
+ * example:
1308
+ * {
1309
+ * "status": 500,
1310
+ * "error": "Internal Server Error"
1311
+ * }
1312
+ */
1313
+ Components.Responses.InternalServerError;
1314
+ }
1315
+ }
1316
+ namespace GetFile {
1317
+ namespace Parameters {
1318
+ export type Async = boolean;
1319
+ export type Id = /**
1320
+ * example:
1321
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
1322
+ */
1323
+ Components.Schemas.FileEntityId;
1324
+ /**
1325
+ * Generate a source_url for the file entity, if it doesn't have one
1326
+ */
1327
+ export type SourceUrl = boolean;
1328
+ export type Strict = boolean;
1329
+ }
1036
1330
  export interface PathParameters {
1037
1331
  id: Parameters.Id;
1038
1332
  }
@@ -1043,14 +1337,46 @@ declare namespace Paths {
1043
1337
  }
1044
1338
  namespace Responses {
1045
1339
  export type $200 = Components.Schemas.FileEntity;
1340
+ export type $401 = /**
1341
+ * A generic error returned by the API
1342
+ * example:
1343
+ * {
1344
+ * "status": 401,
1345
+ * "error": "Unauthorized: Invalid or expired token"
1346
+ * }
1347
+ */
1348
+ Components.Responses.UnauthorizedError;
1349
+ export type $403 = /**
1350
+ * A generic error returned by the API
1351
+ * example:
1352
+ * {
1353
+ * "status": 403,
1354
+ * "error": "Forbidden: You do not have permission to access this file"
1355
+ * }
1356
+ */
1357
+ Components.Responses.ForbiddenError;
1358
+ export type $404 = /**
1359
+ * A generic error returned by the API
1360
+ * example:
1361
+ * {
1362
+ * "status": 404,
1363
+ * "error": "Not Found: File entity not found"
1364
+ * }
1365
+ */
1366
+ Components.Responses.NotFoundError;
1367
+ export type $500 = /**
1368
+ * A generic error returned by the API
1369
+ * example:
1370
+ * {
1371
+ * "status": 500,
1372
+ * "error": "Internal Server Error"
1373
+ * }
1374
+ */
1375
+ Components.Responses.InternalServerError;
1046
1376
  }
1047
1377
  }
1048
1378
  namespace GetFilesInCollection {
1049
1379
  namespace Parameters {
1050
- /**
1051
- * example:
1052
- * documents
1053
- */
1054
1380
  export type CollectionSlug = string;
1055
1381
  export type Id = /**
1056
1382
  * example:
@@ -1060,95 +1386,117 @@ declare namespace Paths {
1060
1386
  }
1061
1387
  export interface PathParameters {
1062
1388
  id: Parameters.Id;
1063
- collectionSlug: /**
1064
- * example:
1065
- * documents
1066
- */
1067
- Parameters.CollectionSlug;
1389
+ collectionSlug: Parameters.CollectionSlug;
1068
1390
  }
1069
1391
  namespace Responses {
1070
1392
  export type $200 = Components.Schemas.FileEntity[];
1071
- export interface $403 {
1072
- /**
1073
- * example:
1074
- * User must have permission to view this entity to access its files
1075
- */
1076
- error?: string;
1077
- }
1078
- export interface $404 {
1079
- /**
1080
- * example:
1081
- * Entity not found
1082
- */
1083
- error?: string;
1084
- }
1393
+ export type $401 = /**
1394
+ * A generic error returned by the API
1395
+ * example:
1396
+ * {
1397
+ * "status": 401,
1398
+ * "error": "Unauthorized: Invalid or expired token"
1399
+ * }
1400
+ */
1401
+ Components.Responses.UnauthorizedError;
1402
+ export type $403 = /* A generic error returned by the API */ Components.Schemas.ErrorObject;
1403
+ export type $404 = /* A generic error returned by the API */ Components.Schemas.ErrorObject;
1404
+ export type $500 = /**
1405
+ * A generic error returned by the API
1406
+ * example:
1407
+ * {
1408
+ * "status": 500,
1409
+ * "error": "Internal Server Error"
1410
+ * }
1411
+ */
1412
+ Components.Responses.InternalServerError;
1085
1413
  }
1086
1414
  }
1087
1415
  namespace GetGlobalFileCollections {
1088
1416
  namespace Parameters {
1089
- /**
1090
- * example:
1091
- * order
1092
- */
1093
1417
  export type SchemaSlug = string;
1094
1418
  }
1095
1419
  export interface PathParameters {
1096
- schemaSlug: /**
1097
- * example:
1098
- * order
1099
- */
1100
- Parameters.SchemaSlug;
1420
+ schemaSlug: Parameters.SchemaSlug;
1101
1421
  }
1102
1422
  namespace Responses {
1103
1423
  export type $200 = /* A file collection with identifiers and timestamps */ Components.Schemas.FileCollectionItem[];
1424
+ export type $401 = /**
1425
+ * A generic error returned by the API
1426
+ * example:
1427
+ * {
1428
+ * "status": 401,
1429
+ * "error": "Unauthorized: Invalid or expired token"
1430
+ * }
1431
+ */
1432
+ Components.Responses.UnauthorizedError;
1433
+ export type $500 = /**
1434
+ * A generic error returned by the API
1435
+ * example:
1436
+ * {
1437
+ * "status": 500,
1438
+ * "error": "Internal Server Error"
1439
+ * }
1440
+ */
1441
+ Components.Responses.InternalServerError;
1104
1442
  }
1105
1443
  }
1106
1444
  namespace GetSession {
1107
1445
  namespace Responses {
1108
1446
  export interface $200 {
1109
1447
  }
1448
+ export type $401 = /**
1449
+ * A generic error returned by the API
1450
+ * example:
1451
+ * {
1452
+ * "status": 401,
1453
+ * "error": "Unauthorized: Invalid or expired token"
1454
+ * }
1455
+ */
1456
+ Components.Responses.UnauthorizedError;
1110
1457
  }
1111
1458
  }
1112
1459
  namespace GetUserSchemaFileCollections {
1113
1460
  namespace Parameters {
1114
- /**
1115
- * example:
1116
- * opportunity
1117
- */
1118
1461
  export type Slug = string;
1119
1462
  }
1120
1463
  export interface PathParameters {
1121
- slug: /**
1122
- * example:
1123
- * opportunity
1124
- */
1125
- Parameters.Slug;
1464
+ slug: Parameters.Slug;
1126
1465
  }
1127
1466
  namespace Responses {
1128
1467
  export type $200 = /* A file collection with identifiers and timestamps */ Components.Schemas.FileCollectionItem[];
1468
+ export type $401 = /**
1469
+ * A generic error returned by the API
1470
+ * example:
1471
+ * {
1472
+ * "status": 401,
1473
+ * "error": "Unauthorized: Invalid or expired token"
1474
+ * }
1475
+ */
1476
+ Components.Responses.UnauthorizedError;
1477
+ export type $500 = /**
1478
+ * A generic error returned by the API
1479
+ * example:
1480
+ * {
1481
+ * "status": 500,
1482
+ * "error": "Internal Server Error"
1483
+ * }
1484
+ */
1485
+ Components.Responses.InternalServerError;
1129
1486
  }
1130
1487
  }
1131
1488
  namespace ListPublicLinksForFile {
1132
1489
  namespace Parameters {
1133
- /**
1134
- * ID of the file entity
1135
- * example:
1136
- * 13d22918-36bd-4227-9ad4-2cb978788c8d
1137
- */
1138
1490
  export type Id = string;
1139
1491
  }
1140
1492
  export interface PathParameters {
1141
- id: /**
1142
- * ID of the file entity
1143
- * example:
1144
- * 13d22918-36bd-4227-9ad4-2cb978788c8d
1145
- */
1146
- Parameters.Id;
1493
+ id: Parameters.Id;
1147
1494
  }
1148
1495
  namespace Responses {
1149
1496
  export interface $200 {
1150
1497
  results?: Components.Schemas.PublicLink[];
1151
1498
  }
1499
+ export type $501 = /* A generic error returned by the API */ Components.Schemas.ErrorObject;
1152
1500
  }
1153
1501
  }
1154
1502
  namespace PreviewFile {
@@ -1170,6 +1518,36 @@ declare namespace Paths {
1170
1518
  w?: Parameters.W;
1171
1519
  h?: Parameters.H;
1172
1520
  }
1521
+ namespace Responses {
1522
+ export type $200 = string; // binary
1523
+ export type $401 = /**
1524
+ * A generic error returned by the API
1525
+ * example:
1526
+ * {
1527
+ * "status": 401,
1528
+ * "error": "Unauthorized: Invalid or expired token"
1529
+ * }
1530
+ */
1531
+ Components.Responses.UnauthorizedError;
1532
+ export type $404 = /**
1533
+ * A generic error returned by the API
1534
+ * example:
1535
+ * {
1536
+ * "status": 404,
1537
+ * "error": "Not Found: File entity not found"
1538
+ * }
1539
+ */
1540
+ Components.Responses.NotFoundError;
1541
+ export type $500 = /**
1542
+ * A generic error returned by the API
1543
+ * example:
1544
+ * {
1545
+ * "status": 500,
1546
+ * "error": "Internal Server Error"
1547
+ * }
1548
+ */
1549
+ Components.Responses.InternalServerError;
1550
+ }
1173
1551
  }
1174
1552
  namespace PreviewPublicFile {
1175
1553
  namespace Parameters {
@@ -1192,6 +1570,28 @@ declare namespace Paths {
1192
1570
  h?: Parameters.H;
1193
1571
  org_id?: Parameters.OrgId;
1194
1572
  }
1573
+ namespace Responses {
1574
+ export type $200 = string; // binary
1575
+ export type $403 = /* A generic error returned by the API */ Components.Schemas.ErrorObject;
1576
+ export type $404 = /**
1577
+ * A generic error returned by the API
1578
+ * example:
1579
+ * {
1580
+ * "status": 404,
1581
+ * "error": "Not Found: File entity not found"
1582
+ * }
1583
+ */
1584
+ Components.Responses.NotFoundError;
1585
+ export type $500 = /**
1586
+ * A generic error returned by the API
1587
+ * example:
1588
+ * {
1589
+ * "status": 500,
1590
+ * "error": "Internal Server Error"
1591
+ * }
1592
+ */
1593
+ Components.Responses.InternalServerError;
1594
+ }
1195
1595
  }
1196
1596
  namespace PreviewS3File {
1197
1597
  namespace Parameters {
@@ -1203,6 +1603,45 @@ declare namespace Paths {
1203
1603
  h?: Parameters.H;
1204
1604
  }
1205
1605
  export type RequestBody = Components.Schemas.S3Ref;
1606
+ namespace Responses {
1607
+ export type $200 = string; // binary
1608
+ export type $400 = /**
1609
+ * A generic error returned by the API
1610
+ * example:
1611
+ * {
1612
+ * "status": 400,
1613
+ * "error": "Bad Request: filename is required"
1614
+ * }
1615
+ */
1616
+ Components.Responses.BadRequestError;
1617
+ export type $401 = /**
1618
+ * A generic error returned by the API
1619
+ * example:
1620
+ * {
1621
+ * "status": 401,
1622
+ * "error": "Unauthorized: Invalid or expired token"
1623
+ * }
1624
+ */
1625
+ Components.Responses.UnauthorizedError;
1626
+ export type $404 = /**
1627
+ * A generic error returned by the API
1628
+ * example:
1629
+ * {
1630
+ * "status": 404,
1631
+ * "error": "Not Found: File entity not found"
1632
+ * }
1633
+ */
1634
+ Components.Responses.NotFoundError;
1635
+ export type $500 = /**
1636
+ * A generic error returned by the API
1637
+ * example:
1638
+ * {
1639
+ * "status": 500,
1640
+ * "error": "Internal Server Error"
1641
+ * }
1642
+ */
1643
+ Components.Responses.InternalServerError;
1644
+ }
1206
1645
  }
1207
1646
  namespace PreviewS3FileGet {
1208
1647
  namespace Parameters {
@@ -1217,30 +1656,57 @@ declare namespace Paths {
1217
1656
  w?: Parameters.W;
1218
1657
  h?: Parameters.H;
1219
1658
  }
1659
+ namespace Responses {
1660
+ export type $200 = string; // binary
1661
+ export type $400 = /**
1662
+ * A generic error returned by the API
1663
+ * example:
1664
+ * {
1665
+ * "status": 400,
1666
+ * "error": "Bad Request: filename is required"
1667
+ * }
1668
+ */
1669
+ Components.Responses.BadRequestError;
1670
+ export type $401 = /**
1671
+ * A generic error returned by the API
1672
+ * example:
1673
+ * {
1674
+ * "status": 401,
1675
+ * "error": "Unauthorized: Invalid or expired token"
1676
+ * }
1677
+ */
1678
+ Components.Responses.UnauthorizedError;
1679
+ export type $404 = /**
1680
+ * A generic error returned by the API
1681
+ * example:
1682
+ * {
1683
+ * "status": 404,
1684
+ * "error": "Not Found: File entity not found"
1685
+ * }
1686
+ */
1687
+ Components.Responses.NotFoundError;
1688
+ export type $500 = /**
1689
+ * A generic error returned by the API
1690
+ * example:
1691
+ * {
1692
+ * "status": 500,
1693
+ * "error": "Internal Server Error"
1694
+ * }
1695
+ */
1696
+ Components.Responses.InternalServerError;
1697
+ }
1220
1698
  }
1221
1699
  namespace RevokePublicLink {
1222
1700
  namespace Parameters {
1223
- /**
1224
- * Id of the publicly generated link
1225
- * example:
1226
- * 13d22918-36bd-4227-9ad4-2cb978788c8d
1227
- */
1228
1701
  export type Id = string;
1229
1702
  }
1230
1703
  export interface PathParameters {
1231
- id: /**
1232
- * Id of the publicly generated link
1233
- * example:
1234
- * 13d22918-36bd-4227-9ad4-2cb978788c8d
1235
- */
1236
- Parameters.Id;
1704
+ id: Parameters.Id;
1237
1705
  }
1238
1706
  namespace Responses {
1239
- /**
1240
- * example:
1241
- * https://file.sls.epilot.io/v1/files/public/links/3ef5c6d9-818d-45e6-8efb-b1de59079a1c
1242
- */
1243
- export type $204 = string;
1707
+ export interface $204 {
1708
+ }
1709
+ export type $501 = /* A generic error returned by the API */ Components.Schemas.ErrorObject;
1244
1710
  }
1245
1711
  }
1246
1712
  namespace SaveFile {
@@ -1252,14 +1718,43 @@ declare namespace Paths {
1252
1718
  */
1253
1719
  Components.Schemas.ActivityId /* ulid */;
1254
1720
  export type Async = boolean;
1721
+ export type VersionOnly = boolean;
1255
1722
  }
1256
1723
  export interface QueryParameters {
1257
1724
  activity_id?: Parameters.ActivityId;
1258
1725
  async?: Parameters.Async;
1726
+ version_only?: Parameters.VersionOnly;
1259
1727
  }
1260
1728
  export type RequestBody = Components.Schemas.SaveFilePayload;
1261
1729
  namespace Responses {
1262
1730
  export type $201 = Components.Schemas.FileEntity;
1731
+ export type $400 = /**
1732
+ * A generic error returned by the API
1733
+ * example:
1734
+ * {
1735
+ * "status": 400,
1736
+ * "error": "Bad Request: filename is required"
1737
+ * }
1738
+ */
1739
+ Components.Responses.BadRequestError;
1740
+ export type $401 = /**
1741
+ * A generic error returned by the API
1742
+ * example:
1743
+ * {
1744
+ * "status": 401,
1745
+ * "error": "Unauthorized: Invalid or expired token"
1746
+ * }
1747
+ */
1748
+ Components.Responses.UnauthorizedError;
1749
+ export type $500 = /**
1750
+ * A generic error returned by the API
1751
+ * example:
1752
+ * {
1753
+ * "status": 500,
1754
+ * "error": "Internal Server Error"
1755
+ * }
1756
+ */
1757
+ Components.Responses.InternalServerError;
1263
1758
  }
1264
1759
  }
1265
1760
  namespace SaveFileV2 {
@@ -1274,6 +1769,7 @@ declare namespace Paths {
1274
1769
  export type DeleteTempFile = boolean;
1275
1770
  export type FillActivity = boolean;
1276
1771
  export type Strict = boolean;
1772
+ export type VersionOnly = boolean;
1277
1773
  }
1278
1774
  export interface QueryParameters {
1279
1775
  activity_id?: Parameters.ActivityId;
@@ -1281,49 +1777,97 @@ declare namespace Paths {
1281
1777
  strict?: Parameters.Strict;
1282
1778
  async?: Parameters.Async;
1283
1779
  delete_temp_file?: Parameters.DeleteTempFile;
1780
+ version_only?: Parameters.VersionOnly;
1284
1781
  }
1285
1782
  export type RequestBody = Components.Schemas.SaveFilePayloadV2;
1286
1783
  namespace Responses {
1287
1784
  export type $200 = Components.Schemas.FileEntity;
1288
- }
1289
- }
1290
- namespace UpdateUserSchemaFileCollection {
1291
- namespace Parameters {
1292
- /**
1785
+ export type $400 = /**
1786
+ * A generic error returned by the API
1293
1787
  * example:
1294
- * documents
1788
+ * {
1789
+ * "status": 400,
1790
+ * "error": "Bad Request: filename is required"
1791
+ * }
1295
1792
  */
1296
- export type CollectionSlug = string;
1297
- /**
1793
+ Components.Responses.BadRequestError;
1794
+ export type $401 = /**
1795
+ * A generic error returned by the API
1298
1796
  * example:
1299
- * opportunity
1797
+ * {
1798
+ * "status": 401,
1799
+ * "error": "Unauthorized: Invalid or expired token"
1800
+ * }
1300
1801
  */
1301
- export type Slug = string;
1302
- }
1303
- export interface PathParameters {
1304
- slug: /**
1802
+ Components.Responses.UnauthorizedError;
1803
+ export type $404 = /**
1804
+ * A generic error returned by the API
1305
1805
  * example:
1306
- * opportunity
1806
+ * {
1807
+ * "status": 404,
1808
+ * "error": "Not Found: File entity not found"
1809
+ * }
1307
1810
  */
1308
- Parameters.Slug;
1309
- collectionSlug: /**
1811
+ Components.Responses.NotFoundError;
1812
+ export type $500 = /**
1813
+ * A generic error returned by the API
1310
1814
  * example:
1311
- * documents
1815
+ * {
1816
+ * "status": 500,
1817
+ * "error": "Internal Server Error"
1818
+ * }
1312
1819
  */
1313
- Parameters.CollectionSlug;
1820
+ Components.Responses.InternalServerError;
1821
+ }
1822
+ }
1823
+ namespace UpdateUserSchemaFileCollection {
1824
+ namespace Parameters {
1825
+ export type CollectionSlug = string;
1826
+ export type Slug = string;
1827
+ }
1828
+ export interface PathParameters {
1829
+ slug: Parameters.Slug;
1830
+ collectionSlug: Parameters.CollectionSlug;
1314
1831
  }
1315
1832
  export type RequestBody = Components.Schemas.FileCollectionAttributes;
1316
1833
  namespace Responses {
1317
1834
  export type $200 = /* A file collection with identifiers and timestamps */ Components.Schemas.FileCollectionItem;
1835
+ export type $400 = /**
1836
+ * A generic error returned by the API
1837
+ * example:
1838
+ * {
1839
+ * "status": 400,
1840
+ * "error": "Bad Request: filename is required"
1841
+ * }
1842
+ */
1843
+ Components.Responses.BadRequestError;
1844
+ export type $401 = /**
1845
+ * A generic error returned by the API
1846
+ * example:
1847
+ * {
1848
+ * "status": 401,
1849
+ * "error": "Unauthorized: Invalid or expired token"
1850
+ * }
1851
+ */
1852
+ Components.Responses.UnauthorizedError;
1318
1853
  export type $404 = /**
1319
1854
  * A generic error returned by the API
1320
1855
  * example:
1321
1856
  * {
1322
1857
  * "status": 404,
1323
- * "error": "Not Found"
1858
+ * "error": "Not Found: File entity not found"
1324
1859
  * }
1325
1860
  */
1326
1861
  Components.Responses.NotFoundError;
1862
+ export type $500 = /**
1863
+ * A generic error returned by the API
1864
+ * example:
1865
+ * {
1866
+ * "status": 500,
1867
+ * "error": "Internal Server Error"
1868
+ * }
1869
+ */
1870
+ Components.Responses.InternalServerError;
1327
1871
  }
1328
1872
  }
1329
1873
  namespace UploadFile {
@@ -1353,6 +1897,33 @@ declare namespace Paths {
1353
1897
  */
1354
1898
  public_url?: string; // url
1355
1899
  }
1900
+ export type $400 = /**
1901
+ * A generic error returned by the API
1902
+ * example:
1903
+ * {
1904
+ * "status": 400,
1905
+ * "error": "Bad Request: filename is required"
1906
+ * }
1907
+ */
1908
+ Components.Responses.BadRequestError;
1909
+ export type $401 = /**
1910
+ * A generic error returned by the API
1911
+ * example:
1912
+ * {
1913
+ * "status": 401,
1914
+ * "error": "Unauthorized: Invalid or expired token"
1915
+ * }
1916
+ */
1917
+ Components.Responses.UnauthorizedError;
1918
+ export type $500 = /**
1919
+ * A generic error returned by the API
1920
+ * example:
1921
+ * {
1922
+ * "status": 500,
1923
+ * "error": "Internal Server Error"
1924
+ * }
1925
+ */
1926
+ Components.Responses.InternalServerError;
1356
1927
  }
1357
1928
  }
1358
1929
  namespace UploadFilePublic {
@@ -1361,16 +1932,36 @@ declare namespace Paths {
1361
1932
  export interface $201 {
1362
1933
  s3ref?: Components.Schemas.S3Reference;
1363
1934
  /**
1935
+ * Pre-signed URL for uploading the file via PUT request
1364
1936
  * example:
1365
1937
  * https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
1366
1938
  */
1367
1939
  upload_url?: string; // url
1368
1940
  /**
1941
+ * Error message if the upload preparation failed
1369
1942
  * example:
1370
1943
  * File entity not found
1371
1944
  */
1372
1945
  error?: string;
1373
1946
  }
1947
+ export type $400 = /**
1948
+ * A generic error returned by the API
1949
+ * example:
1950
+ * {
1951
+ * "status": 400,
1952
+ * "error": "Bad Request: filename is required"
1953
+ * }
1954
+ */
1955
+ Components.Responses.BadRequestError;
1956
+ export type $500 = /**
1957
+ * A generic error returned by the API
1958
+ * example:
1959
+ * {
1960
+ * "status": 500,
1961
+ * "error": "Internal Server Error"
1962
+ * }
1963
+ */
1964
+ Components.Responses.InternalServerError;
1374
1965
  }
1375
1966
  }
1376
1967
  namespace UploadFileV2 {
@@ -1387,14 +1978,71 @@ declare namespace Paths {
1387
1978
  export type RequestBody = Components.Schemas.UploadFilePayload;
1388
1979
  namespace Responses {
1389
1980
  export type $201 = Components.Schemas.FileUpload;
1981
+ export type $400 = /**
1982
+ * A generic error returned by the API
1983
+ * example:
1984
+ * {
1985
+ * "status": 400,
1986
+ * "error": "Bad Request: filename is required"
1987
+ * }
1988
+ */
1989
+ Components.Responses.BadRequestError;
1990
+ export type $401 = /**
1991
+ * A generic error returned by the API
1992
+ * example:
1993
+ * {
1994
+ * "status": 401,
1995
+ * "error": "Unauthorized: Invalid or expired token"
1996
+ * }
1997
+ */
1998
+ Components.Responses.UnauthorizedError;
1999
+ export type $500 = /**
2000
+ * A generic error returned by the API
2001
+ * example:
2002
+ * {
2003
+ * "status": 500,
2004
+ * "error": "Internal Server Error"
2005
+ * }
2006
+ */
2007
+ Components.Responses.InternalServerError;
1390
2008
  }
1391
2009
  }
1392
2010
  namespace VerifyCustomDownloadUrl {
1393
2011
  export type RequestBody = Components.Schemas.VerifyCustomDownloadUrlPayload;
1394
2012
  namespace Responses {
1395
2013
  export interface $200 {
2014
+ /**
2015
+ * Whether the URL is valid and not expired
2016
+ */
1396
2017
  valid?: boolean;
1397
2018
  }
2019
+ export type $400 = /**
2020
+ * A generic error returned by the API
2021
+ * example:
2022
+ * {
2023
+ * "status": 400,
2024
+ * "error": "Bad Request: filename is required"
2025
+ * }
2026
+ */
2027
+ Components.Responses.BadRequestError;
2028
+ export type $401 = /**
2029
+ * A generic error returned by the API
2030
+ * example:
2031
+ * {
2032
+ * "status": 401,
2033
+ * "error": "Unauthorized: Invalid or expired token"
2034
+ * }
2035
+ */
2036
+ Components.Responses.UnauthorizedError;
2037
+ export type $500 = /**
2038
+ * A generic error returned by the API
2039
+ * example:
2040
+ * {
2041
+ * "status": 500,
2042
+ * "error": "Internal Server Error"
2043
+ * }
2044
+ */
2045
+ Components.Responses.InternalServerError;
1398
2046
  }
1399
2047
  }
1400
2048
  }
@@ -1430,6 +2078,19 @@ export interface OperationMethods {
1430
2078
  /**
1431
2079
  * uploadFile - uploadFile
1432
2080
  *
2081
+ * **DEPRECATED** - Will be removed on **2025-06-30**. Use `POST /v2/files/upload` instead.
2082
+ *
2083
+ * ## Migration Guide
2084
+ * Replace calls to this endpoint with `uploadFileV2`:
2085
+ *
2086
+ * | v1 Parameter | v2 Parameter | Notes |
2087
+ * |--------------|--------------|-------|
2088
+ * | `file_entity_id` | `file_entity_id` | No change |
2089
+ *
2090
+ * The v2 response includes the same fields with improved structure.
2091
+ *
2092
+ * ---
2093
+ *
1433
2094
  * Create pre-signed S3 URL to upload a file to keep temporarily (one week).
1434
2095
  *
1435
2096
  * Use the saveFile operation to store file file permanently.
@@ -1443,11 +2104,26 @@ export interface OperationMethods {
1443
2104
  /**
1444
2105
  * saveFile - saveFile
1445
2106
  *
1446
- * Create / Update a permanent File entity
2107
+ * **DEPRECATED** - Will be removed on **2025-06-30**. Use `POST /v2/files` instead.
2108
+ *
2109
+ * ## Migration Guide
2110
+ * Replace calls to this endpoint with `saveFileV2`:
2111
+ *
2112
+ * | v1 Feature | v2 Feature | Notes |
2113
+ * |------------|------------|-------|
2114
+ * | `activity_id` param | `activity_id` param | No change |
2115
+ * | `async` param | `async` param | No change |
2116
+ * | - | `fill_activity` param | New in v2 |
2117
+ * | - | `strict` param | New in v2 |
2118
+ * | - | `delete_temp_file` param | New in v2, defaults to true |
1447
2119
  *
1448
- * Makes file object permanent
2120
+ * The v2 endpoint supports additional parameters for better control over file saving behavior.
1449
2121
  *
1450
- * Saves metadata to file entity
2122
+ * ---
2123
+ *
2124
+ * Create / Update a permanent File entity.
2125
+ *
2126
+ * Makes file object permanent and saves metadata to file entity.
1451
2127
  *
1452
2128
  */
1453
2129
  'saveFile'(
@@ -1478,7 +2154,10 @@ export interface OperationMethods {
1478
2154
  /**
1479
2155
  * downloadFile - downloadFile
1480
2156
  *
1481
- * Generate pre-signed download S3 url for a file
2157
+ * Generate a pre-signed download URL for a file.
2158
+ *
2159
+ * The returned URL is valid for a limited time (typically 15 minutes) and can be used to download the file directly.
2160
+ *
1482
2161
  */
1483
2162
  'downloadFile'(
1484
2163
  parameters?: Parameters<Paths.DownloadFile.QueryParameters & Paths.DownloadFile.PathParameters> | null,
@@ -1488,7 +2167,10 @@ export interface OperationMethods {
1488
2167
  /**
1489
2168
  * downloadS3File - downloadS3File
1490
2169
  *
1491
- * Generate pre-signed download S3 url for a file
2170
+ * Generate a pre-signed download URL for a file using its S3 reference.
2171
+ *
2172
+ * Use this endpoint when you have the S3 bucket and key but not the file entity ID.
2173
+ *
1492
2174
  */
1493
2175
  'downloadS3File'(
1494
2176
  parameters?: Parameters<Paths.DownloadS3File.QueryParameters> | null,
@@ -1498,7 +2180,10 @@ export interface OperationMethods {
1498
2180
  /**
1499
2181
  * downloadFiles - downloadFiles
1500
2182
  *
1501
- * Bulk generate pre-signed download S3 urls for multiple files
2183
+ * Bulk generate pre-signed download URLs for multiple files in a single request.
2184
+ *
2185
+ * This is more efficient than calling `downloadFile` multiple times when you need to download several files.
2186
+ *
1502
2187
  */
1503
2188
  'downloadFiles'(
1504
2189
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -1508,49 +2193,70 @@ export interface OperationMethods {
1508
2193
  /**
1509
2194
  * previewFile - previewFile
1510
2195
  *
1511
- * Generate thumbnail preview for a file entity
2196
+ * Generate a thumbnail preview for a file entity.
2197
+ *
2198
+ * Supported file types include images (PNG, JPEG, GIF, WebP), PDFs, and common document formats.
2199
+ * The preview is returned as an image (PNG or JPEG).
2200
+ *
2201
+ * **Tip:** Use with CookieAuth to embed previews directly in `<img>` tags.
2202
+ *
1512
2203
  */
1513
2204
  'previewFile'(
1514
2205
  parameters?: Parameters<Paths.PreviewFile.QueryParameters & Paths.PreviewFile.PathParameters> | null,
1515
2206
  data?: any,
1516
2207
  config?: AxiosRequestConfig
1517
- ): OperationResponse<any>
2208
+ ): OperationResponse<Paths.PreviewFile.Responses.$200>
1518
2209
  /**
1519
2210
  * previewS3FileGet - previewS3FileGet
1520
2211
  *
1521
- * Get thumbnail preview from an s3 reference for a file entity
2212
+ * Get a thumbnail preview from an S3 reference using query parameters.
2213
+ *
2214
+ * This GET variant is useful for embedding previews directly in `<img>` tags.
2215
+ *
1522
2216
  */
1523
2217
  'previewS3FileGet'(
1524
2218
  parameters?: Parameters<Paths.PreviewS3FileGet.QueryParameters> | null,
1525
2219
  data?: any,
1526
2220
  config?: AxiosRequestConfig
1527
- ): OperationResponse<any>
2221
+ ): OperationResponse<Paths.PreviewS3FileGet.Responses.$200>
1528
2222
  /**
1529
2223
  * previewS3File - previewS3File
1530
2224
  *
1531
- * Generate thumbnail preview from an s3 reference for a file entity
2225
+ * Generate a thumbnail preview from an S3 reference.
2226
+ *
2227
+ * Use this endpoint when you have the S3 bucket and key but not the file entity ID.
2228
+ *
1532
2229
  */
1533
2230
  'previewS3File'(
1534
2231
  parameters?: Parameters<Paths.PreviewS3File.QueryParameters> | null,
1535
2232
  data?: Paths.PreviewS3File.RequestBody,
1536
2233
  config?: AxiosRequestConfig
1537
- ): OperationResponse<any>
2234
+ ): OperationResponse<Paths.PreviewS3File.Responses.$200>
1538
2235
  /**
1539
2236
  * previewPublicFile - previewPublicFile
1540
2237
  *
1541
- * Generate thumbnail preview for a public file entity
2238
+ * Generate a thumbnail preview for a public file entity.
2239
+ *
2240
+ * **No authentication required.** This endpoint only works for files with `access_control: public-read`.
2241
+ *
1542
2242
  */
1543
2243
  'previewPublicFile'(
1544
2244
  parameters?: Parameters<Paths.PreviewPublicFile.QueryParameters & Paths.PreviewPublicFile.PathParameters> | null,
1545
2245
  data?: any,
1546
2246
  config?: AxiosRequestConfig
1547
- ): OperationResponse<any>
2247
+ ): OperationResponse<Paths.PreviewPublicFile.Responses.$200>
1548
2248
  /**
1549
2249
  * getSession - getSession
1550
2250
  *
1551
- * Start a browser session by setting passed Authorization token in a server side cookie.
2251
+ * Start a browser session by converting a Bearer token into a server-side cookie.
2252
+ *
2253
+ * **Use case:** After calling this endpoint, you can use preview URLs directly in `<img>` tags
2254
+ * without needing to set the Authorization header manually.
1552
2255
  *
1553
- * Allows using preview urls directly in img src for private files using cookie authentication.
2256
+ * **Example flow:**
2257
+ * 1. Call this endpoint with your Bearer token: `GET /v1/files/session` with `Authorization: Bearer <token>`
2258
+ * 2. The server sets an HTTP-only cookie named `token`
2259
+ * 3. Use preview URLs directly: `<img src="https://file.sls.epilot.io/v1/files/{id}/preview" />`
1554
2260
  *
1555
2261
  */
1556
2262
  'getSession'(
@@ -1561,7 +2267,10 @@ export interface OperationMethods {
1561
2267
  /**
1562
2268
  * deleteSession - deleteSession
1563
2269
  *
1564
- * End browser session by deleting token cookie
2270
+ * End a browser session by deleting the token cookie.
2271
+ *
2272
+ * Call this endpoint to log out and clear the session cookie.
2273
+ *
1565
2274
  */
1566
2275
  'deleteSession'(
1567
2276
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -1571,7 +2280,10 @@ export interface OperationMethods {
1571
2280
  /**
1572
2281
  * listPublicLinksForFile - listPublicLinksForFile
1573
2282
  *
1574
- * Not yet implemented; This API would fetch all the public links that are previously generated for a file
2283
+ * **Not yet implemented.**
2284
+ *
2285
+ * This endpoint will fetch all public links previously generated for a file.
2286
+ *
1575
2287
  */
1576
2288
  'listPublicLinksForFile'(
1577
2289
  parameters?: Parameters<Paths.ListPublicLinksForFile.PathParameters> | null,
@@ -1581,7 +2293,15 @@ export interface OperationMethods {
1581
2293
  /**
1582
2294
  * generatePublicLink - generatePublicLink
1583
2295
  *
1584
- * Generates a public link to access a private file
2296
+ * Generate a public link to share a private file externally.
2297
+ *
2298
+ * The generated link:
2299
+ * - Is permanent until explicitly revoked
2300
+ * - Includes the filename for user-friendly URLs
2301
+ * - Does not require authentication to access
2302
+ * - Redirects to a signed download URL when accessed
2303
+ *
2304
+ * **Use case:** Share invoices, contracts, or documents with external parties who don't have epilot accounts.
1585
2305
  *
1586
2306
  */
1587
2307
  'generatePublicLink'(
@@ -1592,7 +2312,12 @@ export interface OperationMethods {
1592
2312
  /**
1593
2313
  * accessPublicLink - accessPublicLink
1594
2314
  *
1595
- * Redirects to a accessible signed url for the respective file associated to the public link
2315
+ * Access a file via its public link.
2316
+ *
2317
+ * **No authentication required.** This endpoint redirects to a signed S3 URL for downloading the file.
2318
+ *
2319
+ * The filename in the URL is for user-friendliness and SEO; the actual file is identified by the link ID.
2320
+ *
1596
2321
  */
1597
2322
  'accessPublicLink'(
1598
2323
  parameters?: Parameters<Paths.AccessPublicLink.QueryParameters & Paths.AccessPublicLink.PathParameters> | null,
@@ -1602,7 +2327,10 @@ export interface OperationMethods {
1602
2327
  /**
1603
2328
  * revokePublicLink - revokePublicLink
1604
2329
  *
1605
- * Not yet implemented; This operation would revoke a given public link by ID
2330
+ * **Not yet implemented.**
2331
+ *
2332
+ * This endpoint will revoke a public link, making the file inaccessible via that link.
2333
+ *
1606
2334
  */
1607
2335
  'revokePublicLink'(
1608
2336
  parameters?: Parameters<Paths.RevokePublicLink.PathParameters> | null,
@@ -1612,7 +2340,11 @@ export interface OperationMethods {
1612
2340
  /**
1613
2341
  * verifyCustomDownloadUrl - verifyCustomDownloadUrl
1614
2342
  *
1615
- * Verify a pre-signed custom download url for a file
2343
+ * Verify that a custom download URL is valid and has not expired.
2344
+ *
2345
+ * Use this endpoint to validate custom download URLs before redirecting users.
2346
+ * Custom download URLs include a signature and expiration time for security.
2347
+ *
1616
2348
  */
1617
2349
  'verifyCustomDownloadUrl'(
1618
2350
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -1622,9 +2354,16 @@ export interface OperationMethods {
1622
2354
  /**
1623
2355
  * uploadFilePublic - uploadFilePublic
1624
2356
  *
1625
- * Create pre-signed S3 URL to upload a file to keep temporarily (one week).
2357
+ * Create a pre-signed S3 URL for uploading a file without authentication.
1626
2358
  *
1627
- * Use the saveFileV2 operation to store file file permanently.
2359
+ * **No authentication required.** This endpoint is intended for public-facing forms and journeys
2360
+ * where end-users need to upload files without logging in.
2361
+ *
2362
+ * The uploaded file is stored temporarily (one week). Use `saveFileV2` with proper authentication
2363
+ * to store the file permanently.
2364
+ *
2365
+ * **Security note:** Files uploaded via this endpoint are temporary and require authenticated
2366
+ * access to be saved permanently.
1628
2367
  *
1629
2368
  */
1630
2369
  'uploadFilePublic'(
@@ -1635,7 +2374,11 @@ export interface OperationMethods {
1635
2374
  /**
1636
2375
  * getUserSchemaFileCollections - getUserSchemaFileCollections
1637
2376
  *
1638
- * Gets a list of file collections for the current user and schema
2377
+ * Get all file collections for the current user within a specific schema.
2378
+ *
2379
+ * Collections help organize files into logical groups (e.g., "Contracts", "Invoices").
2380
+ * User collections are private to the creating user.
2381
+ *
1639
2382
  */
1640
2383
  'getUserSchemaFileCollections'(
1641
2384
  parameters?: Parameters<Paths.GetUserSchemaFileCollections.PathParameters> | null,
@@ -1645,7 +2388,10 @@ export interface OperationMethods {
1645
2388
  /**
1646
2389
  * createUserSchemaFileCollection - createUserSchemaFileCollection
1647
2390
  *
1648
- * Creates a new file collection for the current user and schema
2391
+ * Create a new file collection for the current user within a specific schema.
2392
+ *
2393
+ * The collection will be private to the creating user and associated with the specified schema.
2394
+ *
1649
2395
  */
1650
2396
  'createUserSchemaFileCollection'(
1651
2397
  parameters?: Parameters<Paths.CreateUserSchemaFileCollection.PathParameters> | null,
@@ -1655,7 +2401,10 @@ export interface OperationMethods {
1655
2401
  /**
1656
2402
  * updateUserSchemaFileCollection - updateUserSchemaFileCollection
1657
2403
  *
1658
- * Updates a file collection for the current user and schema
2404
+ * Update an existing file collection.
2405
+ *
2406
+ * You can update the name, parent relationships, starred status, and enabled locations/purposes.
2407
+ *
1659
2408
  */
1660
2409
  'updateUserSchemaFileCollection'(
1661
2410
  parameters?: Parameters<Paths.UpdateUserSchemaFileCollection.PathParameters> | null,
@@ -1665,7 +2414,11 @@ export interface OperationMethods {
1665
2414
  /**
1666
2415
  * deleteUserSchemaFileCollection - deleteUserSchemaFileCollection
1667
2416
  *
1668
- * Deletes a file collection for the current user and schema
2417
+ * Delete a file collection.
2418
+ *
2419
+ * **Note:** Deleting a collection does not delete the files within it.
2420
+ * Files will remain but will no longer be associated with this collection.
2421
+ *
1669
2422
  */
1670
2423
  'deleteUserSchemaFileCollection'(
1671
2424
  parameters?: Parameters<Paths.DeleteUserSchemaFileCollection.PathParameters> | null,
@@ -1675,7 +2428,11 @@ export interface OperationMethods {
1675
2428
  /**
1676
2429
  * getFilesInCollection - getFilesInCollection
1677
2430
  *
1678
- * Gets all files within a specific collection for an entity (uses schema-based taxonomy derived from entity)
2431
+ * Get all files within a specific collection for an entity.
2432
+ *
2433
+ * The schema is automatically derived from the entity. This endpoint requires
2434
+ * view permission on the parent entity to access its files.
2435
+ *
1679
2436
  */
1680
2437
  'getFilesInCollection'(
1681
2438
  parameters?: Parameters<Paths.GetFilesInCollection.PathParameters> | null,
@@ -1685,7 +2442,11 @@ export interface OperationMethods {
1685
2442
  /**
1686
2443
  * getGlobalFileCollections - getGlobalFileCollections
1687
2444
  *
1688
- * Gets all global file collections for a specific schema
2445
+ * Get all global file collections for a specific schema.
2446
+ *
2447
+ * Global collections are shared across all users in the organization for the specified schema.
2448
+ * Unlike user collections, these are visible to everyone with access to entities of that schema.
2449
+ *
1689
2450
  */
1690
2451
  'getGlobalFileCollections'(
1691
2452
  parameters?: Parameters<Paths.GetGlobalFileCollections.PathParameters> | null,
@@ -1729,6 +2490,19 @@ export interface PathsDictionary {
1729
2490
  /**
1730
2491
  * uploadFile - uploadFile
1731
2492
  *
2493
+ * **DEPRECATED** - Will be removed on **2025-06-30**. Use `POST /v2/files/upload` instead.
2494
+ *
2495
+ * ## Migration Guide
2496
+ * Replace calls to this endpoint with `uploadFileV2`:
2497
+ *
2498
+ * | v1 Parameter | v2 Parameter | Notes |
2499
+ * |--------------|--------------|-------|
2500
+ * | `file_entity_id` | `file_entity_id` | No change |
2501
+ *
2502
+ * The v2 response includes the same fields with improved structure.
2503
+ *
2504
+ * ---
2505
+ *
1732
2506
  * Create pre-signed S3 URL to upload a file to keep temporarily (one week).
1733
2507
  *
1734
2508
  * Use the saveFile operation to store file file permanently.
@@ -1744,11 +2518,26 @@ export interface PathsDictionary {
1744
2518
  /**
1745
2519
  * saveFile - saveFile
1746
2520
  *
1747
- * Create / Update a permanent File entity
2521
+ * **DEPRECATED** - Will be removed on **2025-06-30**. Use `POST /v2/files` instead.
2522
+ *
2523
+ * ## Migration Guide
2524
+ * Replace calls to this endpoint with `saveFileV2`:
2525
+ *
2526
+ * | v1 Feature | v2 Feature | Notes |
2527
+ * |------------|------------|-------|
2528
+ * | `activity_id` param | `activity_id` param | No change |
2529
+ * | `async` param | `async` param | No change |
2530
+ * | - | `fill_activity` param | New in v2 |
2531
+ * | - | `strict` param | New in v2 |
2532
+ * | - | `delete_temp_file` param | New in v2, defaults to true |
2533
+ *
2534
+ * The v2 endpoint supports additional parameters for better control over file saving behavior.
2535
+ *
2536
+ * ---
1748
2537
  *
1749
- * Makes file object permanent
2538
+ * Create / Update a permanent File entity.
1750
2539
  *
1751
- * Saves metadata to file entity
2540
+ * Makes file object permanent and saves metadata to file entity.
1752
2541
  *
1753
2542
  */
1754
2543
  'post'(
@@ -1783,7 +2572,10 @@ export interface PathsDictionary {
1783
2572
  /**
1784
2573
  * downloadFile - downloadFile
1785
2574
  *
1786
- * Generate pre-signed download S3 url for a file
2575
+ * Generate a pre-signed download URL for a file.
2576
+ *
2577
+ * The returned URL is valid for a limited time (typically 15 minutes) and can be used to download the file directly.
2578
+ *
1787
2579
  */
1788
2580
  'get'(
1789
2581
  parameters?: Parameters<Paths.DownloadFile.QueryParameters & Paths.DownloadFile.PathParameters> | null,
@@ -1795,7 +2587,10 @@ export interface PathsDictionary {
1795
2587
  /**
1796
2588
  * downloadS3File - downloadS3File
1797
2589
  *
1798
- * Generate pre-signed download S3 url for a file
2590
+ * Generate a pre-signed download URL for a file using its S3 reference.
2591
+ *
2592
+ * Use this endpoint when you have the S3 bucket and key but not the file entity ID.
2593
+ *
1799
2594
  */
1800
2595
  'post'(
1801
2596
  parameters?: Parameters<Paths.DownloadS3File.QueryParameters> | null,
@@ -1807,7 +2602,10 @@ export interface PathsDictionary {
1807
2602
  /**
1808
2603
  * downloadFiles - downloadFiles
1809
2604
  *
1810
- * Bulk generate pre-signed download S3 urls for multiple files
2605
+ * Bulk generate pre-signed download URLs for multiple files in a single request.
2606
+ *
2607
+ * This is more efficient than calling `downloadFile` multiple times when you need to download several files.
2608
+ *
1811
2609
  */
1812
2610
  'post'(
1813
2611
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -1819,55 +2617,76 @@ export interface PathsDictionary {
1819
2617
  /**
1820
2618
  * previewFile - previewFile
1821
2619
  *
1822
- * Generate thumbnail preview for a file entity
2620
+ * Generate a thumbnail preview for a file entity.
2621
+ *
2622
+ * Supported file types include images (PNG, JPEG, GIF, WebP), PDFs, and common document formats.
2623
+ * The preview is returned as an image (PNG or JPEG).
2624
+ *
2625
+ * **Tip:** Use with CookieAuth to embed previews directly in `<img>` tags.
2626
+ *
1823
2627
  */
1824
2628
  'get'(
1825
2629
  parameters?: Parameters<Paths.PreviewFile.QueryParameters & Paths.PreviewFile.PathParameters> | null,
1826
2630
  data?: any,
1827
2631
  config?: AxiosRequestConfig
1828
- ): OperationResponse<any>
2632
+ ): OperationResponse<Paths.PreviewFile.Responses.$200>
1829
2633
  }
1830
2634
  ['/v1/files:previewS3']: {
1831
2635
  /**
1832
2636
  * previewS3File - previewS3File
1833
2637
  *
1834
- * Generate thumbnail preview from an s3 reference for a file entity
2638
+ * Generate a thumbnail preview from an S3 reference.
2639
+ *
2640
+ * Use this endpoint when you have the S3 bucket and key but not the file entity ID.
2641
+ *
1835
2642
  */
1836
2643
  'post'(
1837
2644
  parameters?: Parameters<Paths.PreviewS3File.QueryParameters> | null,
1838
2645
  data?: Paths.PreviewS3File.RequestBody,
1839
2646
  config?: AxiosRequestConfig
1840
- ): OperationResponse<any>
2647
+ ): OperationResponse<Paths.PreviewS3File.Responses.$200>
1841
2648
  /**
1842
2649
  * previewS3FileGet - previewS3FileGet
1843
2650
  *
1844
- * Get thumbnail preview from an s3 reference for a file entity
2651
+ * Get a thumbnail preview from an S3 reference using query parameters.
2652
+ *
2653
+ * This GET variant is useful for embedding previews directly in `<img>` tags.
2654
+ *
1845
2655
  */
1846
2656
  'get'(
1847
2657
  parameters?: Parameters<Paths.PreviewS3FileGet.QueryParameters> | null,
1848
2658
  data?: any,
1849
2659
  config?: AxiosRequestConfig
1850
- ): OperationResponse<any>
2660
+ ): OperationResponse<Paths.PreviewS3FileGet.Responses.$200>
1851
2661
  }
1852
2662
  ['/v1/files/public/{id}/preview']: {
1853
2663
  /**
1854
2664
  * previewPublicFile - previewPublicFile
1855
2665
  *
1856
- * Generate thumbnail preview for a public file entity
2666
+ * Generate a thumbnail preview for a public file entity.
2667
+ *
2668
+ * **No authentication required.** This endpoint only works for files with `access_control: public-read`.
2669
+ *
1857
2670
  */
1858
2671
  'get'(
1859
2672
  parameters?: Parameters<Paths.PreviewPublicFile.QueryParameters & Paths.PreviewPublicFile.PathParameters> | null,
1860
2673
  data?: any,
1861
2674
  config?: AxiosRequestConfig
1862
- ): OperationResponse<any>
2675
+ ): OperationResponse<Paths.PreviewPublicFile.Responses.$200>
1863
2676
  }
1864
2677
  ['/v1/files/session']: {
1865
2678
  /**
1866
2679
  * getSession - getSession
1867
2680
  *
1868
- * Start a browser session by setting passed Authorization token in a server side cookie.
2681
+ * Start a browser session by converting a Bearer token into a server-side cookie.
2682
+ *
2683
+ * **Use case:** After calling this endpoint, you can use preview URLs directly in `<img>` tags
2684
+ * without needing to set the Authorization header manually.
1869
2685
  *
1870
- * Allows using preview urls directly in img src for private files using cookie authentication.
2686
+ * **Example flow:**
2687
+ * 1. Call this endpoint with your Bearer token: `GET /v1/files/session` with `Authorization: Bearer <token>`
2688
+ * 2. The server sets an HTTP-only cookie named `token`
2689
+ * 3. Use preview URLs directly: `<img src="https://file.sls.epilot.io/v1/files/{id}/preview" />`
1871
2690
  *
1872
2691
  */
1873
2692
  'get'(
@@ -1878,7 +2697,10 @@ export interface PathsDictionary {
1878
2697
  /**
1879
2698
  * deleteSession - deleteSession
1880
2699
  *
1881
- * End browser session by deleting token cookie
2700
+ * End a browser session by deleting the token cookie.
2701
+ *
2702
+ * Call this endpoint to log out and clear the session cookie.
2703
+ *
1882
2704
  */
1883
2705
  'delete'(
1884
2706
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -1890,7 +2712,15 @@ export interface PathsDictionary {
1890
2712
  /**
1891
2713
  * generatePublicLink - generatePublicLink
1892
2714
  *
1893
- * Generates a public link to access a private file
2715
+ * Generate a public link to share a private file externally.
2716
+ *
2717
+ * The generated link:
2718
+ * - Is permanent until explicitly revoked
2719
+ * - Includes the filename for user-friendly URLs
2720
+ * - Does not require authentication to access
2721
+ * - Redirects to a signed download URL when accessed
2722
+ *
2723
+ * **Use case:** Share invoices, contracts, or documents with external parties who don't have epilot accounts.
1894
2724
  *
1895
2725
  */
1896
2726
  'post'(
@@ -1901,7 +2731,10 @@ export interface PathsDictionary {
1901
2731
  /**
1902
2732
  * listPublicLinksForFile - listPublicLinksForFile
1903
2733
  *
1904
- * Not yet implemented; This API would fetch all the public links that are previously generated for a file
2734
+ * **Not yet implemented.**
2735
+ *
2736
+ * This endpoint will fetch all public links previously generated for a file.
2737
+ *
1905
2738
  */
1906
2739
  'get'(
1907
2740
  parameters?: Parameters<Paths.ListPublicLinksForFile.PathParameters> | null,
@@ -1913,7 +2746,12 @@ export interface PathsDictionary {
1913
2746
  /**
1914
2747
  * accessPublicLink - accessPublicLink
1915
2748
  *
1916
- * Redirects to a accessible signed url for the respective file associated to the public link
2749
+ * Access a file via its public link.
2750
+ *
2751
+ * **No authentication required.** This endpoint redirects to a signed S3 URL for downloading the file.
2752
+ *
2753
+ * The filename in the URL is for user-friendliness and SEO; the actual file is identified by the link ID.
2754
+ *
1917
2755
  */
1918
2756
  'get'(
1919
2757
  parameters?: Parameters<Paths.AccessPublicLink.QueryParameters & Paths.AccessPublicLink.PathParameters> | null,
@@ -1925,7 +2763,10 @@ export interface PathsDictionary {
1925
2763
  /**
1926
2764
  * revokePublicLink - revokePublicLink
1927
2765
  *
1928
- * Not yet implemented; This operation would revoke a given public link by ID
2766
+ * **Not yet implemented.**
2767
+ *
2768
+ * This endpoint will revoke a public link, making the file inaccessible via that link.
2769
+ *
1929
2770
  */
1930
2771
  'delete'(
1931
2772
  parameters?: Parameters<Paths.RevokePublicLink.PathParameters> | null,
@@ -1937,7 +2778,11 @@ export interface PathsDictionary {
1937
2778
  /**
1938
2779
  * verifyCustomDownloadUrl - verifyCustomDownloadUrl
1939
2780
  *
1940
- * Verify a pre-signed custom download url for a file
2781
+ * Verify that a custom download URL is valid and has not expired.
2782
+ *
2783
+ * Use this endpoint to validate custom download URLs before redirecting users.
2784
+ * Custom download URLs include a signature and expiration time for security.
2785
+ *
1941
2786
  */
1942
2787
  'post'(
1943
2788
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -1949,9 +2794,16 @@ export interface PathsDictionary {
1949
2794
  /**
1950
2795
  * uploadFilePublic - uploadFilePublic
1951
2796
  *
1952
- * Create pre-signed S3 URL to upload a file to keep temporarily (one week).
2797
+ * Create a pre-signed S3 URL for uploading a file without authentication.
1953
2798
  *
1954
- * Use the saveFileV2 operation to store file file permanently.
2799
+ * **No authentication required.** This endpoint is intended for public-facing forms and journeys
2800
+ * where end-users need to upload files without logging in.
2801
+ *
2802
+ * The uploaded file is stored temporarily (one week). Use `saveFileV2` with proper authentication
2803
+ * to store the file permanently.
2804
+ *
2805
+ * **Security note:** Files uploaded via this endpoint are temporary and require authenticated
2806
+ * access to be saved permanently.
1955
2807
  *
1956
2808
  */
1957
2809
  'post'(
@@ -1964,7 +2816,11 @@ export interface PathsDictionary {
1964
2816
  /**
1965
2817
  * getUserSchemaFileCollections - getUserSchemaFileCollections
1966
2818
  *
1967
- * Gets a list of file collections for the current user and schema
2819
+ * Get all file collections for the current user within a specific schema.
2820
+ *
2821
+ * Collections help organize files into logical groups (e.g., "Contracts", "Invoices").
2822
+ * User collections are private to the creating user.
2823
+ *
1968
2824
  */
1969
2825
  'get'(
1970
2826
  parameters?: Parameters<Paths.GetUserSchemaFileCollections.PathParameters> | null,
@@ -1974,7 +2830,10 @@ export interface PathsDictionary {
1974
2830
  /**
1975
2831
  * createUserSchemaFileCollection - createUserSchemaFileCollection
1976
2832
  *
1977
- * Creates a new file collection for the current user and schema
2833
+ * Create a new file collection for the current user within a specific schema.
2834
+ *
2835
+ * The collection will be private to the creating user and associated with the specified schema.
2836
+ *
1978
2837
  */
1979
2838
  'post'(
1980
2839
  parameters?: Parameters<Paths.CreateUserSchemaFileCollection.PathParameters> | null,
@@ -1986,7 +2845,10 @@ export interface PathsDictionary {
1986
2845
  /**
1987
2846
  * updateUserSchemaFileCollection - updateUserSchemaFileCollection
1988
2847
  *
1989
- * Updates a file collection for the current user and schema
2848
+ * Update an existing file collection.
2849
+ *
2850
+ * You can update the name, parent relationships, starred status, and enabled locations/purposes.
2851
+ *
1990
2852
  */
1991
2853
  'put'(
1992
2854
  parameters?: Parameters<Paths.UpdateUserSchemaFileCollection.PathParameters> | null,
@@ -1996,7 +2858,11 @@ export interface PathsDictionary {
1996
2858
  /**
1997
2859
  * deleteUserSchemaFileCollection - deleteUserSchemaFileCollection
1998
2860
  *
1999
- * Deletes a file collection for the current user and schema
2861
+ * Delete a file collection.
2862
+ *
2863
+ * **Note:** Deleting a collection does not delete the files within it.
2864
+ * Files will remain but will no longer be associated with this collection.
2865
+ *
2000
2866
  */
2001
2867
  'delete'(
2002
2868
  parameters?: Parameters<Paths.DeleteUserSchemaFileCollection.PathParameters> | null,
@@ -2008,7 +2874,11 @@ export interface PathsDictionary {
2008
2874
  /**
2009
2875
  * getFilesInCollection - getFilesInCollection
2010
2876
  *
2011
- * Gets all files within a specific collection for an entity (uses schema-based taxonomy derived from entity)
2877
+ * Get all files within a specific collection for an entity.
2878
+ *
2879
+ * The schema is automatically derived from the entity. This endpoint requires
2880
+ * view permission on the parent entity to access its files.
2881
+ *
2012
2882
  */
2013
2883
  'get'(
2014
2884
  parameters?: Parameters<Paths.GetFilesInCollection.PathParameters> | null,
@@ -2020,7 +2890,11 @@ export interface PathsDictionary {
2020
2890
  /**
2021
2891
  * getGlobalFileCollections - getGlobalFileCollections
2022
2892
  *
2023
- * Gets all global file collections for a specific schema
2893
+ * Get all global file collections for a specific schema.
2894
+ *
2895
+ * Global collections are shared across all users in the organization for the specified schema.
2896
+ * Unlike user collections, these are visible to everyone with access to entities of that schema.
2897
+ *
2024
2898
  */
2025
2899
  'get'(
2026
2900
  parameters?: Parameters<Paths.GetGlobalFileCollections.PathParameters> | null,