@epilot/file-client 1.18.0 → 1.20.0

package/dist/openapi.json

@@ -2,7 +2,7 @@
   "openapi": "3.0.3",
   "info": {
     "title": "File API",
-    "version": "1.3.0",
+    "version": "1.5.0",
     "description": "Upload and manage epilot Files\n\n## Changelog\n<a href=\"changelog\">View API Changelog</a>\n"
   },
   "tags": [
@@ -31,10 +31,6 @@
       "x-displayName": "File",
       "description": "<SchemaDefinition schemaRef=\"#/components/schemas/FileEntity\" />\n"
     },
-    {
-      "name": "File Folders",
-      "description": "Folder management for organizing files within entities (deprecated - use File Collections)"
-    },
     {
       "name": "File Collections",
       "description": "Collection management for organizing files within entities"
@@ -49,7 +45,6 @@
         "Public Links",
         "Session",
         "File Collections",
-        "File Folders",
         "Deprecated"
       ]
     },
@@ -1099,344 +1094,60 @@
         }
       }
     },
-    "/v1/entity/{id}/folders": {
+    "/v1/{slug}/collections": {
       "get": {
-        "operationId": "getFileFolders",
-        "summary": "getFileFolders",
-        "deprecated": true,
-        "description": "Gets a list of folders that exist for an entity. Deprecated - use getFileCollections instead.",
-        "tags": [
-          "File Folders"
-        ],
-        "parameters": [
-          {
-            "$ref": "#/components/parameters/EntityIdPathParam"
-          },
-          {
-            "name": "parents",
-            "in": "query",
-            "description": "Optional array of parent folder slugs to filter by",
-            "required": false,
-            "schema": {
-              "type": "array",
-              "items": {
-                "type": "string"
-              }
-            },
-            "style": "form",
-            "explode": true
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "List of folders for the entity",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "type": "array",
-                  "items": {
-                    "$ref": "#/components/schemas/FileFolderItem"
-                  }
-                }
-              }
-            }
-          },
-          "404": {
-            "$ref": "#/components/responses/NotFoundError"
-          }
-        }
-      },
-      "post": {
-        "operationId": "createFileFolder",
-        "summary": "createFileFolder",
-        "deprecated": true,
-        "description": "Creates a new file folder for the specified entity. Deprecated - use createFileCollection instead.",
-        "tags": [
-          "File Folders"
-        ],
-        "parameters": [
-          {
-            "$ref": "#/components/parameters/EntityIdPathParam"
-          }
-        ],
-        "requestBody": {
-          "required": true,
-          "content": {
-            "application/json": {
-              "schema": {
-                "$ref": "#/components/schemas/FileFolderCreateRequest"
-              }
-            }
-          }
-        },
-        "responses": {
-          "201": {
-            "description": "File folder created successfully",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/FileFolderItem"
-                }
-              }
-            }
-          },
-          "404": {
-            "$ref": "#/components/responses/NotFoundError"
-          }
-        }
-      }
-    },
-    "/v1/entity/{id}/folders/{folderSlug}": {
-      "put": {
-        "operationId": "updateFileFolder",
-        "summary": "updateFileFolder",
-        "deprecated": true,
-        "description": "Updates a specific file folder by slug. Deprecated - use updateFileCollection instead.",
+        "operationId": "getUserSchemaFileCollections",
+        "summary": "getUserSchemaFileCollections",
+        "description": "Gets a list of file collections for the current user and schema",
         "tags": [
-          "File Folders"
-        ],
-        "parameters": [
-          {
-            "$ref": "#/components/parameters/EntityIdPathParam"
-          },
-          {
-            "name": "folderSlug",
-            "in": "path",
-            "required": true,
-            "description": "The slug identifier for the folder",
-            "schema": {
-              "type": "string",
-              "example": "documents"
-            }
-          }
-        ],
-        "requestBody": {
-          "required": true,
-          "content": {
-            "application/json": {
-              "schema": {
-                "$ref": "#/components/schemas/FileFolderAttributes"
-              }
-            }
-          }
-        },
-        "responses": {
-          "200": {
-            "description": "File folder updated successfully",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/FileFolderItem"
-                }
-              }
-            }
-          },
-          "404": {
-            "$ref": "#/components/responses/NotFoundError"
-          }
-        }
-      },
-      "delete": {
-        "operationId": "deleteFileFolder",
-        "summary": "deleteFileFolder",
-        "deprecated": true,
-        "description": "Deletes a specific file folder by slug. Deprecated - use deleteFileCollection instead.",
-        "tags": [
-          "File Folders"
-        ],
-        "parameters": [
-          {
-            "$ref": "#/components/parameters/EntityIdPathParam"
-          },
-          {
-            "name": "folderSlug",
-            "in": "path",
-            "required": true,
-            "description": "The slug identifier for the folder",
-            "schema": {
-              "type": "string",
-              "example": "documents"
-            }
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "File folder deleted successfully"
-          },
-          "404": {
-            "$ref": "#/components/responses/NotFoundError"
-          }
-        }
-      }
-    },
-    "/v1/entity/{id}/folders/{folderSlug}/files": {
-      "get": {
-        "operationId": "getFilesInFolder",
-        "summary": "getFilesInFolder",
-        "deprecated": true,
-        "description": "Gets all files within a specific folder for an entity. Deprecated - use getFilesInCollection instead.",
-        "tags": [
-          "File Folders"
+          "File Collections"
         ],
         "parameters": [
           {
-            "$ref": "#/components/parameters/EntityIdPathParam"
-          },
-          {
-            "name": "folderSlug",
+            "name": "slug",
             "in": "path",
             "required": true,
-            "description": "The slug identifier for the folder",
+            "description": "The schema slug (e.g., order, opportunity)",
             "schema": {
               "type": "string",
-              "example": "documents"
+              "example": "opportunity"
             }
           }
         ],
         "responses": {
           "200": {
-            "description": "List of files in the folder",
+            "description": "List of collections for the user and schema",
             "content": {
               "application/json": {
                 "schema": {
                   "type": "array",
                   "items": {
-                    "$ref": "#/components/schemas/FileEntity"
-                  }
-                }
-              }
-            }
-          },
-          "403": {
-            "description": "User must have permission to view this entity to access its files",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "type": "object",
-                  "properties": {
-                    "error": {
-                      "type": "string",
-                      "example": "User must have permission to view this entity to access its files"
-                    }
-                  }
-                }
-              }
-            }
-          },
-          "404": {
-            "description": "Entity or folder not found",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "type": "object",
-                  "properties": {
-                    "error": {
-                      "type": "string",
-                      "example": "Entity not found"
-                    }
+                    "$ref": "#/components/schemas/FileCollectionItem"
                   }
                 }
               }
             }
           }
         }
