@aurigma/axios-storefront-api-client 2.63.14 → 2.66.1

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

@@ -704,7 +704,7 @@ export interface IProductsApiClient {
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    getProductSummary(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined): Promise<PersonalizationParametersDto>;
+    getPersonalizationParameters(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined): Promise<PersonalizationParametersDto>;
     /**
      * Returns a product summary by product identifier.
      * @param id Product identifier.
@@ -715,7 +715,7 @@ export interface IProductsApiClient {
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    getProductSummary2(id: number, productVersionId?: number | null | undefined, productLinkId?: number | null | undefined, productVariantId?: number | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined): Promise<ProductSummaryDto>;
+    getProductSummary(id: number, productVersionId?: number | null | undefined, productLinkId?: number | null | undefined, productVariantId?: number | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined): Promise<ProductSummaryDto>;
     /**
      * Returns a list of product options.
      * @param id Product identifier.
@@ -889,8 +889,8 @@ export declare class ProductsApiClient extends ApiClientBase implements IProduct
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    getProductSummary(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PersonalizationParametersDto>;
-    protected processGetProductSummary(response: AxiosResponse): Promise<PersonalizationParametersDto>;
+    getPersonalizationParameters(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PersonalizationParametersDto>;
+    protected processGetPersonalizationParameters(response: AxiosResponse): Promise<PersonalizationParametersDto>;
     /**
      * Returns a product summary by product identifier.
      * @param id Product identifier.
@@ -901,8 +901,8 @@ export declare class ProductsApiClient extends ApiClientBase implements IProduct
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    getProductSummary2(id: number, productVersionId?: number | null | undefined, productLinkId?: number | null | undefined, productVariantId?: number | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductSummaryDto>;
-    protected processGetProductSummary2(response: AxiosResponse): Promise<ProductSummaryDto>;
+    getProductSummary(id: number, productVersionId?: number | null | undefined, productLinkId?: number | null | undefined, productVariantId?: number | null | undefined, sku?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductSummaryDto>;
+    protected processGetProductSummary(response: AxiosResponse): Promise<ProductSummaryDto>;
     /**
      * Returns a list of product options.
      * @param id Product identifier.
@@ -1212,7 +1212,7 @@ export interface IProjectsApiClient {
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    getAvailableTransitions(id: number, tenantId?: number | null | undefined): Promise<PagedOfProjectTransitionDto>;
+    getAvailableTransitions(id: number, tenantId?: number | null | undefined): Promise<PagedOfProjectStatusTransitionDto>;
     /**
      * Changes the project status.
      * @param id Project identifier
@@ -1248,7 +1248,7 @@ export interface IProjectsApiClient {
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    getAllTransitions(tenantId?: number | null | undefined): Promise<PagedOfProjectTransitionDto>;
+    getAllTransitions(tenantId?: number | null | undefined): Promise<PagedOfProjectStatusTransitionDto>;
     /**
      * Returns a project processing results.
      * @param id Project identifier.
@@ -1388,8 +1388,8 @@ export declare class ProjectsApiClient extends ApiClientBase implements IProject
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    getAvailableTransitions(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProjectTransitionDto>;
-    protected processGetAvailableTransitions(response: AxiosResponse): Promise<PagedOfProjectTransitionDto>;
+    getAvailableTransitions(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProjectStatusTransitionDto>;
+    protected processGetAvailableTransitions(response: AxiosResponse): Promise<PagedOfProjectStatusTransitionDto>;
     /**
      * Changes the project status.
      * @param id Project identifier
@@ -1429,8 +1429,8 @@ export declare class ProjectsApiClient extends ApiClientBase implements IProject
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    getAllTransitions(tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProjectTransitionDto>;
-    protected processGetAllTransitions(response: AxiosResponse): Promise<PagedOfProjectTransitionDto>;
+    getAllTransitions(tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProjectStatusTransitionDto>;
+    protected processGetAllTransitions(response: AxiosResponse): Promise<PagedOfProjectStatusTransitionDto>;
     /**
      * Returns a project processing results.
      * @param id Project identifier.
@@ -1485,10 +1485,11 @@ export interface IStorefrontsApiClient {
      * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
      * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
      * @param search (optional) Search string for partial match.
+     * @param status (optional) Storefront status.
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    getAll(types?: StorefrontType[] | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfStorefrontDto>;
+    getAll(types?: StorefrontType[] | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, status?: StorefrontStatus | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfStorefrontDto>;
     /**
      * Returns a storefront by identifier.
      * @param id Storefront identifier.
@@ -1509,10 +1510,11 @@ export declare class StorefrontsApiClient extends ApiClientBase implements IStor
      * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
      * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
      * @param search (optional) Search string for partial match.
+     * @param status (optional) Storefront status.
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    getAll(types?: StorefrontType[] | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfStorefrontDto>;
+    getAll(types?: StorefrontType[] | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, status?: StorefrontStatus | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfStorefrontDto>;
     protected processGetAll(response: AxiosResponse): Promise<PagedOfStorefrontDto>;
     /**
      * Returns a storefront by identifier.
@@ -2610,6 +2612,8 @@ export interface ProjectDto {
     orderUrl?: string | null;
     /** Order number in ecommerce system. */
     orderNumber?: number | null;
+    /** Order name in ecommerce system. */
+    orderName?: string | null;
     /** Order item identifier from storefront order. */
     orderLineItemId?: string | null;
     /** Order item index from storefront order. */
@@ -2717,6 +2721,8 @@ export interface CreateSingleItemProjectDto {
     orderUrl?: string | null;
     /** Order number in ecommerce system. */
     orderNumber?: number | null;
+    /** Order name in ecommerce system. */
+    orderName?: string | null;
     /** Customer identifier in ecommerce system. */
     customerId?: string | null;
     /** Customer name in ecommerce system. */
@@ -2738,6 +2744,8 @@ export interface CreateMultiItemProjectDto {
     orderUrl?: string | null;
     /** Order number in ecommerce system. */
     orderNumber?: number | null;
+    /** Order name in ecommerce system. */
+    orderName?: string | null;
     /** Customer identifier in ecommerce system. */
     customerId?: string | null;
     /** Customer name in ecommerce system. */
@@ -2759,6 +2767,8 @@ export interface OrderDetailsDto {
     orderUrl?: string | null;
     /** Order number in ecommerce system. */
     orderNumber?: number | null;
+    /** Order name in ecommerce system. */
+    orderName?: string | null;
     /** Line item index from ecommerce system order. */
     orderLineItemIndex?: number | null;
     /** Line Item identifier from ecommerce system order. */
@@ -2857,8 +2867,10 @@ export interface CreateProjectBySpecificPipelineScenarioDto {
     /** 'Specific Pipeline' scenario params. For more information check BackOffice.Web.PublicApi.ApiStorefront.Models.SpecificPipelineScenarioDto. */
     scenario: SpecificPipelineScenarioDto;
 }
-/** Project transition dto class. */
-export interface ProjectTransitionDto {
+/** Project status transition dto class. */
+export interface ProjectStatusTransitionDto {
+    /** Transition identifier. */
+    id?: number;
     /** Transition identifying name. */
     name?: string | null;
     /** Transition display name. */
@@ -2869,23 +2881,27 @@ export interface ProjectTransitionDto {
     resultStatus?: number;
 }
 /** Paged list of items. */
-export interface PagedOfProjectTransitionDto {
+export interface PagedOfProjectStatusTransitionDto {
     /** Items count. */
     total?: number;
     /** Items list. */
-    items?: ProjectTransitionDto[] | null;
+    items?: ProjectStatusTransitionDto[] | null;
 }
-/** Dto class, containing the information about project status. */
+/** Project status parameters. */
 export interface ProjectStatusDto {
+    /** Project status identifier. */
+    id?: number;
     /** Status code. */
     code?: number;
+    /** Status mark color. */
+    color?: string | null;
     /** Status display name. */
     displayName?: string | null;
 }
-/** Dto class, containing information about the project transition conflict. */
-export interface ProjectTransitionConflictDto {
+/** Dto class, containing information about the project status transition conflict. */
+export interface ProjectStatusTransitionConflictDto {
     /** A list of all available status transitions for the project. */
-    availableTransitions?: ProjectTransitionDto[] | null;
+    availableTransitions?: ProjectStatusTransitionDto[] | null;
     /** Problem description. */
     description?: string | null;
     /** Coflict type. */
@@ -2961,6 +2977,11 @@ export declare enum StorefrontType {
     Shopify = "Shopify",
     ShopifyCustom = "ShopifyCustom"
 }
+/** Storefront status. */
+export declare enum StorefrontStatus {
+    Dev = "Dev",
+    Prod = "Prod"
+}
 /** Dto class, containing information about a storefront. */
 export interface StorefrontDto {
     /** Storefront identifier. */
@@ -2973,6 +2994,8 @@ export interface StorefrontDto {
     type?: StorefrontType;
     /** Storefront entity creation date and time. */
     created?: string;
+    /** Storefront status. */
+    status?: StorefrontStatus;
 }
 /** Paged list of items. */
 export interface PagedOfStorefrontDto {

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.RenderHiResScenarioOutputRotateMode = exports.RenderHiResScenarioOutputFlipMode = exports.RenderHiResScenarioOutputColorSpace = exports.RenderHiResScenarioOutputFormat = exports.ProjectItemProductType = exports.ProjectItemResourceType = exports.ProjectProcessingStatus = exports.DatePeriod = exports.SurfaceUsageType = exports.ProductVariantMockupType = exports.ProductVariantResourceType = exports.ProductReferenceType = exports.OptionType = exports.ProductLinkResourceType = exports.AppearanceDataType = exports.WorkflowType = exports.ProductType = exports.ConflictType = exports.ProductBundleResourceType = exports.TenantInfoApiClient = exports.StorefrontUsersApiClient = exports.StorefrontsApiClient = exports.ProjectsApiClient = exports.ProductSpecificationsApiClient = exports.ProductsApiClient = exports.ProductReferencesApiClient = exports.ProductLinksApiClient = exports.ProductBundlesApiClient = exports.ProcessingPipelinesApiClient = exports.BuildInfoApiClient = exports.ApiClientBase = exports.ApiClientConfiguration = void 0;
+exports.ApiException = exports.StorefrontStatus = exports.StorefrontType = exports.OrderDataItemValueType = exports.RenderHiResScenarioOutputRotateMode = exports.RenderHiResScenarioOutputFlipMode = exports.RenderHiResScenarioOutputColorSpace = exports.RenderHiResScenarioOutputFormat = exports.ProjectItemProductType = exports.ProjectItemResourceType = exports.ProjectProcessingStatus = exports.DatePeriod = exports.SurfaceUsageType = exports.ProductVariantMockupType = exports.ProductVariantResourceType = exports.ProductReferenceType = exports.OptionType = exports.ProductLinkResourceType = exports.AppearanceDataType = exports.WorkflowType = exports.ProductType = exports.ConflictType = exports.ProductBundleResourceType = exports.TenantInfoApiClient = exports.StorefrontUsersApiClient = exports.StorefrontsApiClient = exports.ProjectsApiClient = exports.ProductSpecificationsApiClient = exports.ProductsApiClient = exports.ProductReferencesApiClient = exports.ProductLinksApiClient = exports.ProductBundlesApiClient = exports.ProcessingPipelinesApiClient = exports.BuildInfoApiClient = exports.ApiClientBase = exports.ApiClientConfiguration = void 0;
 const axios_1 = require("axios");
 class ApiClientConfiguration {
     apiUrl;
@@ -2712,7 +2712,7 @@ class ProductsApiClient extends ApiClientBase {
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    getProductSummary(id, productVersionId, tenantId, cancelToken) {
+    getPersonalizationParameters(id, productVersionId, tenantId, cancelToken) {
         let url_ = this.baseUrl + "/api/storefront/v1/products/{id}/personalization-parameters?";
         if (id === undefined || id === null)
             throw new Error("The parameter 'id' must be defined.");
@@ -2740,10 +2740,10 @@ class ProductsApiClient extends ApiClientBase {
                 throw _error;
             }
         }).then((_response) => {
-            return this.transformResult(url_, _response, (_response) => this.processGetProductSummary(_response));
+            return this.transformResult(url_, _response, (_response) => this.processGetPersonalizationParameters(_response));
         });
     }
-    processGetProductSummary(response) {
+    processGetPersonalizationParameters(response) {
         const status = response.status;
         let _headers = {};
         if (response.headers && typeof response.headers === "object") {
@@ -2798,7 +2798,7 @@ class ProductsApiClient extends ApiClientBase {
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    getProductSummary2(id, productVersionId, productLinkId, productVariantId, sku, tenantId, cancelToken) {
+    getProductSummary(id, productVersionId, productLinkId, productVariantId, sku, tenantId, cancelToken) {
         let url_ = this.baseUrl + "/api/storefront/v1/products/{id}/summary?";
         if (id === undefined || id === null)
             throw new Error("The parameter 'id' must be defined.");
@@ -2832,10 +2832,10 @@ class ProductsApiClient extends ApiClientBase {
                 throw _error;
             }
         }).then((_response) => {
-            return this.transformResult(url_, _response, (_response) => this.processGetProductSummary2(_response));
+            return this.transformResult(url_, _response, (_response) => this.processGetProductSummary(_response));
         });
     }
-    processGetProductSummary2(response) {
+    processGetProductSummary(response) {
         const status = response.status;
         let _headers = {};
         if (response.headers && typeof response.headers === "object") {
@@ -5932,10 +5932,11 @@ class StorefrontsApiClient extends ApiClientBase {
      * @param take (optional) Defines page length (how many consequent items of sorted result list should be taken).
      * @param sorting (optional) Defines sorting order of result list e.g.: "Title ASC, LastModified DESC".
      * @param search (optional) Search string for partial match.
+     * @param status (optional) Storefront status.
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    getAll(types, skip, take, sorting, search, tenantId, cancelToken) {
+    getAll(types, skip, take, sorting, search, status, tenantId, cancelToken) {
         let url_ = this.baseUrl + "/api/storefront/v1/storefronts?";
         if (types !== undefined && types !== null)
             types && types.forEach(item => { url_ += "types=" + encodeURIComponent("" + item) + "&"; });
@@ -5947,6 +5948,8 @@ class StorefrontsApiClient extends ApiClientBase {
             url_ += "sorting=" + encodeURIComponent("" + sorting) + "&";
         if (search !== undefined && search !== null)
             url_ += "search=" + encodeURIComponent("" + search) + "&";
+        if (status !== undefined && status !== null)
+            url_ += "status=" + encodeURIComponent("" + status) + "&";
         if (tenantId !== undefined && tenantId !== null)
             url_ += "tenantId=" + encodeURIComponent("" + tenantId) + "&";
         url_ = url_.replace(/[?&]$/, "");
@@ -7016,6 +7019,12 @@ var StorefrontType;
     StorefrontType["Shopify"] = "Shopify";
     StorefrontType["ShopifyCustom"] = "ShopifyCustom";
 })(StorefrontType = exports.StorefrontType || (exports.StorefrontType = {}));
+/** Storefront status. */
+var StorefrontStatus;
+(function (StorefrontStatus) {
+    StorefrontStatus["Dev"] = "Dev";
+    StorefrontStatus["Prod"] = "Prod";
+})(StorefrontStatus = exports.StorefrontStatus || (exports.StorefrontStatus = {}));
 class ApiException extends Error {
     message;
     status;