@epilot/file-client 1.17.0 → 1.19.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
@@ -100,7 +100,12 @@ declare namespace Components {
100
100
  * example:
101
101
  * ef7d985c-2385-44f4-9c71-ae06a52264f8
102
102
  */
103
- _id?: string;
103
+ _id?: /**
104
+ * if passed, adds a new version to existing file entity
105
+ * example:
106
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
107
+ */
108
+ string | string /* uuid */;
104
109
  /**
105
110
  * Deprecated, use _id instead
106
111
  */
@@ -216,6 +221,101 @@ declare namespace Components {
216
221
  */
217
222
  CustomDownloadUrl /* uri */;
218
223
  }
224
+ export interface FileCollectionAttributes {
225
+ /**
226
+ * Name of the collection
227
+ */
228
+ name?: string;
229
+ /**
230
+ * Array of parent collection slugs, empty array if top-level collection
231
+ */
232
+ parents?: string[];
233
+ /**
234
+ * Whether the collection is starred / favorited
235
+ */
236
+ starred?: boolean;
237
+ }
238
+ /**
239
+ * Request body for creating a file collection
240
+ */
241
+ export interface FileCollectionCreateRequest {
242
+ /**
243
+ * Name of the collection
244
+ */
245
+ name: string;
246
+ /**
247
+ * Array of parent collection slugs, empty array if top-level collection
248
+ */
249
+ parents?: string[];
250
+ /**
251
+ * Whether the collection is starred / favorited
252
+ */
253
+ starred?: boolean;
254
+ }
255
+ /**
256
+ * Generated uuid for a file collection
257
+ */
258
+ export type FileCollectionId = string; // uuid
259
+ /**
260
+ * A file collection with identifiers and timestamps
261
+ */
262
+ export interface FileCollectionItem {
263
+ /**
264
+ * Full slug for the collection. Format depends on collection type:
265
+ * - User collection: `_system_files_collection_{entity_uuid}_{user_id}:{collection_name}`
266
+ * Example: `_system_files_collection_3fa85f64-5717-4562-b3fc-2c963f66afa6_10234:documents`
267
+ * - Global collection: `_system_files_collection_schema_{schema_slug}:{collection_name}`
268
+ * Example: `_system_files_collection_schema_opportunity:templates`
269
+ *
270
+ * example:
271
+ * _system_files_collection_3fa85f64-5717-4562-b3fc-2c963f66afa6_10234:documents
272
+ */
273
+ slug?: string;
274
+ /**
275
+ * Display name of the collection
276
+ * example:
277
+ * Documents
278
+ */
279
+ name: string;
280
+ id?: /* Generated uuid for a file collection */ FileCollectionId /* uuid */;
281
+ /**
282
+ * Array of parent collection slugs, empty array if top-level collection. Format depends on collection type:
283
+ * - User collection: `_system_files_collection_{entity_uuid}_{user_id}`
284
+ * Example: `["_system_files_collection_3fa85f64-5717-4562-b3fc-2c963f66afa6_10234"]`
285
+ * - Global collection: `_system_files_collection_schema_{schema_slug}`
286
+ * Example: `["_system_files_collection_schema_opportunity"]`
287
+ *
288
+ * example:
289
+ * [
290
+ * "_system_files_collection_3fa85f64-5717-4562-b3fc-2c963f66afa6_10234"
291
+ * ]
292
+ */
293
+ parents?: string[];
294
+ /**
295
+ * Whether the collection is starred / favorited
296
+ * example:
297
+ * false
298
+ */
299
+ starred?: boolean;
300
+ /**
301
+ * Display order for the collection
302
+ * example:
303
+ * 0
304
+ */
305
+ order?: number;
306
+ /**
307
+ * Timestamp when the collection was created
308
+ * example:
309
+ * 2024-01-01T12:00:00Z
310
+ */
311
+ created_at?: string; // date-time
312
+ /**
313
+ * Timestamp when the collection was last updated
314
+ * example:
315
+ * 2024-01-02T12:00:00Z
316
+ */
317
+ updated_at?: string; // date-time
318
+ }
219
319
  export interface FileEntity {
220
320
  /**
221
321
  * example:
@@ -319,7 +419,11 @@ declare namespace Components {
319
419
  * example:
320
420
  * ef7d985c-2385-44f4-9c71-ae06a52264f8
321
421
  */
322
- export type FileEntityId = string;
422
+ export type FileEntityId = /**
423
+ * example:
424
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
425
+ */
426
+ string | string /* uuid */;
323
427
  export interface FileFolderAttributes {
324
428
  /**
325
429
  * Name of the folder
@@ -360,9 +464,14 @@ declare namespace Components {
360
464
  */
361
465
  export interface FileFolderItem {
362
466
  /**
363
- * Full slug for the folder
467
+ * Full slug for the folder. Format depends on collection type:
468
+ * - User collection: `_system_files_collection_{entity_uuid}_{user_id}:{collection_name}`
469
+ * Example: `_system_files_collection_3fa85f64-5717-4562-b3fc-2c963f66afa6_10234:documents`
470
+ * - Global collection: `_system_files_collection_schema_{schema_slug}:{collection_name}`
471
+ * Example: `_system_files_collection_schema_opportunity:templates`
472
+ *
364
473
  * example:
365
- * _system_files_collection_entity-123:documents
474
+ * _system_files_collection_3fa85f64-5717-4562-b3fc-2c963f66afa6_10234:documents
366
475
  */
367
476
  slug?: string;
368
477
  /**
@@ -373,10 +482,15 @@ declare namespace Components {
373
482
  name: string;
374
483
  id?: /* Generated uuid for a file folder */ FileFolderId /* uuid */;
375
484
  /**
376
- * Array of parent folder slugs, empty array if top-level folder
485
+ * Array of parent folder slugs, empty array if top-level folder. Format depends on collection type:
486
+ * - User collection: `_system_files_collection_{entity_uuid}_{user_id}`
487
+ * Example: `["_system_files_collection_3fa85f64-5717-4562-b3fc-2c963f66afa6_10234"]`
488
+ * - Global collection: `_system_files_collection_schema_{schema_slug}`
489
+ * Example: `["_system_files_collection_schema_opportunity"]`
490
+ *
377
491
  * example:
378
492
  * [
379
- * "_system_files_collection_entity-123"
493
+ * "_system_files_collection_3fa85f64-5717-4562-b3fc-2c963f66afa6_10234"
380
494
  * ]
381
495
  */
382
496
  parents?: string[];
@@ -495,7 +609,12 @@ declare namespace Components {
495
609
  * example:
496
610
  * ef7d985c-2385-44f4-9c71-ae06a52264f8
497
611
  */
498
- _id?: string;
612
+ _id?: /**
613
+ * if passed, adds a new version to existing file entity
614
+ * example:
615
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
616
+ */
617
+ string | string /* uuid */;
499
618
  /**
500
619
  * Deprecated, use _id instead
501
620
  */
@@ -569,7 +688,12 @@ declare namespace Components {
569
688
  * example:
570
689
  * ef7d985c-2385-44f4-9c71-ae06a52264f8
571
690
  */
572
- _id?: string;
691
+ _id?: /**
692
+ * if passed, adds a new version to existing file entity
693
+ * example:
694
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
695
+ */
696
+ string | string /* uuid */;
573
697
  /**
574
698
  * Deprecated, use _id instead
575
699
  */
@@ -651,7 +775,12 @@ declare namespace Components {
651
775
  * example:
652
776
  * ef7d985c-2385-44f4-9c71-ae06a52264f8
653
777
  */
654
- _id?: string;
778
+ _id?: /**
779
+ * if passed, adds a new version to existing file entity
780
+ * example:
781
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
782
+ */
783
+ string | string /* uuid */;
655
784
  /**
656
785
  * Deprecated, use _id instead
657
786
  */
@@ -800,6 +929,31 @@ declare namespace Paths {
800
929
  }
801
930
  }
802
931
  }
932
+ namespace CreateFileCollection {
933
+ namespace Parameters {
934
+ export type Id = /**
935
+ * example:
936
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
937
+ */
938
+ Components.Schemas.EntityId;
939
+ }
940
+ export interface PathParameters {
941
+ id: Parameters.Id;
942
+ }
943
+ export type RequestBody = /* Request body for creating a file collection */ Components.Schemas.FileCollectionCreateRequest;
944
+ namespace Responses {
945
+ export type $201 = /* A file collection with identifiers and timestamps */ Components.Schemas.FileCollectionItem;
946
+ export type $404 = /**
947
+ * A generic error returned by the API
948
+ * example:
949
+ * {
950
+ * "status": 404,
951
+ * "error": "Not Found"
952
+ * }
953
+ */
954
+ Components.Responses.NotFoundError;
955
+ }
956
+ }
803
957
  namespace CreateFileFolder {
804
958
  namespace Parameters {
805
959
  export type Id = /**
@@ -825,6 +979,26 @@ declare namespace Paths {
825
979
  Components.Responses.NotFoundError;
826
980
  }
827
981
  }
982
+ namespace CreateUserSchemaFileCollection {
983
+ namespace Parameters {
984
+ /**
985
+ * example:
986
+ * opportunity
987
+ */
988
+ export type Slug = string;
989
+ }
990
+ export interface PathParameters {
991
+ slug: /**
992
+ * example:
993
+ * opportunity
994
+ */
995
+ Parameters.Slug;
996
+ }
997
+ export type RequestBody = /* Request body for creating a file collection */ Components.Schemas.FileCollectionCreateRequest;
998
+ namespace Responses {
999
+ export type $201 = /* A file collection with identifiers and timestamps */ Components.Schemas.FileCollectionItem;
1000
+ }
1001
+ }
828
1002
  namespace DeleteFile {
829
1003
  namespace Parameters {
830
1004
  export type ActivityId = /**
@@ -856,6 +1030,41 @@ declare namespace Paths {
856
1030
  export type $200 = Components.Schemas.FileEntity;
857
1031
  }
858
1032
  }
1033
+ namespace DeleteFileCollection {
1034
+ namespace Parameters {
1035
+ /**
1036
+ * example:
1037
+ * documents
1038
+ */
1039
+ export type CollectionSlug = string;
1040
+ export type Id = /**
1041
+ * example:
1042
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
1043
+ */
1044
+ Components.Schemas.EntityId;
1045
+ }
1046
+ export interface PathParameters {
1047
+ id: Parameters.Id;
1048
+ collectionSlug: /**
1049
+ * example:
1050
+ * documents
1051
+ */
1052
+ Parameters.CollectionSlug;
1053
+ }
1054
+ namespace Responses {
1055
+ export interface $200 {
1056
+ }
1057
+ export type $404 = /**
1058
+ * A generic error returned by the API
1059
+ * example:
1060
+ * {
1061
+ * "status": 404,
1062
+ * "error": "Not Found"
1063
+ * }
1064
+ */
1065
+ Components.Responses.NotFoundError;
1066
+ }
1067
+ }
859
1068
  namespace DeleteFileFolder {
860
1069
  namespace Parameters {
861
1070
  /**
@@ -897,6 +1106,45 @@ declare namespace Paths {
897
1106
  }
898
1107
  }
899
1108
  }
1109
+ namespace DeleteUserSchemaFileCollection {
1110
+ namespace Parameters {
1111
+ /**
1112
+ * example:
1113
+ * documents
1114
+ */
1115
+ export type CollectionSlug = string;
1116
+ /**
1117
+ * example:
1118
+ * opportunity
1119
+ */
1120
+ export type Slug = string;
1121
+ }
1122
+ export interface PathParameters {
1123
+ slug: /**
1124
+ * example:
1125
+ * opportunity
1126
+ */
1127
+ Parameters.Slug;
1128
+ collectionSlug: /**
1129
+ * example:
1130
+ * documents
1131
+ */
1132
+ Parameters.CollectionSlug;
1133
+ }
1134
+ namespace Responses {
1135
+ export interface $200 {
1136
+ }
1137
+ export type $404 = /**
1138
+ * A generic error returned by the API
1139
+ * example:
1140
+ * {
1141
+ * "status": 404,
1142
+ * "error": "Not Found"
1143
+ * }
1144
+ */
1145
+ Components.Responses.NotFoundError;
1146
+ }
1147
+ }
900
1148
  namespace DownloadFile {
901
1149
  namespace Parameters {
902
1150
  export type Attachment = boolean;
@@ -1003,6 +1251,34 @@ declare namespace Paths {
1003
1251
  export type $200 = Components.Schemas.FileEntity;
1004
1252
  }
1005
1253
  }
1254
+ namespace GetFileCollections {
1255
+ namespace Parameters {
1256
+ export type Id = /**
1257
+ * example:
1258
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
1259
+ */
1260
+ Components.Schemas.EntityId;
1261
+ export type Parents = string[];
1262
+ }
1263
+ export interface PathParameters {
1264
+ id: Parameters.Id;
1265
+ }
1266
+ export interface QueryParameters {
1267
+ parents?: Parameters.Parents;
1268
+ }
1269
+ namespace Responses {
1270
+ export type $200 = /* A file collection with identifiers and timestamps */ Components.Schemas.FileCollectionItem[];
1271
+ export type $404 = /**
1272
+ * A generic error returned by the API
1273
+ * example:
1274
+ * {
1275
+ * "status": 404,
1276
+ * "error": "Not Found"
1277
+ * }
1278
+ */
1279
+ Components.Responses.NotFoundError;
1280
+ }
1281
+ }
1006
1282
  namespace GetFileFolders {
1007
1283
  namespace Parameters {
1008
1284
  export type Id = /**
@@ -1031,6 +1307,45 @@ declare namespace Paths {
1031
1307
  Components.Responses.NotFoundError;
1032
1308
  }
1033
1309
  }
1310
+ namespace GetFilesInCollection {
1311
+ namespace Parameters {
1312
+ /**
1313
+ * example:
1314
+ * documents
1315
+ */
1316
+ export type CollectionSlug = string;
1317
+ export type Id = /**
1318
+ * example:
1319
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
1320
+ */
1321
+ Components.Schemas.EntityId;
1322
+ }
1323
+ export interface PathParameters {
1324
+ id: Parameters.Id;
1325
+ collectionSlug: /**
1326
+ * example:
1327
+ * documents
1328
+ */
1329
+ Parameters.CollectionSlug;
1330
+ }
1331
+ namespace Responses {
1332
+ export type $200 = Components.Schemas.FileEntity[];
1333
+ export interface $403 {
1334
+ /**
1335
+ * example:
1336
+ * User must have permission to view this entity to access its files
1337
+ */
1338
+ error?: string;
1339
+ }
1340
+ export interface $404 {
1341
+ /**
1342
+ * example:
1343
+ * Entity not found
1344
+ */
1345
+ error?: string;
1346
+ }
1347
+ }
1348
+ }
1034
1349
  namespace GetFilesInFolder {
1035
1350
  namespace Parameters {
1036
1351
  /**
@@ -1070,6 +1385,25 @@ declare namespace Paths {
1070
1385
  }
1071
1386
  }
1072
1387
  }
1388
+ namespace GetGlobalFileCollections {
1389
+ namespace Parameters {
1390
+ /**
1391
+ * example:
1392
+ * order
1393
+ */
1394
+ export type SchemaSlug = string;
1395
+ }
1396
+ export interface PathParameters {
1397
+ schemaSlug: /**
1398
+ * example:
1399
+ * order
1400
+ */
1401
+ Parameters.SchemaSlug;
1402
+ }
1403
+ namespace Responses {
1404
+ export type $200 = /* A file collection with identifiers and timestamps */ Components.Schemas.FileCollectionItem[];
1405
+ }
1406
+ }
1073
1407
  namespace GetGlobalFileFolders {
1074
1408
  namespace Parameters {
1075
1409
  /**
@@ -1095,6 +1429,25 @@ declare namespace Paths {
1095
1429
  }
1096
1430
  }
1097
1431
  }
1432
+ namespace GetUserSchemaFileCollections {
1433
+ namespace Parameters {
1434
+ /**
1435
+ * example:
1436
+ * opportunity
1437
+ */
1438
+ export type Slug = string;
1439
+ }
1440
+ export interface PathParameters {
1441
+ slug: /**
1442
+ * example:
1443
+ * opportunity
1444
+ */
1445
+ Parameters.Slug;
1446
+ }
1447
+ namespace Responses {
1448
+ export type $200 = /* A file collection with identifiers and timestamps */ Components.Schemas.FileCollectionItem[];
1449
+ }
1450
+ }
1098
1451
  namespace ListPublicLinksForFile {
1099
1452
  namespace Parameters {
1100
1453
  /**
@@ -1254,6 +1607,41 @@ declare namespace Paths {
1254
1607
  export type $200 = Components.Schemas.FileEntity;
1255
1608
  }
1256
1609
  }
1610
+ namespace UpdateFileCollection {
1611
+ namespace Parameters {
1612
+ /**
1613
+ * example:
1614
+ * documents
1615
+ */
1616
+ export type CollectionSlug = string;
1617
+ export type Id = /**
1618
+ * example:
1619
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
1620
+ */
1621
+ Components.Schemas.EntityId;
1622
+ }
1623
+ export interface PathParameters {
1624
+ id: Parameters.Id;
1625
+ collectionSlug: /**
1626
+ * example:
1627
+ * documents
1628
+ */
1629
+ Parameters.CollectionSlug;
1630
+ }
1631
+ export type RequestBody = Components.Schemas.FileCollectionAttributes;
1632
+ namespace Responses {
1633
+ export type $200 = /* A file collection with identifiers and timestamps */ Components.Schemas.FileCollectionItem;
1634
+ export type $404 = /**
1635
+ * A generic error returned by the API
1636
+ * example:
1637
+ * {
1638
+ * "status": 404,
1639
+ * "error": "Not Found"
1640
+ * }
1641
+ */
1642
+ Components.Responses.NotFoundError;
1643
+ }
1644
+ }
1257
1645
  namespace UpdateFileFolder {
1258
1646
  namespace Parameters {
1259
1647
  /**
@@ -1289,6 +1677,45 @@ declare namespace Paths {
1289
1677
  Components.Responses.NotFoundError;
1290
1678
  }
1291
1679
  }
1680
+ namespace UpdateUserSchemaFileCollection {
1681
+ namespace Parameters {
1682
+ /**
1683
+ * example:
1684
+ * documents
1685
+ */
1686
+ export type CollectionSlug = string;
1687
+ /**
1688
+ * example:
1689
+ * opportunity
1690
+ */
1691
+ export type Slug = string;
1692
+ }
1693
+ export interface PathParameters {
1694
+ slug: /**
1695
+ * example:
1696
+ * opportunity
1697
+ */
1698
+ Parameters.Slug;
1699
+ collectionSlug: /**
1700
+ * example:
1701
+ * documents
1702
+ */
1703
+ Parameters.CollectionSlug;
1704
+ }
1705
+ export type RequestBody = Components.Schemas.FileCollectionAttributes;
1706
+ namespace Responses {
1707
+ export type $200 = /* A file collection with identifiers and timestamps */ Components.Schemas.FileCollectionItem;
1708
+ export type $404 = /**
1709
+ * A generic error returned by the API
1710
+ * example:
1711
+ * {
1712
+ * "status": 404,
1713
+ * "error": "Not Found"
1714
+ * }
1715
+ */
1716
+ Components.Responses.NotFoundError;
1717
+ }
1718
+ }
1292
1719
  namespace UploadFile {
1293
1720
  namespace Parameters {
1294
1721
  export type FileEntityId = /**
@@ -1598,7 +2025,7 @@ export interface OperationMethods {
1598
2025
  /**
1599
2026
  * getFileFolders - getFileFolders
1600
2027
  *
1601
- * Gets a list of folders that exist for an entity
2028
+ * Gets a list of folders that exist for an entity. Deprecated - use getFileCollections instead.
1602
2029
  */
1603
2030
  'getFileFolders'(
1604
2031
  parameters?: Parameters<Paths.GetFileFolders.QueryParameters & Paths.GetFileFolders.PathParameters> | null,
@@ -1608,7 +2035,7 @@ export interface OperationMethods {
1608
2035
  /**
1609
2036
  * createFileFolder - createFileFolder
1610
2037
  *
1611
- * Creates a new file folder for the specified entity
2038
+ * Creates a new file folder for the specified entity. Deprecated - use createFileCollection instead.
1612
2039
  */
1613
2040
  'createFileFolder'(
1614
2041
  parameters?: Parameters<Paths.CreateFileFolder.PathParameters> | null,
@@ -1618,7 +2045,7 @@ export interface OperationMethods {
1618
2045
  /**
1619
2046
  * updateFileFolder - updateFileFolder
1620
2047
  *
1621
- * Updates a specific file folder by slug
2048
+ * Updates a specific file folder by slug. Deprecated - use updateFileCollection instead.
1622
2049
  */
1623
2050
  'updateFileFolder'(
1624
2051
  parameters?: Parameters<Paths.UpdateFileFolder.PathParameters> | null,
@@ -1628,7 +2055,7 @@ export interface OperationMethods {
1628
2055
  /**
1629
2056
  * deleteFileFolder - deleteFileFolder
1630
2057
  *
1631
- * Deletes a specific file folder by slug
2058
+ * Deletes a specific file folder by slug. Deprecated - use deleteFileCollection instead.
1632
2059
  */
1633
2060
  'deleteFileFolder'(
1634
2061
  parameters?: Parameters<Paths.DeleteFileFolder.PathParameters> | null,
@@ -1638,7 +2065,7 @@ export interface OperationMethods {
1638
2065
  /**
1639
2066
  * getFilesInFolder - getFilesInFolder
1640
2067
  *
1641
- * Gets all files within a specific folder for an entity
2068
+ * Gets all files within a specific folder for an entity. Deprecated - use getFilesInCollection instead.
1642
2069
  */
1643
2070
  'getFilesInFolder'(
1644
2071
  parameters?: Parameters<Paths.GetFilesInFolder.PathParameters> | null,
@@ -1648,13 +2075,113 @@ export interface OperationMethods {
1648
2075
  /**
1649
2076
  * getGlobalFileFolders - getGlobalFileFolders
1650
2077
  *
1651
- * Gets all global file folders for a specific schema
2078
+ * Gets all global file folders for a specific schema. Deprecated - use getGlobalFileCollections instead.
1652
2079
  */
1653
2080
  'getGlobalFileFolders'(
1654
2081
  parameters?: Parameters<Paths.GetGlobalFileFolders.PathParameters> | null,
1655
2082
  data?: any,
1656
2083
  config?: AxiosRequestConfig
1657
2084
  ): OperationResponse<Paths.GetGlobalFileFolders.Responses.$200>
2085
+ /**
2086
+ * getFileCollections - getFileCollections
2087
+ *
2088
+ * Gets a list of collections that exist for an entity
2089
+ */
2090
+ 'getFileCollections'(
2091
+ parameters?: Parameters<Paths.GetFileCollections.QueryParameters & Paths.GetFileCollections.PathParameters> | null,
2092
+ data?: any,
2093
+ config?: AxiosRequestConfig
2094
+ ): OperationResponse<Paths.GetFileCollections.Responses.$200>
2095
+ /**
2096
+ * createFileCollection - createFileCollection
2097
+ *
2098
+ * Creates a new file collection for the specified entity
2099
+ */
2100
+ 'createFileCollection'(
2101
+ parameters?: Parameters<Paths.CreateFileCollection.PathParameters> | null,
2102
+ data?: Paths.CreateFileCollection.RequestBody,
2103
+ config?: AxiosRequestConfig
2104
+ ): OperationResponse<Paths.CreateFileCollection.Responses.$201>
2105
+ /**
2106
+ * updateFileCollection - updateFileCollection
2107
+ *
2108
+ * Updates a file collection for the specified entity
2109
+ */
2110
+ 'updateFileCollection'(
2111
+ parameters?: Parameters<Paths.UpdateFileCollection.PathParameters> | null,
2112
+ data?: Paths.UpdateFileCollection.RequestBody,
2113
+ config?: AxiosRequestConfig
2114
+ ): OperationResponse<Paths.UpdateFileCollection.Responses.$200>
2115
+ /**
2116
+ * deleteFileCollection - deleteFileCollection
2117
+ *
2118
+ * Deletes a file collection for the specified entity
2119
+ */
2120
+ 'deleteFileCollection'(
2121
+ parameters?: Parameters<Paths.DeleteFileCollection.PathParameters> | null,
2122
+ data?: any,
2123
+ config?: AxiosRequestConfig
2124
+ ): OperationResponse<Paths.DeleteFileCollection.Responses.$200>
2125
+ /**
2126
+ * getUserSchemaFileCollections - getUserSchemaFileCollections
2127
+ *
2128
+ * Gets a list of file collections for the current user and schema
2129
+ */
2130
+ 'getUserSchemaFileCollections'(
2131
+ parameters?: Parameters<Paths.GetUserSchemaFileCollections.PathParameters> | null,
2132
+ data?: any,
2133
+ config?: AxiosRequestConfig
2134
+ ): OperationResponse<Paths.GetUserSchemaFileCollections.Responses.$200>
2135
+ /**
2136
+ * createUserSchemaFileCollection - createUserSchemaFileCollection
2137
+ *
2138
+ * Creates a new file collection for the current user and schema
2139
+ */
2140
+ 'createUserSchemaFileCollection'(
2141
+ parameters?: Parameters<Paths.CreateUserSchemaFileCollection.PathParameters> | null,
2142
+ data?: Paths.CreateUserSchemaFileCollection.RequestBody,
2143
+ config?: AxiosRequestConfig
2144
+ ): OperationResponse<Paths.CreateUserSchemaFileCollection.Responses.$201>
2145
+ /**
2146
+ * updateUserSchemaFileCollection - updateUserSchemaFileCollection
2147
+ *
2148
+ * Updates a file collection for the current user and schema
2149
+ */
2150
+ 'updateUserSchemaFileCollection'(
2151
+ parameters?: Parameters<Paths.UpdateUserSchemaFileCollection.PathParameters> | null,
2152
+ data?: Paths.UpdateUserSchemaFileCollection.RequestBody,
2153
+ config?: AxiosRequestConfig
2154
+ ): OperationResponse<Paths.UpdateUserSchemaFileCollection.Responses.$200>
2155
+ /**
2156
+ * deleteUserSchemaFileCollection - deleteUserSchemaFileCollection
2157
+ *
2158
+ * Deletes a file collection for the current user and schema
2159
+ */
2160
+ 'deleteUserSchemaFileCollection'(
2161
+ parameters?: Parameters<Paths.DeleteUserSchemaFileCollection.PathParameters> | null,
2162
+ data?: any,
2163
+ config?: AxiosRequestConfig
2164
+ ): OperationResponse<Paths.DeleteUserSchemaFileCollection.Responses.$200>
2165
+ /**
2166
+ * getFilesInCollection - getFilesInCollection
2167
+ *
2168
+ * Gets all files within a specific collection for an entity (uses schema-based taxonomy derived from entity)
2169
+ */
2170
+ 'getFilesInCollection'(
2171
+ parameters?: Parameters<Paths.GetFilesInCollection.PathParameters> | null,
2172
+ data?: any,
2173
+ config?: AxiosRequestConfig
2174
+ ): OperationResponse<Paths.GetFilesInCollection.Responses.$200>
2175
+ /**
2176
+ * getGlobalFileCollections - getGlobalFileCollections
2177
+ *
2178
+ * Gets all global file collections for a specific schema
2179
+ */
2180
+ 'getGlobalFileCollections'(
2181
+ parameters?: Parameters<Paths.GetGlobalFileCollections.PathParameters> | null,
2182
+ data?: any,
2183
+ config?: AxiosRequestConfig
2184
+ ): OperationResponse<Paths.GetGlobalFileCollections.Responses.$200>
1658
2185
  }
1659
2186
 
1660
2187
  export interface PathsDictionary {
@@ -1927,7 +2454,7 @@ export interface PathsDictionary {
1927
2454
  /**
1928
2455
  * getFileFolders - getFileFolders
1929
2456
  *
1930
- * Gets a list of folders that exist for an entity
2457
+ * Gets a list of folders that exist for an entity. Deprecated - use getFileCollections instead.
1931
2458
  */
1932
2459
  'get'(
1933
2460
  parameters?: Parameters<Paths.GetFileFolders.QueryParameters & Paths.GetFileFolders.PathParameters> | null,
@@ -1937,7 +2464,7 @@ export interface PathsDictionary {
1937
2464
  /**
1938
2465
  * createFileFolder - createFileFolder
1939
2466
  *
1940
- * Creates a new file folder for the specified entity
2467
+ * Creates a new file folder for the specified entity. Deprecated - use createFileCollection instead.
1941
2468
  */
1942
2469
  'post'(
1943
2470
  parameters?: Parameters<Paths.CreateFileFolder.PathParameters> | null,
@@ -1949,7 +2476,7 @@ export interface PathsDictionary {
1949
2476
  /**
1950
2477
  * updateFileFolder - updateFileFolder
1951
2478
  *
1952
- * Updates a specific file folder by slug
2479
+ * Updates a specific file folder by slug. Deprecated - use updateFileCollection instead.
1953
2480
  */
1954
2481
  'put'(
1955
2482
  parameters?: Parameters<Paths.UpdateFileFolder.PathParameters> | null,
@@ -1959,7 +2486,7 @@ export interface PathsDictionary {
1959
2486
  /**
1960
2487
  * deleteFileFolder - deleteFileFolder
1961
2488
  *
1962
- * Deletes a specific file folder by slug
2489
+ * Deletes a specific file folder by slug. Deprecated - use deleteFileCollection instead.
1963
2490
  */
1964
2491
  'delete'(
1965
2492
  parameters?: Parameters<Paths.DeleteFileFolder.PathParameters> | null,
@@ -1971,7 +2498,7 @@ export interface PathsDictionary {
1971
2498
  /**
1972
2499
  * getFilesInFolder - getFilesInFolder
1973
2500
  *
1974
- * Gets all files within a specific folder for an entity
2501
+ * Gets all files within a specific folder for an entity. Deprecated - use getFilesInCollection instead.
1975
2502
  */
1976
2503
  'get'(
1977
2504
  parameters?: Parameters<Paths.GetFilesInFolder.PathParameters> | null,
@@ -1983,7 +2510,7 @@ export interface PathsDictionary {
1983
2510
  /**
1984
2511
  * getGlobalFileFolders - getGlobalFileFolders
1985
2512
  *
1986
- * Gets all global file folders for a specific schema
2513
+ * Gets all global file folders for a specific schema. Deprecated - use getGlobalFileCollections instead.
1987
2514
  */
1988
2515
  'get'(
1989
2516
  parameters?: Parameters<Paths.GetGlobalFileFolders.PathParameters> | null,
@@ -1991,6 +2518,118 @@ export interface PathsDictionary {
1991
2518
  config?: AxiosRequestConfig
1992
2519
  ): OperationResponse<Paths.GetGlobalFileFolders.Responses.$200>
1993
2520
  }
2521
+ ['/v1/entity/{id}/collections']: {
2522
+ /**
2523
+ * getFileCollections - getFileCollections
2524
+ *
2525
+ * Gets a list of collections that exist for an entity
2526
+ */
2527
+ 'get'(
2528
+ parameters?: Parameters<Paths.GetFileCollections.QueryParameters & Paths.GetFileCollections.PathParameters> | null,
2529
+ data?: any,
2530
+ config?: AxiosRequestConfig
2531
+ ): OperationResponse<Paths.GetFileCollections.Responses.$200>
2532
+ /**
2533
+ * createFileCollection - createFileCollection
2534
+ *
2535
+ * Creates a new file collection for the specified entity
2536
+ */
2537
+ 'post'(
2538
+ parameters?: Parameters<Paths.CreateFileCollection.PathParameters> | null,
2539
+ data?: Paths.CreateFileCollection.RequestBody,
2540
+ config?: AxiosRequestConfig
2541
+ ): OperationResponse<Paths.CreateFileCollection.Responses.$201>
2542
+ }
2543
+ ['/v1/entity/{id}/collections/{collectionSlug}']: {
2544
+ /**
2545
+ * updateFileCollection - updateFileCollection
2546
+ *
2547
+ * Updates a file collection for the specified entity
2548
+ */
2549
+ 'put'(
2550
+ parameters?: Parameters<Paths.UpdateFileCollection.PathParameters> | null,
2551
+ data?: Paths.UpdateFileCollection.RequestBody,
2552
+ config?: AxiosRequestConfig
2553
+ ): OperationResponse<Paths.UpdateFileCollection.Responses.$200>
2554
+ /**
2555
+ * deleteFileCollection - deleteFileCollection
2556
+ *
2557
+ * Deletes a file collection for the specified entity
2558
+ */
2559
+ 'delete'(
2560
+ parameters?: Parameters<Paths.DeleteFileCollection.PathParameters> | null,
2561
+ data?: any,
2562
+ config?: AxiosRequestConfig
2563
+ ): OperationResponse<Paths.DeleteFileCollection.Responses.$200>
2564
+ }
2565
+ ['/v1/{slug}/collections']: {
2566
+ /**
2567
+ * getUserSchemaFileCollections - getUserSchemaFileCollections
2568
+ *
2569
+ * Gets a list of file collections for the current user and schema
2570
+ */
2571
+ 'get'(
2572
+ parameters?: Parameters<Paths.GetUserSchemaFileCollections.PathParameters> | null,
2573
+ data?: any,
2574
+ config?: AxiosRequestConfig
2575
+ ): OperationResponse<Paths.GetUserSchemaFileCollections.Responses.$200>
2576
+ /**
2577
+ * createUserSchemaFileCollection - createUserSchemaFileCollection
2578
+ *
2579
+ * Creates a new file collection for the current user and schema
2580
+ */
2581
+ 'post'(
2582
+ parameters?: Parameters<Paths.CreateUserSchemaFileCollection.PathParameters> | null,
2583
+ data?: Paths.CreateUserSchemaFileCollection.RequestBody,
2584
+ config?: AxiosRequestConfig
2585
+ ): OperationResponse<Paths.CreateUserSchemaFileCollection.Responses.$201>
2586
+ }
2587
+ ['/v1/{slug}/collections/{collectionSlug}']: {
2588
+ /**
2589
+ * updateUserSchemaFileCollection - updateUserSchemaFileCollection
2590
+ *
2591
+ * Updates a file collection for the current user and schema
2592
+ */
2593
+ 'put'(
2594
+ parameters?: Parameters<Paths.UpdateUserSchemaFileCollection.PathParameters> | null,
2595
+ data?: Paths.UpdateUserSchemaFileCollection.RequestBody,
2596
+ config?: AxiosRequestConfig
2597
+ ): OperationResponse<Paths.UpdateUserSchemaFileCollection.Responses.$200>
2598
+ /**
2599
+ * deleteUserSchemaFileCollection - deleteUserSchemaFileCollection
2600
+ *
2601
+ * Deletes a file collection for the current user and schema
2602
+ */
2603
+ 'delete'(
2604
+ parameters?: Parameters<Paths.DeleteUserSchemaFileCollection.PathParameters> | null,
2605
+ data?: any,
2606
+ config?: AxiosRequestConfig
2607
+ ): OperationResponse<Paths.DeleteUserSchemaFileCollection.Responses.$200>
2608
+ }
2609
+ ['/v1/entity/{id}/collections/{collectionSlug}/files']: {
2610
+ /**
2611
+ * getFilesInCollection - getFilesInCollection
2612
+ *
2613
+ * Gets all files within a specific collection for an entity (uses schema-based taxonomy derived from entity)
2614
+ */
2615
+ 'get'(
2616
+ parameters?: Parameters<Paths.GetFilesInCollection.PathParameters> | null,
2617
+ data?: any,
2618
+ config?: AxiosRequestConfig
2619
+ ): OperationResponse<Paths.GetFilesInCollection.Responses.$200>
2620
+ }
2621
+ ['/v1/collections/{schemaSlug}']: {
2622
+ /**
2623
+ * getGlobalFileCollections - getGlobalFileCollections
2624
+ *
2625
+ * Gets all global file collections for a specific schema
2626
+ */
2627
+ 'get'(
2628
+ parameters?: Parameters<Paths.GetGlobalFileCollections.PathParameters> | null,
2629
+ data?: any,
2630
+ config?: AxiosRequestConfig
2631
+ ): OperationResponse<Paths.GetGlobalFileCollections.Responses.$200>
2632
+ }
1994
2633
  }
1995
2634
 
1996
2635
  export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
@@ -2006,6 +2645,10 @@ export type EntityId = Components.Schemas.EntityId;
2006
2645
  export type EntitySlug = Components.Schemas.EntitySlug;
2007
2646
  export type ErrorObject = Components.Schemas.ErrorObject;
2008
2647
  export type FileAttributes = Components.Schemas.FileAttributes;
2648
+ export type FileCollectionAttributes = Components.Schemas.FileCollectionAttributes;
2649
+ export type FileCollectionCreateRequest = Components.Schemas.FileCollectionCreateRequest;
2650
+ export type FileCollectionId = Components.Schemas.FileCollectionId;
2651
+ export type FileCollectionItem = Components.Schemas.FileCollectionItem;
2009
2652
  export type FileEntity = Components.Schemas.FileEntity;
2010
2653
  export type FileEntityId = Components.Schemas.FileEntityId;
2011
2654
  export type FileFolderAttributes = Components.Schemas.FileFolderAttributes;