@bytescale/sdk 3.0.0-alpha.1 → 3.0.0-alpha.4

package/dist/node/esm/main.mjs

@@ -51,7 +51,7 @@ __lib_require__.d(__lib_exports__, {
   "AuthManager": function() { return /* reexport */ AuthManager; },
   "BaseAPI": function() { return /* reexport */ BaseAPI; },
   "BinaryResult": function() { return /* reexport */ BinaryResult; },
-  "BytescaleApiClientConfigResolver": function() { return /* reexport */ BytescaleApiClientConfigResolver; },
+  "BytescaleApiClientConfigUtils": function() { return /* reexport */ BytescaleApiClientConfigUtils; },
   "BytescaleApiError": function() { return /* reexport */ BytescaleApiError; },
   "CancelledError": function() { return /* reexport */ CancelledError; },
   "CommonTypesNoOp": function() { return /* reexport */ CommonTypesNoOp; },
@@ -127,21 +127,21 @@ function runtime_createClass(Constructor, protoProps, staticProps) { if (protoPr
 function runtime_toPropertyKey(arg) { var key = runtime_toPrimitive(arg, "string"); return runtime_typeof(key) === "symbol" ? key : String(key); }
 function runtime_toPrimitive(input, hint) { if (runtime_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (runtime_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
 
-var BytescaleApiClientConfigResolver = /*#__PURE__*/function () {
-  function BytescaleApiClientConfigResolver() {
-    runtime_classCallCheck(this, BytescaleApiClientConfigResolver);
+var BytescaleApiClientConfigUtils = /*#__PURE__*/function () {
+  function BytescaleApiClientConfigUtils() {
+    runtime_classCallCheck(this, BytescaleApiClientConfigUtils);
   }
-  runtime_createClass(BytescaleApiClientConfigResolver, null, [{
+  runtime_createClass(BytescaleApiClientConfigUtils, null, [{
     key: "getApiUrl",
     value: function getApiUrl(config) {
       var _a;
-      return (_a = config.apiUrl) !== null && _a !== void 0 ? _a : BytescaleApiClientConfigResolver.defaultApiUrl;
+      return (_a = config.apiUrl) !== null && _a !== void 0 ? _a : BytescaleApiClientConfigUtils.defaultApiUrl;
     }
   }, {
     key: "getCdnUrl",
     value: function getCdnUrl(config) {
       var _a;
-      return (_a = config.cdnUrl) !== null && _a !== void 0 ? _a : BytescaleApiClientConfigResolver.defaultCdnUrl;
+      return (_a = config.cdnUrl) !== null && _a !== void 0 ? _a : BytescaleApiClientConfigUtils.defaultCdnUrl;
     }
   }, {
     key: "getFetchApi",
@@ -149,11 +149,48 @@ var BytescaleApiClientConfigResolver = /*#__PURE__*/function () {
       var _a;
       return (_a = config.fetchApi) !== null && _a !== void 0 ? _a : fetch;
     }
+  }, {
+    key: "getAccountId",
+    value: function getAccountId(config) {
+      var _a, _b;
+      var accountId;
+      if (BytescaleApiClientConfigUtils.specialApiKeys.includes(config.apiKey)) {
+        accountId = BytescaleApiClientConfigUtils.specialApiKeyAccountId;
+      } else {
+        accountId = (_b = (_a = config.apiKey.split("_")[1]) === null || _a === void 0 ? void 0 : _a.substr(0, BytescaleApiClientConfigUtils.accountIdLength)) !== null && _b !== void 0 ? _b : "";
+        if (accountId.length !== BytescaleApiClientConfigUtils.accountIdLength) {
+          throw new Error("Invalid Bytescale API key.");
+        }
+      }
+      return accountId;
+    }
+  }, {
+    key: "validate",
+    value: function validate(config) {
+      var _a;
+      // Defensive programming, for users not using TypeScript. Mainly because this is used by UploadWidget users.
+      if ((config !== null && config !== void 0 ? config : undefined) === undefined) {
+        throw new Error("Config parameter required.");
+      }
+      if (((_a = config.apiKey) !== null && _a !== void 0 ? _a : undefined) === undefined) {
+        throw new Error("Please provide an API key via the 'apiKey' config parameter.");
+      }
+      if (config.apiKey.trim() !== config.apiKey) {
+        // We do not support API keys with whitespace (by trimming ourselves) because otherwise we'd need to support this
+        // everywhere in perpetuity (since removing the trimming would be a breaking change).
+        throw new Error("API key needs trimming (whitespace detected).");
+      }
+      // This performs futher validation on the API key...
+      BytescaleApiClientConfigUtils.getAccountId(config);
+    }
   }]);
-  return BytescaleApiClientConfigResolver;
+  return BytescaleApiClientConfigUtils;
 }();
-BytescaleApiClientConfigResolver.defaultApiUrl = "https://api.bytescale.com";
-BytescaleApiClientConfigResolver.defaultCdnUrl = "https://upcdn.io";
+BytescaleApiClientConfigUtils.defaultApiUrl = "https://api.bytescale.com";
+BytescaleApiClientConfigUtils.defaultCdnUrl = "https://upcdn.io";
+BytescaleApiClientConfigUtils.specialApiKeys = ["free", "demo"];
+BytescaleApiClientConfigUtils.specialApiKeyAccountId = "W142hJk";
+BytescaleApiClientConfigUtils.accountIdLength = 7; // Sync with: upload/shared/**/AccountIdUtils
 /**
  * This is the base class for all generated API classes.
  */
@@ -161,6 +198,7 @@ var BaseAPI = /*#__PURE__*/function () {
   function BaseAPI(config) {
     runtime_classCallCheck(this, BaseAPI);
     this.config = config;
+    BytescaleApiClientConfigUtils.validate(config);
   }
   runtime_createClass(BaseAPI, [{
     key: "request",
@@ -175,7 +213,7 @@ var BaseAPI = /*#__PURE__*/function () {
         }
         // Key: any possible value for 'baseUrlOverride'
         // Value: user-overridden value for that base URL from the config.
-        var nonDefaultBasePaths = _defineProperty({}, BytescaleApiClientConfigResolver.defaultCdnUrl, BytescaleApiClientConfigResolver.getCdnUrl(_this2.config));
+        var nonDefaultBasePaths = _defineProperty({}, BytescaleApiClientConfigUtils.defaultCdnUrl, BytescaleApiClientConfigUtils.getCdnUrl(_this2.config));
         return _await(_this2.createFetchParams(context, initOverrides, baseUrlOverride === undefined ? undefined : (_b = nonDefaultBasePaths[baseUrlOverride]) !== null && _b !== void 0 ? _b : baseUrlOverride), function (_ref) {
           var url = _ref.url,
             init = _ref.init;
@@ -197,7 +235,7 @@ var BaseAPI = /*#__PURE__*/function () {
         var _a, _b;
         var response;
         return _continue(_catch(function () {
-          return _await(BytescaleApiClientConfigResolver.getFetchApi(_this4.config)(url, init), function (_BytescaleApiClientCo) {
+          return _await(BytescaleApiClientConfigUtils.getFetchApi(_this4.config)(url, init), function (_BytescaleApiClientCo) {
             response = _BytescaleApiClientCo;
           });
         }, function (e) {
@@ -251,7 +289,7 @@ var BaseAPI = /*#__PURE__*/function () {
     value: function createFetchParams(context, initOverrides, baseUrlOverride) {
       try {
         var _this6 = this;
-        var url = (baseUrlOverride !== null && baseUrlOverride !== void 0 ? baseUrlOverride : BytescaleApiClientConfigResolver.getApiUrl(_this6.config)) + context.path;
+        var url = (baseUrlOverride !== null && baseUrlOverride !== void 0 ? baseUrlOverride : BytescaleApiClientConfigUtils.getApiUrl(_this6.config)) + context.path;
         if (context.query !== undefined && Object.keys(context.query).length !== 0) {
           // only add the querystring to the URL if there are query parameters.
           // this is done to avoid urls ending with a "?" character which buggy webservers
@@ -295,9 +333,6 @@ var BaseAPI = /*#__PURE__*/function () {
   }]);
   return BaseAPI;
 }();
-BaseAPI.specialApiKeys = ["free", "demo"];
-BaseAPI.specialApiKeyAccountId = "W142hJk";
-BaseAPI.accountIdLength = 7; // Sync with: upload/shared/**/AccountIdUtils
 var CancelledError = /*#__PURE__*/function (_Error) {
   _inherits(CancelledError, _Error);
   var _super = _createSuper(CancelledError);
@@ -455,9 +490,6 @@ function FileApi_getPrototypeOf(o) { FileApi_getPrototypeOf = Object.setPrototyp
  */
 // @ts-ignore
 
-/**
- *
- */
 var FileApi = /*#__PURE__*/function (_runtime$BaseAPI) {
   FileApi_inherits(FileApi, _runtime$BaseAPI);
   var _super = FileApi_createSuper(FileApi);
@@ -756,9 +788,6 @@ function FolderApi_getPrototypeOf(o) { FolderApi_getPrototypeOf = Object.setProt
  */
 // @ts-ignore
 
-/**
- *
- */
 var FolderApi = /*#__PURE__*/function (_runtime$BaseAPI) {
   FolderApi_inherits(FolderApi, _runtime$BaseAPI);
   var _super = FolderApi_createSuper(FolderApi);
@@ -1016,9 +1045,6 @@ function JobApi_getPrototypeOf(o) { JobApi_getPrototypeOf = Object.setPrototypeO
  */
 // @ts-ignore
 
-/**
- *
- */
 var JobApi = /*#__PURE__*/function (_runtime$BaseAPI) {
   JobApi_inherits(JobApi, _runtime$BaseAPI);
   var _super = JobApi_createSuper(JobApi);
@@ -1151,9 +1177,6 @@ function UploadApi_getPrototypeOf(o) { UploadApi_getPrototypeOf = Object.setProt
  */
 // @ts-ignore
 
-/**
- *
- */
 var UploadApi = /*#__PURE__*/function (_runtime$BaseAPI) {
   UploadApi_inherits(UploadApi, _runtime$BaseAPI);
   var _super = UploadApi_createSuper(UploadApi);
@@ -1349,7 +1372,7 @@ var UrlBuilder = /*#__PURE__*/function () {
   function UrlBuilder(config) {
     UrlBuilder_classCallCheck(this, UrlBuilder);
     var _a;
-    this.cdnUrl = (_a = config === null || config === void 0 ? void 0 : config.cdnUrl) !== null && _a !== void 0 ? _a : BytescaleApiClientConfigResolver.defaultCdnUrl;
+    this.cdnUrl = (_a = config === null || config === void 0 ? void 0 : config.cdnUrl) !== null && _a !== void 0 ? _a : BytescaleApiClientConfigUtils.defaultCdnUrl;
   }
   /**
    * Builds a URL to either a raw file or a transformed file.
@@ -1374,7 +1397,7 @@ var UrlBuilder = /*#__PURE__*/function () {
     key: "url",
     value: function url(params) {
       var _a;
-      return ((_a = params.options) === null || _a === void 0 ? void 0 : _a.transformation) === undefined ? this.raw(params) : this.transformation(params, params.options.transformation);
+      return ((_a = params.options) === null || _a === void 0 ? void 0 : _a.transformation) === undefined ? this.raw(params) : this.transformation(params, params.options);
     }
   }, {
     key: "raw",
@@ -1388,18 +1411,25 @@ var UrlBuilder = /*#__PURE__*/function () {
     key: "transformation",
     value: function transformation(params, trans) {
       var _a;
-      var baseUrl = this.getBaseUrl(params, trans.type === "preset" ? trans.preset : trans.type);
-      var transParams = this.getTransformationParams(trans, {
-        cachePermanently: "cache_perm"
-      });
+      var baseUrl = this.getBaseUrl(params, trans.transformation === "preset" ? trans.transformationPreset : trans.transformation);
+      var transParams = trans.transformation === "preset" ? [] : this.getTransformationParams(trans);
       var commonParams = this.getCommonQueryParams((_a = params.options) !== null && _a !== void 0 ? _a : {});
-      return this.addQueryParams(baseUrl, [].concat(_toConsumableArray(commonParams), _toConsumableArray(transParams)));
+      var transCommonParams = this.getCommonTransformationQueryParams(trans);
+      // This format puts "artifact" at the end, which isn't required, but is convention.
+      return this.addQueryParams(baseUrl, [].concat(_toConsumableArray(transParams), _toConsumableArray(commonParams), _toConsumableArray(transCommonParams)));
     }
   }, {
     key: "getBaseUrl",
     value: function getBaseUrl(params, prefix) {
       return "".concat(this.cdnUrl, "/").concat(params.accountId, "/").concat(prefix).concat(params.filePath);
     }
+  }, {
+    key: "getCommonTransformationQueryParams",
+    value: function getCommonTransformationQueryParams(trans) {
+      return this.makeQueryParams(["cachePermanently", "large", "artifact"], {
+        cachePermanently: "cache_perm"
+      })(trans);
+    }
   }, {
     key: "getCommonQueryParams",
     value: function getCommonQueryParams(params) {
@@ -1425,8 +1455,9 @@ var UrlBuilder = /*#__PURE__*/function () {
     }
   }, {
     key: "getTransformationParams",
-    value: function getTransformationParams(trans, keyRewrites) {
-      if (trans.params === undefined) {
+    value: function getTransformationParams(trans) {
+      var params = trans.transformationParams;
+      if (params === undefined) {
         return [];
       }
       var serializeObj = function serializeObj(obj) {
@@ -1434,11 +1465,10 @@ var UrlBuilder = /*#__PURE__*/function () {
           var _ref2 = _slicedToArray(_ref, 2),
             key = _ref2[0],
             value = _ref2[1];
-          var _a;
-          return [(_a = keyRewrites[key]) !== null && _a !== void 0 ? _a : key, value.toString()];
+          return [key, value.toString()];
         });
       };
-      return Array.isArray(trans.params) ? trans.params.flatMap(serializeObj) : serializeObj(trans.params);
+      return Array.isArray(params) ? params.flatMap(serializeObj) : serializeObj(params);
     }
   }, {
     key: "addQueryParams",
@@ -2624,7 +2654,7 @@ var AuthManager = /*#__PURE__*/function () {
 var __lib_exports__AuthManager = __lib_exports__.AuthManager;
 var __lib_exports__BaseAPI = __lib_exports__.BaseAPI;
 var __lib_exports__BinaryResult = __lib_exports__.BinaryResult;
-var __lib_exports__BytescaleApiClientConfigResolver = __lib_exports__.BytescaleApiClientConfigResolver;
+var __lib_exports__BytescaleApiClientConfigUtils = __lib_exports__.BytescaleApiClientConfigUtils;
 var __lib_exports__BytescaleApiError = __lib_exports__.BytescaleApiError;
 var __lib_exports__CancelledError = __lib_exports__.CancelledError;
 var __lib_exports__CommonTypesNoOp = __lib_exports__.CommonTypesNoOp;
@@ -2638,4 +2668,4 @@ var __lib_exports__UrlBuilder = __lib_exports__.UrlBuilder;
 var __lib_exports__UrlBuilderTypesNoOp = __lib_exports__.UrlBuilderTypesNoOp;
 var __lib_exports__VoidApiResponse = __lib_exports__.VoidApiResponse;
 var __lib_exports__querystring = __lib_exports__.querystring;
-export { __lib_exports__AuthManager as AuthManager, __lib_exports__BaseAPI as BaseAPI, __lib_exports__BinaryResult as BinaryResult, __lib_exports__BytescaleApiClientConfigResolver as BytescaleApiClientConfigResolver, __lib_exports__BytescaleApiError as BytescaleApiError, __lib_exports__CancelledError as CancelledError, __lib_exports__CommonTypesNoOp as CommonTypesNoOp, __lib_exports__FileApi as FileApi, __lib_exports__FolderApi as FolderApi, __lib_exports__JSONApiResponse as JSONApiResponse, __lib_exports__JobApi as JobApi, __lib_exports__UploadApi as UploadApi, __lib_exports__UploadManager as UploadManager, __lib_exports__UrlBuilder as UrlBuilder, __lib_exports__UrlBuilderTypesNoOp as UrlBuilderTypesNoOp, __lib_exports__VoidApiResponse as VoidApiResponse, __lib_exports__querystring as querystring };
+export { __lib_exports__AuthManager as AuthManager, __lib_exports__BaseAPI as BaseAPI, __lib_exports__BinaryResult as BinaryResult, __lib_exports__BytescaleApiClientConfigUtils as BytescaleApiClientConfigUtils, __lib_exports__BytescaleApiError as BytescaleApiError, __lib_exports__CancelledError as CancelledError, __lib_exports__CommonTypesNoOp as CommonTypesNoOp, __lib_exports__FileApi as FileApi, __lib_exports__FolderApi as FolderApi, __lib_exports__JSONApiResponse as JSONApiResponse, __lib_exports__JobApi as JobApi, __lib_exports__UploadApi as UploadApi, __lib_exports__UploadManager as UploadManager, __lib_exports__UrlBuilder as UrlBuilder, __lib_exports__UrlBuilderTypesNoOp as UrlBuilderTypesNoOp, __lib_exports__VoidApiResponse as VoidApiResponse, __lib_exports__querystring as querystring };

package/dist/types/public/shared/UrlBuilder.d.ts

@@ -25,6 +25,7 @@ export declare class UrlBuilder {
     private raw;
     private transformation;
     private getBaseUrl;
+    private getCommonTransformationQueryParams;
     private getCommonQueryParams;
     private makeQueryParams;
     private getTransformationParams;

package/dist/types/public/shared/UrlBuilderTypes.d.ts

@@ -26,7 +26,10 @@ export interface UrlBuilderParams {
      */
     options?: UrlBuilderOptions;
 }
-export interface UrlBuilderOptions {
+export declare type UrlBuilderOptions = UrlBuilderOptionsRaw | UrlBuilderTransformationOptions;
+export declare type UrlBuilderTransformationOptions = UrlBuilderTransformationApiOptions | UrlBuilderOptionsPreset;
+export declare type UrlBuilderTransformationApiOptions = UrlBuilderOptionsImage | UrlBuilderOptionsVideo | UrlBuilderOptionsAudio | UrlBuilderOptionsArchive;
+export interface UrlBuilderOptionsBase {
     /**
      * Set to 'true' to download a private file. Requires an active auth session. See AuthManager.beginAuthSession.
      *
@@ -57,7 +60,6 @@ export interface UrlBuilderOptions {
      * Default: false
      */
     forceDownloadPrompt?: boolean;
-    transformation?: UrlBuilderParamsTransformation;
     /**
      * Downloads the latest version of your file (if you have overwritten it) when added to the URL with a unique value.
      *
@@ -67,48 +69,55 @@ export interface UrlBuilderOptions {
      */
     version?: string;
 }
-export declare type UrlBuilderParamsTransformation = UrlBuilderParamsTransformationPreset | UrlBuilderParamsImageTransformation | UrlBuilderParamsVideoTransformation | UrlBuilderParamsAudioTransformation | UrlBuilderParamsArchiveTransformation;
-export interface UrlBuilderParamsTransformationOptions {
+export interface UrlBuilderOptionsRaw extends UrlBuilderOptionsBase {
+    transformation?: undefined;
+}
+export interface UrlBuilderOptionsImage extends UrlBuilderOptionsTransformationApi<ParameterGroup> {
     /**
-     * The transformation artifact to download.
-     *
-     * Some transformations produce multiple files. The 'artifact' parameter is used to select which file to download.
-     *
-     * Must begin with: "/"
+     * Set to "image" to use Bytescale's Image Processing API:
      *
-     * Default: "/"
+     * https://www.bytescale.com/docs/image-processing-api
      */
-    artifact?: string;
+    transformation: "image";
+}
+export interface UrlBuilderOptionsVideo extends UrlBuilderOptionsTransformationApi<ParameterGroup> {
     /**
-     * Specifies whether to permanently cache the transformed result in the Bytescale CDN.
-     *
-     * Permanently cached files can be deleted via a manual action in the Bytescale Dashboard.
-     *
-     * When cache=false this parameter is automatically set to false.
-     *
-     * When cachePermanently="auto" the permanent cache will only be used for files that take more than 1000ms to process.
-     *
-     * When the permanent cache is used, approximately 200ms of latency is added to the initial request. Thereafter, files will be served from the Bytescale CDN's edge cache or permanent cache, so will have minimal latency.
+     * Set to "video" to use Bytescale's Video Processing API:
      *
-     * Default: Please refer to your account's default cache settings in the Bytescale Dashboard.
+     * https://www.bytescale.com/docs/video-processing-api
      */
-    cachePermanently?: "auto" | boolean;
+    transformation: "video";
+}
+export interface UrlBuilderOptionsAudio extends UrlBuilderOptionsTransformationApi<ParameterGroup> {
     /**
-     * Set to true to return transformed files over 6MB in the initial HTTP response.
+     * Set to "audio" to use Bytescale's Audio Processing API:
      *
-     * By default, transformations that produce files larger than 6MB require a subsequent HTTP request to return the result: the initial HTTP request will process the file and return a JSON result instructing the requester the transformation has been performed. All subsequent requests will return the transformed file. Enable this flag to ensure the transformed file is always returned in the initial response.
+     * https://www.bytescale.com/docs/audio-processing-api
+     */
+    transformation: "audio";
+}
+export interface UrlBuilderOptionsArchive extends UrlBuilderOptionsTransformationApi<ParameterGroup> {
+    /**
+     * Set to "archive" to use Bytescale's Archive Processing API:
      *
-     * Recommendation: set large=true only if you require transformation results over 6MB. A small amount of latency is incurred on edge cache misses when this flag is enabled. In general, we recommend adjusting your transformation parameters to keep files below this size, instead of enabling this flag.
+     * https://www.bytescale.com/docs/archive-processing-api
+     */
+    transformation: "archive";
+}
+export interface UrlBuilderOptionsPreset extends UrlBuilderOptionsTransformation {
+    transformation: "preset";
+    /**
+     * The name of the transformation preset, as displayed in the Bytescale Dashboard.
      *
-     * Default: false
+     * To specify transformation parameters on-the-fly, set "transformation" to a File Processing API (e.g. "image", "video", "audio"), and then use the "transformationParams" field to pass parameters to the File Processing API.
      */
-    large?: boolean;
+    transformationPreset: string;
 }
-export interface UrlBuilderParamsTransformationApiBase<T> {
+export interface UrlBuilderOptionsTransformationApi<T> extends UrlBuilderOptionsTransformation {
     /**
-     * Use the "params" field to pass parameters to the File Processing API.
+     * Use the "transformationParams" field to pass parameters to the File Processing API.
      *
-     * Use the "type" field to specify which File Processing API to use:
+     * Use the "transformation" field to specify which File Processing API to use:
      *
      * - https://www.bytescale.com/docs/image-processing-api
      * - https://www.bytescale.com/docs/video-processing-api
@@ -122,52 +131,43 @@ export interface UrlBuilderParamsTransformationApiBase<T> {
      * Order is sensitive both within and across parameter groups for certain transformation operations, please consult
      * the documentation for the File Processing API you are using (see links above).
      */
-    params?: (T & UrlBuilderParamsTransformationOptions) | Array<T & UrlBuilderParamsTransformationOptions>;
+    transformationParams?: T | T[];
 }
-export interface UrlBuilderParamsTransformationPreset {
-    params?: UrlBuilderParamsTransformationOptions;
+export interface UrlBuilderOptionsTransformation extends UrlBuilderOptionsBase {
     /**
-     * The name of the transformation preset, as displayed in the Bytescale Dashboard.
+     * The transformation artifact to download.
      *
-     * To specify transformation parameters on-the-fly, set "type" to a File Processing API (e.g. "image", "video", "audio"), and then use the "params" field to pass parameters to the File Processing API.
-     */
-    preset: string;
-    /**
-     * Use a transformation preset that was created in the Bytescale Dashboard.
+     * Some transformations produce multiple files. The 'artifact' parameter is used to select which file to download.
      *
-     * To specify transformation parameters on-the-fly, set "type" to a File Processing API (e.g. "image", "video", "audio"), and then use the "params" field to pass parameters to the File Processing API.
-     */
-    type: "preset";
-}
-export interface UrlBuilderParamsImageTransformation extends UrlBuilderParamsTransformationApiBase<ParameterGroup> {
-    /**
-     * Set to "image" to use Bytescale's Image Processing API:
+     * Must begin with: "/"
      *
-     * https://www.bytescale.com/docs/image-processing-api
+     * Default: "/"
      */
-    type: "image";
-}
-export interface UrlBuilderParamsVideoTransformation extends UrlBuilderParamsTransformationApiBase<ParameterGroup> {
+    artifact?: string;
     /**
-     * Set to "video" to use Bytescale's Video Processing API:
+     * Specifies whether to permanently cache the transformed result in the Bytescale CDN.
      *
-     * https://www.bytescale.com/docs/video-processing-api
-     */
-    type: "video";
-}
-export interface UrlBuilderParamsAudioTransformation extends UrlBuilderParamsTransformationApiBase<ParameterGroup> {
-    /**
-     * Set to "audio" to use Bytescale's Audio Processing API:
+     * Permanently cached files can be deleted via a manual action in the Bytescale Dashboard.
      *
-     * https://www.bytescale.com/docs/audio-processing-api
+     * When cache=false this parameter is automatically set to false.
+     *
+     * When cachePermanently="auto" the permanent cache will only be used for files that take more than 1000ms to process.
+     *
+     * When the permanent cache is used, approximately 200ms of latency is added to the initial request. Thereafter, files will be served from the Bytescale CDN's edge cache or permanent cache, so will have minimal latency.
+     *
+     * Default: Please refer to your account's default cache settings in the Bytescale Dashboard.
      */
-    type: "audio";
-}
-export interface UrlBuilderParamsArchiveTransformation extends UrlBuilderParamsTransformationApiBase<ParameterGroup> {
+    cachePermanently?: "auto" | boolean;
     /**
-     * Set to "archive" to use Bytescale's Archive Processing API:
+     * Only set this parameter to `true` if you expect the HTTP response body for the transformation request to be over 6MB.
      *
-     * https://www.bytescale.com/docs/archive-processing-api
+     * We recommend leaving this parameter unset (so it defaults to `false`) and controlling the HTTP response body size via transformation parameters. E.g. for Image Processing API requests, you can shrink the HTTP response body by reducing the output image's dimensions and/or quality.
+     *
+     * Setting this parameter to `true` will route the request via an alternative CDN path, which allows responses over 6MB, but incurs a ~200ms latency on all CDN edge cache misses for the URL.
+     *
+     * Setting this parameter to `false` (default) results in faster routing. If a response over 6MB is returned, the initial response will be a JSON error indicating the response was too large to return. All subsequent requests to the same URL will successfully return the transformed file (forever).
+     *
+     * Default: false
      */
-    type: "archive";
+    large?: boolean;
 }

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

@@ -30,8 +30,25 @@ export interface DeleteFileBatchOperationParams {
 export interface DownloadFileParams {
     accountId: string;
     filePath: string;
+    /**
+     * Specifies whether to cache the raw file in the Bytescale CDN.
+     *
+     * Default: true
+     */
     cache?: boolean;
+    /**
+     * Specifies the maximum amount of time, in seconds, the file will be cached on the user's device and in the Bytescale CDN's edge cache.
+     *
+     * Default: Please refer to your account's default cache settings in the Bytescale Dashboard.
+     */
     cacheTtl?: number;
+    /**
+     * Downloads the latest version of your file (if you have overwritten it) when added to the URL with a unique value.
+     *
+     *   The value of the `version` parameter can be anything, e.g. an incremental number, a timestamp, etc.
+     *
+     *   You only need to provide and update this value if/when you overwrite your file.
+     */
     version?: string;
 }
 export interface GetFileDetailsParams {
@@ -41,29 +58,113 @@ export interface GetFileDetailsParams {
 export interface ProcessFileParams {
     accountId: string;
     filePath: string;
+    /**
+     * The name of the File Processing API (e.g. "image", "video", "audio") or transformation preset (created in the Bytescale Dashboard) to use when processing the file.
+     */
     transformation: string;
+    /**
+     * Some transformations output multiple files, called artifacts.
+     *
+     * You can download each individual transformation artifact by specifying its path with this parameter
+     */
     artifact?: string;
+    /**
+     * Specifies whether to cache the transformed result.
+     *
+     * If set to `false` the transformation will be executed on every request.
+     *
+     * *Recommendation:* instead of disabling the cache, a more performant solution is to use the `version` parameter and to increment it each time you require an updated result.
+     *
+     * Default: true
+     */
     cache?: boolean;
+    /**
+     * Specifies whether to cache the transformed result in the Bytescale CDN perma-cache.
+     *
+     * Perma-caching works by storing your file permanently, or until a manual cache purge is performed.
+     *
+     * When `cache=false` this parameter is automatically set to `false`.
+     *
+     * When `cache_perm=auto` the perma-cache will only be used for files that take more than 1000ms to process.
+     *
+     * When the perma-cache is used, approximately 200ms of latency is added to the initial request. Thereafter, files will be served from the Bytescale CDN's edge cache or perma-cache, so will have minimal latency.
+     *
+     * Default: Please refer to your account's default cache settings in the Bytescale Dashboard.
+     */
     cachePerm?: ProcessFileCachePermEnum;
+    /**
+     * Specifies the maximum amount of time, in seconds, the transformed result will be cached on the user's device and in the Bytescale CDN's edge cache.
+     *
+     * If the file is perma-cached, then the file will not be reprocessed on edge cache misses.
+     *
+     * If the file is not perma-cached, then the file will be reprocessed on edge cache misses.
+     *
+     * For more information on perma-caching, see: `cache_perm`
+     *
+     * Default: Please refer to your account's default cache settings in the Bytescale Dashboard.
+     */
     cacheTtl?: number;
+    /**
+     * Only set this parameter to `true` if you expect the HTTP response body for the transformation request to be over 6MB.
+     *
+     * We recommend leaving this parameter unset (so it defaults to `false`) and controlling the HTTP response body size via transformation parameters. E.g. for Image Processing API requests, you can shrink the HTTP response body by reducing the output image's dimensions and/or quality.
+     *
+     * Setting this parameter to `true` will route the request via an alternative CDN path, which allows responses over 6MB, but incurs a ~200ms latency on all CDN edge cache misses for the URL.
+     *
+     * Setting this parameter to `false` (default) results in faster routing. If a response over 6MB is returned, the initial response will be a JSON error indicating the response was too large to return. All subsequent requests to the same URL will successfully return the transformed file (forever).
+     *
+     * Default: `false`
+     */
     large?: boolean;
+    /**
+     * Parameters to submit to the File Processing API (e.g. the Image Processing API).
+     *
+     * Please see the documentation for each File Processing API to determine which values can appear here:
+     *
+     * - https://www.bytescale.com/docs/image-processing-api
+     * - https://www.bytescale.com/docs/video-processing-api
+     * - https://www.bytescale.com/docs/audio-processing-api
+     * - https://www.bytescale.com/docs/archive-processing-api
+     */
     transformationParams?: {
         [key: string]: ProcessFileTransformationParamsParameterValue;
     };
+    /**
+     * Add this parameter and increment its value to force the file to be reprocessed.
+     *
+     * The Bytescale CDN caches files based on the full URL (including the querystring), meaning this parameter is useful when dealing with changes made to transformation presets. By contrast, File Processing APIs (like the Image Processing API) shouldn't ever require this parameter, since the URL/querystring naturally changes each time you adjust a parameter, causing a cache miss and the file to be reprocessed with the new querystring parameters.
+     *
+     * The value of the `version` parameter can be anything, e.g. an incremental number, a timestamp, etc.
+     *
+     * You only need to provide and update this value if/when you make changes to a transformation preset's settings.
+     */
     version?: string;
 }
 export interface ProcessFileAndSaveOperationParams {
     accountId: string;
     filePath: string;
+    /**
+     * The name of the File Processing API (e.g. "image", "video", "audio") or transformation preset (created in the Bytescale Dashboard) to use when processing the file.
+     */
     transformation: string;
+    /**
+     *
+     */
     processFileAndSaveRequest: ProcessFileAndSaveRequest;
+    /**
+     * Parameters to submit to the File Processing API (e.g. the Image Processing API).
+     *
+     * Please see the documentation for each File Processing API to determine which values can appear here:
+     *
+     * - https://www.bytescale.com/docs/image-processing-api
+     * - https://www.bytescale.com/docs/video-processing-api
+     * - https://www.bytescale.com/docs/audio-processing-api
+     * - https://www.bytescale.com/docs/archive-processing-api
+     */
     transformationParams?: {
         [key: string]: ProcessFileTransformationParamsParameterValue;
     };
 }
-/**
- *
- */
 export declare class FileApi extends runtime.BaseAPI {
     /**
      * Copies a file synchronously.

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

@@ -47,9 +47,6 @@ export interface PutFolderOperationParams {
     accountId: string;
     putFolderRequest: PutFolderRequest;
 }
-/**
- *
- */
 export declare class FolderApi extends runtime.BaseAPI {
     /**
      * 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.

package/dist/types/public/shared/generated/apis/JobApi.d.ts

@@ -25,9 +25,6 @@ export interface ListRecentJobsParams {
     accountId: string;
     jobType: Array<AccountJobType>;
 }
-/**
- *
- */
 export declare class JobApi extends runtime.BaseAPI {
     /**
      * Cancels an in-progress background job.  Requires a `secret_*` API key.

package/dist/types/public/shared/generated/apis/UploadApi.d.ts

@@ -13,6 +13,9 @@ import * as runtime from "../runtime";
 import type { BasicUploadResponse, BeginMultipartUploadRequest, BeginMultipartUploadResponse, CompleteUploadPartRequest, UploadFromUrlRequest, UploadPart, UploadPartList } from "../models";
 export interface BeginMultipartUploadOperationParams {
     accountId: string;
+    /**
+     *
+     */
     beginMultipartUploadRequest: BeginMultipartUploadRequest;
 }
 export interface CompleteUploadPartOperationParams {
@@ -32,11 +35,11 @@ export interface ListUploadPartsParams {
 }
 export interface UploadFromUrlOperationParams {
     accountId: string;
+    /**
+     *
+     */
     uploadFromUrlRequest: UploadFromUrlRequest;
 }
-/**
- *
- */
 export declare class UploadApi extends runtime.BaseAPI {
     /**
      * Begins a new multipart file upload process.