@aurigma/axios-design-atoms-api-client 2.46.1 → 2.50.1

package/dist/cjs/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>;
@@ -409,6 +409,13 @@ export interface IDesignAtomsImagesApiClient {
      * @return Success
      */
     renderImagePreview(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderImagePreviewModel | null | undefined): Promise<FileResponse>;
+    /**
+     * Renders a web image preview with the specified parameters and saves rendering result as resource.
+     * @param tenantId (optional) Tenant identifier
+     * @param body (optional) Render model with preview parameters.
+     * @return Success
+     */
+    renderImagePreviewToResource(tenantId?: number | undefined, body?: RenderImagePreviewToResourceModel | null | undefined): Promise<ResourceInfoDto>;
 }
 export declare class DesignAtomsImagesApiClient extends ApiClientBase implements IDesignAtomsImagesApiClient {
     private instance;
@@ -425,6 +432,14 @@ export declare class DesignAtomsImagesApiClient extends ApiClientBase implements
      */
     renderImagePreview(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderImagePreviewModel | null | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
     protected processRenderImagePreview(response: AxiosResponse): Promise<FileResponse>;
+    /**
+     * Renders a web image preview with the specified parameters and saves rendering result as resource.
+     * @param tenantId (optional) Tenant identifier
+     * @param body (optional) Render model with preview parameters.
+     * @return Success
+     */
+    renderImagePreviewToResource(tenantId?: number | undefined, body?: RenderImagePreviewToResourceModel | null | undefined, cancelToken?: CancelToken | undefined): Promise<ResourceInfoDto>;
+    protected processRenderImagePreviewToResource(response: AxiosResponse): Promise<ResourceInfoDto>;
 }
 export interface IDesignAtomsMockups3dApiClient {
     /**
@@ -545,6 +560,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
@@ -619,6 +642,13 @@ 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>;
+    /**
+     * Extracts product item image.
+     * @param tenantId (optional) Tenant identifier
+     * @param body (optional) Extraction parameters.
+     * @return Success
+     */
+    extractItemImage(tenantId?: number | undefined, body?: ExtractItemImageModel | null | undefined): Promise<FileResponse>;
     /**
      * Creates a private design from a public design.
      * @param designId (optional) Public design ID.
@@ -646,6 +676,13 @@ export interface IDesignAtomsServiceApiClient {
      * @return Success
      */
     renderDesignPreview(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderDesignPreviewModel | null | undefined): Promise<FileResponse>;
+    /**
+     * Renders a design preview with the specified parameters and saves rendering result as resource.
+     * @param tenantId (optional) Tenant identifier
+     * @param body (optional) Render model with preview parameters.
+     * @return Success
+     */
+    renderDesignPreviewToResource(tenantId?: number | undefined, body?: RenderDesignPreviewToResourceModel | null | undefined): Promise<ResourceInfoDto>;
     /**
      * Renders a design proof with the specified parameters.
      * @param attachment (optional) If set to 'true', file will be provided as an attachment with unique filename supplied
@@ -655,6 +692,13 @@ export interface IDesignAtomsServiceApiClient {
      * @return Success
      */
     renderDesignProof(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderDesignProofModel | null | undefined): Promise<FileResponse>;
+    /**
+     * Renders a design proof with the specified parameters and saves rendering result as resource.
+     * @param tenantId (optional) Tenant identifier
+     * @param body (optional) Render model with preview parameters.
+     * @return Success
+     */
+    renderDesignProofToResource(tenantId?: number | undefined, body?: RenderDesignProofToResourceModel | null | undefined): Promise<ResourceInfoDto>;
     /**
      * 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').
@@ -743,6 +787,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
@@ -825,6 +878,14 @@ 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>;
+    /**
+     * Extracts product item image.
+     * @param tenantId (optional) Tenant identifier
+     * @param body (optional) Extraction parameters.
+     * @return Success
+     */
+    extractItemImage(tenantId?: number | undefined, body?: ExtractItemImageModel | null | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
+    protected processExtractItemImage(response: AxiosResponse): Promise<FileResponse>;
     /**
      * Creates a private design from a public design.
      * @param designId (optional) Public design ID.
@@ -855,6 +916,14 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
      */
     renderDesignPreview(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderDesignPreviewModel | null | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
     protected processRenderDesignPreview(response: AxiosResponse): Promise<FileResponse>;
+    /**
+     * Renders a design preview with the specified parameters and saves rendering result as resource.
+     * @param tenantId (optional) Tenant identifier
+     * @param body (optional) Render model with preview parameters.
+     * @return Success
+     */
+    renderDesignPreviewToResource(tenantId?: number | undefined, body?: RenderDesignPreviewToResourceModel | null | undefined, cancelToken?: CancelToken | undefined): Promise<ResourceInfoDto>;
+    protected processRenderDesignPreviewToResource(response: AxiosResponse): Promise<ResourceInfoDto>;
     /**
      * Renders a design proof with the specified parameters.
      * @param attachment (optional) If set to 'true', file will be provided as an attachment with unique filename supplied
@@ -865,6 +934,14 @@ export declare class DesignAtomsServiceApiClient extends ApiClientBase implement
      */
     renderDesignProof(attachment?: boolean | null | undefined, tenantId?: number | undefined, body?: RenderDesignProofModel | null | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
     protected processRenderDesignProof(response: AxiosResponse): Promise<FileResponse>;
+    /**
+     * Renders a design proof with the specified parameters and saves rendering result as resource.
+     * @param tenantId (optional) Tenant identifier
+     * @param body (optional) Render model with preview parameters.
+     * @return Success
+     */
+    renderDesignProofToResource(tenantId?: number | undefined, body?: RenderDesignProofToResourceModel | null | undefined, cancelToken?: CancelToken | undefined): Promise<ResourceInfoDto>;
+    protected processRenderDesignProofToResource(response: AxiosResponse): Promise<ResourceInfoDto>;
     /**
      * 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').
@@ -1300,16 +1377,20 @@ 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;
@@ -1417,10 +1498,22 @@ export declare enum ImagePreviewFormat {
     Jpeg = "Jpeg",
     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. */
@@ -1434,6 +1527,36 @@ export interface RenderImagePreviewModel {
     /** Image preview configuration. */
     renderingConfig?: ImagePreviewRenderingConfig | null;
 }
+export interface ResourceParams {
+    ownerId?: string | null;
+    namespace?: string | null;
+    name?: string | null;
+    sourceId?: string | null;
+    type?: string | null;
+    anonymousAccess?: boolean;
+}
+export interface RenderImagePreviewToResourceModel {
+    /** Parameters of resource that should be created for a preview rendering result. */
+    previewResourceParams?: ResourceParams | null;
+    /** External image URL. */
+    imageUrl?: string | 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 ResourceInfoDto {
+    id?: string | null;
+    ownerId?: string | null;
+    name?: string | null;
+    namespace?: string | null;
+    private?: boolean;
+    url?: string | null;
+}
 export interface Mockup3dAttributesDto {
     data?: {
         [key: string]: string;
@@ -1497,6 +1620,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. */
@@ -1530,6 +1669,11 @@ export declare enum ItemSourceType {
     ImageStorage = "ImageStorage",
     PrivateImageStorage = "PrivateImageStorage"
 }
+/** Render product parameters */
+export interface ExtractItemImageModel {
+    /** Serialized item description */
+    item: any;
+}
 /** Product preview file format. */
 export declare enum ProductPreviewFormat {
     Jpeg = "Jpeg",
@@ -1555,6 +1699,22 @@ Used to get mockup file from public storage. */
     /** Variable (user) data for design variable fields in the preview image. */
     variableData?: VariableInfo[] | null;
 }
+export interface RenderDesignPreviewToResourceModel {
+    /** Parameters of resource that should be created for a preview rendering result. */
+    previewResourceParams?: ResourceParams | null;
+    /** 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 for design variable fields in the preview image. */
+    variableData?: VariableInfo[] | null;
+}
 export declare enum ProductProofFormat {
     Jpeg = "Jpeg",
     Png = "Png",
@@ -1605,6 +1765,19 @@ Used to get design file from public or private storage. */
     /** Variable (user) data for design variable fields in the proof image. */
     variableData?: VariableInfo[] | null;
 }
+export interface RenderDesignProofToResourceModel {
+    /** Parameters of resource that should be created for a preview rendering result. */
+    proofResourceParams?: ResourceParams | null;
+    /** Design ID.
+Used to get design file from public or private storage. */
+    designId?: string | null;
+    /** ID of the design owner. */
+    ownerId?: string | null;
+    /** Rendering configuration for getting a proof image of design. */
+    renderingConfig?: ProductProofRenderingConfig | null;
+    /** Variable (user) data for design variable fields in the proof image. */
+    variableData?: VariableInfo[] | null;
+}
 /** Render product parameters */
 export interface RenderProductModel {
     /** Serialized product description */