@bytescale/sdk 3.33.0 → 3.35.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.
Files changed (26) hide show
  1. package/dist/browser/cjs/main.js +511 -448
  2. package/dist/browser/esm/main.mjs +513 -449
  3. package/dist/node/cjs/main.js +488 -431
  4. package/dist/node/esm/main.mjs +500 -438
  5. package/dist/types/private/StreamUtils.d.ts +2 -0
  6. package/dist/types/private/UploadManagerBase.d.ts +3 -2
  7. package/dist/types/private/UploadManagerBrowserWorkerBase.d.ts +1 -1
  8. package/dist/types/private/dtos/AuthSwConfigDto.d.ts +1 -1
  9. package/dist/types/private/model/AddCancellationHandler.d.ts +1 -1
  10. package/dist/types/private/model/OnPartProgress.d.ts +1 -1
  11. package/dist/types/private/model/ServiceWorkerConfig.d.ts +1 -1
  12. package/dist/types/private/model/UploadResult.d.ts +7 -0
  13. package/dist/types/private/model/UploadSourceProcessed.d.ts +4 -4
  14. package/dist/types/public/node/UploadManagerNode.d.ts +1 -1
  15. package/dist/types/public/shared/CommonTypes.d.ts +2 -1
  16. package/dist/types/public/shared/UrlBuilderTypes.d.ts +6 -6
  17. package/dist/types/public/shared/generated/apis/CacheApi.d.ts +23 -0
  18. package/dist/types/public/shared/generated/apis/FileApi.d.ts +7 -7
  19. package/dist/types/public/shared/generated/apis/JobApi.d.ts +1 -1
  20. package/dist/types/public/shared/generated/apis/UploadApi.d.ts +2 -2
  21. package/dist/types/public/shared/generated/apis/index.d.ts +1 -0
  22. package/dist/types/public/shared/generated/models/index.d.ts +237 -63
  23. package/dist/types/public/shared/generated/runtime.d.ts +8 -8
  24. package/dist/worker/cjs/main.js +455 -395
  25. package/dist/worker/esm/main.mjs +457 -396
  26. package/package.json +11 -12
@@ -2,12 +2,12 @@
2
2
  *
3
3
  * @export
4
4
  */
5
- export declare type AccountJobStatus = "Created" | "Pending" | "Running" | "Rollback" | "Failed" | "Succeeded" | "Cancelling" | "Cancelled";
5
+ export type AccountJobStatus = "Created" | "Pending" | "Running" | "Rollback" | "Failed" | "Succeeded" | "Cancelling" | "Cancelled";
6
6
  /**
7
7
  * Job type.
8
8
  * @export
9
9
  */
10
- export declare type AccountJobType = "ProcessImageJob" | "ProcessVideoJob" | "ProcessAudioJob" | "AntivirusJob" | "DeleteFolderBatchJob" | "DeleteFileBatchJob" | "CopyFolderBatchJob" | "CopyFileBatchJob";
10
+ export type AccountJobType = "ProcessImageJob" | "ProcessVideoJob" | "ProcessAudioJob" | "AntivirusJob" | "ResetCacheJob" | "DeleteFolderBatchJob" | "DeleteFileBatchJob" | "CopyFolderBatchJob" | "CopyFileBatchJob";
11
11
  /**
12
12
  * Response body from an API endpoint that performs work asynchronously (i.e. does not complete the work immediately).
13
13
  * @export
@@ -46,12 +46,12 @@ export interface AsyncResponse {
46
46
  /**
47
47
  * @export
48
48
  */
49
- export declare type AsyncResponseJobDocsEnum = "https://www.bytescale.com/docs/job-api/GetJob";
49
+ export type AsyncResponseJobDocsEnum = "https://www.bytescale.com/docs/job-api/GetJob";
50
50
  /**
51
51
  * AWS Region.
52
52
  * @export
53
53
  */
