@bytescale/sdk 3.32.0 → 3.34.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.
@@ -187,7 +187,7 @@ export interface BeginMultipartUploadResponseUploadParts {
187
187
  */
188
188
  export interface CompleteUploadPartRequest {
189
189
  /**
190
- * File ETag.
190
+ * The file's ETag. An ETag (or entity tag) is an identifier for a specific version of a file.
191
191
  * @type {string}
192
192
  * @memberof CompleteUploadPartRequest
193
193
  */
@@ -218,12 +218,24 @@ export interface CopyFileRequest {
218
218
  * @memberof CopyFileRequest
219
219
  */
220
220
  destination: string;
221
+ /**
222
+ *
223
+ * @type {CopyableFileDataFileMetadata}
224
+ * @memberof CopyFileRequest
225
+ */
226
+ metadata?: CopyableFileDataFileMetadata;
221
227
  /**
222
228
  * Absolute path to a file. Begins with a `/`.
223
229
  * @type {string}
224
230
  * @memberof CopyFileRequest
225
231
  */
226
232
  source: string;
233
+ /**
234
+ *
235
+ * @type {CopyableFileDataFileTagNameArray}
236
+ * @memberof CopyFileRequest
237
+ */
238
+ tags?: CopyableFileDataFileTagNameArray;
227
239
  }
228
240
  /**
229
241
  * Response body for CopyFile.
@@ -233,10 +245,10 @@ export interface CopyFileRequest {
233
245
  export interface CopyFileResponse {
234
246
  /**
235
247
  *
236
- * @type {FileCopyStatus}
248
+ * @type {FileCopyStatusCopied}
237
249
  * @memberof CopyFileResponse
238
250
  */
239
- status: FileCopyStatus;
251
+ status: FileCopyStatusCopied;
240
252
  }
241
253
  /**
242
254
  * Request body for CopyFolderBatch.
@@ -296,6 +308,12 @@ export interface CopyFolderRequest {
296
308
  * @memberof CopyFolderRequest
297
309
  */
298
310
  destination: string;
311
+ /**
312
+ *
313
+ * @type {CopyableFileDataFileMetadata}
314
+ * @memberof CopyFolderRequest
315
+ */
316
+ metadata?: CopyableFileDataFileMetadata;
299
317
  /**
300
318
  * If `true` then copies files and virtual folders that are descendants of the `source` folder.
301
319
  *
@@ -312,6 +330,12 @@ export interface CopyFolderRequest {
312
330
  * @memberof CopyFolderRequest
313
331
  */
314
332
  source: string;
333
+ /**
334
+ *
335
+ * @type {CopyableFileDataFileTagNameArray}
336
+ * @memberof CopyFolderRequest
337
+ */
338
+ tags?: CopyableFileDataFileTagNameArray;
315
339
  }
316
340
  /**
317
341
  *
@@ -320,21 +344,15 @@ export interface CopyFolderRequest {
320
344
  */
