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

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

@@ -330,6 +330,33 @@ export declare class DesignAtomsCompatibilityApiClient extends ApiClientBase imp
     updateShapeItemHandler(tenantId: number, body?: UpdateHandlerRequest | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
     protected processUpdateShapeItemHandler(response: AxiosResponse): Promise<any>;
 }
+export interface IDesignAtomsImagesApiClient {
+    /**
+     * Renders a web image 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
+     */
+    renderImagePreview(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderImagePreviewModel | null | undefined): Promise<FileResponse>;
+}
+export declare class DesignAtomsImagesApiClient extends ApiClientBase implements IDesignAtomsImagesApiClient {
+    private instance;
+    private baseUrl;
+    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
+    constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
+    /**
+     * Renders a web image 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
+     */
+    renderImagePreview(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderImagePreviewModel | null | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
+    protected processRenderImagePreview(response: AxiosResponse): Promise<FileResponse>;
+}
 export interface IDesignAtomsServiceApiClient {
     /**
      * Converts colors
@@ -376,17 +403,20 @@ export interface IDesignAtomsServiceApiClient {
      */
     saveProduct(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: any | null | undefined): Promise<void>;
     /**
-     * Patches product (design model) in design file
-     * @param id Design identifier
-     * @param privateStorage (optional) If set to 'true' design will be taken from private storage
-     * @param privateStorageOwner (optional) Private storage owner identifier
+     * Patches product (design model) in design file.
+     * @param id Design identifier.
+     * @param privateStorage (optional) If set to 'true' design will be taken from private storage.
+     * @param privateStorageOwner (optional) Private storage owner identifier.
      * @param tenantId (optional) Tenant identifier
      * @param patchType (optional)
      * @param replaceImageItemFileInfo_itemName (optional)
      * @param replaceImageItemFileInfo_sourceFile (optional)
+     * @param replacePlaceholderItemContentInfo_placeholderItemName (optional)
+     * @param replacePlaceholderItemContentInfo_newContentType (optional)
+     * @param replacePlaceholderItemContentInfo_sourceFile (optional)
      * @return Success
      */
-    patchProduct(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, patchType?: ProductPatchType | undefined, replaceImageItemFileInfo_itemName?: string | null | undefined, replaceImageItemFileInfo_sourceFile?: FileParameter | null | undefined): Promise<void>;
+    patchProduct(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, patchType?: ProductPatchType | undefined, replaceImageItemFileInfo_itemName?: string | null | undefined, replaceImageItemFileInfo_sourceFile?: FileParameter | null | undefined, replacePlaceholderItemContentInfo_placeholderItemName?: string | null | undefined, replacePlaceholderItemContentInfo_newContentType?: PlaceholderItemContentType | undefined, replacePlaceholderItemContentInfo_sourceFile?: FileParameter | null | undefined): Promise<void>;
     /**
      * Loads data schema from design file taken from storage
      * @param id Design identifier
@@ -561,17 +591,20 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
     saveProduct(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: any | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
     protected processSaveProduct(response: AxiosResponse): Promise<void>;
     /**
-     * Patches product (design model) in design file
-     * @param id Design identifier
-     * @param privateStorage (optional) If set to 'true' design will be taken from private storage
-     * @param privateStorageOwner (optional) Private storage owner identifier
+     * Patches product (design model) in design file.
+     * @param id Design identifier.
+     * @param privateStorage (optional) If set to 'true' design will be taken from private storage.
+     * @param privateStorageOwner (optional) Private storage owner identifier.
      * @param tenantId (optional) Tenant identifier
      * @param patchType (optional)
      * @param replaceImageItemFileInfo_itemName (optional)
      * @param replaceImageItemFileInfo_sourceFile (optional)
+     * @param replacePlaceholderItemContentInfo_placeholderItemName (optional)
+     * @param replacePlaceholderItemContentInfo_newContentType (optional)
+     * @param replacePlaceholderItemContentInfo_sourceFile (optional)
      * @return Success
      */
-    patchProduct(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, patchType?: ProductPatchType | undefined, replaceImageItemFileInfo_itemName?: string | null | undefined, replaceImageItemFileInfo_sourceFile?: FileParameter | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
+    patchProduct(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, patchType?: ProductPatchType | undefined, replaceImageItemFileInfo_itemName?: string | null | undefined, replaceImageItemFileInfo_sourceFile?: FileParameter | null | undefined, replacePlaceholderItemContentInfo_placeholderItemName?: string | null | undefined, replacePlaceholderItemContentInfo_newContentType?: PlaceholderItemContentType | undefined, replacePlaceholderItemContentInfo_sourceFile?: FileParameter | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
     protected processPatchProduct(response: AxiosResponse): Promise<void>;
     /**
      * Loads data schema from design file taken from storage
@@ -1122,6 +1155,23 @@ export interface UpdateImageHandlerRequest {
     itemHandlerData?: string | null;
     itemData?: any | null;
 }
+/** Product preview file format. */
+export declare enum ProductPreviewFormat {
+    Jpeg = "Jpeg",
+    Png = "Png",
+    Tiff = "Tiff",
+    Pdf = "Pdf"
+}
+export interface RenderImagePreviewModel {
+    /** External image URL. */
+    imageUrl?: string | null;
+    /** Height of preview image. */
+    height?: number;
+    /** Width of preview image. */
+    width?: number;
+    /** Output image format. PNG by default. */
+    fileFormat?: ProductPreviewFormat | null;
+}
 /** Convert colors operation parameters */
 export interface ConvertColorsModel {
     /** Serialized color description */
@@ -1170,10 +1220,15 @@ export interface UnprocessableDesignElementDto {
     /** Missing element type. */
     readonly missingElementType?: DesignElementType;
 }
-/** Available patch type */
+/** Available patch type. */
 export declare enum ProductPatchType {
     Undefined = "Undefined",
-    ReplaceImageItemFile = "ReplaceImageItemFile"
+    ReplaceImageItemFile = "ReplaceImageItemFile",
+    ReplacePlaceholderItemContent = "ReplacePlaceholderItemContent"
+}
+/** Placeholder item content type. */
+export declare enum PlaceholderItemContentType {
+    Image = "Image"
 }
 /** Variable information. */
 export interface VariableInfo {
@@ -1208,13 +1263,6 @@ 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;
@@ -1232,7 +1280,7 @@ Used to get mockup file from public storage. */
     ownerId?: string | null;
     /** Rendering configuration for getting a preview of design. */
     renderingConfig?: ProductPreviewRenderingConfig | null;
-    /** Variable (user) data of design. */
+    /** Variable (user) data for design variable fields in the preview image. */
     variableData?: VariableInfo[] | null;
 }
 export declare enum ProductProofFormat {
@@ -1280,9 +1328,9 @@ 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. */
+    /** Rendering configuration for getting a proof image of design. */
     renderingConfig?: ProductProofRenderingConfig | null;
-    /** Variable (user) data of design. */
+    /** Variable (user) data for design variable fields in the proof image. */
     variableData?: VariableInfo[] | null;
 }
 /** Render product parameters */

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

@@ -8,7 +8,7 @@
 //----------------------
 // ReSharper disable InconsistentNaming
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiException = exports.ProductProofInterpolationMode = exports.ProductProofFormat = exports.ProductPreviewFormat = exports.ItemSourceType = exports.ItemType = exports.ProductPatchType = exports.DesignElementType = exports.DesignAtomsViewerApiClient = exports.DesignAtomsServiceApiClient = exports.DesignAtomsCompatibilityApiClient = exports.BuildInfoApiClient = exports.ApiClientBase = exports.ApiClientConfiguration = void 0;
+exports.ApiException = exports.ProductProofInterpolationMode = exports.ProductProofFormat = exports.ItemSourceType = exports.ItemType = exports.PlaceholderItemContentType = exports.ProductPatchType = exports.DesignElementType = exports.ProductPreviewFormat = exports.DesignAtomsViewerApiClient = exports.DesignAtomsServiceApiClient = exports.DesignAtomsImagesApiClient = exports.DesignAtomsCompatibilityApiClient = exports.BuildInfoApiClient = exports.ApiClientBase = exports.ApiClientConfiguration = void 0;
 const axios_1 = require("axios");
 class ApiClientConfiguration {
     apiUrl;
@@ -1748,6 +1748,96 @@ class DesignAtomsCompatibilityApiClient extends ApiClientBase {
     }
 }
 exports.DesignAtomsCompatibilityApiClient = DesignAtomsCompatibilityApiClient;
+class DesignAtomsImagesApiClient extends ApiClientBase {
+    instance;
+    baseUrl;
+    jsonParseReviver = undefined;
+    constructor(configuration, baseUrl, instance) {
+        super(configuration);
+        this.instance = instance ? instance : axios_1.default.create();
+        this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : this.getBaseUrl("");
+    }
+    /**
+     * Renders a web image 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
+     */
+    renderImagePreview(attachment, tenantId, body, cancelToken) {
+        let url_ = this.baseUrl + "/api/atoms/v1/images/render-image-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.processRenderImagePreview(_response));
+        });
+    }
+    processRenderImagePreview(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);
+    }
+}
+exports.DesignAtomsImagesApiClient = DesignAtomsImagesApiClient;
 class DesignAtomsServiceApiClient extends ApiClientBase {
     instance;
     baseUrl;
@@ -2192,17 +2282,20 @@ class DesignAtomsServiceApiClient extends ApiClientBase {
         return Promise.resolve(null);
     }
     /**
-     * Patches product (design model) in design file
-     * @param id Design identifier
-     * @param privateStorage (optional) If set to 'true' design will be taken from private storage
-     * @param privateStorageOwner (optional) Private storage owner identifier
+     * Patches product (design model) in design file.
+     * @param id Design identifier.
+     * @param privateStorage (optional) If set to 'true' design will be taken from private storage.
+     * @param privateStorageOwner (optional) Private storage owner identifier.
      * @param tenantId (optional) Tenant identifier
      * @param patchType (optional)
      * @param replaceImageItemFileInfo_itemName (optional)
      * @param replaceImageItemFileInfo_sourceFile (optional)
+     * @param replacePlaceholderItemContentInfo_placeholderItemName (optional)
+     * @param replacePlaceholderItemContentInfo_newContentType (optional)
+     * @param replacePlaceholderItemContentInfo_sourceFile (optional)
      * @return Success
      */
-    patchProduct(id, privateStorage, privateStorageOwner, tenantId, patchType, replaceImageItemFileInfo_itemName, replaceImageItemFileInfo_sourceFile, cancelToken) {
+    patchProduct(id, privateStorage, privateStorageOwner, tenantId, patchType, replaceImageItemFileInfo_itemName, replaceImageItemFileInfo_sourceFile, replacePlaceholderItemContentInfo_placeholderItemName, replacePlaceholderItemContentInfo_newContentType, replacePlaceholderItemContentInfo_sourceFile, cancelToken) {
         let url_ = this.baseUrl + "/api/atoms/v1/designs/{id}/model?";
         if (id === undefined || id === null)
             throw new Error("The parameter 'id' must be defined.");
@@ -2225,6 +2318,14 @@ class DesignAtomsServiceApiClient extends ApiClientBase {
             content_.append("replaceImageItemFileInfo.itemName", replaceImageItemFileInfo_itemName.toString());
         if (replaceImageItemFileInfo_sourceFile !== null && replaceImageItemFileInfo_sourceFile !== undefined)
             content_.append("replaceImageItemFileInfo.sourceFile", replaceImageItemFileInfo_sourceFile.data, replaceImageItemFileInfo_sourceFile.fileName ? replaceImageItemFileInfo_sourceFile.fileName : "replaceImageItemFileInfo.sourceFile");
+        if (replacePlaceholderItemContentInfo_placeholderItemName !== null && replacePlaceholderItemContentInfo_placeholderItemName !== undefined)
+            content_.append("replacePlaceholderItemContentInfo.placeholderItemName", replacePlaceholderItemContentInfo_placeholderItemName.toString());
+        if (replacePlaceholderItemContentInfo_newContentType === null || replacePlaceholderItemContentInfo_newContentType === undefined)
+            throw new Error("The parameter 'replacePlaceholderItemContentInfo_newContentType' cannot be null.");
+        else
+            content_.append("replacePlaceholderItemContentInfo.newContentType", replacePlaceholderItemContentInfo_newContentType.toString());
+        if (replacePlaceholderItemContentInfo_sourceFile !== null && replacePlaceholderItemContentInfo_sourceFile !== undefined)
+            content_.append("replacePlaceholderItemContentInfo.sourceFile", replacePlaceholderItemContentInfo_sourceFile.data, replacePlaceholderItemContentInfo_sourceFile.fileName ? replacePlaceholderItemContentInfo_sourceFile.fileName : "replacePlaceholderItemContentInfo.sourceFile");
         let options_ = {
             data: content_,
             method: "PATCH",
@@ -5017,6 +5118,14 @@ class DesignAtomsViewerApiClient extends ApiClientBase {
     }
 }
 exports.DesignAtomsViewerApiClient = DesignAtomsViewerApiClient;
+/** Product preview file format. */
+var ProductPreviewFormat;
+(function (ProductPreviewFormat) {
+    ProductPreviewFormat["Jpeg"] = "Jpeg";
+    ProductPreviewFormat["Png"] = "Png";
+    ProductPreviewFormat["Tiff"] = "Tiff";
+    ProductPreviewFormat["Pdf"] = "Pdf";
+})(ProductPreviewFormat = exports.ProductPreviewFormat || (exports.ProductPreviewFormat = {}));
 var DesignElementType;
 (function (DesignElementType) {
     DesignElementType["Product"] = "Product";
@@ -5026,12 +5135,18 @@ var DesignElementType;
     DesignElementType["PrintArea"] = "PrintArea";
     DesignElementType["Item"] = "Item";
 })(DesignElementType = exports.DesignElementType || (exports.DesignElementType = {}));
-/** Available patch type */
+/** Available patch type. */
 var ProductPatchType;
 (function (ProductPatchType) {
     ProductPatchType["Undefined"] = "Undefined";
     ProductPatchType["ReplaceImageItemFile"] = "ReplaceImageItemFile";
+    ProductPatchType["ReplacePlaceholderItemContent"] = "ReplacePlaceholderItemContent";
 })(ProductPatchType = exports.ProductPatchType || (exports.ProductPatchType = {}));
+/** Placeholder item content type. */
+var PlaceholderItemContentType;
+(function (PlaceholderItemContentType) {
+    PlaceholderItemContentType["Image"] = "Image";
+})(PlaceholderItemContentType = exports.PlaceholderItemContentType || (exports.PlaceholderItemContentType = {}));
 var ItemType;
 (function (ItemType) {
     ItemType["Image"] = "Image";
@@ -5046,14 +5161,6 @@ var ItemSourceType;
     ItemSourceType["ImageStorage"] = "ImageStorage";
     ItemSourceType["PrivateImageStorage"] = "PrivateImageStorage";
 })(ItemSourceType = exports.ItemSourceType || (exports.ItemSourceType = {}));
-/** Product preview file format. */
-var ProductPreviewFormat;
-(function (ProductPreviewFormat) {
-    ProductPreviewFormat["Jpeg"] = "Jpeg";
-    ProductPreviewFormat["Png"] = "Png";
-    ProductPreviewFormat["Tiff"] = "Tiff";
-    ProductPreviewFormat["Pdf"] = "Pdf";
-})(ProductPreviewFormat = exports.ProductPreviewFormat || (exports.ProductPreviewFormat = {}));
 var ProductProofFormat;
 (function (ProductProofFormat) {
     ProductProofFormat["Jpeg"] = "Jpeg";