@aurigma/axios-design-atoms-api-client 2.46.1 → 2.48.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>;
@@ -545,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
@@ -743,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
@@ -1300,16 +1317,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 +1438,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. */
@@ -1497,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. */

package/dist/cjs/design-atoms-api-client.js

@@ -8,7 +8,7 @@
 //----------------------
 // ReSharper disable InconsistentNaming
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiException = exports.ProductProofInterpolationMode = exports.ProductProofFormat = exports.ProductPreviewFormat = exports.ItemSourceType = exports.ItemType = exports.PlaceholderItemContentType = exports.ProductPatchType = exports.DesignElementType = exports.ImagePreviewFormat = exports.ColorSpace = exports.DesignAtomsViewerApiClient = exports.DesignAtomsServiceApiClient = exports.DesignAtomsMockups3dApiClient = exports.DesignAtomsImagesApiClient = exports.DesignAtomsCompatibilityApiClient = exports.BuildInfoApiClient = exports.ApiClientBase = exports.ApiClientConfiguration = void 0;
+exports.ApiException = exports.ProductProofInterpolationMode = exports.ProductProofFormat = exports.ProductPreviewFormat = exports.ItemSourceType = exports.ItemType = exports.PlaceholderItemContentType = exports.ProductPatchType = exports.DesignElementType = exports.ImagePreviewFitMode = exports.ImagePreviewFormat = exports.ColorSpace = exports.DesignAtomsViewerApiClient = exports.DesignAtomsServiceApiClient = exports.DesignAtomsMockups3dApiClient = exports.DesignAtomsImagesApiClient = exports.DesignAtomsCompatibilityApiClient = exports.BuildInfoApiClient = exports.ApiClientBase = exports.ApiClientConfiguration = void 0;
 const axios_1 = require("axios");
 class ApiClientConfiguration {
     apiUrl;
@@ -63,7 +63,7 @@ class BuildInfoApiClient extends ApiClientBase {
         this.baseUrl = baseUrl !== undefined && baseUrl !== null ? baseUrl : this.getBaseUrl("");
     }
     /**
-     * Gets assembly build info
+     * Get assembly build info.
      * @return Success
      */
     headInfo(cancelToken) {
@@ -116,7 +116,7 @@ class BuildInfoApiClient extends ApiClientBase {
         return Promise.resolve(null);
     }
     /**
-     * Gets assembly build info
+     * Get assembly build info.
      * @return Success
      */
     getInfo(cancelToken) {
@@ -2929,6 +2929,91 @@ class DesignAtomsServiceApiClient extends ApiClientBase {
         }
         return Promise.resolve(null);
     }
+    /**
+     * 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, privateStorageOwner, tenantId, cancelToken) {
+        let url_ = this.baseUrl + "/api/atoms/v1/designs/{id}/parameters?";
+        if (id === undefined || id === null)
+            throw new Error("The parameter 'id' must be defined.");
+        url_ = url_.replace("{id}", encodeURIComponent("" + id));
+        if (privateStorageOwner !== undefined && privateStorageOwner !== null)
+            url_ += "privateStorageOwner=" + encodeURIComponent("" + privateStorageOwner) + "&";
+        if (tenantId === null)
+            throw new Error("The parameter 'tenantId' cannot be null.");
+        else if (tenantId !== undefined)
+            url_ += "tenantId=" + encodeURIComponent("" + tenantId) + "&";
+        url_ = url_.replace(/[?&]$/, "");
+        let options_ = {
+            method: "GET",
+            url: url_,
+            headers: {
+                "Accept": "application/json"
+            },
+            cancelToken
+        };
+        return this.transformOptions(options_).then(transformedOptions_ => {
+            return this.instance.request(transformedOptions_);
+        }).catch((_error) => {
+            if (isAxiosError(_error) && _error.response) {
+                return _error.response;
+            }
+            else {
+                throw _error;
+            }
+        }).then((_response) => {
+            return this.transformResult(url_, _response, (_response) => this.processGetDesignParameters(_response));
+        });
+    }
+    processGetDesignParameters(response) {
+        const status = response.status;
+        let _headers = {};
+        if (response.headers && typeof response.headers === "object") {
+            for (let k in response.headers) {
+                if (response.headers.hasOwnProperty(k)) {
+                    _headers[k] = response.headers[k];
+                }
+            }
+        }
+        if (status === 200) {
+            const _responseText = response.data;
+            let result200 = null;
+            let resultData200 = _responseText;
+            result200 = JSON.parse(resultData200);
+            return Promise.resolve(result200);
+        }
+        else if (status === 404) {
+            const _responseText = response.data;
+            let result404 = null;
+            let resultData404 = _responseText;
+            result404 = JSON.parse(resultData404);
+            return throwException("Not Found", status, _responseText, _headers, result404);
+        }
+        else if (status === 401) {
+            const _responseText = response.data;
+            return throwException("Unauthorized", status, _responseText, _headers);
+        }
+        else if (status === 403) {
+            const _responseText = response.data;
+            return throwException("Forbidden", status, _responseText, _headers);
+        }
+        else if (status === 500) {
+            const _responseText = response.data;
+            let result500 = null;
+            let resultData500 = _responseText;
+            result500 = JSON.parse(resultData500);
+            return throwException("Internal server error", status, _responseText, _headers, result500);
+        }
+        else if (status !== 200 && status !== 204) {
+            const _responseText = response.data;
+            return throwException("An unexpected server error occurred.", status, _responseText, _headers);
+        }
+        return Promise.resolve(null);
+    }
     /**
      * Loads data schema from design file taken from storage
      * @param id Design identifier
@@ -6019,6 +6104,14 @@ var ImagePreviewFormat;
     ImagePreviewFormat["Jpeg"] = "Jpeg";
     ImagePreviewFormat["Png"] = "Png";
 })(ImagePreviewFormat = exports.ImagePreviewFormat || (exports.ImagePreviewFormat = {}));
+/** Image preview fit mode. */
+var ImagePreviewFitMode;
+(function (ImagePreviewFitMode) {
+    ImagePreviewFitMode["Fit"] = "Fit";
+    ImagePreviewFitMode["Shrink"] = "Shrink";
+    ImagePreviewFitMode["Resize"] = "Resize";
+    ImagePreviewFitMode["Fill"] = "Fill";
+})(ImagePreviewFitMode = exports.ImagePreviewFitMode || (exports.ImagePreviewFitMode = {}));
 var DesignElementType;
 (function (DesignElementType) {
     DesignElementType["Product"] = "Product";