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

package/lib/services/cart/index.d.ts

@@ -1,388 +1,319 @@
-/**
- * @packageDocumentation
- *
- * @document documents/cart.md
- */
 import { CreateCartParameters, DeleteCartsResponse, DeleteCartParameters, GetCartParameters, GetCartResponse, GetCartsParameters, GetCartsResponse, UpdateCartParameters, InitializeOrdersFromCartParameters, GetCartLinesParameters, DeleteCartLinesResponse, DeleteCartLinesParameters, GetCartLinesResponse, UpdateCartLinesResponse, UpdateCartLinesParameters, UpdateCartLinesByVariantParameters, UpdateCartLinesByVariantResponse } from "./definitions";
 /**
  * CART ENDPOINT
  */
 /**
- * APICODE(cART135)
- * Deletes all carts associated with the user.
+ * 🛒 Deletes all carts associated with the user.
  *
  * This function sends a request to delete all carts of the logged-in user.
  *
- * @returns {Promise<DeleteCartsResponse>} - An array of objects containing details about the deleted carts.
+ * 🛠 **Endpoint**: `DELETE /v2/shop/carts [cART135]`
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to an array of `DeleteCartsResponse` objects, containing the details of the deleted carts.
  *
- * @example
- * #### input
- * ```typescript
+ * 🛠 **Example usage**:
+ * ```ts
  * const deletedCarts = await deleteCarts();
  * ```
- * #### output
- * ```json
- * [
- *   {
- *     "id": "cart1",
- *     "detail": "Deleted successfully"
- *   },
- *   {
- *     "id": "cart2",
- *     "detail": "Deleted successfully"
- *   }
- * ]
- * ```
+ *
+ * @returns {Promise<DeleteCartsResponse>} - An array of objects containing the details of the deleted carts.
  */
 export declare function deleteCarts(): Promise<DeleteCartsResponse>;
 /**
- * APICODE(cART550)
- * Retrieves all active carts of the logged-in user.
+ * 🛒 Retrieves all active carts of the logged-in user.
  *
  * This function allows fetching the list of active carts based on the provided parameters.
  *
- * @param {GetCartsParameters} params - The parameters for retrieving the carts, including:
- * #### currency - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * 🛠 **Endpoint**: `GET /v2/shop/carts [cART550]`
  *
- * The currency in which to display the carts.
- * #### pageable - `object` | <strong style={{ color: 'red' }}>required</strong>
+ * | Parameter        | Type                 | Required   | Description                                                |
+ * |------------------|----------------------|------------|------------------------------------------------------------|
+ * | `currency`       | `string`             | ✅         | The currency in which to display the carts.                |
+ * | `pageable`       | `object`             | ✅         | The pagination parameters.                                 |
+ * | `status`         | `string[]`           | ❌         | The status of the carts to retrieve.                       |
+ * | `type`           | `string[]`           | ❌         | The type of carts to retrieve.                             |
  *
- * The pagination parameters.
- * #### status - `string[]` | <strong style={{ color: 'red' }}>required</strong>
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetCartsResponse` object, containing the list of carts and pagination information.
  *
- * The status of the carts to retrieve.
- * #### type - `string[]` | <strong style={{ color: 'red' }}>required</strong>
+ * 🛠 **Example usage**:
+ * ```ts
+ * const carts = await getCarts({ currency: 'USD', pageable: { page: 1, size: 10 } });
+ * ```
  *
- * The type of carts to retrieve.
+ * @param {GetCartsParameters} params - The parameters for retrieving the carts, including:
+ *   - `currency` - The currency in which to display the carts.
+ *   - `pageable` - The pagination parameters.
+ *   - `status` - The status of the carts to retrieve.
+ *   - `type` - The type of carts to retrieve.
  *
  * @returns {Promise<GetCartsResponse>} - An object containing the list of carts and pagination information.
- *
- * @example
- * #### input
- * ```typescript
- * const carts = await getCarts({ currency: 'USD', pageable: { page: 1, size: 10 } });
- * ```
- * #### output
- * ```json
- * {
- *   carts: [
- *      {
- *        id: 'cart1',
- *        name: 'My Cart'
- *      },
- *      {
- *        id: 'cart2',
- *        name: 'Another Cart'
- *      }
- *   ],
- *   page: 1,
- *   size: 10,
- *   totalElement: 2
- * }
- * ```
  */
 export declare function getCarts(params: GetCartsParameters): Promise<GetCartsResponse>;
 /**
- * APICODE(cART100)
- * Creates a new cart.
+ * 🛒 Creates a new cart.
  *
  * This function sends a request to create a new cart with the specified name.
  *
- * @param {CreateCartParameters} params - The parameters for creating the cart, including:
- * #### name - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * 🛠 **Endpoint**: `POST /v2/shop/carts [cART100]`
  *
- * The name of the cart to create.
+ * | Parameter  | Type     | Required   | Description                     |
+ * |------------|----------|------------|---------------------------------|
+ * | `name`     | `string` | ✅         | The name of the cart to create. |
  *
- * @returns {Promise<GetCartResponse>} - A promise that resolves when the cart is created.
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetCartResponse` object, confirming the creation of the cart.
  *
- * @example
- * #### input
- * ```typescript
+ * 🛠 **Example usage**:
+ * ```ts
  * await createCart({ name: 'New Cart' });
  * ```
- * #### output
- * ```json
- * {
- *   "message": "Cart created successfully"
- * }
- * ```
+ *
+ * @param {CreateCartParameters} params - The parameters for creating the cart:
+ *   - `name` - The name of the cart to create.
+ *
+ * @returns {Promise<GetCartResponse>} - A promise that resolves when the cart is created.
  */
 export declare function createCart(params: CreateCartParameters): Promise<GetCartResponse>;
 /**
- * APICODE(cART300)
- * Deletes a specific cart.
+ * 🗑️ Deletes a specific cart.
  *
  * This function sends a request to delete the cart identified by its ID.
  *
- * @param {DeleteCartParameters} params - The parameters to identify the cart to delete, including:
- * #### cartId - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * 🛠 **Endpoint**: `DELETE /v2/shop/carts/{cartId} [cART300]`
  *
- * The ID of the cart to delete.
+ * | Parameter  | Type     | Required   | Description                      |
+ * |------------|----------|------------|----------------------------------|
+ * | `cartId`   | `string` | ✅         | The ID of the cart to delete.    |
  *
- * @returns {Promise<void>} - A promise that resolves when the cart is deleted.
+ * 📤 **Returns**:
+ * A `Promise<void>` that resolves when the cart is successfully deleted.
  *
- * @example
- * #### input
- * ```typescript
+ * 🛠 **Example usage**:
+ * ```ts
  * await deleteCart({ cartId: 'cart1' });
  * ```
- * #### output
- * ```json
- * {
- *   "message": "Cart deleted successfully"
- * }
- * ```
+ *
+ * @param {DeleteCartParameters} params - The parameters to identify the cart to delete:
+ *   - `cartId` - The ID of the cart to delete.
+ *
+ * @returns {Promise<void>} - A promise that resolves when the cart is deleted.
  */
 export declare function deleteCart(params: DeleteCartParameters): Promise<void>;
 /**
- * APICODE(cART500)
- * Retrieves the details of a specific cart.
+ * 🛒 Retrieves the details of a specific cart.
  *
  * This function allows fetching the information of a cart based on its ID.
  *
- * @param {GetCartParameters} params - The parameters for identifying the cart, including:
- * #### cartId - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * 🛠 **Endpoint**: `GET /v2/shop/carts/{cartId} [cART500]`
  *
- * The ID of the cart to retrieve.
- * #### currency - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * | Parameter       | Type      | Required   | Description                                     |
+ * |-----------------|-----------|------------|-------------------------------------------------|
+ * | `cartId`        | `string`  | ✅         | The ID of the cart to retrieve.                |
+ * | `currency`      | `string`  | ✅         | The currency in which to display the cart.     |
+ * | `nbFirstLines`  | `number[]`| ❌         | The number of lines to retrieve.               |
  *
- * The currency in which to display the cart.
- * #### nbFirstLines - `number[]`
+ * 📤 **Returns**:
+ * A `Promise<GetCartResponse>` containing the details of the requested cart.
  *
- * The number of lines to retrieve.
- *
- * @returns {Promise<GetCartResponse>} - An object containing the details of the cart.
- *
- * @example
- * #### input
- * ```typescript
+ * 🛠 **Example usage**:
+ * ```ts
  * const cartDetails = await getCart({ cartId: 'cart1', currency: 'USD' });
  * ```
- * #### output
- * ```json
- * {
- *   "id": "cart1",
- *   "name": "My Cart",
- *   "totalPrice": 100,
- *   "lines": [
- *     {
- *       "productName": "Product A",
- *       "quantity": 2
- *     }
- *   ]
- * }
- * ```
+ *
+ * @param {GetCartParameters} params - The parameters for identifying the cart:
+ *   - `cartId` - The ID of the cart to retrieve.
+ *   - `currency` - The currency in which to display the cart.
+ *   - `nbFirstLines` - (Optional) The number of lines to retrieve.
+ *
+ * @returns {Promise<GetCartResponse>} - A promise resolving to the cart details.
  */
 export declare function getCart(params: GetCartParameters): Promise<GetCartResponse>;
 /**
- * APICODE(cART200)
- * Updates an existing cart.
+ * ✏️ Updates an existing cart.
  *
  * This function sends a request to update the name of a cart identified by its ID.
  *
- * @param {UpdateCartParameters} params - The parameters for updating the cart, including:
- * #### cartId - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * 🛠 **Endpoint**: `PUT /v2/shop/carts/{cartId} [cART200]`
  *
- * The ID of the cart to update.
- * #### name - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * | Parameter  | Type     | Required   | Description                           |
+ * |------------|----------|------------|---------------------------------------|
+ * | `cartId`   | `string` | ✅         | The ID of the cart to update.         |
+ * | `name`     | `string` | ✅         | The new name of the cart.             |
  *
- * The new name of the cart.
+ * 📤 **Returns**:
+ * A `Promise<void>` that resolves when the cart is successfully updated.
  *
- * @returns {Promise<void>} - A promise that resolves when the cart is updated.
- *
- * @example
- * #### input
- * ```typescript
+ * 🛠 **Example usage**:
+ * ```ts
  * await updateCart({ cartId: 'cart1', name: 'Updated Cart Name' });
  * ```
- * #### output
- * ```json
- * {
- *   "message": "Cart updated successfully"
- * }
- * ```
+ *
+ * @param {UpdateCartParameters} params - The parameters for updating the cart:
+ *   - `cartId` - The ID of the cart to update.
+ *   - `name` - The new name of the cart.
+ *
+ * @returns {Promise<void>} - A promise that resolves when the update is successful.
  */
 export declare function updateCart(params: UpdateCartParameters): Promise<void>;
 /**
- * APICODE(cART101)
- * Initializes orders from a cart.
+ * 🛒 Initializes orders from a cart.
  *
  * This function sends a request to initialize an order from a specified cart.
  *
- * @param {InitializeOrdersFromCartParameters} params - The parameters for initializing orders, including:
- * #### cartId - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * 🛠 **Endpoint**: `POST /v2/shop/carts/{cartId}/initialize-orders [cART101]`
  *
- * The ID of the cart from which to initialize the order.
+ * | Parameter  | Type     | Required   | Description                              |
+ * |------------|----------|------------|------------------------------------------|
+ * | `cartId`   | `string` | ✅         | The ID of the cart to initialize orders. |
  *
- * @returns {Promise<string>} - The business ID of the commercial order if the initialization succeeds.
+ * 📤 **Returns**:
+ * A `Promise<string>` containing the business ID of the created order.
  *
- * @example
- * #### input
- * ```typescript
+ * 🛠 **Example usage**:
+ * ```ts
  * const orderId = await initializeOrdersFromCart({ cartId: 'cart1' });
  * ```
- * #### output
- * ```json
- * {
- *   "orderId": "order123"
- * }
- * ```
+ *
+ * @param {InitializeOrdersFromCartParameters} params - Parameters for initializing orders:
+ *   - `cartId` - The ID of the cart to initialize orders from.
+ *
+ * @returns {Promise<string>} - The business ID of the created order.
  */
 export declare function initializeOrdersFromCart(params: InitializeOrdersFromCartParameters): Promise<string>;
 /**
- * CARTLINES ENDPOINT
- */
-/**
- * APICODE(cART350)
- * Deletes lines from a cart.
+ * 🗑️ Deletes lines from a cart.
  *
  * This function sends a request to delete specific lines from a cart.
  *
- * @param {DeleteCartLinesParameters} params - The parameters for deleting lines from the cart, including:
- * #### cartId - `string` | <strong style={{ color: 'red' }}>required</strong>
- *
- * The ID of the cart.
- * #### `lineIdsToDelete` - `string[]` | <strong style={{ color: 'red' }}>required</strong>
+ * 🛠 **Endpoint**: `DELETE /v2/shop/carts/{cartId}/lines [cART350]`
  *
- * The IDs of the lines to delete.
+ * | Parameter          | Type       | Required   | Description                          |
+ * |--------------------|------------|------------|--------------------------------------|
+ * | `cartId`           | `string`   | ✅         | The ID of the cart.                  |
+ * | `lineIdsToDelete`  | `string[]` | ✅         | The IDs of the lines to delete.      |
  *
- * @returns {Promise<DeleteCartLinesResponse>} - An object containing information about the deleted lines.
+ * 📤 **Returns**:
+ * A `Promise<DeleteCartLinesResponse>` containing details about the deleted lines.
  *
- * @example
- * #### input
- * ```typescript
- * const response = await deleteCartLines({ cartId: 'cart1', lineIdsToDelete: ['line1', 'line2'] });
- * ```
- * #### output
- * ```json
- * {
- *   "singleWarningReportDto": []
- * }
+ * 🛠 **Example usage**:
+ * ```ts
+ * const response = await deleteCartLines({
+ *   cartId: 'cart1',
+ *   lineIdsToDelete: ['line1', 'line2']
+ * });
  * ```
+ *
+ * @param {DeleteCartLinesParameters} params - Parameters for deleting cart lines:
+ *   - `cartId` - The ID of the cart.
+ *   - `lineIdsToDelete` - The IDs of the lines to delete.
+ *
+ * @returns {Promise<DeleteCartLinesResponse>} - Response with details about the deleted lines.
  */
 export declare function deleteCartLines(params: DeleteCartLinesParameters): Promise<DeleteCartLinesResponse>;
 /**
- * APICODE(cART551)
- * Fetches the lines of a shopping cart based on the provided parameters.
+ * 📋 Fetches the lines of a shopping cart.
  *
  * This function retrieves detailed information about the items (lines) in a shopping cart.
  * It supports filtering by supplier, product variant, or offer price and handles pagination.
  *
- * @param {GetCartLinesParameters} params - The parameters for retrieving cart lines, including:
- * #### cartId - `string` | <strong style={{ color: 'red' }}>required</strong>
- *
- * The ID of the cart.
- * #### currency - `string` | <strong style={{ color: 'red' }}>required</strong>
- *
- * The currency in which prices should be returned (e.g., "USD").
- * #### pageable - `object` | <strong style={{ color: 'red' }}>required</strong>
- *
- * Pagination details, such as page number and size.
- * #### supplierId - `string[]`
+ * 🛠 **Endpoint**: `GET /v2/shop/carts/{cartId}/lines [cART551]`
  *
- * Filter by a specific supplier's ID.
- * #### productVariantId - `string[]`
+ * | Parameter           | Type       | Required   | Description                              |
+ * |---------------------|------------|------------|------------------------------------------|
+ * | `cartId`            | `string`   | ✅         | The ID of the cart.                      |
+ * | `currency`          | `string`   | ✅         | The currency in which prices are shown.  |
+ * | `pageable`          | `object`   | ✅         | Pagination details (page number, size).  |
+ * | `supplierId`        | `string[]` | ❌         | Filter by specific supplier IDs.         |
+ * | `productVariantId`  | `string[]` | ❌         | Filter by specific product variants.     |
+ * | `offerPriceId`      | `string[]` | ❌         | Filter by specific offer price IDs.      |
  *
- * Filter by a specific product variant's ID.
- * #### offerPriceId - `string[]`
+ * 📤 **Returns**:
+ * A `Promise<GetCartLinesResponse>` containing the lines of the cart.
  *
- * Filter by a specific offer price ID.
- *
- * @returns {Promise<GetCartLinesResponse>} - A promise resolving to the response containing cart lines information.
- *
- * @example
- * #### input
- * ```typescript
+ * 🛠 **Example usage**:
+ * ```ts
  * const cartLines = await getCartLines({
  *   cartId: 'cart1',
  *   currency: 'USD',
  *   pageable: { page: 1, size: 10 },
- *   supplierId: ['supplier1'],
- *   productVariantId: ['variant1'],
- *   offerPriceId: ['offer1']
+ *   supplierId: ['supplier1']
  * });
  * ```
- * #### output
- * ```json
- * {
- *   "lines": [
- *     {
- *       "productName": "Product A",
- *       "quantity": 2,
- *       "price": 20
- *     }
- *   ],
- *   "totalItems": 1,
- *   "totalPages": 1
- * }
- * ```
+ *
+ * @param {GetCartLinesParameters} params - Parameters for fetching cart lines:
+ *   - `cartId` - The ID of the cart.
+ *   - `currency` - The currency for prices.
+ *   - `pageable` - Pagination details.
+ *   - `supplierId` (optional) - Supplier IDs for filtering.
+ *   - `productVariantId` (optional) - Product variant IDs for filtering.
+ *   - `offerPriceId` (optional) - Offer price IDs for filtering.
+ *
+ * @returns {Promise<GetCartLinesResponse>} - Response containing cart lines information.
  */
 export declare function getCartLines(params: GetCartLinesParameters): Promise<GetCartLinesResponse>;
 /**
- * APICODE(cART150)
- * Updates the lines of a cart.
- *
- * This function sends a request to update the lines of a specified cart.
+ * ✏️ Updates the lines of a cart.
  *
- * @param {UpdateCartLinesParameters} params - The parameters for updating the cart lines, including:
- * #### cartId - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * This function sends a request to update specific lines of a shopping cart.
  *
- * The ID of the cart.
- * #### `linesToUpdate` - `object[]` | <strong style={{ color: 'red' }}>required</strong>
+ * 🛠 **Endpoint**: `PUT /v2/shop/carts/{cartId}/lines [cART150]`
  *
- * The lines to update with their details.
+ * | Parameter         | Type       | Required   | Description                            |
+ * |-------------------|------------|------------|----------------------------------------|
+ * | `cartId`          | `string`   | ✅         | The ID of the cart.                    |
+ * | `linesToUpdate`   | `object[]` | ✅         | Details of the lines to update.        |
  *
- * @returns {Promise<UpdateCartLinesResponse>} - An object containing information about the updated lines.
+ * 📤 **Returns**:
+ * A `Promise<UpdateCartLinesResponse>` containing the updated lines' information.
  *
- * @example
- * #### input
- * ```typescript
+ * 🛠 **Example usage**:
+ * ```ts
  * const response = await updateCartLines({
  *   cartId: 'cart1',
  *   linesToUpdate: [
  *     { offerPriceId: 'line1', quantity: 3, updateAction: 'update' }
- *   ],
+ *   ]
  * });
  * ```
- * #### output
- * ```json
- * {
- *   "singleWarningReportDto": []
- * }
- * ```
+ *
+ * @param {UpdateCartLinesParameters} params - Parameters for updating cart lines:
+ *   - `cartId` - The ID of the cart.
+ *   - `linesToUpdate` - Details of the lines to update.
+ *
+ * @returns {Promise<UpdateCartLinesResponse>} - Response with details about the updated lines.
  */
 export declare function updateCartLines(params: UpdateCartLinesParameters): Promise<UpdateCartLinesResponse>;
 /**
- * APICODE(cART151)
- * Updates the lines of a cart by variant.
+ * ✏️ Updates the lines of a cart by variant.
  *
- * This function sends a request to update the lines of a cart based on the product variant.
+ * This function sends a request to update cart lines based on product variants.
  *
- * @param {UpdateCartLinesByVariantParameters} params - The parameters for updating the cart lines by variant, including:
- * #### cartId - `string` | <strong style={{ color: 'red' }}>required</strong>
+ * 🛠 **Endpoint**: `PUT /v2/shop/carts/{cartId}/lines-by-variant [cART151]`
  *
- * The ID of the cart.
- * #### linesToUpdate - `object[]` | <strong style={{ color: 'red' }}>required</strong>
+ * | Parameter         | Type       | Required   | Description                            |
+ * |-------------------|------------|------------|----------------------------------------|
+ * | `cartId`          | `string`   | ✅         | The ID of the cart.                    |
+ * | `linesToUpdate`   | `object[]` | ✅         | Details of the lines to update.        |
  *
- * The lines to update with their details.
+ * 📤 **Returns**:
+ * A `Promise<UpdateCartLinesByVariantResponse>` containing the updated lines' information.
  *
- * @returns {Promise<UpdateCartLinesByVariantResponse>} - An object containing information about the updated lines by variant.
- *
- * @example
- * #### input
- * ```typescript
+ * 🛠 **Example usage**:
+ * ```ts
  * const response = await updateCartLinesByVariant({
  *   cartId: 'cart1',
  *   linesToUpdate: [
  *     { offerPriceId: 'variant1', quantity: 2, updateAction: 'update' }
- *   ],
+ *   ]
  * });
  * ```
- * #### output
- * ```json
- * {
- *   "singleWarningReportDto": []
- * }
- * ```
+ *
+ * @param {UpdateCartLinesByVariantParameters} params - Parameters for updating cart lines by variant:
+ *   - `cartId` - The ID of the cart.
+ *   - `linesToUpdate` - Details of the lines to update.
+ *
+ * @returns {Promise<UpdateCartLinesByVariantResponse>} - Response with details about the updated lines by variant.
  */
 export declare function updateCartLinesByVariant(params: UpdateCartLinesByVariantParameters): Promise<UpdateCartLinesByVariantResponse>;