@aurigma/axios-design-atoms-api-client 2.26.1 → 2.26.7

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
@@ -510,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
@@ -1110,6 +1129,20 @@ 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;
+}
 /** Available patch type */
 export declare enum ProductPatchType {
     Undefined = "Undefined",

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.ProductPatchType = exports.DesignAtomsViewerApiClient = exports.DesignAtomsServiceApiClient = exports.DesignAtomsCompatibilityApiClient = exports.BuildInfoApiClient = exports.ApiClientBase = exports.ApiClientConfiguration = void 0;
+exports.ApiException = exports.ProductProofInterpolationMode = exports.ProductProofFormat = exports.ProductPreviewFormat = exports.ItemSourceType = exports.ItemType = exports.ProductPatchType = exports.DesignElementType = exports.DesignAtomsViewerApiClient = exports.DesignAtomsServiceApiClient = exports.DesignAtomsCompatibilityApiClient = exports.BuildInfoApiClient = exports.ApiClientBase = exports.ApiClientConfiguration = void 0;
 const axios_1 = require("axios");
 class ApiClientConfiguration {
     apiUrl;
@@ -1731,6 +1731,87 @@ class DesignAtomsServiceApiClient extends ApiClientBase {
         }
         return Promise.resolve(null);
     }
+    /**
+     * 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, surfaceIndex, privateStorageOwner, tenantId, cancelToken) {
+        let url_ = this.baseUrl + "/api/atoms/v1/designs/{id}/background?";
+        if (id === undefined || id === null)
+            throw new Error("The parameter 'id' must be defined.");
+        url_ = url_.replace("{id}", encodeURIComponent("" + id));
+        if (surfaceIndex !== undefined && surfaceIndex !== null)
+            url_ += "surfaceIndex=" + encodeURIComponent("" + surfaceIndex) + "&";
+        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_ = {
+            responseType: "blob",
+            method: "GET",
+            url: url_,
+            headers: {
+                "Accept": "application/octet-stream"
+            },
+            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.processExtractBackground(_response));
+        });
+    }
+    processExtractBackground(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 || status === 206) {
+            const contentDisposition = response.headers ? response.headers["content-disposition"] : undefined;
+            const fileNameMatch = contentDisposition ? /filename="?([^"]*?)"?(;|$)/g.exec(contentDisposition) : undefined;
+            const fileName = fileNameMatch && fileNameMatch.length > 1 ? fileNameMatch[1] : undefined;
+            return Promise.resolve({ fileName: fileName, status: status, data: new Blob([response.data]), headers: _headers });
+        }
+        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 !== 200 && status !== 204) {
+            const _responseText = response.data;
+            return throwException("An unexpected server error occurred.", status, _responseText, _headers);
+        }
+        return Promise.resolve(null);
+    }
     /**
      * Loads product (design model) from design file taken from storage
      * @param id Design identifier
@@ -4387,6 +4468,15 @@ class DesignAtomsViewerApiClient extends ApiClientBase {
     }
 }
 exports.DesignAtomsViewerApiClient = DesignAtomsViewerApiClient;
+var DesignElementType;
+(function (DesignElementType) {
+    DesignElementType["Product"] = "Product";
+    DesignElementType["Design"] = "Design";
+    DesignElementType["Surface"] = "Surface";
+    DesignElementType["Container"] = "Container";
+    DesignElementType["PrintArea"] = "PrintArea";
+    DesignElementType["Item"] = "Item";
+})(DesignElementType = exports.DesignElementType || (exports.DesignElementType = {}));
 /** Available patch type */
 var ProductPatchType;
 (function (ProductPatchType) {