54
- export declare type AwsRegion = "us-east-2" | "us-east-1" | "us-west-1" | "us-west-2" | "af-south-1" | "ap-east-1" | "ap-south-2" | "ap-southeast-3" | "ap-southeast-4" | "ap-south-1" | "ap-northeast-3" | "ap-northeast-2" | "ap-southeast-1" | "ap-southeast-2" | "ap-northeast-1" | "ca-central-1" | "ca-west-1" | "eu-central-1" | "eu-west-1" | "eu-west-2" | "eu-south-1" | "eu-west-3" | "eu-south-2" | "eu-north-1" | "eu-central-2" | "il-central-1" | "me-south-1" | "me-central-1" | "sa-east-1";
54
+ export type AwsRegion = "us-east-2" | "us-east-1" | "us-west-1" | "us-west-2" | "af-south-1" | "ap-east-1" | "ap-south-2" | "ap-southeast-3" | "ap-southeast-4" | "ap-south-1" | "ap-northeast-3" | "ap-northeast-2" | "ap-southeast-1" | "ap-southeast-2" | "ap-northeast-1" | "ca-central-1" | "ca-west-1" | "eu-central-1" | "eu-west-1" | "eu-west-2" | "eu-south-1" | "eu-west-3" | "eu-south-2" | "eu-north-1" | "eu-central-2" | "il-central-1" | "me-south-1" | "me-central-1" | "sa-east-1";
55
55
  /**
56
56
  * Response body for BasicUpload.
57
57
  * @export
@@ -68,6 +68,12 @@ export interface BasicUploadResponse {
68
68
  * @memberof BasicUploadResponse
69
69
  */
70
70
  accountId: string;
71
+ /**
72
+ * The file's ETag, short for "entity tag", reflects the file's version and changes whenever the file is modified.
73
+ * @type {string}
74
+ * @memberof BasicUploadResponse
75
+ */
76
+ etag: string;
71
77
  /**
72
78
  * Absolute path to a file. Begins with a `/`.
73
79
  * @type {string}
@@ -180,6 +186,52 @@ export interface BeginMultipartUploadResponseUploadParts {
180
186
  */
181
187
  count: number;
182
188
  }
189
+ /**
190
+ * @type CompleteMultipartUploadResponse
191
+ * Response body for CompleteUploadPart.
192
+ * @export
193
+ */
194
+ export type CompleteMultipartUploadResponse = CompleteMultipartUploadResponseCompleted | CompleteMultipartUploadResponsePending;
195
+ /**
196
+ * Response body for CompleteUploadPart when the final upload part is marked as completed.
197
+ * @export
198
+ * @interface CompleteMultipartUploadResponseCompleted
199
+ */
200
+ export interface CompleteMultipartUploadResponseCompleted {
201
+ /**
202
+ * The file's ETag, short for "entity tag", reflects the file's version and changes whenever the file is modified.
203
+ * @type {string}
204
+ * @memberof CompleteMultipartUploadResponseCompleted
205
+ */
206
+ etag: string;
207
+ /**
208
+ *
209
+ * @type {string}
210
+ * @memberof CompleteMultipartUploadResponseCompleted
211
+ */
212
+ status: CompleteMultipartUploadResponseCompletedStatusEnum;
213
+ }
214
+ /**
215
+ * @export
216
+ */
217
+ export type CompleteMultipartUploadResponseCompletedStatusEnum = "Completed";
218
+ /**
219
+ * Response body for CompleteUploadPart when additional upload parts still need to be marked as completed.
220
+ * @export
221
+ * @interface CompleteMultipartUploadResponsePending
222
+ */
223
+ export interface CompleteMultipartUploadResponsePending {
224
+ /**
225
+ *
226
+ * @type {string}
227
+ * @memberof CompleteMultipartUploadResponsePending
228
+ */
229
+ status: CompleteMultipartUploadResponsePendingStatusEnum;
230
+ }
231
+ /**
232
+ * @export
233
+ */
234
+ export type CompleteMultipartUploadResponsePendingStatusEnum = "Pending";
183
235
  /**
184
236
  * Request body for CompleteUploadPart.
185
237
  * @export
@@ -187,7 +239,7 @@ export interface BeginMultipartUploadResponseUploadParts {
187
239
  */
188
240
  export interface CompleteUploadPartRequest {
189
241
  /**
190
- * The file's ETag. An ETag (or entity tag) is an identifier for a specific version of a file.
242
+ * The file's ETag, short for "entity tag", reflects the file's version and changes whenever the file is modified.
191
243
  * @type {string}
192
244
  * @memberof CompleteUploadPartRequest
193
245
  */
@@ -218,12 +270,24 @@ export interface CopyFileRequest {
218
270
  * @memberof CopyFileRequest
219
271
  */
220
272
  destination: string;
273
+ /**
274
+ *
275
+ * @type {CopyableFileDataFileMetadata}
276
+ * @memberof CopyFileRequest
277
+ */
278
+ metadata?: CopyableFileDataFileMetadata;
221
279
  /**
222
280
  * Absolute path to a file. Begins with a `/`.
223
281
  * @type {string}
224
282
  * @memberof CopyFileRequest
225
283
  */
226
284
  source: string;
285
+ /**
286
+ *
287
+ * @type {CopyableFileDataFileTagNameArray}
288
+ * @memberof CopyFileRequest
289
+ */
290
+ tags?: CopyableFileDataFileTagNameArray;
227
291
  }
228
292
  /**
229
293
  * Response body for CopyFile.
@@ -233,10 +297,10 @@ export interface CopyFileRequest {
233
297
  export interface CopyFileResponse {
234
298
  /**
235
299
  *
236
- * @type {FileCopyStatus}
300
+ * @type {FileCopyStatusCopied}
237
301
  * @memberof CopyFileResponse
238
302
  */
239
- status: FileCopyStatus;
303
+ status: FileCopyStatusCopied;
240
304
  }
