@aurigma/axios-design-atoms-api-client 2.23.1 → 2.28.1

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

@@ -347,6 +347,15 @@ export interface IDesignAtomsServiceApiClient {
      * @return Success
      */
     createDesign(privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: CreateDesignModel | null | undefined): Promise<DesignInfo>;
+    /**
+     * Returns content of the background.
+     * @param id Design identifier.
+     * @param surfaceIndex (optional) Surface index.
+     * @param privateStorageOwner (optional) Private storage owner identifier.
+     * @param tenantId (optional) Tenant identifier
+     * @return Success
+     */
+    extractBackground(id: string | null, surfaceIndex?: number | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<FileResponse>;
     /**
      * Loads product (design model) from design file taken from storage
      * @param id Design identifier
@@ -405,7 +414,7 @@ export interface IDesignAtomsServiceApiClient {
      * @param body (optional) Design variable values
      * @return Success
      */
-    setVariables(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: VariablesModel | null | undefined): Promise<VariablesModel>;
+    setVariables(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: VariablesModel | null | undefined): Promise<void>;
     /**
      * Loads variable data printing information from design file taken from storage
      * @param id Design identifier
@@ -435,9 +444,9 @@ export interface IDesignAtomsServiceApiClient {
      */
     deleteVdpData(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<void>;
     /**
-     * Flatten items
+     * Flatten items.
      * @param tenantId (optional) Tenant identifier
-     * @param body (optional) Items to flatten
+     * @param body (optional) Items to flatten.
      * @return Success
      */
     flattenItems(tenantId?: number | undefined, body?: any[] | null | undefined): Promise<any>;
@@ -452,11 +461,37 @@ export interface IDesignAtomsServiceApiClient {
      * @return Success
      */
     createItem(itemType?: ItemType | null | undefined, tenantId?: number | undefined, sourceType?: ItemSourceType | null | undefined, sourceId?: string | null | undefined, sourceOwnerId?: string | null | undefined, sourceFile?: FileParameter | null | undefined): Promise<any>;
+    /**
+     * Creates a private design from a public design.
+     * @param designId (optional) Public design ID.
+     * @param privateDesignId (optional) Private design ID.
+     * @param privateStorageOwner (optional) Private storage owner ID.
+     * @param tenantId (optional) Tenant identifier
+     * @return Success
+     */
+    createPrivateDesignFromDesign(designId?: string | null | undefined, privateDesignId?: string | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<void>;
+    /**
+     * Creates a private design from a public resource.
+     * @param resourceId (optional) Resource ID.
+     * @param privateDesignId (optional) Private design ID.
+     * @param privateStorageOwner (optional) Private storage owner ID.
+     * @param tenantId (optional) Tenant identifier
+     * @return Success
+     */
+    createPrivateDesignFromResource(resourceId?: string | null | undefined, privateDesignId?: string | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined): Promise<void>;
+    /**
+     * Renders a design 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 identifier
+     * @param body (optional) Render model with preview parameters.
+     * @return Success
+     */
+    renderDesign(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderDesignModel | null | undefined): Promise<FileResponse>;
     /**
      * Render product proof image with 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 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 identifier
-     * @param body (optional) Preview parameters
+     * @param body (optional) Preview parameters.
      * @return Success
      */
     renderProduct(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderProductModel | null | undefined): Promise<FileResponse>;
@@ -484,6 +519,16 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
      */
     createDesign(privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: CreateDesignModel | null | undefined, cancelToken?: CancelToken | undefined): Promise<DesignInfo>;
     protected processCreateDesign(response: AxiosResponse): Promise<DesignInfo>;
+    /**
+     * Returns content of the background.
+     * @param id Design identifier.
+     * @param surfaceIndex (optional) Surface index.
+     * @param privateStorageOwner (optional) Private storage owner identifier.
+     * @param tenantId (optional) Tenant identifier
+     * @return Success
+     */
+    extractBackground(id: string | null, surfaceIndex?: number | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
+    protected processExtractBackground(response: AxiosResponse): Promise<FileResponse>;
     /**
      * Loads product (design model) from design file taken from storage
      * @param id Design identifier
@@ -547,8 +592,8 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
      * @param body (optional) Design variable values
      * @return Success
      */
-    setVariables(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: VariablesModel | null | undefined, cancelToken?: CancelToken | undefined): Promise<VariablesModel>;
-    protected processSetVariables(response: AxiosResponse): Promise<VariablesModel>;
+    setVariables(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, body?: VariablesModel | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
+    protected processSetVariables(response: AxiosResponse): Promise<void>;
     /**
      * Loads variable data printing information from design file taken from storage
      * @param id Design identifier
@@ -581,9 +626,9 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
     deleteVdpData(id: string | null, privateStorage?: boolean | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
     protected processDeleteVdpData(response: AxiosResponse): Promise<void>;
     /**
-     * Flatten items
+     * Flatten items.
      * @param tenantId (optional) Tenant identifier
-     * @param body (optional) Items to flatten
+     * @param body (optional) Items to flatten.
      * @return Success
      */
     flattenItems(tenantId?: number | undefined, body?: any[] | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
@@ -600,11 +645,40 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
      */
     createItem(itemType?: ItemType | null | undefined, tenantId?: number | undefined, sourceType?: ItemSourceType | null | undefined, sourceId?: string | null | undefined, sourceOwnerId?: string | null | undefined, sourceFile?: FileParameter | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
     protected processCreateItem(response: AxiosResponse): Promise<any>;
+    /**
+     * Creates a private design from a public design.
+     * @param designId (optional) Public design ID.
+     * @param privateDesignId (optional) Private design ID.
+     * @param privateStorageOwner (optional) Private storage owner ID.
+     * @param tenantId (optional) Tenant identifier
+     * @return Success
+     */
+    createPrivateDesignFromDesign(designId?: string | null | undefined, privateDesignId?: string | null | undefined, privateStorageOwner?: string | null | undefined, tenantId?: number | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
+    protected processCreatePrivateDesignFromDesign(response: AxiosResponse): Promise<void>;
+    /**
+     * Creates a private design from a public resource.
+     * @param resourceId (optional) Resource ID.
+     * @param privateDesignId (optional) Private design ID.
+     * @param privateStorageOwner (optional) Private storage owner ID.
+     * @param tenantId (optional) Tenant identifier
+     * @return Success
+     */
+    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>;
+    /**
+     * Renders a design 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 identifier
+     * @param body (optional) Render model with preview parameters.
+     * @return Success
+     */
+    renderDesign(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderDesignModel | null | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
+    protected processRenderDesign(response: AxiosResponse): Promise<FileResponse>;
     /**
      * Render product proof image with 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 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 identifier
-     * @param body (optional) Preview parameters
+     * @param body (optional) Preview parameters.
      * @return Success
      */
     renderProduct(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderProductModel | null | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
@@ -943,6 +1017,13 @@ export declare class DesignAtomsViewerApiClient extends ApiClientBase implements
     updateShapeItemHandler(tenantId?: number | undefined, body?: UpdateHandlerRequest | null | undefined, cancelToken?: CancelToken | undefined): Promise<any>;
     protected processUpdateShapeItemHandler(response: AxiosResponse): Promise<any>;
 }
+export interface ProblemDetails {
+    type?: string | null;
+    title?: string | null;
+    status?: number | null;
+    detail?: string | null;
+    instance?: string | null;
+}
 /** Information about a service */
 export interface BuildInfoModel {
     /** Version number */
@@ -959,13 +1040,6 @@ export interface FontsMethodData {
     advancedMode?: boolean;
     baseUrl?: string | null;
 }
-export interface ProblemDetails {
-    type?: string | null;
-    title?: string | null;
-    status?: number | null;
-    detail?: string | null;
-    instance?: string | null;
-}
 export interface GetImageSizeRequest {
     imageId?: string | null;
     pageIndex?: number;
@@ -1055,18 +1129,38 @@ export interface DesignInfo {
     name?: string | null;
     private?: boolean;
 }
+export declare enum DesignElementType {
+    Product = "Product",
+    Design = "Design",
+    Surface = "Surface",
+    Container = "Container",
+    PrintArea = "PrintArea",
+    Item = "Item"
+}
+export interface MissingDesignElementDto {
+    /** Problem description. */
+    description?: string | null;
+    /** Missing element type. */
+    readonly missingElementType?: DesignElementType;
+}
+export interface UnprocessableDesignElementDto {
+    /** Problem description. */
+    description?: string | null;
+    /** Missing element type. */
+    readonly missingElementType?: DesignElementType;
+}
 /** Available patch type */
 export declare enum ProductPatchType {
     Undefined = "Undefined",
     ReplaceImageItemFile = "ReplaceImageItemFile"
 }
-/** Variable information */
+/** Variable information. */
 export interface VariableInfo {
-    /** Variable name */
+    /** Variable name. */
     name?: string | null;
-    /** Variable value */
+    /** Variable value. */
     value?: string | null;
-    /** Variable type */
+    /** Variable type. */
     type?: string | null;
 }
 /** Variables information */
@@ -1093,6 +1187,33 @@ export declare enum ItemSourceType {
     ImageStorage = "ImageStorage",
     PrivateImageStorage = "PrivateImageStorage"
 }
+/** Product preview file format. */
+export declare enum ProductPreviewFormat {
+    Jpeg = "Jpeg",
+    Png = "Png",
+    Tiff = "Tiff",
+    Pdf = "Pdf"
+}
+export interface ProductPreviewRenderingConfig {
+    surfaceIndex?: number | null;
+    width?: number;
+    height?: number;
+    fileFormat?: ProductPreviewFormat | null;
+}
+export interface RenderDesignModel {
+    /** Design ID.
+Used to get design file from public or private storage. */
+    designId?: string | null;
+    /** Mockup ID.
+Used to get mockup file from public storage. */
+    mockupId?: string | null;
+    /** ID of the design owner. */
+    ownerId?: string | null;
+    /** Rendering configuration for getting a preview of design. */
+    renderingConfig?: ProductPreviewRenderingConfig | null;
+    /** Variable (user) data of design. */
+    variableData?: VariableInfo[] | null;
+}
 export declare enum ProductProofFormat {
     Jpeg = "Jpeg",
     Png = "Png",