@aurigma/axios-design-atoms-api-client 2.28.1 → 2.29.1

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

@@ -480,13 +480,23 @@ export interface IDesignAtomsServiceApiClient {
      */
     createPrivateDesignFromResource(resourceId?: string | null | undefined, privateDesignId?: string | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<void>;
     /**
-     * Renders a design 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').
+     * Renders a design 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 identifier
      * @param body (optional) Render model with preview parameters.
      * @return Success
      */
-    renderDesign(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderDesignModel | null | undefined): Promise<FileResponse>;
+    renderDesignPreview(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderDesignPreviewModel | null | undefined): Promise<FileResponse>;
+    /**
+     * Renders a design proof 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 identifier
+     * @param body (optional) Render model with proof parameters.
+     * @return Success
+     */
+    renderDesignProof(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderDesignProofModel | null | undefined): Promise<FileResponse>;
     /**
      * Render product proof image with specified parameters.
      * @param attachment (optional) If set to 'true', file will be provided as an attachment with unique filename supplied (default value is 'false').
@@ -666,14 +676,25 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
     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>;
     /**
-     * Renders a design 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').
+     * Renders a design 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 identifier
      * @param body (optional) Render model with preview parameters.
      * @return Success
      */
-    renderDesign(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderDesignModel | null | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
-    protected processRenderDesign(response: AxiosResponse): Promise<FileResponse>;
+    renderDesignPreview(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderDesignPreviewModel | null | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
+    protected processRenderDesignPreview(response: AxiosResponse): Promise<FileResponse>;
+    /**
+     * Renders a design proof 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 identifier
+     * @param body (optional) Render model with proof parameters.
+     * @return Success
+     */
+    renderDesignProof(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderDesignProofModel | null | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
+    protected processRenderDesignProof(response: AxiosResponse): Promise<FileResponse>;
     /**
      * Render product proof image with specified parameters.
      * @param attachment (optional) If set to 'true', file will be provided as an attachment with unique filename supplied (default value is 'false').
@@ -1200,7 +1221,7 @@ export interface ProductPreviewRenderingConfig {
     height?: number;
     fileFormat?: ProductPreviewFormat | null;
 }
-export interface RenderDesignModel {
+export interface RenderDesignPreviewModel {
     /** Design ID.
 Used to get design file from public or private storage. */
     designId?: string | null;
@@ -1253,6 +1274,17 @@ export interface ProductProofRenderingConfig {
     /** Defines whether watermark should be repeated */
     watermarkRepeat?: boolean | null;
 }
+export interface RenderDesignProofModel {
+    /** Design ID.
+Used to get design file from public or private storage. */
+    designId?: string | null;
+    /** ID of the design owner. */
+    ownerId?: string | null;
+    /** Rendering configuration for getting a preview of design. */
+    renderingConfig?: ProductProofRenderingConfig | null;
+    /** Variable (user) data of design. */
+    variableData?: VariableInfo[] | null;
+}
 /** Render product parameters */
 export interface RenderProductModel {
     /** Serialized product description */

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

@@ -3152,13 +3152,14 @@ class DesignAtomsServiceApiClient extends ApiClientBase {
         return Promise.resolve(null);
     }
     /**
-     * Renders a design 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').
+     * Renders a design 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 identifier
      * @param body (optional) Render model with preview parameters.
      * @return Success
      */
-    renderDesign(attachment, tenantId, body, cancelToken) {
+    renderDesignPreview(attachment, tenantId, body, cancelToken) {
         let url_ = this.baseUrl + "/api/atoms/v1/render-design-preview?";
         if (attachment !== undefined && attachment !== null)
             url_ += "attachment=" + encodeURIComponent("" + attachment) + "&";
@@ -3189,10 +3190,89 @@ class DesignAtomsServiceApiClient extends ApiClientBase {
                 throw _error;
             }
         }).then((_response) => {
-            return this.transformResult(url_, _response, (_response) => this.processRenderDesign(_response));
+            return this.transformResult(url_, _response, (_response) => this.processRenderDesignPreview(_response));
+        });
+    }
+    processRenderDesignPreview(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 === 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 === 500) {
+            const _responseText = response.data;
+            let result500 = null;
+            let resultData500 = _responseText;
+            result500 = JSON.parse(resultData500);
+            return throwException("Internal server error", status, _responseText, _headers, result500);
+        }
+        else if (status !== 200 && status !== 204) {
+            const _responseText = response.data;
+            return throwException("An unexpected server error occurred.", status, _responseText, _headers);
+        }
+        return Promise.resolve(null);
+    }
+    /**
+     * Renders a design proof 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 identifier
+     * @param body (optional) Render model with proof parameters.
+     * @return Success
+     */
+    renderDesignProof(attachment, tenantId, body, cancelToken) {
+        let url_ = this.baseUrl + "/api/atoms/v1/render-design-proof?";
+        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.processRenderDesignProof(_response));
         });
     }
-    processRenderDesign(response) {
+    processRenderDesignProof(response) {
         const status = response.status;
         let _headers = {};
         if (response.headers && typeof response.headers === "object") {