@aurigma/ng-design-atoms-api-client 2.30.1 → 2.31.5

package/lib/design-atoms-api-client.d.ts

@@ -333,6 +333,33 @@ export declare class DesignAtomsCompatibilityApiClient extends ApiClientBase imp
     updateShapeItemHandler(tenantId: number, body?: UpdateHandlerRequest | null | undefined): Observable<any>;
     protected processUpdateShapeItemHandler(response: HttpResponseBase): Observable<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): Observable<FileResponse>;
+}
+export declare class DesignAtomsImagesApiClient extends ApiClientBase implements IDesignAtomsImagesApiClient {
+    private http;
+    private baseUrl;
+    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
+    constructor(configuration: ApiClientConfiguration, http: HttpClient, baseUrl?: string);
+    /**
+     * 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): Observable<FileResponse>;
+    protected processRenderImagePreview(response: HttpResponseBase): Observable<FileResponse>;
+}
 export interface IDesignAtomsServiceApiClient {
     /**
      * Converts colors
@@ -379,17 +406,20 @@ export interface IDesignAtomsServiceApiClient {
      */
     saveProduct(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: any | null | undefined): Observable<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): Observable<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): Observable<void>;
     /**
      * Loads data schema from design file taken from storage
      * @param id Design identifier
@@ -564,17 +594,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): Observable<void>;
     protected processSaveProduct(response: HttpResponseBase): Observable<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): Observable<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): Observable<void>;
     protected processPatchProduct(response: HttpResponseBase): Observable<void>;
     /**
      * Loads data schema from design file taken from storage
@@ -1125,6 +1158,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 */
@@ -1173,10 +1223,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 {
@@ -1211,13 +1266,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;
@@ -1235,7 +1283,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 {
@@ -1283,9 +1331,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aurigma/ng-design-atoms-api-client",
-  "version": "2.30.1",
+  "version": "2.31.5",
   "license": "SEE LICENSE IN License.md",
   "description": "Angular API Client for Design Atoms API service of Customer's Canvas web-to-print system.",
   "author": "Aurigma Inc <info@aurigma.com> (https://customerscanvas.com)",