@aurigma/axios-storefront-api-client 2.16.1 → 2.17.1

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

@@ -97,6 +97,18 @@ export interface IProductReferencesApiClient {
      * @return Success
      */
     getProductConfig(reference: string | null, storefrontId: number, tenantId?: number | null | undefined): Promise<string>;
+    /**
+     * Returns a product cost details from ecommerce system.
+     * @param reference Product reference - external reference to Customer's Canvas product product specification, e.g online store product identifier.
+     * @param sku Product SKU.
+     * @param storefrontId Storefront identifier.
+     * @param storefrontUserId (optional) Storefront user identifier.
+     * @param currencyCode (optional) Product cost currency code.
+     * @param quantity (optional) Product quantity.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    getProductCostDetails(reference: string | null, sku: string, storefrontId: number, storefrontUserId?: string | null | undefined, currencyCode?: string | null | undefined, quantity?: number | undefined, tenantId?: number | null | undefined): Promise<ProductCostDetailsDto>;
 }
 export declare class ProductReferencesApiClient extends ApiClientBase implements IProductReferencesApiClient {
     private instance;
@@ -162,6 +174,19 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements
      */
     getProductConfig(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<string>;
     protected processGetProductConfig(response: AxiosResponse): Promise<string>;
+    /**
+     * Returns a product cost details from ecommerce system.
+     * @param reference Product reference - external reference to Customer's Canvas product product specification, e.g online store product identifier.
+     * @param sku Product SKU.
+     * @param storefrontId Storefront identifier.
+     * @param storefrontUserId (optional) Storefront user identifier.
+     * @param currencyCode (optional) Product cost currency code.
+     * @param quantity (optional) Product quantity.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    getProductCostDetails(reference: string | null, sku: string, storefrontId: number, storefrontUserId?: string | null | undefined, currencyCode?: string | null | undefined, quantity?: number | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductCostDetailsDto>;
+    protected processGetProductCostDetails(response: AxiosResponse): Promise<ProductCostDetailsDto>;
 }
 export interface IProductSpecificationsApiClient {
     /**
@@ -703,6 +728,25 @@ export interface ProductSpecificationDto {
     /** Product specification modification time. */
     lastModified?: string | null;
 }
+/** Dto class, containing information about storefront product cost details. */
+export interface ProductCostDetailsDto {
+    /** Product reference is an external reference to Customer's Canvas product specification, e.g online store product identifier. */
+    productReference?: string | null;
+    /** Product SKU. */
+    productSku?: string | null;
+    /** Product quantity. */
+    productQuantity?: number;
+    /** Product price. */
+    productPrice?: number;
+    /** Product cost. */
+    productCost?: number;
+    /** Product discount. */
+    productDiscount?: number;
+    /** Currency code. */
+    currencyCode?: string | null;
+    /** Tenant identifier. */
+    tenantId?: number;
+}
 /** Paged list of items. */
 export interface PagedOfProductSpecificationDto {
     /** Items count. */
@@ -717,6 +761,20 @@ export declare enum DatePeriod {
     Last7Days = "Last7Days",
     Last30Days = "Last30Days"
 }
+/** Available product resource types */
+export declare enum ProjectProductResourceType {
+    _0 = 0,
+    _1 = 1,
+    _2 = 2
+}
+/** Dto class, containing information about a project item resource. */
+export interface ProjectItemResourceDto {
+    /** Resource ID. */
+    resourceId?: string | null;
+    /** Resource name. */
+    name?: string | null;
+    type?: ProjectProductResourceType;
+}
 /** Dto class, containing information about a project item. */
 export interface ProjectItemDto {
     /** Item name. */
@@ -733,6 +791,8 @@ export interface ProjectItemDto {
     designIds?: string[] | null;
     /** SKU. */
     sku?: string | null;
+    /** External resources descriptions. */
+    resources?: ProjectItemResourceDto[] | null;
 }
 /** Dto class, containing information about a project. */
 export interface ProjectDto {
@@ -780,6 +840,33 @@ export interface PagedOfProjectDto {
     /** Items list. */
     items?: ProjectDto[] | null;
 }
+/** Dto class, containing create operation paramters for a project item resource. */
+export interface ProjectItemResourceParametersDto {
+    /** Resource URL. */
+    url?: string | null;
+    /** Resource name. */
+    name?: string | null;
+    type?: ProjectProductResourceType;
+}
+/** Dto class, containing create operation paramters for a project item. */
+export interface ProjectItemParametersDto {
+    /** Item name. */
+    name?: string | null;
+    /** Item quantity information. */
+    quantity?: number | null;
+    /** Item information. */
+    fields?: {
+        [key: string]: any;
+    } | null;
+    /** Additional item information. */
+    hidden?: any | null;
+    /** A list of design identifiers associated to the item. */
+    designIds?: string[] | null;
+    /** SKU. */
+    sku?: string | null;
+    /** External resources descriptions. */
+    resources?: ProjectItemResourceParametersDto[] | null;
+}
 /** Dto class, containing create operation parameters for project entity. */
 export interface CreateProjectDto {
     /** Product reference (i.e external reference to Customer's Canvas product specification - main subject of this project). */
@@ -803,7 +890,7 @@ export interface CreateProjectDto {
     /** Project owner identifier. */
     ownerId: string;
     /** List of project items. */
-    items?: ProjectItemDto[] | null;
+    items?: ProjectItemParametersDto[] | null;
     /** Description of the project. */
     description?: string | null;
 }

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.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.ProjectProductResourceType = 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;
@@ -636,6 +636,100 @@ class ProductReferencesApiClient extends ApiClientBase {
         }
         return Promise.resolve(null);
     }
+    /**
+     * Returns a product cost details from ecommerce system.
+     * @param reference Product reference - external reference to Customer's Canvas product product specification, e.g online store product identifier.
+     * @param sku Product SKU.
+     * @param storefrontId Storefront identifier.
+     * @param storefrontUserId (optional) Storefront user identifier.
+     * @param currencyCode (optional) Product cost currency code.
+     * @param quantity (optional) Product quantity.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    getProductCostDetails(reference, sku, storefrontId, storefrontUserId, currencyCode, quantity, tenantId, cancelToken) {
+        let url_ = this.baseUrl + "/api/storefront/v1/product-references/{reference}/product-cost-details?";
+        if (reference === undefined || reference === null)
+            throw new Error("The parameter 'reference' must be defined.");
+        url_ = url_.replace("{reference}", encodeURIComponent("" + reference));
+        if (sku === undefined || sku === null)
+            throw new Error("The parameter 'sku' must be defined and cannot be null.");
+        else
+            url_ += "sku=" + encodeURIComponent("" + sku) + "&";
+        if (storefrontId === undefined || storefrontId === null)
+            throw new Error("The parameter 'storefrontId' must be defined and cannot be null.");
+        else
+            url_ += "storefrontId=" + encodeURIComponent("" + storefrontId) + "&";
+        if (storefrontUserId !== undefined && storefrontUserId !== null)
+            url_ += "storefrontUserId=" + encodeURIComponent("" + storefrontUserId) + "&";
+        if (currencyCode !== undefined && currencyCode !== null)
+            url_ += "currencyCode=" + encodeURIComponent("" + currencyCode) + "&";
+        if (quantity === null)
+            throw new Error("The parameter 'quantity' cannot be null.");
+        else if (quantity !== undefined)
+            url_ += "quantity=" + encodeURIComponent("" + quantity) + "&";
+        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.processGetProductCostDetails(_response));
+        });
+    }
+    processGetProductCostDetails(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);
+    }
 }
 exports.ProductReferencesApiClient = ProductReferencesApiClient;
 class ProductSpecificationsApiClient extends ApiClientBase {
@@ -2605,6 +2699,13 @@ var DatePeriod;
     DatePeriod["Last7Days"] = "Last7Days";
     DatePeriod["Last30Days"] = "Last30Days";
 })(DatePeriod = exports.DatePeriod || (exports.DatePeriod = {}));
+/** Available product resource types */
+var ProjectProductResourceType;
+(function (ProjectProductResourceType) {
+    ProjectProductResourceType[ProjectProductResourceType["_0"] = 0] = "_0";
+    ProjectProductResourceType[ProjectProductResourceType["_1"] = 1] = "_1";
+    ProjectProductResourceType[ProjectProductResourceType["_2"] = 2] = "_2";
+})(ProjectProductResourceType = exports.ProjectProductResourceType || (exports.ProjectProductResourceType = {}));
 /** Storefront types. */
 var StorefrontType;
 (function (StorefrontType) {