@aurigma/axios-backoffice-api-client 2.59.1 → 2.62.12

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

@@ -53,6 +53,7 @@ export declare module BackOfficeApiClient {
          * @param productSpecificationId (optional) Customer's Canvas product specification filter.
          * @param productId (optional) Customer's Canvas product filter.
          * @param productLinkId (optional) Customer's Canvas product link filter.
+         * @param productBundleId (optional) Customer's Canvas product bundle filter.
          * @param skip (optional) Defines page start offset from beginning of sorted result list.
          * @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".
@@ -63,7 +64,7 @@ export declare module BackOfficeApiClient {
          * @param tenantId (optional) Tenant identifier.
          * @return Success
          */
-        getAll(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductReferenceDto>;
+        getAll(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, productBundleId?: number | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined): Promise<PagedOfProductReferenceDto>;
         /**
          * Creates a new storefront product reference.
          * @param storefrontId Storefront identifier.
@@ -102,6 +103,7 @@ export declare module BackOfficeApiClient {
          * @param productSpecificationId (optional) Customer's Canvas product specification filter.
          * @param productId (optional) Customer's Canvas product filter.
          * @param productLinkId (optional) Customer's Canvas product link filter.
+         * @param productBundleId (optional) Customer's Canvas product bundle filter.
          * @param skip (optional) Defines page start offset from beginning of sorted result list.
          * @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".
@@ -112,7 +114,7 @@ export declare module BackOfficeApiClient {
          * @param tenantId (optional) Tenant identifier.
          * @return Success
          */
-        getAll(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductReferenceDto>;
+        getAll(storefrontId: number, productReference?: string | null | undefined, productSpecificationId?: number | null | undefined, productId?: number | null | undefined, productLinkId?: number | null | undefined, productBundleId?: number | undefined, skip?: number | null | undefined, take?: number | null | undefined, sorting?: string | null | undefined, search?: string | null | undefined, sku?: string | null | undefined, tags?: string[] | null | undefined, customFields?: string | null | undefined, tenantId?: number | null | undefined, cancelToken?: CancelToken | undefined): Promise<PagedOfProductReferenceDto>;
         protected processGetAll(response: AxiosResponse): Promise<PagedOfProductReferenceDto>;
         /**
          * Creates a new storefront product reference.
@@ -186,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.
@@ -423,6 +433,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.
@@ -938,7 +957,8 @@ export declare module BackOfficeApiClient {
     enum ProductReferenceType {
         ProductSpecification = "ProductSpecification",
         Product = "Product",
-        ProductLink = "ProductLink"
+        ProductLink = "ProductLink",
+        ProductBundle = "ProductBundle"
     }
     /** DTO class, containing information about storefront product reference. */
     interface ProductReferenceDto {
@@ -956,6 +976,8 @@ export declare module BackOfficeApiClient {
         productVersionId?: number;
         /** Customer's Canvas product link identifier. */
         productLinkId?: number;
+        /** Customer's Canvas product bundle identifier. */
+        productBundleId?: number;
         /** Storefront identifier. */
         storefrontId?: number;
         /** Tenant identifier. */
@@ -996,6 +1018,8 @@ export declare module BackOfficeApiClient {
         productId?: number | null;
         /** Customer's Canvas product link identifier. */
         productLinkId?: number | null;
+        /** Customer's Canvas product bundle identifier. */
+        productBundleId?: number | null;
     }
     interface ProblemDetails {
         type?: string | null;
@@ -1018,6 +1042,8 @@ export declare module BackOfficeApiClient {
         productId?: number;
         /** Customer's Canvas product link identifier. */
         productLinkId?: number;
+        /** Customer's Canvas product bundle identifier. */
+        productBundleId?: number;
         /** Storefront identifier. */
         storefrontId?: number;
     }
@@ -1218,6 +1244,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. */

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

@@ -177,6 +177,7 @@ var BackOfficeApiClient;
          * @param productSpecificationId (optional) Customer's Canvas product specification filter.
          * @param productId (optional) Customer's Canvas product filter.
          * @param productLinkId (optional) Customer's Canvas product link filter.
+         * @param productBundleId (optional) Customer's Canvas product bundle filter.
          * @param skip (optional) Defines page start offset from beginning of sorted result list.
          * @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".
@@ -187,7 +188,7 @@ var BackOfficeApiClient;
          * @param tenantId (optional) Tenant identifier.
          * @return Success
          */
-        getAll(storefrontId, productReference, productSpecificationId, productId, productLinkId, skip, take, sorting, search, sku, tags, customFields, tenantId, cancelToken) {
+        getAll(storefrontId, productReference, productSpecificationId, productId, productLinkId, productBundleId, skip, take, sorting, search, sku, tags, customFields, tenantId, cancelToken) {
             let url_ = this.baseUrl + "/api/backoffice/v1/product-references?";
             if (storefrontId === undefined || storefrontId === null)
                 throw new Error("The parameter 'storefrontId' must be defined and cannot be null.");
@@ -201,6 +202,10 @@ var BackOfficeApiClient;
                 url_ += "productId=" + encodeURIComponent("" + productId) + "&";
             if (productLinkId !== undefined && productLinkId !== null)
                 url_ += "productLinkId=" + encodeURIComponent("" + productLinkId) + "&";
+            if (productBundleId === null)
+                throw new Error("The parameter 'productBundleId' cannot be null.");
+            else if (productBundleId !== undefined)
+                url_ += "productBundleId=" + encodeURIComponent("" + productBundleId) + "&";
             if (skip !== undefined && skip !== null)
                 url_ += "skip=" + encodeURIComponent("" + skip) + "&";
             if (take !== undefined && take !== null)
@@ -933,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.
@@ -3875,6 +3964,7 @@ var BackOfficeApiClient;
         ProductReferenceType["ProductSpecification"] = "ProductSpecification";
         ProductReferenceType["Product"] = "Product";
         ProductReferenceType["ProductLink"] = "ProductLink";
+        ProductReferenceType["ProductBundle"] = "ProductBundle";
     })(ProductReferenceType = BackOfficeApiClient.ProductReferenceType || (BackOfficeApiClient.ProductReferenceType = {}));
     /** Conflict types. */
     let ConflictType;
@@ -3973,10 +4063,7 @@ var BackOfficeApiClient;
     }
     BackOfficeApiClient.ApiException = ApiException;
     function throwException(message, status, response, headers, result) {
-        if (result !== null && result !== undefined)
-            throw result;
-        else
-            throw new ApiException(message, status, response, headers, null);
+        throw new ApiException(message, status, response, headers, result);
     }
     function isAxiosError(obj) {
         return obj && obj.isAxiosError === true;