241
305
  /**
242
306
  * Request body for CopyFolderBatch.
@@ -279,7 +343,7 @@ export interface CopyFolderRequest {
279
343
  */
280
344
  copyOverriddenStorage?: boolean;
281
345
  /**
282
- * If `true` then copies virtual folder settings at the current path and below, else only files will be copied.
346
+ * If `true` then copies virtual folders at the current path and below, else only files will be copied.
283
347
  *
284
348
  * Virtual folders are folders that have been created using the PutFolder operation.
285
349
  *
@@ -297,9 +361,15 @@ export interface CopyFolderRequest {
297
361
  */
298
362
  destination: string;
299
363
  /**
300
- * If `true` then copies files and virtual folders that are descendants of the `source` folder.
301
364
  *
302
- * If `false` then only copies files that are direct children of the `source` folder, and does not copy descendant virtual folders (children or otherwise).
365
+ * @type {CopyableFileDataFileMetadata}
366
+ * @memberof CopyFolderRequest
367
+ */
368
+ metadata?: CopyableFileDataFileMetadata;
369
+ /**
370
+ * If `true` then copies files and folders that are descendants of the `source` folder.
371
+ *
372
+ * If `false` then only copies files that are direct children of the `source` folder, and does not copy descendant folders (children or otherwise).
303
373
  *
304
374
  * Default: true
305
375
  * @type {boolean}
@@ -312,6 +382,12 @@ export interface CopyFolderRequest {
312
382
  * @memberof CopyFolderRequest
313
383
  */
314
384
  source: string;
385
+ /**
386
+ *
387
+ * @type {CopyableFileDataFileTagNameArray}
388
+ * @memberof CopyFolderRequest
389
+ */
390
+ tags?: CopyableFileDataFileTagNameArray;
315
391
  }
316
392
  /**
317
393
  *
@@ -320,21 +396,15 @@ export interface CopyFolderRequest {
320
396
  */
