@aurigma/ng-design-atoms-api-client 2.80.14 → 2.83.1

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

@@ -1094,6 +1094,16 @@ export interface IDesignAtomsPrintProductApiClient {
      * @return Success
      */
     addDesignSurfaceModel(id: string, index?: number | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: any | undefined): Observable<any>;
+    /**
+     * Creates a new print product and saves it as a design file.
+     * @param name (optional) Design file name.
+     * @param path (optional) Design file path.
+     * @param privateStorageOwner (optional) Private storage owner identifier.
+     * @param tenantId (optional) Tenant ID.
+     * @param body (optional) Patch product parameters model.
+     * @return Created
+     */
+    createDesignProduct(name?: string | null | undefined, path?: string | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: CreateProductModel | undefined): Observable<DesignInfo>;
 }
 export declare class DesignAtomsPrintProductApiClient extends ApiClientBase implements IDesignAtomsPrintProductApiClient {
     private http;
@@ -1479,6 +1489,17 @@ export declare class DesignAtomsPrintProductApiClient extends ApiClientBase impl
      */
     addDesignSurfaceModel(id: string, index?: number | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: any | undefined): Observable<any>;
     protected processAddDesignSurfaceModel(response: HttpResponseBase): Observable<any>;
+    /**
+     * Creates a new print product and saves it as a design file.
+     * @param name (optional) Design file name.
+     * @param path (optional) Design file path.
+     * @param privateStorageOwner (optional) Private storage owner identifier.
+     * @param tenantId (optional) Tenant ID.
+     * @param body (optional) Patch product parameters model.
+     * @return Created
+     */
+    createDesignProduct(name?: string | null | undefined, path?: string | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: CreateProductModel | undefined): Observable<DesignInfo>;
+    protected processCreateDesignProduct(response: HttpResponseBase): Observable<DesignInfo>;
 }
 export interface IDesignAtomsPrintProductItemsApiClient {
     /**
@@ -1768,7 +1789,7 @@ export interface IDesignAtomsServiceApiClient {
      * @param body (optional) Design variable values.
      * @return Success
      */
-    setVariables(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: VariablesModel | undefined): Observable<void>;
+    setVariables(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: SetVariablesModel | undefined): Observable<void>;
     /**
      * Loads variable data printing information from design file taken from storage.
      * @param id Design identifier.
@@ -2022,7 +2043,7 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
      * @param body (optional) Design variable values.
      * @return Success
      */
-    setVariables(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: VariablesModel | undefined): Observable<void>;
+    setVariables(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: SetVariablesModel | undefined): Observable<void>;
     protected processSetVariables(response: HttpResponseBase): Observable<void>;
     /**
      * Loads variable data printing information from design file taken from storage.
@@ -2891,6 +2912,24 @@ For example, `Authorization` header can be placed here to provide access to imag
     /** Indicates if resulting item should store original source file. */
     preserveOriginalFile?: boolean | null;
 }
