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

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

@@ -736,24 +736,28 @@ export class DesignAtomsCompatibilityApiClient extends ApiClientBase {
         return Promise.resolve(null);
     }
     /**
-     * @param f (optional)
-     * @param w (optional)
-     * @param h (optional)
-     * @param cmyk (optional)
-     * @param rgb (optional)
-     * @param grayscale (optional)
-     * @param target (optional)
-     * @param sq (optional)
-     * @param effect (optional)
-     * @param kp (optional)
-     * @param color (optional)
-     * @param obm (optional)
-     * @param oo (optional)
-     * @param alphaMask (optional)
-     * @param page (optional)
-     * @param colorizeColor (optional)
-     * @param rw (optional)
-     * @param rh (optional)
+     * 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`.
      * @return Success
      */
     img(tenantId, f, w, h, cmyk, rgb, grayscale, target, sq, effect, kp, color, obm, oo, alphaMask, page, colorizeColor, rw, rh, cancelToken) {
@@ -1053,24 +1057,26 @@ export class DesignAtomsCompatibilityApiClient extends ApiClientBase {
         return Promise.resolve(null);
     }
     /**
-     * @param f (optional)
-     * @param w (optional)
-     * @param h (optional)
-     * @param cmyk (optional)
-     * @param rgb (optional)
-     * @param grayscale (optional)
-     * @param target (optional)
-     * @param sq (optional)
-     * @param effect (optional)
-     * @param kp (optional)
-     * @param color (optional)
-     * @param obm (optional)
-     * @param oo (optional)
-     * @param alphaMask (optional)
-     * @param page (optional)
-     * @param colorizeColor (optional)
-     * @param rw (optional)
-     * @param rh (optional)
+     * @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`.
      * @return Success
      */
     svg(tenantId, f, w, h, cmyk, rgb, grayscale, target, sq, effect, kp, color, obm, oo, alphaMask, page, colorizeColor, rw, rh, cancelToken) {
@@ -3096,6 +3102,13 @@ export class DesignAtomsPrintProductApiClient 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);
@@ -3475,6 +3488,13 @@ export class DesignAtomsPrintProductApiClient 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);
@@ -3941,6 +3961,13 @@ export class DesignAtomsPrintProductApiClient 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);
@@ -4268,6 +4295,13 @@ export class DesignAtomsPrintProductApiClient 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);
@@ -4734,6 +4768,13 @@ export class DesignAtomsPrintProductApiClient 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);
@@ -9292,24 +9333,28 @@ export class DesignAtomsViewerApiClient extends ApiClientBase {
         return Promise.resolve(null);
     }
     /**
-     * @param f (optional)
-     * @param w (optional)
-     * @param h (optional)
-     * @param cmyk (optional)
-     * @param rgb (optional)
-     * @param grayscale (optional)
-     * @param target (optional)
-     * @param sq (optional)
-     * @param effect (optional)
-     * @param kp (optional)
-     * @param color (optional)
-     * @param obm (optional)
-     * @param oo (optional)
-     * @param alphaMask (optional)
-     * @param page (optional)
-     * @param colorizeColor (optional)
-     * @param rw (optional)
-     * @param rh (optional)
+     * 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 tenantId (optional) Tenant ID.
      * @return Success
      */
@@ -9617,24 +9662,26 @@ export class DesignAtomsViewerApiClient extends ApiClientBase {
         return Promise.resolve(null);
     }
     /**
-     * @param f (optional)
-     * @param w (optional)
-     * @param h (optional)
-     * @param cmyk (optional)
-     * @param rgb (optional)
-     * @param grayscale (optional)
-     * @param target (optional)
-     * @param sq (optional)
-     * @param effect (optional)
-     * @param kp (optional)
-     * @param color (optional)
-     * @param obm (optional)
-     * @param oo (optional)
-     * @param alphaMask (optional)
-     * @param page (optional)
-     * @param colorizeColor (optional)
-     * @param rw (optional)
-     * @param rh (optional)
+     * @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 tenantId (optional) Tenant ID.
      * @return Success
      */