@epilot/file-client 1.19.0 → 1.20.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/dist/definition.js +1 -1
  2. package/dist/openapi-runtime.json +0 -177
  3. package/dist/openapi.d.ts +0 -615
  4. package/dist/openapi.json +1 -551
  5. package/package.json +1 -1
package/dist/openapi.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
4
  "title": "File API",
5
- "version": "1.4.0",
5
+ "version": "1.5.0",
6
6
  "description": "Upload and manage epilot Files\n\n## Changelog\n<a href=\"changelog\">View API Changelog</a>\n"
7
7
  },
8
8
  "tags": [
@@ -31,10 +31,6 @@
31
31
  "x-displayName": "File",
32
32
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/FileEntity\" />\n"
33
33
  },
34
- {
35
- "name": "File Folders",
36
- "description": "Folder management for organizing files within entities (deprecated - use File Collections)"
37
- },
38
34
  {
39
35
  "name": "File Collections",
40
36
  "description": "Collection management for organizing files within entities"
@@ -49,7 +45,6 @@
49
45
  "Public Links",
50
46
  "Session",
51
47
  "File Collections",
52
- "File Folders",
53
48
  "Deprecated"
54
49
  ]
55
50
  },
@@ -1099,457 +1094,6 @@
1099
1094
  }
1100
1095
  }
1101
1096
  },