-      }
-    },
-    "/v1/folders/{schemaSlug}": {
-      "get": {
-        "operationId": "getGlobalFileFolders",
-        "summary": "getGlobalFileFolders",
-        "deprecated": true,
-        "description": "Gets all global file folders for a specific schema. Deprecated - use getGlobalFileCollections instead.",
+      },
+      "post": {
+        "operationId": "createUserSchemaFileCollection",
+        "summary": "createUserSchemaFileCollection",
+        "description": "Creates a new file collection for the current user and schema",
         "tags": [
-          "File Folders"
+          "File Collections"
         ],
         "parameters": [
           {
-            "name": "schemaSlug",
+            "name": "slug",
             "in": "path",
             "required": true,
             "description": "The schema slug (e.g., order, opportunity)",
             "schema": {
               "type": "string",
-              "example": "order"
-            }
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "List of global folders for the schema",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "type": "array",
-                  "items": {
-                    "$ref": "#/components/schemas/FileFolderItem"
-                  }
-                }
-              }
+              "example": "opportunity"
             }
           }
-        }
-      }
-    },
-    "/v1/entity/{id}/collections": {
-      "get": {
-        "operationId": "getFileCollections",
-        "summary": "getFileCollections",
-        "description": "Gets a list of collections that exist for an entity",
-        "tags": [
-          "File Collections"
-        ],
-        "parameters": [
-          {
-            "$ref": "#/components/parameters/EntityIdPathParam"
-          },
-          {
-            "name": "parents",
-            "in": "query",
-            "description": "Optional array of parent collection slugs to filter by",
-            "required": false,
-            "schema": {
-              "type": "array",
-              "items": {
-                "type": "string"
-              }
-            },
-            "style": "form",
-            "explode": true
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "List of collections for the entity",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "type": "array",
-                  "items": {
-                    "$ref": "#/components/schemas/FileCollectionItem"
-                  }
-                }
-              }
-            }
-          },
-          "404": {
-            "$ref": "#/components/responses/NotFoundError"
-          }
-        }
-      },
-      "post": {
-        "operationId": "createFileCollection",
-        "summary": "createFileCollection",
-        "description": "Creates a new file collection for the specified entity",
-        "tags": [
-          "File Collections"
-        ],
-        "parameters": [
-          {
-            "$ref": "#/components/parameters/EntityIdPathParam"
-          }
         ],
         "requestBody": {
           "required": true,
@@ -1458,24 +1169,28 @@
                 }
               }
             }
-          },
-          "404": {
-            "$ref": "#/components/responses/NotFoundError"
           }
         }
       }
     },
