@epilot/file-client 1.15.2 → 1.16.0-alpha.1

package/dist/definition.js

@@ -1 +1 @@
-(()=>{"use strict";var e={330:function(e,r,i){var a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var t=a(i(466));r.default=t.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"paths":{"/v2/files/upload":{"post":{"operationId":"uploadFileV2","parameters":[{"name":"file_entity_id","in":"query"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/files":{"post":{"operationId":"saveFileV2","parameters":[{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/StrictQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/DeleteTempFileQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/files/upload":{"post":{"operationId":"uploadFile","deprecated":true,"parameters":[{"name":"file_entity_id","in":"query"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/files":{"post":{"operationId":"saveFile","deprecated":true,"parameters":[{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/files/{id}":{"get":{"operationId":"getFile","parameters":[{"name":"id","in":"path","required":true},{"name":"source_url","in":"query"},{"$ref":"#/components/parameters/StrictQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"}],"responses":{}},"delete":{"operationId":"deleteFile","parameters":[{"name":"id","in":"path","required":true},{"name":"purge","in":"query"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/StrictQueryParam"}],"responses":{}}},"/v1/files/{id}/download":{"get":{"operationId":"downloadFile","parameters":[{"name":"id","in":"path","required":true},{"name":"version","in":"query"},{"name":"attachment","in":"query"}],"responses":{}}},"/v1/files:downloadS3":{"post":{"operationId":"downloadS3File","parameters":[{"name":"s3_key","in":"query","required":true},{"name":"s3_bucket","in":"query","required":true},{"name":"attachment","in":"query"}],"responses":{}}},"/v1/files:downloadFiles":{"post":{"operationId":"downloadFiles","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/files/{id}/preview":{"get":{"operationId":"previewFile","parameters":[{"name":"id","in":"path","required":true},{"name":"version","in":"query"},{"name":"w","in":"query"},{"name":"h","in":"query"}],"responses":{}}},"/v1/files:previewS3":{"post":{"operationId":"previewS3File","parameters":[{"name":"w","in":"query"},{"name":"h","in":"query"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"previewS3FileGet","parameters":[{"name":"key","in":"query","required":true},{"name":"bucket","in":"query","required":true},{"name":"w","in":"query"},{"name":"h","in":"query"}],"responses":{}}},"/v1/files/public/{id}/preview":{"get":{"operationId":"previewPublicFile","parameters":[{"name":"id","in":"path","required":true},{"name":"version","in":"query"},{"name":"w","in":"query"},{"name":"h","in":"query"},{"name":"org_id","in":"query"}],"responses":{}}},"/v1/files/session":{"get":{"operationId":"getSession","responses":{}},"delete":{"operationId":"deleteSession","responses":{}}},"/v1/files/{id}/public/links":{"post":{"operationId":"generatePublicLink","parameters":[{"name":"id","in":"path","required":true}],"responses":{}},"get":{"operationId":"listPublicLinksForFile","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/files/public/links/{id}/{filename}":{"get":{"operationId":"accessPublicLink","parameters":[{"name":"id","in":"path","required":true},{"name":"filename","in":"path","required":true},{"name":"hash","in":"query","required":false}],"responses":{}}},"/v1/files/public/links/{id}":{"delete":{"operationId":"revokePublicLink","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/files/download:verify":{"post":{"operationId":"verifyCustomDownloadUrl","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/files/public/upload":{"post":{"operationId":"uploadFilePublic","requestBody":{"content":{"application/json":{}}},"responses":{}}}},"components":{"parameters":{"StrictQueryParam":{"name":"strict","in":"query","required":false},"ActivityIdQueryParam":{"name":"activity_id","in":"query","required":false},"FillActivityQueryParam":{"name":"fill_activity","in":"query","required":false},"AsyncOperationQueryParam":{"name":"async","in":"query","required":false},"DeleteTempFileQueryParam":{"name":"delete_temp_file","in":"query","required":false}}},"servers":[{"url":"https://file.sls.epilot.io"}]}')}},r={},i=function i(a){var t=r[a];if(void 0!==t)return t.exports;var n=r[a]={exports:{}};return e[a].call(n.exports,n,n.exports,i),n.exports}(330),a=exports;for(var t in i)a[t]=i[t];i.__esModule&&Object.defineProperty(a,"__esModule",{value:!0})})();
+(()=>{"use strict";var e={466:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"paths":{"/v2/files/upload":{"post":{"operationId":"uploadFileV2","parameters":[{"name":"file_entity_id","in":"query"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/files":{"post":{"operationId":"saveFileV2","parameters":[{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/FillActivityQueryParam"},{"$ref":"#/components/parameters/StrictQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"},{"$ref":"#/components/parameters/DeleteTempFileQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/files/upload":{"post":{"operationId":"uploadFile","deprecated":true,"parameters":[{"name":"file_entity_id","in":"query"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/files":{"post":{"operationId":"saveFile","deprecated":true,"parameters":[{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/files/{id}":{"get":{"operationId":"getFile","parameters":[{"name":"id","in":"path","required":true},{"name":"source_url","in":"query"},{"$ref":"#/components/parameters/StrictQueryParam"},{"$ref":"#/components/parameters/AsyncOperationQueryParam"}],"responses":{}},"delete":{"operationId":"deleteFile","parameters":[{"name":"id","in":"path","required":true},{"name":"purge","in":"query"},{"$ref":"#/components/parameters/ActivityIdQueryParam"},{"$ref":"#/components/parameters/StrictQueryParam"}],"responses":{}}},"/v1/files/{id}/download":{"get":{"operationId":"downloadFile","parameters":[{"name":"id","in":"path","required":true},{"name":"version","in":"query"},{"name":"attachment","in":"query"}],"responses":{}}},"/v1/files:downloadS3":{"post":{"operationId":"downloadS3File","parameters":[{"name":"s3_key","in":"query","required":true},{"name":"s3_bucket","in":"query","required":true},{"name":"attachment","in":"query"}],"responses":{}}},"/v1/files:downloadFiles":{"post":{"operationId":"downloadFiles","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/files/{id}/preview":{"get":{"operationId":"previewFile","parameters":[{"name":"id","in":"path","required":true},{"name":"version","in":"query"},{"name":"w","in":"query"},{"name":"h","in":"query"}],"responses":{}}},"/v1/files:previewS3":{"post":{"operationId":"previewS3File","parameters":[{"name":"w","in":"query"},{"name":"h","in":"query"}],"requestBody":{"content":{"application/json":{}}},"responses":{}},"get":{"operationId":"previewS3FileGet","parameters":[{"name":"key","in":"query","required":true},{"name":"bucket","in":"query","required":true},{"name":"w","in":"query"},{"name":"h","in":"query"}],"responses":{}}},"/v1/files/public/{id}/preview":{"get":{"operationId":"previewPublicFile","parameters":[{"name":"id","in":"path","required":true},{"name":"version","in":"query"},{"name":"w","in":"query"},{"name":"h","in":"query"},{"name":"org_id","in":"query"}],"responses":{}}},"/v1/files/session":{"get":{"operationId":"getSession","responses":{}},"delete":{"operationId":"deleteSession","responses":{}}},"/v1/files/{id}/public/links":{"post":{"operationId":"generatePublicLink","parameters":[{"name":"id","in":"path","required":true}],"responses":{}},"get":{"operationId":"listPublicLinksForFile","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/files/public/links/{id}/{filename}":{"get":{"operationId":"accessPublicLink","parameters":[{"name":"id","in":"path","required":true},{"name":"filename","in":"path","required":true},{"name":"hash","in":"query","required":false}],"responses":{}}},"/v1/files/public/links/{id}":{"delete":{"operationId":"revokePublicLink","parameters":[{"name":"id","in":"path","required":true}],"responses":{}}},"/v1/files/download:verify":{"post":{"operationId":"verifyCustomDownloadUrl","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/files/public/upload":{"post":{"operationId":"uploadFilePublic","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{id}/folders":{"get":{"operationId":"getFileFolders","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"name":"parents","in":"query","required":false,"style":"form","explode":true}],"responses":{}},"post":{"operationId":"createFileFolder","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/entity/{id}/folders/{folderSlug}":{"put":{"operationId":"updateFileFolder","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"name":"folderSlug","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteFileFolder","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"name":"folderSlug","in":"path","required":true}],"responses":{}}},"/v1/entity/{id}/folders/{folderSlug}/files":{"get":{"operationId":"getFilesInFolder","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"name":"folderSlug","in":"path","required":true}],"responses":{}}}},"components":{"parameters":{"EntityIdPathParam":{"name":"id","in":"path","required":true},"StrictQueryParam":{"name":"strict","in":"query","required":false},"ActivityIdQueryParam":{"name":"activity_id","in":"query","required":false},"FillActivityQueryParam":{"name":"fill_activity","in":"query","required":false},"AsyncOperationQueryParam":{"name":"async","in":"query","required":false},"DeleteTempFileQueryParam":{"name":"delete_temp_file","in":"query","required":false}},"responses":{"NotFoundError":{"content":{"application/json":{}}}}},"servers":[{"url":"https://file.sls.epilot.io"}]}')},757:function(e,r,t){var a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var n=a(t(466));r.default=n.default}},r={},t=function t(a){var n=r[a];if(void 0!==n)return n.exports;var i=r[a]={exports:{}};return e[a].call(i.exports,i,i.exports,t),i.exports}(757),a=exports;for(var n in t)a[n]=t[n];t.__esModule&&Object.defineProperty(a,"__esModule",{value:!0})})();

package/dist/openapi-runtime.json

@@ -376,10 +376,100 @@
         },
         "responses": {}
       }
+    },
+    "/v1/entity/{id}/folders": {
+      "get": {
+        "operationId": "getFileFolders",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/EntityIdPathParam"
+          },
+          {
+            "name": "parents",
+            "in": "query",
+            "required": false,
+            "style": "form",
+            "explode": true
+          }
+        ],
+        "responses": {}
+      },
+      "post": {
+        "operationId": "createFileFolder",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/EntityIdPathParam"
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {}
+          }
+        },
+        "responses": {}
+      }
+    },
+    "/v1/entity/{id}/folders/{folderSlug}": {
+      "put": {
+        "operationId": "updateFileFolder",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/EntityIdPathParam"
+          },
+          {
+            "name": "folderSlug",
+            "in": "path",
+            "required": true
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {}
+          }
+        },
+        "responses": {}
+      },
+      "delete": {
+        "operationId": "deleteFileFolder",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/EntityIdPathParam"
+          },
+          {
+            "name": "folderSlug",
+            "in": "path",
+            "required": true
+          }
+        ],
+        "responses": {}
+      }
+    },
+    "/v1/entity/{id}/folders/{folderSlug}/files": {
+      "get": {
+        "operationId": "getFilesInFolder",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/EntityIdPathParam"
+          },
+          {
+            "name": "folderSlug",
+            "in": "path",
+            "required": true
+          }
+        ],
+        "responses": {}
+      }
     }
   },
   "components": {
     "parameters": {
+      "EntityIdPathParam": {
+        "name": "id",
+        "in": "path",
+        "required": true
+      },
       "StrictQueryParam": {
         "name": "strict",
         "in": "query",
@@ -405,6 +495,13 @@
         "in": "query",
         "required": false
       }
+    },
+    "responses": {
+      "NotFoundError": {
+        "content": {
+          "application/json": {}
+        }
+      }
     }
   },
   "servers": [

package/dist/openapi.d.ts

@@ -18,9 +18,17 @@ declare namespace Components {
         Schemas.ActivityId /* ulid */;
         export type AsyncOperationQueryParam = boolean;
         export type DeleteTempFileQueryParam = boolean;
+        export type EntityIdPathParam = /**
+         * example:
+         * ef7d985c-2385-44f4-9c71-ae06a52264f8
+         */
+        Schemas.EntityId;
         export type FillActivityQueryParam = boolean;
         export type StrictQueryParam = boolean;
     }
+    export interface PathParameters {
+        EntityIdPathParam?: Parameters.EntityIdPathParam;
+    }
     export interface QueryParameters {
         StrictQueryParam?: Parameters.StrictQueryParam;
         ActivityIdQueryParam?: Parameters.ActivityIdQueryParam;
@@ -28,6 +36,30 @@ declare namespace Components {
         AsyncOperationQueryParam?: Parameters.AsyncOperationQueryParam;
         DeleteTempFileQueryParam?: Parameters.DeleteTempFileQueryParam;
     }
+    namespace Responses {
+        /**
+         * A generic error returned by the API
+         * example:
+         * {
+         *   "status": 404,
+         *   "error": "Not Found"
+         * }
+         */
+        export interface NotFoundError {
+            /**
+             * The HTTP status code of the error
+             * example:
+             * 400
+             */
+            status?: number;
+            /**
+             * The error message
+             * example:
+             * Bad Request
+             */
+            error?: string;
+        }
+    }
     namespace Schemas {
         /**
          * See https://github.com/ulid/spec
@@ -108,6 +140,23 @@ declare namespace Components {
          * contact
          */
         export type EntitySlug = string;
+        /**
+         * A generic error returned by the API
+         */
+        export interface ErrorObject {
+            /**
+             * The HTTP status code of the error
+             * example:
+             * 400
+             */
+            status?: number;
+            /**
+             * The error message
+             * example:
+             * Bad Request
+             */
+            error?: string;
+        }
         export interface FileAttributes {
             /**
              * example:
@@ -271,6 +320,85 @@ declare namespace Components {
          * ef7d985c-2385-44f4-9c71-ae06a52264f8
          */
         export type FileEntityId = string;
+        export interface FileFolderAttributes {
+            /**
+             * Name of the file folder
+             */
+            name?: string;
+            /**
+             * Optional parent folder slug. If not provided, the folder will be created at the top level
+             */
+            parent?: string;
+            /**
+             * Array of file IDs in this folder
+             */
+            files?: string /* uuid */[];
+        }
+        /**
+         * Request body for creating a file folder
+         */
+        export interface FileFolderCreateRequest {
+            /**
+             * Name of the file folder
+             */
+            name: string;
+            /**
+             * Optional parent folder slug. If not provided, the folder will be created at the top level
+             */
+            parent?: string;
+            /**
+             * Array of file IDs in this folder
+             */
+            files?: string /* uuid */[];
+        }
+        /**
+         * Generated uuid for a file folder
+         */
+        export type FileFolderId = string; // uuid
+        /**
+         * A file folder with identifiers and timestamps
+         */
+        export interface FileFolderItem {
+            /**
+             * Full slug for the folder
+             * example:
+             * _system_files_collection_entity-123:documents
+             */
+            slug?: string;
+            /**
+             * Display name of the folder
+             * example:
+             * Documents
+             */
+            name: string;
+            id?: /* Generated uuid for a file folder */ FileFolderId /* uuid */;
+            /**
+             * Array of parent folder slugs, empty array if top-level folder
+             * example:
+             * [
+             *   "_system_files_collection_entity-123"
+             * ]
+             */
+            parents?: string[];
+            /**
+             * Whether the folder is starred / favorited
+             * example:
+             * false
+             */
+            starred?: boolean;
+            /**
+             * Timestamp when the folder was created
+             * example:
+             * 2024-01-01T12:00:00Z
+             */
+            created_at?: string; // date-time
+            /**
+             * Timestamp when the folder was last updated
+             * example:
+             * 2024-01-02T12:00:00Z
+             */
+            updated_at?: string; // date-time
+        }
         export interface FileItem {
             s3ref?: S3Ref;
             /**
@@ -666,6 +794,31 @@ declare namespace Paths {
             }
         }
     }
+    namespace CreateFileFolder {
+        namespace Parameters {
+            export type Id = /**
+             * example:
+             * ef7d985c-2385-44f4-9c71-ae06a52264f8
+             */
+            Components.Schemas.EntityId;
+        }
+        export interface PathParameters {
+            id: Parameters.Id;
+        }
+        export type RequestBody = /* Request body for creating a file folder */ Components.Schemas.FileFolderCreateRequest;
+        namespace Responses {
+            export type $201 = /* A file folder with identifiers and timestamps */ Components.Schemas.FileFolderItem;
+            export type $404 = /**
+             * A generic error returned by the API
+             * example:
+             * {
+             *   "status": 404,
+             *   "error": "Not Found"
+             * }
+             */
+            Components.Responses.NotFoundError;
+        }
+    }
     namespace DeleteFile {
         namespace Parameters {
             export type ActivityId = /**
@@ -697,6 +850,41 @@ declare namespace Paths {
             export type $200 = Components.Schemas.FileEntity;
         }
     }
+    namespace DeleteFileFolder {
+        namespace Parameters {
+            /**
+             * example:
+             * documents
+             */
+            export type FolderSlug = string;
+            export type Id = /**
+             * example:
+             * ef7d985c-2385-44f4-9c71-ae06a52264f8
+             */
+            Components.Schemas.EntityId;
+        }
+        export interface PathParameters {
+            id: Parameters.Id;
+            folderSlug: /**
+             * example:
+             * documents
+             */
+            Parameters.FolderSlug;
+        }
+        namespace Responses {
+            export interface $200 {
+            }
+            export type $404 = /**
+             * A generic error returned by the API
+             * example:
+             * {
+             *   "status": 404,
+             *   "error": "Not Found"
+             * }
+             */
+            Components.Responses.NotFoundError;
+        }
+    }
     namespace DeleteSession {
         namespace Responses {
             export interface $200 {
@@ -809,6 +997,73 @@ declare namespace Paths {
             export type $200 = Components.Schemas.FileEntity;
         }
     }
+    namespace GetFileFolders {
+        namespace Parameters {
+            export type Id = /**
+             * example:
+             * ef7d985c-2385-44f4-9c71-ae06a52264f8
+             */
+            Components.Schemas.EntityId;
+            export type Parents = string[];
+        }
+        export interface PathParameters {
+            id: Parameters.Id;
+        }
+        export interface QueryParameters {
+            parents?: Parameters.Parents;
+        }
+        namespace Responses {
+            export type $200 = /* A file folder with identifiers and timestamps */ Components.Schemas.FileFolderItem[];
+            export type $404 = /**
+             * A generic error returned by the API
+             * example:
+             * {
+             *   "status": 404,
+             *   "error": "Not Found"
+             * }
+             */
+            Components.Responses.NotFoundError;
+        }
+    }
+    namespace GetFilesInFolder {
+        namespace Parameters {
+            /**
+             * example:
+             * documents
+             */
+            export type FolderSlug = string;
+            export type Id = /**
+             * example:
+             * ef7d985c-2385-44f4-9c71-ae06a52264f8
+             */
+            Components.Schemas.EntityId;
+        }
+        export interface PathParameters {
+            id: Parameters.Id;
+            folderSlug: /**
+             * example:
+             * documents
+             */
+            Parameters.FolderSlug;
+        }
+        namespace Responses {
+            export type $200 = Components.Schemas.FileEntity[];
+            export interface $403 {
+                /**
+                 * example:
+                 * User must have permission to view this entity to access its files
+                 */
+                error?: string;
+            }
+            export interface $404 {
+                /**
+                 * example:
+                 * Entity not found
+                 */
+                error?: string;
+            }
+        }
+    }
     namespace GetSession {
         namespace Responses {
             export interface $200 {
@@ -974,6 +1229,41 @@ declare namespace Paths {
             export type $200 = Components.Schemas.FileEntity;
         }
     }
+    namespace UpdateFileFolder {
+        namespace Parameters {
+            /**
+             * example:
+             * documents
+             */
+            export type FolderSlug = string;
+            export type Id = /**
+             * example:
+             * ef7d985c-2385-44f4-9c71-ae06a52264f8
+             */
+            Components.Schemas.EntityId;
+        }
+        export interface PathParameters {
+            id: Parameters.Id;
+            folderSlug: /**
+             * example:
+             * documents
+             */
+            Parameters.FolderSlug;
+        }
+        export type RequestBody = /* Request body for creating a file folder */ Components.Schemas.FileFolderCreateRequest;
+        namespace Responses {
+            export type $200 = /* A file folder with identifiers and timestamps */ Components.Schemas.FileFolderItem;
+            export type $404 = /**
+             * A generic error returned by the API
+             * example:
+             * {
+             *   "status": 404,
+             *   "error": "Not Found"
+             * }
+             */
+            Components.Responses.NotFoundError;
+        }
+    }
     namespace UploadFile {
         namespace Parameters {
             export type FileEntityId = /**
@@ -1013,6 +1303,11 @@ declare namespace Paths {
                  * https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
                  */
                 upload_url?: string; // url
+                /**
+                 * example:
+                 * File entity not found
+                 */
+                error?: string;
             }
         }
     }
@@ -1275,6 +1570,56 @@ export interface OperationMethods {
     data?: Paths.UploadFilePublic.RequestBody,
     config?: AxiosRequestConfig  
   ): OperationResponse<Paths.UploadFilePublic.Responses.$201>
+  /**
+   * getFileFolders - getFileFolders
+   * 
+   * Gets a list of folders that exist for an entity
+   */
+  'getFileFolders'(
+    parameters?: Parameters<Paths.GetFileFolders.QueryParameters & Paths.GetFileFolders.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetFileFolders.Responses.$200>
+  /**
+   * createFileFolder - createFileFolder
+   * 
+   * Creates a new file folder for the specified entity
+   */
+  'createFileFolder'(
+    parameters?: Parameters<Paths.CreateFileFolder.PathParameters> | null,
+    data?: Paths.CreateFileFolder.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.CreateFileFolder.Responses.$201>
+  /**
+   * updateFileFolder - updateFileFolder
+   * 
+   * Updates a specific file folder by slug
+   */
+  'updateFileFolder'(
+    parameters?: Parameters<Paths.UpdateFileFolder.PathParameters> | null,
+    data?: Paths.UpdateFileFolder.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.UpdateFileFolder.Responses.$200>
+  /**
+   * deleteFileFolder - deleteFileFolder
+   * 
+   * Deletes a specific file folder by slug
+   */
+  'deleteFileFolder'(
+    parameters?: Parameters<Paths.DeleteFileFolder.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.DeleteFileFolder.Responses.$200>
+  /**
+   * getFilesInFolder - getFilesInFolder
+   * 
+   * Gets all files within a specific folder for an entity
+   */
+  'getFilesInFolder'(
+    parameters?: Parameters<Paths.GetFilesInFolder.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetFilesInFolder.Responses.$200>
 }
 
 export interface PathsDictionary {
@@ -1543,6 +1888,62 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig  
     ): OperationResponse<Paths.UploadFilePublic.Responses.$201>
   }
+  ['/v1/entity/{id}/folders']: {
+    /**
+     * getFileFolders - getFileFolders
+     * 
+     * Gets a list of folders that exist for an entity
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetFileFolders.QueryParameters & Paths.GetFileFolders.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetFileFolders.Responses.$200>
+    /**
+     * createFileFolder - createFileFolder
+     * 
+     * Creates a new file folder for the specified entity
+     */
+    'post'(
+      parameters?: Parameters<Paths.CreateFileFolder.PathParameters> | null,
+      data?: Paths.CreateFileFolder.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.CreateFileFolder.Responses.$201>
+  }
+  ['/v1/entity/{id}/folders/{folderSlug}']: {
+    /**
+     * updateFileFolder - updateFileFolder
+     * 
+     * Updates a specific file folder by slug
+     */
+    'put'(
+      parameters?: Parameters<Paths.UpdateFileFolder.PathParameters> | null,
+      data?: Paths.UpdateFileFolder.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.UpdateFileFolder.Responses.$200>
+    /**
+     * deleteFileFolder - deleteFileFolder
+     * 
+     * Deletes a specific file folder by slug
+     */
+    'delete'(
+      parameters?: Parameters<Paths.DeleteFileFolder.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.DeleteFileFolder.Responses.$200>
+  }
+  ['/v1/entity/{id}/folders/{folderSlug}/files']: {
+    /**
+     * getFilesInFolder - getFilesInFolder
+     * 
+     * Gets all files within a specific folder for an entity
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetFilesInFolder.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetFilesInFolder.Responses.$200>
+  }
 }
 
 export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
@@ -1556,9 +1957,14 @@ export type CustomDownloadUrl = Components.Schemas.CustomDownloadUrl;
 export type DownloadFilesPayload = Components.Schemas.DownloadFilesPayload;
 export type EntityId = Components.Schemas.EntityId;
 export type EntitySlug = Components.Schemas.EntitySlug;
+export type ErrorObject = Components.Schemas.ErrorObject;
 export type FileAttributes = Components.Schemas.FileAttributes;
 export type FileEntity = Components.Schemas.FileEntity;
 export type FileEntityId = Components.Schemas.FileEntityId;
+export type FileFolderAttributes = Components.Schemas.FileFolderAttributes;
+export type FileFolderCreateRequest = Components.Schemas.FileFolderCreateRequest;
+export type FileFolderId = Components.Schemas.FileFolderId;
+export type FileFolderItem = Components.Schemas.FileFolderItem;
 export type FileItem = Components.Schemas.FileItem;
 export type FileRelationItem = Components.Schemas.FileRelationItem;
 export type FileType = Components.Schemas.FileType;

package/dist/openapi.json

@@ -2,8 +2,8 @@
   "openapi": "3.0.3",
   "info": {
     "title": "File API",
-    "version": "0.2.1",
-    "description": "Upload and manage epilot Files"
+    "version": "1.0.0",
+    "description": "Upload and manage epilot Files\n\n## Changelog\n<a href=\"changelog\">View API Changelog</a>\n"
   },
   "tags": [
     {
@@ -30,6 +30,10 @@
       "name": "file_schema",
       "x-displayName": "File",
       "description": "<SchemaDefinition schemaRef=\"#/components/schemas/FileEntity\" />\n"
+    },
+    {
+      "name": "File Folders",
+      "description": "Folder management for organizing files within entities"
     }
   ],
   "x-tagGroups": [
@@ -40,6 +44,7 @@
         "Preview",
         "Public Links",
         "Session",
+        "File Folders",
         "Deprecated"
       ]
     },
@@ -1076,6 +1081,248 @@
                       "type": "string",
                       "format": "url",
                       "example": "https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123"
+                    },
+                    "error": {
+                      "type": "string",
+                      "example": "File entity not found"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/entity/{id}/folders": {
+      "get": {
+        "operationId": "getFileFolders",
+        "summary": "getFileFolders",
+        "description": "Gets a list of folders that exist for an entity",
+        "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",
+        "description": "Creates a new file folder for the specified entity",
+        "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",
+        "description": "Updates a specific file folder by slug",
+        "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/FileFolderCreateRequest"
+              }
+            }
+          }
+        },
+        "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",
+        "description": "Deletes a specific file folder by slug",
+        "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",
+        "description": "Gets all files within a specific folder for an entity",
+        "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": "List of files in the folder",
+            "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"
                     }
                   }
                 }
@@ -1648,9 +1895,124 @@
             }
           }
         }
+      },
+      "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",
+            "example": "_system_files_collection_entity-123: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",
+            "items": {
+              "type": "string"
+            },
+            "example": [
+              "_system_files_collection_entity-123"
+            ]
+          },
+          "starred": {
+            "type": "boolean",
+            "description": "Whether the folder is starred / favorited",
+            "example": false
+          },
+          "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",
+        "properties": {
+          "status": {
+            "type": "integer",
+            "description": "The HTTP status code of the error",
+            "example": 400
+          },
+          "error": {
+            "type": "string",
+            "description": "The error message",
+            "example": "Bad Request"
+          }
+        }
+      },
+      "FileFolderAttributes": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string",
+            "description": "Name of the file folder"
+          },
+          "parent": {
+            "type": "string",
+            "description": "Optional parent folder slug. If not provided, the folder will be created at the top level"
+          },
+          "files": {
+            "type": "array",
+            "description": "Array of file IDs in this folder",
+            "items": {
+              "type": "string",
+              "format": "uuid"
+            }
+          }
+        },
+        "additionalProperties": false
+      },
+      "FileFolderCreateRequest": {
+        "description": "Request body for creating a file folder",
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/FileFolderAttributes"
+          },
+          {
+            "type": "object",
+            "required": [
+              "name"
+            ]
+          }
+        ]
       }
     },
     "parameters": {
+      "EntityIdPathParam": {
+        "name": "id",
+        "description": "Entity id",
+        "in": "path",
+        "required": true,
+        "schema": {
+          "$ref": "#/components/schemas/EntityId"
+        }
+      },
       "StrictQueryParam": {
         "name": "strict",
         "in": "query",
@@ -1700,6 +2062,28 @@
           "default": true
         }
       }
+    },
+    "responses": {
+      "NotFoundError": {
+        "description": "The requested resource was not found",
+        "content": {
+          "application/json": {
+            "schema": {
+              "allOf": [
+                {
+                  "$ref": "#/components/schemas/ErrorObject"
+                },
+                {
+                  "example": {
+                    "status": 404,
+                    "error": "Not Found"
+                  }
+                }
+              ]
+            }
+          }
+        }
+      }
     }
   },
   "servers": [

package/package.json

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