321
397
  export interface CopyableFileDataFileMetadata {
322
398
  /**
323
- * If `true` then merges `value` with the original file's existing data, else uses `value` as-is.
399
+ * If `true` then merges `value` with the settings from the original file, giving precedence to `value`.
400
+ *
401
+ * If `false` then uses `value` as-is, ignoring the settings from the original file.
324
402
  *
325
403
  * Default: false
326
404
  * @type {boolean}
327
405
  * @memberof CopyableFileDataFileMetadata
328
406
  */
329
407
  merge?: boolean;
330
- /**
331
- * If `true` then sets the `value` for all files generated by the transformation, else only sets the `value` for the root output file.
332
- *
333
- * Default: true
334
- * @type {boolean}
335
- * @memberof CopyableFileDataFileMetadata
336
- */
337
- setForAllArtifacts?: boolean;
338
408
  /**
339
409
  * The file metadata specified in the original upload request as a JSON object.
340
410
  * @type {{ [key: string]: any; }}
@@ -351,29 +421,89 @@ export interface CopyableFileDataFileMetadata {
351
421
  */
352
422
  export interface CopyableFileDataFileTagNameArray {
353
423
  /**
354
- * If `true` then merges `value` with the original file's existing data, else uses `value` as-is.
424
+ * If `true` then merges `value` with the settings from the original file, giving precedence to `value`.
425
+ *
426
+ * If `false` then uses `value` as-is, ignoring the settings from the original file.
355
427
  *
356
428
  * Default: false
357
429
  * @type {boolean}
358
430
  * @memberof CopyableFileDataFileTagNameArray
359
431
  */
360
432
  merge?: boolean;
433
+ /**
434
+ * The value to set into the field.
435
+ *
436
+ * Default: empty object / empty array
437
+ * @type {Array<string>}
438
+ * @memberof CopyableFileDataFileTagNameArray
439
+ */
440
+ value?: Array<string>;
441
+ }
442
+ /**
443
+ *
444
+ * @export
445
+ * @interface CopyableFileDataForArtifactsFileMetadata
446
+ */
447
+ export interface CopyableFileDataForArtifactsFileMetadata {
448
+ /**
449
+ * If `true` then merges `value` with the settings from the original file, giving precedence to `value`.
450
+ *
451
+ * If `false` then uses `value` as-is, ignoring the settings from the original file.
452
+ *
453
+ * Default: false
454
+ * @type {boolean}
455
+ * @memberof CopyableFileDataForArtifactsFileMetadata
456
+ */
457
+ merge?: boolean;
458
+ /**
459
+ * The file metadata specified in the original upload request as a JSON object.
460
+ * @type {{ [key: string]: any; }}
461
+ * @memberof CopyableFileDataForArtifactsFileMetadata
462
+ */
463
+ value?: {
464
+ [key: string]: any;
465
+ };
361
466
  /**
362
467
  * If `true` then sets the `value` for all files generated by the transformation, else only sets the `value` for the root output file.
363
468
  *
364
469
  * Default: true
365
470
  * @type {boolean}
366
- * @memberof CopyableFileDataFileTagNameArray
471
+ * @memberof CopyableFileDataForArtifactsFileMetadata
367
472
  */
368
473
  setForAllArtifacts?: boolean;
474
+ }
475
+ /**
476
+ *
477
+ * @export
478
+ * @interface CopyableFileDataForArtifactsFileTagNameArray
479
+ */
480
+ export interface CopyableFileDataForArtifactsFileTagNameArray {
369
481
  /**
370
- * The value to set or merge into the field.
482
+ * If `true` then merges `value` with the settings from the original file, giving precedence to `value`.
483
+ *
484
+ * If `false` then uses `value` as-is, ignoring the settings from the original file.
485
+ *
486
+ * Default: false
487
+ * @type {boolean}
488
+ * @memberof CopyableFileDataForArtifactsFileTagNameArray
489
+ */
490
+ merge?: boolean;
491
+ /**
492
+ * The value to set into the field.
371
493
  *
372
494
  * Default: empty object / empty array
373
495
  * @type {Array<string>}
374
- * @memberof CopyableFileDataFileTagNameArray
496
+ * @memberof CopyableFileDataForArtifactsFileTagNameArray
375
497
  */
376
498
  value?: Array<string>;
499
+ /**
500
+ * If `true` then sets the `value` for all files generated by the transformation, else only sets the `value` for the root output file.
501
+ *
502
+ * Default: true
503
+ * @type {boolean}
504
+ * @memberof CopyableFileDataForArtifactsFileTagNameArray
505
+ */
506
+ setForAllArtifacts?: boolean;
377
507
  }
378
508
  /**
379
509
  * Request body for DeleteFileBatch.
@@ -482,7 +612,7 @@ export interface DigitalOceanStorage {
482
612
  /**
483
613
  * @export
484
614
  */
485
- export declare type DigitalOceanStorageTypeEnum = "DigitalOceanSpace";
615
+ export type DigitalOceanStorageTypeEnum = "DigitalOceanSpace";
486
616
  /**
487
617
  *
488
618
  * @export
@@ -610,10 +740,10 @@ export interface ErrorResponseError {
610
740
  code: string;
611
741
  }
612
742
  /**
613
- * The result of the CopyFile operation.
743
+ *
614
744
  * @export
615
745
  */
616
- export declare type FileCopyStatus = "Copied" | "FileNotFound" | "SkippedDueToCondition";
746
+ export type FileCopyStatusCopied = "Copied";
617
747
  /**
618
748
  * Contains full information about a file, including its file metadata, file tags, original file name, and MIME type.
619
749
  * @export
@@ -717,7 +847,7 @@ export interface FileDownloadGrants {
717
847
  * The path to upload the file to.
718
848
  * @export
719
849
  */
720
- export declare type FilePathDefinition = DynamicFilePath | string;
850
+ export type FilePathDefinition = DynamicFilePath | string;
721
851
  /**
722
852
  * Summary information about a file (a subset of the FileDetails type).
723
853
  * @export
@@ -758,7 +888,7 @@ export interface FileSummary {
758
888
  /**
759
889
  * @export
760
890
  */
761
- export declare type FileSummaryTypeEnum = "File";
891
+ export type FileSummaryTypeEnum = "File";
762
892
  /**
763
893
  *
764
894
  * @export
@@ -801,7 +931,7 @@ export interface FolderDetails {
801
931
  /**
802
932
  * @export
803
933
  */
804
- export declare type FolderDetailsTypeEnum = "Folder";
934
+ export type FolderDetailsTypeEnum = "Folder";
805
935
  /**
806
936
  * The FolderSettings inherited by the current path.
807
937
  *
@@ -888,7 +1018,7 @@ export interface FolderSummary {
888
1018
  /**
889
1019
  * @export
890
1020
  */
891
- export declare type FolderSummaryTypeEnum = "Folder";
1021
+ export type FolderSummaryTypeEnum = "Folder";
892
1022
  /**
893
1023
  * Storage layer used for storing files in Google Storage, as opposed to Bytescale's built-in storage.
894
1024
  *
@@ -927,7 +1057,7 @@ export interface GoogleStorage {
927
1057
  /**
928
1058
  * @export
929
1059
  */
930
- export declare type GoogleStorageTypeEnum = "GoogleStorage";
1060
+ export type GoogleStorageTypeEnum = "GoogleStorage";
931
1061
  /**
932
1062
  *
933
1063
  * @export
@@ -965,7 +1095,7 @@ export interface InternalStorageV1 {
965
1095
  /**
966
1096
  * @export
967
1097
  */
968
- export declare type InternalStorageV1TypeEnum = "InternalStorageV1";
1098
+ export type InternalStorageV1TypeEnum = "InternalStorageV1";
969
1099
  /**
970
1100
  * Default storage layer used for files uploaded via the Bytescale API V2 (latest version).
971
1101
  *
@@ -990,7 +1120,7 @@ export interface InternalStorageV2 {
990
1120
  /**
991
1121
  * @export
992
1122
  */
993
- export declare type InternalStorageV2TypeEnum = "InternalStorageV2";
1123
+ export type InternalStorageV2TypeEnum = "InternalStorageV2";
994
1124
  /**
995
1125
  * Summary information about an asynchronous background job (for example, a folder deletion).
996
1126
  * @export
@@ -1071,7 +1201,7 @@ export interface JobSummary {
1071
1201
  /**
1072
1202
  * @export
1073
1203
  */
1074
- export declare type JobSummaryJobDocsEnum = "https://www.bytescale.com/docs/job-api/GetJob";
1204
+ export type JobSummaryJobDocsEnum = "https://www.bytescale.com/docs/job-api/GetJob";
1075
1205
  /**
1076
1206
  *
1077
1207
  * @export
@@ -1149,13 +1279,13 @@ export interface ListRecentJobsResponse {
1149
1279
  * - `1.1`: this protocol version uses multipart uploads for all files. When this protocol is used, files only exist after the last CompleteUploadPart request is made. This protocol simplifies client code, and fixes a known issue in the `2.0` protocol for file TTLs (described above).
1150
1280
  * @export
1151
1281
  */
1152
- export declare type MultipartUploadProtocol = "1.0" | "1.1";
1282
+ export type MultipartUploadProtocol = "1.0" | "1.1";
1153
1283
  /**
1154
1284
  * @type ObjectSummary
1155
1285
  * Summary information about a file or folder.
1156
1286
  * @export
1157
1287
  */
1158
- export declare type ObjectSummary = FileSummary | FolderSummary;
1288
+ export type ObjectSummary = FileSummary | FolderSummary;
1159
1289
  /**
1160
1290
  * Specifies the folder settings to use when creating or updating a folder.
1161
1291
  * @export
@@ -1191,7 +1321,7 @@ export interface PatchFolderSettings {
1191
1321
  * - `"Grandchildren+"`: Permissions apply to the grandchildren (files and folders) of this path and their descendants only.
1192
1322
  * @export
1193
1323
  */
1194
- export declare type PathPermissionScope = "Children" | "Grandchildren+" | "This";
1324
+ export type PathPermissionScope = "Children" | "Grandchildren+" | "This";
1195
1325
  /**
1196
1326
  * From T, pick a set of properties whose keys are in the union K
1197
1327
  * @export
@@ -1222,7 +1352,7 @@ export interface PickDigitalOceanStorageExcludeKeyofDigitalOceanStorageCredentia
1222
1352
  /**
1223
1353
  * @export
1224
1354
  */
1225
- export declare type PickDigitalOceanStorageExcludeKeyofDigitalOceanStorageCredentialsTypeEnum = "DigitalOceanSpace";
1355
+ export type PickDigitalOceanStorageExcludeKeyofDigitalOceanStorageCredentialsTypeEnum = "DigitalOceanSpace";
1226
1356
  /**
1227
1357
  *
1228
1358
  * @export
@@ -1278,7 +1408,7 @@ export interface PickGoogleStorageExcludeKeyofGoogleStorageCredentials {
1278
1408
  /**
1279
1409
  * @export
1280
1410
  */
1281
- export declare type PickGoogleStorageExcludeKeyofGoogleStorageCredentialsTypeEnum = "GoogleStorage";
1411
+ export type PickGoogleStorageExcludeKeyofGoogleStorageCredentialsTypeEnum = "GoogleStorage";
1282
1412
  /**
1283
1413
  *
1284
1414
  * @export
@@ -1334,7 +1464,7 @@ export interface PickR2StorageExcludeKeyofR2StorageCredentials {
1334
1464
  /**
1335
1465
  * @export
1336
1466
  */
1337
- export declare type PickR2StorageExcludeKeyofR2StorageCredentialsTypeEnum = "R2";
1467
+ export type PickR2StorageExcludeKeyofR2StorageCredentialsTypeEnum = "R2";
1338
1468
  /**
1339
1469
  *
1340
1470
  * @export
@@ -1392,7 +1522,7 @@ export interface PickS3StorageExcludeKeyofS3StorageCredentials {
1392
1522
  /**
1393
1523
  * @export
1394
1524
  */
1395
- export declare type PickS3StorageExcludeKeyofS3StorageCredentialsTypeEnum = "S3";
1525
+ export type PickS3StorageExcludeKeyofS3StorageCredentialsTypeEnum = "S3";
1396
1526
  /**
1397
1527
  *
1398
1528
  * @export
@@ -1438,23 +1568,23 @@ export interface ProcessFileAndSaveRequest {
1438
1568
  extendedParams?: TransformationParams;
1439
1569
  /**
1440
1570
  *
1441
- * @type {CopyableFileDataFileMetadata}
1571
+ * @type {CopyableFileDataForArtifactsFileMetadata}
1442
1572
  * @memberof ProcessFileAndSaveRequest
1443
1573
  */
1444
- metadata?: CopyableFileDataFileMetadata;
1574
+ metadata?: CopyableFileDataForArtifactsFileMetadata;
1445
1575
  /**
1446
1576
  *
1447
- * @type {CopyableFileDataFileTagNameArray}
1577
+ * @type {CopyableFileDataForArtifactsFileTagNameArray}
1448
1578
  * @memberof ProcessFileAndSaveRequest
1449
1579
  */
1450
- tags?: CopyableFileDataFileTagNameArray;
1580
+ tags?: CopyableFileDataForArtifactsFileTagNameArray;
1451
1581
  }
