@epilot/file-client 1.24.0 → 1.26.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/definition.js +1 -1
- package/dist/openapi-runtime.json +18 -0
- package/dist/openapi.d.ts +217 -4
- package/dist/openapi.json +152 -4
- package/package.json +1 -1
package/dist/definition.js
CHANGED
|
@@ -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":{}}},"ConflictError":{"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",
|
|
@@ -566,6 +579,11 @@
|
|
|
566
579
|
"application/json": {}
|
|
567
580
|
}
|
|
568
581
|
},
|
|
582
|
+
"ConflictError": {
|
|
583
|
+
"content": {
|
|
584
|
+
"application/json": {}
|
|
585
|
+
}
|
|
586
|
+
},
|
|
569
587
|
"InternalServerError": {
|
|
570
588
|
"content": {
|
|
571
589
|
"application/json": {}
|
package/dist/openapi.d.ts
CHANGED
|
@@ -59,6 +59,28 @@ declare namespace Components {
|
|
|
59
59
|
*/
|
|
60
60
|
error?: string;
|
|
61
61
|
}
|
|
62
|
+
/**
|
|
63
|
+
* A generic error returned by the API
|
|
64
|
+
* example:
|
|
65
|
+
* {
|
|
66
|
+
* "status": 409,
|
|
67
|
+
* "error": "Extracted file content is still being prepared"
|
|
68
|
+
* }
|
|
69
|
+
*/
|
|
70
|
+
export interface ConflictError {
|
|
71
|
+
/**
|
|
72
|
+
* The HTTP status code of the error
|
|
73
|
+
* example:
|
|
74
|
+
* 400
|
|
75
|
+
*/
|
|
76
|
+
status?: number;
|
|
77
|
+
/**
|
|
78
|
+
* The error message
|
|
79
|
+
* example:
|
|
80
|
+
* Bad Request
|
|
81
|
+
*/
|
|
82
|
+
error?: string;
|
|
83
|
+
}
|
|
62
84
|
/**
|
|
63
85
|
* A generic error returned by the API
|
|
64
86
|
* example:
|
|
@@ -1282,9 +1304,11 @@ declare namespace Components {
|
|
|
1282
1304
|
*/
|
|
1283
1305
|
zip_filename?: string;
|
|
1284
1306
|
/**
|
|
1285
|
-
*
|
|
1307
|
+
* Email address to notify when the ZIP is ready. Omit to skip the email notification.
|
|
1308
|
+
* example:
|
|
1309
|
+
* user@example.com
|
|
1286
1310
|
*/
|
|
1287
|
-
notify_email?:
|
|
1311
|
+
notify_email?: string; // email
|
|
1288
1312
|
} | {
|
|
1289
1313
|
/**
|
|
1290
1314
|
* List of file entity IDs to include in the ZIP
|
|
@@ -2320,9 +2344,11 @@ declare namespace Components {
|
|
|
2320
2344
|
*/
|
|
2321
2345
|
zip_filename?: string;
|
|
2322
2346
|
/**
|
|
2323
|
-
*
|
|
2347
|
+
* Email address to notify when the ZIP is ready. Omit to skip the email notification.
|
|
2348
|
+
* example:
|
|
2349
|
+
* user@example.com
|
|
2324
2350
|
*/
|
|
2325
|
-
notify_email?:
|
|
2351
|
+
notify_email?: string; // email
|
|
2326
2352
|
};
|
|
2327
2353
|
/**
|
|
2328
2354
|
* Custom external download url used for the file
|
|
@@ -2429,6 +2455,23 @@ declare namespace Components {
|
|
|
2429
2455
|
* https://some-api-url.com/download?file_id=123
|
|
2430
2456
|
*/
|
|
2431
2457
|
CustomDownloadUrl /* uri */;
|
|
2458
|
+
/**
|
|
2459
|
+
* Compact German summary for hover and list preview surfaces.
|
|
2460
|
+
*/
|
|
2461
|
+
preview_summary_de?: string;
|
|
2462
|
+
/**
|
|
2463
|
+
* Short German paragraph summary for file preview surfaces.
|
|
2464
|
+
*/
|
|
2465
|
+
short_summary_de?: string;
|
|
2466
|
+
/**
|
|
2467
|
+
* Compact English summary for hover and list preview surfaces.
|
|
2468
|
+
*/
|
|
2469
|
+
preview_summary_en?: string;
|
|
2470
|
+
/**
|
|
2471
|
+
* Short English paragraph summary for file preview surfaces.
|
|
2472
|
+
*/
|
|
2473
|
+
short_summary_en?: string;
|
|
2474
|
+
summary_status?: /* Current AI summary generation state for the file. */ FileSummaryStatus;
|
|
2432
2475
|
}
|
|
2433
2476
|
export interface FileCollectionAttributes {
|
|
2434
2477
|
/**
|
|
@@ -2628,6 +2671,23 @@ declare namespace Components {
|
|
|
2628
2671
|
* https://some-api-url.com/download?file_id=123
|
|
2629
2672
|
*/
|
|
2630
2673
|
CustomDownloadUrl /* uri */;
|
|
2674
|
+
/**
|
|
2675
|
+
* Compact German summary for hover and list preview surfaces.
|
|
2676
|
+
*/
|
|
2677
|
+
preview_summary_de?: string;
|
|
2678
|
+
/**
|
|
2679
|
+
* Short German paragraph summary for file preview surfaces.
|
|
2680
|
+
*/
|
|
2681
|
+
short_summary_de?: string;
|
|
2682
|
+
/**
|
|
2683
|
+
* Compact English summary for hover and list preview surfaces.
|
|
2684
|
+
*/
|
|
2685
|
+
preview_summary_en?: string;
|
|
2686
|
+
/**
|
|
2687
|
+
* Short English paragraph summary for file preview surfaces.
|
|
2688
|
+
*/
|
|
2689
|
+
short_summary_en?: string;
|
|
2690
|
+
summary_status?: /* Current AI summary generation state for the file. */ FileSummaryStatus;
|
|
2631
2691
|
/**
|
|
2632
2692
|
* Source URL for the file. Included if the entity was created from source_url, or when ?source_url=true
|
|
2633
2693
|
* example:
|
|
@@ -2699,6 +2759,13 @@ declare namespace Components {
|
|
|
2699
2759
|
EntitySlug;
|
|
2700
2760
|
_tags?: string[];
|
|
2701
2761
|
}
|
|
2762
|
+
export interface FileSummaryGenerationStatus {
|
|
2763
|
+
status: /* Current AI summary generation state for the file. */ FileSummaryStatus;
|
|
2764
|
+
}
|
|
2765
|
+
/**
|
|
2766
|
+
* Current AI summary generation state for the file.
|
|
2767
|
+
*/
|
|
2768
|
+
export type FileSummaryStatus = "processing" | "completed" | "failed" | "unsupported";
|
|
2702
2769
|
export type FileType = "document" | "document_template" | "text" | "image" | "video" | "audio" | "spreadsheet" | "presentation" | "font" | "archive" | "application" | "unknown";
|
|
2703
2770
|
export interface FileUpload {
|
|
2704
2771
|
s3ref?: S3Reference;
|
|
@@ -2823,6 +2890,23 @@ declare namespace Components {
|
|
|
2823
2890
|
* https://some-api-url.com/download?file_id=123
|
|
2824
2891
|
*/
|
|
2825
2892
|
CustomDownloadUrl /* uri */;
|
|
2893
|
+
/**
|
|
2894
|
+
* Compact German summary for hover and list preview surfaces.
|
|
2895
|
+
*/
|
|
2896
|
+
preview_summary_de?: string;
|
|
2897
|
+
/**
|
|
2898
|
+
* Short German paragraph summary for file preview surfaces.
|
|
2899
|
+
*/
|
|
2900
|
+
short_summary_de?: string;
|
|
2901
|
+
/**
|
|
2902
|
+
* Compact English summary for hover and list preview surfaces.
|
|
2903
|
+
*/
|
|
2904
|
+
preview_summary_en?: string;
|
|
2905
|
+
/**
|
|
2906
|
+
* Short English paragraph summary for file preview surfaces.
|
|
2907
|
+
*/
|
|
2908
|
+
short_summary_en?: string;
|
|
2909
|
+
summary_status?: /* Current AI summary generation state for the file. */ FileSummaryStatus;
|
|
2826
2910
|
}
|
|
2827
2911
|
export interface SaveFileFromSourceURLPayload {
|
|
2828
2912
|
[name: string]: any;
|
|
@@ -2902,6 +2986,23 @@ declare namespace Components {
|
|
|
2902
2986
|
* https://some-api-url.com/download?file_id=123
|
|
2903
2987
|
*/
|
|
2904
2988
|
CustomDownloadUrl /* uri */;
|
|
2989
|
+
/**
|
|
2990
|
+
* Compact German summary for hover and list preview surfaces.
|
|
2991
|
+
*/
|
|
2992
|
+
preview_summary_de?: string;
|
|
2993
|
+
/**
|
|
2994
|
+
* Short German paragraph summary for file preview surfaces.
|
|
2995
|
+
*/
|
|
2996
|
+
short_summary_de?: string;
|
|
2997
|
+
/**
|
|
2998
|
+
* Compact English summary for hover and list preview surfaces.
|
|
2999
|
+
*/
|
|
3000
|
+
preview_summary_en?: string;
|
|
3001
|
+
/**
|
|
3002
|
+
* Short English paragraph summary for file preview surfaces.
|
|
3003
|
+
*/
|
|
3004
|
+
short_summary_en?: string;
|
|
3005
|
+
summary_status?: /* Current AI summary generation state for the file. */ FileSummaryStatus;
|
|
2905
3006
|
source_url?: /**
|
|
2906
3007
|
* Custom external download url used for the file
|
|
2907
3008
|
* example:
|
|
@@ -2989,6 +3090,23 @@ declare namespace Components {
|
|
|
2989
3090
|
* https://some-api-url.com/download?file_id=123
|
|
2990
3091
|
*/
|
|
2991
3092
|
CustomDownloadUrl /* uri */;
|
|
3093
|
+
/**
|
|
3094
|
+
* Compact German summary for hover and list preview surfaces.
|
|
3095
|
+
*/
|
|
3096
|
+
preview_summary_de?: string;
|
|
3097
|
+
/**
|
|
3098
|
+
* Short German paragraph summary for file preview surfaces.
|
|
3099
|
+
*/
|
|
3100
|
+
short_summary_de?: string;
|
|
3101
|
+
/**
|
|
3102
|
+
* Compact English summary for hover and list preview surfaces.
|
|
3103
|
+
*/
|
|
3104
|
+
preview_summary_en?: string;
|
|
3105
|
+
/**
|
|
3106
|
+
* Short English paragraph summary for file preview surfaces.
|
|
3107
|
+
*/
|
|
3108
|
+
short_summary_en?: string;
|
|
3109
|
+
summary_status?: /* Current AI summary generation state for the file. */ FileSummaryStatus;
|
|
2992
3110
|
s3ref?: S3Ref;
|
|
2993
3111
|
}
|
|
2994
3112
|
export interface UploadFilePayload {
|
|
@@ -3516,6 +3634,75 @@ declare namespace Paths {
|
|
|
3516
3634
|
Components.Responses.InternalServerError;
|
|
3517
3635
|
}
|
|
3518
3636
|
}
|
|
3637
|
+
namespace GenerateFileSummary {
|
|
3638
|
+
namespace Parameters {
|
|
3639
|
+
export type Id = /**
|
|
3640
|
+
* example:
|
|
3641
|
+
* ef7d985c-2385-44f4-9c71-ae06a52264f8
|
|
3642
|
+
*/
|
|
3643
|
+
Components.Schemas.FileEntityId;
|
|
3644
|
+
}
|
|
3645
|
+
export interface PathParameters {
|
|
3646
|
+
id: Parameters.Id;
|
|
3647
|
+
}
|
|
3648
|
+
namespace Responses {
|
|
3649
|
+
export type $202 = Components.Schemas.FileSummaryGenerationStatus;
|
|
3650
|
+
export type $400 = /**
|
|
3651
|
+
* A generic error returned by the API
|
|
3652
|
+
* example:
|
|
3653
|
+
* {
|
|
3654
|
+
* "status": 400,
|
|
3655
|
+
* "error": "Bad Request: filename is required"
|
|
3656
|
+
* }
|
|
3657
|
+
*/
|
|
3658
|
+
Components.Responses.BadRequestError;
|
|
3659
|
+
export type $401 = /**
|
|
3660
|
+
* A generic error returned by the API
|
|
3661
|
+
* example:
|
|
3662
|
+
* {
|
|
3663
|
+
* "status": 401,
|
|
3664
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
3665
|
+
* }
|
|
3666
|
+
*/
|
|
3667
|
+
Components.Responses.UnauthorizedError;
|
|
3668
|
+
export type $403 = /**
|
|
3669
|
+
* A generic error returned by the API
|
|
3670
|
+
* example:
|
|
3671
|
+
* {
|
|
3672
|
+
* "status": 403,
|
|
3673
|
+
* "error": "Forbidden: You do not have permission to access this file"
|
|
3674
|
+
* }
|
|
3675
|
+
*/
|
|
3676
|
+
Components.Responses.ForbiddenError;
|
|
3677
|
+
export type $404 = /**
|
|
3678
|
+
* A generic error returned by the API
|
|
3679
|
+
* example:
|
|
3680
|
+
* {
|
|
3681
|
+
* "status": 404,
|
|
3682
|
+
* "error": "Not Found: File entity not found"
|
|
3683
|
+
* }
|
|
3684
|
+
*/
|
|
3685
|
+
Components.Responses.NotFoundError;
|
|
3686
|
+
export type $409 = /**
|
|
3687
|
+
* A generic error returned by the API
|
|
3688
|
+
* example:
|
|
3689
|
+
* {
|
|
3690
|
+
* "status": 409,
|
|
3691
|
+
* "error": "Extracted file content is still being prepared"
|
|
3692
|
+
* }
|
|
3693
|
+
*/
|
|
3694
|
+
Components.Responses.ConflictError;
|
|
3695
|
+
export type $500 = /**
|
|
3696
|
+
* A generic error returned by the API
|
|
3697
|
+
* example:
|
|
3698
|
+
* {
|
|
3699
|
+
* "status": 500,
|
|
3700
|
+
* "error": "Internal Server Error"
|
|
3701
|
+
* }
|
|
3702
|
+
*/
|
|
3703
|
+
Components.Responses.InternalServerError;
|
|
3704
|
+
}
|
|
3705
|
+
}
|
|
3519
3706
|
namespace GeneratePublicLink {
|
|
3520
3707
|
namespace Parameters {
|
|
3521
3708
|
export type Id = /**
|
|
@@ -3867,6 +4054,8 @@ declare namespace Paths {
|
|
|
3867
4054
|
}
|
|
3868
4055
|
namespace Responses {
|
|
3869
4056
|
export type $200 = string; // binary
|
|
4057
|
+
export interface $304 {
|
|
4058
|
+
}
|
|
3870
4059
|
export type $403 = /* A generic error returned by the API */ Components.Schemas.ErrorObject;
|
|
3871
4060
|
export type $404 = /**
|
|
3872
4061
|
* A generic error returned by the API
|
|
@@ -4536,6 +4725,16 @@ export interface OperationMethods {
|
|
|
4536
4725
|
data?: any,
|
|
4537
4726
|
config?: AxiosRequestConfig
|
|
4538
4727
|
): OperationResponse<Paths.GetZipJob.Responses.$200>
|
|
4728
|
+
/**
|
|
4729
|
+
* generateFileSummary - generateFileSummary
|
|
4730
|
+
*
|
|
4731
|
+
* Request AI generation of preview and short summaries for a file entity.
|
|
4732
|
+
*/
|
|
4733
|
+
'generateFileSummary'(
|
|
4734
|
+
parameters?: Parameters<Paths.GenerateFileSummary.PathParameters> | null,
|
|
4735
|
+
data?: any,
|
|
4736
|
+
config?: AxiosRequestConfig
|
|
4737
|
+
): OperationResponse<Paths.GenerateFileSummary.Responses.$202>
|
|
4539
4738
|
/**
|
|
4540
4739
|
* previewFile - previewFile
|
|
4541
4740
|
*
|
|
@@ -4987,6 +5186,18 @@ export interface PathsDictionary {
|
|
|
4987
5186
|
config?: AxiosRequestConfig
|
|
4988
5187
|
): OperationResponse<Paths.GetZipJob.Responses.$200>
|
|
4989
5188
|
}
|
|
5189
|
+
['/v1/files/{id}/summary:generate']: {
|
|
5190
|
+
/**
|
|
5191
|
+
* generateFileSummary - generateFileSummary
|
|
5192
|
+
*
|
|
5193
|
+
* Request AI generation of preview and short summaries for a file entity.
|
|
5194
|
+
*/
|
|
5195
|
+
'post'(
|
|
5196
|
+
parameters?: Parameters<Paths.GenerateFileSummary.PathParameters> | null,
|
|
5197
|
+
data?: any,
|
|
5198
|
+
config?: AxiosRequestConfig
|
|
5199
|
+
): OperationResponse<Paths.GenerateFileSummary.Responses.$202>
|
|
5200
|
+
}
|
|
4990
5201
|
['/v1/files/{id}/preview']: {
|
|
4991
5202
|
/**
|
|
4992
5203
|
* previewFile - previewFile
|
|
@@ -5295,6 +5506,8 @@ export type FileEntity = Components.Schemas.FileEntity;
|
|
|
5295
5506
|
export type FileEntityId = Components.Schemas.FileEntityId;
|
|
5296
5507
|
export type FileItem = Components.Schemas.FileItem;
|
|
5297
5508
|
export type FileRelationItem = Components.Schemas.FileRelationItem;
|
|
5509
|
+
export type FileSummaryGenerationStatus = Components.Schemas.FileSummaryGenerationStatus;
|
|
5510
|
+
export type FileSummaryStatus = Components.Schemas.FileSummaryStatus;
|
|
5298
5511
|
export type FileType = Components.Schemas.FileType;
|
|
5299
5512
|
export type FileUpload = Components.Schemas.FileUpload;
|
|
5300
5513
|
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":
|
|
805
|
+
"notify_email": "user@example.com"
|
|
806
806
|
}
|
|
807
807
|
}
|
|
808
808
|
}
|
|
@@ -875,6 +875,57 @@
|
|
|
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
|
+
"409": {
|
|
921
|
+
"$ref": "#/components/responses/ConflictError"
|
|
922
|
+
},
|
|
923
|
+
"500": {
|
|
924
|
+
"$ref": "#/components/responses/InternalServerError"
|
|
925
|
+
}
|
|
926
|
+
}
|
|
927
|
+
}
|
|
928
|
+
},
|
|
878
929
|
"/v1/files/{id}/preview": {
|
|
879
930
|
"get": {
|
|
880
931
|
"operationId": "previewFile",
|
|
@@ -1167,6 +1218,20 @@
|
|
|
1167
1218
|
"responses": {
|
|
1168
1219
|
"200": {
|
|
1169
1220
|
"description": "Generated thumbnail image for a public file",
|
|
1221
|
+
"headers": {
|
|
1222
|
+
"ETag": {
|
|
1223
|
+
"description": "Identifier of the previewed file version, for conditional requests",
|
|
1224
|
+
"schema": {
|
|
1225
|
+
"type": "string"
|
|
1226
|
+
}
|
|
1227
|
+
},
|
|
1228
|
+
"Cache-Control": {
|
|
1229
|
+
"description": "Caching policy for the preview",
|
|
1230
|
+
"schema": {
|
|
1231
|
+
"type": "string"
|
|
1232
|
+
}
|
|
1233
|
+
}
|
|
1234
|
+
},
|
|
1170
1235
|
"content": {
|
|
1171
1236
|
"image/png": {
|
|
1172
1237
|
"schema": {
|
|
@@ -1182,6 +1247,23 @@
|
|
|
1182
1247
|
}
|
|
1183
1248
|
}
|
|
1184
1249
|
},
|
|
1250
|
+
"304": {
|
|
1251
|
+
"description": "The preview is unchanged since the version identified by the `If-None-Match`\nrequest header. No body is returned; the cached copy should be reused.\n",
|
|
1252
|
+
"headers": {
|
|
1253
|
+
"ETag": {
|
|
1254
|
+
"description": "Identifier of the current file version's preview",
|
|
1255
|
+
"schema": {
|
|
1256
|
+
"type": "string"
|
|
1257
|
+
}
|
|
1258
|
+
},
|
|
1259
|
+
"Cache-Control": {
|
|
1260
|
+
"description": "Caching policy for the preview",
|
|
1261
|
+
"schema": {
|
|
1262
|
+
"type": "string"
|
|
1263
|
+
}
|
|
1264
|
+
}
|
|
1265
|
+
}
|
|
1266
|
+
},
|
|
1185
1267
|
"403": {
|
|
1186
1268
|
"description": "File is not public",
|
|
1187
1269
|
"content": {
|
|
@@ -2113,6 +2195,29 @@
|
|
|
2113
2195
|
},
|
|
2114
2196
|
"custom_download_url": {
|
|
2115
2197
|
"$ref": "#/components/schemas/CustomDownloadUrl"
|
|
2198
|
+
},
|
|
2199
|
+
"preview_summary_de": {
|
|
2200
|
+
"type": "string",
|
|
2201
|
+
"description": "Compact German summary for hover and list preview surfaces.",
|
|
2202
|
+
"readOnly": true
|
|
2203
|
+
},
|
|
2204
|
+
"short_summary_de": {
|
|
2205
|
+
"type": "string",
|
|
2206
|
+
"description": "Short German paragraph summary for file preview surfaces.",
|
|
2207
|
+
"readOnly": true
|
|
2208
|
+
},
|
|
2209
|
+
"preview_summary_en": {
|
|
2210
|
+
"type": "string",
|
|
2211
|
+
"description": "Compact English summary for hover and list preview surfaces.",
|
|
2212
|
+
"readOnly": true
|
|
2213
|
+
},
|
|
2214
|
+
"short_summary_en": {
|
|
2215
|
+
"type": "string",
|
|
2216
|
+
"description": "Short English paragraph summary for file preview surfaces.",
|
|
2217
|
+
"readOnly": true
|
|
2218
|
+
},
|
|
2219
|
+
"summary_status": {
|
|
2220
|
+
"$ref": "#/components/schemas/FileSummaryStatus"
|
|
2116
2221
|
}
|
|
2117
2222
|
}
|
|
2118
2223
|
},
|
|
@@ -2133,6 +2238,28 @@
|
|
|
2133
2238
|
"unknown"
|
|
2134
2239
|
]
|
|
2135
2240
|
},
|
|
2241
|
+
"FileSummaryStatus": {
|
|
2242
|
+
"type": "string",
|
|
2243
|
+
"description": "Current AI summary generation state for the file.",
|
|
2244
|
+
"enum": [
|
|
2245
|
+
"processing",
|
|
2246
|
+
"completed",
|
|
2247
|
+
"failed",
|
|
2248
|
+
"unsupported"
|
|
2249
|
+
],
|
|
2250
|
+
"readOnly": true
|
|
2251
|
+
},
|
|
2252
|
+
"FileSummaryGenerationStatus": {
|
|
2253
|
+
"type": "object",
|
|
2254
|
+
"properties": {
|
|
2255
|
+
"status": {
|
|
2256
|
+
"$ref": "#/components/schemas/FileSummaryStatus"
|
|
2257
|
+
}
|
|
2258
|
+
},
|
|
2259
|
+
"required": [
|
|
2260
|
+
"status"
|
|
2261
|
+
]
|
|
2262
|
+
},
|
|
2136
2263
|
"CustomDownloadUrl": {
|
|
2137
2264
|
"description": "Custom external download url used for the file",
|
|
2138
2265
|
"type": "string",
|
|
@@ -2515,9 +2642,10 @@
|
|
|
2515
2642
|
"example": "Documents.zip"
|
|
2516
2643
|
},
|
|
2517
2644
|
"notify_email": {
|
|
2518
|
-
"type": "
|
|
2519
|
-
"
|
|
2520
|
-
"
|
|
2645
|
+
"type": "string",
|
|
2646
|
+
"format": "email",
|
|
2647
|
+
"description": "Email address to notify when the ZIP is ready. Omit to skip the email notification.",
|
|
2648
|
+
"example": "user@example.com"
|
|
2521
2649
|
}
|
|
2522
2650
|
},
|
|
2523
2651
|
"oneOf": [
|
|
@@ -3070,6 +3198,26 @@
|
|
|
3070
3198
|
}
|
|
3071
3199
|
}
|
|
3072
3200
|
},
|
|
3201
|
+
"ConflictError": {
|
|
3202
|
+
"description": "The request conflicts with the current resource state",
|
|
3203
|
+
"content": {
|
|
3204
|
+
"application/json": {
|
|
3205
|
+
"schema": {
|
|
3206
|
+
"allOf": [
|
|
3207
|
+
{
|
|
3208
|
+
"$ref": "#/components/schemas/ErrorObject"
|
|
3209
|
+
},
|
|
3210
|
+
{
|
|
3211
|
+
"example": {
|
|
3212
|
+
"status": 409,
|
|
3213
|
+
"error": "Extracted file content is still being prepared"
|
|
3214
|
+
}
|
|
3215
|
+
}
|
|
3216
|
+
]
|
|
3217
|
+
}
|
|
3218
|
+
}
|
|
3219
|
+
}
|
|
3220
|
+
},
|
|
3073
3221
|
"InternalServerError": {
|
|
3074
3222
|
"description": "An unexpected error occurred on the server",
|
|
3075
3223
|
"content": {
|