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

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

@@ -1091,6 +1091,16 @@ export interface IDesignAtomsPrintProductApiClient {
      * @return Success
      */
     addDesignSurfaceModel(id: string, index?: number | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: any | undefined): Promise<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): Promise<DesignInfo>;
 }
 export declare class DesignAtomsPrintProductApiClient extends ApiClientBase implements IDesignAtomsPrintProductApiClient {
     private instance;
@@ -1476,6 +1486,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, cancelToken?: CancelToken | undefined): Promise<any>;
     protected processAddDesignSurfaceModel(response: AxiosResponse): Promise<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, cancelToken?: CancelToken | undefined): Promise<DesignInfo>;
+    protected processCreateDesignProduct(response: AxiosResponse): Promise<DesignInfo>;
 }
 export interface IDesignAtomsPrintProductItemsApiClient {
     /**
@@ -1765,7 +1786,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): Promise<void>;
+    setVariables(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: SetVariablesModel | undefined): Promise<void>;
     /**
      * Loads variable data printing information from design file taken from storage.
      * @param id Design identifier.
@@ -2019,7 +2040,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, cancelToken?: CancelToken | undefined): Promise<void>;
+    setVariables(id: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: SetVariablesModel | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
     protected processSetVariables(response: AxiosResponse): Promise<void>;
     /**
      * Loads variable data printing information from design file taken from storage.
@@ -2888,6 +2909,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. */
@@ -2903,6 +2942,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;
@@ -2984,6 +3030,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. */
@@ -3020,6 +3085,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. */
@@ -3366,20 +3453,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",
@@ -3438,17 +3511,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. */
@@ -3458,17 +3532,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.
@@ -3477,9 +3552,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. */
@@ -3492,9 +3567,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 {
@@ -3602,6 +3677,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. */
@@ -3651,6 +3731,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. */
@@ -3659,6 +3745,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/dist/cjs/design-atoms-api-client.js

@@ -8,7 +8,7 @@
 //----------------------
 // ReSharper disable InconsistentNaming
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiException = exports.TextVerticalAlignment = exports.TextAlignment = exports.ProductProofInterpolationMode = exports.ProductProofFormat = exports.ProductPreviewFormat = exports.ProductPatchType = exports.PlaceholderItemContentType = exports.MockupPreviewFormat = exports.MockupPreviewFitMode = exports.ItemType = exports.ItemSourceType = exports.ItemBorderStyle = exports.ImagePreviewFormat = exports.ImagePreviewFitMode = exports.ImageExtractionFormat = exports.DesignElementType = exports.ContainerPrintingMode = exports.ContainerColorSpace = exports.ConflictType = exports.ColorlessContainerFormat = exports.ColorlessContainerDitherType = exports.ColorlessContainerDisplayType = exports.ArtworkShapeType = exports.DesignAtomsViewerApiClient = exports.DesignAtomsServiceApiClient = exports.DesignAtomsPrintProductItemsApiClient = exports.DesignAtomsPrintProductApiClient = exports.DesignAtomsPalettesApiClient = exports.DesignAtomsMockups3dApiClient = exports.DesignAtomsMockups2dApiClient = exports.DesignAtomsImagesApiClient = exports.DesignAtomsCompatibilityApiClient = exports.BuildInfoApiClient = exports.ApiClientBase = exports.ApiClientConfiguration = void 0;
+exports.ApiException = exports.TextVerticalAlignment = exports.TextAlignment = exports.ProductProofInterpolationMode = exports.ProductProofFormat = exports.ProductPreviewFormat = exports.ProductPatchType = exports.PlaceholderItemContentType = exports.MockupPreviewFormat = exports.MockupPreviewFitMode = exports.ItemType = exports.ItemSourceType = exports.ItemBorderStyle = exports.ImagePreviewFormat = exports.ImagePreviewFitMode = exports.ImageExtractionFormat = exports.DesignPreviewMockupStrategy = exports.DesignElementType = exports.ContainerPrintingMode = exports.ContainerColorSpace = exports.ConflictType = exports.ColorlessContainerFormat = exports.ColorlessContainerDitherType = exports.ColorlessContainerDisplayType = exports.ArtworkShapeType = exports.DesignAtomsViewerApiClient = exports.DesignAtomsServiceApiClient = exports.DesignAtomsPrintProductItemsApiClient = exports.DesignAtomsPrintProductApiClient = exports.DesignAtomsPalettesApiClient = exports.DesignAtomsMockups3dApiClient = exports.DesignAtomsMockups2dApiClient = exports.DesignAtomsImagesApiClient = exports.DesignAtomsCompatibilityApiClient = exports.BuildInfoApiClient = exports.ApiClientBase = exports.ApiClientConfiguration = void 0;
 const axios_1 = require("axios");
 class ApiClientConfiguration {
     apiUrl;
@@ -6300,6 +6300,90 @@ class DesignAtomsPrintProductApiClient extends ApiClientBase {
         }
         return Promise.resolve(null);
     }
+    /**
+     * 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, path, privateStorageOwner, tenantId, body, cancelToken) {
+        let url_ = this.baseUrl + "/api/atoms/v1/designs/print-product?";
+        if (name !== undefined && name !== null)
+            url_ += "name=" + encodeURIComponent("" + name) + "&";
+        if (path !== undefined && path !== null)
+            url_ += "path=" + encodeURIComponent("" + path) + "&";
+        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(/[?&]$/, "");
+        const content_ = JSON.stringify(body);
+        let options_ = {
+            data: content_,
+            method: "POST",
+            url: url_,
+            headers: {
+                "Content-Type": "application/json",
+                "Accept": "application/json"
+            },
+            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.processCreateDesignProduct(_response));
+        });
+    }
+    processCreateDesignProduct(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;
+            let result201 = null;
+            let resultData201 = _responseText;
+            result201 = JSON.parse(resultData201);
+            return Promise.resolve(result201);
+        }
+        else if (status === 409) {
+            const _responseText = response.data;
+            let result409 = null;
+            let resultData409 = _responseText;
+            result409 = JSON.parse(resultData409);
+            return throwException("Conflict", status, _responseText, _headers, result409);
+        }
+        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);
+    }
 }
 exports.DesignAtomsPrintProductApiClient = DesignAtomsPrintProductApiClient;
 class DesignAtomsPrintProductItemsApiClient extends ApiClientBase {
@@ -11396,6 +11480,12 @@ var DesignElementType;
     DesignElementType["PrintArea"] = "PrintArea";
     DesignElementType["Item"] = "Item";
 })(DesignElementType = exports.DesignElementType || (exports.DesignElementType = {}));
+var DesignPreviewMockupStrategy;
+(function (DesignPreviewMockupStrategy) {
+    DesignPreviewMockupStrategy["UseProvidedMockup"] = "UseProvidedMockup";
+    DesignPreviewMockupStrategy["UseEmbeddedMockup"] = "UseEmbeddedMockup";
+    DesignPreviewMockupStrategy["UseNoMockup"] = "UseNoMockup";
+})(DesignPreviewMockupStrategy = exports.DesignPreviewMockupStrategy || (exports.DesignPreviewMockupStrategy = {}));
 /** Image preview file format. */
 var ImageExtractionFormat;
 (function (ImageExtractionFormat) {