@djust-b2b/djust-front-sdk 1.13.0 → 1.15.0

package/lib/services/commercial-order/index.js

@@ -3,22 +3,50 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getCommercialOrders = getCommercialOrders;
 exports.createCommercialOrder = createCommercialOrder;
 exports.getCommercialOrder = getCommercialOrder;
+exports.createCommercialOrderCardRegistration = createCommercialOrderCardRegistration;
 exports.updateCommercialOrderBillingInformation = updateCommercialOrderBillingInformation;
 exports.setCommercialOrderStatusAsCreated = setCommercialOrderStatusAsCreated;
 exports.setCommercialOrderStatusAsOnHold = setCommercialOrderStatusAsOnHold;
 exports.getCommercialOrderPaymentPageUrl = getCommercialOrderPaymentPageUrl;
+exports.createCommercialOrderPreauthorization = createCommercialOrderPreauthorization;
 exports.updateCommercialOrderShippingAddress = updateCommercialOrderShippingAddress;
 exports.updateCommercialOrderShippingInformation = updateCommercialOrderShippingInformation;
 exports.updateCommercialOrderShippingType = updateCommercialOrderShippingType;
-exports.updateLogisticOrderCustomFieldsValue = updateLogisticOrderCustomFieldsValue;
 const parameters_validation_1 = require("../../helpers/parameters-validation");
 const fetch_instance_1 = require("../../settings/fetch-instance");
 /**
- * Get commercial orders
+ * COMMERCIAL ORDER ENDPOINT
+ */
+/**
+ * 🚚 Gets commercial orders.
+ *
+ * This function retrieves all commercial orders. The parameter locale is mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/commercial-orders [ORDER-560]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `locale`          | `string`                        | ✅         | The locale in which to return the commercial order. |
+ * | `nbPreviewLines`  | `integer`                       | ❌         | The number of lines to display in the commercial order. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a single `GetCommercialOrdersResponse` object representing the page of commercial orders.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const orders = await getCommercialOrders({
+ *   locale: "fr",
+ * });
+ * ```
+ *
+ * @param {GetCommercialOrdersParameters} params - The parameters for the request.
+ * @throws {Error} If `locale` is missing.
+ * @returns {Promise<GetCommercialOrdersResponse>} A promise resolving to the response containing page object.
  */
 async function getCommercialOrders({ locale, nbPreviewLines, }) {
     (0, parameters_validation_1.required)({ locale });
-    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+    const { data } = await await (0, fetch_instance_1.enhancedFetch)({
         method: "GET",
         path: `/v1/shop/commercial-orders`,
         params: {
@@ -29,11 +57,41 @@ async function getCommercialOrders({ locale, nbPreviewLines, }) {
     return data;
 }
 /**
- * Create commercial order
+ * 🚚 Creates commercial orders.
+ *
+ * This function creates a commercial order. The parameters `locale`, `origin` and `originId` is mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `POST /v1/shop/commercial-orders [ORDER-100]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `nbPreviewLines`  | `integer`                       | ❌         | The number of lines to display in the logistic order. |
+ * | `customFields`    | `CustomFieldValueRequest[]`     | ❌         | The custom fields to add to the created commercial order. |
+ * | `locale`          | `string`                        | ✅         | The locale in which to return the logistic order. |
+ * | `origin`          | `OrderOrigin`                   | ✅         | The type of object from which the commercial order is created (e.g., `CART`, `SUPPLIER_QUOTE`). |
+ * | `originId`        | `string`                        | ✅         | The ID of the object from which the commercial order is created. |
+ * | `paymentInfo`     | `string`                        | ❌         | The payment information for the order |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a single `CreateCommercialOrderResponse` object representing the created commercial orders.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const orders = await createCommercialOrder({
+ *   locale: "fr",
+ *   origin: "CART",
+ *   originId: "cart1"
+ * });
+ * ```
+ *
+ * @param {CreateCommercialOrderParameters} params - The parameters for the request.
+ * @throws {Error} If `locale` or òrigin`or òriginId` is missing.
+ * @returns {Promise<CreateCommercialOrderResponse>} A promise resolving to the response containing the commercial orders.
  */
 async function createCommercialOrder({ nbPreviewLines, channel, customFields, locale, originId, paymentInfo, }) {
     (0, parameters_validation_1.required)({ channel, locale, origin, originId });
-    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+    const { data } = await await (0, fetch_instance_1.enhancedFetch)({
         method: "POST",
         path: `/v1/shop/commercial-orders`,
         params: {
@@ -50,11 +108,39 @@ async function createCommercialOrder({ nbPreviewLines, channel, customFields, lo
     return data;
 }
 /**
- * Get commercial order
+ * 🚚 Gets a specific commercial order.
+ *
+ * This function retrieves a specific commercial order, identified by
+ * the `orderId`. This parameter is mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/commercial-orders/${orderId} [ORDER-500]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `orderId`         | `string`                        | ✅         | The ID of the commercial order you want to retrieve. |
+ * | `locale`          | `string`                        | ✅         | The locale in which to return the commercial order. |
+ * | `idType`          | `OrderIdType`                   | ❌         | The type of order ID (e.g., `BUSINESS_ID`, `CART_ID`). |
+ * | `nbPreviewLines`  | `integer`                       | ❌         | The number of lines to display in the commercial order. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a single `GetCommercialOrderResponse` object representing the commercial order.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const order = await getCommercialOrder({
+ *   orderId: "commercialOrder1",
+ *   locale: "fr",
+ * });
+ * ```
+ *
+ * @param {GetCommercialOrderParameters} params - The parameters for the request.
+ * @throws {Error} If `orderId` or `locale` is missing.
+ * @returns {Promise<GetCommercialOrderResponse>} A promise resolving to the response containing the commercial order.
  */
 async function getCommercialOrder({ orderId, idType, locale, nbPreviewLines, }) {
     (0, parameters_validation_1.required)({ orderId, locale });
-    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+    const { data } = await await (0, fetch_instance_1.enhancedFetch)({
         method: "GET",
         path: `/v1/shop/commercial-orders/${orderId}`,
         params: {
@@ -66,11 +152,80 @@ async function getCommercialOrder({ orderId, idType, locale, nbPreviewLines, })
     return data;
 }
 /**
- * Update commercial order billing information
+ * 🚚 Creates a specific commercial order's card registration.
+ *
+ * This function registered a card for a specific commercial order, identified by
+ * the `orderId`. Both parameters are mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `POST /v1/shop/commercial-orders/${orderId}/card-registration [ORDER-104]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `orderId`         | `string`                        | ✅         | The ID of the commercial order for which you want to register a card. |
+ * | `paymentProvider `| `paymentProvider`               | ✅         | Specifies whether the card payments uses (`MANGOPAY`), (`THUNES`) or (`LEMONWAY`). |
+ * | `currency`        | `Currency`                      | ✅         | The currency of the registered card. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a single `CreateCommercialOrderCardRegistrationResponse` object representing the card registered.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const card = await createCommercialOrderCardRegistration({
+ *   orderId: "commercialOrder1",
+ *   paymentProvider: "MANGOPAY",
+ *   currency: "EUR",
+ * });
+ * ```
+ *
+ * @param {CreateCommercialOrderCardRegistrationParameters} params - The parameters for the request.
+ * @throws {Error} If `orderId` or `billingAddressId` is missing.
+ * @returns {Promise<CreateCommercialOrderCardRegistrationResponse>} A promise resolving to a response containing the card registered.
+ */
+async function createCommercialOrderCardRegistration({ orderId, paymentProvider, currency, }) {
+    (0, parameters_validation_1.required)({ orderId, paymentProvider, currency });
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+        method: "POST",
+        path: `/v1/shop/commercial-orders/${orderId}/card-registration`,
+        body: JSON.stringify({
+            paymentProvider,
+            currency,
+        }),
+    });
+    return data;
+}
+/**
+ * 🚚 Updates a specific commercial order's billing information.
+ *
+ * This function updates the billing information of a specific commercial order, identified by
+ * the `orderId` and the `billingAddressId`. Both parameters are mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `PUT /v1/shop/commercial-orders/${orderId}/billing-information [ORDER-213]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `orderId`         | `string`                        | ✅         | The ID of the commercial order of which you want to update the address. |
+ * | `billingAddressId`| `string`                        | ✅         | The ID of the billing address to add. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving when the billing address of the commercial order is updated.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * await updateCommercialOrderBillingInformation({
+ *   orderId: "commercialOrder1",
+ *   billingAddressId: "billingAddress1",
+ * });
+ * ```
+ *
+ * @param {UpdateCommercialOrderBillingInformationParameters} params - The parameters for the request.
+ * @throws {Error} If `orderId` or `billingAddressId` is missing.
+ * @returns {Promise<void>} A promise resolving when shipping information of the commercial order is updated.
  */
 async function updateCommercialOrderBillingInformation({ orderId, billingAddressId, }) {
     (0, parameters_validation_1.required)({ orderId, billingAddressId });
-    (0, fetch_instance_1.enhancedFetch)({
+    await (0, fetch_instance_1.enhancedFetch)({
         method: "PUT",
         path: `/v1/shop/commercial-orders/${orderId}/billing-information`,
         body: JSON.stringify({
@@ -79,32 +234,121 @@ async function updateCommercialOrderBillingInformation({ orderId, billingAddress
     });
 }
 /**
- * Set commercial order status as created
+ * 🚚 Sets commercial order status as CREATED.
+ *
+ * This function changes a specific order status to CREATED, identified by
+ * the `orderId`. This parameter is mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `PUT /v1/shop/commercial-orders/${orderId}/created [ORDER-212]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `orderId`         | `string`                        | ✅         | The ID of the commercial order of which you want to set the status to CREATED. |
+ * | `paymentInfo`     | `string`                        | ❌         | The payment information for the order |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving when the commerical order is set to CREATED.
+ *
+ * 🛠 **Example usage**:
+ *  ```ts
+ * await setCommercialOrderStatusAsCreated({
+ *   orderId: "commercialOrder1",
+ * });
+ * ```
+ *
+ * ```json
+ * {
+ *   "message": "Commercial order successfully set to created"
+ * }
+ * ```
+ *
+ * @param {SetCommercialOrderStatusAsCreatedParameters} params - The parameters for the request.
+ * @throws {Error} If `orderId` is missing.
+ * @returns {Promise<void>} A promise resolving when the commercial order is set to CREATED.
  */
 async function setCommercialOrderStatusAsCreated({ orderId, paymentInfo, }) {
     (0, parameters_validation_1.required)({ orderId });
-    (0, fetch_instance_1.enhancedFetch)({
+    await (0, fetch_instance_1.enhancedFetch)({
         method: "PUT",
         path: `/v1/shop/commercial-orders/${orderId}/created`,
         body: JSON.stringify(paymentInfo),
     });
 }
 /**
- * Set commercial order status as on hold
+ * 🚚 Sets commercial order status as ON HOLD.
+ *
+ * This function changes a specific order status to ON HOLD, identified by
+ * the `orderId`. This parameter is mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `PUT /v1/shop/commercial-orders/${orderId}/hold [ORDER-207]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `orderId`         | `string`                        | ✅         | The ID of the commercial order of which you want to set the status to ON HOLD. |
+ * | `paymentInfo`     | `string`                        | ❌         | The payment information for the order |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving when the commercial order is set to ON HOLD.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * await setCommercialOrderStatusAsOnHold({
+ *   orderId: "commercialOrder1",
+ * });
+ * ```
+ *
+ * ```json
+ * {
+ *   "message": "Commercial order successfully set to on-hold"
+ * }
+ * ```
+ *
+ * @param {SetCommercialOrderStatusAsOnHoldParameters} params - The parameters for the request.
+ * @throws {Error} If `orderId` is missing.
+ * @returns {Promise<void>} A promise resolving when the commercial order is set to ON HOLD.
  */
 async function setCommercialOrderStatusAsOnHold({ orderId, }) {
     (0, parameters_validation_1.required)({ orderId });
-    (0, fetch_instance_1.enhancedFetch)({
+    await (0, fetch_instance_1.enhancedFetch)({
         method: "PUT",
         path: `/v1/shop/commercial-orders/${orderId}/hold`,
     });
 }
 /**
- * Get payment page url for an order
+ * 🚚 Gets payment page url for a specific order.
+ *
+ * This function retrieves the url of a payment page for a commercial order, identified by
+ * the `orderId`. This parameter is mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/commercial-orders/${orderId}/payment-page [ORDER-507]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `orderId`         | `string`                        | ✅         | The ID of the commercial order associated with the payment page. |
+ * | `paymentOption`   | `PaymentOption`                 | ✅         | Specifies whether the payment is done with (`BANK_WIRE`), (`BANK_WIRE_ON_DUE_DATE`), (`CREDIT_CARD`), (`DIRECT_PAYMENT`), (`BANK_WIRE_ON_ACCEPTANCE`). |
+ * | `paymentProvider` | `PaymentProvider`               | ❌         | Specifies whether the payment uses (`MANGOPAY`), (`THUNES`) or (`LEMONWAY`). |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a string containig the payment page url.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * await getCommercialOrderPaymentPageUrl({
+ *   orderId: "commercialOrder1",
+ *   paymentOption: "BANK_WIRE",
+ * });
+ * ```
+ *
+ * @param {GetCommercialOrderPaymentPageUrlParameters} params - The parameters for the request.
+ * @throws {Error} If `orderId` is missing.
+ * @returns {Promise<string>} A promise resolving to a string containig the payment page url.
  */
 async function getCommercialOrderPaymentPageUrl({ orderId, paymentOption, paymentProvider, }) {
     (0, parameters_validation_1.required)({ orderId, paymentOption });
-    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+    const { data } = await await (0, fetch_instance_1.enhancedFetch)({
         method: "GET",
         path: `/v1/shop/commercial-orders/${orderId}/payment-page`,
         params: {
@@ -115,11 +359,90 @@ async function getCommercialOrderPaymentPageUrl({ orderId, paymentOption, paymen
     return data.url;
 }
 /**
- * Update commercial order shipping address
+ * 🚚 Creates a specific commercial order's card registration.
+ *
+ * This function registered a card for a specific commercial order, identified by
+ * the `orderId`. Both parameters are mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `POST /v1/shop/commercial-orders/${orderId}/preauthorization [ORDER-105]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `orderId`         | `string`                        | ✅         | The ID of the commercial order for which you want to register a card. |
+ * | `paymentProvider` | `paymentProvider`               | ✅         | Specifies whether the card payments uses (`MANGOPAY`), (`THUNES`) or (`LEMONWAY`). |
+ * | `authorId`        | `string`                        | ❌         | The ID of the author of the preauthorization. |
+ * | `browserInfo`     | `browserInfo`                   | ❌         | The information of the browser used to make the preauthorization. |
+ * | `ipAddress`       | `string`                        | ❌         | The IP Address of the machine used to make the preauthorization. |
+ * | `paymentCardInfo` | `paymentCardInfo`               | ✅         | The information of the card used to make the preauthorization. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a single `CreateCommercialOrderPreauthorizationResponse` object representing the preauthorization.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const preauthorization = await createCommercialOrderPreauthorization({
+ *   orderId: "commercialOrder1",
+ *   paymentProvider: "MANGOPAY",
+ *   paymentCardInfo: {
+                      "amount": 0,
+                      "cardId": "card1",
+                      "currency": "EUR"
+                      }
+ * });
+ * ```
+ *
+ * @param {CreateCommercialOrderPreauthorizationParameters} params - The parameters for the request.
+ * @throws {Error} If `orderId`, `paymentProvider` or `paymentCardInfo` is missing.
+ * @returns {Promise<CreateCommercialOrderPreauthorizationResponse>} A promise resolving to a response containing the preauthorization.
+ */
+async function createCommercialOrderPreauthorization({ orderId, paymentProvider, authorId, browserInfo, ipAddress, paymentCardInfo, }) {
+    (0, parameters_validation_1.required)({ orderId, paymentProvider, paymentCardInfo });
+    const { data } = await await (0, fetch_instance_1.enhancedFetch)({
+        method: "POST",
+        path: `/v1/shop/commercial-orders/${orderId}/preauthorization`,
+        body: JSON.stringify({
+            paymentProvider,
+            authorId,
+            browserInfo,
+            ipAddress,
+            paymentCardInfo,
+        }),
+    });
+    return data;
+}
+/**
+ * 🚚 Updates a specific commercial order's shipping address.
+ *
+ * This function updates the shipping address of a specific commercial order, identified by
+ * the `orderId` and the `shippingAddressId`. Both parameters are mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `PUT /v1/shop/commercial-orders/${orderId}/shipping-address [ORDER-202]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `orderId`         | `string`                        | ✅         | The ID of the commercial order of which you want to update the address. |
+ * | `shippingAddressId`| `string`                       | ✅         | The ID of the shipping address to update. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving when the shipping address of the commercial order is updated.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * await updateCommercialOrderShippingAddress({
+ *   orderId: "commercialOrder1",
+ *   shippingAddressId: "shippingAddress1",
+ * });
+ * ```
+ *
+ * @param {UpdateCommercialOrderShippingAddressParameters} params - The parameters for the request.
+ * @throws {Error} If `orderId` or `shippingAddressId` is missing.
+ * @returns {Promise<void>} A promise resolving when shipping address of the commercial order is updated.
  */
 async function updateCommercialOrderShippingAddress({ orderId, shippingAddressId, }) {
     (0, parameters_validation_1.required)({ orderId, shippingAddressId });
-    (0, fetch_instance_1.enhancedFetch)({
+    await (0, fetch_instance_1.enhancedFetch)({
         method: "PUT",
         path: `/v1/shop/commercial-orders/${orderId}/shipping-address`,
         body: JSON.stringify({
@@ -128,11 +451,38 @@ async function updateCommercialOrderShippingAddress({ orderId, shippingAddressId
     });
 }
 /**
- * Update commercial order shipping information
+ * 🚚 Updates a specific commercial order's shipping information.
+ *
+ * This function updates the shipping information of a specific commercial order, identified by
+ * the `orderId` and the `shippingAddressId`. Both parameters are mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `PUT /v1/shop/commercial-orders/${orderId}/shipping-information [ORDER-215]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `orderId`         | `string`                        | ✅         | The ID of the commercial order of which you want to update the address. |
+ * | `shippingAddressId`| `string`                       | ✅         | The ID of the shipping address to update. |
+ * | `shippingType    `| `string`                        | ✅         | The shipping type to set to the commercial order. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving when the shipping address of the commercial order is updated.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * await updateCommercialOrderShippingInformation({
+ *   orderId: "commercialOrder1",
+ *   shippingAddressId: "shippingAddress1",
+ * });
+ * ```
+ *
+ * @param {UpdateCommercialOrderShippingInformationParameters} params - The parameters for the request.
+ * @throws {Error} If `orderId` or `shippingAddressId` is missing.
+ * @returns {Promise<void>} A promise resolving when shipping information of the commercial order is updated.
  */
 async function updateCommercialOrderShippingInformation({ orderId, shippingAddressId, shippingType, }) {
     (0, parameters_validation_1.required)({ orderId, shippingAddressId, shippingType });
-    (0, fetch_instance_1.enhancedFetch)({
+    await (0, fetch_instance_1.enhancedFetch)({
         method: "PUT",
         path: `/v1/shop/commercial-orders/${orderId}/shipping-information`,
         body: JSON.stringify({
@@ -142,11 +492,37 @@ async function updateCommercialOrderShippingInformation({ orderId, shippingAddre
     });
 }
 /**
- * Update commercial order shipping type
+ * 🚚 Updates a specific commercial order's shipping type.
+ *
+ * This function updates the shipping type of a specific commercial order, identified by
+ * the `orderId`. This parameter is mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `PUT /v1/shop/commercial-orders/${orderId}/shipping-information [ORDER-215]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `orderId`         | `string`                        | ✅         | The ID of the commercial order of which you want to update the address. |
+ * | `shippingType    `| `string`                        | ✅         | The shipping type to set to the commercial order. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving when the shipping type of the commercial order is updated.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * await updateCommercialOrderShippingType({
+ *   orderId: "commercialOrder1",
+ *   shippingAddressId: "shippingAddress1",
+ * });
+ * ```
+ *
+ * @param {UpdateCommercialOrderShippingTypeParameters} params - The parameters for the request.
+ * @throws {Error} If `orderId` or `shippingType` is missing.
+ * @returns {Promise<void>} A promise resolving when shipping type of the commercial order is updated.
  */
 async function updateCommercialOrderShippingType({ orderId, shippingType, }) {
     (0, parameters_validation_1.required)({ orderId, shippingType });
-    (0, fetch_instance_1.enhancedFetch)({
+    await (0, fetch_instance_1.enhancedFetch)({
         method: "PUT",
         path: `/v1/shop/commercial-orders/${orderId}/shipping-type`,
         body: JSON.stringify({
@@ -154,15 +530,3 @@ async function updateCommercialOrderShippingType({ orderId, shippingType, }) {
         }),
     });
 }
-/**
- * Update order logistic custom fields value
- */
-async function updateLogisticOrderCustomFieldsValue({ orderLogisticId, customFieldsValues, }) {
-    (0, parameters_validation_1.required)({ orderLogisticId });
-    const { data } = await (0, fetch_instance_1.enhancedFetch)({
-        method: "PATCH",
-        path: `/v1/shop/logistic-orders/${orderLogisticId}`,
-        body: JSON.stringify(customFieldsValues),
-    });
-    return data;
-}

package/lib/services/custom-field/definitions.d.ts

@@ -0,0 +1,100 @@
+import { Order, PageableObject } from "../../interfaces/models/common";
+declare enum SealedTarget {
+    OFFER = 0,
+    ACCOUNT = 1,
+    NAVIGATION_CATEGORY = 2,
+    SUPPLIER = 3,
+    CUSTOMER_USER = 4,
+    CUSTOMER_ORGANISATION = 5,
+    ORDER_LOGISTIC = 6,
+    ORDER_COMMERCIAL = 7,
+    ORDER_LOGISTIC_LINE = 8,
+    QUOTE = 9,
+    QUOTE_LINE = 10,
+    ORDER_INCIDENT = 11,
+    THREAD_MESSAGE = 12
+}
+declare enum ExternalSource {
+    MIRAKL = 0,
+    CLIENT = 1,
+    NOT_DEFINED = 2,
+    EXTERN = 3,
+    SYSTEM = 4
+}
+declare enum CustomFieldRole {
+    PRODUCT_TAX_RATE = 0,
+    SHIPPING_TAX_RATE = 1,
+    SHIPPING_TAX_CODE = 2,
+    PRODUCT_TAX_CODE = 3,
+    ORDERS_MANAGED_INTERNALLY = 4,
+    OFFER_VALIDITY_START_DATE = 5,
+    OFFER_VALIDITY_END_DATE = 6,
+    AUTOMATIC_ORDER_VALIDATION = 7
+}
+declare enum CustomFieldStatus {
+    ACTIVE = 0,
+    INACTIVE = 1
+}
+declare enum CustomFieldType {
+    LONG_TEXT = 0,
+    TEXT = 1,
+    NUMBER = 2,
+    METRIC = 3,
+    DATE = 4,
+    LIST_TEXT = 5,
+    LIST_METRIC = 6,
+    LIST_NUMBER = 7,
+    BOOLEAN = 8,
+    MEDIA = 9
+}
+declare enum CustomFieldIdType {
+    BUSINESS_ID = 0,
+    EXTERNAL_ID = 1
+}
+interface CustomFieldDto {
+    externalId: string;
+    externalSource: ExternalSource;
+    faceted?: boolean;
+    id?: string;
+    indexable?: boolean;
+    mandatory: boolean;
+    name: string;
+    role?: CustomFieldRole;
+    sealedTarget: boolean;
+    searchable?: boolean;
+    sortable?: boolean;
+    status: CustomFieldStatus;
+    type?: CustomFieldType;
+}
+export interface GetCustomFieldParameters {
+    sealedTarget: SealedTarget;
+    status?: CustomFieldStatus;
+    type?: CustomFieldType;
+    searchCriteria?: string;
+    searchable?: boolean;
+    sortable?: boolean;
+    page?: number;
+    size?: number;
+    sort?: string[];
+}
+export interface GetCustomFieldResponse {
+    content: CustomFieldDto[];
+    empty?: boolean;
+    first?: boolean;
+    last?: boolean;
+    number?: number;
+    numberOfElements?: number;
+    pageable?: PageableObject;
+    size?: number;
+    sort?: Order[];
+    totalElemets?: number;
+    totalPages?: number;
+}
+export interface PostMediaCustomFieldParameters {
+    id: string;
+    customFieldIdType?: CustomFieldIdType;
+    sealedTarget?: SealedTarget;
+    fileName: string;
+    fileSize: number;
+}
+export {};