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

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

@@ -159,7 +159,7 @@ export declare module BackOfficeApiClient {
         /**
          * Creates a new product and returns its description.
          * @param tenantId (optional) Tenant identifier.
-         * @param body (optional)
+         * @param body (optional) Product creation parameters.
          * @return Success
          */
         createProduct(tenantId?: number | null | undefined, body?: CreateProductDto | null | undefined): Promise<ProductDto>;
@@ -342,6 +342,15 @@ export declare module BackOfficeApiClient {
          * @return Success
          */
         removeDocumentsConnections(id: number, tenantId?: number | null | undefined, body?: RemoveProductDocumentConnectionsDto | null | undefined): Promise<void>;
+        /**
+         * Set a thumbnail image for an existing product.
+         * @param id Product identifier.
+         * @param productVersionId (optional)
+         * @param tenantId (optional) Tenant identifier.
+         * @param file (optional)
+         * @return Success
+         */
+        setProductImage(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined, file?: FileParameter | null | undefined): Promise<void>;
         /**
          * Returns all available product personalization workflows.
          * @param skip (optional) Defines page start offset from beginning of sorted result list.
@@ -383,7 +392,7 @@ export declare module BackOfficeApiClient {
         /**
          * Creates a new product and returns its description.
          * @param tenantId (optional) Tenant identifier.
-         * @param body (optional)
+         * @param body (optional) Product creation parameters.
          * @return Success
          */
         createProduct(tenantId?: number | null | undefined, body?: CreateProductDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<ProductDto>;
@@ -585,6 +594,16 @@ export declare module BackOfficeApiClient {
          */
         removeDocumentsConnections(id: number, tenantId?: number | null | undefined, body?: RemoveProductDocumentConnectionsDto | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
         protected processRemoveDocumentsConnections(response: AxiosResponse): Promise<void>;
+        /**
+         * Set a thumbnail image for an existing product.
+         * @param id Product identifier.
+         * @param productVersionId (optional)
+         * @param tenantId (optional) Tenant identifier.
+         * @param file (optional)
+         * @return Success
+         */
+        setProductImage(id: number, productVersionId?: number | null | undefined, tenantId?: number | null | undefined, file?: FileParameter | null | undefined, cancelToken?: CancelToken | undefined): Promise<void>;
+        protected processSetProductImage(response: AxiosResponse): Promise<void>;
         /**
          * Returns all available product personalization workflows.
          * @param skip (optional) Defines page start offset from beginning of sorted result list.
@@ -1066,7 +1085,7 @@ export declare module BackOfficeApiClient {
     /** Product option creation operation parameters. */
     interface CreateProductOptionDto {
         /** Option title. */
-        title?: string | null;
+        title: string;
         /** Option traits. */
         traits?: string[] | null;
         /** Product option values. */
@@ -1081,7 +1100,7 @@ export declare module BackOfficeApiClient {
     /** Product option creation operation parameters. */
     interface CreateProductDto {
         /** Product name. */
-        name?: string | null;
+        name: string;
         /** Product description. */
         description?: string | null;
         /** Personalization workflow identifier. */
@@ -1144,6 +1163,8 @@ export declare module BackOfficeApiClient {
         isDefault?: boolean;
         /** Product option value identifying tag. */
         tag?: string | null;
+        /** Product option value UID. */
+        uid?: string | null;
         /** Product option value description for 'Simple' option type. */
         simpleOptionValue?: SimpleOptionValue | null;
         /** Product option value description. */
@@ -1173,6 +1194,8 @@ export declare module BackOfficeApiClient {
         sortIndex?: number;
         /** Product option identifying tag. */
         tag?: string | null;
+        /** Product option UID. */
+        uid?: string | null;
         /** Specifies if the option is used for design binding. */
         useForDesignBinding?: boolean;
         /** Specifies if the option is used for mockup binding. */
@@ -1436,10 +1459,10 @@ export declare module BackOfficeApiClient {
     }
     /** Product asset connection options description. */
     interface ProductAssetConnectionOptionsDto {
-        /** Product option identifier. */
-        optionId?: number;
-        /** Product option values identifiers. */
-        optionValueIds?: number[] | null;
+        /** Product option UID. */
+        optionUID?: string | null;
+        /** Product option values UIDs. */
+        optionValueUIDs?: string[] | null;
     }
     /** Product design connection description. */
     interface ProductDesignConnectionDto {

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

@@ -626,7 +626,7 @@ export var BackOfficeApiClient;
         /**
          * Creates a new product and returns its description.
          * @param tenantId (optional) Tenant identifier.
-         * @param body (optional)
+         * @param body (optional) Product creation parameters.
          * @return Success
          */
         createProduct(tenantId, body, cancelToken) {
@@ -1509,6 +1509,13 @@ export var BackOfficeApiClient;
                 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;
@@ -1589,6 +1596,13 @@ export var BackOfficeApiClient;
                 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;
@@ -1669,6 +1683,13 @@ export var BackOfficeApiClient;
                 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;
@@ -2258,6 +2279,96 @@ export var BackOfficeApiClient;
             }
             return Promise.resolve(null);
         }
+        /**
+         * Set a thumbnail image for an existing product.
+         * @param id Product identifier.
+         * @param productVersionId (optional)
+         * @param tenantId (optional) Tenant identifier.
+         * @param file (optional)
+         * @return Success
+         */
+        setProductImage(id, productVersionId, tenantId, file, cancelToken) {
+            let url_ = this.baseUrl + "/api/backoffice/v1/products/{id}/set-image?";
+            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(/[?&]$/, "");
+            const content_ = new FormData();
+            if (file !== null && file !== undefined)
+                content_.append("file", file.data, file.fileName ? file.fileName : "file");
+            let options_ = {
+                data: content_,
+                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.processSetProductImage(_response));
+            });
+        }
+        processSetProductImage(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);
+        }
         /**
          * Returns all available product personalization workflows.
          * @param skip (optional) Defines page start offset from beginning of sorted result list.