@aurigma/axios-design-atoms-api-client 2.21.1 → 2.26.1

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

@@ -405,7 +405,7 @@ export interface IDesignAtomsServiceApiClient {
      * @param body (optional) Design variable values
      * @return Success
      */
-    setVariables(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: VariablesModel | null | undefined): Promise<VariablesModel>;
+    setVariables(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: VariablesModel | null | undefined): Promise<void>;
     /**
      * Loads variable data printing information from design file taken from storage
      * @param id Design identifier
@@ -435,9 +435,9 @@ export interface IDesignAtomsServiceApiClient {
      */
     deleteVdpData(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<void>;
     /**
-     * Flatten items
+     * Flatten items.
      * @param tenantId (optional) Tenant identifier
-     * @param body (optional) Items to flatten
+     * @param body (optional) Items to flatten.
      * @return Success
      */
     flattenItems(tenantId?: number | undefined, body?: any[] | null | undefined): Promise<any>;
@@ -452,11 +452,37 @@ export interface IDesignAtomsServiceApiClient {
      * @return Success
      */
     createItem(itemType?: ItemType | null | undefined, tenantId?: number | undefined, sourceType?: ItemSourceType | null | undefined, sourceId?: string | null | undefined, sourceOwnerId?: string | null | undefined, sourceFile?: FileParameter | null | undefined): Promise<any>;
+    /**
+     * Creates a private design from a public design.
+     * @param designId (optional) Public design ID.
+     * @param privateDesignId (optional) Private design ID.
+     * @param privateStorageOwner (optional) Private storage owner ID.
+     * @param tenantId (optional) Tenant identifier
+     * @return Success
+     */
+    createPrivateDesignFromDesign(designId?: string | null | undefined, privateDesignId?: string | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<void>;
+    /**
+     * Creates a private design from a public resource.
+     * @param resourceId (optional) Resource ID.
+     * @param privateDesignId (optional) Private design ID.
+     * @param privateStorageOwner (optional) Private storage owner ID.
+     * @param tenantId (optional) Tenant identifier
+     * @return Success
+     */
+    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').
+     * @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>;
     /**
      * 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')
+     * @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) Preview parameters
+     * @param body (optional) Preview parameters.
      * @return Success
      */
     renderProduct(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderProductModel | null | undefined): Promise<FileResponse>;
@@ -547,8 +573,8 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
      * @param body (optional) Design variable values
      * @return Success
      */
-    setVariables(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: VariablesModel | null | undefined, cancelToken?: CancelToken | undefined): Promise<VariablesModel>;
-    protected processSetVariables(response: AxiosResponse): Promise<VariablesModel>;
+    setVariables(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: VariablesModel | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
+    protected processSetVariables(response: AxiosResponse): Promise<void>;
     /**
      * Loads variable data printing information from design file taken from storage
      * @param id Design identifier
@@ -581,9 +607,9 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
     deleteVdpData(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
     protected processDeleteVdpData(response: AxiosResponse): Promise<void>;
     /**
-     * Flatten items
+     * Flatten items.
      * @param tenantId (optional) Tenant identifier
-     * @param body (optional) Items to flatten
+     * @param body (optional) Items to flatten.
      * @return Success
      */
     flattenItems(tenantId?: number | undefined, body?: any[] | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
@@ -600,11 +626,40 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
      */
     createItem(itemType?: ItemType | null | undefined, tenantId?: number | undefined, sourceType?: ItemSourceType | null | undefined, sourceId?: string | null | undefined, sourceOwnerId?: string | null | undefined, sourceFile?: FileParameter | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
     protected processCreateItem(response: AxiosResponse): Promise<any>;
+    /**
+     * Creates a private design from a public design.
+     * @param designId (optional) Public design ID.
+     * @param privateDesignId (optional) Private design ID.
+     * @param privateStorageOwner (optional) Private storage owner ID.
+     * @param tenantId (optional) Tenant identifier
+     * @return Success
+     */
+    createPrivateDesignFromDesign(designId?: string | null | undefined, privateDesignId?: string | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
+    protected processCreatePrivateDesignFromDesign(response: AxiosResponse): Promise<void>;
+    /**
+     * Creates a private design from a public resource.
+     * @param resourceId (optional) Resource ID.
+     * @param privateDesignId (optional) Private design ID.
+     * @param privateStorageOwner (optional) Private storage owner ID.
+     * @param tenantId (optional) Tenant identifier
+     * @return Success
+     */
+    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').
+     * @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>;
     /**
      * 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')
+     * @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) Preview parameters
+     * @param body (optional) Preview parameters.
      * @return Success
      */
     renderProduct(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderProductModel | null | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
@@ -1060,13 +1115,13 @@ export declare enum ProductPatchType {
     Undefined = "Undefined",
     ReplaceImageItemFile = "ReplaceImageItemFile"
 }
-/** Variable information */
+/** Variable information. */
 export interface VariableInfo {
-    /** Variable name */
+    /** Variable name. */
     name?: string | null;
-    /** Variable value */
+    /** Variable value. */
     value?: string | null;
-    /** Variable type */
+    /** Variable type. */
     type?: string | null;
 }
 /** Variables information */
@@ -1093,6 +1148,33 @@ export declare enum ItemSourceType {
     ImageStorage = "ImageStorage",
     PrivateImageStorage = "PrivateImageStorage"
 }
+/** Product preview file format. */
+export declare enum ProductPreviewFormat {
+    Jpeg = "Jpeg",
+    Png = "Png",
+    Tiff = "Tiff",
+    Pdf = "Pdf"
+}
+export interface ProductPreviewRenderingConfig {
+    surfaceIndex?: number | null;
+    width?: number;
+    height?: number;
+    fileFormat?: ProductPreviewFormat | null;
+}
+export interface RenderDesignModel {
+    /** Design ID.
+Used to get design file from public or private storage. */
+    designId?: string | null;
+    /** Mockup ID.
+Used to get mockup file from public storage. */
+    mockupId?: string | null;
+    /** ID of the design owner. */
+    ownerId?: string | null;
+    /** Rendering configuration for getting a preview of design. */
+    renderingConfig?: ProductPreviewRenderingConfig | null;
+    /** Variable (user) data of design. */
+    variableData?: VariableInfo[] | null;
+}
 export declare enum ProductProofFormat {
     Jpeg = "Jpeg",
     Png = "Png",

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

@@ -2174,7 +2174,6 @@ export class DesignAtomsServiceApiClient extends ApiClientBase {
             url: url_,
             headers: {
                 "Content-Type": "application/json",
-                "Accept": "application/json"
             },
             cancelToken
         };
@@ -2203,10 +2202,7 @@ export class DesignAtomsServiceApiClient extends ApiClientBase {
         }
         if (status === 200) {
             const _responseText = response.data;
-            let result200 = null;
-            let resultData200 = _responseText;
-            result200 = JSON.parse(resultData200);
-            return Promise.resolve(result200);
+            return Promise.resolve(null);
         }
         else if (status === 404) {
             const _responseText = response.data;
@@ -2482,9 +2478,9 @@ export class DesignAtomsServiceApiClient extends ApiClientBase {
         return Promise.resolve(null);
     }
     /**
-     * Flatten items
+     * Flatten items.
      * @param tenantId (optional) Tenant identifier
-     * @param body (optional) Items to flatten
+     * @param body (optional) Items to flatten.
      * @return Success
      */
     flattenItems(tenantId, body, cancelToken) {
@@ -2637,11 +2633,218 @@ export class DesignAtomsServiceApiClient extends ApiClientBase {
         }
         return Promise.resolve(null);
     }
+    /**
+     * Creates a private design from a public design.
+     * @param designId (optional) Public design ID.
+     * @param privateDesignId (optional) Private design ID.
+     * @param privateStorageOwner (optional) Private storage owner ID.
+     * @param tenantId (optional) Tenant identifier
+     * @return Success
+     */
+    createPrivateDesignFromDesign(designId, privateDesignId, privateStorageOwner, tenantId, cancelToken) {
+        let url_ = this.baseUrl + "/api/atoms/v1/private-designs/from-design?";
+        if (designId !== undefined && designId !== null)
+            url_ += "designId=" + encodeURIComponent("" + designId) + "&";
+        if (privateDesignId !== undefined && privateDesignId !== null)
+            url_ += "privateDesignId=" + encodeURIComponent("" + privateDesignId) + "&";
+        if (privateStorageOwner !== undefined && privateStorageOwner !== null)
+            url_ += "privateStorageOwner=" + encodeURIComponent("" + privateStorageOwner) + "&";
+        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",
+            url: url_,
+            headers: {},
+            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.processCreatePrivateDesignFromDesign(_response));
+        });
+    }
+    processCreatePrivateDesignFromDesign(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 === 201) {
+            const _responseText = response.data;
+            return Promise.resolve(null);
+        }
+        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);
+    }
+    /**
+     * Creates a private design from a public resource.
+     * @param resourceId (optional) Resource ID.
+     * @param privateDesignId (optional) Private design ID.
+     * @param privateStorageOwner (optional) Private storage owner ID.
+     * @param tenantId (optional) Tenant identifier
+     * @return Success
+     */
+    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) + "&";
+        if (privateDesignId !== undefined && privateDesignId !== null)
+            url_ += "privateDesignId=" + encodeURIComponent("" + privateDesignId) + "&";
+        if (privateStorageOwner !== undefined && privateStorageOwner !== null)
+            url_ += "privateStorageOwner=" + encodeURIComponent("" + privateStorageOwner) + "&";
+        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",
+            url: url_,
+            headers: {},
+            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.processCreatePrivateDesignFromResource(_response));
+        });
+    }
+    processCreatePrivateDesignFromResource(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 === 201) {
+            const _responseText = response.data;
+            return Promise.resolve(null);
+        }
+        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);
+    }
+    /**
+     * 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').
+     * @param tenantId (optional) Tenant identifier
+     * @param body (optional) Render model with preview parameters.
+     * @return Success
+     */
+    renderDesign(attachment, tenantId, body, cancelToken) {
+        let url_ = this.baseUrl + "/api/atoms/v1/render-design-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.processRenderDesign(_response));
+        });
+    }
+    processRenderDesign(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 !== 200 && status !== 204) {
+            const _responseText = response.data;
+            return throwException("An unexpected server error occurred.", status, _responseText, _headers);
+        }
+        return Promise.resolve(null);
+    }
     /**
      * 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')
+     * @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) Preview parameters
+     * @param body (optional) Preview parameters.
      * @return Success
      */
     renderProduct(attachment, tenantId, body, cancelToken) {
@@ -2661,7 +2864,7 @@ export class DesignAtomsServiceApiClient extends ApiClientBase {
             url: url_,
             headers: {
                 "Content-Type": "application/json",
-                "Accept": "application/json"
+                "Accept": "application/octet-stream"
             },
             cancelToken
         };
@@ -4195,6 +4398,14 @@ export var ItemSourceType;
     ItemSourceType["ImageStorage"] = "ImageStorage";
     ItemSourceType["PrivateImageStorage"] = "PrivateImageStorage";
 })(ItemSourceType || (ItemSourceType = {}));
+/** Product preview file format. */
+export var ProductPreviewFormat;
+(function (ProductPreviewFormat) {
+    ProductPreviewFormat["Jpeg"] = "Jpeg";
+    ProductPreviewFormat["Png"] = "Png";
+    ProductPreviewFormat["Tiff"] = "Tiff";
+    ProductPreviewFormat["Pdf"] = "Pdf";
+})(ProductPreviewFormat || (ProductPreviewFormat = {}));
 export var ProductProofFormat;
 (function (ProductProofFormat) {
     ProductProofFormat["Jpeg"] = "Jpeg";