@aurigma/axios-storefront-api-client 2.62.12 → 2.65.1

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.WorkflowType = exports.AppearanceDataType = 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;
@@ -485,6 +485,89 @@ class ProductBundlesApiClient extends ApiClientBase {
         }
         return Promise.resolve(null);
     }
+    /**
+     * Returns a product bundle personalization parameters by product identifier.
+     * @param id Product bundle identifier.
+     * @param productBundleVersionId (optional) Product bundle version identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    getProductBundlePersonalizationParameters(id, productBundleVersionId, tenantId, cancelToken) {
+        let url_ = this.baseUrl + "/api/storefront/v1/product-bundles/{id}/personalization-parameters?";
+        if (id === undefined || id === null)
+            throw new Error("The parameter 'id' must be defined.");
+        url_ = url_.replace("{id}", encodeURIComponent("" + id));
+        if (productBundleVersionId !== undefined && productBundleVersionId !== null)
+            url_ += "productBundleVersionId=" + encodeURIComponent("" + productBundleVersionId) + "&";
+        if (tenantId !== undefined && tenantId !== null)
+            url_ += "tenantId=" + encodeURIComponent("" + tenantId) + "&";
+        url_ = url_.replace(/[?&]$/, "");
+        let options_ = {
+            method: "GET",
+            url: url_,
+            headers: {
+                "Accept": "application/json"
+            },
+            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.processGetProductBundlePersonalizationParameters(_response));
+        });
+    }
+    processGetProductBundlePersonalizationParameters(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 === 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 a product bundle summary by product bundle identifier.
      * @param id Product bundle identifier.
@@ -828,6 +911,89 @@ class ProductLinksApiClient extends ApiClientBase {
         }
         return Promise.resolve(null);
     }
+    /**
+     * Returns a product link personalization parameters by product identifier.
+     * @param id Product link identifier.
+     * @param productLinkVersionId (optional) Product link version identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    getProductLinkPersonalizationParameters(id, productLinkVersionId, tenantId, cancelToken) {
+        let url_ = this.baseUrl + "/api/storefront/v1/product-links/{id}/personalization-parameters?";
+        if (id === undefined || id === null)
+            throw new Error("The parameter 'id' must be defined.");
+        url_ = url_.replace("{id}", encodeURIComponent("" + id));
+        if (productLinkVersionId !== undefined && productLinkVersionId !== null)
+            url_ += "productLinkVersionId=" + encodeURIComponent("" + productLinkVersionId) + "&";
+        if (tenantId !== undefined && tenantId !== null)
+            url_ += "tenantId=" + encodeURIComponent("" + tenantId) + "&";
+        url_ = url_.replace(/[?&]$/, "");
+        let options_ = {
+            method: "GET",
+            url: url_,
+            headers: {
+                "Accept": "application/json"
+            },
+            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.processGetProductLinkPersonalizationParameters(_response));
+        });
+    }
+    processGetProductLinkPersonalizationParameters(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 === 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 a product link summary by product link identifier.
      * @param id Product link identifier.
@@ -1660,6 +1826,91 @@ class ProductReferencesApiClient extends ApiClientBase {
         }
         return Promise.resolve(null);
     }
+    /**
+     * 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 tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    getPersonalizationParameters(reference, storefrontId, 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.");
+        url_ = url_.replace("{reference}", encodeURIComponent("" + reference));
+        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(/[?&]$/, "");
+        let options_ = {
+            method: "GET",
+            url: url_,
+            headers: {
+                "Accept": "application/json"
+            },
+            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.processGetPersonalizationParameters(_response));
+        });
+    }
+    processGetPersonalizationParameters(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 === 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 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.
@@ -2454,6 +2705,89 @@ class ProductsApiClient extends ApiClientBase {
         }
         return Promise.resolve(null);
     }
+    /**
+     * Returns a product personalization parameters by product identifier.
+     * @param id Product identifier.
+     * @param productVersionId (optional) Product version identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    getProductSummary(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.");
+        url_ = url_.replace("{id}", encodeURIComponent("" + id));
+        if (productVersionId !== undefined && productVersionId !== null)
+            url_ += "productVersionId=" + encodeURIComponent("" + productVersionId) + "&";
+        if (tenantId !== undefined && tenantId !== null)
+            url_ += "tenantId=" + encodeURIComponent("" + tenantId) + "&";
+        url_ = url_.replace(/[?&]$/, "");
+        let options_ = {
+            method: "GET",
+            url: url_,
+            headers: {
+                "Accept": "application/json"
+            },
+            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.processGetProductSummary(_response));
+        });
+    }
+    processGetProductSummary(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 === 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 a product summary by product identifier.
      * @param id Product identifier.
@@ -2464,7 +2798,7 @@ class ProductsApiClient extends ApiClientBase {
      * @param tenantId (optional) Tenant identifier.
      * @return Success
      */
