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

package/lib/services/commercial-order/index.d.ts

@@ -1,45 +1,391 @@
-import { CreateCommercialOrderParameters, CreateCommercialOrderResponse, GetCommercialOrderParameters, GetCommercialOrderPaymentPageUrlParameters, GetCommercialOrderResponse, GetCommercialOrdersParameters, GetCommercialOrdersResponse, SetCommercialOrderStatusAsCreatedParameters, SetCommercialOrderStatusAsOnHoldParameters, UpdateCommercialOrderBillingInformationParameters, UpdateCommercialOrderShippingAddressParameters, UpdateCommercialOrderShippingInformationParameters, UpdateCommercialOrderShippingTypeParameters, UpdateOrderLogisticCustomFieldParameters, UpdateOrderLogisticCustomFieldResponse } from "./definitions";
+import { CreateCommercialOrderCardRegistrationParameters, CreateCommercialOrderCardRegistrationResponse, CreateCommercialOrderParameters, CreateCommercialOrderPreauthorizationParameters, CreateCommercialOrderPreauthorizationResponse, CreateCommercialOrderResponse, GetCommercialOrderParameters, GetCommercialOrderPaymentPageUrlParameters, GetCommercialOrderResponse, GetCommercialOrdersParameters, GetCommercialOrdersResponse, SetCommercialOrderStatusAsCreatedParameters, SetCommercialOrderStatusAsOnHoldParameters, UpdateCommercialOrderBillingInformationParameters, UpdateCommercialOrderShippingAddressParameters, UpdateCommercialOrderShippingInformationParameters, UpdateCommercialOrderShippingTypeParameters } from "./definitions";
 /**
- * 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.
  */
 export declare function getCommercialOrders({ locale, nbPreviewLines, }: GetCommercialOrdersParameters): Promise<GetCommercialOrdersResponse>;
 /**
- * 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.
  */
 export declare function createCommercialOrder({ nbPreviewLines, channel, customFields, locale, originId, paymentInfo, }: CreateCommercialOrderParameters): Promise<CreateCommercialOrderResponse>;
 /**
- * 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.
  */
 export declare function getCommercialOrder({ orderId, idType, locale, nbPreviewLines, }: GetCommercialOrderParameters): Promise<GetCommercialOrderResponse>;
 /**
- * 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.
+ */
+export declare function createCommercialOrderCardRegistration({ orderId, paymentProvider, currency, }: CreateCommercialOrderCardRegistrationParameters): Promise<CreateCommercialOrderCardRegistrationResponse>;
+/**
+ * 🚚 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.
  */
 export declare function updateCommercialOrderBillingInformation({ orderId, billingAddressId, }: UpdateCommercialOrderBillingInformationParameters): Promise<void>;
 /**
- * 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.
  */
 export declare function setCommercialOrderStatusAsCreated({ orderId, paymentInfo, }: SetCommercialOrderStatusAsCreatedParameters): Promise<void>;
 /**
- * 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.
  */
 export declare function setCommercialOrderStatusAsOnHold({ orderId, }: SetCommercialOrderStatusAsOnHoldParameters): Promise<void>;
 /**
- * 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.
  */
 export declare function getCommercialOrderPaymentPageUrl({ orderId, paymentOption, paymentProvider, }: GetCommercialOrderPaymentPageUrlParameters): Promise<string>;
 /**
- * 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.
+ */
+export declare function createCommercialOrderPreauthorization({ orderId, paymentProvider, authorId, browserInfo, ipAddress, paymentCardInfo, }: CreateCommercialOrderPreauthorizationParameters): Promise<CreateCommercialOrderPreauthorizationResponse>;
+/**
+ * 🚚 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.
  */
 export declare function updateCommercialOrderShippingAddress({ orderId, shippingAddressId, }: UpdateCommercialOrderShippingAddressParameters): Promise<void>;
 /**
- * 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.
  */
 export declare function updateCommercialOrderShippingInformation({ orderId, shippingAddressId, shippingType, }: UpdateCommercialOrderShippingInformationParameters): Promise<void>;
 /**
- * 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.
  */
 export declare function updateCommercialOrderShippingType({ orderId, shippingType, }: UpdateCommercialOrderShippingTypeParameters): Promise<void>;
-/**
- * Update order logistic custom fields value
- */
-export declare function updateLogisticOrderCustomFieldsValue({ orderLogisticId, customFieldsValues, }: UpdateOrderLogisticCustomFieldParameters): Promise<UpdateOrderLogisticCustomFieldResponse>;