321
345
  export interface CopyableFileDataFileMetadata {
322
346
  /**
323
- * If `true` then merges `value` with the original file's existing data, else uses `value` as-is.
347
+ * If `true` then merges `value` with the settings from the original file, giving precedence to `value`.
348
+ *
349
+ * If `false` then uses `value` as-is, ignoring the settings from the original file.
324
350
  *
325
351
  * Default: false
326
352
  * @type {boolean}
327
353
  * @memberof CopyableFileDataFileMetadata
328
354
  */
329
355
  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
356
  /**
339
357
  * The file metadata specified in the original upload request as a JSON object.
340
358
  * @type {{ [key: string]: any; }}
@@ -351,29 +369,89 @@ export interface CopyableFileDataFileMetadata {
351
369
  */
352
370
  export interface CopyableFileDataFileTagNameArray {
353
371
  /**
354
- * If `true` then merges `value` with the original file's existing data, else uses `value` as-is.
372
+ * If `true` then merges `value` with the settings from the original file, giving precedence to `value`.
373
+ *
374
+ * If `false` then uses `value` as-is, ignoring the settings from the original file.
355
375
  *
356
376
  * Default: false
357
377
  * @type {boolean}
358
378
  * @memberof CopyableFileDataFileTagNameArray
359
379
  */
360
380
  merge?: boolean;
381
+ /**
382
+ * The value to set into the field.
383
+ *
384
+ * Default: empty object / empty array
385
+ * @type {Array<string>}
386
+ * @memberof CopyableFileDataFileTagNameArray
387
+ */
388
+ value?: Array<string>;
389
+ }
390
+ /**
391
+ *
392
+ * @export
393
+ * @interface CopyableFileDataForArtifactsFileMetadata
394
+ */
395
+ export interface CopyableFileDataForArtifactsFileMetadata {
396
+ /**
397
+ * If `true` then merges `value` with the settings from the original file, giving precedence to `value`.
398
+ *
399
+ * If `false` then uses `value` as-is, ignoring the settings from the original file.
400
+ *
401
+ * Default: false
402
+ * @type {boolean}
403
+ * @memberof CopyableFileDataForArtifactsFileMetadata
404
+ */
405
+ merge?: boolean;
406
+ /**
407
+ * The file metadata specified in the original upload request as a JSON object.
408
+ * @type {{ [key: string]: any; }}
409
+ * @memberof CopyableFileDataForArtifactsFileMetadata
410
+ */
411
+ value?: {
412
+ [key: string]: any;
413
+ };
361
414
  /**
362
415
  * If `true` then sets the `value` for all files generated by the transformation, else only sets the `value` for the root output file.
363
416
  *
364
417
  * Default: true
365
418
  * @type {boolean}
366
- * @memberof CopyableFileDataFileTagNameArray
419
+ * @memberof CopyableFileDataForArtifactsFileMetadata
367
420
  */
368
421
  setForAllArtifacts?: boolean;
422
+ }
423
+ /**
424
+ *
425
+ * @export
426
+ * @interface CopyableFileDataForArtifactsFileTagNameArray
427
+ */
428
+ export interface CopyableFileDataForArtifactsFileTagNameArray {
429
+ /**
430
+ * If `true` then merges `value` with the settings from the original file, giving precedence to `value`.
431
+ *
432
+ * If `false` then uses `value` as-is, ignoring the settings from the original file.
433
+ *
434
+ * Default: false
435
+ * @type {boolean}
436
+ * @memberof CopyableFileDataForArtifactsFileTagNameArray
437
+ */
438
+ merge?: boolean;
369
439
  /**
370
- * The value to set or merge into the field.
440
+ * The value to set into the field.
371
441
  *
372
442
  * Default: empty object / empty array
373
443
  * @type {Array<string>}
374
- * @memberof CopyableFileDataFileTagNameArray
444
+ * @memberof CopyableFileDataForArtifactsFileTagNameArray
375
445
  */
376
446
  value?: Array<string>;
447
+ /**
448
+ * If `true` then sets the `value` for all files generated by the transformation, else only sets the `value` for the root output file.
449
+ *
450
+ * Default: true
451
+ * @type {boolean}
452
+ * @memberof CopyableFileDataForArtifactsFileTagNameArray
453
+ */
454
+ setForAllArtifacts?: boolean;
377
455
  }
378
456
  /**
379
457
  * Request body for DeleteFileBatch.
@@ -610,10 +688,10 @@ export interface ErrorResponseError {
610
688
  code: string;
611
689
  }
612
690
  /**
613
- * The result of the CopyFile operation.
691
+ *
614
692
  * @export
615
693
  */
616
- export declare type FileCopyStatus = "Copied" | "FileNotFound" | "SkippedDueToCondition";
694
+ export declare type FileCopyStatusCopied = "Copied";
617
695
  /**
618
696
  * Contains full information about a file, including its file metadata, file tags, original file name, and MIME type.
619
697
  * @export
@@ -630,6 +708,12 @@ export interface FileDetails {
630
708
  * @memberof FileDetails
631
709
  */
632
710
  accountId: string;
711
+ /**
712
+ *
713
+ * @type {string}
714
+ * @memberof FileDetails
715
+ */
716
+ etag: string | null;
633
717
  /**
634
718
  * The file metadata specified in the original upload request as a JSON object.
635
719
  * @type {{ [key: string]: any; }}
@@ -1432,16 +1516,16 @@ export interface ProcessFileAndSaveRequest {
1432
1516
  extendedParams?: TransformationParams;
1433
1517
  /**
1434
1518
  *
1435
- * @type {CopyableFileDataFileMetadata}
1519
+ * @type {CopyableFileDataForArtifactsFileMetadata}
1436
1520
  * @memberof ProcessFileAndSaveRequest
1437
1521
  */
1438
- metadata?: CopyableFileDataFileMetadata;
1522
+ metadata?: CopyableFileDataForArtifactsFileMetadata;
1439
1523
  /**
1440
1524
  *
1441
- * @type {CopyableFileDataFileTagNameArray}
1525
+ * @type {CopyableFileDataForArtifactsFileTagNameArray}
1442
1526
  * @memberof ProcessFileAndSaveRequest
1443
1527
  */
1444
- tags?: CopyableFileDataFileTagNameArray;
1528
+ tags?: CopyableFileDataForArtifactsFileTagNameArray;
1445
1529
  }
1446
1530
  /**
1447
1531
  * @type ProcessFileAndSaveResponse
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bytescale/sdk",
3
- "version": "3.32.0",
3
+ "version": "3.34.0",
4
4
  "description": "Bytescale JavaScript SDK",
5
5
  "author": "Bytescale <hello@bytescale.com> (https://www.bytescale.com)",
6
6
  "license": "MIT",