@djust-b2b/djust-front-sdk 1.10.2 → 1.11.1

package/lib/services/cart/index.js

@@ -1,41 +1,108 @@
 "use strict";
+/**
+ * @packageDocumentation
+ *
+ * @document documents/cart.md
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCart = getCart;
-exports.getCarts = getCarts;
-exports.deleteCart = deleteCart;
 exports.deleteCarts = deleteCarts;
+exports.getCarts = getCarts;
 exports.createCart = createCart;
+exports.deleteCart = deleteCart;
+exports.getCart = getCart;
 exports.updateCart = updateCart;
 exports.initializeOrdersFromCart = initializeOrdersFromCart;
-exports.getCartLines = getCartLines;
 exports.deleteCartLines = deleteCartLines;
+exports.getCartLines = getCartLines;
 exports.updateCartLines = updateCartLines;
 exports.updateCartLinesByVariant = updateCartLinesByVariant;
 const parameters_validation_1 = require("../../helpers/parameters-validation");
 const fetch_instance_1 = require("../../settings/fetch-instance");
 /**
- * Get cart
- * @param {GetCartParameters} params - The parameters for getting a cart
- * @returns {Promise<GetCartResponse>} The response containing the cart data
+ * CART ENDPOINT
  */
-async function getCart({ cartId, currency, nbFirstLines, }) {
-    (0, parameters_validation_1.required)({ cartId, currency });
+/**
+ * APICODE(cART135)
+ * 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.
+ *
+ * @example
+ * #### input
+ * ```typescript
+ * const deletedCarts = await deleteCarts();
+ * ```
+ * #### output
+ * ```json
+ * [
+ *   {
+ *     "id": "cart1",
+ *     "detail": "Deleted successfully"
+ *   },
+ *   {
+ *     "id": "cart2",
+ *     "detail": "Deleted successfully"
+ *   }
+ * ]
+ * ```
+ */
+async function deleteCarts() {
     const { data } = await (0, fetch_instance_1.enhancedFetch)({
-        method: "GET",
-        path: `/v2/shop/carts/${cartId}`,
-        params: {
-            currency,
-            nbFirstLines,
-        },
+        method: "DELETE",
+        path: `/v2/shop/carts`,
     });
     return data;
 }
 /**
- * Get carts
- * @param {GetCartsParameters} params - The parameters for getting multiple carts
- * @returns {Promise<GetCartsResponse>} The response containing the carts data
+ * APICODE(cART550)
+ * 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>
+ *
+ * The currency in which to display the carts.
+ * #### pageable - `object` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * The pagination parameters.
+ * #### status - `string[]` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * The status of the carts to retrieve.
+ * #### type - `string[]` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * 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
+ * }
+ * ```
  */
-async function getCarts({ currency, pageable, status, type, }) {
+async function getCarts(params) {
+    const { currency, pageable, status, type } = params;
     (0, parameters_validation_1.required)({ currency, pageable });
     const { data } = await (0, fetch_instance_1.enhancedFetch)({
         method: "GET",
@@ -50,11 +117,66 @@ async function getCarts({ currency, pageable, status, type, }) {
     return data;
 }
 /**
- * Delete cart
- * @param {DeleteCartParameters} params - The parameters for deleting a cart
- * @returns {Promise<void>} A promise that resolves when the cart is deleted
+ * APICODE(cART100)
+ * 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>
+ *
+ * The name of the cart to create.
+ *
+ * @returns {Promise<GetCartResponse>} - A promise that resolves when the cart is created.
+ *
+ * @example
+ * #### input
+ * ```typescript
+ * await createCart({ name: 'New Cart' });
+ * ```
+ * #### output
+ * ```json
+ * {
+ *   "message": "Cart created successfully"
+ * }
+ * ```
+ */
+async function createCart(params) {
+    const { name } = params;
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+        method: "POST",
+        path: `/v2/shop/carts`,
+        body: JSON.stringify({ name }),
+    });
+    return data;
+}
+/**
+ * APICODE(cART300)
+ * 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>
+ *
+ * The ID of the cart to delete.
+ *
+ * @returns {Promise<void>} - A promise that resolves when the cart is deleted.
+ *
+ * @example
+ * #### input
+ * ```typescript
+ * await deleteCart({ cartId: 'cart1' });
+ * ```
+ * #### output
+ * ```json
+ * {
+ *   "message": "Cart deleted successfully"
+ * }
+ * ```
  */
-async function deleteCart({ cartId, }) {
+async function deleteCart(params) {
+    const { cartId } = params;
     (0, parameters_validation_1.required)({ cartId });
     (0, fetch_instance_1.enhancedFetch)({
         method: "DELETE",
@@ -62,34 +184,87 @@ async function deleteCart({ cartId, }) {
     });
 }
 /**
- * Delete carts
- * @returns {Promise<DeleteCartsResponse>} The response containing the delete carts data
+ * APICODE(cART500)
+ * 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>
+ *
+ * The ID of the cart to retrieve.
+ * #### currency - `string` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * The currency in which to display the cart.
+ * #### nbFirstLines - `number[]`
+ *
+ * The number of lines to retrieve.
+ *
+ * @returns {Promise<GetCartResponse>} - An object containing the details of the cart.
+ *
+ * @example
+ * #### input
+ * ```typescript
+ * const cartDetails = await getCart({ cartId: 'cart1', currency: 'USD' });
+ * ```
+ * #### output
+ * ```json
+ * {
+ *   "id": "cart1",
+ *   "name": "My Cart",
+ *   "totalPrice": 100,
+ *   "lines": [
+ *     {
+ *       "productName": "Product A",
+ *       "quantity": 2
+ *     }
+ *   ]
+ * }
+ * ```
  */
-async function deleteCarts() {
+async function getCart(params) {
+    const { cartId, currency, nbFirstLines } = params;
+    (0, parameters_validation_1.required)({ cartId, currency });
     const { data } = await (0, fetch_instance_1.enhancedFetch)({
-        method: "DELETE",
-        path: `/v2/shop/carts`,
+        method: "GET",
+        path: `/v2/shop/carts/${cartId}`,
+        params: {
+            currency,
+            nbFirstLines,
+        },
     });
     return data;
 }
 /**
- * Create cart
- * @param {CreateCartParameters} params - The parameters for creating a cart
- * @returns {Promise<void>} A promise that resolves when the cart is created
- */
-async function createCart({ name, }) {
-    (0, fetch_instance_1.enhancedFetch)({
-        method: "POST",
-        path: `/v2/shop/carts`,
-        body: JSON.stringify({ name }),
-    });
-}
-/**
- * Update cart
- * @param {UpdateCartParameters} params - The parameters for updating a cart
- * @returns {Promise<void>} A promise that resolves when the cart is updated
+ * APICODE(cART200)
+ * 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>
+ *
+ * The ID of the cart to update.
+ * #### name - `string` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * The new name of the cart.
+ *
+ * @returns {Promise<void>} - A promise that resolves when the cart is updated.
+ *
+ * @example
+ * #### input
+ * ```typescript
+ * await updateCart({ cartId: 'cart1', name: 'Updated Cart Name' });
+ * ```
+ * #### output
+ * ```json
+ * {
+ *   "message": "Cart updated successfully"
+ * }
+ * ```
  */
-async function updateCart({ cartId, name, }) {
+async function updateCart(params) {
+    const { cartId, name } = params;
     (0, parameters_validation_1.required)({ cartId, name });
     (0, fetch_instance_1.enhancedFetch)({
         method: "PUT",
@@ -98,11 +273,32 @@ async function updateCart({ cartId, name, }) {
     });
 }
 /**
- * Initialize orders from cart
- * @param {InitializeOrdersFromCartParameters} params - The parameters for initializing orders from a cart
- * @returns {Promise<string>} The response containing the order data
+ * APICODE(cART101)
+ * 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>
+ *
+ * The ID of the cart from which to initialize the order.
+ *
+ * @returns {Promise<string>} - The business ID of the commercial order if the initialization succeeds.
+ *
+ * @example
+ * #### input
+ * ```typescript
+ * const orderId = await initializeOrdersFromCart({ cartId: 'cart1' });
+ * ```
+ * #### output
+ * ```json
+ * {
+ *   "orderId": "order123"
+ * }
+ * ```
  */
-async function initializeOrdersFromCart({ cartId, }) {
+async function initializeOrdersFromCart(params) {
+    const { cartId } = params;
     (0, parameters_validation_1.required)({ cartId });
     const { data } = await (0, fetch_instance_1.enhancedFetch)({
         method: "POST",
@@ -111,46 +307,154 @@ async function initializeOrdersFromCart({ cartId, }) {
     return data;
 }
 /**
- * Get cart lines
- * @param {GetCartLinesParameters} params - The parameters for getting cart lines
- * @returns {Promise<GetCartLinesResponse>} The response containing the cart lines data
+ * CARTLINES ENDPOINT
+ */
+/**
+ * APICODE(cART350)
+ * 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>
+ *
+ * The IDs of the lines to delete.
+ *
+ * @returns {Promise<DeleteCartLinesResponse>} - An object containing information about the deleted lines.
+ *
+ * @example
+ * #### input
+ * ```typescript
+ * const response = await deleteCartLines({ cartId: 'cart1', lineIdsToDelete: ['line1', 'line2'] });
+ * ```
+ * #### output
+ * ```json
+ * {
+ *   "singleWarningReportDto": []
+ * }
+ * ```
  */
-async function getCartLines({ cartId, currency, pageable, supplierId, productVariantId, offerPriceId, }) {
+async function deleteCartLines(params) {
+    const { cartId, lineIdsToDelete } = params;
     (0, parameters_validation_1.required)({ cartId });
+    const body = lineIdsToDelete.map((lineId) => ({ offerPriceId: lineId }));
     const { data } = await (0, fetch_instance_1.enhancedFetch)({
-        method: "GET",
+        method: "DELETE",
         path: `/v2/shop/carts/${cartId}/lines`,
-        params: {
-            currency,
-            pageable,
-            supplierId,
-            productVariantId,
-            offerPriceId,
-        },
+        body: JSON.stringify(body),
     });
     return data;
 }
 /**
- * Delete cart lines
- * @param {DeleteCartLinesParameters} params - The parameters for deleting cart lines
- * @returns {Promise<DeleteCartLinesResponse>} The response containing the delete cart lines data
+ * APICODE(cART551)
+ * Fetches the lines of a shopping cart based on the provided parameters.
+ *
+ * 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[]`
+ *
+ * Filter by a specific supplier's ID.
+ * #### productVariantId - `string[]`
+ *
+ * Filter by a specific product variant's ID.
+ * #### offerPriceId - `string[]`
+ *
+ * Filter by a specific offer price ID.
+ *
+ * @returns {Promise<GetCartLinesResponse>} - A promise resolving to the response containing cart lines information.
+ *
+ * @example
+ * #### input
+ * ```typescript
+ * const cartLines = await getCartLines({
+ *   cartId: 'cart1',
+ *   currency: 'USD',
+ *   pageable: { page: 1, size: 10 },
+ *   supplierId: ['supplier1'],
+ *   productVariantId: ['variant1'],
+ *   offerPriceId: ['offer1']
+ * });
+ * ```
+ * #### output
+ * ```json
+ * {
+ *   "lines": [
+ *     {
+ *       "productName": "Product A",
+ *       "quantity": 2,
+ *       "price": 20
+ *     }
+ *   ],
+ *   "totalItems": 1,
+ *   "totalPages": 1
+ * }
+ * ```
  */
-async function deleteCartLines({ cartId, lineIdsToDelete, }) {
+async function getCartLines(params) {
+    const { cartId, currency, pageable, supplierId, productVariantId, offerPriceId, } = params;
     (0, parameters_validation_1.required)({ cartId });
-    const body = lineIdsToDelete.map((lineId) => ({ offerPriceId: lineId }));
     const { data } = await (0, fetch_instance_1.enhancedFetch)({
-        method: "DELETE",
+        method: "GET",
         path: `/v2/shop/carts/${cartId}/lines`,
-        body: JSON.stringify(body),
+        params: {
+            currency,
+            pageable,
+            supplierId,
+            productVariantId,
+            offerPriceId,
+        },
     });
     return data;
 }
 /**
- * Update cart lines
- * @param {UpdateCartLinesParameters} params - The parameters for updating cart lines
- * @returns {Promise<UpdateCartLinesResponse>} The response containing the update cart lines data
+ * APICODE(cART150)
+ * Updates the lines of a cart.
+ *
+ * This function sends a request to update the lines of a specified cart.
+ *
+ * @param {UpdateCartLinesParameters} params - The parameters for updating the cart lines, including:
+ * #### cartId - `string` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * The ID of the cart.
+ * #### `linesToUpdate` - `object[]` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * The lines to update with their details.
+ *
+ * @returns {Promise<UpdateCartLinesResponse>} - An object containing information about the updated lines.
+ *
+ * @example
+ * #### input
+ * ```typescript
+ * const response = await updateCartLines({
+ *   cartId: 'cart1',
+ *   linesToUpdate: [
+ *     { offerPriceId: 'line1', quantity: 3, updateAction: 'update' }
+ *   ],
+ * });
+ * ```
+ * #### output
+ * ```json
+ * {
+ *   "singleWarningReportDto": []
+ * }
+ * ```
  */
-async function updateCartLines({ cartId, linesToUpdate, }) {
+async function updateCartLines(params) {
+    const { cartId, linesToUpdate } = params;
     (0, parameters_validation_1.required)({ cartId, linesToUpdate });
     const { data } = await (0, fetch_instance_1.enhancedFetch)({
         method: "PUT",
@@ -160,11 +464,40 @@ async function updateCartLines({ cartId, linesToUpdate, }) {
     return data;
 }
 /**
- * Update cart lines by variant
- * @param {UpdateCartLinesByVariantParameters} params - The parameters for updating cart lines by variant
- * @returns {Promise<UpdateCartLinesByVariantResponse>} The response containing the update cart lines by variant data
+ * APICODE(cART151)
+ * 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.
+ *
+ * @param {UpdateCartLinesByVariantParameters} params - The parameters for updating the cart lines by variant, including:
+ * #### cartId - `string` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * The ID of the cart.
+ * #### linesToUpdate - `object[]` | <strong style={{ color: 'red' }}>required</strong>
+ *
+ * The lines to update with their details.
+ *
+ * @returns {Promise<UpdateCartLinesByVariantResponse>} - An object containing information about the updated lines by variant.
+ *
+ * @example
+ * #### input
+ * ```typescript
+ * const response = await updateCartLinesByVariant({
+ *   cartId: 'cart1',
+ *   linesToUpdate: [
+ *     { offerPriceId: 'variant1', quantity: 2, updateAction: 'update' }
+ *   ],
+ * });
+ * ```
+ * #### output
+ * ```json
+ * {
+ *   "singleWarningReportDto": []
+ * }
+ * ```
  */
-async function updateCartLinesByVariant({ cartId, linesToUpdate, }) {
+async function updateCartLinesByVariant(params) {
+    const { cartId, linesToUpdate } = params;
     (0, parameters_validation_1.required)({ cartId, linesToUpdate });
     const { data } = await (0, fetch_instance_1.enhancedFetch)({
         method: "PUT",