@aurigma/axios-design-atoms-api-client 2.74.1 → 2.76.4

package/dist/cjs/design-atoms-api-client.d.ts

@@ -617,6 +617,33 @@ export declare class DesignAtomsImagesApiClient extends ApiClientBase implements
     renderImagePreviewToResource(tenantId?: number | undefined, body?: RenderImagePreviewToResourceModel | undefined, cancelToken?: CancelToken | undefined): Promise<ResourceInfoDto>;
     protected processRenderImagePreviewToResource(response: AxiosResponse): Promise<ResourceInfoDto>;
 }
+export interface IDesignAtomsMockups2dApiClient {
+    /**
+     * Renders a mockup preview with the specified parameters.
+     * @param attachment (optional) If set to 'true', file will be provided as an attachment with unique filename supplied
+    (default value is 'false').
+     * @param tenantId (optional) Tenant ID.
+     * @param body (optional) Render model with preview parameters.
+     * @return Success
+     */
+    renderMockupPreview(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderMockupPreviewModel | undefined): Promise<FileResponse>;
+}
+export declare class DesignAtomsMockups2dApiClient extends ApiClientBase implements IDesignAtomsMockups2dApiClient {
+    private instance;
+    private baseUrl;
+    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
+    constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
+    /**
+     * Renders a mockup preview with the specified parameters.
+     * @param attachment (optional) If set to 'true', file will be provided as an attachment with unique filename supplied
+    (default value is 'false').
+     * @param tenantId (optional) Tenant ID.
+     * @param body (optional) Render model with preview parameters.
+     * @return Success
+     */
+    renderMockupPreview(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderMockupPreviewModel | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
+    protected processRenderMockupPreview(response: AxiosResponse): Promise<FileResponse>;
+}
 export interface IDesignAtomsMockups3dApiClient {
     /**
      * Returns a 3D-Mockup attributes.
@@ -1797,11 +1824,11 @@ export interface IDesignAtomsServiceApiClient {
      * @param resourceId (optional) Resource identifier.
      * @param privateDesignId (optional) Private design identifier.
      * @param privateStorageOwner (optional) Private storage owner identifier.
-     * @param tenantIdQuery (optional) Tenant identifier.
+     * @param tenantId (optional) Tenant ID.
      * @return Created
      * @deprecated
      */
-    createPrivateDesignFromResource(resourceId?: string | null | undefined, privateDesignId?: string | null | undefined, privateStorageOwner?: string | null | undefined, tenantIdQuery?: number | undefined): Promise<void>;
+    createPrivateDesignFromResource(resourceId?: string | null | undefined, privateDesignId?: string | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<void>;
 }
 export declare class DesignAtomsServiceApiClient extends ApiClientBase implements IDesignAtomsServiceApiClient {
     private instance;
@@ -2069,11 +2096,11 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
      * @param resourceId (optional) Resource identifier.
      * @param privateDesignId (optional) Private design identifier.
      * @param privateStorageOwner (optional) Private storage owner identifier.
-     * @param tenantIdQuery (optional) Tenant identifier.
+     * @param tenantId (optional) Tenant ID.
      * @return Created
      * @deprecated
      */
-    createPrivateDesignFromResource(resourceId?: string | null | undefined, privateDesignId?: string | null | undefined, privateStorageOwner?: string | null | undefined, tenantIdQuery?: number | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
+    createPrivateDesignFromResource(resourceId?: string | null | undefined, privateDesignId?: string | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
     protected processCreatePrivateDesignFromResource(response: AxiosResponse): Promise<void>;
 }
 export interface IDesignAtomsViewerApiClient {
@@ -2956,6 +2983,35 @@ export interface Mockup3dAttributesDto {
         [key: string]: string;
     } | null;
 }
+/** Mockup preview fitting mode. */
+export declare enum MockupPreviewFitMode {
+    Fit = "Fit",
+    Shrink = "Shrink",
+    Resize = "Resize",
+    Fill = "Fill"
+}
+/** Mockup preview file format. */
+export declare enum MockupPreviewFormat {
+    Jpeg = "Jpeg",
+    Png = "Png"
+}
+/** Settings that describe mockup preview rendering parameters. */
+export interface MockupPreviewRenderingConfig {
+    /** Mockup preview width (in pixels). */
+    width?: number;
+    /** Mockup preview height (in pixels). */
+    height?: number;
+    /** Parameters of active group layers. Each group can have only one active layer.
+E.g. { "Group1: "Layer1", "Group2": "Layer2" }.
+If value is not set, all visible layers will be rendered. */
+    groups?: {
+        [key: string]: string;
+    } | null;
+    /** Mockup preview file format. */
+    fileFormat?: MockupPreviewFormat | null;
+    /** Mockup preview fit mode. */
+    fitMode?: MockupPreviewFitMode | null;
+}
 export interface MultiCallRequest {
     items?: MultiCallRequestItem[] | null;
 }
@@ -3219,6 +3275,14 @@ export interface RenderImagePreviewToResourceModel {
     /** Image preview configuration. */
     renderingConfig?: ImagePreviewRenderingConfig | null;
 }
+export interface RenderMockupPreviewModel {
+    /** Mockup identifier. */
+    mockupId?: string | null;
+    /** Storage image owner identifier. */
+    ownerId?: string | null;
+    /** Mockup preview configuration. */
+    renderingConfig?: MockupPreviewRenderingConfig | null;
+}
 /** Render product parameters. */
 export interface RenderProductModel {
     /** Serialized product description. */

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.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;
+exports.ApiException = exports.TextVerticalAlignment = exports.TextAlignment = exports.ProductProofInterpolationMode = exports.ProductProofFormat = exports.ProductPreviewFormat = exports.ProductPatchType = exports.PlaceholderItemContentType = exports.MockupPreviewFormat = exports.MockupPreviewFitMode = 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.DesignAtomsMockups2dApiClient = exports.DesignAtomsImagesApiClient = exports.DesignAtomsCompatibilityApiClient = exports.BuildInfoApiClient = exports.ApiClientBase = exports.ApiClientConfiguration = void 0;
 const axios_1 = require("axios");
 class ApiClientConfiguration {
     apiUrl;
@@ -2545,6 +2545,103 @@ class DesignAtomsImagesApiClient extends ApiClientBase {
     }
 }
 exports.DesignAtomsImagesApiClient = DesignAtomsImagesApiClient;
+class DesignAtomsMockups2dApiClient extends ApiClientBase {
+    instance;
+    baseUrl;
+    jsonParseReviver = undefined;
+    constructor(configuration, baseUrl, instance) {
+        super(configuration);
+        this.instance = instance ? instance : axios_1.create();
+        this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : this.getBaseUrl("");
+    }
+    /**
+     * Renders a mockup preview with the specified parameters.
+     * @param attachment (optional) If set to 'true', file will be provided as an attachment with unique filename supplied
+    (default value is 'false').
+     * @param tenantId (optional) Tenant ID.
+     * @param body (optional) Render model with preview parameters.
+     * @return Success
+     */
+    renderMockupPreview(attachment, tenantId, body, cancelToken) {
+        let url_ = this.baseUrl + "/api/atoms/v1/mockups-2d/render-preview?";
+        if (attachment !== undefined && attachment !== null)
+            url_ += "attachment=" + encodeURIComponent("" + attachment) + "&";
+        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_,
+            responseType: "blob",
+            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.processRenderMockupPreview(_response));
+        });
+    }
+    processRenderMockupPreview(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 || status === 206) {
+            const contentDisposition = response.headers ? response.headers["content-disposition"] : undefined;
+            const fileNameMatch = contentDisposition ? /filename="?([^"]*?)"?(;|$)/g.exec(contentDisposition) : undefined;
+            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 === 404) {
+            const _responseText = response.data;
+            let result404 = null;
+            let resultData404 = _responseText;
+            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);
+        }
+        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);
+    }
+}
+exports.DesignAtomsMockups2dApiClient = DesignAtomsMockups2dApiClient;
 class DesignAtomsMockups3dApiClient extends ApiClientBase {
     instance;
     baseUrl;
@@ -8877,11 +8974,11 @@ class DesignAtomsServiceApiClient extends ApiClientBase {
      * @param resourceId (optional) Resource identifier.
      * @param privateDesignId (optional) Private design identifier.
      * @param privateStorageOwner (optional) Private storage owner identifier.
-     * @param tenantIdQuery (optional) Tenant identifier.
+     * @param tenantId (optional) Tenant ID.
      * @return Created
      * @deprecated
      */
-    createPrivateDesignFromResource(resourceId, privateDesignId, privateStorageOwner, tenantIdQuery, cancelToken) {
+    createPrivateDesignFromResource(resourceId, privateDesignId, privateStorageOwner, tenantId, cancelToken) {
         let url_ = this.baseUrl + "/api/atoms/v1/private-designs/from-resource?";
         if (resourceId !== undefined && resourceId !== null)
             url_ += "resourceId=" + encodeURIComponent("" + resourceId) + "&";
@@ -8889,10 +8986,10 @@ class DesignAtomsServiceApiClient extends ApiClientBase {
             url_ += "privateDesignId=" + encodeURIComponent("" + privateDesignId) + "&";
         if (privateStorageOwner !== undefined && privateStorageOwner !== null)
             url_ += "privateStorageOwner=" + encodeURIComponent("" + privateStorageOwner) + "&";
-        if (tenantIdQuery === null)
-            throw new Error("The parameter 'tenantIdQuery' cannot be null.");
-        else if (tenantIdQuery !== undefined)
-            url_ += "tenantId=" + encodeURIComponent("" + tenantIdQuery) + "&";
+        if (tenantId === null)
+            throw new Error("The parameter 'tenantId' cannot be null.");
+        else if (tenantId !== undefined)
+            url_ += "tenantId=" + encodeURIComponent("" + tenantId) + "&";
         url_ = url_.replace(/[?&]$/, "");
         let options_ = {
             method: "POST",
@@ -10851,6 +10948,20 @@ var ItemType;
     ItemType["Clipart"] = "Clipart";
     ItemType["Group"] = "Group";
 })(ItemType = exports.ItemType || (exports.ItemType = {}));
+/** Mockup preview fitting mode. */
+var MockupPreviewFitMode;
+(function (MockupPreviewFitMode) {
+    MockupPreviewFitMode["Fit"] = "Fit";
+    MockupPreviewFitMode["Shrink"] = "Shrink";
+    MockupPreviewFitMode["Resize"] = "Resize";
+    MockupPreviewFitMode["Fill"] = "Fill";
+})(MockupPreviewFitMode = exports.MockupPreviewFitMode || (exports.MockupPreviewFitMode = {}));
+/** Mockup preview file format. */
+var MockupPreviewFormat;
+(function (MockupPreviewFormat) {
+    MockupPreviewFormat["Jpeg"] = "Jpeg";
+    MockupPreviewFormat["Png"] = "Png";
+})(MockupPreviewFormat = exports.MockupPreviewFormat || (exports.MockupPreviewFormat = {}));
 /** Placeholder item content type. */
 var PlaceholderItemContentType;
 (function (PlaceholderItemContentType) {