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

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

@@ -1,105 +1,876 @@
-import { AddLogisticOrderReviewParameters, AddLogisticOrderReviewResponse, ApproveLogisticOrderParameters, ApproveLogisticOrderResponse, CancelLogisticOrderParameters, CancelLogisticOrderResponse, ConfirmLogisticOrderReceptionParameters, ConfirmLogisticOrderReceptionResponse, CreateLogisticOrderThreadParameters, DisapproveLogisticOrderParameters, DisapproveLogisticOrderResponse, GetLogisticOrderAccountingDocumentsParameters, GetLogisticOrderAccountingDocumentsResponse, GetLogisticOrderAccountingDocumentUrlParameters, GetLogisticOrderApproversParameters, GetLogisticOrderApproversResponse, GetLogisticOrderCustomFieldsParameters, GetLogisticOrderCustomFieldsResponse, GetLogisticOrderDocumentsParameters, GetLogisticOrderDocumentsResponse, GetLogisticOrderDocumentUrlParameters, GetLogisticOrderLineCustomFieldsParameters, GetLogisticOrderLineCustomFieldsResponse, GetLogisticOrderLinesParameters, GetLogisticOrderLinesResponse, GetLogisticOrderParameters, GetLogisticOrderResponse, GetLogisticOrderReviewParameters, GetLogisticOrderReviewResponse, GetLogisticOrderShippingAddressParameters, GetLogisticOrderShippingAddressResponse, GetLogisticOrdersParameters, GetLogisticOrdersResponse, GetThreadReasonTypesResponse, GetThreadSubReasonsParameters, GetThreadSubReasonsResponse, UpdateLogisticOrderBillingInformationParameters, UpdateLogisticOrderCustomFieldsParameters, UpdateLogisticOrderCustomFieldsResponse, UpdateLogisticOrderLineCustomFieldsParameters, UpdateLogisticOrderLineCustomFieldsResponse, UpdateLogisticOrderShippingAddressParameters, UpdateLogisticOrderShippingInformationParameters, UpdateLogisticOrderShippingTypeParameters } from "./definitions";
+import { AddLogisticOrderReviewParameters, AddLogisticOrderReviewResponse, ApproveLogisticOrderParameters, ApproveLogisticOrderResponse, CancelLogisticOrderParameters, CancelLogisticOrderResponse, ConfirmLogisticOrderReceptionParameters, ConfirmLogisticOrderReceptionResponse, CreateLogisticOrderParameters, CreateLogisticOrderThreadParameters, DisapproveLogisticOrderParameters, DisapproveLogisticOrderResponse, GetLogisticOrderAccountingDocumentsParameters, GetLogisticOrderAccountingDocumentsResponse, GetLogisticOrderAccountingDocumentUrlParameters, GetLogisticOrderApproversParameters, GetLogisticOrderApproversResponse, GetLogisticOrderCustomFieldsParameters, GetLogisticOrderCustomFieldsResponse, GetLogisticOrderDocumentsParameters, GetLogisticOrderDocumentsResponse, GetLogisticOrderDocumentUrlParameters, GetLogisticOrderLineCustomFieldsParameters, GetLogisticOrderLineCustomFieldsResponse, GetLogisticOrderLinesParameters, GetLogisticOrderLinesResponse, GetLogisticOrderParameters, GetLogisticOrderResponse, GetLogisticOrderReviewParameters, GetLogisticOrderReviewResponse, GetLogisticOrderShippingAddressParameters, GetLogisticOrderShippingAddressResponse, GetLogisticOrdersParameters, GetLogisticOrdersResponse, GetThreadReasonTypesResponse, GetThreadSubReasonsParameters, GetThreadSubReasonsResponse, UpdateLogisticOrderBillingInformationParameters, UpdateLogisticOrderCustomFieldsParameters, UpdateLogisticOrderCustomFieldsResponse, UpdateLogisticOrderLineCustomFieldsParameters, UpdateLogisticOrderLineCustomFieldsResponse, UpdateLogisticOrderShippingAddressParameters, UpdateLogisticOrderShippingInformationParameters, UpdateLogisticOrderShippingTypeParameters, UpdateOnHoldLogisticOrderLineParameters, UpdateOnHoldLogisticOrderLinesParameters, UpdateOnHoldLogisticOrderLinesResponse } from "./definitions";
 /**
- * Get commercial orders
+ * 🚚 Gets logistic orders.
+ *
+ * This function retrieves all logistic orders. The parameter locale is mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/logistic-orders [ORDER-550]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `approvalIds`     | `string`                        | ❌         | The IDs of the users responsible for the approval of the logistic order. |
+ * | `locale`          | `string`                        | ✅         | The locale in which to return the logistic order. |
+ * | `logisticStatus`  | `OrderLogisticStatusType[]`     | ❌         | The statuses of the logistic orders you want to retrieve . |
+ * | `incident`        | `boolean`                       | ❌         | Whether you want to retrieve incidents or not. |
+ * | `paymentOptions`  | `PaymentOption[]`               | ❌         | The types of payment (e.g., `BANK WIRE`, `CREDIT_CARD`). |
+ * | `nbPreviewLines`  | `integer`                       | ❌         | The number of lines to display in the logistic order. |
+ * | `page`            | `integer`                       | ❌         | The page number you want to retrieve. |
+ * | `size`            | `integer`                       | ❌         | The size of the page you want to retrieve. |
+ * | `sort`            | `string`                        | ❌         | The order how you want to retrieve the custom fields. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a single `GetLogisticOrdersResponse` object representing the page of logistic orders.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const orders = await getLogisticOrders({
+ *   locale: "fr",
+ * });
+ * ```
+ *
+ * @param {GetLogisticOrdersParameters} params - The parameters for the request.
+ * @throws {Error} If `locale` is missing.
+ * @returns {Promise<GetLogisticOrdersResponse>} A promise resolving to the response containing page object.
  */
 export declare function getLogisticOrders({ approvalIds, locale, logisticStatus, incident, paymentOptions, nbPreviewLines, page, size, sort, }: GetLogisticOrdersParameters): Promise<GetLogisticOrdersResponse>;
 /**
- * Get logistic order custom fields
+ * 🚚 Get logistic order's custom fields.
+ *
+ * This function retrieves custom fields of logistic orders, identified by
+ * the `customFieldIds`. This parameter is mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/logistic-orders/custom-fields [ORDER-553]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `customFieldIds`  | `string[]`                      | ✅         | The list of custom fields' ID you want to retrieve. |
+ * | `page`            | `integer`                       | ❌         | The page number you want to retrieve. |
+ * | `size`            | `integer`                       | ❌         | The size of the page you want to retrieve. |
+ * | `sort`            | `string`                        | ❌         | The order how you want to retrieve the custom fields. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a single `GetLogisticOrderCustomFieldsResponse` object representing the page of custom fields.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const customFields = await getLogisticOrderCustomFields({
+ *   customFieldIds: ["customFieldId1", "customFieldId2"],
+ *   page: 1,
+ *   size: 20,
+ * });
+ * ```
+ *
+ * @param {GetLogisticOrderCustomFieldsParameters} params - The parameters for the request.
+ * @throws {Error} If `customFieldIds` is missing.
+ * @returns {Promise<GetLogisticOrderCustomFieldsResponse>} A promise resolving to the response containing the page object.
  */
 export declare function getLogisticOrderCustomFields({ customFieldIds, page, size, sort, }: GetLogisticOrderCustomFieldsParameters): Promise<GetLogisticOrderCustomFieldsResponse>;
 /**
- * Get logistic order line custom fields
+ * 🚚 Get logistic order lines' custom fields.
+ *
+ * This function retrieves custom fields of logistic order lines, identified by
+ * the `customFieldIds`. This parameter is mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/logistic-orders/lines/custom-fields [ORDER-554]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `customFieldIds`  | `string[]`                      | ✅         | The list of custom fields' ID you want to retrieve. |
+ * | `page`            | `integer`                       | ❌         | The page number you want to retrieve. |
+ * | `size`            | `integer`                       | ❌         | The size of the page you want to retrieve. |
+ * | `sort`            | `string`                        | ❌         | The order how you want to retrieve the custom fields. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a single `GetLogisticOrderLineCustomFieldsResponse` object representing the page of custom fields.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const customFields = await updateLogisticOrderCustomFields({
+ *   customFieldIds: ["customFieldId1", "customFieldId2"],
+ *   page: 1,
+ *   size: 20,
+ * });
+ * ```
+ *
+ * @param {GetLogisticOrderLineCustomFieldsParameters} params - The parameters for the request.
+ * @throws {Error} If `customFieldIds` is missing.
+ * @returns {Promise<GetLogisticOrderLineCustomFieldsResponse>} A promise resolving to the response containing the page object.
  */
 export declare function getLogisticOrderLineCustomFields({ customFieldIds, page, size, sort, }: GetLogisticOrderLineCustomFieldsParameters): Promise<GetLogisticOrderLineCustomFieldsResponse>;
 /**
- * Get logistic order
+ * 🚚 Gets a specific logistic order.
+ *
+ * This function retrieves a specific logistic order, identified by
+ * the `orderId`. This parameter is mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/logistic-orders/${orderId} [ORDER-501]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `orderId`         | `string`                        | ✅         | The ID of the logistic order you want to retrieve. |
+ * | `locale`          | `string`                        | ✅         | The locale in which to return the logistic order. |
+ * | `nbPreviewLines`  | `integer`                       | ❌         | The number of lines to display in the logistic order. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a single `GetLogisticOrderResponse` object representing the logistic order.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const order = await getLogisticOrder({
+ *   orderId: "logisticOrder1",
+ *   locale: "fr",
+ * });
+ * ```
+ *
+ * @param {GetLogisticOrderParameters} params - The parameters for the request.
+ * @throws {Error} If `orderId` is missing.
+ * @returns {Promise<GetLogisticOrderResponse>} A promise resolving to the response containing the logistic order.
  */
 export declare function getLogisticOrder({ orderId, locale, nbPreviewLines, }: GetLogisticOrderParameters): Promise<GetLogisticOrderResponse>;
 /**
- * Update logistic order custom fields
+ * 🚚 Updates a specific logistic order's custom fields.
+ *
+ * This function updates the custom fields of a specific logistic order, identified by
+ * the `orderId`. This parameter is mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `PATCH /v1/shop/logistic-orders/${orderId} [ORDER-205]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `orderId`         | `string`                        | ✅         | The ID of the logistic order of which you want to update the custom fields. |
+ * | `customFields`    | `CustomFieldValueObject[]`      | ✅         | The custom fields with value and externalId. |
+ * | `locale`          | `string`                        | ❌         | The locale in which to return the logistic order. |
+ * | `nbPreviewLines`  | `integer`                       | ❌         | The number of lines to display in the logistic order. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a single `UpdateOrderLogisticCustomFieldResponse` object representing the logistic order.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const order = await updateLogisticOrderCustomFields({
+ *   orderId: "logisticOrder1",
+ *   customFields: [{ customFieldId: "externalId1", customFieldValue: "value1" }, { customFieldId: "externalId2", customFieldValue: "value2" }],
+ * });
+ * ```
+ *
+ * @param {UpdateOrderLogisticCustomFieldParameters} params - The parameters for the request.
+ * @throws {Error} If `orderId` or `customFields` is missing.
+ * @returns {Promise<UpdateOrderLogisticCustomFieldResponse>} A promise resolving to the response containing the logistic order.
  */
 export declare function updateLogisticOrderCustomFields({ orderId, locale, nbPreviewLines, customFields, }: UpdateLogisticOrderCustomFieldsParameters): Promise<UpdateLogisticOrderCustomFieldsResponse>;
 /**
- * Get logistic order accounting documents
+ * 🚚 Gets a specific logistic order's accounting documents.
+ *
+ * This function retrieves the accounting documents of a specific logistic order, identified by
+ * the `orderId`. This parameter is mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/logistic-orders/${orderId}/accounting-documents [ORDER-551]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `orderId`         | `string`                        | ✅         | The ID of the logistic order of which you want to retrieve the accounting documents. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a single `GetLogisticOrderAccountingDocumentsResponse` object representing the list of accounting documents of the logistic order.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const accountingDocuments = await getLogisticOrderAccountingDocuments({
+ *   orderId: "logisticOrder1",
+ * });
+ * ```
+ *
+ * @param {GetLogisticOrderAccountingDocumentsParameters} params - The parameters for the request.
+ * @throws {Error} If `orderId` is missing.
+ * @returns {Promise<GetLogisticOrderAccountingDocumentsResponse>} A promise resolving to the response containing the list of accounting documents.
  */
 export declare function getLogisticOrderAccountingDocuments({ orderId, }: GetLogisticOrderAccountingDocumentsParameters): Promise<GetLogisticOrderAccountingDocumentsResponse>;
 /**
- * Get logistic order accounting document
+ * 🚚 Gets specific accounting document urls of a specific logistic order.
+ *
+ * This function retrieves specific accounting document urls of a specific logistic order, both identified by
+ * the `orderId` and the `documentId`. Both parameters are mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/logistic-orders/${orderId}/accounting-documents/{documentId} [ORDER-506]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `orderId`         | `string`                        | ✅         | The ID of the logistic order of which you want to retrieve the accounting documents. |
+ * | `documentId`      | `string`                        | ✅         | The ID of the accounting document to be downloaded. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a single `GetLogisticOrderAccountingDocumentsResponse` object representing the list of accounting document's urls.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const accountingDocumentUrls = await getLogisticOrderAccountingDocumentUrl({
+ *   orderId: "logisticOrder1",
+ *   documentId: "document1",
+ * });
+ * ```
+ *
+ * @param {GetLogisticOrderAccountingDocumentUrlParameters} params - The parameters for the request.
+ * @throws {Error} If `orderId` or `documentId` is missing.
+ * @returns {Promise<string[]>} A promise resolving to the response containing the list of document's urls.
  */
 export declare function getLogisticOrderAccountingDocumentUrl({ orderId, documentId, }: GetLogisticOrderAccountingDocumentUrlParameters): Promise<string[]>;
 /**
- * Approve logistic order
+ * 🚚 Approves a logistic order.
+ *
+ * This function approves a specific logistic order, identified by the `orderId`. The parameters `orderId` and `locale` are mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `PUT /v1/shop/logistic-orders/${orderId}/approve [ORDER-200]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `orderId`         | `string`                        | ✅         | The ID of the logistic order you want to approve. |
+ * | `locale`          | `string`                        | ✅         | The locale in which to return the logistic order. |
+ * | `nbPreviewLines`  | `integer`                       | ❌         | The number of lines to display in the logistic order. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a single `ApproveLogisticOrderResponse` object representing the logistic order approved.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const order = await approveLogisticOrder({
+ *   orderId: "logisticOrder1",
+ *   locale: "fr",
+ * });
+ * ```
+ *
+ * @param {ApproveLogisticOrderParameters} params - The parameters for the request.
+ * @throws {Error} If `orderId` or `locale` is missing.
+ * @returns {Promise<ApproveLogisticOrderResponse>} A promise resolving to the response containing the logistic order.
  */
 export declare function approveLogisticOrder({ orderId, locale, nbPreviewLines, }: ApproveLogisticOrderParameters): Promise<ApproveLogisticOrderResponse>;
 /**
- * Get logistic order approvers
+ * 🚚 Gets a logistic order's approvers.
+ *
+ * This function retrieves the users able to approve a specific logistic order, identified by the `orderId`. This parameter is mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/logistic-orders/${orderId}/approvers [ORDER-556]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `orderId`         | `string`                        | ✅         | The ID of the logistic order of which you want to retrieve the approvers. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a single `ApproveLogisticOrderResponse` object representing a list of approval objects, a combination of a user, the logistic order and an approval status.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const approvalObjects = await getLogisticOrderApprovers({
+ *   orderId: "logisticOrder1",
+ * });
+ * ```
+ *
+ * @param {GetLogisticOrderApproversParameters} params - The parameters for the request.
+ * @throws {Error} If `orderId` is missing.
+ * @returns {Promise<GetLogisticOrderApproversResponse>} A promise resolving to the response containing a list of approval objects.
  */
 export declare function getLogisticOrderApprovers({ orderId, }: GetLogisticOrderApproversParameters): Promise<GetLogisticOrderApproversResponse>;
 /**
- * Update logistic order billing information
+ * 🚚 Updates a logistic order's billing information.
+ *
+ * This function updates the billing information of a specific logistic order, both identified by the `orderId` and the `billingAddressId`. Both parameters are mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `PUT /v1/shop/logistic-orders/${orderId}/billing-information [ORDER-209]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `orderId`         | `string`                        | ✅         | The ID of the logistic order of which you want to update the billing information. |
+ * | `billingAddressId`| `string`                        | ✅         | The ID of the billing address you want to add to the logistic order. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving when the billing information of the logistic order is updated.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * await updateLogisticOrderBillingInformation({
+ *   orderId: "logisticOrder1",
+ *   billingAddressId: "address1",
+ * });
+ * ```
+ *
+ * @param {UpdateLogisticOrderBillingInformationParameters} params - The parameters for the request.
+ * @throws {Error} If `orderId` or `billingAddressId` is missing.
+ * @returns {Promise<void>} A promise resolving when the billing information is updated.
  */
 export declare function updateLogisticOrderBillingInformation({ orderId, billingAddressId, }: UpdateLogisticOrderBillingInformationParameters): Promise<void>;
 /**
- * Cancel logistic order
+ * 🚚 Cancels a logistic order.
+ *
+ * This function cancels a specific logistic order, identified by the `orderId`. The parameters `orderId` and `locale` are mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `PUT /v1/shop/logistic-orders/${orderId}/cancel [ORDER-201]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `orderId`         | `string`                        | ✅         | The ID of the logistic order you want to cancel. |
+ * | `locale`          | `string`                        | ✅         | The locale in which to return the logistic order. |
+ * | `nbPreviewLines`  | `integer`                       | ❌         | The number of lines to display in the logistic order. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a single `CancelLogisticOrderResponse` object representing the logistic order cancelled.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const order = await cancelLogisticOrder({
+ *   orderId: "logisticOrder1",
+ *   locale: "fr",
+ * });
+ * ```
+ *
+ * @param {CancelLogisticOrderParameters} params - The parameters for the request.
+ * @throws {Error} If `orderId` or `locale` is missing.
+ * @returns {Promise<CancelLogisticOrderResponse>} A promise resolving to the response containing the logistic order.
  */
 export declare function cancelLogisticOrder({ orderId, locale, nbPreviewLines, }: CancelLogisticOrderParameters): Promise<CancelLogisticOrderResponse>;
 /**
- * Confirm logistic order reception
+ * 🚚 Confirms reception of logistic order.
+ *
+ * This function confirms the reception of a specific logistic order, identified by the `orderId`. The parameters `orderId` and `locale` are mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `PUT /v1/shop/logistic-orders/${orderId}/confirm-reception [ORDER-203]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `orderId`         | `string`                        | ✅         | The ID of the logistic order you want to confirm reception. |
+ * | `locale`          | `string`                        | ✅         | The locale in which to return the logistic order. |
+ * | `nbPreviewLines`  | `integer`                       | ❌         | The number of lines to display in the logistic order. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a single `ConfirmLogisticOrderReceptionResponse` object representing the logistic order received.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const order = await confirmLogisticOrderReception({
+ *   orderId: "logisticOrder1",
+ *   locale: "fr",
+ * });
+ * ```
+ *
+ * @param {ConfirmLogisticOrderReceptionParameters} params - The parameters for the request.
+ * @throws {Error} If `orderId` or `locale` is missing.
+ * @returns {Promise<ConfirmLogisticOrderReceptionResponse>} A promise resolving to the response containing the logistic order.
  */
 export declare function confirmLogisticOrderReception({ orderId, locale, nbPreviewLines, }: ConfirmLogisticOrderReceptionParameters): Promise<ConfirmLogisticOrderReceptionResponse>;
 /**
- * Disapprove logistic order
+ * 🚚 Update a DRAFT_ORDER_ON_HOLD logistic order to CREATED.
+ *
+ * This function updates the status of a specific logistic order, identified by the `orderId`, from DRAFT_ORDER_ON_HOLD to CREATED. The parameter `orderId` is mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `PUT /v1/shop/logistic-orders/${orderId}/created [ORDER-220]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `orderId`         | `string`                        | ✅         | The ID of the logistic order you want to pass to CREATED. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving when the logistic order's status is passed to CREATED.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * await createLogisticOrder({
+ *   orderId: "logisticOrder1",
+ * });
+ * ```
+ *
+ * @param {CreateLogisticOrderParameters} params - The parameters for the request.
+ * @throws {Error} If `orderId` or `locale` is missing.
+ * @returns {Promise<void>} A promise resolving when the logistic order is created.
+ */
+export declare function createLogisticOrder({ orderId, }: CreateLogisticOrderParameters): Promise<void>;
+/**
+ * 🚚 Disapproves a logistic order.
+ *
+ * This function disapproves a specific logistic order, identified by the `orderId`. The parameters `orderId` and `locale` are mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `PUT /v1/shop/logistic-orders/${orderId}/disapprove [ORDER-204]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `orderId`         | `string`                        | ✅         | The ID of the logistic order you want to disapprove. |
+ * | `locale`          | `string`                        | ✅         | The locale in which to return the logistic order. |
+ * | `nbPreviewLines`  | `integer`                       | ❌         | The number of lines to display in the logistic order. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a single `DisapproveLogisticOrderResponse` object representing the logistic order disapproved.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const order = await disapproveLogisticOrder({
+ *   orderId: "logisticOrder1",
+ *   locale: "fr",
+ * });
+ * ```
+ *
+ * @param {DisapproveLogisticOrderParameters} params - The parameters for the request.
+ * @throws {Error} If `orderId` or `locale` is missing.
+ * @returns {Promise<DisapproveLogisticOrderResponse>} A promise resolving to the response containing the logistic order.
  */
 export declare function disapproveLogisticOrder({ orderId, locale, nbPreviewLines, }: DisapproveLogisticOrderParameters): Promise<DisapproveLogisticOrderResponse>;
 /**
- * Get logistic order documents
+ * 🚚 Gets a specific logistic order's documents.
+ *
+ * This function retrieves the documents of a specific logistic order, identified by
+ * the `orderId`. This parameter is mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/logistic-orders/${orderId}/documents [ORDER-552]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `orderId`         | `string`                        | ✅         | The ID of the logistic order of which you want to retrieve the documents. |
+ * | `idType`          | `OrderIdType`                   | ❌         | The type of order ID (e.g., `DJUST_ID`, `EXTERNAL_ID`, `REFERENCE`). |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a single `GetLogisticOrderDocumentsParameters` object representing the list of documents of the logistic order.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const documents = await getLogisticOrderDocuments({
+ *   orderId: "logisticOrder1",
+ * });
+ * ```
+ *
+ * @param {GetLogisticOrderDocumentsParameters} params - The parameters for the request.
+ * @throws {Error} If `orderId` is missing.
+ * @returns {Promise<GetLogisticOrderDocumentsParameters>} A promise resolving to the response containing the list of documents.
  */
 export declare function getLogisticOrderDocuments({ orderId, idType, }: GetLogisticOrderDocumentsParameters): Promise<GetLogisticOrderDocumentsResponse>;
 /**
- * Get logistic order document url
+ * 🚚 Gets specific document urls of a specific logistic order.
+ *
+ * This function retrieves specific document urls of a specific logistic order, both identified by
+ * the `orderId` and the `documentId`. Both parameters are mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/logistic-orders/${orderId}/documents/{documentId} [ORDER-508]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `orderId`         | `string`                        | ✅         | The ID of the logistic order of which you want to retrieve the documents. |
+ * | `documentId`      | `string`                        | ✅         | The ID of the document to be downloaded. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a single `GetLogisticOrderAccountingDocumentsResponse` object representing the list of document's urls.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const documentUrls = await getLogisticOrderDocumentUrl({
+ *   orderId: "logisticOrder1",
+ *   documentId: "document1",
+ * });
+ * ```
+ *
+ * @param {GetLogisticOrderAccountingDocumentUrlParameters} params - The parameters for the request.
+ * @throws {Error} If `orderId` or `documentId` is missing.
+ * @returns {Promise<string[]>} A promise resolving to the response containing the list of document's urls.
  */
 export declare function getLogisticOrderDocumentUrl({ orderId, documentId, }: GetLogisticOrderDocumentUrlParameters): Promise<string[]>;
 /**
- * Get logistic order lines
+ * 🚚 Gets order lines of a specific logistic order.
+ *
+ * This function retrieves the order lines of a specific logistic order, identified by
+ * the `orderId`. This parameter is mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/logistic-orders/${orderId}/lines [ORDER-555]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `orderId`         | `string`                        | ✅         | The ID of the logistic order of which you want to retrieve the order lines. |
+ * | `page`            | `integer`                       | ❌         | The page number you want to retrieve. |
+ * | `size`            | `integer`                       | ❌         | The size of the page you want to retrieve. |
+ * | `sort`            | `string`                        | ❌         | The order how you want to retrieve the custom fields. |
+ * | `locale`          | `string`                        | ❌         | The locale in which to return the logistic order lines. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a single `GetLogisticOrderLinesResponse` object representing the page of logistic order lines.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const logisticOrderLines = await getLogisticOrderLines({
+ *   orderId: "logisticOrder1",
+ * });
+ * ```
+ *
+ * @param {GetLogisticOrderLinesParameters} params - The parameters for the request.
+ * @throws {Error} If `orderId` is missing.
+ * @returns {Promise<GetLogisticOrderLinesResponse>} A promise resolving to the response containing the page object.
  */
 export declare function getLogisticOrderLines({ orderId, page, size, sort, locale, }: GetLogisticOrderLinesParameters): Promise<GetLogisticOrderLinesResponse>;
 /**
- * Update logistic order line
+ * 🚚 Updates order lines of a specific DRAFT_ORDER_ON_HOLD logistic order.
+ *
+ * This function updates the confirmed quantity and custom field values of the order lines of a specific logistic order, identified by
+ * the `orderId`. This parameter, as well as the `lines`, is mandatory and validated before the request is executed.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/logistic-orders/${orderId}/lines [ORDER-250]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `orderId`         | `string`                        | ✅         | The ID of the logistic order of which you want to update the lines. |
+ * | `lines`           | `OrderLogisticLineUpdate[]`     | ✅         | The lines you want to update. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a single `UpdateOnHoldLogisticOrderLinesResponse` object representing the error report for each lines that failed to update.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const errorReport = await updateOnHoldLogisticOrderLines({
+ *   orderId: "logisticOrder1",
+ *   lines: [
+              {
+                "customFields": [
+                  {
+                    "customFieldId": "customField1",
+                    "customFieldValue": "value1"
+                  }
+                ],
+                "id": "orderLine1",
+                "quantity": 1,
+                "updateAction": "ADD_QUANTITY"
+              }
+            ]
+ * });
+ * ```
+ *
+ * @param {UpdateOnHoldLogisticOrderLinesParameters} params - The parameters for the request.
+ * @throws {Error} If `orderId` or `lines` is missing.
+ * @returns {Promise<UpdateOnHoldLogisticOrderLinesResponse>} A promise resolving to the response containing the error report.
+ */
+export declare function updateOnHoldLogisticOrderLines({ orderId, lines, }: UpdateOnHoldLogisticOrderLinesParameters): Promise<UpdateOnHoldLogisticOrderLinesResponse>;
+/**
+ * 🚚 Updates specific logistic order line's customFields.
+ *
+ * This function updates a specific logistic order line's customFields, identified by both
+ * the `orderId` and the `lineId`. These parameters, as well as the `customFields` is mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `PATCH /v1/shop/logistic-orders/${orderId}/lines/${lineId} [ORDER-206]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `orderId`         | `string`                        | ✅         | The ID of the logistic order of which you want to update an order line. |
+ * | `lineId`          | `string`                        | ✅         | The ID of the logistic order line you want to update. |
+ * | `customFields`    | `CustomFieldValueObject[]`      | ✅         | The custom fields to add with value and externalId. |
+ * | `locale`          | `string`                        | ❌         | The locale in which to return the logistic order lines. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a single `UpdateLogisticOrderLineCustomFieldsResponse` object representing the updated logistic order line.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const newLogisticOrderLine = await updateLogisticOrderLineCustomFields({
+ *   orderId: "logisticOrder1",
+ *   lineId: "logisticOrderLine1",
+ *   customFields: [{externalId: "cf1", value: "value1"}, {externalId: "cf2", value: "value2"}]
+ * });
+ * ```
+ *
+ * @param {UpdateLogisticOrderLineCustomFieldsParameters} params - The parameters for the request.
+ * @throws {Error} If `orderId` or `lineId` is missing.
+ * @returns {Promise<UpdateLogisticOrderLineCustomFieldsResponse>} A promise resolving to the response containing the logistic order line.
  */
 export declare function updateLogisticOrderLineCustomFields({ orderId, lineId, locale, customFields, }: UpdateLogisticOrderLineCustomFieldsParameters): Promise<UpdateLogisticOrderLineCustomFieldsResponse>;
 /**
- * Update logistic order shipping address
+ * 🚚 Updates order line of a specific DRAFT_ORDER_ON_HOLD logistic order.
+ *
+ * This function updates the confirmed quantity of a specific order line of a specific logistic order, both identified by
+ * the `orderId` and the `orderLineId`. Both parameters, as well as the `quantity`, are mandatory and validated before the request is executed.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/logistic-orders/${orderId}/lines/${orderLineId} [ORDER-218]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `orderId`         | `string`                        | ✅         | The ID of the logistic order of which you want to update the lines. |
+ * | `orderLineId`     | `string`                        | ✅         | The ID of the logistic order line you want to update. |
+ * | `quantity`        | `number`                        | ✅         | The lines you want to update. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving when the logistic order line is updated.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * await updateOnHoldLogisticOrderLine({
+ *   orderId: "logisticOrder1",
+ *   orderLineId: "logisticOrderLine1",
+ *   quantity: 1
+ * ```
+ *
+ * @param {UpdateOnHoldLogisticOrderLineParameters} params - The parameters for the request.
+ * @throws {Error} If `orderId`, `orderLineId` or `quantity` is missing.
+ * @returns {Promise<void>} A promise resolving when the logistic order line is updated.
+ */
+export declare function updateOnHoldLogisticOrderLine({ orderId, orderLineId, quantity, }: UpdateOnHoldLogisticOrderLineParameters): Promise<void>;
+/**
+ * 🚚 Updates a logistic order's shipping address.
+ *
+ * This function updates the shipping address of a specific logistic order, both identified by the `orderId` and the `shippingAddressId`. Both parameters are mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `PUT /v1/shop/logistic-orders/${orderId}/shipping-address [ORDER-210]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `orderId`         | `string`                        | ✅         | The ID of the logistic order of which you want to update the shipping address. |
+ * | `shippingAddressId`| `string`                        | ✅         | The ID of the shipping address you want to set to the logistic order. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving when the shipping address of the logistic order is set.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * await updateLogisticOrderShippingAddress({
+ *   orderId: "logisticOrder1",
+ *   shippingAddressId: "address1",
+ * });
+ * ```
+ *
+ * @param {UpdateLogisticOrderShippingInformationParameters} params - The parameters for the request.
+ * @throws {Error} If `orderId` or `shippingAddressId` is missing.
+ * @returns {Promise<void>} A promise resolving when the shipping address of the logistic order is set.
  */
 export declare function updateLogisticOrderShippingAddress({ orderId, shippingAddressId, }: UpdateLogisticOrderShippingAddressParameters): Promise<void>;
 /**
- * Get logistic order shipping information
+ * 🚚 Gets a logistic order's shipping information.
+ *
+ * This function retrieves the shipping information of a specific logistic order, identified by the `orderId`. This parameter is mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/logistic-orders/${orderId}/shipping-information [ORDER-502]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `orderId`         | `string`                        | ✅         | The ID of the logistic order of which you want to retrieve the shipping information. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a single `GetLogisticOrderShippingAddressResponse` object representing the array of the logistic order's shipping information.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const shippingInformation = await getLogisticOrderShippingInformation({
+ *   orderId: "logisticOrder1",
+ * });
+ * ```
+ *
+ * @param {GetLogisticOrderShippingAddressParameters} params - The parameters for the request.
+ * @throws {Error} If `orderId` is missing.
+ * @returns {Promise<GetLogisticOrderShippingAddressResponse>} A promise resolving to the response containing the array of shipping information.
  */
 export declare function getLogisticOrderShippingInformation({ orderId, }: GetLogisticOrderShippingAddressParameters): Promise<GetLogisticOrderShippingAddressResponse>;
 /**
- * Update logistic order shipping information
+ * 🚚 Updates a logistic order's shipping information.
+ *
+ * This function updates the shipping information of a specific logistic order, identified by the `orderId`. This parameter, as well as the `shippingAddressId` and the `shippingType`, are mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `PUT /v1/shop/logistic-orders/${orderId}/shipping-information [ORDER-214]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `orderId`         | `string`                        | ✅         | The ID of the logistic order of which you want to update the shipping information. |
+ * | `shippingAddressId`| `string`                        | ✅         | The ID of the shipping address you want to add to the logistic order. |
+ * | `shippingType`    | `string`                        | ✅         | The type of shipping address to be added with the shipping address. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving when the shipping information of the logistic order is updated.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * await updateLogisticOrderShippingInformation({
+ *   orderId: "logisticOrder1",
+ *   shippingAddressId: "address1",
+ * });
+ * ```
+ *
+ * @param {UpdateLogisticOrderShippingInformationParameters} params - The parameters for the request.
+ * @throws {Error} If `orderId` or `shippingAddressId` is missing.
+ * @returns {Promise<void>} A promise resolving when the shipping information is updated.
  */
 export declare function updateLogisticOrderShippingInformation({ orderId, shippingAddressId, shippingType, }: UpdateLogisticOrderShippingInformationParameters): Promise<void>;
 /**
- * Update logistic order shipping type
+ * 🚚 Updates a logistic order's shipping type.
+ *
+ * This function updates the shipping type of a specific logistic order, both identified by the `orderId` and the `shippingType`. Both parameters are mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `PUT /v1/shop/logistic-orders/${orderId}/shipping-information [ORDER-211]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `orderId`         | `string`                        | ✅         | The ID of the logistic order of which you want to update the shipping type. |
+ * | `shippingType`    | `string`                        | ✅         | The shipping type you want to set to the logistic order. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving when the shipping type of the logistic order is set.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * await updateLogisticOrderShippingType({
+ *   orderId: "logisticOrder1",
+ *   shippingType: "shipping_type",
+ * });
+ * ```
+ *
+ * @param {UpdateLogisticOrderShippingTypeParameters} params - The parameters for the request.
+ * @throws {Error} If `orderId` or `shippingType` is missing.
+ * @returns {Promise<void>} A promise resolving when the shipping type of the logistic order is set.
  */
 export declare function updateLogisticOrderShippingType({ orderId, shippingType, }: UpdateLogisticOrderShippingTypeParameters): Promise<void>;
 /**
- * Create logistic order thread
+ * 🚚 Creates a thread on a specific logistic order.
+ *
+ * This function creates a thread on a specific logistic order, identified by
+ * the `orderId`. This parameter, as well as the `lineId`, the `message` and the `reasonCode`, is mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `POST /v1/shop/logistic-orders/${orderId}/threads [ORDER-100]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `orderId`         | `string`                        | ✅         | The ID of the logistic order for which you want to create a thread. |
+ * | `lineId`          | `string`                        | ✅         | The ID of the logistic order line involved in the thread. |
+ * | `message`         | `string`                        | ✅         | A message to add comments on the thread. |
+ * | `reasonCode`      | `string`                        | ✅         | The code indentifying the type of thread. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving when the thread is created.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * await createLogisticOrderThread({
+ *   orderId: "logisticOrder1",
+ *   lineId: "logisticOrderLine1",
+ *   message: "This is a message",
+ *   reasonCode: "REFUND"
+ * });
+ * ```
+ *
+ * @param {CreateLogisticOrderThreadParameters} params - The parameters for the request.
+ * @throws {Error} If `orderId`, `lineId`, `message` or `reasonCode` is missing.
+ * @returns {Promise<void>} A promise resolving when the thread is created.
  */
 export declare function createLogisticOrderThread({ orderId, lineId, message, reasonCode, }: CreateLogisticOrderThreadParameters): Promise<void>;
 /**
- * Get logistic order review
+ * 🚚 Gets a specific logistic order's review.
+ *
+ * This function retrieves a specific logistic order line's review, identified by
+ * the `orderId`. This parameter is mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/rating-orders/${orderId} [ORDER-504]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `orderId`         | `string`                        | ✅         | The ID of the logistic order of which you want to retrieve the review. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a single `GetLogisticOrderReviewResponse` object representing the review of the logistic order.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const review = await getLogisticOrderReview({
+ *   orderId: "logisticOrder1",
+ * });
+ * ```
+ *
+ * @param {GetLogisticOrderReviewParameters} params - The parameters for the request.
+ * @throws {Error} If `orderId` is missing.
+ * @returns {Promise<GetLogisticOrderReviewResponse>} A promise resolving to a response containing the review of the logistic order.
  */
 export declare function getLogisticOrderReview({ orderId, }: GetLogisticOrderReviewParameters): Promise<GetLogisticOrderReviewResponse>;
 /**
- * Add logistic order review
+ * 🚚 Adds a rewiew on a specific logistic order.
+ *
+ * This function adds a review on a specific logistic order, identified by
+ * the `orderId`. This parameter, as well as the `comment` and `grade`, is mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `PUT /v1/shop/rating-orders/${orderId} [ORDER-219]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `orderId`         | `string`                        | ✅         | The ID of the logistic order of which you want to retrieve the review. |
+ * | `comment`         | `string`                        | ✅         | A comment on how the logistic order as realized. |
+ * | `grade`           | `number`                        | ✅         | A grade to rate the logistic order. |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a single `AddLogisticOrderReviewResponse` object representing the review of the logistic order.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const review = await addLogisticOrderReview({
+ *   orderId: "logisticOrder1",
+ *   comment: "This was a bad order",
+ *   grade: 0,
+ * });
+ * ```
+ *
+ * @param {AddLogisticOrderReviewParameters} params - The parameters for the request.
+ * @throws {Error} If `orderId`, `comment` or `grade` is missing.
+ * @returns {Promise<AddLogisticOrderReviewResponse>} A promise resolving to a response containing the review of the logistic order.
  */
