@aurigma/axios-backoffice-api-client 2.60.2 → 2.63.14

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

@@ -188,6 +188,14 @@ export declare module BackOfficeApiClient {
          * @return Success
          */
         getProductOptions(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductOptionDto>;
+        /**
+         * Set product options and returns updated options list.
+         * @param id Product identifier.
+         * @param tenantId (optional) Tenant identifier.
+         * @param body (optional)
+         * @return Success
+         */
+        setProductOptions(id: number, tenantId?: number | null | undefined, body?: SetProductOptionsDto | null | undefined): Promise<PagedOfProductOptionDto>;
         /**
          * Returns a list of product variants.
          * @param id Product identifier.
@@ -211,6 +219,21 @@ export declare module BackOfficeApiClient {
          * @return Success
          */
         getProductVariant(id: number, productVariantId: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined): Promise<ProductVariantDto>;
+        /**
+         * Updates product variant resources.
+         * @param id Product identifier.
+         * @param productVersionId (optional) Product version identifier.
+         * @param tenantId (optional) Tenant identifier.
+         * @return Success
+         */
+        updateProductVariantResources(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined): Promise<void>;
+        /**
+         * Validates product variant resources.
+         * @param id Product identifier.
+         * @param tenantId (optional) Tenant identifier.
+         * @return Success
+         */
+        validateProductVariantResources(id: number, tenantId?: number | null | undefined): Promise<void>;
         /**
          * Returns a list of product variant designs.
          * @param id Product identifier.
@@ -273,6 +296,14 @@ export declare module BackOfficeApiClient {
          * @return Success
          */
         setProductVariantPrice(id: number, tenantId?: number | null | undefined, body?: SetProductVariantPriceDto | null | undefined): Promise<void>;
+        /**
+         * Set product variants weight. Variants identifiers will be changed.
+         * @param id Product identifier.
+         * @param tenantId (optional) Tenant identifier.
+         * @param body (optional) Set product variants weight operation parameters.
+         * @return Success
+         */
+        setProductVariantWeight(id: number, tenantId?: number | null | undefined, body?: SetProductVariantWeightDto | null | undefined): Promise<void>;
         /**
          * Set product variants availability. Variants identifiers will be changed.
          * @param id Product identifier.
@@ -425,6 +456,15 @@ export declare module BackOfficeApiClient {
          */
         getProductOptions(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductOptionDto>;
         protected processGetProductOptions(response: AxiosResponse): Promise<PagedOfProductOptionDto>;
+        /**
+         * Set product options and returns updated options list.
+         * @param id Product identifier.
+         * @param tenantId (optional) Tenant identifier.
+         * @param body (optional)
+         * @return Success
+         */
+        setProductOptions(id: number, tenantId?: number | null | undefined, body?: SetProductOptionsDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductOptionDto>;
+        protected processSetProductOptions(response: AxiosResponse): Promise<PagedOfProductOptionDto>;
         /**
          * Returns a list of product variants.
          * @param id Product identifier.
@@ -450,6 +490,23 @@ export declare module BackOfficeApiClient {
          */
         getProductVariant(id: number, productVariantId: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductVariantDto>;
         protected processGetProductVariant(response: AxiosResponse): Promise<ProductVariantDto>;
+        /**
+         * Updates product variant resources.
+         * @param id Product identifier.
+         * @param productVersionId (optional) Product version identifier.
+         * @param tenantId (optional) Tenant identifier.
+         * @return Success
+         */
+        updateProductVariantResources(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
+        protected processUpdateProductVariantResources(response: AxiosResponse): Promise<void>;
+        /**
+         * Validates product variant resources.
+         * @param id Product identifier.
+         * @param tenantId (optional) Tenant identifier.
+         * @return Success
+         */
+        validateProductVariantResources(id: number, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
+        protected processValidateProductVariantResources(response: AxiosResponse): Promise<void>;
         /**
          * Returns a list of product variant designs.
          * @param id Product identifier.
@@ -516,6 +573,15 @@ export declare module BackOfficeApiClient {
          */
         setProductVariantPrice(id: number, tenantId?: number | null | undefined, body?: SetProductVariantPriceDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
         protected processSetProductVariantPrice(response: AxiosResponse): Promise<void>;
+        /**
+         * Set product variants weight. Variants identifiers will be changed.
+         * @param id Product identifier.
+         * @param tenantId (optional) Tenant identifier.
+         * @param body (optional) Set product variants weight operation parameters.
+         * @return Success
+         */
+        setProductVariantWeight(id: number, tenantId?: number | null | undefined, body?: SetProductVariantWeightDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
+        protected processSetProductVariantWeight(response: AxiosResponse): Promise<void>;
         /**
          * Set product variants availability. Variants identifiers will be changed.
          * @param id Product identifier.
@@ -1227,6 +1293,47 @@ export declare module BackOfficeApiClient {
         total?: number;
         items?: ProductOptionDto[] | null;
     }
+    /** Product option value create or update operation parameters. */
+    interface SetProductOptionValueDto {
+        /** Product option value UID. */
+        uid?: string | null;
+        /** Product option value description. */
+        description?: string | null;
+        /** Product option value sort index. */
+        sortIndex?: number;
+        /** Indicates if product option value is used as a default value. */
+        isDefault?: boolean;
+        /** Product option value. */
+        value?: string | null;
+        /** Product option value colors. */
+        colors?: string[] | null;
+    }
+    /** Product option create or update operation parameters. */
+    interface SetProductOptionDto {
+        /** Product option UID. */
+        uid?: string | null;
+        /** Product option title. */
+        title?: string | null;
+        /** Product option description. */
+        description?: string | null;
+        /** Product option tooltip. */
+        tooltip?: string | null;
+        /** Product option sort index. */
+        sortIndex?: number;
+        /** Specifies if the option is used for design binding. */
+        useForDesignBinding?: boolean;
+        /** Specifies if the option is used for mockup binding. */
+        useForMockupBinding?: boolean;
+        /** Specifies if the option is used for document binding. */
+        useForDocumentBinding?: boolean;
+        /** A list of product option values. */
+        values?: SetProductOptionValueDto[] | null;
+    }
+    /** Product options setting operation parameters. */
+    interface SetProductOptionsDto {
+        /** Product options create or update parameters. */
+        options?: SetProductOptionDto[] | null;
+    }
     /** Dto class, containing information about a product variant option. */
     interface ProductVariantOptionDto {
         /** Product option identifier. */
@@ -1260,6 +1367,8 @@ export declare module BackOfficeApiClient {
         isAvailable?: boolean;
         /** Product variant price. */
         price?: number | null;
+        /** Product variant weight. */
+        weight?: number | null;
         /** Product variant sort index. */
         sortIndex?: number;
         /** Product variant identifier (usually SKU) in storefront / online store. */
@@ -1442,6 +1551,18 @@ export declare module BackOfficeApiClient {
         /** List of product variants grouped by price value. */
         items?: ProductVariantPriceDto[] | null;
     }
+    /** Parameters for setting product variants weight. */
+    interface ProductVariantWeightDto {
+        /** Weight. */
+        weight?: number | null;
+        /** UIDs of variants for price setting. */
+        variantUIDs?: string[] | null;
+    }
+    /** Product variants weight setting operation parameters. */
+    interface SetProductVariantWeightDto {
+        /** List of product variants grouped by weight value. */
+        items?: ProductVariantWeightDto[] | null;
+    }
     /** Parameters for setting product variants availability. */
     interface ProductVariantAvailabilityDto {
         /** Availability. */

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

@@ -938,6 +938,90 @@ var BackOfficeApiClient;
             }
             return Promise.resolve(null);
         }
+        /**
+         * Set product options and returns updated options list.
+         * @param id Product identifier.
+         * @param tenantId (optional) Tenant identifier.
+         * @param body (optional)
+         * @return Success
+         */
+        setProductOptions(id, tenantId, body, cancelToken) {
+            let url_ = this.baseUrl + "/api/backoffice/v1/products/{id}/options?";
+            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(/[?&]$/, "");
+            const content_ = JSON.stringify(body);
+            let options_ = {
+                data: content_,
+                method: "PUT",
+                url: url_,
+                headers: {
+                    "Content-Type": "application/json",
+                    "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.processSetProductOptions(_response));
+            });
+        }
+        processSetProductOptions(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 list of product variants.
          * @param id Product identifier.
@@ -1126,6 +1210,159 @@ var BackOfficeApiClient;
             }
             return Promise.resolve(null);
         }
+        /**
+         * Updates product variant resources.
+         * @param id Product identifier.
+         * @param productVersionId (optional) Product version identifier.
+         * @param tenantId (optional) Tenant identifier.
+         * @return Success
+         */
+        updateProductVariantResources(id, productVersionId, tenantId, cancelToken) {
+            let url_ = this.baseUrl + "/api/backoffice/v1/products/{id}/update-variant-resources?";
+            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: "POST",
+                url: url_,
+                headers: {},
+                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.processUpdateProductVariantResources(_response));
+            });
+        }
+        processUpdateProductVariantResources(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;
+                return Promise.resolve(null);
+            }
+            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);
+        }
+        /**
+         * Validates product variant resources.
+         * @param id Product identifier.
+         * @param tenantId (optional) Tenant identifier.
+         * @return Success
+         */
+        validateProductVariantResources(id, tenantId, cancelToken) {
+            let url_ = this.baseUrl + "/api/backoffice/v1/products/{id}/validate-variant-resources?";
+            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: "POST",
+                url: url_,
+                headers: {},
+                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.processValidateProductVariantResources(_response));
+            });
+        }
+        processValidateProductVariantResources(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;
+                return Promise.resolve(null);
+            }
+            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 list of product variant designs.
          * @param id Product identifier.
@@ -1552,6 +1789,93 @@ var BackOfficeApiClient;
             }
             return Promise.resolve(null);
         }
+        /**
+         * Set product variants weight. Variants identifiers will be changed.
+         * @param id Product identifier.
+         * @param tenantId (optional) Tenant identifier.
+         * @param body (optional) Set product variants weight operation parameters.
+         * @return Success
+         */
+        setProductVariantWeight(id, tenantId, body, cancelToken) {
+            let url_ = this.baseUrl + "/api/backoffice/v1/products/{id}/set-variant-weight?";
+            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(/[?&]$/, "");
+            const content_ = JSON.stringify(body);
+            let options_ = {
+                data: content_,
+                method: "POST",
+                url: url_,
+                headers: {
+                    "Content-Type": "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.processSetProductVariantWeight(_response));
+            });
+        }
+        processSetProductVariantWeight(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;
+                return Promise.resolve(null);
+            }
+            else if (status === 400) {
+                const _responseText = response.data;
+                let result400 = null;
+                let resultData400 = _responseText;
+                result400 = JSON.parse(resultData400);
+                return throwException("Bad Request", status, _responseText, _headers, result400);
+            }
+            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);
+        }
         /**
          * Set product variants availability. Variants identifiers will be changed.
          * @param id Product identifier.