1102
- "/v1/entity/{id}/folders": {
1103
- "get": {
1104
- "operationId": "getFileFolders",
1105
- "summary": "getFileFolders",
1106
- "deprecated": true,
1107
- "description": "Gets a list of folders that exist for an entity. Deprecated - use getFileCollections instead.",
1108
- "tags": [
1109
- "File Folders"
1110
- ],
1111
- "parameters": [
1112
- {
1113
- "$ref": "#/components/parameters/EntityIdPathParam"
1114
- },
1115
- {
1116
- "name": "parents",
1117
- "in": "query",
1118
- "description": "Optional array of parent folder slugs to filter by",
1119
- "required": false,
1120
- "schema": {
1121
- "type": "array",
1122
- "items": {
1123
- "type": "string"
1124
- }
1125
- },
1126
- "style": "form",
1127
- "explode": true
1128
- }
1129
- ],
1130
- "responses": {
1131
- "200": {
1132
- "description": "List of folders for the entity",
1133
- "content": {
1134
- "application/json": {
1135
- "schema": {
1136
- "type": "array",
1137
- "items": {
1138
- "$ref": "#/components/schemas/FileFolderItem"
1139
- }
1140
- }
1141
- }
1142
- }
1143
- },
1144
- "404": {
1145
- "$ref": "#/components/responses/NotFoundError"
1146
- }
1147
- }
1148
- },
1149
- "post": {
1150
- "operationId": "createFileFolder",
1151
- "summary": "createFileFolder",
1152
- "deprecated": true,
1153
- "description": "Creates a new file folder for the specified entity. Deprecated - use createFileCollection instead.",
1154
- "tags": [
1155
- "File Folders"
1156
- ],
1157
- "parameters": [
1158
- {
1159
- "$ref": "#/components/parameters/EntityIdPathParam"
1160
- }
1161
- ],
1162
- "requestBody": {
1163
- "required": true,
1164
- "content": {
1165
- "application/json": {
1166
- "schema": {
1167
- "$ref": "#/components/schemas/FileFolderCreateRequest"
1168
- }
1169
- }
1170
- }
1171
- },
1172
- "responses": {
1173
- "201": {
1174
- "description": "File folder created successfully",
1175
- "content": {
1176
- "application/json": {
1177
- "schema": {
1178
- "$ref": "#/components/schemas/FileFolderItem"
1179
- }
1180
- }
1181
- }
1182
- },
1183
- "404": {
1184
- "$ref": "#/components/responses/NotFoundError"
1185
- }
1186
- }
1187
- }
1188
- },
1189
- "/v1/entity/{id}/folders/{folderSlug}": {
1190
- "put": {
1191
- "operationId": "updateFileFolder",
1192
- "summary": "updateFileFolder",
1193
- "deprecated": true,
1194
- "description": "Updates a specific file folder by slug. Deprecated - use updateFileCollection instead.",
1195
- "tags": [
1196
- "File Folders"
1197
- ],
1198
- "parameters": [
1199
- {
1200
- "$ref": "#/components/parameters/EntityIdPathParam"
1201
- },
1202
- {
1203
- "name": "folderSlug",
1204
- "in": "path",
1205
- "required": true,
1206
- "description": "The slug identifier for the folder",
1207
- "schema": {
1208
- "type": "string",
1209
- "example": "documents"
1210
- }
1211
- }
1212
- ],
1213
- "requestBody": {
1214
- "required": true,
1215
- "content": {
1216
- "application/json": {
1217
- "schema": {
1218
- "$ref": "#/components/schemas/FileFolderAttributes"
1219
- }
1220
- }
1221
- }
1222
- },
1223
- "responses": {
1224
- "200": {
1225
- "description": "File folder updated successfully",
1226
- "content": {
1227
- "application/json": {
1228
- "schema": {
1229
- "$ref": "#/components/schemas/FileFolderItem"
1230
- }
1231
- }
1232
- }
1233
- },
1234
- "404": {
1235
- "$ref": "#/components/responses/NotFoundError"
1236
- }
1237
- }
1238
- },
1239
- "delete": {
1240
- "operationId": "deleteFileFolder",
1241
- "summary": "deleteFileFolder",
1242
- "deprecated": true,
1243
- "description": "Deletes a specific file folder by slug. Deprecated - use deleteFileCollection instead.",
1244
- "tags": [
1245
- "File Folders"
1246
- ],
1247
- "parameters": [
1248
- {
1249
- "$ref": "#/components/parameters/EntityIdPathParam"
1250
- },
1251
- {
1252
- "name": "folderSlug",
1253
- "in": "path",
1254
- "required": true,
1255
- "description": "The slug identifier for the folder",
1256
- "schema": {
1257
- "type": "string",
1258
- "example": "documents"
1259
- }
1260
- }
1261
- ],
1262
- "responses": {
1263
- "200": {
1264
- "description": "File folder deleted successfully"
1265
- },
1266
- "404": {
1267
- "$ref": "#/components/responses/NotFoundError"
1268
- }
1269
- }
1270
- }
1271
- },
1272
- "/v1/entity/{id}/folders/{folderSlug}/files": {
1273
- "get": {
1274
- "operationId": "getFilesInFolder",
1275
- "summary": "getFilesInFolder",
1276
- "deprecated": true,
1277
- "description": "Gets all files within a specific folder for an entity. Deprecated - use getFilesInCollection instead.",
1278
- "tags": [
1279
- "File Folders"
1280
- ],
1281
- "parameters": [
1282
- {
1283
- "$ref": "#/components/parameters/EntityIdPathParam"
1284
- },
1285
- {
1286
- "name": "folderSlug",
1287
- "in": "path",
1288
- "required": true,
1289
- "description": "The slug identifier for the folder",
1290
- "schema": {
1291
- "type": "string",
1292
- "example": "documents"
1293
- }
1294
- }
1295
- ],
1296
- "responses": {
1297
- "200": {
1298
- "description": "List of files in the folder",
1299
- "content": {
1300
- "application/json": {
1301
- "schema": {
1302
- "type": "array",
1303
- "items": {
1304
- "$ref": "#/components/schemas/FileEntity"
1305
- }
1306
- }
1307
- }
1308
- }
1309
- },
1310
- "403": {
1311
- "description": "User must have permission to view this entity to access its files",
1312
- "content": {
1313
- "application/json": {
1314
- "schema": {
1315
- "type": "object",
1316
- "properties": {
1317
- "error": {
1318
- "type": "string",
1319
- "example": "User must have permission to view this entity to access its files"
1320
- }
1321
- }
1322
- }
1323
- }
1324
- }
1325
- },
1326
- "404": {
1327
- "description": "Entity or folder not found",
1328
- "content": {
1329
- "application/json": {
1330
- "schema": {
1331
- "type": "object",
1332
- "properties": {
1333
- "error": {
1334
- "type": "string",
1335
- "example": "Entity not found"
1336
- }
1337
- }
1338
- }
1339
- }
1340
- }
1341
- }
1342
- }
1343
- }
1344
- },
1345
- "/v1/folders/{schemaSlug}": {
1346
- "get": {
1347
- "operationId": "getGlobalFileFolders",
1348
- "summary": "getGlobalFileFolders",
1349
- "deprecated": true,
1350
- "description": "Gets all global file folders for a specific schema. Deprecated - use getGlobalFileCollections instead.",
1351
- "tags": [
1352
- "File Folders"
1353
- ],
1354
- "parameters": [
1355
- {
1356
- "name": "schemaSlug",
1357
- "in": "path",
1358
- "required": true,
1359
- "description": "The schema slug (e.g., order, opportunity)",
1360
- "schema": {
1361
- "type": "string",
1362
- "example": "order"
1363
- }
1364
- }
1365
- ],
1366
- "responses": {
1367
- "200": {
1368
- "description": "List of global folders for the schema",
1369
- "content": {
1370
- "application/json": {
1371
- "schema": {
1372
- "type": "array",
1373
- "items": {
1374
- "$ref": "#/components/schemas/FileFolderItem"
1375
- }
1376
- }
1377
- }
1378
- }
1379
- }
1380
- }
1381
- }
1382
- },
1383
- "/v1/entity/{id}/collections": {
1384
- "get": {
1385
- "operationId": "getFileCollections",
1386
- "summary": "getFileCollections",
1387
- "description": "Gets a list of collections that exist for an entity",
1388
- "deprecated": true,
1389
- "tags": [
1390
- "File Collections"
1391
- ],
1392
- "parameters": [
1393
- {
1394
- "$ref": "#/components/parameters/EntityIdPathParam"
1395
- },
1396
- {
1397
- "name": "parents",
1398
- "in": "query",
1399
- "description": "Optional array of parent collection slugs to filter by",
1400
- "required": false,
1401
- "schema": {
1402
- "type": "array",
1403
- "items": {
1404
- "type": "string"
1405
- }
1406
- },
1407
- "style": "form",
1408
- "explode": true
1409
- }
1410
- ],
1411
- "responses": {
1412
- "200": {
1413
- "description": "List of collections for the entity",
1414
- "content": {
1415
- "application/json": {
1416
- "schema": {
1417
- "type": "array",
1418
- "items": {
1419
- "$ref": "#/components/schemas/FileCollectionItem"
1420
- }
1421
- }
1422
- }
1423
- }
1424
- },
1425
- "404": {
1426
- "$ref": "#/components/responses/NotFoundError"
1427
- }
1428
- }
1429
- },
1430
- "post": {
1431
- "operationId": "createFileCollection",
1432
- "summary": "createFileCollection",
1433
- "description": "Creates a new file collection for the specified entity",
1434
- "deprecated": true,
1435
- "tags": [
1436
- "File Collections"
1437
- ],
1438
- "parameters": [
1439
- {
1440
- "$ref": "#/components/parameters/EntityIdPathParam"
1441
- }
1442
- ],
1443
- "requestBody": {
1444
- "required": true,
1445
- "content": {
1446
- "application/json": {
1447
- "schema": {
1448
- "$ref": "#/components/schemas/FileCollectionCreateRequest"
1449
- }
1450
- }
1451
- }
1452
- },
1453
- "responses": {
1454
- "201": {
1455
- "description": "File collection created successfully",
1456
- "content": {
1457
- "application/json": {
1458
- "schema": {
1459
- "$ref": "#/components/schemas/FileCollectionItem"
1460
- }
1461
- }
1462
- }
1463
- },
1464
- "404": {
1465
- "$ref": "#/components/responses/NotFoundError"
1466
- }
1467
- }
1468
- }
1469
- },
1470
- "/v1/entity/{id}/collections/{collectionSlug}": {
1471
- "put": {
1472
- "operationId": "updateFileCollection",
1473
- "summary": "updateFileCollection",
1474
- "description": "Updates a file collection for the specified entity",
1475
- "deprecated": true,
1476
- "tags": [
1477
- "File Collections"
1478
- ],
1479
- "parameters": [
1480
- {
1481
- "$ref": "#/components/parameters/EntityIdPathParam"
1482
- },
1483
- {
1484
- "name": "collectionSlug",
1485
- "in": "path",
1486
- "required": true,
1487
- "description": "The slug identifier for the collection",
1488
- "schema": {
1489
- "type": "string",
1490
- "example": "documents"
1491
- }
1492
- }
1493
- ],
1494
- "requestBody": {
1495
- "required": true,
1496
- "content": {
1497
- "application/json": {
1498
- "schema": {
1499
- "$ref": "#/components/schemas/FileCollectionAttributes"
1500
- }
1501
- }
1502
- }
1503
- },
1504
- "responses": {
1505
- "200": {
1506
- "description": "File collection updated successfully",
1507
- "content": {
1508
- "application/json": {
1509
- "schema": {
1510
- "$ref": "#/components/schemas/FileCollectionItem"
1511
- }
1512
- }
1513
- }
1514
- },
1515
- "404": {
1516
- "$ref": "#/components/responses/NotFoundError"
1517
- }
1518
- }
1519
- },
1520
- "delete": {
1521
- "operationId": "deleteFileCollection",
1522
- "summary": "deleteFileCollection",
1523
- "description": "Deletes a file collection for the specified entity",
1524
- "deprecated": true,
1525
- "tags": [
1526
- "File Collections"
1527
- ],
1528
- "parameters": [
1529
- {
1530
- "$ref": "#/components/parameters/EntityIdPathParam"
1531
- },
1532
- {
1533
- "name": "collectionSlug",
1534
- "in": "path",
1535
- "required": true,
1536
- "description": "The slug identifier for the collection",
1537
- "schema": {
1538
- "type": "string",
1539
- "example": "documents"
1540
- }
1541
- }
1542
- ],
1543
- "responses": {
1544
- "200": {
1545
- "description": "File collection deleted successfully"
1546
- },
1547
- "404": {
1548
- "$ref": "#/components/responses/NotFoundError"
1549
- }
1550
- }
1551
- }
1552
- },
1553
1097
  "/v1/{slug}/collections": {
1554
1098
  "get": {
1555
1099
  "operationId": "getUserSchemaFileCollections",
@@ -2408,65 +1952,6 @@
2408
1952
  }
2409
1953
  }
