@aurigma/axios-design-atoms-api-client 2.74.1 → 2.77.4

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

@@ -617,6 +617,33 @@ export declare class DesignAtomsImagesApiClient extends ApiClientBase implements
     renderImagePreviewToResource(tenantId?: number | undefined, body?: RenderImagePreviewToResourceModel | undefined, cancelToken?: CancelToken | undefined): Promise<ResourceInfoDto>;
     protected processRenderImagePreviewToResource(response: AxiosResponse): Promise<ResourceInfoDto>;
 }
+export interface IDesignAtomsMockups2dApiClient {
+    /**
+     * Renders a mockup 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 ID.
+     * @param body (optional) Render model with preview parameters.
+     * @return Success
+     */
+    renderMockupPreview(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderMockupPreviewModel | undefined): Promise<FileResponse>;
+}
+export declare class DesignAtomsMockups2dApiClient extends ApiClientBase implements IDesignAtomsMockups2dApiClient {
+    private instance;
+    private baseUrl;
+    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
+    constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
+    /**
+     * Renders a mockup 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 ID.
+     * @param body (optional) Render model with preview parameters.
+     * @return Success
+     */
+    renderMockupPreview(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderMockupPreviewModel | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
+    protected processRenderMockupPreview(response: AxiosResponse): Promise<FileResponse>;
+}
 export interface IDesignAtomsMockups3dApiClient {
     /**
      * Returns a 3D-Mockup attributes.
@@ -742,6 +769,36 @@ export interface IDesignAtomsPrintProductApiClient {
      * @return Success
      */
     getDesignSurfaceContainers(id: string, surfaceId?: string | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<DesignSurfaceContainerDto[]>;
+    /**
+     * Returns a list of print-product container descriptions of the specified design file.
+     * @param id Design identifier.
+     * @param index (optional)
+     * @param surfaceId (optional) Print-product surface identifier.
+     * @param privateStorageOwner (optional) Private storage owner identifier.
+     * @param tenantId (optional) Tenant ID.
+     * @param body (optional)
+     * @return Success
+     */
+    addDesignSurfaceContainer(id: string, index?: number | null | undefined, surfaceId?: string | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: DesignSurfaceContainerParams | undefined): Promise<DesignSurfaceContainerDto>;
+    /**
+     * Returns a print-product container parameters of the specified design file.
+     * @param id Design identifier.
+     * @param containerId Print-product container identifier.
+     * @param privateStorageOwner (optional) Private storage owner identifier.
+     * @param tenantId (optional) Tenant ID.
+     * @return Success
+     */
+    getDesignSurfaceContainer(id: string, containerId: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<DesignSurfaceContainerDto>;
+    /**
+     * Returns a list of print-product container descriptions of the specified design file.
+     * @param id Design identifier.
+     * @param surfaceId (optional) Print-product surface identifier.
+     * @param privateStorageOwner (optional) Private storage owner identifier.
+     * @param tenantId (optional) Tenant ID.
+     * @param body (optional)
+     * @return Success
+     */
+    updateDesignSurfaceContainer(id: string, containerId: string, surfaceId?: string | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: DesignSurfaceContainerParams | undefined): Promise<DesignSurfaceContainerDto>;
     /**
      * Deletes a specified print-product container in an existing design file.
      * @param id Design identifier.
@@ -882,7 +939,7 @@ export interface IDesignAtomsPrintProductApiClient {
      * @param body (optional) Print-area description model.
      * @return Success
      */
-    updateDesignPrintArea(id: string, printAreaId: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: DesignPrintAreaParams | undefined): Promise<any>;
+    updateDesignPrintArea(id: string, printAreaId: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: DesignPrintAreaParams | undefined): Promise<DesignPrintAreaDto>;
     /**
      * Deletes a specified print-area in an existing design file.
      * @param id Design identifier.
@@ -1061,6 +1118,39 @@ export declare class DesignAtomsPrintProductApiClient extends ApiClientBase impl
      */
     getDesignSurfaceContainers(id: string, surfaceId?: string | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<DesignSurfaceContainerDto[]>;
     protected processGetDesignSurfaceContainers(response: AxiosResponse): Promise<DesignSurfaceContainerDto[]>;
+    /**
+     * Returns a list of print-product container descriptions of the specified design file.
+     * @param id Design identifier.
+     * @param index (optional)
+     * @param surfaceId (optional) Print-product surface identifier.
+     * @param privateStorageOwner (optional) Private storage owner identifier.
+     * @param tenantId (optional) Tenant ID.
+     * @param body (optional)
+     * @return Success
+     */
+    addDesignSurfaceContainer(id: string, index?: number | null | undefined, surfaceId?: string | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: DesignSurfaceContainerParams | undefined, cancelToken?: CancelToken | undefined): Promise<DesignSurfaceContainerDto>;
+    protected processAddDesignSurfaceContainer(response: AxiosResponse): Promise<DesignSurfaceContainerDto>;
+    /**
+     * Returns a print-product container parameters of the specified design file.
+     * @param id Design identifier.
+     * @param containerId Print-product container identifier.
+     * @param privateStorageOwner (optional) Private storage owner identifier.
+     * @param tenantId (optional) Tenant ID.
+     * @return Success
+     */
+    getDesignSurfaceContainer(id: string, containerId: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<DesignSurfaceContainerDto>;
+    protected processGetDesignSurfaceContainer(response: AxiosResponse): Promise<DesignSurfaceContainerDto>;
+    /**
+     * Returns a list of print-product container descriptions of the specified design file.
+     * @param id Design identifier.
+     * @param surfaceId (optional) Print-product surface identifier.
+     * @param privateStorageOwner (optional) Private storage owner identifier.
+     * @param tenantId (optional) Tenant ID.
+     * @param body (optional)
+     * @return Success
+     */
+    updateDesignSurfaceContainer(id: string, containerId: string, surfaceId?: string | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: DesignSurfaceContainerParams | undefined, cancelToken?: CancelToken | undefined): Promise<DesignSurfaceContainerDto>;
+    protected processUpdateDesignSurfaceContainer(response: AxiosResponse): Promise<DesignSurfaceContainerDto>;
     /**
      * Deletes a specified print-product container in an existing design file.
      * @param id Design identifier.
@@ -1214,8 +1304,8 @@ export declare class DesignAtomsPrintProductApiClient extends ApiClientBase impl
      * @param body (optional) Print-area description model.
      * @return Success
      */
-    updateDesignPrintArea(id: string, printAreaId: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: DesignPrintAreaParams | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
-    protected processUpdateDesignPrintArea(response: AxiosResponse): Promise<any>;
+    updateDesignPrintArea(id: string, printAreaId: string, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: DesignPrintAreaParams | undefined, cancelToken?: CancelToken | undefined): Promise<DesignPrintAreaDto>;
+    protected processUpdateDesignPrintArea(response: AxiosResponse): Promise<DesignPrintAreaDto>;
     /**
      * Deletes a specified print-area in an existing design file.
      * @param id Design identifier.
@@ -1797,11 +1887,11 @@ export interface IDesignAtomsServiceApiClient {
      * @param resourceId (optional) Resource identifier.
      * @param privateDesignId (optional) Private design identifier.
      * @param privateStorageOwner (optional) Private storage owner identifier.
-     * @param tenantIdQuery (optional) Tenant identifier.
+     * @param tenantId (optional) Tenant ID.
      * @return Created
      * @deprecated
      */
-    createPrivateDesignFromResource(resourceId?: string | null | undefined, privateDesignId?: string | null | undefined, privateStorageOwner?: string | null | undefined, tenantIdQuery?: number | undefined): Promise<void>;
+    createPrivateDesignFromResource(resourceId?: string | null | undefined, privateDesignId?: string | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<void>;
 }
 export declare class DesignAtomsServiceApiClient extends ApiClientBase implements IDesignAtomsServiceApiClient {
     private instance;
@@ -2069,11 +2159,11 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
      * @param resourceId (optional) Resource identifier.
      * @param privateDesignId (optional) Private design identifier.
      * @param privateStorageOwner (optional) Private storage owner identifier.
-     * @param tenantIdQuery (optional) Tenant identifier.
+     * @param tenantId (optional) Tenant ID.
      * @return Created
      * @deprecated
      */
-    createPrivateDesignFromResource(resourceId?: string | null | undefined, privateDesignId?: string | null | undefined, privateStorageOwner?: string | null | undefined, tenantIdQuery?: number | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
+    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>;
 }
 export interface IDesignAtomsViewerApiClient {
@@ -2557,6 +2647,10 @@ export interface ApplyDesignItemsDataModel {
         [key: string]: DesignItemDataModel;
     } | null;
 }
+export declare enum ArtworkShapeType {
+    Rectangle = "rectangle",
+    Ellipse = "ellipse"
+}
 /** Batch create items from storage source operation parameters. */
 export interface BatchCreateItemsFromStorageModel {
     /** Source image assets owner identifier. If value is set, all images should belong to a specified user. */
@@ -2597,6 +2691,54 @@ export interface BuildInfoModel {
     /** Aurigma.DesignAtoms.Model version. */
     designAtomsModelVersion?: string | null;
 }
+/** Colorless container display type. */
+export declare enum ColorlessContainerDisplayType {
+    Color = "Color",
+    Texture = "Texture"
+}
+/** Colorless container dither type. */
+export declare enum ColorlessContainerDitherType {
+    None = "None",
+    Diffusion = "Diffusion",
+    Pattern = "Pattern",
+    Noise = "Noise"
+}
+/** Colorless container format. */
+export declare enum ColorlessContainerFormat {
+    OneBit = "OneBit",
+    Grayscale = "Grayscale",
+    Vector = "Vector"
+}
+/** Colorless container settigns. */
+export interface ColorlessContainerSettingsDto {
+    /** Container format. */
+    format?: ColorlessContainerFormat;
+    /** Container dither type. */
+    dither?: ColorlessContainerDitherType;
+    /** Container display type. */
+    displayType?: ColorlessContainerDisplayType;
+    /** Container dither amount. */
+    ditherAmount?: number;
+    /** Display color. */
+    displayColor?: string | null;
+    /** Output color. */
+    outputColor?: string | null;
+}
+/** Colorless container settigns. */
+export interface ColorlessContainerSettingsParams {
+    /** Container format. */
+    format?: ColorlessContainerFormat;
+    /** Container dither type. */
+    dither?: ColorlessContainerDitherType;
+    /** Container display type. */
+    displayType?: ColorlessContainerDisplayType;
+    /** Container dither amount. */
+    ditherAmount?: number;
+    /** Display color. */
+    displayColor?: string | null;
+    /** Output color. */
+    outputColor?: string | null;
+}
 /** Conflict types. */
 export declare enum ConflictType {
     NameConflict = "NameConflict",
@@ -2604,6 +2746,42 @@ export declare enum ConflictType {
     IdConflict = "IdConflict",
     GeneralConflict = "GeneralConflict"
 }
+/** Full color container color space. */
+export declare enum ContainerColorSpace {
+    Rgb = "Rgb",
+    Cmyk = "Cmyk",
+    Grayscale = "Grayscale",
+    Lab = "Lab",
+    Spot = "Spot"
+}
+/** Container constraints parameters. */
+export interface ContainerConstraintsDto {
+    /** Boolean flag indicates if raster images are allowed to be placed in container. */
+    allowRasterObjects?: boolean;
+    /** Target hi-res print file DPI. */
+    targetResolution?: number;
+    /** Minimal font size for text objects placed in container. */
+    minFontSize?: number;
+    /** Maximal size of print zone. */
+    maxArtworkSize?: MaxArtworkSizeConstraintsDto | null;
+}
+/** Container constraints parameters. */
+export interface ContainerConstraintsParams {
+    /** Boolean flag indicates if raster images are allowed to be placed in container. */
+    allowRasterObjects?: boolean;
+    /** Target hi-res print file DPI. */
+    targetResolution?: number;
+    /** Minimal font size for text objects placed in container. */
+    minFontSize?: number;
+    /** Maximal size of print zone. */
+    maxArtworkSize?: MaxArtworkSizeConstraintsParams | null;
+}
+/** Container printing mode. */
+export declare enum ContainerPrintingMode {
+    FullColor = "FullColor",
+    LimitedColor = "LimitedColor",
+    Colorless = "Colorless"
+}
 /** Convert colors operation parameters. */
 export interface ConvertColorsModel {
     /** Serialized color description. */
@@ -2754,6 +2932,8 @@ export interface DesignPrintAreaDto {
     bleed?: MarginDto | null;
     /** Print area slug. */
     slug?: MarginDto | null;
+    /** Print area shape. Usually content of svg path that describes print area shape is provided. */
+    shape?: string | null;
 }
 /** Design print area parameters. */
 export interface DesignPrintAreaParams {
@@ -2769,6 +2949,8 @@ export interface DesignPrintAreaParams {
     bleed?: MarginModel | null;
     /** Print area slug. */
     slug?: MarginModel | null;
+    /** Print area shape. Usually content of svg path that describes print area shape is provided. */
+    shape?: string | null;
 }
 /** Print-product container description. */
 export interface DesignSurfaceContainerDto {
@@ -2784,6 +2966,35 @@ export interface DesignSurfaceContainerDto {
     size?: SizeDto | null;
     /** Container position. */
     position?: PositionDto | null;
+    /** Container printing mode. */
+    mode?: ContainerPrintingMode;
+    /** Container constraints. */
+    constraints?: ContainerConstraintsDto | null;
+    /** Limited color container settings. If container mode is not 'LimitedColor', null value will be provided. */
+    limitedColorSettings?: LimitedColorContainerSettingsDto | null;
+    /** Full color container settings. If container mode is not 'FullColor', null value will be provided. */
+    fullColorSettings?: FullColorContainerSettingsDto | null;
+    /** Colorless container settings. If container mode is not 'Colorless', null value will be provided. */
+    colorlessSettings?: ColorlessContainerSettingsDto | null;
+}
+/** Print-product container description. */
+export interface DesignSurfaceContainerParams {
+    /** Container name. */
+    name?: string | null;
+    /** Container size. */
+    size?: SizeModel | null;
+    /** Container position. */
+    position?: PositionModel | null;
+    /** Container printing mode. */
+    mode?: ContainerPrintingMode;
+    /** Container constraints. */
+    constraints?: ContainerConstraintsParams | null;
+    /** Limited color container settings. If container mode is not 'LimitedColor', null value will be provided. */
+    limitedColorSettings?: LimitedColorContainerSettingsParams | null;
+    /** Full color container settings. If container mode is not 'FullColor', null value will be provided. */
+    fullColorSettings?: FullColorContainerSettingsParams | null;
+    /** Colorless container settings. If container mode is not 'Colorless', null value will be provided. */
+    colorlessSettings?: ColorlessContainerSettingsParams | null;
 }
 /** Print-product surface description. */
 export interface DesignSurfaceDto {
@@ -2858,6 +3069,20 @@ export interface FontsMethodData {
     advancedMode?: boolean;
     baseUrl?: string | null;
 }
+/** Full color container settigns. */
+export interface FullColorContainerSettingsDto {
+    /** Target color space. */
+    colorSpace?: ContainerColorSpace;
+    /** Target color profile name. */
+    colorProfile?: string | null;
+}
+/** Full color container settigns. */
+export interface FullColorContainerSettingsParams {
+    /** Target color space. */
+    colorSpace?: ContainerColorSpace;
+    /** Target color profile name. */
+    colorProfile?: string | null;
+}
 /** Information about operation conflict. */
 export interface GeneralConflictDto {
     /** Problem description. */
@@ -2924,6 +3149,20 @@ export declare enum ItemType {
     Clipart = "Clipart",
     Group = "Group"
 }
+/** Limited color container settigns. */
+export interface LimitedColorContainerSettingsDto {
+    /** Colors limit count. */
+    colors?: number;
+    /** Related palette UID. */
+    paletteUID?: string | null;
+}
+/** Limited color container settigns. */
+export interface LimitedColorContainerSettingsParams {
+    /** Colors limit count. */
+    colors?: number;
+    /** Related palette UID. */
+    paletteUID?: string | null;
+}
 /** Margins of the print-product element. */
 export interface MarginDto {
     /** Print-product element top margin. */
@@ -2946,6 +3185,16 @@ export interface MarginModel {
     /** Bottom margin. */
     bottom?: number;
 }
+export interface MaxArtworkSizeConstraintsDto {
+    width?: number | null;
+    height?: number | null;
+    shapeType?: ArtworkShapeType | null;
+}
+export interface MaxArtworkSizeConstraintsParams {
+    width?: number | null;
+    height?: number | null;
+    shapeType?: ArtworkShapeType | null;
+}
 export interface MeasureUnitInfo {
     name?: string | null;
     shortName?: string | null;
@@ -2956,6 +3205,35 @@ export interface Mockup3dAttributesDto {
         [key: string]: string;
     } | null;
 }
+/** Mockup preview fitting mode. */
+export declare enum MockupPreviewFitMode {
+    Fit = "Fit",
+    Shrink = "Shrink",
+    Resize = "Resize",
+    Fill = "Fill"
+}
+/** Mockup preview file format. */
+export declare enum MockupPreviewFormat {
+    Jpeg = "Jpeg",
+    Png = "Png"
+}
+/** Settings that describe mockup preview rendering parameters. */
+export interface MockupPreviewRenderingConfig {
+    /** Mockup preview width (in pixels). */
+    width?: number;
+    /** Mockup preview height (in pixels). */
+    height?: number;
+    /** Parameters of active group layers. Each group can have only one active layer.
+E.g. { "Group1: "Layer1", "Group2": "Layer2" }.
+If value is not set, all visible layers will be rendered. */
+    groups?: {
+        [key: string]: string;
+    } | null;
+    /** Mockup preview file format. */
+    fileFormat?: MockupPreviewFormat | null;
+    /** Mockup preview fit mode. */
+    fitMode?: MockupPreviewFitMode | null;
+}
 export interface MultiCallRequest {
     items?: MultiCallRequestItem[] | null;
 }
@@ -3219,6 +3497,14 @@ export interface RenderImagePreviewToResourceModel {
     /** Image preview configuration. */
     renderingConfig?: ImagePreviewRenderingConfig | null;
 }
+export interface RenderMockupPreviewModel {
+    /** Mockup identifier. */
+    mockupId?: string | null;
+    /** Storage image owner identifier. */
+    ownerId?: string | null;
+    /** Mockup preview configuration. */
+    renderingConfig?: MockupPreviewRenderingConfig | null;
+}
 /** Render product parameters. */
 export interface RenderProductModel {
     /** Serialized product description. */