@aurigma/axios-storefront-api-client - npm Package Compare versions

Comparing version 2.16.1 to 2.17.1

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

@@ -100,2 +100,14 @@ import { AxiosInstance, AxiosRequestConfig, AxiosResponse, CancelToken } from 'axios';
     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>;
 }
@@ -166,2 +178,15 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements IProductReferencesApiClient {
     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>;
 }
@@ -708,2 +733,21 @@ export interface IProductSpecificationsApiClient {
 }
+/** 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. */
@@ -723,2 +767,16 @@ export interface PagedOfProductSpecificationDto {
 }
+/** 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. */
@@ -740,2 +798,4 @@ export interface ProjectItemDto {
     sku?: string | null;
+    /** External resources descriptions. */
+    resources?: ProjectItemResourceDto[] | null;
 }
@@ -788,2 +848,29 @@ /** Dto class, containing information about a project. */
 }
+/** 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. */
@@ -812,3 +899,3 @@ export interface CreateProjectDto {
     /** List of project items. */
-    items?: ProjectItemDto[] | null;
+    items?: ProjectItemParametersDto[] | null;
     /** Description of the project. */
@@ -815,0 +902,0 @@ description?: string | null;

dist/esm/storefront-api-client.d.ts

@@ -100,2 +100,14 @@ import { AxiosInstance, AxiosRequestConfig, AxiosResponse, CancelToken } from 'axios';
     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>;
 }
@@ -166,2 +178,15 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements IProductReferencesApiClient {
     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>;
 }
@@ -708,2 +733,21 @@ export interface IProductSpecificationsApiClient {
 }
+/** 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. */
@@ -723,2 +767,16 @@ export interface PagedOfProductSpecificationDto {
 }
+/** 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. */
@@ -740,2 +798,4 @@ export interface ProjectItemDto {
     sku?: string | null;
+    /** External resources descriptions. */
+    resources?: ProjectItemResourceDto[] | null;
 }
@@ -788,2 +848,29 @@ /** Dto class, containing information about a project. */
 }
+/** 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. */
@@ -812,3 +899,3 @@ export interface CreateProjectDto {
     /** List of project items. */
-    items?: ProjectItemDto[] | null;
+    items?: ProjectItemParametersDto[] | null;
     /** Description of the project. */
@@ -815,0 +902,0 @@ description?: string | null;

package.json

 {
     "name": "@aurigma/axios-storefront-api-client",
-    "version": "2.16.1",
+    "version": "2.17.1",
     "license": "SEE LICENSE IN License.md",
@@ -5,0 +5,0 @@ "description": "Axios API Client for Storefront API service of Customer's Canvas web-to-print system.",

No alert changes

Improved metrics

Total package byte prevSize

527001

increased by4.89%

Lines of code

7624

increased by5.22%

No dependency changes