@aurigma/axios-design-atoms-api-client 2.76.4 → 2.79.1

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

@@ -769,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.
@@ -909,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.
@@ -1088,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.
@@ -1241,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.
@@ -1414,6 +1477,13 @@ export interface IDesignAtomsPrintProductItemsApiClient {
      * @return Success
      */
     applyItemEffects(tenantId?: number | undefined, body?: any | undefined): Promise<any>;
+    /**
+     * Creates ellipse print-product item and returns its serialized model.
+     * @param tenantId (optional) Tenant ID.
+     * @param body (optional) Operation parameters.
+     * @return Success
+     */
+    createEllipseItem(tenantId?: number | undefined, body?: CreateEllipseItemModel | undefined): Promise<any>;
     /**
      * Extracts print-product item image.
      * @param tenantId (optional) Tenant ID.
@@ -1489,6 +1559,13 @@ export interface IDesignAtomsPrintProductItemsApiClient {
      * @return Success
      */
     batchCreateItemsFromUrl(itemType?: ItemType | null | undefined, tenantId?: number | undefined, body?: BatchCreateItemsFromUrlModel | undefined): Promise<any>;
+    /**
+     * Creates rectangle print-product item and returns its serialized model.
+     * @param tenantId (optional) Tenant ID.
+     * @param body (optional) Operation parameters.
+     * @return Success
+     */
+    createRectangleItem(tenantId?: number | undefined, body?: CreateRectangleItemModel | undefined): Promise<any>;
 }
 export declare class DesignAtomsPrintProductItemsApiClient extends ApiClientBase implements IDesignAtomsPrintProductItemsApiClient {
     private instance;
@@ -1503,6 +1580,14 @@ export declare class DesignAtomsPrintProductItemsApiClient extends ApiClientBase
      */
     applyItemEffects(tenantId?: number | undefined, body?: any | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
     protected processApplyItemEffects(response: AxiosResponse): Promise<any>;
+    /**
+     * Creates ellipse print-product item and returns its serialized model.
+     * @param tenantId (optional) Tenant ID.
+     * @param body (optional) Operation parameters.
+     * @return Success
+     */
+    createEllipseItem(tenantId?: number | undefined, body?: CreateEllipseItemModel | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
+    protected processCreateEllipseItem(response: AxiosResponse): Promise<any>;
     /**
      * Extracts print-product item image.
      * @param tenantId (optional) Tenant ID.
@@ -1587,6 +1672,14 @@ export declare class DesignAtomsPrintProductItemsApiClient extends ApiClientBase
      */
     batchCreateItemsFromUrl(itemType?: ItemType | null | undefined, tenantId?: number | undefined, body?: BatchCreateItemsFromUrlModel | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
     protected processBatchCreateItemsFromUrl(response: AxiosResponse): Promise<any>;
+    /**
+     * Creates rectangle print-product item and returns its serialized model.
+     * @param tenantId (optional) Tenant ID.
+     * @param body (optional) Operation parameters.
+     * @return Success
+     */
+    createRectangleItem(tenantId?: number | undefined, body?: CreateRectangleItemModel | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
+    protected processCreateRectangleItem(response: AxiosResponse): Promise<any>;
 }
 export interface IDesignAtomsServiceApiClient {
     /**
@@ -2584,6 +2677,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. */
@@ -2624,6 +2721,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",
@@ -2631,6 +2776,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. */
@@ -2653,6 +2834,19 @@ export interface CreateDesignModel {
     /** Design location (folder path). */
     path?: string | null;
 }
+/** Ellipse item creation parameters. */
+export interface CreateEllipseItemModel {
+    /** Ellipse width. */
+    width?: number;
+    /** Ellipse height. */
+    height?: number;
+    /** Ellipse fill color (css-style, e.g. #000000). */
+    fillColor?: string | null;
+    /** Ellipse border color (css-style, e.g. #000000). */
+    borderColor?: string | null;
+    /** Ellipse border style. */
+    borderStyle?: ItemBorderStyle;
+}
 /** Create item from storage source operation parameters. */
 export interface CreateItemFromStorageModel {
     /** Source image asset owner identifier. If value is set, all images should belong to a specified user. */
@@ -2684,6 +2878,19 @@ 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;
 }
+/** Rectangle item creation parameters. */
+export interface CreateRectangleItemModel {
+    /** Rectangle width. */
+    width?: number;
+    /** Rectangle height. */
+    height?: number;
+    /** Rectangle fill color (css-style, e.g. #000000). */
+    fillColor?: string | null;
+    /** Rectangle border color (css-style, e.g. #000000). */
+    borderColor?: string | null;
+    /** Rectangle border style. */
+    borderStyle?: ItemBorderStyle;
+}
 export interface DesignElementProcessingConflictDto {
     /** Missing element type. */
     readonly missingElementType?: DesignElementType | null;
@@ -2781,6 +2988,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 {
@@ -2796,6 +3005,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 {
@@ -2811,6 +3022,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 {
@@ -2885,6 +3125,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. */
@@ -2938,6 +3192,10 @@ export interface ImagePreviewRenderingConfig {
 Zero by default. */
     pageIndex?: number | null;
 }
+export declare enum ItemBorderStyle {
+    Solid = "Solid",
+    Dashed = "Dashed"
+}
 /** Item source types. */
 export declare enum ItemSourceType {
     File = "File",
@@ -2951,6 +3209,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. */
@@ -2973,6 +3245,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;
@@ -3084,6 +3366,8 @@ export interface ProductPreviewRenderingConfig {
     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. */
@@ -3123,6 +3407,8 @@ export interface ProductProofRenderingConfig {
     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). */