@epilot/sdk 2.9.5 → 2.10.1
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/definitions/file-runtime.json +1 -1
- package/definitions/file.json +291 -15
- package/definitions/integration-toolkit-runtime.json +1 -1
- package/definitions/integration-toolkit.json +213 -2
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/calendar.cjs +6 -6
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +6 -6
- package/dist/apis/customer-portal.js +1 -1
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +8 -8
- package/dist/apis/file.d.cts +2 -2
- package/dist/apis/file.d.ts +2 -2
- package/dist/apis/file.js +2 -2
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/integration-toolkit.cjs +8 -8
- package/dist/apis/integration-toolkit.d.cts +2 -2
- package/dist/apis/integration-toolkit.d.ts +2 -2
- package/dist/apis/integration-toolkit.js +2 -2
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/snapshot.cjs +6 -6
- package/dist/apis/snapshot.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/chunk-7WGJSGWE.js +14 -0
- package/dist/chunk-G5KVG3RU.js +14 -0
- package/dist/{chunk-DBRYXXXY.js → chunk-H3ZV5T3V.js} +4 -4
- package/dist/{chunk-IIQYDQGR.cjs → chunk-HB6KHEKG.cjs} +4 -4
- package/dist/chunk-LNLUCLPL.cjs +14 -0
- package/dist/chunk-YISO22FS.cjs +14 -0
- package/dist/file-7CQXDQ3I.cjs +7 -0
- package/dist/file-O6ZD3HOU.js +7 -0
- package/dist/file-runtime-HYLQTQBX.cjs +5 -0
- package/dist/{file-runtime-DKGFS44O.js → file-runtime-VY6DJAQ3.js} +1 -1
- package/dist/{file.d-BjlMgTwj.d.cts → file.d-BN417xok.d.cts} +416 -23
- package/dist/{file.d-BjlMgTwj.d.ts → file.d-BN417xok.d.ts} +416 -23
- package/dist/index.cjs +12 -12
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +3 -3
- package/dist/integration-toolkit-DUMRNE6A.cjs +7 -0
- package/dist/integration-toolkit-IK7KA76K.js +7 -0
- package/dist/{integration-toolkit-runtime-FR6RZS5O.cjs → integration-toolkit-runtime-4LHEPGGC.cjs} +2 -2
- package/dist/{integration-toolkit-runtime-I2O6QP5G.js → integration-toolkit-runtime-5K3AAC63.js} +1 -1
- package/dist/{integration-toolkit.d-DUZ_fiuf.d.cts → integration-toolkit.d-BVe_MBBi.d.cts} +162 -3
- package/dist/{integration-toolkit.d-DUZ_fiuf.d.ts → integration-toolkit.d-BVe_MBBi.d.ts} +162 -3
- package/docs/file.md +165 -25
- package/docs/integration-toolkit.md +133 -0
- package/package.json +1 -1
- package/dist/chunk-3CNCQJOJ.js +0 -14
- package/dist/chunk-4M5V6BIT.cjs +0 -14
- package/dist/chunk-ILIHCSNO.cjs +0 -14
- package/dist/chunk-RDVFQOCQ.js +0 -14
- package/dist/file-2MSILSPP.cjs +0 -7
- package/dist/file-JVFTT5RZ.js +0 -7
- package/dist/file-runtime-7AWKNQU6.cjs +0 -5
- package/dist/integration-toolkit-TL3BQ6FJ.cjs +0 -7
- package/dist/integration-toolkit-X3Y4OFVW.js +0 -7
|
@@ -2353,6 +2353,12 @@ declare namespace Components {
|
|
|
2353
2353
|
* https://some-api-url.com/download?file_id=123
|
|
2354
2354
|
*/
|
|
2355
2355
|
export type CustomDownloadUrl = string; // uri
|
|
2356
|
+
/**
|
|
2357
|
+
* Authorization mode for the custom_download_url. `presigned` (the default) uses an HMAC-signed URL; `token` authorizes the download via the caller's bearer token, matched against the exact stored custom_download_url. In token mode the File API returns the unsigned custom_download_url (no expires_at/signature query params) so the stored url matches exactly.
|
|
2358
|
+
* example:
|
|
2359
|
+
* token
|
|
2360
|
+
*/
|
|
2361
|
+
export type CustomDownloadUrlAuth = "presigned" | "token";
|
|
2356
2362
|
export type DownloadFilesPayload = {
|
|
2357
2363
|
id: /**
|
|
2358
2364
|
* example:
|
|
@@ -2452,6 +2458,12 @@ declare namespace Components {
|
|
|
2452
2458
|
* https://some-api-url.com/download?file_id=123
|
|
2453
2459
|
*/
|
|
2454
2460
|
CustomDownloadUrl /* uri */;
|
|
2461
|
+
custom_download_url_auth?: /**
|
|
2462
|
+
* Authorization mode for the custom_download_url. `presigned` (the default) uses an HMAC-signed URL; `token` authorizes the download via the caller's bearer token, matched against the exact stored custom_download_url. In token mode the File API returns the unsigned custom_download_url (no expires_at/signature query params) so the stored url matches exactly.
|
|
2463
|
+
* example:
|
|
2464
|
+
* token
|
|
2465
|
+
*/
|
|
2466
|
+
CustomDownloadUrlAuth;
|
|
2455
2467
|
/**
|
|
2456
2468
|
* Compact German summary for hover and list preview surfaces.
|
|
2457
2469
|
*/
|
|
@@ -2468,7 +2480,6 @@ declare namespace Components {
|
|
|
2468
2480
|
* Short English paragraph summary for file preview surfaces.
|
|
2469
2481
|
*/
|
|
2470
2482
|
short_summary_en?: string;
|
|
2471
|
-
summary_status?: /* Current AI summary generation state for the file. */ FileSummaryStatus;
|
|
2472
2483
|
}
|
|
2473
2484
|
export interface FileCollectionAttributes {
|
|
2474
2485
|
/**
|
|
@@ -2668,6 +2679,12 @@ declare namespace Components {
|
|
|
2668
2679
|
* https://some-api-url.com/download?file_id=123
|
|
2669
2680
|
*/
|
|
2670
2681
|
CustomDownloadUrl /* uri */;
|
|
2682
|
+
custom_download_url_auth?: /**
|
|
2683
|
+
* Authorization mode for the custom_download_url. `presigned` (the default) uses an HMAC-signed URL; `token` authorizes the download via the caller's bearer token, matched against the exact stored custom_download_url. In token mode the File API returns the unsigned custom_download_url (no expires_at/signature query params) so the stored url matches exactly.
|
|
2684
|
+
* example:
|
|
2685
|
+
* token
|
|
2686
|
+
*/
|
|
2687
|
+
CustomDownloadUrlAuth;
|
|
2671
2688
|
/**
|
|
2672
2689
|
* Compact German summary for hover and list preview surfaces.
|
|
2673
2690
|
*/
|
|
@@ -2684,7 +2701,6 @@ declare namespace Components {
|
|
|
2684
2701
|
* Short English paragraph summary for file preview surfaces.
|
|
2685
2702
|
*/
|
|
2686
2703
|
short_summary_en?: string;
|
|
2687
|
-
summary_status?: /* Current AI summary generation state for the file. */ FileSummaryStatus;
|
|
2688
2704
|
/**
|
|
2689
2705
|
* Source URL for the file. Included if the entity was created from source_url, or when ?source_url=true
|
|
2690
2706
|
* example:
|
|
@@ -2756,13 +2772,52 @@ declare namespace Components {
|
|
|
2756
2772
|
EntitySlug;
|
|
2757
2773
|
_tags?: string[];
|
|
2758
2774
|
}
|
|
2759
|
-
export interface
|
|
2760
|
-
status
|
|
2775
|
+
export interface FileSummary {
|
|
2776
|
+
status?: /* Current state of a file summary job. */ FileSummaryJobStatus;
|
|
2777
|
+
/**
|
|
2778
|
+
* Current summary job ID when available.
|
|
2779
|
+
*/
|
|
2780
|
+
job_id?: string; // uuid
|
|
2781
|
+
/**
|
|
2782
|
+
* Compact German summary for hover and list preview surfaces.
|
|
2783
|
+
*/
|
|
2784
|
+
preview_summary_de?: string | null;
|
|
2785
|
+
/**
|
|
2786
|
+
* Short German paragraph summary for file preview surfaces.
|
|
2787
|
+
*/
|
|
2788
|
+
short_summary_de?: string | null;
|
|
2789
|
+
/**
|
|
2790
|
+
* Compact English summary for hover and list preview surfaces.
|
|
2791
|
+
*/
|
|
2792
|
+
preview_summary_en?: string | null;
|
|
2793
|
+
/**
|
|
2794
|
+
* Short English paragraph summary for file preview surfaces.
|
|
2795
|
+
*/
|
|
2796
|
+
short_summary_en?: string | null;
|
|
2797
|
+
}
|
|
2798
|
+
export interface FileSummaryJob {
|
|
2799
|
+
/**
|
|
2800
|
+
* File summary job ID.
|
|
2801
|
+
*/
|
|
2802
|
+
job_id: string; // uuid
|
|
2803
|
+
file_id: /**
|
|
2804
|
+
* example:
|
|
2805
|
+
* ef7d985c-2385-44f4-9c71-ae06a52264f8
|
|
2806
|
+
*/
|
|
2807
|
+
FileEntityId;
|
|
2808
|
+
status: /* Current state of a file summary job. */ FileSummaryJobStatus;
|
|
2809
|
+
/**
|
|
2810
|
+
* Human-readable failure or unsupported reason when available.
|
|
2811
|
+
*/
|
|
2812
|
+
error?: string;
|
|
2813
|
+
created_at: string; // date-time
|
|
2814
|
+
updated_at: string; // date-time
|
|
2815
|
+
completed_at?: string; // date-time
|
|
2761
2816
|
}
|
|
2762
2817
|
/**
|
|
2763
|
-
* Current
|
|
2818
|
+
* Current state of a file summary job.
|
|
2764
2819
|
*/
|
|
2765
|
-
export type
|
|
2820
|
+
export type FileSummaryJobStatus = "queued" | "waiting_for_extraction" | "processing" | "completed" | "failed" | "unsupported" | "stale";
|
|
2766
2821
|
export type FileType = "document" | "document_template" | "text" | "image" | "video" | "audio" | "spreadsheet" | "presentation" | "font" | "archive" | "application" | "unknown";
|
|
2767
2822
|
export interface FileUpload {
|
|
2768
2823
|
s3ref?: S3Reference;
|
|
@@ -2887,6 +2942,12 @@ declare namespace Components {
|
|
|
2887
2942
|
* https://some-api-url.com/download?file_id=123
|
|
2888
2943
|
*/
|
|
2889
2944
|
CustomDownloadUrl /* uri */;
|
|
2945
|
+
custom_download_url_auth?: /**
|
|
2946
|
+
* Authorization mode for the custom_download_url. `presigned` (the default) uses an HMAC-signed URL; `token` authorizes the download via the caller's bearer token, matched against the exact stored custom_download_url. In token mode the File API returns the unsigned custom_download_url (no expires_at/signature query params) so the stored url matches exactly.
|
|
2947
|
+
* example:
|
|
2948
|
+
* token
|
|
2949
|
+
*/
|
|
2950
|
+
CustomDownloadUrlAuth;
|
|
2890
2951
|
/**
|
|
2891
2952
|
* Compact German summary for hover and list preview surfaces.
|
|
2892
2953
|
*/
|
|
@@ -2903,7 +2964,6 @@ declare namespace Components {
|
|
|
2903
2964
|
* Short English paragraph summary for file preview surfaces.
|
|
2904
2965
|
*/
|
|
2905
2966
|
short_summary_en?: string;
|
|
2906
|
-
summary_status?: /* Current AI summary generation state for the file. */ FileSummaryStatus;
|
|
2907
2967
|
}
|
|
2908
2968
|
export interface SaveFileFromSourceURLPayload {
|
|
2909
2969
|
[name: string]: any;
|
|
@@ -2983,6 +3043,12 @@ declare namespace Components {
|
|
|
2983
3043
|
* https://some-api-url.com/download?file_id=123
|
|
2984
3044
|
*/
|
|
2985
3045
|
CustomDownloadUrl /* uri */;
|
|
3046
|
+
custom_download_url_auth?: /**
|
|
3047
|
+
* Authorization mode for the custom_download_url. `presigned` (the default) uses an HMAC-signed URL; `token` authorizes the download via the caller's bearer token, matched against the exact stored custom_download_url. In token mode the File API returns the unsigned custom_download_url (no expires_at/signature query params) so the stored url matches exactly.
|
|
3048
|
+
* example:
|
|
3049
|
+
* token
|
|
3050
|
+
*/
|
|
3051
|
+
CustomDownloadUrlAuth;
|
|
2986
3052
|
/**
|
|
2987
3053
|
* Compact German summary for hover and list preview surfaces.
|
|
2988
3054
|
*/
|
|
@@ -2999,7 +3065,6 @@ declare namespace Components {
|
|
|
2999
3065
|
* Short English paragraph summary for file preview surfaces.
|
|
3000
3066
|
*/
|
|
3001
3067
|
short_summary_en?: string;
|
|
3002
|
-
summary_status?: /* Current AI summary generation state for the file. */ FileSummaryStatus;
|
|
3003
3068
|
source_url?: /**
|
|
3004
3069
|
* Custom external download url used for the file
|
|
3005
3070
|
* example:
|
|
@@ -3087,6 +3152,12 @@ declare namespace Components {
|
|
|
3087
3152
|
* https://some-api-url.com/download?file_id=123
|
|
3088
3153
|
*/
|
|
3089
3154
|
CustomDownloadUrl /* uri */;
|
|
3155
|
+
custom_download_url_auth?: /**
|
|
3156
|
+
* Authorization mode for the custom_download_url. `presigned` (the default) uses an HMAC-signed URL; `token` authorizes the download via the caller's bearer token, matched against the exact stored custom_download_url. In token mode the File API returns the unsigned custom_download_url (no expires_at/signature query params) so the stored url matches exactly.
|
|
3157
|
+
* example:
|
|
3158
|
+
* token
|
|
3159
|
+
*/
|
|
3160
|
+
CustomDownloadUrlAuth;
|
|
3090
3161
|
/**
|
|
3091
3162
|
* Compact German summary for hover and list preview surfaces.
|
|
3092
3163
|
*/
|
|
@@ -3103,7 +3174,6 @@ declare namespace Components {
|
|
|
3103
3174
|
* Short English paragraph summary for file preview surfaces.
|
|
3104
3175
|
*/
|
|
3105
3176
|
short_summary_en?: string;
|
|
3106
|
-
summary_status?: /* Current AI summary generation state for the file. */ FileSummaryStatus;
|
|
3107
3177
|
s3ref?: S3Ref;
|
|
3108
3178
|
}
|
|
3109
3179
|
export interface UploadFilePayload {
|
|
@@ -3273,6 +3343,66 @@ declare namespace Paths {
|
|
|
3273
3343
|
Components.Responses.InternalServerError;
|
|
3274
3344
|
}
|
|
3275
3345
|
}
|
|
3346
|
+
namespace CreateFileSummaryJob {
|
|
3347
|
+
namespace Parameters {
|
|
3348
|
+
export type Id = /**
|
|
3349
|
+
* example:
|
|
3350
|
+
* ef7d985c-2385-44f4-9c71-ae06a52264f8
|
|
3351
|
+
*/
|
|
3352
|
+
Components.Schemas.FileEntityId;
|
|
3353
|
+
}
|
|
3354
|
+
export interface PathParameters {
|
|
3355
|
+
id: Parameters.Id;
|
|
3356
|
+
}
|
|
3357
|
+
namespace Responses {
|
|
3358
|
+
export type $202 = Components.Schemas.FileSummaryJob;
|
|
3359
|
+
export type $400 = /**
|
|
3360
|
+
* A generic error returned by the API
|
|
3361
|
+
* example:
|
|
3362
|
+
* {
|
|
3363
|
+
* "status": 400,
|
|
3364
|
+
* "error": "Bad Request: filename is required"
|
|
3365
|
+
* }
|
|
3366
|
+
*/
|
|
3367
|
+
Components.Responses.BadRequestError;
|
|
3368
|
+
export type $401 = /**
|
|
3369
|
+
* A generic error returned by the API
|
|
3370
|
+
* example:
|
|
3371
|
+
* {
|
|
3372
|
+
* "status": 401,
|
|
3373
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
3374
|
+
* }
|
|
3375
|
+
*/
|
|
3376
|
+
Components.Responses.UnauthorizedError;
|
|
3377
|
+
export type $403 = /**
|
|
3378
|
+
* A generic error returned by the API
|
|
3379
|
+
* example:
|
|
3380
|
+
* {
|
|
3381
|
+
* "status": 403,
|
|
3382
|
+
* "error": "Forbidden: You do not have permission to access this file"
|
|
3383
|
+
* }
|
|
3384
|
+
*/
|
|
3385
|
+
Components.Responses.ForbiddenError;
|
|
3386
|
+
export type $404 = /**
|
|
3387
|
+
* A generic error returned by the API
|
|
3388
|
+
* example:
|
|
3389
|
+
* {
|
|
3390
|
+
* "status": 404,
|
|
3391
|
+
* "error": "Not Found: File entity not found"
|
|
3392
|
+
* }
|
|
3393
|
+
*/
|
|
3394
|
+
Components.Responses.NotFoundError;
|
|
3395
|
+
export type $500 = /**
|
|
3396
|
+
* A generic error returned by the API
|
|
3397
|
+
* example:
|
|
3398
|
+
* {
|
|
3399
|
+
* "status": 500,
|
|
3400
|
+
* "error": "Internal Server Error"
|
|
3401
|
+
* }
|
|
3402
|
+
*/
|
|
3403
|
+
Components.Responses.InternalServerError;
|
|
3404
|
+
}
|
|
3405
|
+
}
|
|
3276
3406
|
namespace CreateUserSchemaFileCollection {
|
|
3277
3407
|
namespace Parameters {
|
|
3278
3408
|
export type Slug = string;
|
|
@@ -3643,7 +3773,7 @@ declare namespace Paths {
|
|
|
3643
3773
|
id: Parameters.Id;
|
|
3644
3774
|
}
|
|
3645
3775
|
namespace Responses {
|
|
3646
|
-
export type $202 = Components.Schemas.
|
|
3776
|
+
export type $202 = Components.Schemas.FileSummaryJob;
|
|
3647
3777
|
export type $400 = /**
|
|
3648
3778
|
* A generic error returned by the API
|
|
3649
3779
|
* example:
|
|
@@ -3680,15 +3810,60 @@ declare namespace Paths {
|
|
|
3680
3810
|
* }
|
|
3681
3811
|
*/
|
|
3682
3812
|
Components.Responses.NotFoundError;
|
|
3683
|
-
export type $
|
|
3813
|
+
export type $500 = /**
|
|
3684
3814
|
* A generic error returned by the API
|
|
3685
3815
|
* example:
|
|
3686
3816
|
* {
|
|
3687
|
-
* "status":
|
|
3688
|
-
* "error": "
|
|
3817
|
+
* "status": 500,
|
|
3818
|
+
* "error": "Internal Server Error"
|
|
3689
3819
|
* }
|
|
3690
3820
|
*/
|
|
3691
|
-
Components.Responses.
|
|
3821
|
+
Components.Responses.InternalServerError;
|
|
3822
|
+
}
|
|
3823
|
+
}
|
|
3824
|
+
namespace GeneratePublicLink {
|
|
3825
|
+
namespace Parameters {
|
|
3826
|
+
export type Id = /**
|
|
3827
|
+
* example:
|
|
3828
|
+
* ef7d985c-2385-44f4-9c71-ae06a52264f8
|
|
3829
|
+
*/
|
|
3830
|
+
Components.Schemas.FileEntityId;
|
|
3831
|
+
}
|
|
3832
|
+
export interface PathParameters {
|
|
3833
|
+
id: Parameters.Id;
|
|
3834
|
+
}
|
|
3835
|
+
namespace Responses {
|
|
3836
|
+
/**
|
|
3837
|
+
* The public URL that can be shared externally
|
|
3838
|
+
*/
|
|
3839
|
+
export type $201 = string;
|
|
3840
|
+
export type $401 = /**
|
|
3841
|
+
* A generic error returned by the API
|
|
3842
|
+
* example:
|
|
3843
|
+
* {
|
|
3844
|
+
* "status": 401,
|
|
3845
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
3846
|
+
* }
|
|
3847
|
+
*/
|
|
3848
|
+
Components.Responses.UnauthorizedError;
|
|
3849
|
+
export type $403 = /**
|
|
3850
|
+
* A generic error returned by the API
|
|
3851
|
+
* example:
|
|
3852
|
+
* {
|
|
3853
|
+
* "status": 403,
|
|
3854
|
+
* "error": "Forbidden: You do not have permission to access this file"
|
|
3855
|
+
* }
|
|
3856
|
+
*/
|
|
3857
|
+
Components.Responses.ForbiddenError;
|
|
3858
|
+
export type $404 = /**
|
|
3859
|
+
* A generic error returned by the API
|
|
3860
|
+
* example:
|
|
3861
|
+
* {
|
|
3862
|
+
* "status": 404,
|
|
3863
|
+
* "error": "Not Found: File entity not found"
|
|
3864
|
+
* }
|
|
3865
|
+
*/
|
|
3866
|
+
Components.Responses.NotFoundError;
|
|
3692
3867
|
export type $500 = /**
|
|
3693
3868
|
* A generic error returned by the API
|
|
3694
3869
|
* example:
|
|
@@ -3700,7 +3875,7 @@ declare namespace Paths {
|
|
|
3700
3875
|
Components.Responses.InternalServerError;
|
|
3701
3876
|
}
|
|
3702
3877
|
}
|
|
3703
|
-
namespace
|
|
3878
|
+
namespace GetCurrentFileSummaryJob {
|
|
3704
3879
|
namespace Parameters {
|
|
3705
3880
|
export type Id = /**
|
|
3706
3881
|
* example:
|
|
@@ -3712,10 +3887,16 @@ declare namespace Paths {
|
|
|
3712
3887
|
id: Parameters.Id;
|
|
3713
3888
|
}
|
|
3714
3889
|
namespace Responses {
|
|
3715
|
-
|
|
3716
|
-
|
|
3890
|
+
export type $200 = Components.Schemas.FileSummaryJob;
|
|
3891
|
+
export type $400 = /**
|
|
3892
|
+
* A generic error returned by the API
|
|
3893
|
+
* example:
|
|
3894
|
+
* {
|
|
3895
|
+
* "status": 400,
|
|
3896
|
+
* "error": "Bad Request: filename is required"
|
|
3897
|
+
* }
|
|
3717
3898
|
*/
|
|
3718
|
-
|
|
3899
|
+
Components.Responses.BadRequestError;
|
|
3719
3900
|
export type $401 = /**
|
|
3720
3901
|
* A generic error returned by the API
|
|
3721
3902
|
* example:
|
|
@@ -3816,6 +3997,128 @@ declare namespace Paths {
|
|
|
3816
3997
|
Components.Responses.InternalServerError;
|
|
3817
3998
|
}
|
|
3818
3999
|
}
|
|
4000
|
+
namespace GetFileSummary {
|
|
4001
|
+
namespace Parameters {
|
|
4002
|
+
export type Id = /**
|
|
4003
|
+
* example:
|
|
4004
|
+
* ef7d985c-2385-44f4-9c71-ae06a52264f8
|
|
4005
|
+
*/
|
|
4006
|
+
Components.Schemas.FileEntityId;
|
|
4007
|
+
}
|
|
4008
|
+
export interface PathParameters {
|
|
4009
|
+
id: Parameters.Id;
|
|
4010
|
+
}
|
|
4011
|
+
namespace Responses {
|
|
4012
|
+
export type $200 = Components.Schemas.FileSummary;
|
|
4013
|
+
export type $400 = /**
|
|
4014
|
+
* A generic error returned by the API
|
|
4015
|
+
* example:
|
|
4016
|
+
* {
|
|
4017
|
+
* "status": 400,
|
|
4018
|
+
* "error": "Bad Request: filename is required"
|
|
4019
|
+
* }
|
|
4020
|
+
*/
|
|
4021
|
+
Components.Responses.BadRequestError;
|
|
4022
|
+
export type $401 = /**
|
|
4023
|
+
* A generic error returned by the API
|
|
4024
|
+
* example:
|
|
4025
|
+
* {
|
|
4026
|
+
* "status": 401,
|
|
4027
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
4028
|
+
* }
|
|
4029
|
+
*/
|
|
4030
|
+
Components.Responses.UnauthorizedError;
|
|
4031
|
+
export type $403 = /**
|
|
4032
|
+
* A generic error returned by the API
|
|
4033
|
+
* example:
|
|
4034
|
+
* {
|
|
4035
|
+
* "status": 403,
|
|
4036
|
+
* "error": "Forbidden: You do not have permission to access this file"
|
|
4037
|
+
* }
|
|
4038
|
+
*/
|
|
4039
|
+
Components.Responses.ForbiddenError;
|
|
4040
|
+
export type $404 = /**
|
|
4041
|
+
* A generic error returned by the API
|
|
4042
|
+
* example:
|
|
4043
|
+
* {
|
|
4044
|
+
* "status": 404,
|
|
4045
|
+
* "error": "Not Found: File entity not found"
|
|
4046
|
+
* }
|
|
4047
|
+
*/
|
|
4048
|
+
Components.Responses.NotFoundError;
|
|
4049
|
+
export type $500 = /**
|
|
4050
|
+
* A generic error returned by the API
|
|
4051
|
+
* example:
|
|
4052
|
+
* {
|
|
4053
|
+
* "status": 500,
|
|
4054
|
+
* "error": "Internal Server Error"
|
|
4055
|
+
* }
|
|
4056
|
+
*/
|
|
4057
|
+
Components.Responses.InternalServerError;
|
|
4058
|
+
}
|
|
4059
|
+
}
|
|
4060
|
+
namespace GetFileSummaryJob {
|
|
4061
|
+
namespace Parameters {
|
|
4062
|
+
export type Id = /**
|
|
4063
|
+
* example:
|
|
4064
|
+
* ef7d985c-2385-44f4-9c71-ae06a52264f8
|
|
4065
|
+
*/
|
|
4066
|
+
Components.Schemas.FileEntityId;
|
|
4067
|
+
export type JobId = string; // uuid
|
|
4068
|
+
}
|
|
4069
|
+
export interface PathParameters {
|
|
4070
|
+
id: Parameters.Id;
|
|
4071
|
+
job_id: Parameters.JobId /* uuid */;
|
|
4072
|
+
}
|
|
4073
|
+
namespace Responses {
|
|
4074
|
+
export type $200 = Components.Schemas.FileSummaryJob;
|
|
4075
|
+
export type $400 = /**
|
|
4076
|
+
* A generic error returned by the API
|
|
4077
|
+
* example:
|
|
4078
|
+
* {
|
|
4079
|
+
* "status": 400,
|
|
4080
|
+
* "error": "Bad Request: filename is required"
|
|
4081
|
+
* }
|
|
4082
|
+
*/
|
|
4083
|
+
Components.Responses.BadRequestError;
|
|
4084
|
+
export type $401 = /**
|
|
4085
|
+
* A generic error returned by the API
|
|
4086
|
+
* example:
|
|
4087
|
+
* {
|
|
4088
|
+
* "status": 401,
|
|
4089
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
4090
|
+
* }
|
|
4091
|
+
*/
|
|
4092
|
+
Components.Responses.UnauthorizedError;
|
|
4093
|
+
export type $403 = /**
|
|
4094
|
+
* A generic error returned by the API
|
|
4095
|
+
* example:
|
|
4096
|
+
* {
|
|
4097
|
+
* "status": 403,
|
|
4098
|
+
* "error": "Forbidden: You do not have permission to access this file"
|
|
4099
|
+
* }
|
|
4100
|
+
*/
|
|
4101
|
+
Components.Responses.ForbiddenError;
|
|
4102
|
+
export type $404 = /**
|
|
4103
|
+
* A generic error returned by the API
|
|
4104
|
+
* example:
|
|
4105
|
+
* {
|
|
4106
|
+
* "status": 404,
|
|
4107
|
+
* "error": "Not Found: File entity not found"
|
|
4108
|
+
* }
|
|
4109
|
+
*/
|
|
4110
|
+
Components.Responses.NotFoundError;
|
|
4111
|
+
export type $500 = /**
|
|
4112
|
+
* A generic error returned by the API
|
|
4113
|
+
* example:
|
|
4114
|
+
* {
|
|
4115
|
+
* "status": 500,
|
|
4116
|
+
* "error": "Internal Server Error"
|
|
4117
|
+
* }
|
|
4118
|
+
*/
|
|
4119
|
+
Components.Responses.InternalServerError;
|
|
4120
|
+
}
|
|
4121
|
+
}
|
|
3819
4122
|
namespace GetFilesInCollection {
|
|
3820
4123
|
namespace Parameters {
|
|
3821
4124
|
export type CollectionSlug = string;
|
|
@@ -4722,10 +5025,50 @@ interface OperationMethods {
|
|
|
4722
5025
|
data?: any,
|
|
4723
5026
|
config?: AxiosRequestConfig
|
|
4724
5027
|
): OperationResponse<Paths.GetZipJob.Responses.$200>
|
|
5028
|
+
/**
|
|
5029
|
+
* getFileSummary - getFileSummary
|
|
5030
|
+
*
|
|
5031
|
+
* Get summary text for a file entity together with the current summary job status when available.
|
|
5032
|
+
*/
|
|
5033
|
+
'getFileSummary'(
|
|
5034
|
+
parameters?: Parameters<Paths.GetFileSummary.PathParameters> | null,
|
|
5035
|
+
data?: any,
|
|
5036
|
+
config?: AxiosRequestConfig
|
|
5037
|
+
): OperationResponse<Paths.GetFileSummary.Responses.$200>
|
|
5038
|
+
/**
|
|
5039
|
+
* createFileSummaryJob - createFileSummaryJob
|
|
5040
|
+
*
|
|
5041
|
+
* Create or return the current AI summary job for a file entity.
|
|
5042
|
+
*/
|
|
5043
|
+
'createFileSummaryJob'(
|
|
5044
|
+
parameters?: Parameters<Paths.CreateFileSummaryJob.PathParameters> | null,
|
|
5045
|
+
data?: any,
|
|
5046
|
+
config?: AxiosRequestConfig
|
|
5047
|
+
): OperationResponse<Paths.CreateFileSummaryJob.Responses.$202>
|
|
5048
|
+
/**
|
|
5049
|
+
* getCurrentFileSummaryJob - getCurrentFileSummaryJob
|
|
5050
|
+
*
|
|
5051
|
+
* Get the latest AI summary job for the file entity's current source.
|
|
5052
|
+
*/
|
|
5053
|
+
'getCurrentFileSummaryJob'(
|
|
5054
|
+
parameters?: Parameters<Paths.GetCurrentFileSummaryJob.PathParameters> | null,
|
|
5055
|
+
data?: any,
|
|
5056
|
+
config?: AxiosRequestConfig
|
|
5057
|
+
): OperationResponse<Paths.GetCurrentFileSummaryJob.Responses.$200>
|
|
5058
|
+
/**
|
|
5059
|
+
* getFileSummaryJob - getFileSummaryJob
|
|
5060
|
+
*
|
|
5061
|
+
* Get an AI summary job by id.
|
|
5062
|
+
*/
|
|
5063
|
+
'getFileSummaryJob'(
|
|
5064
|
+
parameters?: Parameters<Paths.GetFileSummaryJob.PathParameters> | null,
|
|
5065
|
+
data?: any,
|
|
5066
|
+
config?: AxiosRequestConfig
|
|
5067
|
+
): OperationResponse<Paths.GetFileSummaryJob.Responses.$200>
|
|
4725
5068
|
/**
|
|
4726
5069
|
* generateFileSummary - generateFileSummary
|
|
4727
5070
|
*
|
|
4728
|
-
*
|
|
5071
|
+
* Compatibility alias for creating or returning the current AI summary job for a file entity.
|
|
4729
5072
|
*/
|
|
4730
5073
|
'generateFileSummary'(
|
|
4731
5074
|
parameters?: Parameters<Paths.GenerateFileSummary.PathParameters> | null,
|
|
@@ -5183,11 +5526,59 @@ interface PathsDictionary {
|
|
|
5183
5526
|
config?: AxiosRequestConfig
|
|
5184
5527
|
): OperationResponse<Paths.GetZipJob.Responses.$200>
|
|
5185
5528
|
}
|
|
5529
|
+
['/v1/files/{id}/summary']: {
|
|
5530
|
+
/**
|
|
5531
|
+
* getFileSummary - getFileSummary
|
|
5532
|
+
*
|
|
5533
|
+
* Get summary text for a file entity together with the current summary job status when available.
|
|
5534
|
+
*/
|
|
5535
|
+
'get'(
|
|
5536
|
+
parameters?: Parameters<Paths.GetFileSummary.PathParameters> | null,
|
|
5537
|
+
data?: any,
|
|
5538
|
+
config?: AxiosRequestConfig
|
|
5539
|
+
): OperationResponse<Paths.GetFileSummary.Responses.$200>
|
|
5540
|
+
}
|
|
5541
|
+
['/v1/files/{id}/summary-jobs']: {
|
|
5542
|
+
/**
|
|
5543
|
+
* createFileSummaryJob - createFileSummaryJob
|
|
5544
|
+
*
|
|
5545
|
+
* Create or return the current AI summary job for a file entity.
|
|
5546
|
+
*/
|
|
5547
|
+
'post'(
|
|
5548
|
+
parameters?: Parameters<Paths.CreateFileSummaryJob.PathParameters> | null,
|
|
5549
|
+
data?: any,
|
|
5550
|
+
config?: AxiosRequestConfig
|
|
5551
|
+
): OperationResponse<Paths.CreateFileSummaryJob.Responses.$202>
|
|
5552
|
+
}
|
|
5553
|
+
['/v1/files/{id}/summary-jobs/current']: {
|
|
5554
|
+
/**
|
|
5555
|
+
* getCurrentFileSummaryJob - getCurrentFileSummaryJob
|
|
5556
|
+
*
|
|
5557
|
+
* Get the latest AI summary job for the file entity's current source.
|
|
5558
|
+
*/
|
|
5559
|
+
'get'(
|
|
5560
|
+
parameters?: Parameters<Paths.GetCurrentFileSummaryJob.PathParameters> | null,
|
|
5561
|
+
data?: any,
|
|
5562
|
+
config?: AxiosRequestConfig
|
|
5563
|
+
): OperationResponse<Paths.GetCurrentFileSummaryJob.Responses.$200>
|
|
5564
|
+
}
|
|
5565
|
+
['/v1/files/{id}/summary-jobs/{job_id}']: {
|
|
5566
|
+
/**
|
|
5567
|
+
* getFileSummaryJob - getFileSummaryJob
|
|
5568
|
+
*
|
|
5569
|
+
* Get an AI summary job by id.
|
|
5570
|
+
*/
|
|
5571
|
+
'get'(
|
|
5572
|
+
parameters?: Parameters<Paths.GetFileSummaryJob.PathParameters> | null,
|
|
5573
|
+
data?: any,
|
|
5574
|
+
config?: AxiosRequestConfig
|
|
5575
|
+
): OperationResponse<Paths.GetFileSummaryJob.Responses.$200>
|
|
5576
|
+
}
|
|
5186
5577
|
['/v1/files/{id}/summary:generate']: {
|
|
5187
5578
|
/**
|
|
5188
5579
|
* generateFileSummary - generateFileSummary
|
|
5189
5580
|
*
|
|
5190
|
-
*
|
|
5581
|
+
* Compatibility alias for creating or returning the current AI summary job for a file entity.
|
|
5191
5582
|
*/
|
|
5192
5583
|
'post'(
|
|
5193
5584
|
parameters?: Parameters<Paths.GenerateFileSummary.PathParameters> | null,
|
|
@@ -5490,6 +5881,7 @@ type BatchSaveFileVersionPayload = Components.Schemas.BatchSaveFileVersionPayloa
|
|
|
5490
5881
|
type CommonSaveFilePayload = Components.Schemas.CommonSaveFilePayload;
|
|
5491
5882
|
type CreateZipJobPayload = Components.Schemas.CreateZipJobPayload;
|
|
5492
5883
|
type CustomDownloadUrl = Components.Schemas.CustomDownloadUrl;
|
|
5884
|
+
type CustomDownloadUrlAuth = Components.Schemas.CustomDownloadUrlAuth;
|
|
5493
5885
|
type DownloadFilesPayload = Components.Schemas.DownloadFilesPayload;
|
|
5494
5886
|
type EntityId = Components.Schemas.EntityId;
|
|
5495
5887
|
type EntitySlug = Components.Schemas.EntitySlug;
|
|
@@ -5503,8 +5895,9 @@ type FileEntity = Components.Schemas.FileEntity;
|
|
|
5503
5895
|
type FileEntityId = Components.Schemas.FileEntityId;
|
|
5504
5896
|
type FileItem = Components.Schemas.FileItem;
|
|
5505
5897
|
type FileRelationItem = Components.Schemas.FileRelationItem;
|
|
5506
|
-
type
|
|
5507
|
-
type
|
|
5898
|
+
type FileSummary = Components.Schemas.FileSummary;
|
|
5899
|
+
type FileSummaryJob = Components.Schemas.FileSummaryJob;
|
|
5900
|
+
type FileSummaryJobStatus = Components.Schemas.FileSummaryJobStatus;
|
|
5508
5901
|
type FileType = Components.Schemas.FileType;
|
|
5509
5902
|
type FileUpload = Components.Schemas.FileUpload;
|
|
5510
5903
|
type PublicLink = Components.Schemas.PublicLink;
|
|
@@ -5519,4 +5912,4 @@ type UploadFilePayload = Components.Schemas.UploadFilePayload;
|
|
|
5519
5912
|
type VerifyCustomDownloadUrlPayload = Components.Schemas.VerifyCustomDownloadUrlPayload;
|
|
5520
5913
|
type ZipJob = Components.Schemas.ZipJob;
|
|
5521
5914
|
|
|
5522
|
-
export { type ActivityId as A, type BaseEntityAcl as B, type Client as C, type DownloadFilesPayload as D, type EntityId as E, type FileAttributes as F, type
|
|
5915
|
+
export { type ActivityId as A, type BaseEntityAcl as B, type Client as C, type DownloadFilesPayload as D, type EntityId as E, type FileAttributes as F, type SaveFileFromSourceURLPayload as G, type SaveFilePayload as H, type SaveFilePayloadV2 as I, type SaveS3FilePayload as J, type OperationMethods as O, Paths as P, type S3Ref as S, type UploadFilePayload as U, type VerifyCustomDownloadUrlPayload as V, type ZipJob as Z, Components as a, type PathsDictionary as b, type BaseEntityOwner as c, type BatchSaveFileVersionPayload as d, type CommonSaveFilePayload as e, type CreateZipJobPayload as f, type CustomDownloadUrl as g, type CustomDownloadUrlAuth as h, type EntitySlug as i, type ErrorObject as j, type FileCollectionAttributes as k, type FileCollectionCreateRequest as l, type FileCollectionId as m, type FileCollectionItem as n, type FileEntity as o, type FileEntityId as p, type FileItem as q, type FileRelationItem as r, type FileSummary as s, type FileSummaryJob as t, type FileSummaryJobStatus as u, type FileType as v, type FileUpload as w, type PublicLink as x, type S3Reference as y, type SaveCustomFilePayload as z };
|