@aurigma/axios-design-atoms-api-client 2.70.1 → 2.71.1

package/dist/cjs/design-atoms-api-client.js

@@ -8,7 +8,7 @@
 //----------------------
 // ReSharper disable InconsistentNaming
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiException = exports.TextVerticalAlignment = exports.TextAlignment = exports.ProductProofInterpolationMode = exports.ProductProofFormat = exports.ProductPreviewFormat = exports.ProductPatchType = exports.PlaceholderItemContentType = exports.ItemType = exports.ItemSourceType = exports.ImagePreviewFormat = exports.ImagePreviewFitMode = exports.DesignElementType = exports.ConflictType = exports.DesignAtomsViewerApiClient = exports.DesignAtomsServiceApiClient = exports.DesignAtomsPrintProductItemsApiClient = exports.DesignAtomsPrintProductApiClient = exports.DesignAtomsPalettesApiClient = exports.DesignAtomsMockups3dApiClient = exports.DesignAtomsImagesApiClient = exports.DesignAtomsCompatibilityApiClient = exports.BuildInfoApiClient = exports.ApiClientBase = exports.ApiClientConfiguration = void 0;
+exports.ApiException = exports.TextVerticalAlignment = exports.TextAlignment = exports.ProductProofInterpolationMode = exports.ProductProofFormat = exports.ProductPreviewFormat = exports.ProductPatchType = exports.PlaceholderItemContentType = exports.ItemType = exports.ItemSourceType = exports.ImagePreviewFormat = exports.ImagePreviewFitMode = exports.ImageExtractionFormat = exports.DesignElementType = exports.ConflictType = exports.DesignAtomsViewerApiClient = exports.DesignAtomsServiceApiClient = exports.DesignAtomsPrintProductItemsApiClient = exports.DesignAtomsPrintProductApiClient = exports.DesignAtomsPalettesApiClient = exports.DesignAtomsMockups3dApiClient = exports.DesignAtomsImagesApiClient = exports.DesignAtomsCompatibilityApiClient = exports.BuildInfoApiClient = exports.ApiClientBase = exports.ApiClientConfiguration = void 0;
 const axios_1 = require("axios");
 class ApiClientConfiguration {
     apiUrl;
@@ -743,27 +743,38 @@ class DesignAtomsCompatibilityApiClient extends ApiClientBase {
     }
     /**
      * Retrieves an image with resized dimensions and additional visual effects based on the provided parameters.
-    This method accepts query parameters that control the output of the image.
      * @param f (optional) The identifier of the original image file.
      * @param w (optional) Target width of the resulting image.
      * @param h (optional) Target height of the resulting image.
      * @param cmyk (optional) Name of the CMYK profile used for color conversion.
      * @param rgb (optional) Name of the RGB profile used for color conversion.
      * @param grayscale (optional) Name of the grayscale profile used to convert into shades of gray.
-     * @param target (optional) Target color space, one of `"Rgb"`, `"Grayscale"`, or `"Cmyk"`.
-     * @param sq (optional) Indicates that the image is squared. The default value is `false`.
-     * @param effect (optional) Effect applied to the image. The default value is `"None"`.
-    Possible values: `"None"`, `"BlackAndWhite"`, `"FlipVertical"`, `"FlipHorizontal"`, `"Colorize"`, `"Grayscale"`, or `"BlackAndTransparent"`.
-     * @param kp (optional) Indicates that image proportions should be maintained. The default value is `false`.
-     * @param color (optional) String defining an overlay color in the RGB, RGBA, CMYK, or CMYKA format. By default, it's an empty string.
-     * @param obm (optional) Overlay blend mode used for blending colors. By default, it's an empty string.
-    Possible values: `"Normal"`, `"Multiply"`, `"Screen"`, `"Overlay"`, `"Darken"`, `"Lighten"`, `"ColorDodge"`, `"ColorBurn"`, `"HardLight"`, `"SoftLight"`, `"Difference"`, `"Exclusion"`, `"None"`, or `"LinearBurn"`.
-     * @param oo (optional) Opacity level of the overlaid layer, in the range `[0.0,1.0]`. The default value is `null`.
-     * @param alphaMask (optional) Enables alpha mask processing. The default value is `false`.
-     * @param page (optional) Page index in a PDF document that needs to be processed. The default value is `0`.
-     * @param colorizeColor (optional) Color applied for the `"Colorize"` image effect. By default, it's an empty string.
-     * @param rw (optional) Rectangle width for area selection. The default value is `0`.
-     * @param rh (optional) Rectangle height for area selection. The default value is `0`.
+     * @param target (optional) Target color space, one of "Rgb", "Grayscale", or "Cmyk".
+     * @param sq (optional) Indicates that the image is squared.
+    The default value is "false".
+     * @param effect (optional) Effect applied to the image.
+    Possible values: "None", "BlackAndWhite", "FlipVertical", "FlipHorizontal", "Colorize", "Grayscale", or "BlackAndTransparent".
+    The default value is "None".
+     * @param kp (optional) Indicates that image proportions should be maintained.
+    The default value is "false".
+     * @param color (optional) Overlay color in the RGB, RGBA, CMYK, or CMYKA format.
+    By default, it's an empty string.
+     * @param obm (optional) Overlay blend mode used for blending colors.
+    Possible values: "Normal", "Multiply", "Screen", "Overlay", "Darken", "Lighten", "ColorDodge",
+    "ColorBurn", "HardLight", "SoftLight", `Difference", "Exclusion", "None", or "LinearBurn".
+    By default, it's an empty string.
+     * @param oo (optional) Opacity level of the overlaid layer, in the range [0.0, 1.0].
+    The default value is "null".
+     * @param alphaMask (optional) Enables alpha mask processing.
+    The default value is "false".
+     * @param page (optional) Page index in a PDF document that needs to be processed.
+    The default value is "0".
+     * @param colorizeColor (optional) Color applied for the "Colorize" image effect.
+    By default, it's an empty string.
+     * @param rw (optional) Rectangle width for area selection.
+    The default value is "0".
+     * @param rh (optional) Rectangle height for area selection.
+    The default value is "0".
      * @return Success
      */
     img(tenantId, f, w, h, cmyk, rgb, grayscale, target, sq, effect, kp, color, obm, oo, alphaMask, page, colorizeColor, rw, rh, cancelToken) {
@@ -1069,20 +1080,32 @@ class DesignAtomsCompatibilityApiClient extends ApiClientBase {
      * @param cmyk (optional) Name of the CMYK profile used for color conversion.
      * @param rgb (optional) Name of the RGB profile used for color conversion.
      * @param grayscale (optional) Name of the grayscale profile used to convert into shades of gray.
-     * @param target (optional) Target color space, one of `"Rgb"`, `"Grayscale"`, or `"Cmyk"`.
-     * @param sq (optional) Indicates that the image is squared. The default value is `false`.
-     * @param effect (optional) Effect applied to the image. The default value is `"None"`.
-    Possible values: `"None"`, `"BlackAndWhite"`, `"FlipVertical"`, `"FlipHorizontal"`, `"Colorize"`, `"Grayscale"`, or `"BlackAndTransparent"`.
-     * @param kp (optional) Indicates that image proportions should be maintained. The default value is `false`.
-     * @param color (optional) String defining an overlay color in the RGB, RGBA, CMYK, or CMYKA format. By default, it's an empty string.
-     * @param obm (optional) Overlay blend mode used for blending colors. By default, it's an empty string.
-    Possible values: `"Normal"`, `"Multiply"`, `"Screen"`, `"Overlay"`, `"Darken"`, `"Lighten"`, `"ColorDodge"`, `"ColorBurn"`, `"HardLight"`, `"SoftLight"`, `"Difference"`, `"Exclusion"`, `"None"`, or `"LinearBurn"`.
-     * @param oo (optional) Opacity level of the overlaid layer, in the range `[0.0,1.0]`. The default value is `null`.
-     * @param alphaMask (optional) Enables alpha mask processing. The default value is `false`.
-     * @param page (optional) Page index in a PDF document that needs to be processed. The default value is `0`.
-     * @param colorizeColor (optional) Color applied for the `"Colorize"` image effect. By default, it's an empty string.
-     * @param rw (optional) Rectangle width for area selection. The default value is `0`.
-     * @param rh (optional) Rectangle height for area selection. The default value is `0`.
+     * @param target (optional) Target color space, one of "Rgb", "Grayscale", or "Cmyk".
+     * @param sq (optional) Indicates that the image is squared.
+    The default value is "false".
+     * @param effect (optional) Effect applied to the image.
+    Possible values: "None", "BlackAndWhite", "FlipVertical", "FlipHorizontal", "Colorize", "Grayscale", or "BlackAndTransparent".
+    The default value is "None".
+     * @param kp (optional) Indicates that image proportions should be maintained.
+    The default value is "false".
+     * @param color (optional) Overlay color in the RGB, RGBA, CMYK, or CMYKA format.
+    By default, it's an empty string.
+     * @param obm (optional) Overlay blend mode used for blending colors.
+    Possible values: "Normal", "Multiply", "Screen", "Overlay", "Darken", "Lighten", "ColorDodge",
+    "ColorBurn", "HardLight", "SoftLight", `Difference", "Exclusion", "None", or "LinearBurn".
+    By default, it's an empty string.
+     * @param oo (optional) Opacity level of the overlaid layer, in the range [0.0, 1.0].
+    The default value is "null".
+     * @param alphaMask (optional) Enables alpha mask processing.
+    The default value is "false".
+     * @param page (optional) Page index in a PDF document that needs to be processed.
+    The default value is "0".
+     * @param colorizeColor (optional) Color applied for the "Colorize" image effect.
+    By default, it's an empty string.
+     * @param rw (optional) Rectangle width for area selection.
+    The default value is "0".
+     * @param rh (optional) Rectangle height for area selection.
+    The default value is "0".
      * @return Success
      */
     svg(tenantId, f, w, h, cmyk, rgb, grayscale, target, sq, effect, kp, color, obm, oo, alphaMask, page, colorizeColor, rw, rh, cancelToken) {
@@ -2004,6 +2027,13 @@ class DesignAtomsImagesApiClient extends ApiClientBase {
             result404 = JSON.parse(resultData404);
             return throwException("Not Found", status, _responseText, _headers, result404);
         }
+        else if (status === 409) {
+            const _responseText = response.data;
+            let result409 = null;
+            let resultData409 = _responseText;
+            result409 = JSON.parse(resultData409);
+            return throwException("Conflict", status, _responseText, _headers, result409);
+        }
         else if (status === 401) {
             const _responseText = response.data;
             return throwException("Unauthorized", status, _responseText, _headers);
@@ -2030,9 +2060,10 @@ class DesignAtomsImagesApiClient extends ApiClientBase {
      * @param height (optional)
      * @param fileFormat (optional)
      * @param fitMode (optional)
+     * @param pageIndex (optional)
      * @return Success
      */
-    renderImagePreviewFromFile(attachment, tenantId, sourceFile, mockupOwnerId, mockupId, width, height, fileFormat, fitMode, cancelToken) {
+    renderImagePreviewFromFile(attachment, tenantId, sourceFile, mockupOwnerId, mockupId, width, height, fileFormat, fitMode, pageIndex, cancelToken) {
         let url_ = this.baseUrl + "/api/atoms/v1/images/render-preview/from-file?";
         if (attachment !== undefined && attachment !== null)
             url_ += "attachment=" + encodeURIComponent("" + attachment) + "&";
@@ -2056,6 +2087,8 @@ class DesignAtomsImagesApiClient extends ApiClientBase {
             content_.append("fileFormat", fileFormat.toString());
         if (fitMode !== null && fitMode !== undefined)
             content_.append("fitMode", fitMode.toString());
+        if (pageIndex !== null && pageIndex !== undefined)
+            content_.append("pageIndex", pageIndex.toString());
         let options_ = {
             data: content_,
             responseType: "blob",
@@ -2102,6 +2135,13 @@ class DesignAtomsImagesApiClient extends ApiClientBase {
             result404 = JSON.parse(resultData404);
             return throwException("Not Found", status, _responseText, _headers, result404);
         }
+        else if (status === 409) {
+            const _responseText = response.data;
+            let result409 = null;
+            let resultData409 = _responseText;
+            result409 = JSON.parse(resultData409);
+            return throwException("Conflict", status, _responseText, _headers, result409);
+        }
         else if (status === 401) {
             const _responseText = response.data;
             return throwException("Unauthorized", status, _responseText, _headers);
@@ -2133,9 +2173,10 @@ class DesignAtomsImagesApiClient extends ApiClientBase {
      * @param height (optional)
      * @param fileFormat (optional)
      * @param fitMode (optional)
+     * @param pageIndex (optional)
      * @return Success
      */
-    renderImagePreviewFromFileToResource(tenantId, resourceOwnerId, resourceNamespace, resourceName, resourceSourceId, resourceType, anonymousAccess, overwriteExistingResource, sourceFile, mockupOwnerId, mockupId, width, height, fileFormat, fitMode, cancelToken) {
+    renderImagePreviewFromFileToResource(tenantId, resourceOwnerId, resourceNamespace, resourceName, resourceSourceId, resourceType, anonymousAccess, overwriteExistingResource, sourceFile, mockupOwnerId, mockupId, width, height, fileFormat, fitMode, pageIndex, cancelToken) {
         let url_ = this.baseUrl + "/api/atoms/v1/images/render-preview/from-file/to-resource?";
         if (tenantId === null)
             throw new Error("The parameter 'tenantId' cannot be null.");
@@ -2171,6 +2212,8 @@ class DesignAtomsImagesApiClient extends ApiClientBase {
             content_.append("fileFormat", fileFormat.toString());
         if (fitMode !== null && fitMode !== undefined)
             content_.append("fitMode", fitMode.toString());
+        if (pageIndex !== null && pageIndex !== undefined)
+            content_.append("pageIndex", pageIndex.toString());
         let options_ = {
             data: content_,
             method: "POST",
@@ -2303,6 +2346,13 @@ class DesignAtomsImagesApiClient extends ApiClientBase {
             result404 = JSON.parse(resultData404);
             return throwException("Not Found", status, _responseText, _headers, result404);
         }
+        else if (status === 409) {
+            const _responseText = response.data;
+            let result409 = null;
+            let resultData409 = _responseText;
+            result409 = JSON.parse(resultData409);
+            return throwException("Conflict", status, _responseText, _headers, result409);
+        }
         else if (status === 401) {
             const _responseText = response.data;
             return throwException("Unauthorized", status, _responseText, _headers);
@@ -5915,6 +5965,13 @@ class DesignAtomsPrintProductItemsApiClient extends ApiClientBase {
             result200 = JSON.parse(resultData200);
             return Promise.resolve(result200);
         }
+        else if (status === 400) {
+            const _responseText = response.data;
+            let result400 = null;
+            let resultData400 = _responseText;
+            result400 = JSON.parse(resultData400);
+            return throwException("Bad Request", status, _responseText, _headers, result400);
+        }
         else if (status === 401) {
             const _responseText = response.data;
             return throwException("Unauthorized", status, _responseText, _headers);
@@ -5983,6 +6040,88 @@ class DesignAtomsPrintProductItemsApiClient extends ApiClientBase {
             const fileName = fileNameMatch && fileNameMatch.length > 1 ? fileNameMatch[1] : undefined;
             return Promise.resolve({ fileName: fileName, status: status, data: new Blob([response.data]), headers: _headers });
         }
+        else if (status === 400) {
+            const _responseText = response.data;
+            let result400 = null;
+            let resultData400 = _responseText;
+            result400 = JSON.parse(resultData400);
+            return throwException("Bad Request", status, _responseText, _headers, result400);
+        }
+        else if (status === 401) {
+            const _responseText = response.data;
+            return throwException("Unauthorized", status, _responseText, _headers);
+        }
+        else if (status === 403) {
+            const _responseText = response.data;
+            return throwException("Forbidden", status, _responseText, _headers);
+        }
+        else if (status !== 200 && status !== 204) {
+            const _responseText = response.data;
+            return throwException("An unexpected server error occurred.", status, _responseText, _headers);
+        }
+        return Promise.resolve(null);
+    }
+    /**
+     * Extracts print-product item image.
+     * @param tenantId (optional) Tenant ID.
+     * @param body (optional) Extraction parameters.
+     * @return Success
+     */
+    extractItemImageToResource(tenantId, body, cancelToken) {
+        let url_ = this.baseUrl + "/api/atoms/v1/designs/print-product/items/extract-image/to-resource?";
+        if (tenantId === null)
+            throw new Error("The parameter 'tenantId' cannot be null.");
+        else if (tenantId !== undefined)
+            url_ += "tenantId=" + encodeURIComponent("" + tenantId) + "&";
+        url_ = url_.replace(/[?&]$/, "");
+        const content_ = JSON.stringify(body);
+        let options_ = {
+            data: content_,
+            method: "POST",
+            url: url_,
+            headers: {
+                "Content-Type": "application/json",
+                "Accept": "application/octet-stream"
+            },
+            cancelToken
+        };
+        return this.transformOptions(options_).then(transformedOptions_ => {
+            return this.instance.request(transformedOptions_);
+        }).catch((_error) => {
+            if (isAxiosError(_error) && _error.response) {
+                return _error.response;
+            }
+            else {
+                throw _error;
+            }
+        }).then((_response) => {
+            return this.transformResult(url_, _response, (_response) => this.processExtractItemImageToResource(_response));
+        });
+    }
+    processExtractItemImageToResource(response) {
+        const status = response.status;
+        let _headers = {};
+        if (response.headers && typeof response.headers === "object") {
+            for (let k in response.headers) {
+                if (response.headers.hasOwnProperty(k)) {
+                    _headers[k] = response.headers[k];
+                }
+            }
+        }
+        if (status === 200) {
+            const _responseText = response.data;
+            let result200 = null;
+            let resultData200 = _responseText;
+            result200 = JSON.parse(resultData200);
+            return Promise.resolve(result200);
+        }
+        else if (status === 400) {
+            const _responseText = response.data;
+            let result400 = null;
+            let resultData400 = _responseText;
+            result400 = JSON.parse(resultData400);
+            return throwException("Bad Request", status, _responseText, _headers, result400);
+        }
         else if (status === 401) {
             const _responseText = response.data;
             return throwException("Unauthorized", status, _responseText, _headers);
@@ -6054,6 +6193,20 @@ class DesignAtomsPrintProductItemsApiClient extends ApiClientBase {
             result200 = JSON.parse(resultData200);
             return Promise.resolve(result200);
         }
+        else if (status === 400) {
+            const _responseText = response.data;
+            let result400 = null;
+            let resultData400 = _responseText;
+            result400 = JSON.parse(resultData400);
+            return throwException("Bad Request", status, _responseText, _headers, result400);
+        }
+        else if (status === 409) {
+            const _responseText = response.data;
+            let result409 = null;
+            let resultData409 = _responseText;
+            result409 = JSON.parse(resultData409);
+            return throwException("Conflict", status, _responseText, _headers, result409);
+        }
         else if (status === 401) {
             const _responseText = response.data;
             return throwException("Unauthorized", status, _responseText, _headers);
@@ -6074,10 +6227,11 @@ class DesignAtomsPrintProductItemsApiClient extends ApiClientBase {
      * @param tenantId (optional) Tenant ID.
      * @param sourceFile (optional)
      * @param paletteUID (optional)
+     * @param pageIndex (optional)
      * @param preserveOriginalFile (optional)
      * @return Success
      */
-    createItemFromFile(itemType, tenantId, sourceFile, paletteUID, preserveOriginalFile, cancelToken) {
+    createItemFromFile(itemType, tenantId, sourceFile, paletteUID, pageIndex, preserveOriginalFile, cancelToken) {
         let url_ = this.baseUrl + "/api/atoms/v1/designs/print-product/items/from-file?";
         if (itemType !== undefined && itemType !== null)
             url_ += "itemType=" + encodeURIComponent("" + itemType) + "&";
@@ -6091,6 +6245,8 @@ class DesignAtomsPrintProductItemsApiClient extends ApiClientBase {
             content_.append("sourceFile", sourceFile.data, sourceFile.fileName ? sourceFile.fileName : "sourceFile");
         if (paletteUID !== null && paletteUID !== undefined)
             content_.append("paletteUID", paletteUID.toString());
+        if (pageIndex !== null && pageIndex !== undefined)
+            content_.append("pageIndex", pageIndex.toString());
         if (preserveOriginalFile !== null && preserveOriginalFile !== undefined)
             content_.append("preserveOriginalFile", preserveOriginalFile.toString());
         let options_ = {
@@ -6132,6 +6288,13 @@ class DesignAtomsPrintProductItemsApiClient extends ApiClientBase {
             result200 = JSON.parse(resultData200);
             return Promise.resolve(result200);
         }
+        else if (status === 400) {
+            const _responseText = response.data;
+            let result400 = null;
+            let resultData400 = _responseText;
+            result400 = JSON.parse(resultData400);
+            return throwException("Bad Request", status, _responseText, _headers, result400);
+        }
         else if (status === 404) {
             const _responseText = response.data;
             let result404 = null;
@@ -6224,6 +6387,13 @@ class DesignAtomsPrintProductItemsApiClient extends ApiClientBase {
             result200 = JSON.parse(resultData200);
             return Promise.resolve(result200);
         }
+        else if (status === 400) {
+            const _responseText = response.data;
+            let result400 = null;
+            let resultData400 = _responseText;
+            result400 = JSON.parse(resultData400);
+            return throwException("Bad Request", status, _responseText, _headers, result400);
+        }
         else if (status === 404) {
             const _responseText = response.data;
             let result404 = null;
@@ -6309,6 +6479,13 @@ class DesignAtomsPrintProductItemsApiClient extends ApiClientBase {
             result200 = JSON.parse(resultData200);
             return Promise.resolve(result200);
         }
+        else if (status === 400) {
+            const _responseText = response.data;
+            let result400 = null;
+            let resultData400 = _responseText;
+            result400 = JSON.parse(resultData400);
+            return throwException("Bad Request", status, _responseText, _headers, result400);
+        }
         else if (status === 404) {
             const _responseText = response.data;
             let result404 = null;
@@ -6394,6 +6571,13 @@ class DesignAtomsPrintProductItemsApiClient extends ApiClientBase {
             result200 = JSON.parse(resultData200);
             return Promise.resolve(result200);
         }
+        else if (status === 400) {
+            const _responseText = response.data;
+            let result400 = null;
+            let resultData400 = _responseText;
+            result400 = JSON.parse(resultData400);
+            return throwException("Bad Request", status, _responseText, _headers, result400);
+        }
         else if (status === 404) {
             const _responseText = response.data;
             let result404 = null;
@@ -9347,27 +9531,38 @@ class DesignAtomsViewerApiClient extends ApiClientBase {
     }
     /**
      * Retrieves an image with resized dimensions and additional visual effects based on the provided parameters.
-    This method accepts query parameters that control the output of the image.
      * @param f (optional) The identifier of the original image file.
      * @param w (optional) Target width of the resulting image.
      * @param h (optional) Target height of the resulting image.
      * @param cmyk (optional) Name of the CMYK profile used for color conversion.
      * @param rgb (optional) Name of the RGB profile used for color conversion.
      * @param grayscale (optional) Name of the grayscale profile used to convert into shades of gray.
-     * @param target (optional) Target color space, one of `"Rgb"`, `"Grayscale"`, or `"Cmyk"`.
-     * @param sq (optional) Indicates that the image is squared. The default value is `false`.
-     * @param effect (optional) Effect applied to the image. The default value is `"None"`.
-    Possible values: `"None"`, `"BlackAndWhite"`, `"FlipVertical"`, `"FlipHorizontal"`, `"Colorize"`, `"Grayscale"`, or `"BlackAndTransparent"`.
-     * @param kp (optional) Indicates that image proportions should be maintained. The default value is `false`.
-     * @param color (optional) String defining an overlay color in the RGB, RGBA, CMYK, or CMYKA format. By default, it's an empty string.
-     * @param obm (optional) Overlay blend mode used for blending colors. By default, it's an empty string.
-    Possible values: `"Normal"`, `"Multiply"`, `"Screen"`, `"Overlay"`, `"Darken"`, `"Lighten"`, `"ColorDodge"`, `"ColorBurn"`, `"HardLight"`, `"SoftLight"`, `"Difference"`, `"Exclusion"`, `"None"`, or `"LinearBurn"`.
-     * @param oo (optional) Opacity level of the overlaid layer, in the range `[0.0,1.0]`. The default value is `null`.
-     * @param alphaMask (optional) Enables alpha mask processing. The default value is `false`.
-     * @param page (optional) Page index in a PDF document that needs to be processed. The default value is `0`.
-     * @param colorizeColor (optional) Color applied for the `"Colorize"` image effect. By default, it's an empty string.
-     * @param rw (optional) Rectangle width for area selection. The default value is `0`.
-     * @param rh (optional) Rectangle height for area selection. The default value is `0`.
+     * @param target (optional) Target color space, one of "Rgb", "Grayscale", or "Cmyk".
+     * @param sq (optional) Indicates that the image is squared.
+    The default value is "false".
+     * @param effect (optional) Effect applied to the image.
+    Possible values: "None", "BlackAndWhite", "FlipVertical", "FlipHorizontal", "Colorize", "Grayscale", or "BlackAndTransparent".
+    The default value is "None".
+     * @param kp (optional) Indicates that image proportions should be maintained.
+    The default value is "false".
+     * @param color (optional) Overlay color in the RGB, RGBA, CMYK, or CMYKA format.
+    By default, it's an empty string.
+     * @param obm (optional) Overlay blend mode used for blending colors.
+    Possible values: "Normal", "Multiply", "Screen", "Overlay", "Darken", "Lighten", "ColorDodge",
+    "ColorBurn", "HardLight", "SoftLight", `Difference", "Exclusion", "None", or "LinearBurn".
+    By default, it's an empty string.
+     * @param oo (optional) Opacity level of the overlaid layer, in the range [0.0, 1.0].
+    The default value is "null".
+     * @param alphaMask (optional) Enables alpha mask processing.
+    The default value is "false".
+     * @param page (optional) Page index in a PDF document that needs to be processed.
+    The default value is "0".
+     * @param colorizeColor (optional) Color applied for the "Colorize" image effect.
+    By default, it's an empty string.
+     * @param rw (optional) Rectangle width for area selection.
+    The default value is "0".
+     * @param rh (optional) Rectangle height for area selection.
+    The default value is "0".
      * @param tenantId (optional) Tenant ID.
      * @return Success
      */
@@ -9681,20 +9876,32 @@ class DesignAtomsViewerApiClient extends ApiClientBase {
      * @param cmyk (optional) Name of the CMYK profile used for color conversion.
      * @param rgb (optional) Name of the RGB profile used for color conversion.
      * @param grayscale (optional) Name of the grayscale profile used to convert into shades of gray.
-     * @param target (optional) Target color space, one of `"Rgb"`, `"Grayscale"`, or `"Cmyk"`.
-     * @param sq (optional) Indicates that the image is squared. The default value is `false`.
-     * @param effect (optional) Effect applied to the image. The default value is `"None"`.
-    Possible values: `"None"`, `"BlackAndWhite"`, `"FlipVertical"`, `"FlipHorizontal"`, `"Colorize"`, `"Grayscale"`, or `"BlackAndTransparent"`.
-     * @param kp (optional) Indicates that image proportions should be maintained. The default value is `false`.
-     * @param color (optional) String defining an overlay color in the RGB, RGBA, CMYK, or CMYKA format. By default, it's an empty string.
-     * @param obm (optional) Overlay blend mode used for blending colors. By default, it's an empty string.
-    Possible values: `"Normal"`, `"Multiply"`, `"Screen"`, `"Overlay"`, `"Darken"`, `"Lighten"`, `"ColorDodge"`, `"ColorBurn"`, `"HardLight"`, `"SoftLight"`, `"Difference"`, `"Exclusion"`, `"None"`, or `"LinearBurn"`.
-     * @param oo (optional) Opacity level of the overlaid layer, in the range `[0.0,1.0]`. The default value is `null`.
-     * @param alphaMask (optional) Enables alpha mask processing. The default value is `false`.
-     * @param page (optional) Page index in a PDF document that needs to be processed. The default value is `0`.
-     * @param colorizeColor (optional) Color applied for the `"Colorize"` image effect. By default, it's an empty string.
-     * @param rw (optional) Rectangle width for area selection. The default value is `0`.
-     * @param rh (optional) Rectangle height for area selection. The default value is `0`.
+     * @param target (optional) Target color space, one of "Rgb", "Grayscale", or "Cmyk".
+     * @param sq (optional) Indicates that the image is squared.
+    The default value is "false".
+     * @param effect (optional) Effect applied to the image.
+    Possible values: "None", "BlackAndWhite", "FlipVertical", "FlipHorizontal", "Colorize", "Grayscale", or "BlackAndTransparent".
+    The default value is "None".
+     * @param kp (optional) Indicates that image proportions should be maintained.
+    The default value is "false".
+     * @param color (optional) Overlay color in the RGB, RGBA, CMYK, or CMYKA format.
+    By default, it's an empty string.
+     * @param obm (optional) Overlay blend mode used for blending colors.
+    Possible values: "Normal", "Multiply", "Screen", "Overlay", "Darken", "Lighten", "ColorDodge",
+    "ColorBurn", "HardLight", "SoftLight", `Difference", "Exclusion", "None", or "LinearBurn".
+    By default, it's an empty string.
+     * @param oo (optional) Opacity level of the overlaid layer, in the range [0.0, 1.0].
+    The default value is "null".
+     * @param alphaMask (optional) Enables alpha mask processing.
+    The default value is "false".
+     * @param page (optional) Page index in a PDF document that needs to be processed.
+    The default value is "0".
+     * @param colorizeColor (optional) Color applied for the "Colorize" image effect.
+    By default, it's an empty string.
+     * @param rw (optional) Rectangle width for area selection.
+    The default value is "0".
+     * @param rh (optional) Rectangle height for area selection.
+    The default value is "0".
      * @param tenantId (optional) Tenant ID.
      * @return Success
      */
@@ -10585,6 +10792,12 @@ var DesignElementType;
     DesignElementType["PrintArea"] = "PrintArea";
     DesignElementType["Item"] = "Item";
 })(DesignElementType = exports.DesignElementType || (exports.DesignElementType = {}));
+/** Image preview file format. */
+var ImageExtractionFormat;
+(function (ImageExtractionFormat) {
+    ImageExtractionFormat["Jpeg"] = "Jpeg";
+    ImageExtractionFormat["Png"] = "Png";
+})(ImageExtractionFormat = exports.ImageExtractionFormat || (exports.ImageExtractionFormat = {}));
 /** Image preview fit mode. */
 var ImagePreviewFitMode;
 (function (ImagePreviewFitMode) {