@aurigma/axios-storefront-api-client 2.66.6 → 2.68.1

package/README.md

@@ -1,6 +1,6 @@
 # Aurigma Customer's Canvas SDK - Storefront API Client
 
-This module is an Axios API client for Storefront API service which is a part of [**Customer's Canvas**](https://customerscanvas.com) web-to-print system. It is supposed that you are familiar with its services and understand how to use its APIs. To learn more about Customer's Canvas and its services, refer the [Getting Started section of its documentation](https://customerscanvas.com/dev/getting-started/intro.html).
+This module is an Axios API client for Storefront API which is a part of [**Customer's Canvas**](https://customerscanvas.com) web-to-print system. It is supposed that you are familiar with its services and understand how to use its APIs. To learn more about Customer's Canvas and its services, refer the [Getting Started section of its documentation](https://customerscanvas.com/dev/getting-started/intro.html).
 
 The API client is automatically generated with [NSwag tool](https://github.com/RicoSuter/NSwag). If for any reasons this API client does not work well for you, feel free to generate it yourself using Swagger document published at [Customer's Canvas API Gateway](https://api.customerscanvashub.com/).
 

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

@@ -410,10 +410,11 @@ export interface IProductReferencesApiClient {
      * Returns a personalization parameters by the storefront product reference.
      * @param reference Product reference - external reference to Customer's Canvas product, e.g online store product identifier.
      * @param storefrontId Storefront identifier.
+     * @param designId (optional) Design identifier (for PIM products with design-specific workflows).
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    getPersonalizationParameters(reference: string | null, storefrontId: number, tenantId?: number | null | undefined): Promise<PersonalizationParametersDto>;
+    getPersonalizationParameters(reference: string | null, storefrontId: number, designId?: string | null | undefined, tenantId?: number | null | undefined): Promise<PersonalizationParametersDto>;
     /**
      * Returns a product specification by the storefront product reference.
      * @param reference Product reference - external reference to Customer's Canvas product, e.g online store product identifier.
@@ -600,10 +601,11 @@ export declare class ProductReferencesApiClient extends ApiClientBase implements
      * Returns a personalization parameters by the storefront product reference.
      * @param reference Product reference - external reference to Customer's Canvas product, e.g online store product identifier.
      * @param storefrontId Storefront identifier.
+     * @param designId (optional) Design identifier (for PIM products with design-specific workflows).
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    getPersonalizationParameters(reference: string | null, storefrontId: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PersonalizationParametersDto>;
+    getPersonalizationParameters(reference: string | null, storefrontId: number, designId?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PersonalizationParametersDto>;
     protected processGetPersonalizationParameters(response: AxiosResponse): Promise<PersonalizationParametersDto>;
     /**
      * Returns a product specification by the storefront product reference.
@@ -701,10 +703,11 @@ export interface IProductsApiClient {
      * Returns a product personalization parameters by product identifier.
      * @param id Product identifier.
      * @param productVersionId (optional) Product version identifier.
+     * @param designId (optional) Design identifier (for PIM products with design-specific workflows).
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    getPersonalizationParameters(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined): Promise<PersonalizationParametersDto>;
+    getPersonalizationParameters(id: number, productVersionId?: number | null | undefined, designId?: string | null | undefined, tenantId?: number | null | undefined): Promise<PersonalizationParametersDto>;
     /**
      * Returns a product summary by product identifier.
      * @param id Product identifier.
@@ -886,10 +889,11 @@ export declare class ProductsApiClient extends ApiClientBase implements IProduct
      * Returns a product personalization parameters by product identifier.
      * @param id Product identifier.
      * @param productVersionId (optional) Product version identifier.
+     * @param designId (optional) Design identifier (for PIM products with design-specific workflows).
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    getPersonalizationParameters(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PersonalizationParametersDto>;
+    getPersonalizationParameters(id: number, productVersionId?: number | null | undefined, designId?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PersonalizationParametersDto>;
     protected processGetPersonalizationParameters(response: AxiosResponse): Promise<PersonalizationParametersDto>;
     /**
      * Returns a product summary by product identifier.
@@ -2422,6 +2426,8 @@ export interface ProductVariantDesignDto {
     price?: number | null;
     /** Product variant sort index. */
     sortIndex?: number;
+    /** Design-specific personalization workflow identifier. */
+    personalizationWorkflowId?: number | null;
     /** Product variant identifier (usually SKU) in storefront / online store. */
     storefrontProductVariantId?: string | null;
     /** Product variant SKU. */

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

@@ -1830,10 +1830,11 @@ class ProductReferencesApiClient extends ApiClientBase {
      * Returns a personalization parameters by the storefront product reference.
      * @param reference Product reference - external reference to Customer's Canvas product, e.g online store product identifier.
      * @param storefrontId Storefront identifier.
+     * @param designId (optional) Design identifier (for PIM products with design-specific workflows).
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    getPersonalizationParameters(reference, storefrontId, tenantId, cancelToken) {
+    getPersonalizationParameters(reference, storefrontId, designId, tenantId, cancelToken) {
         let url_ = this.baseUrl + "/api/storefront/v1/product-references/{reference}/personalization-parameters?";
         if (reference === undefined || reference === null)
             throw new Error("The parameter 'reference' must be defined.");
@@ -1842,6 +1843,8 @@ class ProductReferencesApiClient extends ApiClientBase {
             throw new Error("The parameter 'storefrontId' must be defined and cannot be null.");
         else
             url_ += "storefrontId=" + encodeURIComponent("" + storefrontId) + "&";
+        if (designId !== undefined && designId !== null)
+            url_ += "designId=" + encodeURIComponent("" + designId) + "&";
         if (tenantId !== undefined && tenantId !== null)
             url_ += "tenantId=" + encodeURIComponent("" + tenantId) + "&";
         url_ = url_.replace(/[?&]$/, "");
@@ -2709,16 +2712,19 @@ class ProductsApiClient extends ApiClientBase {
      * Returns a product personalization parameters by product identifier.
      * @param id Product identifier.
      * @param productVersionId (optional) Product version identifier.
+     * @param designId (optional) Design identifier (for PIM products with design-specific workflows).
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    getPersonalizationParameters(id, productVersionId, tenantId, cancelToken) {
+    getPersonalizationParameters(id, productVersionId, designId, 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.");
         url_ = url_.replace("{id}", encodeURIComponent("" + id));
         if (productVersionId !== undefined && productVersionId !== null)
             url_ += "productVersionId=" + encodeURIComponent("" + productVersionId) + "&";
+        if (designId !== undefined && designId !== null)
+            url_ += "designId=" + encodeURIComponent("" + designId) + "&";
         if (tenantId !== undefined && tenantId !== null)
             url_ += "tenantId=" + encodeURIComponent("" + tenantId) + "&";
         url_ = url_.replace(/[?&]$/, "");