1452
1582
  /**
1453
1583
  * @type ProcessFileAndSaveResponse
1454
1584
  * Response body for ProcessFileAndSave.
1455
1585
  * @export
1456
1586
  */
1457
- export declare type ProcessFileAndSaveResponse = ProcessFileAndSaveResponseAsync | ProcessFileAndSaveResponseSync;
1587
+ export type ProcessFileAndSaveResponse = ProcessFileAndSaveResponseAsync | ProcessFileAndSaveResponseSync;
1458
1588
  /**
1459
1589
  * Response body for ProcessFileAndSave operations where the File Processing API operation is asynchronous (e.g. a video transcoding job).
1460
1590
  * @export
@@ -1543,11 +1673,11 @@ export interface ProcessFileAndSaveResponseAsync {
1543
1673
  /**
1544
1674
  * @export
1545
1675
  */
1546
- export declare type ProcessFileAndSaveResponseAsyncJobDocsEnum = "https://www.bytescale.com/docs/job-api/GetJob";
1676
+ export type ProcessFileAndSaveResponseAsyncJobDocsEnum = "https://www.bytescale.com/docs/job-api/GetJob";
1547
1677
  /**
1548
1678
  * @export
1549
1679
  */
1550
- export declare type ProcessFileAndSaveResponseAsyncAsyncEnum = true;
1680
+ export type ProcessFileAndSaveResponseAsyncAsyncEnum = true;
1551
1681
  /**
1552
1682
  * Response body for ProcessFileAndSave operations where the File Processing API operation is synchronous (e.g. an image processing job).
1553
1683
  * @export
@@ -1598,7 +1728,7 @@ export interface ProcessFileAndSaveResponseSync {
1598
1728
  /**
1599
1729
  * @export
1600
1730
  */