-    getProductSummary(id, productVersionId, productLinkId, productVariantId, sku, tenantId, cancelToken) {
+    getProductSummary2(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.");
@@ -2498,10 +2832,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.processGetProductSummary2(_response));
         });
     }
-    processGetProductSummary(response) {
+    processGetProductSummary2(response) {
         const status = response.status;
         let _headers = {};
         if (response.headers && typeof response.headers === "object") {
@@ -3790,6 +4124,86 @@ class ProductSpecificationsApiClient extends ApiClientBase {
         }
         return Promise.resolve(null);
     }
+    /**
+     * Returns a product specification personalization parameters by product identifier.
+     * @param id Product specification identifier.
+     * @param tenantId (optional) Tenant identifier.
+     * @return Success
+     */
+    getProductSpecificationSummary(id, tenantId, cancelToken) {
+        let url_ = this.baseUrl + "/api/storefront/v1/product-specifications/{id}/personalization-parameters?";
+        if (id === undefined || id === null)
+            throw new Error("The parameter 'id' must be defined.");
+        url_ = url_.replace("{id}", encodeURIComponent("" + id));
+        if (tenantId !== undefined && tenantId !== null)
+            url_ += "tenantId=" + encodeURIComponent("" + tenantId) + "&";
+        url_ = url_.replace(/[?&]$/, "");
+        let options_ = {
+            method: "GET",
+            url: url_,
+            headers: {
+                "Accept": "application/json"
+            },
+            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.processGetProductSpecificationSummary(_response));
+        });
+    }
+    processGetProductSpecificationSummary(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 === 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 a product personalization workflow description by product specification identifier.
      * @param id Product specification identifier.
@@ -5518,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) + "&"; });
@@ -5533,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(/[?&]$/, "");
@@ -6454,6 +6871,22 @@ var ConflictType;
     ConflictType["IdConflict"] = "IdConflict";
     ConflictType["GeneralConflict"] = "GeneralConflict";
 })(ConflictType = exports.ConflictType || (exports.ConflictType = {}));
+/** Customer's Canvas product type. */
+var ProductType;
+(function (ProductType) {
+    ProductType["ProductSpecification"] = "ProductSpecification";
+    ProductType["Product"] = "Product";
+    ProductType["ProductLink"] = "ProductLink";
+    ProductType["ProductBundle"] = "ProductBundle";
+})(ProductType = exports.ProductType || (exports.ProductType = {}));
+/** Type of editor that should be configured by workflow. */
+var WorkflowType;
+(function (WorkflowType) {
+    WorkflowType["UIFramework"] = "UIFramework";
+    WorkflowType["SimpleEditor"] = "SimpleEditor";
+    WorkflowType["DesignEditor"] = "DesignEditor";
+    WorkflowType["WorkflowElements"] = "WorkflowElements";
+})(WorkflowType = exports.WorkflowType || (exports.WorkflowType = {}));
 /** Available appearance types. */
 var AppearanceDataType;
 (function (AppearanceDataType) {
@@ -6465,14 +6898,6 @@ var AppearanceDataType;
     AppearanceDataType["ImageGrid"] = "ImageGrid";
     AppearanceDataType["ImageList"] = "ImageList";
 })(AppearanceDataType = exports.AppearanceDataType || (exports.AppearanceDataType = {}));
-/** Type of editor that should be configured by workflow. */
-var WorkflowType;
-(function (WorkflowType) {
-    WorkflowType["UIFramework"] = "UIFramework";
-    WorkflowType["SimpleEditor"] = "SimpleEditor";
-    WorkflowType["DesignEditor"] = "DesignEditor";
-    WorkflowType["WorkflowElements"] = "WorkflowElements";
-})(WorkflowType = exports.WorkflowType || (exports.WorkflowType = {}));
 /** Product link resource type. */
 var ProductLinkResourceType;
 (function (ProductLinkResourceType) {
@@ -6594,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;