@aurigma/axios-storefront-api-client 2.30.6 → 2.32.1

package/dist/cjs/storefront-api-client.d.ts

@@ -286,6 +286,20 @@ export interface IProjectsApiClient {
      * @return Success
      */
     delete(id: number, tenantId?: number | null | undefined): Promise<void>;
+    /**
+     * Returns a project preview file by project identifier.
+     * @param id Project identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    getPreview(id: number, tenantId?: number | null | undefined): Promise<FileResponse>;
+    /**
+     * Returns a project preview URL by project identifier.
+     * @param id Project identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    getPreviewUrl(id: number, tenantId?: number | null | undefined): Promise<string>;
     /**
      * Creates a new project by 'Render HiRes' scenario.
      * @param storefrontId Storefront identifier.
@@ -434,6 +448,22 @@ export declare class ProjectsApiClient extends ApiClientBase implements IProject
      */
     delete(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
     protected processDelete(response: AxiosResponse): Promise<void>;
+    /**
+     * Returns a project preview file by project identifier.
+     * @param id Project identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    getPreview(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<FileResponse>;
+    protected processGetPreview(response: AxiosResponse): Promise<FileResponse>;
+    /**
+     * Returns a project preview URL by project identifier.
+     * @param id Project identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    getPreviewUrl(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<string>;
+    protected processGetPreviewUrl(response: AxiosResponse): Promise<string>;
     /**
      * Creates a new project by 'Render HiRes' scenario.
      * @param storefrontId Storefront identifier.
@@ -949,6 +979,8 @@ export interface ProjectItemResourceParametersDto {
     name?: string | null;
     /** Resource type. */
     type?: ProjectItemResourceType;
+    /** Original resource identifier. */
+    resourceId?: string | null;
 }
 /** Dto class, containing create operation paramters for a project item. */
 export interface ProjectItemParametersDto {

package/dist/cjs/storefront-api-client.js

@@ -1294,6 +1294,152 @@ class ProjectsApiClient extends ApiClientBase {
         }
         return Promise.resolve(null);
     }
+    /**
+     * Returns a project preview file by project identifier.
+     * @param id Project identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    getPreview(id, tenantId, cancelToken) {
+        let url_ = this.baseUrl + "/api/storefront/v1/projects/{id}/preview?";
+        if (id === undefined || id === null)
+            throw new Error("The parameter 'id' must be defined.");
+        url_ = url_.replace("{id}", encodeURIComponent("" + id));
+        if (tenantId !== undefined && tenantId !== null)
+            url_ += "tenantId=" + encodeURIComponent("" + tenantId) + "&";
+        url_ = url_.replace(/[?&]$/, "");
+        let options_ = {
+            responseType: "blob",
+            method: "GET",
+            url: url_,
+            headers: {
+                "Accept": "text/plain"
+            },
+            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.processGetPreview(_response));
+        });
+    }
+    processGetPreview(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);
+    }
+    /**
+     * Returns a project preview URL by project identifier.
+     * @param id Project identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    getPreviewUrl(id, tenantId, cancelToken) {
+        let url_ = this.baseUrl + "/api/storefront/v1/projects/{id}/preview-url?";
+        if (id === undefined || id === null)
+            throw new Error("The parameter 'id' must be defined.");
+        url_ = url_.replace("{id}", encodeURIComponent("" + id));
+        if (tenantId !== undefined && tenantId !== null)
+            url_ += "tenantId=" + encodeURIComponent("" + tenantId) + "&";
+        url_ = url_.replace(/[?&]$/, "");
+        let options_ = {
+            method: "GET",
+            url: url_,
+            headers: {
+                "Accept": "text/plain"
+            },
+            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.processGetPreviewUrl(_response));
+        });
+    }
+    processGetPreviewUrl(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 !== 200 && status !== 204) {
+            const _responseText = response.data;
+            return throwException("An unexpected server error occurred.", status, _responseText, _headers);
+        }
+        return Promise.resolve(null);
+    }
     /**
      * Creates a new project by 'Render HiRes' scenario.
      * @param storefrontId Storefront identifier.