1601
- export declare type ProcessFileAndSaveResponseSyncAsyncEnum = false;
1731
+ export type ProcessFileAndSaveResponseSyncAsyncEnum = false;
1602
1732
  /**
1603
1733
  * Permissions applied to anonymous users who attempt to download files from a folder.
1604
1734
  *
@@ -1708,7 +1838,7 @@ export interface R2Storage {
1708
1838
  /**
1709
1839
  * @export
1710
1840
  */
1711
- export declare type R2StorageTypeEnum = "R2";
1841
+ export type R2StorageTypeEnum = "R2";
1712
1842
  /**
1713
1843
  *
1714
1844
  * @export
@@ -1728,6 +1858,50 @@ export interface R2StorageCredentials {
1728
1858
  */
1729
1859
  r2AccessKey: string;
1730
1860
  }
1861
+ /**
1862
+ * Request body for ResetCache.
1863
+ *
1864
+ * You can choose to reset the edge cache, or permanent cache, or both caches.
1865
+ *
1866
+ * *Warning:* Resetting the permanent cache (by setting ```resetPermanentCache: true```) may lead to a significant increase in processing time if numerous file transformations need to be re-performed upon their next request.
1867
+ *
1868
+ * *Recommended:* Prevent cache resets by adding a ```?v=<etag>``` querystring parameter to your URLs. This ensures your URLs change when your files change, eliminating the need for cache resets. The `etag` field is returned by GetFileDetails and all upload operations.
1869
+ *
1870
+ * *Example patterns:*
1871
+ *
1872
+ * - ```"/*"```
1873
+ * - ```"/raw/example.jpg"```
1874
+ * - ```"/image/example.jpg"```
1875
+ * - ```"/image/customers/abc/*"```
1876
+ *
1877
+ * You may only use ```*``` at the end of the pattern. You must not include your account ID prefix in the pattern.
1878
+ * @export
1879
+ * @interface ResetCacheRequest
1880
+ */
1881
+ export interface ResetCacheRequest {
1882
+ /**
1883
+ * The URL pattern to reset the cache for, excluding the account ID, but including the delivery method prefix (e.g. "raw", "image", etc.).
1884
+ *
1885
+ * May end with a `*` to indicate that all files with this prefix are to be removed from the cache.
1886
+ *
1887
+ * Specify `/*` to reset your entire cache.
1888
+ * @type {string}
1889
+ * @memberof ResetCacheRequest
1890
+ */
1891
+ pattern: string;
1892
+ /**
1893
+ * If `true` then resets the edge cache for the location(s) specified by `pattern`.
1894
+ * @type {boolean}
1895
+ * @memberof ResetCacheRequest
1896
+ */
1897
+ resetEdgeCache: boolean;
1898
+ /**
1899
+ * If `true` then resets the permanent cache for the location(s) specified by `pattern`.
1900
+ * @type {boolean}
1901
+ * @memberof ResetCacheRequest
1902
+ */
1903
+ resetPermanentCache: boolean;
1904
+ }
1731
1905
  /**
1732
1906
  * Storage layer used for storing files in custom S3 buckets, as opposed to Bytescale's built-in storage.
1733
1907
  *
@@ -1774,7 +1948,7 @@ export interface S3Storage {
1774
1948
  /**
1775
1949
  * @export
1776
1950
  */