+/** Design print area creation parameters. */
+export interface CreatePrintAreaModel {
+    /** Print area name. */
+    name?: string | null;
+    /** Print area size. */
+    size?: SizeModel | null;
+    /** Print area position. */
+    position?: PositionModel | null;
+    /** Print area bleed. */
+    bleed?: MarginModel | null;
+    /** Print area slug. */
+    slug?: MarginModel | null;
+}
+/** Create print product operation parameters. */
+export interface CreateProductModel {
+    /** Design surfaces parameters. */
+    surfaces?: CreateSurfaceModel[] | null;
+}
 /** Rectangle item creation parameters. */
 export interface CreateRectangleItemModel {
     /** Rectangle width. */
@@ -2906,6 +2945,13 @@ export interface CreateRectangleItemModel {
     /** Rectangle border style. */
     borderStyle?: ItemBorderStyle;
 }
+/** Design surface creation parameters. */
+export interface CreateSurfaceModel {
+    /** Surface name. */
+    name?: string | null;
+    /** Print areas parameters. */
+    printAreas?: CreatePrintAreaModel[] | null;
+}
 export interface DesignElementProcessingConflictDto {
     /** Missing element type. */
     readonly missingElementType?: DesignElementType | null;
@@ -2987,6 +3033,25 @@ export interface DesignParameters {
     /** Version of DesignAtoms library that used to save design file. */
     designAtomsVersion?: string | null;
 }
+export declare enum DesignPreviewMockupStrategy {
+    UseProvidedMockup = "UseProvidedMockup",
+    UseEmbeddedMockup = "UseEmbeddedMockup",
+    UseNoMockup = "UseNoMockup"
+}
+export interface DesignPreviewRenderingConfig {
+    /** Surface index. */
+    surfaceIndex?: number | null;
+    /** Indicates whether to show stub content for preview image. */
+    stub?: boolean | null;
+    /** Indicates whether print areas borders should be visualized. */
+    visualizePrintAreas?: boolean | null;
+    /** Preview image width. */
+    width?: number;
+    /** Preview image height. */
+    height?: number;
+    /** Preview image file format. */
+    fileFormat?: ProductPreviewFormat | null;
+}
 /** Design print area parameters. */
 export interface DesignPrintAreaDto {
     /** Print area identifier. */
@@ -3023,6 +3088,28 @@ export interface DesignPrintAreaParams {
     /** Print area shape. Usually content of svg path that describes print area shape is provided. */
     shape?: string | null;
 }
+export interface DesignProofRenderingConfig {
+    /** Surface to render. */
+    surfaceIndex?: number | null;
+    /** Desired proof image width. */
+    width?: number;
+    /** Desired proof image height. */
+    height?: number;
+    /** Desired proof image format. */
+    format?: ProductProofFormat | null;
+    /** Desired proof image interpolation. */
+    interpolationMode?: ProductProofInterpolationMode | null;
+    /** Defines whether safety lines should be visualized. */
+    safetyLinesEnabled?: boolean | null;
+    /** Defines whether print areas borders should be visualized. */
+    visualizePrintAreas?: boolean | null;
+    /** Defines whether watermark should be included. */
+    watermarkEnabled?: boolean | null;
+    /** Defines watermark opacity (in range 0 .. 1.0). */
+    watermarkOpacity?: number | null;
+    /** Defines whether watermark should be repeated. */
+    watermarkRepeat?: boolean | null;
+}
 /** Print-product container description. */
 export interface DesignSurfaceContainerDto {
     /** Container identifier. */
@@ -3369,20 +3456,6 @@ export declare enum ProductPreviewFormat {
     Jpeg = "Jpeg",
     Png = "Png"
 }
-export interface ProductPreviewRenderingConfig {
-    /** Surface index. */
-    surfaceIndex?: number | null;
-    /** Indicates whether to show stub content for preview image. */
-    stub?: boolean | null;
-    /** Indicates whether print areas borders should be visualized. */
-    visualizePrintAreas?: boolean | null;
-    /** Preview image width. */
-    width?: number;
-    /** Preview image height. */
-    height?: number;
-    /** Preview image file format. */
-    fileFormat?: ProductPreviewFormat | null;
-}
 export declare enum ProductProofFormat {
     Jpeg = "Jpeg",
     Png = "Png",
@@ -3441,17 +3514,18 @@ export interface RenderDesignPreviewModel {
     /** Design identifier.
 Used to get design file from public or private storage. */
     designId?: string | null;
+    /** Identifier of the design owner. */
+    ownerId?: string | null;
+    mockupStrategy?: DesignPreviewMockupStrategy;
     /** Mockup identifier.
 Used to get mockup file from public storage. */
     mockupId?: string | null;
-    /** Identifier of the design owner. */
-    ownerId?: string | null;
     /** Identifier of the mockup owner. */
     mockupOwnerId?: string | null;
     /** Rendering configuration for getting a preview of design. */
-    renderingConfig?: ProductPreviewRenderingConfig | null;
+    renderingConfig?: DesignPreviewRenderingConfig | null;
     /** Variable (user) data for design variable fields in the preview image. */
-    variableData?: VariableInfo[] | null;
+    variableData?: VariableData[] | null;
 }
 export interface RenderDesignPreviewToResourceModel {
     /** Parameters of resource that should be created for a preview rendering result. */
@@ -3461,17 +3535,18 @@ export interface RenderDesignPreviewToResourceModel {
     /** Design identifier.
 Used to get design file from public or private storage. */
     designId?: string | null;
+    /** Identifier of the design owner. */
+    ownerId?: string | null;
+    mockupStrategy?: DesignPreviewMockupStrategy;
     /** Mockup identifier.
 Used to get mockup file from public storage. */
     mockupId?: string | null;
-    /** Identifier of the design owner. */
-    ownerId?: string | null;
     /** Identifier of the mockup owner. */
     mockupOwnerId?: string | null;
     /** Rendering configuration for getting a preview of design. */
-    renderingConfig?: ProductPreviewRenderingConfig | null;
+    renderingConfig?: DesignPreviewRenderingConfig | null;
     /** Variable (user) data for design variable fields in the preview image. */
-    variableData?: VariableInfo[] | null;
+    variableData?: VariableData[] | null;
 }
 export interface RenderDesignProofModel {
     /** Design identifier.
@@ -3480,9 +3555,9 @@ Used to get design file from public or private storage. */
     /** Identifier of the design owner. */
     ownerId?: string | null;
     /** Rendering configuration for getting a proof image of design. */
-    renderingConfig?: ProductProofRenderingConfig | null;
+    renderingConfig?: DesignProofRenderingConfig | null;
     /** Variable (user) data for design variable fields in the proof image. */
-    variableData?: VariableInfo[] | null;
+    variableData?: VariableData[] | null;
 }
 export interface RenderDesignProofToResourceModel {
     /** Parameters of resource that should be created for a preview rendering result. */
@@ -3495,9 +3570,9 @@ Used to get design file from public or private storage. */
     /** Identifier of the design owner. */
     ownerId?: string | null;
     /** Rendering configuration for getting a proof image of design. */
-    renderingConfig?: ProductProofRenderingConfig | null;
+    renderingConfig?: DesignProofRenderingConfig | null;
     /** Variable (user) data for design variable fields in the proof image. */
-    variableData?: VariableInfo[] | null;
+    variableData?: VariableData[] | null;
 }
 /** Web image preview rendering parameters. */
 export interface RenderImagePreviewFromUrlModel {
@@ -3605,6 +3680,11 @@ export interface SetEditorMockupsModel {
     /** List of editor mockup binding instructions. */
     editorMockupBindings?: EditorMockupBindingModel[] | null;
 }
+/** Variables information. */
+export interface SetVariablesModel {
+    /** List of variables. */
+    items?: VariableData[] | null;
+}
 /** Size of the print-product element. */
 export interface SizeDto {
     /** Print-product element width. */
@@ -3654,6 +3734,12 @@ export interface UpdateImageHandlerRequest {
     itemData?: any | null;
     colorSettings?: PreviewColorSettings | null;
 }
+export interface VariableData {
+    /** Variable name. */
+    name?: string | null;
+    /** Variable value. */
+    value?: string | null;
+}
 /** Variable information. */
 export interface VariableInfo {
     /** Variable name. */
@@ -3662,6 +3748,10 @@ export interface VariableInfo {
     value?: string | null;
     /** Variable type. */
     type?: string | null;
+    /** Variable constraints. */
+    constraints?: {
+        [key: string]: string;
+    } | null;
 }
 /** Variables information. */
 export interface VariablesModel {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aurigma/ng-design-atoms-api-client",
-  "version": "2.80.14",
+  "version": "2.83.1",
   "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)",