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

package/lib/index.d.ts

@@ -114,17 +114,17 @@ export declare const DjustSDK: {
     getCustomerAccountOrganisationOrders({ organisationId, pageable, locale, }: import("./interfaces").GetCustomerAccountOrganisationOrdersParameters): Promise<import("./interfaces").GetCustomerAccountOrganisationOrdersResponse>;
     getCustomerAccountOrganisationUsers({ organisationId, pageable, }: import("./interfaces").GetCustomerAccountOrganisationUsersParameters): Promise<import("./interfaces").GetCustomerAccountOrganisationUsersResponse>;
     updateCustomerAccountOrganisationUser({ organisationId, customerUserId, civility, customFieldValues, firstName, lastName, phone, }: import("./interfaces").UpdateCustomerAccountOrganisationUserParameters): Promise<import("./interfaces").UpdateCustomerAccountOrganisationUserResponse>;
-    getCart({ cartId, currency, nbFirstLines, }: import("./interfaces").GetCartParameters): Promise<import("./interfaces").GetCartResponse>;
-    getCarts({ currency, pageable, status, type, }: import("./interfaces").GetCartsParameters): Promise<import("./interfaces").GetCartsResponse>;
-    deleteCart({ cartId, }: import("./interfaces").DeleteCartParameters): Promise<void>;
     deleteCarts(): Promise<import("./interfaces").DeleteCartsResponse>;
-    createCart({ name, }: import("./interfaces").CreateCartParameters): Promise<void>;
-    updateCart({ cartId, name, }: import("./interfaces").UpdateCartParameters): Promise<void>;
-    initializeOrdersFromCart({ cartId, }: import("./interfaces").InitializeOrdersFromCartParameters): Promise<string>;
-    getCartLines({ cartId, currency, pageable, supplierId, productVariantId, offerPriceId, }: import("./interfaces").GetCartLinesParameters): Promise<import("./interfaces").GetCartLinesResponse>;
-    deleteCartLines({ cartId, lineIdsToDelete, }: import("./interfaces").DeleteCartLinesParameters): Promise<import("./interfaces").DeleteCartLinesResponse>;
-    updateCartLines({ cartId, linesToUpdate, }: import("./interfaces").UpdateCartLinesParameters): Promise<import("./interfaces").UpdateCartLinesResponse>;
-    updateCartLinesByVariant({ cartId, linesToUpdate, }: import("./interfaces").UpdateCartLinesByVariantParameters): Promise<import("./interfaces").UpdateCartLinesByVariantResponse>;
+    getCarts(params: import("./interfaces").GetCartsParameters): Promise<import("./interfaces").GetCartsResponse>;
+    createCart(params: import("./interfaces").CreateCartParameters): Promise<import("./interfaces").GetCartResponse>;
+    deleteCart(params: import("./interfaces").DeleteCartParameters): Promise<void>;
+    getCart(params: import("./interfaces").GetCartParameters): Promise<import("./interfaces").GetCartResponse>;
+    updateCart(params: import("./interfaces").UpdateCartParameters): Promise<void>;
+    initializeOrdersFromCart(params: import("./interfaces").InitializeOrdersFromCartParameters): Promise<string>;
+    deleteCartLines(params: import("./interfaces").DeleteCartLinesParameters): Promise<import("./interfaces").DeleteCartLinesResponse>;
+    getCartLines(params: import("./interfaces").GetCartLinesParameters): Promise<import("./interfaces").GetCartLinesResponse>;
+    updateCartLines(params: import("./interfaces").UpdateCartLinesParameters): Promise<import("./interfaces").UpdateCartLinesResponse>;
+    updateCartLinesByVariant(params: import("./interfaces").UpdateCartLinesByVariantParameters): Promise<import("./interfaces").UpdateCartLinesByVariantResponse>;
     getBuyingList({ buyingListId, locale, }: import("./interfaces").GetBuyingListParameters): Promise<import("./interfaces").GetBuyingListResponse>;
     getBuyingLists(): Promise<import("./interfaces").GetBuyingListsResponse>;
     createBuyingList({ name, }: import("./interfaces").CreateBuyingListParameters): Promise<import("./interfaces").CreateBuyingListResponse>;

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

@@ -1,66 +1,388 @@
+/**
+ * @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";
 /**
- * Get cart
- * @param {GetCartParameters} params - The parameters for getting a cart
- * @returns {Promise<GetCartResponse>} The response containing the cart data
+ * CART ENDPOINT
  */
-export declare function getCart({ cartId, currency, nbFirstLines, }: GetCartParameters): Promise<GetCartResponse>;
 /**
- * Get carts
- * @param {GetCartsParameters} params - The parameters for getting multiple carts
- * @returns {Promise<GetCartsResponse>} The response containing the carts data
+ * 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"
+ *   }
+ * ]
+ * ```
  */
-export declare function getCarts({ currency, pageable, status, type, }: GetCartsParameters): Promise<GetCartsResponse>;
+export declare function deleteCarts(): Promise<DeleteCartsResponse>;
 /**
- * Delete cart
- * @param {DeleteCartParameters} params - The parameters for deleting a cart
- * @returns {Promise<void>} A promise that resolves when the cart is deleted
+ * 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
+ * }
+ * ```
  */
-export declare function deleteCart({ cartId, }: DeleteCartParameters): Promise<void>;
+export declare function getCarts(params: GetCartsParameters): Promise<GetCartsResponse>;
 /**
- * Delete carts
- * @returns {Promise<DeleteCartsResponse>} The response containing the delete carts data
+ * 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"
+ * }
+ * ```
  */
-export declare function deleteCarts(): Promise<DeleteCartsResponse>;
+export declare function createCart(params: CreateCartParameters): Promise<GetCartResponse>;
+/**
+ * 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"
+ * }
+ * ```
+ */
+export declare function deleteCart(params: DeleteCartParameters): Promise<void>;
+/**
+ * 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
+ *     }
+ *   ]
+ * }
+ * ```
+ */
+export declare function getCart(params: GetCartParameters): Promise<GetCartResponse>;
 /**
- * Create cart
- * @param {CreateCartParameters} params - The parameters for creating a cart
- * @returns {Promise<void>} A promise that resolves when the cart is created
+ * 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"
+ * }
+ * ```
  */
-export declare function createCart({ name, }: CreateCartParameters): Promise<void>;
+export declare function updateCart(params: UpdateCartParameters): Promise<void>;
 /**
- * Update cart
- * @param {UpdateCartParameters} params - The parameters for updating a cart
- * @returns {Promise<void>} A promise that resolves when the cart is updated
+ * 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"
+ * }
+ * ```
  */
-export declare function updateCart({ cartId, name, }: UpdateCartParameters): Promise<void>;
+export declare function initializeOrdersFromCart(params: InitializeOrdersFromCartParameters): Promise<string>;
 /**
- * Initialize orders from cart
- * @param {InitializeOrdersFromCartParameters} params - The parameters for initializing orders from a cart
- * @returns {Promise<string>} The response containing the order data
+ * CARTLINES ENDPOINT
  */
-export declare function initializeOrdersFromCart({ cartId, }: InitializeOrdersFromCartParameters): Promise<string>;
 /**
- * Get cart lines
- * @param {GetCartLinesParameters} params - The parameters for getting cart lines
- * @returns {Promise<GetCartLinesResponse>} The response containing the cart lines data
+ * 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": []
+ * }
+ * ```
  */
-export declare function getCartLines({ cartId, currency, pageable, supplierId, productVariantId, offerPriceId, }: GetCartLinesParameters): Promise<GetCartLinesResponse>;
+export declare function deleteCartLines(params: DeleteCartLinesParameters): Promise<DeleteCartLinesResponse>;
 /**
- * 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
+ * }
+ * ```
  */
-export declare function deleteCartLines({ cartId, lineIdsToDelete, }: DeleteCartLinesParameters): Promise<DeleteCartLinesResponse>;
+export declare function getCartLines(params: GetCartLinesParameters): Promise<GetCartLinesResponse>;
 /**
- * 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": []
+ * }
+ * ```
  */
-export declare function updateCartLines({ cartId, linesToUpdate, }: UpdateCartLinesParameters): Promise<UpdateCartLinesResponse>;
+export declare function updateCartLines(params: UpdateCartLinesParameters): Promise<UpdateCartLinesResponse>;
 /**
- * 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": []
+ * }
+ * ```
  */
-export declare function updateCartLinesByVariant({ cartId, linesToUpdate, }: UpdateCartLinesByVariantParameters): Promise<UpdateCartLinesByVariantResponse>;
+export declare function updateCartLinesByVariant(params: UpdateCartLinesByVariantParameters): Promise<UpdateCartLinesByVariantResponse>;