1777
- export declare type S3StorageTypeEnum = "S3";
1951
+ export type S3StorageTypeEnum = "S3";
1778
1952
  /**
1779
1953
  *
1780
1954
  * @export
@@ -1816,7 +1990,7 @@ export interface SpecifiedFieldValueEmptiableFolderDescription {
1816
1990
  /**
1817
1991
  * @export
1818
1992
  */
1819
- export declare type SpecifiedFieldValueEmptiableFolderDescriptionSetEnum = true;
1993
+ export type SpecifiedFieldValueEmptiableFolderDescriptionSetEnum = true;
1820
1994
  /**
1821
1995
  * This data type specifies the field must be updated.
1822
1996
  * @export
@@ -1839,7 +2013,7 @@ export interface SpecifiedFieldValueEmptiablePublicPermissionsArray {
1839
2013
  /**
1840
2014
  * @export
1841
2015
  */
1842
- export declare type SpecifiedFieldValueEmptiablePublicPermissionsArraySetEnum = true;
2016
+ export type SpecifiedFieldValueEmptiablePublicPermissionsArraySetEnum = true;
1843
2017
  /**
1844
2018
  * This data type specifies the field must be updated.
1845
2019
  * @export
@@ -1862,7 +2036,7 @@ export interface SpecifiedFieldValueEmptiableStorageLayerUpdate {
1862
2036
  /**
1863
2037
  * @export
1864
2038
  */
1865
- export declare type SpecifiedFieldValueEmptiableStorageLayerUpdateSetEnum = true;
2039
+ export type SpecifiedFieldValueEmptiableStorageLayerUpdateSetEnum = true;
1866
2040
  /**
1867
2041
  * @type StorageLayerSummary
1868
2042
  * Storage layer summary information, describing an existing folder's storage layer.
@@ -1870,7 +2044,7 @@ export declare type SpecifiedFieldValueEmptiableStorageLayerUpdateSetEnum = true
1870
2044
  * This data type does not contain credentials.
1871
2045
  * @export
1872
2046
  */
