@djust-b2b/djust-front-sdk 3.0.0-beta.9 → 3.0.1

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

@@ -0,0 +1,986 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCommercialOrders = getCommercialOrders;
+exports.getCommercialOrdersV2 = getCommercialOrdersV2;
+exports.createCommercialOrder = createCommercialOrder;
+exports.createCommercialOrderV2 = createCommercialOrderV2;
+exports.getCommercialOrder = getCommercialOrder;
+exports.updateCommercialOrder = updateCommercialOrder;
+exports.createCommercialOrderCardRegistration = createCommercialOrderCardRegistration;
+exports.updateCommercialOrderBillingInformation = updateCommercialOrderBillingInformation;
+exports.setCommercialOrderStatusAsCreated = setCommercialOrderStatusAsCreated;
+exports.setCommercialOrderStatusAsOnHold = setCommercialOrderStatusAsOnHold;
+exports.syncCommercialOrder = syncCommercialOrder;
+exports.getCommercialOrderPaymentPageUrl = getCommercialOrderPaymentPageUrl;
+exports.createCommercialOrderPreauthorization = createCommercialOrderPreauthorization;
+exports.updateCommercialOrderShippingAddress = updateCommercialOrderShippingAddress;
+exports.updateCommercialOrderShippingInformation = updateCommercialOrderShippingInformation;
+exports.updateCommercialOrderShippingType = updateCommercialOrderShippingType;
+exports.deleteCommercialOrder = deleteCommercialOrder;
+exports.getCommercialOrderLines = getCommercialOrderLines;
+exports.updateCommercialOrderLines = updateCommercialOrderLines;
+exports.deleteCommercialOrderLines = deleteCommercialOrderLines;
+exports.punchoutOciCommercialOrder = punchoutOciCommercialOrder;
+const parameters_validation_1 = require("../../helpers/parameters-validation");
+const fetch_instance_1 = require("../../settings/fetch-instance");
+/**
+ * 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-v1]`
+ *
+ * | Parameter              | Type                | Required | Description                              |
+ * |------------------------|---------------------|----------|------------------------------------------|
+ * | `locale`               | `string`            | ✅       | The locale in which to return the commercial order. |
+ * | `nbPreviewLines`       | `number`            | ❌       | The number of lines to display in the commercial order. |
+ * | `page`                 | `number`            | ❌       | The page number to retrieve. |
+ * | `size`                 | `number`            | ❌       | The number of items per page. |
+ * | `sort`                 | `string[]`          | ❌       | The sort to apply to the results. |
+ * | `connectedUserOnly`    | `boolean`           | ❌       | Filter to show only orders for the connected user. |
+ * | `customerAccountIds`   | `string[]`          | ❌       | Filter by customer account IDs. |
+ * | `sourceTypes`          | `string[]`          | ❌       | Filter by source types. |
+ * | `isValidated`          | `boolean`           | ❌       | Filter by validation status. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a single `GetCommercialOrdersResponse` object representing the page of commercial orders.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const orders = await getCommercialOrders({
+ *   locale: "fr",
+ *   page: 0,
+ *   size: 20,
+ *   sort: ["createdAt,desc"],
+ *   connectedUserOnly: true
+ * });
+ * ```
+ *
+ * @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, page, size, sort, connectedUserOnly, customerAccountIds, sourceTypes, isValidated, }) {
+    (0, parameters_validation_1.required)({ locale });
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+        method: "GET",
+        path: `/v1/shop/commercial-orders`,
+        params: {
+            locale,
+            nbPreviewLines,
+            page,
+            size,
+            sort,
+            connectedUserOnly,
+            customerAccountIds,
+            sourceTypes,
+            isValidated,
+        },
+    });
+    return data;
+}
+/**
+ * 🚚 Gets commercial orders V2.
+ *
+ * This function retrieves all commercial orders (Version 2). The parameter locale is mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `GET /v2/shop/commercial-orders [ORDER-560]`
+ *
+ * | Parameter              | Type                | Required | Description                              |
+ * |------------------------|---------------------|----------|------------------------------------------|
+ * | `page`                 | `number`            | ❌       | The page number to retrieve. |
+ * | `size`                 | `number`            | ❌       | The number of items per page. |
+ * | `sort`                 | `string[]`          | ❌       | The sort to apply to the results. Format: `field:direction` (e.g., `["createdAt:desc", "reference:asc"]`). Supported fields: `createdAt`, `validatedAt`, `updatedAt`, `sourceType`, `sourceId`, `reference`. |
+ * | `locale`               | `string`            | ✅       | The locale (IETF BCP 47) in which to return the commercial order. |
+ * | `connectedUserOnly`    | `boolean`           | ❌       | Filter to show only orders for the connected user. |
+ * | `customerAccountIds`   | `string[]`          | ❌       | Filter by customer account IDs. |
+ * | `sourceTypes`          | `string[]`          | ❌       | Filter by source types. |
+ * | `sourceIds`            | `string[]`          | ❌       | Filter by source IDs. |
+ * | `isValidated`          | `boolean`           | ❌       | Filter by validation status. |
+ * | `nbPreviewLines`       | `number`            | ❌       | The number of lines to display in the commercial order. |
+ * | `cf`                   | `string[]`          | ❌       | Custom field filtering. Format: `<CF_EXTERNAL_ID>|<CF_VALUE>`. AND between different CF external IDs; OR between multiple values of the same CF. |
+ *
+ * **Filters**: AND between different keys; OR between values of the same key.
+ * Unknown or malformed values are silently ignored; empty lists mean no filter.
+ *
+ * **Sorting**: Multiple criteria supported (comma-separated). Default: `createdAt:desc` then `reference:asc` as tie-breaker.
+ * Invalid/malformed sort entries are silently ignored. When sorting by reference, collation is case-insensitive and locale-aware.
+ * Null values are always placed last, regardless of sort direction.
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a single `GetCommercialOrdersV2Response` object representing the page of commercial orders.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const orders = await getCommercialOrdersV2({
+ *   locale: "fr",
+ *   page: 0,
+ *   size: 20,
+ *   sort: ["createdAt:desc", "reference:asc"],
+ *   connectedUserOnly: true,
+ *   cf: ["customField1|value1", "customField1|value2", "customField2|value3"]
+ * });
+ * ```
+ *
+ * @param {GetCommercialOrdersV2Parameters} params - The parameters for the request.
+ * @throws {Error} If `locale` is missing.
+ * @returns {Promise<GetCommercialOrdersV2Response>} A promise resolving to the response containing page object.
+ */
+async function getCommercialOrdersV2({ page, size, sort, locale, connectedUserOnly, customerAccountIds, sourceTypes, sourceIds, isValidated, nbPreviewLines, cf, }) {
+    (0, parameters_validation_1.required)({ locale });
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+        method: "GET",
+        path: `/v2/shop/commercial-orders`,
+        params: {
+            page,
+            size,
+            sort,
+            locale,
+            connectedUserOnly,
+            customerAccountIds,
+            sourceTypes,
+            sourceIds,
+            isValidated,
+            nbPreviewLines,
+            cf,
+        },
+    });
+    return data;
+}
+/**
+ * 🚚 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, origin, originId, paymentInfo, }) {
+    (0, parameters_validation_1.required)({ channel, locale, origin, originId });
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+        method: "POST",
+        path: `/v1/shop/commercial-orders`,
+        params: {
+            nbPreviewLines,
+        },
+        body: JSON.stringify({
+            channel,
+            customFields,
+            locale,
+            origin,
+            originId,
+            paymentInfo,
+        }),
+    });
+    return data;
+}
+/**
+ * 🚚 Creates commercial orders V2.
+ *
+ * This function creates a commercial order (Version 2).
+ *
+ * 🛠 **Endpoint**: `POST /v2/shop/commercial-orders [ORDER-108]`
+ *
+ * | Parameter            | Type                                 | Required  | Description                                               |
+ * |----------------------|--------------------------------------|-----------------------------------------------------------------------|
+ * | `customFieldIdType`  | `IdType`                             |     ❌    | The custom field id type to use.                          |
+ * | `customFields`       | `CustomFieldValueRequest[]`          |     ❌    | The custom fields to add to the created commercial order. |
+ * | `isFull`             | `boolean`                            |     ❌    | Whether the order is full or not.                          |
+ * | `sourceId`           | `string`                             |     ❌    | The source ID for the order.                               |
+ * | `sourceType`         | `string`                             |     ❌    | The type of source (e.g., "OPERATION").                   |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a single `CreateCommercialOrderV2Response` object representing the created commercial orders [ORDER-108].
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const orders = await createCommercialOrderV2({
+ *   customFieldIdType: "EXTERNAL_ID",
+ *   customFields: [
+ *     {
+ *       "customFieldId": "string",
+ *       "customFieldValue": "string"
+ *     }
+ *   ],
+ *   isFull: true,
+ *   sourceId: "OPE-UK-SUMMER-2025",
+ *   sourceType: "OPERATION"
+ * });
+ * ```
+ *
+ * @param {CreateCommercialOrderV2Parameters} params - The body of the request.
+ * @returns {Promise<CreateCommercialOrderV2Response>} A promise resolving to the response containing the created commercial orders.
+ */
+async function createCommercialOrderV2({ customFieldIdType, customFields, isFull, sourceId, sourceType, }) {
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+        method: "POST",
+        path: `/v2/shop/commercial-orders`,
+        body: JSON.stringify({
+            customFieldIdType,
+            customFields,
+            isFull,
+            sourceId,
+            sourceType,
+        }),
+    });
+    return data;
+}
+/**
+ * 🚚 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`, `REFERENCE`). |
+ * | `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)({
+        method: "GET",
+        path: `/v1/shop/commercial-orders/${orderId}`,
+        params: {
+            locale,
+            idType,
+            nbPreviewLines,
+        },
+    });
+    return data;
+}
+/**
+ * 🚚 Update commercial orders.
+ *
+ * This function update a commercial order.
+ *
+ * 🛠 **Endpoint**: `POST /v2/shop/commercial-orders/${commercialOrderId} [ORDER-222]`
+ *
+ * | Parameter            | Type                                 | Required  | Description                                              |
+ * |----------------------|--------------------------------------|----------------------------------------------------------------------|
+ * | `commercialOrderId`  | `string`                             |     ✅    | The commercial order Id.                                 |
+ * | `customFieldIdType`  | `IdType`                             |     ❌    | The custom field id type to use.                          |
+ * | `customFields`       | `CustomFieldValueRequest[]`          |     ❌    | The custom fields to add to the created commercial order. |
+ *
+ * 📤 **Returns**:
+ * A `Promise<void>` when the commercialOrder is successfully updated. No additional data is returned.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const orders = await updateCommercialOrder({
+ *   customFieldIdType: "EXTERNAL_ID",
+ *   customFields: [
+ *     {
+ *       "customFieldId": "string",
+ *       "customFieldValue": "string"
+ *     }
+ *   ],
+ * });
+ * ```
+ *
+ * @param {UpdateCommercialOrderParameters} params - The params of the request.
+ * @returns {Promise<void>}
+ */
+async function updateCommercialOrder({ commercialOrderId, customFieldIdType, customFields, }) {
+    (0, parameters_validation_1.required)({ commercialOrderId });
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+        method: "PUT",
+        path: `/v2/shop/commercial-orders/${commercialOrderId}`,
+        body: JSON.stringify({
+            customFieldIdType,
+            customFields,
+        }),
+    });
+    return data;
+}
+/**
+ * 🚚 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 });
+    await (0, fetch_instance_1.enhancedFetch)({
+        method: "PUT",
+        path: `/v1/shop/commercial-orders/${orderId}/billing-information`,
+        body: JSON.stringify({
+            billingAddressId,
+        }),
+    });
+}
+/**
+ * 🚚 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 });
+    await (0, fetch_instance_1.enhancedFetch)({
+        method: "PUT",
+        path: `/v1/shop/commercial-orders/${orderId}/created`,
+        ...(paymentInfo != null ? { body: JSON.stringify(paymentInfo) } : {}),
+    });
+}
+/**
+ * 🚚 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 });
+    await (0, fetch_instance_1.enhancedFetch)({
+        method: "PUT",
+        path: `/v1/shop/commercial-orders/${orderId}/hold`,
+    });
+}
+/**
+ * 🚚 Sync commercial order (ORDER-223).
+ *
+ * Synchronises a commercial order so it remains consistent with the current
+ * pricing, availability and configuration rules applied to its order lines.
+ * Supports RTP (Real Time Pricing) and standard mode depending on tenant config.
+ *
+ * 🛠 Endpoint: `PUT /v1/shop/commercial-orders/{orderCommercialReference}/sync`
+ *
+ * | Parameter | Type     | Required | Description                                                                 |
+ * |-----------|----------|----------|-----------------------------------------------------------------------------|
+ * | `orderId` | `string` | ✅       | Commercial order ID (REFERENCE only; business/external IDs not supported)    |
+ *
+ * 📤 Returns:
+ * Array of synchronisation warnings (`id`, `code`, `blocked`, `detail`). Empty array if no warning.
+ *
+ * 🛠 Example usage:
+ * ```ts
+ * const warnings = await syncCommercialOrder("CO-2026-000123");
+ * if (warnings.some((w) => w.blocked)) { ... }
+ * ```
+ *
+ * @param {string} orderId - Commercial order reference to synchronize
+ * @returns {Promise<SyncCommercialOrderResponse>} Synchronisation warnings; empty array if none
+ */
+async function syncCommercialOrder(orderId) {
+    (0, parameters_validation_1.required)({ orderId });
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+        method: "PUT",
+        path: `/v1/shop/commercial-orders/${orderId}/sync`,
+        body: JSON.stringify({}),
+    });
+    return data ?? [];
+}
+/**
+ * 🚚 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)({
+        method: "GET",
+        path: `/v1/shop/commercial-orders/${orderId}/payment-page`,
+        params: {
+            paymentOption,
+            paymentProvider,
+        },
+    });
+    return data.url;
+}
+/**
+ * 🚚 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 (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 });
+    await (0, fetch_instance_1.enhancedFetch)({
+        method: "PUT",
+        path: `/v1/shop/commercial-orders/${orderId}/shipping-address`,
+        body: JSON.stringify({
+            shippingAddressId,
+        }),
+    });
+}
+/**
+ * 🚚 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 });
+    await (0, fetch_instance_1.enhancedFetch)({
+        method: "PUT",
+        path: `/v1/shop/commercial-orders/${orderId}/shipping-information`,
+        body: JSON.stringify({
+            shippingAddressId,
+            shippingType,
+        }),
+    });
+}
+/**
+ * 🚚 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 });
+    await (0, fetch_instance_1.enhancedFetch)({
+        method: "PUT",
+        path: `/v1/shop/commercial-orders/${orderId}/shipping-type`,
+        body: JSON.stringify({
+            shippingType,
+        }),
+    });
+}
+/**
+ * ❌ Deletes a specific commercial order.
+ *
+ * This function deletes a commercial order identified by the `commercialOrderId`.
+ * The `commercialOrderId` parameter is required and validated before the request is executed.
+ *
+ * 🛠 **Endpoint**: `DELETE /v2/shop/commercial-orders/${commercialOrderId}` [ORDER-300]
+ *
+ * | Parameter            | Type     | Required | Description                                   |
+ * |----------------------|--------- |----------|-----------------------------------------------|
+ * | `commercialOrderId`  | `string` | ✅       | The ID of the commercial order to be deleted. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving with an empty response (`204 No Content`) when the commercial order is successfully deleted.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * await deleteCommercialOrder("commercialOrder123");
+ * ```
+ *
+ * @param {string} commercialOrderId - The ID of the commercial order to be deleted.
+ * @throws {Error} If `commercialOrderId` is missing.
+ * @returns {Promise<void>} A promise resolving when the commercial order is successfully deleted.
+ */
+async function deleteCommercialOrder(commercialOrderId) {
+    (0, parameters_validation_1.required)({ commercialOrderId });
+    await (0, fetch_instance_1.enhancedFetch)({
+        method: "DELETE",
+        path: `/v2/shop/commercial-orders/${commercialOrderId}`,
+    });
+}
+/**
+ * 🚚 Gets commercial order lines.
+ *
+ * This function retrieves the lines of a commercial order identified by the `commercialOrderId`.
+ * The `commercialOrderId` parameter is mandatory and validated before the request is executed.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/commercial-orders/${commercialOrderId}/lines` [ORDER-561]
+ *
+ * | Parameter           | Type               | Required  | Description                                                    |
+ * |---------------------|--------------------|-----------|----------------------------------------------------------------|
+ * | `commercialOrderId` | `string`           | ✅        | The ID of the commercial order whose lines are to be retrieved |
+ * | `page`              | `number`           | ❌        | The page number to retrieve                                    |
+ * | `size`              | `number`           | ❌        | The number of items per page                                   |
+ * | `sort`              | `string`           | ❌        | The sort to apply to the results                               |
+ * | `supplierIds`       | `string[]`         | ❌        | Filter by supplier IDs                                         |
+ * | `productVariantIds` | `string[]`         | ❌        | Filter by product variant IDs                                  |
+ * | `offerPriceIds`     | `string[]`         | ❌        | Filter by offer price IDs                                      |
+ * | `idType`            | `string`           | ❌        | The ID type to use                                             |
+ * | `locale`            | `string`           | ❌        | The locale for the response data                               |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetOrderCommercialLinesResponse` object containing the commercial order lines.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const response = await getCommercialOrderLines({
+ *   commercialOrderId: "commercialOrder123",
+ *   page: 0,
+ *   size: 20,
+ *   sort: "createdAt,desc",
+ *   locale: "fr"
+ * });
+ * ```
+ *
+ * @param {GetOrderCommercialLinesParameters} params - The parameters for the request
+ * @throws {Error} If `commercialOrderId` is missing
+ * @returns {Promise<GetOrderCommercialLinesResponse>} A promise resolving to the response containing the commercial order lines
+ */
+async function getCommercialOrderLines({ commercialOrderId, page, size, sort, supplierIds, productVariantIds, offerPriceIds, idType, locale, }) {
+    (0, parameters_validation_1.required)({ commercialOrderId });
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+        method: "GET",
+        path: `/v1/shop/commercial-orders/${commercialOrderId}/lines`,
+        params: {
+            page,
+            sort,
+            size,
+            supplierIds,
+            productVariantIds,
+            offerPriceIds,
+            idType,
+            locale,
+        },
+    });
+    return data;
+}
+/**
+ * 🚚 Update specific commercial order lines.
+ *
+ * This function update commercial order lines identified by the `commercialOrderId`.
+ * This `commercialOrderId` parameter is required and validated before the request is executed.
+ *
+ * 🛠 **Endpoint**: `PUT /v2/shop/commercial-orders/${commercialOrderId}/lines` [ORDER-150]
+ *
+ * | Parameter                          | Type                                 | Required        | Description                                                    |
+ * |------------------------------------|--------------------------------------|-----------------|----------------------------------------------------------------|
+ * | `commercialOrderId`                | `string`                             | ✅              | The ID of the commercial order whose lines are to be deleted   |
+ * | `customFieldIdType`                | `IdType`                             | ❌              | The custom field id type to use.                               |
+ * | `lineIdType`                       | `string`                             | ❌              | The line id type to use.                                       |
+ * | `lineType`                         | `string`                             | ❌              | The line type to use.                                          |
+ * | `updateOrderCommercialLines`       | `OrderLogisticLineUpdate[]`          | ❌              | Attributes to update. Can be empty object.                     |
+ * | `metadata`                         | `{ [key: string]: any }`             | ❌              | Metadata to update. Can be empty object.                       |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving when the commercial order lines are successfully updated.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const response = await updateCommercialOrderLines("commercialOrder123", {
+ *    customFieldType: "DJUST_ID",
+ *    lineIdType: "string",
+ *    lineType: "string",
+ *    updateOrderCommercialLines: [
+ *      {
+ *        customFields: [
+ *          {
+ *            customFieldId: "string",
+ *            value: "string"
+ *          }
+ *        ],
+ *        id: "string",
+ *        quantity: 0,
+ *        updateAction: "ADD_QUANTITY"
+ *      }
+ *    ],
+ *    metadata: {
+ *      "key": "value"
+ *    }
+ * });
+ * ```
+ *
+ * @param {UpdateCommercialOrderLinesParameters} params - The parameters for the request.
+ * @throws {Error} If `commercialOrderId` is missing.
+ * @returns {Promise<UpdateCommercialOrderLinesResponse>} A promise resolving when the commercial order lines are successfully updated.
+ */
+async function updateCommercialOrderLines({ commercialOrderId, customFieldIdType, lineIdType, lineType, updateOrderCommercialLines, metadata, }) {
+    (0, parameters_validation_1.required)({ commercialOrderId });
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+        method: "PUT",
+        path: `/v2/shop/commercial-orders/${commercialOrderId}/lines`,
+        body: JSON.stringify({
+            customFieldIdType,
+            lineIdType,
+            lineType,
+            updateOrderCommercialLines,
+            metadata,
+        }),
+    });
+    return data;
+}
+/**
+ * ❌ Deletes specific commercial order lines.
+ *
+ * This function deletes commercial order lines identified by the `commercialOrderId`.
+ * The `commercialOrderId` parameter is mandatory and validated before the request is executed.
+ *
+ * 🛠 **Endpoint**: `DELETE /v2/shop/commercial-orders/${commercialOrderId}/lines` [ORDER-350]
+ *
+ * | Parameter            | Type               | Required | Description                                                   |
+ * |----------------------|------------------- |----------|---------------------------------------------------------------|
+ * | `commercialOrderId`  | `string`           | ✅       | The ID of the commercial order whose lines are to be deleted  |
+ * | `body`               | `OfferToDelete[]`  | ❌       | The list of offers to delete. Can be empty.                   |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving when the commercial order lines are successfully deleted.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const response = await deleteCommercialOrderLines("commercialOrder123", [{ offerPriceId: "price456" }]);
+ * ```
+ *
+ * @param {DeleteCommercialOrderLinesParameters} params - The parameters for the request.
+ * @throws {Error} If `commercialOrderId` is missing.
+ * @returns {Promise<DeleteCommercialOrderLinesResponse>} A promise resolving when the commercial order lines are successfully deleted.
+ */
+async function deleteCommercialOrderLines({ commercialOrderId, body, }) {
+    (0, parameters_validation_1.required)({ commercialOrderId });
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+        method: "DELETE",
+        path: `/v2/shop/commercial-orders/${commercialOrderId}/lines`,
+        body: JSON.stringify(body),
+    });
+    return data;
+}
+/**
+ * 🚚 Punchout for specific commercial order.
+ *
+ * This function retrieves commercial order's data needed for the punchout, with order identified by the `commercialOrderId`.
+ * This `commercialOrderId` parameter is required and validated before the request is executed.
+ *
+ * 🛠 **Endpoint**: `GET /punchout/oci/${tenantConfigurationKey}/commercial-orders/${commercialOrderId}`
+ *
+ * | Parameter                          | Type                                 | Required        | Description                                                    |
+ * |------------------------------------|--------------------------------------|-----------------|----------------------------------------------------------------|
+ * | `tenantConfigurationKey`           | `string`                             | ✅              | The combination of tenant id and tenant OCI                          |
+ * | `commercialOrderId`                | `string`                             | ✅              | The ID of the commercial order whose lines are to be deleted   |
+ * | `locale`                           | `string`                             | ✅              | The locale in which to return the commercial order.            |
+
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving when the punchout data are successfully retrieved
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const response = await punchoutOciCommercialOrder({
+ *    tenantConfigurationKey: "0000000300-0000000001",
+ *    commercialOrderId: "commercialOrder123",
+ *    locale: "EN",
+ * });
+ * ```
+ *
+ * @param {PunchoutOciCommercialOrderParameters} params - The parameters for the request.
+ * @throws {Error} If `commercialOrderId` or `tenantConfigurationKey` is missing.
+ * @returns {Promise<Map(<string,string>)>} A promise resolving when the punchout data are successfully retrieved.
+ */
+async function punchoutOciCommercialOrder({ tenantConfigurationKey, commercialOrderId, locale, }) {
+    (0, parameters_validation_1.required)({ commercialOrderId, tenantConfigurationKey });
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+        method: "GET",
+        path: `/cxml/punchout/oci/${tenantConfigurationKey}/commercial-orders/${commercialOrderId}`,
+        params: {
+            locale,
+        },
+    });
+    return data;
+}
+//# sourceMappingURL=index.js.map