2410
1954
  },
2411
- "FileFolderId": {
2412
- "description": "Generated uuid for a file folder",
2413
- "type": "string",
2414
- "format": "uuid"
2415
- },
2416
- "FileFolderItem": {
2417
- "description": "A file folder with identifiers and timestamps",
2418
- "type": "object",
2419
- "properties": {
2420
- "slug": {
2421
- "type": "string",
2422
- "description": "Full slug for the folder. Format depends on collection type:\n- User collection: `_system_files_collection_{entity_uuid}_{user_id}:{collection_name}`\n Example: `_system_files_collection_3fa85f64-5717-4562-b3fc-2c963f66afa6_10234:documents`\n- Global collection: `_system_files_collection_schema_{schema_slug}:{collection_name}`\n Example: `_system_files_collection_schema_opportunity:templates`\n",
2423
- "example": "_system_files_collection_3fa85f64-5717-4562-b3fc-2c963f66afa6_10234:documents"
2424
- },
2425
- "name": {
2426
- "type": "string",
2427
- "description": "Display name of the folder",
2428
- "example": "Documents"
2429
- },
2430
- "id": {
2431
- "$ref": "#/components/schemas/FileFolderId"
2432
- },
2433
- "parents": {
2434
- "type": "array",
2435
- "description": "Array of parent folder slugs, empty array if top-level folder. Format depends on collection type:\n- User collection: `_system_files_collection_{entity_uuid}_{user_id}`\n Example: `[\"_system_files_collection_3fa85f64-5717-4562-b3fc-2c963f66afa6_10234\"]`\n- Global collection: `_system_files_collection_schema_{schema_slug}`\n Example: `[\"_system_files_collection_schema_opportunity\"]`\n",
2436
- "items": {
2437
- "type": "string"
2438
- },
2439
- "example": [
2440
- "_system_files_collection_3fa85f64-5717-4562-b3fc-2c963f66afa6_10234"
2441
- ]
2442
- },
2443
- "starred": {
2444
- "type": "boolean",
2445
- "description": "Whether the folder is starred / favorited",
2446
- "example": false
2447
- },
2448
- "order": {
2449
- "type": "number",
2450
- "description": "Display order for the folder",
2451
- "example": 0
2452
- },
2453
- "created_at": {
2454
- "type": "string",
2455
- "format": "date-time",
2456
- "description": "Timestamp when the folder was created",
2457
- "example": "2024-01-01T12:00:00Z"
2458
- },
2459
- "updated_at": {
2460
- "type": "string",
2461
- "format": "date-time",
2462
- "description": "Timestamp when the folder was last updated",
2463
- "example": "2024-01-02T12:00:00Z"
2464
- }
2465
- },
2466
- "required": [
2467
- "name"
2468
- ]
2469
- },
2470
1955
  "ErrorObject": {
2471
1956
  "description": "A generic error returned by the API",
2472
1957
  "type": "object",
@@ -2483,41 +1968,6 @@
2483
1968
  }
