@bytescale/sdk - npm Package Compare versions

Comparing version 3.21.6 to 3.22.0

dist/types/public/shared/generated/apis/FileApi.d.ts

@@ -166,7 +166,7 @@ /**
     /**
-     * Deletes a file synchronously.
+     * Deletes a file synchronously.  Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
      */
     deleteFile(params: DeleteFileParams): Promise<void>;
     /**
-     * Deletes multiple files asynchronously.
+     * Deletes multiple files asynchronously.  Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
      */
@@ -173,0 +173,0 @@ deleteFileBatch(params: DeleteFileBatchOperationParams): Promise<AsyncResponse>;

dist/types/public/shared/generated/apis/FolderApi.d.ts

@@ -52,29 +52,29 @@ /**
     /**
-     * Copies a folder asynchronously.  You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles```, ```includeOverriddenStorage``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
+     * Copies a folder asynchronously.  You can use ListFolder to preview the operation using the `dryRun` parameter.
      */
     copyFolder(params: CopyFolderOperationParams): Promise<AsyncResponse>;
     /**
-     * Copies multiple folders asynchronously.  You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles```, ```includeOverriddenStorage``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
+     * Copies multiple folders asynchronously.  You can use ListFolder to preview the operation using the `dryRun` parameter.
      */
     copyFolderBatch(params: CopyFolderBatchOperationParams): Promise<AsyncResponse>;
     /**
-     * Deletes a folder asynchronously.  If the folder has overridden storage settings, then no files will be deleted.  You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
+     * Deletes a folder asynchronously.  If the folder has overridden storage settings, then no files will be deleted.  You can use ListFolder to preview the operation using the `dryRun` parameter.  Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
      */
     deleteFolder(params: DeleteFolderOperationParams): Promise<AsyncResponse>;
     /**
-     * Deletes multiple folders asynchronously.  If the folder has overridden storage settings, then no files will be deleted.  You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles``` and ```includeVirtualFolders``` set to match the values you\'re using here. Leave all other flags unset.
+     * Deletes multiple folders asynchronously.  If the folder has overridden storage settings, then no files will be deleted.  You can use ListFolder to preview the operation using the `dryRun` parameter.  Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
      */
     deleteFolderBatch(params: DeleteFolderBatchOperationParams): Promise<AsyncResponse>;
     /**
-     * Gets the full details (e.g. permission, storage layer, etc.) for a folder.  Returns an empty object if no settings have been configured for this folder.
+     * Gets the full details (e.g. permission, storage layer, etc.) for a folder.  Returns an empty object if no settings have been configured for this folder.  Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
      */
     getFolderDetails(params: GetFolderDetailsParams): Promise<FolderDetails>;
     /**
-     * Lists the folder\'s contents.  The result may be paginated: subsequent pages can be requested by passing the ```cursor``` from the response into the ```cursor``` request parameter.  Pagination is complete when the response includes `isPaginationComplete=true`.
+     * Lists the folder\'s contents.  The result may be paginated: subsequent pages can be requested by passing the ```cursor``` from the response into the next request.  Pagination is complete when the response includes `isPaginationComplete=true`.
      */
     listFolder(params: ListFolderParams): Promise<ListFolderResponse>;
     /**
-     * Creates or updates the folder specified by the `folderPath`.  If the folder\'s ancestors do not exist, they will be created automatically (with empty FolderSettings).  Note: you don\'t need to create folders before uploading files to them.
+     * Creates or updates the folder specified by the `folderPath`.  If the folder\'s ancestors do not exist, they will be created automatically (with empty FolderSettings).  Note: you don\'t need to create folders before uploading files to them.  Requires a `secret_*` API key. Alternatively, you can use a `public_*` API key and JWT-based auth.
      */
     putFolder(params: PutFolderOperationParams): Promise<FolderDetails>;
 }

dist/types/public/shared/generated/models/index.d.ts

@@ -10,3 +10,3 @@ /**
  */