-    "/v1/entity/{id}/collections/{collectionSlug}": {
+    "/v1/{slug}/collections/{collectionSlug}": {
       "put": {
-        "operationId": "updateFileCollection",
-        "summary": "updateFileCollection",
-        "description": "Updates a specific file collection by slug",
+        "operationId": "updateUserSchemaFileCollection",
+        "summary": "updateUserSchemaFileCollection",
+        "description": "Updates a file collection for the current user and schema",
         "tags": [
           "File Collections"
         ],
         "parameters": [
           {
-            "$ref": "#/components/parameters/EntityIdPathParam"
+            "name": "slug",
+            "in": "path",
+            "required": true,
+            "description": "The schema slug (e.g., order, opportunity)",
+            "schema": {
+              "type": "string",
+              "example": "opportunity"
+            }
           },
           {
             "name": "collectionSlug",
@@ -1515,15 +1230,22 @@
         }
       },
       "delete": {
-        "operationId": "deleteFileCollection",
-        "summary": "deleteFileCollection",
-        "description": "Deletes a specific file collection by slug",
+        "operationId": "deleteUserSchemaFileCollection",
+        "summary": "deleteUserSchemaFileCollection",
+        "description": "Deletes a file collection for the current user and schema",
         "tags": [
           "File Collections"
         ],
         "parameters": [
           {
-            "$ref": "#/components/parameters/EntityIdPathParam"
+            "name": "slug",
+            "in": "path",
+            "required": true,
+            "description": "The schema slug (e.g., order, opportunity)",
+            "schema": {
+              "type": "string",
+              "example": "opportunity"
+            }
           },
           {
             "name": "collectionSlug",
@@ -1550,7 +1272,7 @@
       "get": {
         "operationId": "getFilesInCollection",
         "summary": "getFilesInCollection",
-        "description": "Gets all files within a specific collection for an entity",
+        "description": "Gets all files within a specific collection for an entity (uses schema-based taxonomy derived from entity)",
         "tags": [
           "File Collections"
         ],
@@ -2230,65 +1952,6 @@
           }
         }
       },
-      "FileFolderId": {
-        "description": "Generated uuid for a file folder",
-        "type": "string",
-        "format": "uuid"
-      },
-      "FileFolderItem": {
-        "description": "A file folder with identifiers and timestamps",
-        "type": "object",
-        "properties": {
-          "slug": {
-            "type": "string",
-            "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",
-            "example": "_system_files_collection_3fa85f64-5717-4562-b3fc-2c963f66afa6_10234:documents"
-          },
-          "name": {
-            "type": "string",
-            "description": "Display name of the folder",
-            "example": "Documents"
-          },
-          "id": {
-            "$ref": "#/components/schemas/FileFolderId"
-          },
-          "parents": {
-            "type": "array",
-            "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",
-            "items": {
-              "type": "string"
-            },
-            "example": [
-              "_system_files_collection_3fa85f64-5717-4562-b3fc-2c963f66afa6_10234"
-            ]
-          },
-          "starred": {
-            "type": "boolean",
-            "description": "Whether the folder is starred / favorited",
-            "example": false
-          },
-          "order": {
-            "type": "number",
-            "description": "Display order for the folder",
-            "example": 0
-          },
-          "created_at": {
-            "type": "string",
-            "format": "date-time",
-            "description": "Timestamp when the folder was created",
-            "example": "2024-01-01T12:00:00Z"
-          },
-          "updated_at": {
-            "type": "string",
-            "format": "date-time",
-            "description": "Timestamp when the folder was last updated",
-            "example": "2024-01-02T12:00:00Z"
-          }
-        },
-        "required": [
-          "name"
-        ]
-      },
       "ErrorObject": {
         "description": "A generic error returned by the API",
         "type": "object",
@@ -2305,41 +1968,6 @@
           }
         }
       },
-      "FileFolderAttributes": {
-        "type": "object",
-        "properties": {
-          "name": {
-            "type": "string",
-            "description": "Name of the folder"
-          },
-          "parents": {
-            "type": "array",
-            "description": "Array of parent folder slugs, empty array if top-level folder",
-            "items": {
-              "type": "string"
-            }
-          },
-          "starred": {
-            "type": "boolean",
-            "description": "Whether the folder is starred / favorited",
-            "default": false
-          }
-        }
-      },
-      "FileFolderCreateRequest": {
-        "description": "Request body for creating a file folder",
-        "allOf": [
-          {
-            "$ref": "#/components/schemas/FileFolderAttributes"
-          },
-          {
-            "type": "object",
-            "required": [
-              "name"
-            ]
-          }
-        ]
-      },
       "FileCollectionId": {
         "description": "Generated uuid for a file collection",
         "type": "string",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/file-client",
-  "version": "1.18.0",
+  "version": "1.20.0",
   "description": "Client library for the epilot File API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",