2484
1969
  }
2485
1970
  },
2486
- "FileFolderAttributes": {
2487
- "type": "object",
2488
- "properties": {
2489
- "name": {
2490
- "type": "string",
2491
- "description": "Name of the folder"
2492
- },
2493
- "parents": {
2494
- "type": "array",
2495
- "description": "Array of parent folder slugs, empty array if top-level folder",
2496
- "items": {
2497
- "type": "string"
2498
- }
2499
- },
2500
- "starred": {
2501
- "type": "boolean",
2502
- "description": "Whether the folder is starred / favorited",
2503
- "default": false
2504
- }
2505
- }
2506
- },
2507
- "FileFolderCreateRequest": {
2508
- "description": "Request body for creating a file folder",
2509
- "allOf": [
2510
- {
2511
- "$ref": "#/components/schemas/FileFolderAttributes"
2512
- },
2513
- {
2514
- "type": "object",
2515
- "required": [
2516
- "name"
2517
- ]
2518
- }
2519
- ]
2520
- },
2521
1971
  "FileCollectionId": {
2522
1972
  "description": "Generated uuid for a file collection",
2523
1973
  "type": "string",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/file-client",
3
- "version": "1.19.0",
3
+ "version": "1.20.0",
4
4
  "description": "Client library for the epilot File API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",