@epilot/file-client 1.21.0 → 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
  /**
@@ -327,8 +417,8 @@ declare namespace Components {
327
417
  * List of purpose slugs where the collection is enabled. If empty, enabled for all.
328
418
  * example:
329
419
  * [
330
- * "purpose:9eefcb98-93cf-4c5b-a040-f1d26d57c177",
331
- * "purpose:5c544c09-a691-43ed-a7fa-0a8b44b5b161"
420
+ * "9eefcb98-93cf-4c5b-a040-f1d26d57c177",
421
+ * "5c544c09-a691-43ed-a7fa-0a8b44b5b161"
332
422
  * ]
333
423
  */
334
424
  enabled_purposes?: string[];
@@ -824,63 +914,69 @@ declare namespace Components {
824
914
  declare namespace Paths {
825
915
  namespace AccessPublicLink {
826
916
  namespace Parameters {
827
- /**
828
- * Name of the file
829
- * example:
830
- * invoice-2023-12.pdf
831
- */
832
917
  export type Filename = string;
833
- /**
834
- * An optional cache-busting hash for the file
835
- */
836
918
  export type Hash = string;
837
- /**
838
- * Id of the publicly generated link
839
- * example:
840
- * 13d22918-36bd-4227-9ad4-2cb978788c8d
841
- */
842
919
  export type Id = string;
843
920
  }
844
921
  export interface PathParameters {
845
- id: /**
846
- * Id of the publicly generated link
847
- * example:
848
- * 13d22918-36bd-4227-9ad4-2cb978788c8d
849
- */
850
- Parameters.Id;
851
- filename: /**
852
- * Name of the file
853
- * example:
854
- * invoice-2023-12.pdf
855
- */
856
- Parameters.Filename;
922
+ id: Parameters.Id;
923
+ filename: Parameters.Filename;
857
924
  }
858
925
  export interface QueryParameters {
859
- hash?: /* An optional cache-busting hash for the file */ Parameters.Hash;
926
+ hash?: Parameters.Hash;
860
927
  }
861
928
  namespace Responses {
862
929
  export interface $302 {
863
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;
864
941
  }
865
942
  }
866
943
  namespace CreateUserSchemaFileCollection {
867
944
  namespace Parameters {
868
- /**
869
- * example:
870
- * opportunity
871
- */
872
945
  export type Slug = string;
873
946
  }
874
947
  export interface PathParameters {
875
- slug: /**
876
- * example:
877
- * opportunity
878
- */
879
- Parameters.Slug;
948
+ slug: Parameters.Slug;
880
949
  }
881
950
  export type RequestBody = /* Request body for creating a file collection */ Components.Schemas.FileCollectionCreateRequest;
882
951
  namespace Responses {
883
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;
884
980
  }
885
981
  }
886
982
  namespace DeleteFile {
@@ -912,6 +1008,42 @@ declare namespace Paths {
912
1008
  }
913
1009
  namespace Responses {
914
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;
915
1047
  }
916
1048
  }
917
1049
  namespace DeleteSession {
@@ -922,41 +1054,43 @@ declare namespace Paths {
922
1054
  }
923
1055
  namespace DeleteUserSchemaFileCollection {
924
1056
  namespace Parameters {
925
- /**
926
- * example:
927
- * documents
928
- */
929
1057
  export type CollectionSlug = string;
930
- /**
931
- * example:
932
- * opportunity
933
- */
934
1058
  export type Slug = string;
935
1059
  }
936
1060
  export interface PathParameters {
937
- slug: /**
938
- * example:
939
- * opportunity
940
- */
941
- Parameters.Slug;
942
- collectionSlug: /**
943
- * example:
944
- * documents
945
- */
946
- Parameters.CollectionSlug;
1061
+ slug: Parameters.Slug;
1062
+ collectionSlug: Parameters.CollectionSlug;
947
1063
  }
948
1064
  namespace Responses {
949
1065
  export interface $200 {
950
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;
951
1076
  export type $404 = /**
952
1077
  * A generic error returned by the API
953
1078
  * example:
954
1079
  * {
955
1080
  * "status": 404,
956
- * "error": "Not Found"
1081
+ * "error": "Not Found: File entity not found"
957
1082
  * }
958
1083
  */
959
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;
960
1094
  }
961
1095
  }
962
1096
  namespace DownloadFile {
@@ -979,11 +1113,48 @@ declare namespace Paths {
979
1113
  namespace Responses {
980
1114
  export interface $200 {
981
1115
  /**
1116
+ * Pre-signed S3 URL valid for downloading the file
982
1117
  * example:
983
1118
  * https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
984
1119
  */
985
1120
  download_url?: string; // uri
986
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;
987
1158
  }
988
1159
  }
989
1160
  namespace DownloadFiles {
@@ -991,12 +1162,43 @@ declare namespace Paths {
991
1162
  namespace Responses {
992
1163
  export type $200 = {
993
1164
  /**
1165
+ * Pre-signed S3 URL for downloading the file
994
1166
  * example:
995
1167
  * https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
996
1168
  */
997
1169
  download_url?: string; // uri
1170
+ /**
1171
+ * The file entity ID (matches the requested ID)
1172
+ */
998
1173
  file_entity_id?: string; // uuid
999
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;
1000
1202
  }
1001
1203
  }
1002
1204
  namespace DownloadS3File {
@@ -1013,11 +1215,48 @@ declare namespace Paths {
1013
1215
  namespace Responses {
1014
1216
  export interface $200 {
1015
1217
  /**
1218
+ * Pre-signed S3 URL valid for downloading the file
1016
1219
  * example:
1017
1220
  * https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
1018
1221
  */
1019
1222
  download_url?: string; // uri
1020
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;
1021
1260
  }
1022
1261
  }
1023
1262
  namespace GeneratePublicLink {
@@ -1033,10 +1272,45 @@ declare namespace Paths {
1033
1272
  }
1034
1273
  namespace Responses {
1035
1274
  /**
1036
- * example:
1037
- * 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
1038
1276
  */
1039
1277
  export type $201 = string;
1278
+ export type $401 = /**
1279
+ * A generic error returned by the API
1280
+ * example:
1281
+ * {
1282
+ * "status": 401,
1283
+ * "error": "Unauthorized: Invalid or expired token"
1284
+ * }
1285
+ */
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
+ * }
1294
+ */
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;
1040
1314
  }
1041
1315
  }
1042
1316
  namespace GetFile {
@@ -1063,16 +1337,48 @@ declare namespace Paths {
1063
1337
  }
1064
1338
  namespace Responses {
1065
1339
  export type $200 = Components.Schemas.FileEntity;
1066
- }
1067
- }
1068
- namespace GetFilesInCollection {
1069
- namespace Parameters {
1070
- /**
1340
+ export type $401 = /**
1341
+ * A generic error returned by the API
1071
1342
  * example:
1072
- * documents
1343
+ * {
1344
+ * "status": 401,
1345
+ * "error": "Unauthorized: Invalid or expired token"
1346
+ * }
1073
1347
  */
1074
- export type CollectionSlug = string;
1075
- export type Id = /**
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;
1376
+ }
1377
+ }
1378
+ namespace GetFilesInCollection {
1379
+ namespace Parameters {
1380
+ export type CollectionSlug = string;
1381
+ export type Id = /**
1076
1382
  * example:
1077
1383
  * ef7d985c-2385-44f4-9c71-ae06a52264f8
1078
1384
  */
@@ -1080,95 +1386,117 @@ declare namespace Paths {
1080
1386
  }
1081
1387
  export interface PathParameters {
1082
1388
  id: Parameters.Id;
1083
- collectionSlug: /**
1084
- * example:
1085
- * documents
1086
- */
1087
- Parameters.CollectionSlug;
1389
+ collectionSlug: Parameters.CollectionSlug;
1088
1390
  }
1089
1391
  namespace Responses {
1090
1392
  export type $200 = Components.Schemas.FileEntity[];
1091
- export interface $403 {
1092
- /**
1093
- * example:
1094
- * User must have permission to view this entity to access its files
1095
- */
1096
- error?: string;
1097
- }
1098
- export interface $404 {
1099
- /**
1100
- * example:
1101
- * Entity not found
1102
- */
1103
- error?: string;
1104
- }
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;
1105
1413
  }
1106
1414
  }
1107
1415
  namespace GetGlobalFileCollections {
1108
1416
  namespace Parameters {
1109
- /**
1110
- * example:
1111
- * order
1112
- */
1113
1417
  export type SchemaSlug = string;
1114
1418
  }
1115
1419
  export interface PathParameters {
1116
- schemaSlug: /**
1117
- * example:
1118
- * order
1119
- */
1120
- Parameters.SchemaSlug;
1420
+ schemaSlug: Parameters.SchemaSlug;
1121
1421
  }
1122
1422
  namespace Responses {
1123
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;
1124
1442
  }
1125
1443
  }
1126
1444
  namespace GetSession {
1127
1445
  namespace Responses {
1128
1446
  export interface $200 {
1129
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;
1130
1457
  }
1131
1458
  }
1132
1459
  namespace GetUserSchemaFileCollections {
1133
1460
  namespace Parameters {
1134
- /**
1135
- * example:
1136
- * opportunity
1137
- */
1138
1461
  export type Slug = string;
1139
1462
  }
1140
1463
  export interface PathParameters {
1141
- slug: /**
1142
- * example:
1143
- * opportunity
1144
- */
1145
- Parameters.Slug;
1464
+ slug: Parameters.Slug;
1146
1465
  }
1147
1466
  namespace Responses {
1148
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;
1149
1486
  }
1150
1487
  }
1151
1488
  namespace ListPublicLinksForFile {
1152
1489
  namespace Parameters {
1153
- /**
1154
- * ID of the file entity
1155
- * example:
1156
- * 13d22918-36bd-4227-9ad4-2cb978788c8d
1157
- */
1158
1490
  export type Id = string;
1159
1491
  }
1160
1492
  export interface PathParameters {
1161
- id: /**
1162
- * ID of the file entity
1163
- * example:
1164
- * 13d22918-36bd-4227-9ad4-2cb978788c8d
1165
- */
1166
- Parameters.Id;
1493
+ id: Parameters.Id;
1167
1494
  }
1168
1495
  namespace Responses {
1169
1496
  export interface $200 {
1170
1497
  results?: Components.Schemas.PublicLink[];
1171
1498
  }
1499
+ export type $501 = /* A generic error returned by the API */ Components.Schemas.ErrorObject;
1172
1500
  }
1173
1501
  }
1174
1502
  namespace PreviewFile {
@@ -1190,6 +1518,36 @@ declare namespace Paths {
1190
1518
  w?: Parameters.W;
1191
1519
  h?: Parameters.H;
1192
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
+ }
1193
1551
  }
1194
1552
  namespace PreviewPublicFile {
1195
1553
  namespace Parameters {
@@ -1212,6 +1570,28 @@ declare namespace Paths {
1212
1570
  h?: Parameters.H;
1213
1571
  org_id?: Parameters.OrgId;
1214
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
+ }
1215
1595
  }
1216
1596
  namespace PreviewS3File {
1217
1597
  namespace Parameters {
@@ -1223,6 +1603,45 @@ declare namespace Paths {
1223
1603
  h?: Parameters.H;
1224
1604
  }
1225
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
+ }
1226
1645
  }
1227
1646
  namespace PreviewS3FileGet {
1228
1647
  namespace Parameters {
@@ -1237,30 +1656,57 @@ declare namespace Paths {
1237
1656
  w?: Parameters.W;
1238
1657
  h?: Parameters.H;
1239
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
+ }
1240
1698
  }
1241
1699
  namespace RevokePublicLink {
1242
1700
  namespace Parameters {
1243
- /**
1244
- * Id of the publicly generated link
1245
- * example:
1246
- * 13d22918-36bd-4227-9ad4-2cb978788c8d
1247
- */
1248
1701
  export type Id = string;
1249
1702
  }
1250
1703
  export interface PathParameters {
1251
- id: /**
1252
- * Id of the publicly generated link
1253
- * example:
1254
- * 13d22918-36bd-4227-9ad4-2cb978788c8d
1255
- */
1256
- Parameters.Id;
1704
+ id: Parameters.Id;
1257
1705
  }
1258
1706
  namespace Responses {
1259
- /**
1260
- * example:
1261
- * https://file.sls.epilot.io/v1/files/public/links/3ef5c6d9-818d-45e6-8efb-b1de59079a1c
1262
- */
1263
- export type $204 = string;
1707
+ export interface $204 {
1708
+ }
1709
+ export type $501 = /* A generic error returned by the API */ Components.Schemas.ErrorObject;
1264
1710
  }
1265
1711
  }
1266
1712
  namespace SaveFile {
@@ -1272,14 +1718,43 @@ declare namespace Paths {
1272
1718
  */
1273
1719
  Components.Schemas.ActivityId /* ulid */;
1274
1720
  export type Async = boolean;
1721
+ export type VersionOnly = boolean;
1275
1722
  }
1276
1723
  export interface QueryParameters {
1277
1724
  activity_id?: Parameters.ActivityId;
1278
1725
  async?: Parameters.Async;
1726
+ version_only?: Parameters.VersionOnly;
1279
1727
  }
1280
1728
  export type RequestBody = Components.Schemas.SaveFilePayload;
1281
1729
  namespace Responses {
1282
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;
1283
1758
  }
1284
1759
  }
1285
1760
  namespace SaveFileV2 {
@@ -1294,6 +1769,7 @@ declare namespace Paths {
1294
1769
  export type DeleteTempFile = boolean;
1295
1770
  export type FillActivity = boolean;
1296
1771
  export type Strict = boolean;
1772
+ export type VersionOnly = boolean;
1297
1773
  }
1298
1774
  export interface QueryParameters {
1299
1775
  activity_id?: Parameters.ActivityId;
@@ -1301,49 +1777,97 @@ declare namespace Paths {
1301
1777
  strict?: Parameters.Strict;
1302
1778
  async?: Parameters.Async;
1303
1779
  delete_temp_file?: Parameters.DeleteTempFile;
1780
+ version_only?: Parameters.VersionOnly;
1304
1781
  }
1305
1782
  export type RequestBody = Components.Schemas.SaveFilePayloadV2;
1306
1783
  namespace Responses {
1307
1784
  export type $200 = Components.Schemas.FileEntity;
1308
- }
1309
- }
1310
- namespace UpdateUserSchemaFileCollection {
1311
- namespace Parameters {
1312
- /**
1785
+ export type $400 = /**
1786
+ * A generic error returned by the API
1313
1787
  * example:
1314
- * documents
1788
+ * {
1789
+ * "status": 400,
1790
+ * "error": "Bad Request: filename is required"
1791
+ * }
1315
1792
  */
1316
- export type CollectionSlug = string;
1317
- /**
1793
+ Components.Responses.BadRequestError;
1794
+ export type $401 = /**
1795
+ * A generic error returned by the API
1318
1796
  * example:
1319
- * opportunity
1797
+ * {
1798
+ * "status": 401,
1799
+ * "error": "Unauthorized: Invalid or expired token"
1800
+ * }
1320
1801
  */
1321
- export type Slug = string;
1322
- }
1323
- export interface PathParameters {
1324
- slug: /**
1802
+ Components.Responses.UnauthorizedError;
1803
+ export type $404 = /**
1804
+ * A generic error returned by the API
1325
1805
  * example:
1326
- * opportunity
1806
+ * {
1807
+ * "status": 404,
1808
+ * "error": "Not Found: File entity not found"
1809
+ * }
1327
1810
  */
1328
- Parameters.Slug;
1329
- collectionSlug: /**
1811
+ Components.Responses.NotFoundError;
1812
+ export type $500 = /**
1813
+ * A generic error returned by the API
1330
1814
  * example:
1331
- * documents
1815
+ * {
1816
+ * "status": 500,
1817
+ * "error": "Internal Server Error"
1818
+ * }
1332
1819
  */
1333
- 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;
1334
1831
  }
1335
1832
  export type RequestBody = Components.Schemas.FileCollectionAttributes;
1336
1833
  namespace Responses {
1337
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;
1338
1853
  export type $404 = /**
1339
1854
  * A generic error returned by the API
1340
1855
  * example:
1341
1856
  * {
1342
1857
  * "status": 404,
1343
- * "error": "Not Found"
1858
+ * "error": "Not Found: File entity not found"
1344
1859
  * }
1345
1860
  */
1346
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;
1347
1871
  }
1348
1872
  }
1349
1873
  namespace UploadFile {
@@ -1373,6 +1897,33 @@ declare namespace Paths {
1373
1897
  */
1374
1898
  public_url?: string; // url
1375
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;
1376
1927
  }
1377
1928
  }
1378
1929
  namespace UploadFilePublic {
@@ -1381,16 +1932,36 @@ declare namespace Paths {
1381
1932
  export interface $201 {
1382
1933
  s3ref?: Components.Schemas.S3Reference;
1383
1934
  /**
1935
+ * Pre-signed URL for uploading the file via PUT request
1384
1936
  * example:
1385
1937
  * https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
1386
1938
  */
1387
1939
  upload_url?: string; // url
1388
1940
  /**
1941
+ * Error message if the upload preparation failed
1389
1942
  * example:
1390
1943
  * File entity not found
1391
1944
  */
1392
1945
  error?: string;
1393
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;
1394
1965
  }
1395
1966
  }
1396
1967
  namespace UploadFileV2 {
@@ -1407,14 +1978,71 @@ declare namespace Paths {
1407
1978
  export type RequestBody = Components.Schemas.UploadFilePayload;
1408
1979
  namespace Responses {
1409
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;
1410
2008
  }
1411
2009
  }
1412
2010
  namespace VerifyCustomDownloadUrl {
1413
2011
  export type RequestBody = Components.Schemas.VerifyCustomDownloadUrlPayload;
1414
2012
  namespace Responses {
1415
2013
  export interface $200 {
2014
+ /**
2015
+ * Whether the URL is valid and not expired
2016
+ */
1416
2017
  valid?: boolean;
1417
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;
1418
2046
  }
1419
2047
  }
1420
2048
  }
@@ -1450,6 +2078,19 @@ export interface OperationMethods {
1450
2078
  /**
1451
2079
  * uploadFile - uploadFile
1452
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
+ *
1453
2094
  * Create pre-signed S3 URL to upload a file to keep temporarily (one week).
1454
2095
  *
1455
2096
  * Use the saveFile operation to store file file permanently.
@@ -1463,11 +2104,26 @@ export interface OperationMethods {
1463
2104
  /**
1464
2105
  * saveFile - saveFile
1465
2106
  *
1466
- * Create / Update a permanent File entity
2107
+ * **DEPRECATED** - Will be removed on **2025-06-30**. Use `POST /v2/files` instead.
1467
2108
  *
1468
- * Makes file object permanent
2109
+ * ## Migration Guide
2110
+ * Replace calls to this endpoint with `saveFileV2`:
1469
2111
  *
1470
- * Saves metadata to file entity
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 |
2119
+ *
2120
+ * The v2 endpoint supports additional parameters for better control over file saving behavior.
2121
+ *
2122
+ * ---
2123
+ *
2124
+ * Create / Update a permanent File entity.
2125
+ *
2126
+ * Makes file object permanent and saves metadata to file entity.
1471
2127
  *
1472
2128
  */
1473
2129
  'saveFile'(
@@ -1498,7 +2154,10 @@ export interface OperationMethods {
1498
2154
  /**
1499
2155
  * downloadFile - downloadFile
1500
2156
  *
1501
- * 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
+ *
1502
2161
  */
1503
2162
  'downloadFile'(
1504
2163
  parameters?: Parameters<Paths.DownloadFile.QueryParameters & Paths.DownloadFile.PathParameters> | null,
@@ -1508,7 +2167,10 @@ export interface OperationMethods {
1508
2167
  /**
1509
2168
  * downloadS3File - downloadS3File
1510
2169
  *
1511
- * 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
+ *
1512
2174
  */
1513
2175
  'downloadS3File'(
1514
2176
  parameters?: Parameters<Paths.DownloadS3File.QueryParameters> | null,
@@ -1518,7 +2180,10 @@ export interface OperationMethods {
1518
2180
  /**
1519
2181
  * downloadFiles - downloadFiles
1520
2182
  *
1521
- * 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
+ *
1522
2187
  */
1523
2188
  'downloadFiles'(
1524
2189
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -1528,49 +2193,70 @@ export interface OperationMethods {
1528
2193
  /**
1529
2194
  * previewFile - previewFile
1530
2195
  *
1531
- * 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
+ *
1532
2203
  */
1533
2204
  'previewFile'(
1534
2205
  parameters?: Parameters<Paths.PreviewFile.QueryParameters & Paths.PreviewFile.PathParameters> | null,
1535
2206
  data?: any,
1536
2207
  config?: AxiosRequestConfig
1537
- ): OperationResponse<any>
2208
+ ): OperationResponse<Paths.PreviewFile.Responses.$200>
1538
2209
  /**
1539
2210
  * previewS3FileGet - previewS3FileGet
1540
2211
  *
1541
- * 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
+ *
1542
2216
  */
1543
2217
  'previewS3FileGet'(
1544
2218
  parameters?: Parameters<Paths.PreviewS3FileGet.QueryParameters> | null,
1545
2219
  data?: any,
1546
2220
  config?: AxiosRequestConfig
1547
- ): OperationResponse<any>
2221
+ ): OperationResponse<Paths.PreviewS3FileGet.Responses.$200>
1548
2222
  /**
1549
2223
  * previewS3File - previewS3File
1550
2224
  *
1551
- * 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
+ *
1552
2229
  */
1553
2230
  'previewS3File'(
1554
2231
  parameters?: Parameters<Paths.PreviewS3File.QueryParameters> | null,
1555
2232
  data?: Paths.PreviewS3File.RequestBody,
1556
2233
  config?: AxiosRequestConfig
1557
- ): OperationResponse<any>
2234
+ ): OperationResponse<Paths.PreviewS3File.Responses.$200>
1558
2235
  /**
1559
2236
  * previewPublicFile - previewPublicFile
1560
2237
  *
1561
- * 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
+ *
1562
2242
  */
1563
2243
  'previewPublicFile'(
1564
2244
  parameters?: Parameters<Paths.PreviewPublicFile.QueryParameters & Paths.PreviewPublicFile.PathParameters> | null,
1565
2245
  data?: any,
1566
2246
  config?: AxiosRequestConfig
1567
- ): OperationResponse<any>
2247
+ ): OperationResponse<Paths.PreviewPublicFile.Responses.$200>
1568
2248
  /**
1569
2249
  * getSession - getSession
1570
2250
  *
1571
- * 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.
1572
2255
  *
1573
- * 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" />`
1574
2260
  *
1575
2261
  */
1576
2262
  'getSession'(
@@ -1581,7 +2267,10 @@ export interface OperationMethods {
1581
2267
  /**
1582
2268
  * deleteSession - deleteSession
1583
2269
  *
1584
- * 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
+ *
1585
2274
  */
1586
2275
  'deleteSession'(
1587
2276
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -1591,7 +2280,10 @@ export interface OperationMethods {
1591
2280
  /**
1592
2281
  * listPublicLinksForFile - listPublicLinksForFile
1593
2282
  *
1594
- * 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
+ *
1595
2287
  */
1596
2288
  'listPublicLinksForFile'(
1597
2289
  parameters?: Parameters<Paths.ListPublicLinksForFile.PathParameters> | null,
@@ -1601,7 +2293,15 @@ export interface OperationMethods {
1601
2293
  /**
1602
2294
  * generatePublicLink - generatePublicLink
1603
2295
  *
1604
- * 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.
1605
2305
  *
1606
2306
  */
1607
2307
  'generatePublicLink'(
@@ -1612,7 +2312,12 @@ export interface OperationMethods {
1612
2312
  /**
1613
2313
  * accessPublicLink - accessPublicLink
1614
2314
  *
1615
- * 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
+ *
1616
2321
  */
1617
2322
  'accessPublicLink'(
1618
2323
  parameters?: Parameters<Paths.AccessPublicLink.QueryParameters & Paths.AccessPublicLink.PathParameters> | null,
@@ -1622,7 +2327,10 @@ export interface OperationMethods {
1622
2327
  /**
1623
2328
  * revokePublicLink - revokePublicLink
1624
2329
  *
1625
- * 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
+ *
1626
2334
  */
1627
2335
  'revokePublicLink'(
1628
2336
  parameters?: Parameters<Paths.RevokePublicLink.PathParameters> | null,
@@ -1632,7 +2340,11 @@ export interface OperationMethods {
1632
2340
  /**
1633
2341
  * verifyCustomDownloadUrl - verifyCustomDownloadUrl
1634
2342
  *
1635
- * 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
+ *
1636
2348
  */
1637
2349
  'verifyCustomDownloadUrl'(
1638
2350
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -1642,9 +2354,16 @@ export interface OperationMethods {
1642
2354
  /**
1643
2355
  * uploadFilePublic - uploadFilePublic
1644
2356
  *
1645
- * 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.
1646
2358
  *
1647
- * 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.
1648
2367
  *
1649
2368
  */
1650
2369
  'uploadFilePublic'(
@@ -1655,7 +2374,11 @@ export interface OperationMethods {
1655
2374
  /**
1656
2375
  * getUserSchemaFileCollections - getUserSchemaFileCollections
1657
2376
  *
1658
- * 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
+ *
1659
2382
  */
1660
2383
  'getUserSchemaFileCollections'(
1661
2384
  parameters?: Parameters<Paths.GetUserSchemaFileCollections.PathParameters> | null,
@@ -1665,7 +2388,10 @@ export interface OperationMethods {
1665
2388
  /**
1666
2389
  * createUserSchemaFileCollection - createUserSchemaFileCollection
1667
2390
  *
1668
- * 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
+ *
1669
2395
  */
1670
2396
  'createUserSchemaFileCollection'(
1671
2397
  parameters?: Parameters<Paths.CreateUserSchemaFileCollection.PathParameters> | null,
@@ -1675,7 +2401,10 @@ export interface OperationMethods {
1675
2401
  /**
1676
2402
  * updateUserSchemaFileCollection - updateUserSchemaFileCollection
1677
2403
  *
1678
- * 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
+ *
1679
2408
  */
1680
2409
  'updateUserSchemaFileCollection'(
1681
2410
  parameters?: Parameters<Paths.UpdateUserSchemaFileCollection.PathParameters> | null,
@@ -1685,7 +2414,11 @@ export interface OperationMethods {
1685
2414
  /**
1686
2415
  * deleteUserSchemaFileCollection - deleteUserSchemaFileCollection
1687
2416
  *
1688
- * 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
+ *
1689
2422
  */
1690
2423
  'deleteUserSchemaFileCollection'(
1691
2424
  parameters?: Parameters<Paths.DeleteUserSchemaFileCollection.PathParameters> | null,
@@ -1695,7 +2428,11 @@ export interface OperationMethods {
1695
2428
  /**
1696
2429
  * getFilesInCollection - getFilesInCollection
1697
2430
  *
1698
- * 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
+ *
1699
2436
  */
1700
2437
  'getFilesInCollection'(
1701
2438
  parameters?: Parameters<Paths.GetFilesInCollection.PathParameters> | null,
@@ -1705,7 +2442,11 @@ export interface OperationMethods {
1705
2442
  /**
1706
2443
  * getGlobalFileCollections - getGlobalFileCollections
1707
2444
  *
1708
- * 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
+ *
1709
2450
  */
1710
2451
  'getGlobalFileCollections'(
1711
2452
  parameters?: Parameters<Paths.GetGlobalFileCollections.PathParameters> | null,
@@ -1749,6 +2490,19 @@ export interface PathsDictionary {
1749
2490
  /**
1750
2491
  * uploadFile - uploadFile
1751
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
+ *
1752
2506
  * Create pre-signed S3 URL to upload a file to keep temporarily (one week).
1753
2507
  *
1754
2508
  * Use the saveFile operation to store file file permanently.
@@ -1764,11 +2518,26 @@ export interface PathsDictionary {
1764
2518
  /**
1765
2519
  * saveFile - saveFile
1766
2520
  *
1767
- * 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`:
1768
2525
  *
1769
- * Makes file object permanent
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 |
1770
2533
  *
1771
- * Saves metadata to file entity
2534
+ * The v2 endpoint supports additional parameters for better control over file saving behavior.
2535
+ *
2536
+ * ---
2537
+ *
2538
+ * Create / Update a permanent File entity.
2539
+ *
2540
+ * Makes file object permanent and saves metadata to file entity.
1772
2541
  *
1773
2542
  */
1774
2543
  'post'(
@@ -1803,7 +2572,10 @@ export interface PathsDictionary {
1803
2572
  /**
1804
2573
  * downloadFile - downloadFile
1805
2574
  *
1806
- * 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
+ *
1807
2579
  */
1808
2580
  'get'(
1809
2581
  parameters?: Parameters<Paths.DownloadFile.QueryParameters & Paths.DownloadFile.PathParameters> | null,
@@ -1815,7 +2587,10 @@ export interface PathsDictionary {
1815
2587
  /**
1816
2588
  * downloadS3File - downloadS3File
1817
2589
  *
1818
- * 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
+ *
1819
2594
  */
1820
2595
  'post'(
1821
2596
  parameters?: Parameters<Paths.DownloadS3File.QueryParameters> | null,
@@ -1827,7 +2602,10 @@ export interface PathsDictionary {
1827
2602
  /**
1828
2603
  * downloadFiles - downloadFiles
1829
2604
  *
1830
- * 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
+ *
1831
2609
  */
1832
2610
  'post'(
1833
2611
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -1839,55 +2617,76 @@ export interface PathsDictionary {
1839
2617
  /**
1840
2618
  * previewFile - previewFile
1841
2619
  *
1842
- * 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
+ *
1843
2627
  */
1844
2628
  'get'(
1845
2629
  parameters?: Parameters<Paths.PreviewFile.QueryParameters & Paths.PreviewFile.PathParameters> | null,
1846
2630
  data?: any,
1847
2631
  config?: AxiosRequestConfig
1848
- ): OperationResponse<any>
2632
+ ): OperationResponse<Paths.PreviewFile.Responses.$200>
1849
2633
  }
1850
2634
  ['/v1/files:previewS3']: {
1851
2635
  /**
1852
2636
  * previewS3File - previewS3File
1853
2637
  *
1854
- * 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
+ *
1855
2642
  */
1856
2643
  'post'(
1857
2644
  parameters?: Parameters<Paths.PreviewS3File.QueryParameters> | null,
1858
2645
  data?: Paths.PreviewS3File.RequestBody,
1859
2646
  config?: AxiosRequestConfig
1860
- ): OperationResponse<any>
2647
+ ): OperationResponse<Paths.PreviewS3File.Responses.$200>
1861
2648
  /**
1862
2649
  * previewS3FileGet - previewS3FileGet
1863
2650
  *
1864
- * 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
+ *
1865
2655
  */
1866
2656
  'get'(
1867
2657
  parameters?: Parameters<Paths.PreviewS3FileGet.QueryParameters> | null,
1868
2658
  data?: any,
1869
2659
  config?: AxiosRequestConfig
1870
- ): OperationResponse<any>
2660
+ ): OperationResponse<Paths.PreviewS3FileGet.Responses.$200>
1871
2661
  }
1872
2662
  ['/v1/files/public/{id}/preview']: {
1873
2663
  /**
1874
2664
  * previewPublicFile - previewPublicFile
1875
2665
  *
1876
- * 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
+ *
1877
2670
  */
1878
2671
  'get'(
1879
2672
  parameters?: Parameters<Paths.PreviewPublicFile.QueryParameters & Paths.PreviewPublicFile.PathParameters> | null,
1880
2673
  data?: any,
1881
2674
  config?: AxiosRequestConfig
1882
- ): OperationResponse<any>
2675
+ ): OperationResponse<Paths.PreviewPublicFile.Responses.$200>
1883
2676
  }
1884
2677
  ['/v1/files/session']: {
1885
2678
  /**
1886
2679
  * getSession - getSession
1887
2680
  *
1888
- * 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.
1889
2685
  *
1890
- * 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" />`
1891
2690
  *
1892
2691
  */
1893
2692
  'get'(
@@ -1898,7 +2697,10 @@ export interface PathsDictionary {
1898
2697
  /**
1899
2698
  * deleteSession - deleteSession
1900
2699
  *
1901
- * 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
+ *
1902
2704
  */
1903
2705
  'delete'(
1904
2706
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -1910,7 +2712,15 @@ export interface PathsDictionary {
1910
2712
  /**
1911
2713
  * generatePublicLink - generatePublicLink
1912
2714
  *
1913
- * 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.
1914
2724
  *
1915
2725
  */
1916
2726
  'post'(
@@ -1921,7 +2731,10 @@ export interface PathsDictionary {
1921
2731
  /**
1922
2732
  * listPublicLinksForFile - listPublicLinksForFile
1923
2733
  *
1924
- * 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
+ *
1925
2738
  */
1926
2739
  'get'(
1927
2740
  parameters?: Parameters<Paths.ListPublicLinksForFile.PathParameters> | null,
@@ -1933,7 +2746,12 @@ export interface PathsDictionary {
1933
2746
  /**
1934
2747
  * accessPublicLink - accessPublicLink
1935
2748
  *
1936
- * 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
+ *
1937
2755
  */
1938
2756
  'get'(
1939
2757
  parameters?: Parameters<Paths.AccessPublicLink.QueryParameters & Paths.AccessPublicLink.PathParameters> | null,
@@ -1945,7 +2763,10 @@ export interface PathsDictionary {
1945
2763
  /**
1946
2764
  * revokePublicLink - revokePublicLink
1947
2765
  *
1948
- * 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
+ *
1949
2770
  */
1950
2771
  'delete'(
1951
2772
  parameters?: Parameters<Paths.RevokePublicLink.PathParameters> | null,
@@ -1957,7 +2778,11 @@ export interface PathsDictionary {
1957
2778
  /**
1958
2779
  * verifyCustomDownloadUrl - verifyCustomDownloadUrl
1959
2780
  *
1960
- * 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
+ *
1961
2786
  */
1962
2787
  'post'(
1963
2788
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -1969,9 +2794,16 @@ export interface PathsDictionary {
1969
2794
  /**
1970
2795
  * uploadFilePublic - uploadFilePublic
1971
2796
  *
1972
- * 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.
1973
2798
  *
1974
- * 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.
1975
2807
  *
1976
2808
  */
1977
2809
  'post'(
@@ -1984,7 +2816,11 @@ export interface PathsDictionary {
1984
2816
  /**
1985
2817
  * getUserSchemaFileCollections - getUserSchemaFileCollections
1986
2818
  *
1987
- * 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
+ *
1988
2824
  */
1989
2825
  'get'(
1990
2826
  parameters?: Parameters<Paths.GetUserSchemaFileCollections.PathParameters> | null,
@@ -1994,7 +2830,10 @@ export interface PathsDictionary {
1994
2830
  /**
1995
2831
  * createUserSchemaFileCollection - createUserSchemaFileCollection
1996
2832
  *
1997
- * 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
+ *
1998
2837
  */
1999
2838
  'post'(
2000
2839
  parameters?: Parameters<Paths.CreateUserSchemaFileCollection.PathParameters> | null,
@@ -2006,7 +2845,10 @@ export interface PathsDictionary {
2006
2845
  /**
2007
2846
  * updateUserSchemaFileCollection - updateUserSchemaFileCollection
2008
2847
  *
2009
- * 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
+ *
2010
2852
  */
2011
2853
  'put'(
2012
2854
  parameters?: Parameters<Paths.UpdateUserSchemaFileCollection.PathParameters> | null,
@@ -2016,7 +2858,11 @@ export interface PathsDictionary {
2016
2858
  /**
2017
2859
  * deleteUserSchemaFileCollection - deleteUserSchemaFileCollection
2018
2860
  *
2019
- * 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
+ *
2020
2866
  */
2021
2867
  'delete'(
2022
2868
  parameters?: Parameters<Paths.DeleteUserSchemaFileCollection.PathParameters> | null,
@@ -2028,7 +2874,11 @@ export interface PathsDictionary {
2028
2874
  /**
2029
2875
  * getFilesInCollection - getFilesInCollection
2030
2876
  *
2031
- * 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
+ *
2032
2882
  */
2033
2883
  'get'(
2034
2884
  parameters?: Parameters<Paths.GetFilesInCollection.PathParameters> | null,
@@ -2040,7 +2890,11 @@ export interface PathsDictionary {
2040
2890
  /**
2041
2891
  * getGlobalFileCollections - getGlobalFileCollections
2042
2892
  *
2043
- * 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
+ *
2044
2898
  */
2045
2899
  'get'(
2046
2900
  parameters?: Parameters<Paths.GetGlobalFileCollections.PathParameters> | null,