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

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

@@ -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 {
     /**
@@ -627,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.
@@ -654,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
@@ -663,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').
@@ -842,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.
@@ -872,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
@@ -882,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').
@@ -1467,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;
@@ -1579,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",
@@ -1604,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",
@@ -1654,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 */

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

@@ -2090,6 +2090,81 @@ class DesignAtomsImagesApiClient extends ApiClientBase {
         }
         return Promise.resolve(null);
     }
+    /**
+     * 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, body, cancelToken) {
+        let url_ = this.baseUrl + "/api/atoms/v1/images/render-image-preview/to-resource?";
+        if (tenantId === null)
+            throw new Error("The parameter 'tenantId' cannot be null.");
+        else if (tenantId !== undefined)
+            url_ += "tenantId=" + encodeURIComponent("" + tenantId) + "&";
+        url_ = url_.replace(/[?&]$/, "");
+        const content_ = JSON.stringify(body);
+        let options_ = {
+            data: content_,
+            method: "POST",
+            url: url_,
+            headers: {
+                "Content-Type": "application/json",
+                "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.processRenderImagePreviewToResource(_response));
+        });
+    }
+    processRenderImagePreviewToResource(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 === 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);
+    }
 }
 exports.DesignAtomsImagesApiClient = DesignAtomsImagesApiClient;
 class DesignAtomsMockups3dApiClient extends ApiClientBase {
@@ -3728,6 +3803,81 @@ class DesignAtomsServiceApiClient extends ApiClientBase {
         }
         return Promise.resolve(null);
     }
+    /**
+     * Extracts product item image.
+     * @param tenantId (optional) Tenant identifier
+     * @param body (optional) Extraction parameters.
+     * @return Success
+     */
+    extractItemImage(tenantId, body, cancelToken) {
+        let url_ = this.baseUrl + "/api/atoms/v1/itemExtractor?";
+        if (tenantId === null)
+            throw new Error("The parameter 'tenantId' cannot be null.");
+        else if (tenantId !== undefined)
+            url_ += "tenantId=" + encodeURIComponent("" + tenantId) + "&";
+        url_ = url_.replace(/[?&]$/, "");
+        const content_ = JSON.stringify(body);
+        let options_ = {
+            data: content_,
+            responseType: "blob",
+            method: "POST",
+            url: url_,
+            headers: {
+                "Content-Type": "application/json",
+                "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.processExtractItemImage(_response));
+        });
+    }
+    processExtractItemImage(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 === 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);
+    }
     /**
      * Creates a private design from a public design.
      * @param designId (optional) Public design ID.
@@ -3957,6 +4107,81 @@ class DesignAtomsServiceApiClient extends ApiClientBase {
         }
         return Promise.resolve(null);
     }
+    /**
+     * 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, body, cancelToken) {
+        let url_ = this.baseUrl + "/api/atoms/v1/render-design-preview/to-resource?";
+        if (tenantId === null)
+            throw new Error("The parameter 'tenantId' cannot be null.");
+        else if (tenantId !== undefined)
+            url_ += "tenantId=" + encodeURIComponent("" + tenantId) + "&";
+        url_ = url_.replace(/[?&]$/, "");
+        const content_ = JSON.stringify(body);
+        let options_ = {
+            data: content_,
+            method: "POST",
+            url: url_,
+            headers: {
+                "Content-Type": "application/json",
+                "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.processRenderDesignPreviewToResource(_response));
+        });
+    }
+    processRenderDesignPreviewToResource(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 === 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);
+    }
     /**
      * 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
@@ -4036,6 +4261,81 @@ class DesignAtomsServiceApiClient extends ApiClientBase {
         }
         return Promise.resolve(null);
     }
+    /**
+     * 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, body, cancelToken) {
+        let url_ = this.baseUrl + "/api/atoms/v1/render-design-proof/to-resource?";
+        if (tenantId === null)
+            throw new Error("The parameter 'tenantId' cannot be null.");
+        else if (tenantId !== undefined)
+            url_ += "tenantId=" + encodeURIComponent("" + tenantId) + "&";
+        url_ = url_.replace(/[?&]$/, "");
+        const content_ = JSON.stringify(body);
+        let options_ = {
+            data: content_,
+            method: "POST",
+            url: url_,
+            headers: {
+                "Content-Type": "application/json",
+                "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.processRenderDesignProofToResource(_response));
+        });
+    }
+    processRenderDesignProofToResource(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 === 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);
+    }
     /**
      * 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').