-export declare function addLogisitcOrderReview({ orderId, comment, grade, }: AddLogisticOrderReviewParameters): Promise<AddLogisticOrderReviewResponse>;
+export declare function addLogisticOrderReview({ orderId, comment, grade, }: AddLogisticOrderReviewParameters): Promise<AddLogisticOrderReviewResponse>;
 /**
- * Get thread reason types
+ * 🚚 Gets thread reason types.
+ *
+ * This function retrieves all the thread reason types. No parameters for this request.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/threads/reason-types [ORDER-550]`
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a single `GetThreadReasonTypesResponse` object representing the array of reason types.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const reasonTypes = await getThreadReasonTypes();
+ * ```
+ *
+ * @returns {Promise<GetThreadReasonTypesResponse>} A promise resolving to a response containing the array of reason types.
  */
 export declare function getThreadReasonTypes(): Promise<GetThreadReasonTypesResponse>;
 /**
- * Get thread sub reasons
+ * 🚚 Gets thread subreasons.
+ *
+ * This function retrieves all the subreasons under a reason type, identified by
+ * the `reasonType`. This parameter is mandatory and validated
+ * before the request is executed.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/threads/reason-types/${reasonType}/sub-reasons [ORDER-551]`
+ *
+ * | Parameter         | Type                            | Required   | Description                              |
+ * |-------------------|---------------------------------|------------|------------------------------------------|
+ * | `reasonType`      | `string`                        | ✅         | The type of thread reasons.              |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a single `GetThreadSubReasonsResponse` object representing the array of subreasons.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const subreasons = await getThreadSubReasons({
+ *   reasonType: "REFUND",
+ * });
+ * ```
+ *
+ * @param {GetThreadSubReasonsParameters} params - The parameters for the request.
+ * @throws {Error} If `reasonType` is missing.
+ * @returns {Promise<GetThreadSubReasonsResponse>} A promise resolving to a response containing the array of subreasons.
  */
 export declare function getThreadSubReasons({ reasonType, }: GetThreadSubReasonsParameters): Promise<GetThreadSubReasonsResponse>;