1873
- export declare type StorageLayerSummary = InternalStorageV1 | InternalStorageV2 | PickDigitalOceanStorageExcludeKeyofDigitalOceanStorageCredentials | PickGoogleStorageExcludeKeyofGoogleStorageCredentials | PickR2StorageExcludeKeyofR2StorageCredentials | PickS3StorageExcludeKeyofS3StorageCredentials | WebStorage;
2047
+ export type StorageLayerSummary = InternalStorageV1 | InternalStorageV2 | PickDigitalOceanStorageExcludeKeyofDigitalOceanStorageCredentials | PickGoogleStorageExcludeKeyofGoogleStorageCredentials | PickR2StorageExcludeKeyofR2StorageCredentials | PickS3StorageExcludeKeyofS3StorageCredentials | WebStorage;
1874
2048
  /**
1875
2049
  * @type StorageLayerUpdate
1876
2050
  * Data type used to update or create a folder's storage layer.
@@ -1878,7 +2052,7 @@ export declare type StorageLayerSummary = InternalStorageV1 | InternalStorageV2
1878
2052
  * This data type may contain credentials.
1879
2053
  * @export
1880
2054
  */
1881
- export declare type StorageLayerUpdate = DigitalOceanStorage | GoogleStorage | InternalStorageV2 | R2Storage | S3Storage | WebStorage;
2055
+ export type StorageLayerUpdate = DigitalOceanStorage | GoogleStorage | InternalStorageV2 | R2Storage | S3Storage | WebStorage;
1882
2056
  /**
1883
2057
  * @type TransformationParamValue
1884
2058
  * A single transformation parameter provided to a Bytescale File Processing API.
@@ -1886,7 +2060,7 @@ export declare type StorageLayerUpdate = DigitalOceanStorage | GoogleStorage | I
1886
2060
  * See TransformationParams for more information.
1887
2061
  * @export
1888
2062
  */
1889
- export declare type TransformationParamValue = boolean | number | string;
2063
+ export type TransformationParamValue = boolean | number | string;
1890
2064
  /**
1891
2065
  * @type TransformationParams
1892
2066
  * Transformation parameters provided to a Bytescale File Processing API.
@@ -1918,7 +2092,7 @@ export declare type TransformationParamValue = boolean | number | string;
1918
2092
  * The `extendedParams` field supports up to 400KB of transformation parameter data.
1919
2093
  * @export
1920
2094
  */
1921
- export declare type TransformationParams = Array<{
2095
+ export type TransformationParams = Array<{
1922
2096
  [key: string]: TransformationParamValue;
1923
2097
  }> | {
1924
2098
  [key: string]: TransformationParamValue;
@@ -1939,25 +2113,25 @@ export interface UnspecifiedFieldValue {
1939
2113
  /**
1940
2114
  * @export
1941
2115
  */
1942
- export declare type UnspecifiedFieldValueSetEnum = false;
2116
+ export type UnspecifiedFieldValueSetEnum = false;
1943
2117
  /**
1944
2118
  * @type UpdatableFieldEmptiableFolderDescription
1945
2119
  *
1946
2120
  * @export
1947
2121
  */
1948
- export declare type UpdatableFieldEmptiableFolderDescription = SpecifiedFieldValueEmptiableFolderDescription | UnspecifiedFieldValue;
2122
+ export type UpdatableFieldEmptiableFolderDescription = SpecifiedFieldValueEmptiableFolderDescription | UnspecifiedFieldValue;
1949
2123
  /**
1950
2124
  * @type UpdatableFieldEmptiablePublicPermissionsArray
1951
2125
  *
1952
2126
  * @export
1953
2127
  */
1954
- export declare type UpdatableFieldEmptiablePublicPermissionsArray = SpecifiedFieldValueEmptiablePublicPermissionsArray | UnspecifiedFieldValue;
2128
+ export type UpdatableFieldEmptiablePublicPermissionsArray = SpecifiedFieldValueEmptiablePublicPermissionsArray | UnspecifiedFieldValue;
1955
2129
  /**
1956
2130
  * @type UpdatableFieldEmptiableStorageLayerUpdate
1957
2131
  *
1958
2132
  * @export
1959
2133
  */
1960
- export declare type UpdatableFieldEmptiableStorageLayerUpdate = SpecifiedFieldValueEmptiableStorageLayerUpdate | UnspecifiedFieldValue;
2134
+ export type UpdatableFieldEmptiableStorageLayerUpdate = SpecifiedFieldValueEmptiableStorageLayerUpdate | UnspecifiedFieldValue;
1961
2135
  /**
1962
2136
  * Request body for UploadFromUrl.
1963
2137
  * @export
@@ -2109,7 +2283,7 @@ export interface WebStorage {
2109
2283
  /**
2110
2284
  * @export
2111
2285
  */
2112
- export declare type WebStorageTypeEnum = "Web";
2286
+ export type WebStorageTypeEnum = "Web";
2113
2287
  /**
2114
2288
  *
2115
2289
  * @export