@aurigma/axios-design-atoms-api-client 2.44.1 → 2.48.1

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

@@ -15,12 +15,12 @@ export declare class ApiClientBase {
 }
 export interface IBuildInfoApiClient {
     /**
-     * Gets assembly build info
+     * Get assembly build info.
      * @return Success
      */
     headInfo(): Promise<void>;
     /**
-     * Gets assembly build info
+     * Get assembly build info.
      * @return Success
      */
     getInfo(): Promise<BuildInfoModel>;
@@ -31,13 +31,13 @@ export declare class BuildInfoApiClient extends ApiClientBase implements IBuildI
     protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
     constructor(configuration: ApiClientConfiguration, baseUrl?: string, instance?: AxiosInstance);
     /**
-     * Gets assembly build info
+     * Get assembly build info.
      * @return Success
      */
     headInfo(cancelToken?: CancelToken | undefined): Promise<void>;
     protected processHeadInfo(response: AxiosResponse): Promise<void>;
     /**
-     * Gets assembly build info
+     * Get assembly build info.
      * @return Success
      */
     getInfo(cancelToken?: CancelToken | undefined): Promise<BuildInfoModel>;
@@ -104,9 +104,11 @@ export interface IDesignAtomsCompatibilityApiClient {
      * @param alphaMask (optional)
      * @param page (optional)
      * @param colorizeColor (optional)
+     * @param rw (optional)
+     * @param rh (optional)
      * @return Success
      */
-    img(tenantId: number, f?: string | null | undefined, w?: number | null | undefined, h?: number | null | undefined, cmyk?: string | null | undefined, rgb?: string | null | undefined, grayscale?: string | null | undefined, target?: string | null | undefined, sq?: boolean | null | undefined, effect?: string | null | undefined, kp?: boolean | null | undefined, color?: string | null | undefined, obm?: string | null | undefined, oo?: number | null | undefined, alphaMask?: boolean | null | undefined, page?: number | null | undefined, colorizeColor?: string | null | undefined): Promise<FileResponse>;
+    img(tenantId: number, f?: string | null | undefined, w?: number | null | undefined, h?: number | null | undefined, cmyk?: string | null | undefined, rgb?: string | null | undefined, grayscale?: string | null | undefined, target?: string | null | undefined, sq?: boolean | null | undefined, effect?: string | null | undefined, kp?: boolean | null | undefined, color?: string | null | undefined, obm?: string | null | undefined, oo?: number | null | undefined, alphaMask?: boolean | null | undefined, page?: number | null | undefined, colorizeColor?: string | null | undefined, rw?: number | null | undefined, rh?: number | null | undefined): Promise<FileResponse>;
     /**
      * @return Success
      */
@@ -123,9 +125,26 @@ export interface IDesignAtomsCompatibilityApiClient {
     resource(tenantId: number, image?: string | null | undefined): Promise<FileResponse>;
     /**
      * @param f (optional)
+     * @param w (optional)
+     * @param h (optional)
+     * @param cmyk (optional)
+     * @param rgb (optional)
+     * @param grayscale (optional)
+     * @param target (optional)
+     * @param sq (optional)
+     * @param effect (optional)
+     * @param kp (optional)
+     * @param color (optional)
+     * @param obm (optional)
+     * @param oo (optional)
+     * @param alphaMask (optional)
+     * @param page (optional)
+     * @param colorizeColor (optional)
+     * @param rw (optional)
+     * @param rh (optional)
      * @return Success
      */
-    svg(tenantId: number, f?: string | null | undefined): Promise<FileResponse>;
+    svg(tenantId: number, f?: string | null | undefined, w?: number | null | undefined, h?: number | null | undefined, cmyk?: string | null | undefined, rgb?: string | null | undefined, grayscale?: string | null | undefined, target?: string | null | undefined, sq?: boolean | null | undefined, effect?: string | null | undefined, kp?: boolean | null | undefined, color?: string | null | undefined, obm?: string | null | undefined, oo?: number | null | undefined, alphaMask?: boolean | null | undefined, page?: number | null | undefined, colorizeColor?: string | null | undefined, rw?: number | null | undefined, rh?: number | null | undefined): Promise<FileResponse>;
     /**
      * @param f (optional)
      * @return Success
@@ -261,9 +280,11 @@ export declare class DesignAtomsCompatibilityApiClient extends ApiClientBase imp
      * @param alphaMask (optional)
      * @param page (optional)
      * @param colorizeColor (optional)
+     * @param rw (optional)
+     * @param rh (optional)
      * @return Success
      */
-    img(tenantId: number, f?: string | null | undefined, w?: number | null | undefined, h?: number | null | undefined, cmyk?: string | null | undefined, rgb?: string | null | undefined, grayscale?: string | null | undefined, target?: string | null | undefined, sq?: boolean | null | undefined, effect?: string | null | undefined, kp?: boolean | null | undefined, color?: string | null | undefined, obm?: string | null | undefined, oo?: number | null | undefined, alphaMask?: boolean | null | undefined, page?: number | null | undefined, colorizeColor?: string | null | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
+    img(tenantId: number, f?: string | null | undefined, w?: number | null | undefined, h?: number | null | undefined, cmyk?: string | null | undefined, rgb?: string | null | undefined, grayscale?: string | null | undefined, target?: string | null | undefined, sq?: boolean | null | undefined, effect?: string | null | undefined, kp?: boolean | null | undefined, color?: string | null | undefined, obm?: string | null | undefined, oo?: number | null | undefined, alphaMask?: boolean | null | undefined, page?: number | null | undefined, colorizeColor?: string | null | undefined, rw?: number | null | undefined, rh?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
     protected processImg(response: AxiosResponse): Promise<FileResponse>;
     /**
      * @return Success
@@ -284,9 +305,26 @@ export declare class DesignAtomsCompatibilityApiClient extends ApiClientBase imp
     protected processResource(response: AxiosResponse): Promise<FileResponse>;
     /**
      * @param f (optional)
+     * @param w (optional)
+     * @param h (optional)
+     * @param cmyk (optional)
+     * @param rgb (optional)
+     * @param grayscale (optional)
+     * @param target (optional)
+     * @param sq (optional)
+     * @param effect (optional)
+     * @param kp (optional)
+     * @param color (optional)
+     * @param obm (optional)
+     * @param oo (optional)
+     * @param alphaMask (optional)
+     * @param page (optional)
+     * @param colorizeColor (optional)
+     * @param rw (optional)
+     * @param rh (optional)
      * @return Success
      */
-    svg(tenantId: number, f?: string | null | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
+    svg(tenantId: number, f?: string | null | undefined, w?: number | null | undefined, h?: number | null | undefined, cmyk?: string | null | undefined, rgb?: string | null | undefined, grayscale?: string | null | undefined, target?: string | null | undefined, sq?: boolean | null | undefined, effect?: string | null | undefined, kp?: boolean | null | undefined, color?: string | null | undefined, obm?: string | null | undefined, oo?: number | null | undefined, alphaMask?: boolean | null | undefined, page?: number | null | undefined, colorizeColor?: string | null | undefined, rw?: number | null | undefined, rh?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
     protected processSvg(response: AxiosResponse): Promise<FileResponse>;
     /**
      * @param f (optional)
@@ -507,6 +545,14 @@ export interface IDesignAtomsServiceApiClient {
      * @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, replacePlaceholderItemContentInfo_placeholderItemName?: string | null | undefined, replacePlaceholderItemContentInfo_newContentType?: PlaceholderItemContentType | undefined, replacePlaceholderItemContentInfo_sourceFile?: FileParameter | null | undefined): Promise<void>;
+    /**
+     * Returns design parameters stored in product model.
+     * @param id Design identifier.
+     * @param privateStorageOwner (optional) Private storage owner identifier.
+     * @param tenantId (optional) Tenant identifier
+     * @return Success
+     */
+    getDesignParameters(id: string | null, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<DesignParameters>;
     /**
      * Loads data schema from design file taken from storage
      * @param id Design identifier
@@ -705,6 +751,15 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
      */
     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, cancelToken?: CancelToken | undefined): Promise<void>;
     protected processPatchProduct(response: AxiosResponse): Promise<void>;
+    /**
+     * Returns design parameters stored in product model.
+     * @param id Design identifier.
+     * @param privateStorageOwner (optional) Private storage owner identifier.
+     * @param tenantId (optional) Tenant identifier
+     * @return Success
+     */
+    getDesignParameters(id: string | null, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<DesignParameters>;
+    protected processGetDesignParameters(response: AxiosResponse): Promise<DesignParameters>;
     /**
      * Loads data schema from design file taken from storage
      * @param id Design identifier
@@ -917,10 +972,12 @@ export interface IDesignAtomsViewerApiClient {
      * @param alphaMask (optional)
      * @param page (optional)
      * @param colorizeColor (optional)
+     * @param rw (optional)
+     * @param rh (optional)
      * @param tenantId (optional) Tenant identifier
      * @return Success
      */
-    img(f?: string | null | undefined, w?: number | null | undefined, h?: number | null | undefined, cmyk?: string | null | undefined, rgb?: string | null | undefined, grayscale?: string | null | undefined, target?: string | null | undefined, sq?: boolean | null | undefined, effect?: string | null | undefined, kp?: boolean | null | undefined, color?: string | null | undefined, obm?: string | null | undefined, oo?: number | null | undefined, alphaMask?: boolean | null | undefined, page?: number | null | undefined, colorizeColor?: string | null | undefined, tenantId?: number | undefined): Promise<FileResponse>;
+    img(f?: string | null | undefined, w?: number | null | undefined, h?: number | null | undefined, cmyk?: string | null | undefined, rgb?: string | null | undefined, grayscale?: string | null | undefined, target?: string | null | undefined, sq?: boolean | null | undefined, effect?: string | null | undefined, kp?: boolean | null | undefined, color?: string | null | undefined, obm?: string | null | undefined, oo?: number | null | undefined, alphaMask?: boolean | null | undefined, page?: number | null | undefined, colorizeColor?: string | null | undefined, rw?: number | null | undefined, rh?: number | null | undefined, tenantId?: number | undefined): Promise<FileResponse>;
     /**
      * @param tenantId (optional) Tenant identifier
      * @return Success
@@ -940,10 +997,27 @@ export interface IDesignAtomsViewerApiClient {
     resource(image?: string | null | undefined, tenantId?: number | undefined): Promise<FileResponse>;
     /**
      * @param f (optional)
+     * @param w (optional)
+     * @param h (optional)
+     * @param cmyk (optional)
+     * @param rgb (optional)
+     * @param grayscale (optional)
+     * @param target (optional)
+     * @param sq (optional)
+     * @param effect (optional)
+     * @param kp (optional)
+     * @param color (optional)
+     * @param obm (optional)
+     * @param oo (optional)
+     * @param alphaMask (optional)
+     * @param page (optional)
+     * @param colorizeColor (optional)
+     * @param rw (optional)
+     * @param rh (optional)
      * @param tenantId (optional) Tenant identifier
      * @return Success
      */
-    svg(f?: string | null | undefined, tenantId?: number | undefined): Promise<FileResponse>;
+    svg(f?: string | null | undefined, w?: number | null | undefined, h?: number | null | undefined, cmyk?: string | null | undefined, rgb?: string | null | undefined, grayscale?: string | null | undefined, target?: string | null | undefined, sq?: boolean | null | undefined, effect?: string | null | undefined, kp?: boolean | null | undefined, color?: string | null | undefined, obm?: string | null | undefined, oo?: number | null | undefined, alphaMask?: boolean | null | undefined, page?: number | null | undefined, colorizeColor?: string | null | undefined, rw?: number | null | undefined, rh?: number | null | undefined, tenantId?: number | undefined): Promise<FileResponse>;
     /**
      * @param f (optional)
      * @param tenantId (optional) Tenant identifier
@@ -1100,10 +1174,12 @@ export declare class DesignAtomsViewerApiClient extends ApiClientBase implements
      * @param alphaMask (optional)
      * @param page (optional)
      * @param colorizeColor (optional)
+     * @param rw (optional)
+     * @param rh (optional)
      * @param tenantId (optional) Tenant identifier
      * @return Success
      */
-    img(f?: string | null | undefined, w?: number | null | undefined, h?: number | null | undefined, cmyk?: string | null | undefined, rgb?: string | null | undefined, grayscale?: string | null | undefined, target?: string | null | undefined, sq?: boolean | null | undefined, effect?: string | null | undefined, kp?: boolean | null | undefined, color?: string | null | undefined, obm?: string | null | undefined, oo?: number | null | undefined, alphaMask?: boolean | null | undefined, page?: number | null | undefined, colorizeColor?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
+    img(f?: string | null | undefined, w?: number | null | undefined, h?: number | null | undefined, cmyk?: string | null | undefined, rgb?: string | null | undefined, grayscale?: string | null | undefined, target?: string | null | undefined, sq?: boolean | null | undefined, effect?: string | null | undefined, kp?: boolean | null | undefined, color?: string | null | undefined, obm?: string | null | undefined, oo?: number | null | undefined, alphaMask?: boolean | null | undefined, page?: number | null | undefined, colorizeColor?: string | null | undefined, rw?: number | null | undefined, rh?: number | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
     protected processImg(response: AxiosResponse): Promise<FileResponse>;
     /**
      * @param tenantId (optional) Tenant identifier
@@ -1127,10 +1203,27 @@ export declare class DesignAtomsViewerApiClient extends ApiClientBase implements
     protected processResource(response: AxiosResponse): Promise<FileResponse>;
     /**
      * @param f (optional)
+     * @param w (optional)
+     * @param h (optional)
+     * @param cmyk (optional)
+     * @param rgb (optional)
+     * @param grayscale (optional)
+     * @param target (optional)
+     * @param sq (optional)
+     * @param effect (optional)
+     * @param kp (optional)
+     * @param color (optional)
+     * @param obm (optional)
+     * @param oo (optional)
+     * @param alphaMask (optional)
+     * @param page (optional)
+     * @param colorizeColor (optional)
+     * @param rw (optional)
+     * @param rh (optional)
      * @param tenantId (optional) Tenant identifier
      * @return Success
      */
-    svg(f?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
+    svg(f?: string | null | undefined, w?: number | null | undefined, h?: number | null | undefined, cmyk?: string | null | undefined, rgb?: string | null | undefined, grayscale?: string | null | undefined, target?: string | null | undefined, sq?: boolean | null | undefined, effect?: string | null | undefined, kp?: boolean | null | undefined, color?: string | null | undefined, obm?: string | null | undefined, oo?: number | null | undefined, alphaMask?: boolean | null | undefined, page?: number | null | undefined, colorizeColor?: string | null | undefined, rw?: number | null | undefined, rh?: number | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
     protected processSvg(response: AxiosResponse): Promise<FileResponse>;
     /**
      * @param f (optional)
@@ -1224,27 +1317,39 @@ export interface ProblemDetails {
     detail?: string | null;
     instance?: string | null;
 }
-/** Information about a service */
+/** Information about a service. */
 export interface BuildInfoModel {
-    /** Version number */
+    /** Version number. */
     version?: string | null;
-    /** Build date (UTC) */
+    /** Build date (UTC). */
     buildDate?: string | null;
-    /** Build configuration (Debug | Release) */
+    /** Build configuration (Debug | Release). */
     configuration?: string | null;
-    /** Service name */
+    /** Service name. */
     appName?: string | null;
+    /** Aurigma.DesignAtoms version. */
+    designAtomsVersion?: string | null;
+    /** Aurigma.DesignAtoms.Model version. */
+    designAtomsModelVersion?: string | null;
 }
 export interface FontsMethodData {
     requestedFontsByPsName?: string[] | null;
     advancedMode?: boolean;
     baseUrl?: string | null;
 }
+export interface PreviewColorSettings {
+    rgbColorProfileName?: string | null;
+    cmykColorProfileName?: string | null;
+    grayscaleColorProfileName?: string | null;
+    hiResDestinationColorProfileName?: string | null;
+}
 export interface GetColorPreviewRequest {
     colorData?: any | null;
+    colorSettings?: PreviewColorSettings | null;
 }
 export interface GetColorPreviewsRequest {
     colorData?: any | null;
+    colorSettings?: PreviewColorSettings | null;
 }
 export declare enum ColorSpace {
     Rgb = "Rgb",
@@ -1297,6 +1402,7 @@ export interface UpdateHandlerRequest {
     canvasData?: string | null;
     itemHandlerData?: string | null;
     itemData?: any | null;
+    colorSettings?: PreviewColorSettings | null;
 }
 export interface UpdateColorsRequest {
     canvasData?: string | null;
@@ -1313,6 +1419,7 @@ export interface MultiCallRequestItem {
     pageIndex?: number | null;
     methodName?: string | null;
     itemData?: any | null;
+    colorSettings?: PreviewColorSettings | null;
 }
 export interface MultiCallRequest {
     items?: MultiCallRequestItem[] | null;
@@ -1324,23 +1431,41 @@ export interface UpdateImageHandlerRequest {
     canvasData?: string | null;
     itemHandlerData?: string | null;
     itemData?: any | null;
+    colorSettings?: PreviewColorSettings | null;
 }
 /** Image preview file format. */
 export declare enum ImagePreviewFormat {
     Jpeg = "Jpeg",
-    Png = "Png",
-    Tiff = "Tiff",
-    Pdf = "Pdf"
+    Png = "Png"
+}
+/** Image preview fit mode. */
+export declare enum ImagePreviewFitMode {
+    Fit = "Fit",
+    Shrink = "Shrink",
+    Resize = "Resize",
+    Fill = "Fill"
+}
+export interface ImagePreviewRenderingConfig {
+    /** Image preview width. */
+    width?: number;
+    /** Image preview height. */
+    height?: number;
+    /** Image preview file format. */
+    fileFormat?: ImagePreviewFormat | null;
+    /** Image preview fit mode. */
+    fitMode?: ImagePreviewFitMode | null;
 }
 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?: ImagePreviewFormat | null;
+    /** Storage image identifier. */
+    imageId?: string | null;
+    /** Storage image owner identifier. */
+    ownerId?: string | null;
+    /** Mockup identifier. */
+    mockupId?: string | null;
+    /** Image preview configuration. */
+    renderingConfig?: ImagePreviewRenderingConfig | null;
 }
 export interface Mockup3dAttributesDto {
     data?: {
@@ -1405,6 +1530,22 @@ export declare enum ProductPatchType {
 export declare enum PlaceholderItemContentType {
     Image = "Image"
 }
+/** Measure unit description. */
+export interface MeasureUnitInfo {
+    /** Measure unit name. */
+    name?: string | null;
+    /** Measure unit short name. */
+    shortName?: string | null;
+    /** Measure unit ratio (to point). */
+    ratio?: number;
+}
+/** Specific design parameters stored in product model. */
+export interface DesignParameters {
+    /** Design measure unit description. */
+    measureUnit?: MeasureUnitInfo | null;
+    /** Version of DesignAtoms library that used to save design file. */
+    designAtomsVersion?: string | null;
+}
 /** Variable information. */
 export interface VariableInfo {
     /** Variable name. */
@@ -1441,9 +1582,7 @@ export declare enum ItemSourceType {
 /** Product preview file format. */
 export declare enum ProductPreviewFormat {
     Jpeg = "Jpeg",
-    Png = "Png",
-    Tiff = "Tiff",
-    Pdf = "Pdf"
+    Png = "Png"
 }
 export interface ProductPreviewRenderingConfig {
     surfaceIndex?: number | null;