@aurigma/axios-storefront-api-client 2.38.1 → 2.39.1

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

@@ -259,11 +259,12 @@ export interface IProjectsApiClient {
      * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
      * @param search (optional) Search string for partial match.
      * @param orderId (optional) Identifier of corresponding order.
+     * @param processingStatus (optional) Project processing status filter.
      * @param storefrontId (optional) Storefront identifier.
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    getAll(ownerId?: string | null | undefined, productReference?: string | null | undefined, status?: number | null | undefined, datePeriod?: DatePeriod | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, orderId?: string | null | undefined, storefrontId?: number | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProjectDto>;
+    getAll(ownerId?: string | null | undefined, productReference?: string | null | undefined, status?: number | null | undefined, datePeriod?: DatePeriod | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, orderId?: string | null | undefined, processingStatus?: ProjectProcessingStatus | null | undefined, storefrontId?: number | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProjectDto>;
     /**
      * Creates a new project.
      * @param storefrontId Storefront identifier.
@@ -308,6 +309,14 @@ export interface IProjectsApiClient {
      * @return Success
      */
     createByRenderHiResScenario(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProjectByRenderHiResScenarioDto | null | undefined): Promise<ProjectDto>;
+    /**
+     * Creates a new project by 'Specific Pipeline' scenario.
+     * @param storefrontId Storefront identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @param body (optional) Create operation parameters.
+     * @return Success
+     */
+    createBySpecificPipelineScenario(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProjectBySpecificPipelineScenarioDto | null | undefined): Promise<ProjectDto>;
     /**
      * Returns all available status transitions for a project.
      * @param id Project identifier.
@@ -417,11 +426,12 @@ export declare class ProjectsApiClient extends ApiClientBase implements IProject
      * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
      * @param search (optional) Search string for partial match.
      * @param orderId (optional) Identifier of corresponding order.
+     * @param processingStatus (optional) Project processing status filter.
      * @param storefrontId (optional) Storefront identifier.
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    getAll(ownerId?: string | null | undefined, productReference?: string | null | undefined, status?: number | null | undefined, datePeriod?: DatePeriod | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, orderId?: string | null | undefined, storefrontId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProjectDto>;
+    getAll(ownerId?: string | null | undefined, productReference?: string | null | undefined, status?: number | null | undefined, datePeriod?: DatePeriod | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, orderId?: string | null | undefined, processingStatus?: ProjectProcessingStatus | null | undefined, storefrontId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProjectDto>;
     protected processGetAll(response: AxiosResponse): Promise<PagedOfProjectDto>;
     /**
      * Creates a new project.
@@ -473,6 +483,15 @@ export declare class ProjectsApiClient extends ApiClientBase implements IProject
      */
     createByRenderHiResScenario(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProjectByRenderHiResScenarioDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectDto>;
     protected processCreateByRenderHiResScenario(response: AxiosResponse): Promise<ProjectDto>;
+    /**
+     * Creates a new project by 'Specific Pipeline' scenario.
+     * @param storefrontId Storefront identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @param body (optional) Create operation parameters.
+     * @return Success
+     */
+    createBySpecificPipelineScenario(storefrontId: number, tenantId?: number | null | undefined, body?: CreateProjectBySpecificPipelineScenarioDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProjectDto>;
+    protected processCreateBySpecificPipelineScenario(response: AxiosResponse): Promise<ProjectDto>;
     /**
      * Returns all available status transitions for a project.
      * @param id Project identifier.
@@ -891,6 +910,13 @@ export declare enum DatePeriod {
     Last7Days = "Last7Days",
     Last30Days = "Last30Days"
 }
+/** Available project processing statuses. */
+export declare enum ProjectProcessingStatus {
+    Pending = "Pending",
+    InProgress = "InProgress",
+    Completed = "Completed",
+    Failed = "Failed"
+}
 /** Available product resource types */
 export declare enum ProjectItemResourceType {
     General = "General",
@@ -963,6 +989,8 @@ export interface ProjectDto {
     lastModified?: string | null;
     /** Description of the project. */
     description?: string | null;
+    /** Project processing status. */
+    processingStatus?: ProjectProcessingStatus;
 }
 /** Paged list of items. */
 export interface PagedOfProjectDto {
@@ -982,7 +1010,7 @@ export interface ProjectItemResourceParametersDto {
     /** Original resource identifier. */
     resourceId?: string | null;
 }
-/** Dto class, containing create operation paramters for a project item. */
+/** Dto class, containing create operation parameters for a project item. */
 export interface ProjectItemParametersDto {
     /** Item name. */
     name?: string | null;
@@ -1062,7 +1090,7 @@ export declare enum RenderHiResScenarioOutputFlipMode {
     Vertical = "Vertical",
     Both = "Both"
 }
-/** Dto class, containing 'RenderHiRes' scenario paramters. */
+/** Dto class, containing 'RenderHiRes' scenario parameters. */
 export interface RenderHiResScenarioDto {
     /** Private design identifier. */
     designId: string;
@@ -1092,6 +1120,26 @@ export interface CreateProjectByRenderHiResScenarioDto {
     /** List of project items. */
     scenario: RenderHiResScenarioDto;
 }
+/** Dto class, containing 'Specific Pipeline' scenario parameters. */
+export interface SpecificPipelineScenarioDto {
+    /** An existing processing pipeline identifier. */
+    pipelineId?: number;
+}
+/** Dto class, containing 'create' operation parameters for a new project that should be created by executing 'Specific Pipeline' scenario. <seealso cref="T:BackOffice.Web.PublicApi.ApiStorefront.Models.CreateProjectDto" /> */
+export interface CreateProjectBySpecificPipelineScenarioDto {
+    /** Project owner identifier. */
+    ownerId: string;
+    /** Project name. */
+    name?: string | null;
+    /** Description of the project. */
+    description?: string | null;
+    /** Ecommerce system order description. */
+    orderDetails?: OrderDetailsDto | null;
+    /** List of project items. */
+    items?: ProjectItemParametersDto[] | null;
+    /** 'Specific Pipeline' scenario params. <seealso cref="T:BackOffice.Web.PublicApi.ApiStorefront.Models.SpecificPipelineScenarioDto" /> */
+    scenario: SpecificPipelineScenarioDto;
+}
 /** Project transition dto class. */
 export interface ProjectTransitionDto {
     /** Transition identifying name. */
@@ -1134,13 +1182,6 @@ export interface ProjectPdfResultDto {
     /** Project pdf url. */
     url?: string | null;
 }
-/** Available project processing statuses. */
-export declare enum ProjectProcessingStatus {
-    Pending = "Pending",
-    InProgress = "InProgress",
-    Completed = "Completed",
-    Failed = "Failed"
-}
 /** Dto class, containing description of a project output file. */
 export interface ProjectOutputFileDetailsDto {
     /** Project output file URL. */
@@ -1255,6 +1296,8 @@ export interface TenantApplicationsInfoDto {
     uiFrameworkUrl?: string | null;
     /** An url to the 'Simple editor'. */
     simpleEditorUrl?: string | null;
+    /** An url to the 'Handy editor'. */
+    handyEditorUrl?: string | null;
     /** An url to the 'Preflight' tenant application. */
     preflightUrl?: string | null;
     /** An url to the 'Dynamic Image' tenant application. */

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

@@ -8,7 +8,7 @@
 //----------------------
 // ReSharper disable InconsistentNaming
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiException = exports.StorefrontType = exports.OrderDataItemValueType = exports.ProjectProcessingStatus = exports.RenderHiResScenarioOutputFlipMode = exports.RenderHiResScenarioOutputColorSpace = exports.RenderHiResScenarioOutputFormat = exports.ProjectItemResourceType = exports.DatePeriod = exports.TenantInfoApiClient = exports.StorefrontUsersApiClient = exports.StorefrontsApiClient = exports.ProjectsApiClient = exports.ProductSpecificationsApiClient = exports.ProductReferencesApiClient = exports.BuildInfoApiClient = exports.ApiClientBase = exports.ApiClientConfiguration = void 0;
+exports.ApiException = exports.StorefrontType = exports.OrderDataItemValueType = exports.RenderHiResScenarioOutputFlipMode = exports.RenderHiResScenarioOutputColorSpace = exports.RenderHiResScenarioOutputFormat = exports.ProjectItemResourceType = exports.ProjectProcessingStatus = exports.DatePeriod = exports.TenantInfoApiClient = exports.StorefrontUsersApiClient = exports.StorefrontsApiClient = exports.ProjectsApiClient = exports.ProductSpecificationsApiClient = exports.ProductReferencesApiClient = exports.BuildInfoApiClient = exports.ApiClientBase = exports.ApiClientConfiguration = void 0;
 const axios_1 = require("axios");
 class ApiClientConfiguration {
     apiUrl;
@@ -621,14 +621,14 @@ class ProductReferencesApiClient extends ApiClientBase {
             const _responseText = response.data;
             let result200 = null;
             let resultData200 = _responseText;
-            result200 = JSON.parse(resultData200);
+            result200 = resultData200;
             return Promise.resolve(result200);
         }
         else if (status === 404) {
             const _responseText = response.data;
             let result404 = null;
             let resultData404 = _responseText;
-            result404 = JSON.parse(resultData404);
+            result404 = resultData404;
             return throwException("Not Found", status, _responseText, _headers, result404);
         }
         else if (status === 401) {
@@ -946,14 +946,14 @@ class ProductSpecificationsApiClient extends ApiClientBase {
             const _responseText = response.data;
             let result200 = null;
             let resultData200 = _responseText;
-            result200 = JSON.parse(resultData200);
+            result200 = resultData200;
             return Promise.resolve(result200);
         }
         else if (status === 404) {
             const _responseText = response.data;
             let result404 = null;
             let resultData404 = _responseText;
-            result404 = JSON.parse(resultData404);
+            result404 = resultData404;
             return throwException("Not Found", status, _responseText, _headers, result404);
         }
         else if (status === 401) {
@@ -992,11 +992,12 @@ class ProjectsApiClient extends ApiClientBase {
      * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
      * @param search (optional) Search string for partial match.
      * @param orderId (optional) Identifier of corresponding order.
+     * @param processingStatus (optional) Project processing status filter.
      * @param storefrontId (optional) Storefront identifier.
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    getAll(ownerId, productReference, status, datePeriod, skip, take, sorting, search, orderId, storefrontId, tenantId, cancelToken) {
+    getAll(ownerId, productReference, status, datePeriod, skip, take, sorting, search, orderId, processingStatus, storefrontId, tenantId, cancelToken) {
         let url_ = this.baseUrl + "/api/storefront/v1/projects?";
         if (ownerId !== undefined && ownerId !== null)
             url_ += "ownerId=" + encodeURIComponent("" + ownerId) + "&";
@@ -1018,6 +1019,8 @@ class ProjectsApiClient extends ApiClientBase {
             url_ += "search=" + encodeURIComponent("" + search) + "&";
         if (orderId !== undefined && orderId !== null)
             url_ += "orderId=" + encodeURIComponent("" + orderId) + "&";
+        if (processingStatus !== undefined && processingStatus !== null)
+            url_ += "processingStatus=" + encodeURIComponent("" + processingStatus) + "&";
         if (storefrontId !== undefined && storefrontId !== null)
             url_ += "storefrontId=" + encodeURIComponent("" + storefrontId) + "&";
         if (tenantId !== undefined && tenantId !== null)
@@ -1518,6 +1521,84 @@ class ProjectsApiClient extends ApiClientBase {
         }
         return Promise.resolve(null);
     }
+    /**
+     * Creates a new project by 'Specific Pipeline' scenario.
+     * @param storefrontId Storefront identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @param body (optional) Create operation parameters.
+     * @return Success
+     */
+    createBySpecificPipelineScenario(storefrontId, tenantId, body, cancelToken) {
+        let url_ = this.baseUrl + "/api/storefront/v1/projects/by-scenario/specific-pipeline?";
+        if (storefrontId === undefined || storefrontId === null)
+            throw new Error("The parameter 'storefrontId' must be defined and cannot be null.");
+        else
+            url_ += "storefrontId=" + encodeURIComponent("" + storefrontId) + "&";
+        if (tenantId !== undefined && tenantId !== null)
+            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-patch+json",
+                "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.processCreateBySpecificPipelineScenario(_response));
+        });
+    }
+    processCreateBySpecificPipelineScenario(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 === 201) {
+            const _responseText = response.data;
+            let result201 = null;
+            let resultData201 = _responseText;
+            result201 = JSON.parse(resultData201);
+            return Promise.resolve(result201);
+        }
+        else if (status === 409) {
+            const _responseText = response.data;
+            let result409 = null;
+            let resultData409 = _responseText;
+            result409 = JSON.parse(resultData409);
+            return throwException("Conflict", status, _responseText, _headers, result409);
+        }
+        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 all available status transitions for a project.
      * @param id Project identifier.
@@ -3285,6 +3366,14 @@ var DatePeriod;
     DatePeriod["Last7Days"] = "Last7Days";
     DatePeriod["Last30Days"] = "Last30Days";
 })(DatePeriod = exports.DatePeriod || (exports.DatePeriod = {}));
+/** Available project processing statuses. */
+var ProjectProcessingStatus;
+(function (ProjectProcessingStatus) {
+    ProjectProcessingStatus["Pending"] = "Pending";
+    ProjectProcessingStatus["InProgress"] = "InProgress";
+    ProjectProcessingStatus["Completed"] = "Completed";
+    ProjectProcessingStatus["Failed"] = "Failed";
+})(ProjectProcessingStatus = exports.ProjectProcessingStatus || (exports.ProjectProcessingStatus = {}));
 /** Available product resource types */
 var ProjectItemResourceType;
 (function (ProjectItemResourceType) {
@@ -3312,14 +3401,6 @@ var RenderHiResScenarioOutputFlipMode;
     RenderHiResScenarioOutputFlipMode["Vertical"] = "Vertical";
     RenderHiResScenarioOutputFlipMode["Both"] = "Both";
 })(RenderHiResScenarioOutputFlipMode = exports.RenderHiResScenarioOutputFlipMode || (exports.RenderHiResScenarioOutputFlipMode = {}));
-/** Available project processing statuses. */
-var ProjectProcessingStatus;
-(function (ProjectProcessingStatus) {
-    ProjectProcessingStatus["Pending"] = "Pending";
-    ProjectProcessingStatus["InProgress"] = "InProgress";
-    ProjectProcessingStatus["Completed"] = "Completed";
-    ProjectProcessingStatus["Failed"] = "Failed";
-})(ProjectProcessingStatus = exports.ProjectProcessingStatus || (exports.ProjectProcessingStatus = {}));
 /** Available value types for order data item. */
 var OrderDataItemValueType;
 (function (OrderDataItemValueType) {