@epilot/file-client 1.24.0 → 1.25.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.
@@ -1 +1 @@
1
- (()=>{"use strict";var e={438(e,r,t){var n=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var i=n(t(466));r.default=i.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"},{"$ref":"#/components/parameters/VersionOnlyQueryParam"}],"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"},{"$ref":"#/components/parameters/VersionOnlyQueryParam"}],"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:zipJob":{"post":{"operationId":"createZipJob","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/files:zipJob/{job_id}":{"get":{"operationId":"getZipJob","parameters":[{"name":"job_id","in":"path","required":true}],"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/{slug}/collections":{"get":{"operationId":"getUserSchemaFileCollections","parameters":[{"name":"slug","in":"path","required":true}],"responses":{}},"post":{"operationId":"createUserSchemaFileCollection","parameters":[{"name":"slug","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/{slug}/collections/{collectionSlug}":{"put":{"operationId":"updateUserSchemaFileCollection","parameters":[{"name":"slug","in":"path","required":true},{"name":"collectionSlug","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteUserSchemaFileCollection","parameters":[{"name":"slug","in":"path","required":true},{"name":"collectionSlug","in":"path","required":true}],"responses":{}}},"/v1/entity/{id}/collections/{collectionSlug}/files":{"get":{"operationId":"getFilesInCollection","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"name":"collectionSlug","in":"path","required":true}],"responses":{}}},"/v1/collections/{schemaSlug}":{"get":{"operationId":"getGlobalFileCollections","parameters":[{"name":"schemaSlug","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},"VersionOnlyQueryParam":{"name":"version_only","in":"query","required":false}},"responses":{"BadRequestError":{"content":{"application/json":{}}},"UnauthorizedError":{"content":{"application/json":{}}},"ForbiddenError":{"content":{"application/json":{}}},"NotFoundError":{"content":{"application/json":{}}},"InternalServerError":{"content":{"application/json":{}}}}},"servers":[{"url":"https://file.sls.epilot.io"}]}')}},r={},t=function t(n){var i=r[n];if(void 0!==i)return i.exports;var a=r[n]={exports:{}};return e[n].call(a.exports,a,a.exports,t),a.exports}(438),n=exports;for(var i in t)n[i]=t[i];t.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();
1
+ (()=>{"use strict";var e={438(e,r,t){var n=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(r,"__esModule",{value:!0});var i=n(t(466));r.default=i.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"},{"$ref":"#/components/parameters/VersionOnlyQueryParam"}],"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"},{"$ref":"#/components/parameters/VersionOnlyQueryParam"}],"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:zipJob":{"post":{"operationId":"createZipJob","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/files:zipJob/{job_id}":{"get":{"operationId":"getZipJob","parameters":[{"name":"job_id","in":"path","required":true}],"responses":{}}},"/v1/files/{id}/summary:generate":{"post":{"operationId":"generateFileSummary","parameters":[{"name":"id","in":"path","required":true}],"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/{slug}/collections":{"get":{"operationId":"getUserSchemaFileCollections","parameters":[{"name":"slug","in":"path","required":true}],"responses":{}},"post":{"operationId":"createUserSchemaFileCollection","parameters":[{"name":"slug","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}}},"/v1/{slug}/collections/{collectionSlug}":{"put":{"operationId":"updateUserSchemaFileCollection","parameters":[{"name":"slug","in":"path","required":true},{"name":"collectionSlug","in":"path","required":true}],"requestBody":{"required":true,"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteUserSchemaFileCollection","parameters":[{"name":"slug","in":"path","required":true},{"name":"collectionSlug","in":"path","required":true}],"responses":{}}},"/v1/entity/{id}/collections/{collectionSlug}/files":{"get":{"operationId":"getFilesInCollection","parameters":[{"$ref":"#/components/parameters/EntityIdPathParam"},{"name":"collectionSlug","in":"path","required":true}],"responses":{}}},"/v1/collections/{schemaSlug}":{"get":{"operationId":"getGlobalFileCollections","parameters":[{"name":"schemaSlug","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},"VersionOnlyQueryParam":{"name":"version_only","in":"query","required":false}},"responses":{"BadRequestError":{"content":{"application/json":{}}},"UnauthorizedError":{"content":{"application/json":{}}},"ForbiddenError":{"content":{"application/json":{}}},"NotFoundError":{"content":{"application/json":{}}},"InternalServerError":{"content":{"application/json":{}}}}},"servers":[{"url":"https://file.sls.epilot.io"}]}')}},r={},t=function t(n){var i=r[n];if(void 0!==i)return i.exports;var a=r[n]={exports:{}};return e[n].call(a.exports,a,a.exports,t),a.exports}(438),n=exports;for(var i in t)n[i]=t[i];t.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();
@@ -216,6 +216,19 @@
216
216
  "responses": {}
217
217
  }
218
218
  },
219
+ "/v1/files/{id}/summary:generate": {
220
+ "post": {
221
+ "operationId": "generateFileSummary",
222
+ "parameters": [
223
+ {
224
+ "name": "id",
225
+ "in": "path",
226
+ "required": true
227
+ }
228
+ ],
229
+ "responses": {}
230
+ }
231
+ },
219
232
  "/v1/files/{id}/preview": {
220
233
  "get": {
221
234
  "operationId": "previewFile",
package/dist/openapi.d.ts CHANGED
@@ -1282,9 +1282,11 @@ declare namespace Components {
1282
1282
  */
1283
1283
  zip_filename?: string;
1284
1284
  /**
1285
- * Send email notification when ZIP is ready
1285
+ * Email address to notify when the ZIP is ready. Omit to skip the email notification.
1286
+ * example:
1287
+ * user@example.com
1286
1288
  */
1287
- notify_email?: boolean;
1289
+ notify_email?: string; // email
1288
1290
  } | {
1289
1291
  /**
1290
1292
  * List of file entity IDs to include in the ZIP
@@ -2320,9 +2322,11 @@ declare namespace Components {
2320
2322
  */
2321
2323
  zip_filename?: string;
2322
2324
  /**
2323
- * Send email notification when ZIP is ready
2325
+ * Email address to notify when the ZIP is ready. Omit to skip the email notification.
2326
+ * example:
2327
+ * user@example.com
2324
2328
  */
2325
- notify_email?: boolean;
2329
+ notify_email?: string; // email
2326
2330
  };
2327
2331
  /**
2328
2332
  * Custom external download url used for the file
@@ -2429,6 +2433,15 @@ declare namespace Components {
2429
2433
  * https://some-api-url.com/download?file_id=123
2430
2434
  */
2431
2435
  CustomDownloadUrl /* uri */;
2436
+ /**
2437
+ * AI-generated compact summary for hover and list preview surfaces.
2438
+ */
2439
+ preview_summary?: string;
2440
+ /**
2441
+ * AI-generated short paragraph summary for file preview surfaces.
2442
+ */
2443
+ short_summary?: string;
2444
+ summary_status?: /* Current AI summary generation state for the file. */ FileSummaryStatus;
2432
2445
  }
2433
2446
  export interface FileCollectionAttributes {
2434
2447
  /**
@@ -2628,6 +2641,15 @@ declare namespace Components {
2628
2641
  * https://some-api-url.com/download?file_id=123
2629
2642
  */
2630
2643
  CustomDownloadUrl /* uri */;
2644
+ /**
2645
+ * AI-generated compact summary for hover and list preview surfaces.
2646
+ */
2647
+ preview_summary?: string;
2648
+ /**
2649
+ * AI-generated short paragraph summary for file preview surfaces.
2650
+ */
2651
+ short_summary?: string;
2652
+ summary_status?: /* Current AI summary generation state for the file. */ FileSummaryStatus;
2631
2653
  /**
2632
2654
  * Source URL for the file. Included if the entity was created from source_url, or when ?source_url=true
2633
2655
  * example:
@@ -2699,6 +2721,13 @@ declare namespace Components {
2699
2721
  EntitySlug;
2700
2722
  _tags?: string[];
2701
2723
  }
2724
+ export interface FileSummaryGenerationStatus {
2725
+ status: /* Current AI summary generation state for the file. */ FileSummaryStatus;
2726
+ }
2727
+ /**
2728
+ * Current AI summary generation state for the file.
2729
+ */
2730
+ export type FileSummaryStatus = "processing" | "completed" | "failed" | "unsupported";
2702
2731
  export type FileType = "document" | "document_template" | "text" | "image" | "video" | "audio" | "spreadsheet" | "presentation" | "font" | "archive" | "application" | "unknown";
2703
2732
  export interface FileUpload {
2704
2733
  s3ref?: S3Reference;
@@ -2823,6 +2852,15 @@ declare namespace Components {
2823
2852
  * https://some-api-url.com/download?file_id=123
2824
2853
  */
2825
2854
  CustomDownloadUrl /* uri */;
2855
+ /**
2856
+ * AI-generated compact summary for hover and list preview surfaces.
2857
+ */
2858
+ preview_summary?: string;
2859
+ /**
2860
+ * AI-generated short paragraph summary for file preview surfaces.
2861
+ */
2862
+ short_summary?: string;
2863
+ summary_status?: /* Current AI summary generation state for the file. */ FileSummaryStatus;
2826
2864
  }
2827
2865
  export interface SaveFileFromSourceURLPayload {
2828
2866
  [name: string]: any;
@@ -2902,6 +2940,15 @@ declare namespace Components {
2902
2940
  * https://some-api-url.com/download?file_id=123
2903
2941
  */
2904
2942
  CustomDownloadUrl /* uri */;
2943
+ /**
2944
+ * AI-generated compact summary for hover and list preview surfaces.
2945
+ */
2946
+ preview_summary?: string;
2947
+ /**
2948
+ * AI-generated short paragraph summary for file preview surfaces.
2949
+ */
2950
+ short_summary?: string;
2951
+ summary_status?: /* Current AI summary generation state for the file. */ FileSummaryStatus;
2905
2952
  source_url?: /**
2906
2953
  * Custom external download url used for the file
2907
2954
  * example:
@@ -2989,6 +3036,15 @@ declare namespace Components {
2989
3036
  * https://some-api-url.com/download?file_id=123
2990
3037
  */
2991
3038
  CustomDownloadUrl /* uri */;
3039
+ /**
3040
+ * AI-generated compact summary for hover and list preview surfaces.
3041
+ */
3042
+ preview_summary?: string;
3043
+ /**
3044
+ * AI-generated short paragraph summary for file preview surfaces.
3045
+ */
3046
+ short_summary?: string;
3047
+ summary_status?: /* Current AI summary generation state for the file. */ FileSummaryStatus;
2992
3048
  s3ref?: S3Ref;
2993
3049
  }
2994
3050
  export interface UploadFilePayload {
@@ -3516,6 +3572,66 @@ declare namespace Paths {
3516
3572
  Components.Responses.InternalServerError;
3517
3573
  }
3518
3574
  }
3575
+ namespace GenerateFileSummary {
3576
+ namespace Parameters {
3577
+ export type Id = /**
3578
+ * example:
3579
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
3580
+ */
3581
+ Components.Schemas.FileEntityId;
3582
+ }
3583
+ export interface PathParameters {
3584
+ id: Parameters.Id;
3585
+ }
3586
+ namespace Responses {
3587
+ export type $202 = Components.Schemas.FileSummaryGenerationStatus;
3588
+ export type $400 = /**
3589
+ * A generic error returned by the API
3590
+ * example:
3591
+ * {
3592
+ * "status": 400,
3593
+ * "error": "Bad Request: filename is required"
3594
+ * }
3595
+ */
3596
+ Components.Responses.BadRequestError;
3597
+ export type $401 = /**
3598
+ * A generic error returned by the API
3599
+ * example:
3600
+ * {
3601
+ * "status": 401,
3602
+ * "error": "Unauthorized: Invalid or expired token"
3603
+ * }
3604
+ */
3605
+ Components.Responses.UnauthorizedError;
3606
+ export type $403 = /**
3607
+ * A generic error returned by the API
3608
+ * example:
3609
+ * {
3610
+ * "status": 403,
3611
+ * "error": "Forbidden: You do not have permission to access this file"
3612
+ * }
3613
+ */
3614
+ Components.Responses.ForbiddenError;
3615
+ export type $404 = /**
3616
+ * A generic error returned by the API
3617
+ * example:
3618
+ * {
3619
+ * "status": 404,
3620
+ * "error": "Not Found: File entity not found"
3621
+ * }
3622
+ */
3623
+ Components.Responses.NotFoundError;
3624
+ export type $500 = /**
3625
+ * A generic error returned by the API
3626
+ * example:
3627
+ * {
3628
+ * "status": 500,
3629
+ * "error": "Internal Server Error"
3630
+ * }
3631
+ */
3632
+ Components.Responses.InternalServerError;
3633
+ }
3634
+ }
3519
3635
  namespace GeneratePublicLink {
3520
3636
  namespace Parameters {
3521
3637
  export type Id = /**
@@ -4536,6 +4652,16 @@ export interface OperationMethods {
4536
4652
  data?: any,
4537
4653
  config?: AxiosRequestConfig
4538
4654
  ): OperationResponse<Paths.GetZipJob.Responses.$200>
4655
+ /**
4656
+ * generateFileSummary - generateFileSummary
4657
+ *
4658
+ * Request AI generation of preview and short summaries for a file entity.
4659
+ */
4660
+ 'generateFileSummary'(
4661
+ parameters?: Parameters<Paths.GenerateFileSummary.PathParameters> | null,
4662
+ data?: any,
4663
+ config?: AxiosRequestConfig
4664
+ ): OperationResponse<Paths.GenerateFileSummary.Responses.$202>
4539
4665
  /**
4540
4666
  * previewFile - previewFile
4541
4667
  *
@@ -4987,6 +5113,18 @@ export interface PathsDictionary {
4987
5113
  config?: AxiosRequestConfig
4988
5114
  ): OperationResponse<Paths.GetZipJob.Responses.$200>
4989
5115
  }
5116
+ ['/v1/files/{id}/summary:generate']: {
5117
+ /**
5118
+ * generateFileSummary - generateFileSummary
5119
+ *
5120
+ * Request AI generation of preview and short summaries for a file entity.
5121
+ */
5122
+ 'post'(
5123
+ parameters?: Parameters<Paths.GenerateFileSummary.PathParameters> | null,
5124
+ data?: any,
5125
+ config?: AxiosRequestConfig
5126
+ ): OperationResponse<Paths.GenerateFileSummary.Responses.$202>
5127
+ }
4990
5128
  ['/v1/files/{id}/preview']: {
4991
5129
  /**
4992
5130
  * previewFile - previewFile
@@ -5295,6 +5433,8 @@ export type FileEntity = Components.Schemas.FileEntity;
5295
5433
  export type FileEntityId = Components.Schemas.FileEntityId;
5296
5434
  export type FileItem = Components.Schemas.FileItem;
5297
5435
  export type FileRelationItem = Components.Schemas.FileRelationItem;
5436
+ export type FileSummaryGenerationStatus = Components.Schemas.FileSummaryGenerationStatus;
5437
+ export type FileSummaryStatus = Components.Schemas.FileSummaryStatus;
5298
5438
  export type FileType = Components.Schemas.FileType;
5299
5439
  export type FileUpload = Components.Schemas.FileUpload;
5300
5440
  export type PublicLink = Components.Schemas.PublicLink;
package/dist/openapi.json CHANGED
@@ -802,7 +802,7 @@
802
802
  "3fa85f64-5717-4562-b3fc-2c963f66afa6"
803
803
  ],
804
804
  "zip_filename": "Documents.zip",
805
- "notify_email": true
805
+ "notify_email": "user@example.com"
806
806
  }
807
807
  }
808
808
  }
@@ -875,6 +875,54 @@
875
875
  }
876
876
  }
877
877
  },
878
+ "/v1/files/{id}/summary:generate": {
879
+ "post": {
880
+ "operationId": "generateFileSummary",
881
+ "summary": "generateFileSummary",
882
+ "description": "Request AI generation of preview and short summaries for a file entity.",
883
+ "tags": [
884
+ "File"
885
+ ],
886
+ "parameters": [
887
+ {
888
+ "name": "id",
889
+ "in": "path",
890
+ "required": true,
891
+ "description": "The UUID of the file entity",
892
+ "schema": {
893
+ "$ref": "#/components/schemas/FileEntityId"
894
+ }
895
+ }
896
+ ],
897
+ "responses": {
898
+ "202": {
899
+ "description": "Summary generation accepted",
900
+ "content": {
901
+ "application/json": {
902
+ "schema": {
903
+ "$ref": "#/components/schemas/FileSummaryGenerationStatus"
904
+ }
905
+ }
906
+ }
907
+ },
908
+ "400": {
909
+ "$ref": "#/components/responses/BadRequestError"
910
+ },
911
+ "401": {
912
+ "$ref": "#/components/responses/UnauthorizedError"
913
+ },
914
+ "403": {
915
+ "$ref": "#/components/responses/ForbiddenError"
916
+ },
917
+ "404": {
918
+ "$ref": "#/components/responses/NotFoundError"
919
+ },
920
+ "500": {
921
+ "$ref": "#/components/responses/InternalServerError"
922
+ }
923
+ }
924
+ }
925
+ },
878
926
  "/v1/files/{id}/preview": {
879
927
  "get": {
880
928
  "operationId": "previewFile",
@@ -2113,6 +2161,19 @@
2113
2161
  },
2114
2162
  "custom_download_url": {
2115
2163
  "$ref": "#/components/schemas/CustomDownloadUrl"
2164
+ },
2165
+ "preview_summary": {
2166
+ "type": "string",
2167
+ "description": "AI-generated compact summary for hover and list preview surfaces.",
2168
+ "readOnly": true
2169
+ },
2170
+ "short_summary": {
2171
+ "type": "string",
2172
+ "description": "AI-generated short paragraph summary for file preview surfaces.",
2173
+ "readOnly": true
2174
+ },
2175
+ "summary_status": {
2176
+ "$ref": "#/components/schemas/FileSummaryStatus"
2116
2177
  }
2117
2178
  }
2118
2179
  },
@@ -2133,6 +2194,28 @@
2133
2194
  "unknown"
2134
2195
  ]
2135
2196
  },
2197
+ "FileSummaryStatus": {
2198
+ "type": "string",
2199
+ "description": "Current AI summary generation state for the file.",
2200
+ "enum": [
2201
+ "processing",
2202
+ "completed",
2203
+ "failed",
2204
+ "unsupported"
2205
+ ],
2206
+ "readOnly": true
2207
+ },
2208
+ "FileSummaryGenerationStatus": {
2209
+ "type": "object",
2210
+ "properties": {
2211
+ "status": {
2212
+ "$ref": "#/components/schemas/FileSummaryStatus"
2213
+ }
2214
+ },
2215
+ "required": [
2216
+ "status"
2217
+ ]
2218
+ },
2136
2219
  "CustomDownloadUrl": {
2137
2220
  "description": "Custom external download url used for the file",
2138
2221
  "type": "string",
@@ -2515,9 +2598,10 @@
2515
2598
  "example": "Documents.zip"
2516
2599
  },
2517
2600
  "notify_email": {
2518
- "type": "boolean",
2519
- "description": "Send email notification when ZIP is ready",
2520
- "default": true
2601
+ "type": "string",
2602
+ "format": "email",
2603
+ "description": "Email address to notify when the ZIP is ready. Omit to skip the email notification.",
2604
+ "example": "user@example.com"
2521
2605
  }
2522
2606
  },
2523
2607
  "oneOf": [
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/file-client",
3
- "version": "1.24.0",
3
+ "version": "1.25.0",
4
4
  "description": "Client library for the epilot File API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",