-export declare type AccountJobType = "ProcessFileJob" | "DeleteFolderBatchJob" | "DeleteFileBatchJob" | "CopyFolderBatchJob" | "CopyFileBatchJob";
+export declare type AccountJobType = "ProcessVideoJob" | "ProcessAudioJob" | "AntivirusJob" | "DeleteFolderBatchJob" | "DeleteFileBatchJob" | "CopyFolderBatchJob" | "CopyFileBatchJob";
 /**
@@ -217,8 +217,2 @@ * Response body from an API endpoint that performs work asynchronously (i.e. does not complete the work immediately).
     /**
-     *
-     * @type {TagCondition}
-     * @memberof CopyFileRequest
-     */
-    condition?: TagCondition;
-    /**
      * Absolute path to a file. Begins with a `/`.
@@ -269,8 +263,2 @@ * @type {string}
     /**
-     *
-     * @type {TagCondition}
-     * @memberof CopyFolderRequest
-     */
-    condition?: TagCondition;
-    /**
      * If `true` then copies files.
@@ -284,4 +272,10 @@ *
     /**
-     * If `true` then copies files from folders that have overridden storage settings, else skips them. The current folder is treated the same: if it has overridden storage settings, then its files will only be copied if this flag is `true`, else they will be skipped.
+     * If `true` then copies files from folders that have overridden storage settings, else skips them.
      *
+     * If the `source` folder overrides its storage settings, then its files will only be copied if this flag is `true`.
+     *
+     * If the `source` folder inherits its storage settings, then its files will be copied regardless of this flag.
+     *
+     * In all cases, files will only be copied if `copyFiles` is also set to `true`.
+     *
      * You can ignore this setting if your account does not use folders with overridden storage settings, such as custom AWS S3 buckets.
@@ -424,3 +418,3 @@ *
  *
- * You can use ListFolder to preview the operation: set `dryRun=true` with ```recursive```, ```includeFiles``` and ```includeVirtualFolders``` set to match the values you're using here. Leave all other flags unset.
+ * You can use ListFolder to preview the operation using the `dryRun` parameter.
  * @export
@@ -587,3 +581,3 @@ * @interface DeleteFolderRequest
 /**
- * Response body for all error responses.
+ * Response body for client-side and server-side errors.
  * @export
@@ -1892,158 +1886,2 @@ * @interface ErrorResponse
 /**
- * @type TagCondition
- * Expresses a condition that matches files by their tags.
- * @export
- */
-export declare type TagCondition = TagConditionAll | TagConditionAnd | TagConditionAny | TagConditionEquals | TagConditionNot | TagConditionOr;
-/**
- *
- * @export
- * @interface TagConditionAll
- */
-export interface TagConditionAll {
-    /**
-     *
-     * @type {Array<string>}
-     * @memberof TagConditionAll
-     */
-    all: Array<string>;
-    /**
-     *
-     * @type {string}
-     * @memberof TagConditionAll
-     */
-    type: TagConditionAllTypeEnum;
-}
-/**
- * @export
- */
-export declare type TagConditionAllTypeEnum = "All";
-/**
- *
- * @export
- * @interface TagConditionAnd
- */
-export interface TagConditionAnd {
-    /**
-     *
-     * @type {TagCondition}
-     * @memberof TagConditionAnd
-     */
-    left: TagCondition;
-    /**
-     *
-     * @type {TagCondition}
-     * @memberof TagConditionAnd
-     */
-    right: TagCondition;
-    /**
-     *
-     * @type {string}
-     * @memberof TagConditionAnd
-     */
-    type: TagConditionAndTypeEnum;
-}
-/**
- * @export
- */
-export declare type TagConditionAndTypeEnum = "And";
-/**
- *
- * @export
- * @interface TagConditionAny
- */
-export interface TagConditionAny {
-    /**
-     *
-     * @type {Array<string>}
-     * @memberof TagConditionAny
-     */
-    any: Array<string>;
-    /**
-     *
-     * @type {string}
-     * @memberof TagConditionAny
-     */
-    type: TagConditionAnyTypeEnum;
-}
-/**
- * @export
- */
-export declare type TagConditionAnyTypeEnum = "Any";
-/**
- *
- * @export
- * @interface TagConditionEquals
- */
-export interface TagConditionEquals {
-    /**
-     * File tag scope, e.g. for a transformation definition, a CDN download access token, or an API key's tag whitelist.
-     * @type {string}
-     * @memberof TagConditionEquals
-     */
-    equals: string;
-    /**
-     *
-     * @type {string}
-     * @memberof TagConditionEquals
-     */
-    type: TagConditionEqualsTypeEnum;
-}
-/**
- * @export
- */
-export declare type TagConditionEqualsTypeEnum = "Equals";
-/**
- *
- * @export
- * @interface TagConditionNot
- */
-export interface TagConditionNot {
-    /**
-     *
-     * @type {TagCondition}
-     * @memberof TagConditionNot
-     */
-    condition: TagCondition;
-    /**
-     *
-     * @type {string}
-     * @memberof TagConditionNot
-     */
-    type: TagConditionNotTypeEnum;
-}
-/**
- * @export
- */
-export declare type TagConditionNotTypeEnum = "Not";
-/**
- *
- * @export
- * @interface TagConditionOr
- */
-export interface TagConditionOr {
-    /**
-     *
-     * @type {TagCondition}
-     * @memberof TagConditionOr
-     */
-    left: TagCondition;
-    /**
-     *
-     * @type {TagCondition}
-     * @memberof TagConditionOr
-     */
-    right: TagCondition;
-    /**
-     *
-     * @type {string}
-     * @memberof TagConditionOr
-     */
-    type: TagConditionOrTypeEnum;
-}
-/**
- * @export
- */
-export declare type TagConditionOrTypeEnum = "Or";
-/**
  * This data type specifies no update is to be performed.
@@ -2050,0 +1888,0 @@ * @export

package.json

 {
   "name": "@bytescale/sdk",
-  "version": "3.21.6",
+  "version": "3.22.0",
   "description": "Bytescale JavaScript SDK",
@@ -5,0 +5,0 @@ "author": "Bytescale <[e-mail]> (https://www.bytescale.com)",

No alert changes

Worsened metrics

Total package byte prevSize

1000423

decreased by-0.32%

Lines of code

20715

decreased by-0.81%

No dependency changes