@djust-b2b/djust-front-sdk 3.0.0-beta.8 → 3.0.0

package/lib/services/cart/endpoints.js

@@ -0,0 +1,26 @@
+"use strict";
+/**
+ * DJUST SDK Cart Service - Endpoints
+ * API endpoint constants for cart operations.
+ *
+ * @module services/cart/endpoints
+ * @since 2.17.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CartEndpoints = void 0;
+/**
+ * Cart API endpoints.
+ */
+exports.CartEndpoints = {
+    /** Base carts endpoint */
+    CARTS: "/v2/shop/carts",
+    /** Single cart endpoint [cART500] */
+    CART: "/v2/shop/carts/{cartId}",
+    /** Initialize orders from cart [cART101] */
+    INITIALIZE_ORDERS: "/v2/shop/carts/{cartId}/initialize-orders",
+    /** Cart lines endpoint [cART551] */
+    LINES: "/v2/shop/carts/{cartId}/lines",
+    /** Cart lines by variant endpoint [cART151] */
+    LINES_BY_VARIANT: "/v2/shop/carts/{cartId}/lines-by-variant",
+};
+//# sourceMappingURL=endpoints.js.map

package/lib/services/cart/endpoints.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"endpoints.js","sourceRoot":"","sources":["../../../src/services/cart/endpoints.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;;AAEH;;GAEG;AACU,QAAA,aAAa,GAAG;IAC3B,0BAA0B;IAC1B,KAAK,EAAE,gBAAgB;IAEvB,qCAAqC;IACrC,IAAI,EAAE,yBAAyB;IAE/B,4CAA4C;IAC5C,iBAAiB,EAAE,2CAA2C;IAE9D,oCAAoC;IACpC,KAAK,EAAE,+BAA+B;IAEtC,+CAA+C;IAC/C,gBAAgB,EAAE,0CAA0C;CACpD,CAAC"}

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

@@ -0,0 +1,330 @@
+import { CreateCartParameters, DeleteCartsResponse, DeleteCartParameters, GetCartParameters, GetCartResponse, GetCartsParameters, GetCartsResponse, UpdateCartParameters, InitializeOrdersFromCartParameters, GetCartLinesParameters, DeleteCartLinesResponse, DeleteCartLinesParameters, GetCartLinesResponse, UpdateCartLinesResponse, UpdateCartLinesParameters, UpdateCartLinesByVariantParameters, UpdateCartLinesByVariantResponse, CreateCartResponse } from "./definitions";
+/**
+ * CART ENDPOINT
+ */
+/**
+ * 🛒 Deletes all carts associated with the user.
+ *
+ * This function sends a request to delete all carts of the logged-in user.
+ *
+ * 🛠 **Endpoint**: `DELETE /v2/shop/carts [cART135]`
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to an array of `DeleteCartsResponse` objects, containing the details of the deleted carts.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const deletedCarts = await deleteCarts();
+ * ```
+ *
+ * @returns {Promise<DeleteCartsResponse>} - An array of objects containing the details of the deleted carts.
+ */
+export declare function deleteCarts(): Promise<DeleteCartsResponse>;
+/**
+ * 🛒 Retrieves all active carts of the logged-in user.
+ *
+ * This function allows fetching the list of active carts based on the provided parameters.
+ *
+ * 🛠 **Endpoint**: `GET /v2/shop/carts [cART550]`
+ *
+ * | Parameter        | Type                 | Required   | Description                                                |
+ * |------------------|----------------------|------------|------------------------------------------------------------|
+ * | `currency`       | `string`             | ✅         | The currency in which to display the carts.                |
+ * | `pageable`       | `object`             | ✅         | The pagination parameters.                                 |
+ * | `status`         | `CartStatusDto[]`    | ❌         | The status of the carts to retrieve.                       |
+ * | `type`           | `CartTypeDto[]`      | ❌         | The type of carts to retrieve (e.g. `CART`, `BUYING_LIST`).                             |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetCartsResponse` object, containing the list of carts and pagination information.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const carts = await getCarts({ currency: 'USD', pageable: { page: 1, size: 10 } });
+ * ```
+ *
+ * @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.
+ */
+export declare function getCarts(params: GetCartsParameters): Promise<GetCartsResponse>;
+/**
+ * 🛒 Creates a new cart.
+ *
+ * This function sends a request to create a new cart with the specified name.
+ *
+ * 🛠 **Endpoint**: `POST /v2/shop/carts [cART100]`
+ *
+ * | Parameter  | Type     | Required   | Description                     |
+ * |------------|----------|------------|---------------------------------|
+ * | `name`     | `string` | ✅         | The name of the cart to create. |
+ * | `type`     | `CartTypeDto` | ❌         | The type of the cart to create (`CART` (by default) or `BUYING_LIST`). |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetCartResponse` object, confirming the creation of the cart.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * await createCart({ name: 'New Cart' });
+ * ```
+ *
+ * @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<CreateCartResponse>;
+/**
+ * 🗑️ Deletes a specific cart.
+ *
+ * This function sends a request to delete the cart identified by its ID.
+ *
+ * 🛠 **Endpoint**: `DELETE /v2/shop/carts/{cartId} [cART300]`
+ *
+ * | Parameter  | Type     | Required   | Description                      |
+ * |------------|----------|------------|----------------------------------|
+ * | `cartId`   | `string` | ✅         | The ID of the cart to delete.    |
+ *
+ * 📤 **Returns**:
+ * A `Promise<void>` that resolves when the cart is successfully deleted.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * await deleteCart({ cartId: 'cart1' });
+ * ```
+ *
+ * @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>;
+/**
+ * 🛒 Retrieves the details of a specific cart.
+ *
+ * This function allows fetching the information of a cart based on its ID.
+ *
+ * 🛠 **Endpoint**: `GET /v2/shop/carts/{cartId} [cART500]`
+ *
+ * | 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.               |
+ *
+ * 📤 **Returns**:
+ * A `Promise<GetCartResponse>` containing the details of the requested cart.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const cartDetails = await getCart({ cartId: 'cart1', currency: 'USD' });
+ * ```
+ *
+ * @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>;
+/**
+ * ✏️ Updates an existing cart.
+ *
+ * This function sends a request to update the name of a cart identified by its ID.
+ *
+ * 🛠 **Endpoint**: `PUT /v2/shop/carts/{cartId} [cART200]`
+ *
+ * | Parameter  | Type     | Required   | Description                           |
+ * |------------|----------|------------|---------------------------------------|
+ * | `cartId`   | `string` | ✅         | The ID of the cart to update.         |
+ * | `name`     | `string` | ✅         | The new name of the cart.             |
+ * | `type`     | `CartTypeDto` | ❌    | The type of cart (`CART` (by default) or `BUYING_LIST`).                     |
+ *
+ * 📤 **Returns**:
+ * A `Promise<void>` that resolves when the cart is successfully updated.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * await updateCart({ cartId: 'cart1', name: 'Updated Cart Name' });
+ * ```
+ *
+ * @param {UpdateCartParameters} params - The parameters for updating the cart:
+ *   - `cartId` - The ID of the cart to update.
+ *   - `name` - The new name of the cart.
+ *   - `type` - The type of the cart.
+ *
+ * @returns {Promise<void>} - A promise that resolves when the update is successful.
+ */
+export declare function updateCart(params: UpdateCartParameters): Promise<void>;
+/**
+ * 🛒 Initializes orders from a cart.
+ *
+ * This function sends a request to initialize an order from a specified cart.
+ *
+ * 🛠 **Endpoint**: `POST /v2/shop/carts/{cartId}/initialize-orders [cART101]`
+ *
+ * | Parameter  | Type     | Required   | Description                              |
+ * |------------|----------|------------|------------------------------------------|
+ * | `cartId`   | `string` | ✅         | The ID of the cart to initialize orders. |
+ *
+ * 📤 **Returns**:
+ * A `Promise<string>` containing the business ID of the created order.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const orderId = await initializeOrdersFromCart({ cartId: 'cart1' });
+ * ```
+ *
+ * @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>;
+/**
+ * 🗑️ Deletes lines from a cart.
+ *
+ * This function sends a request to delete specific lines from a cart.
+ *
+ * 🛠 **Endpoint**: `DELETE /v2/shop/carts/{cartId}/lines [cART350]`
+ *
+ * | Parameter          | Type       | Required   | Description                          |
+ * |--------------------|------------|------------|--------------------------------------|
+ * | `cartId`           | `string`   | ✅         | The ID of the cart.                  |
+ * | `lineIdsToDelete`  | `FoOfferToDelete[]` | ✅         | The IDs of the lines to delete.      |
+ *
+ * 📤 **Returns**:
+ * A `Promise<DeleteCartLinesResponse>` containing details about the deleted lines.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const response = await deleteCartLines({
+ *   cartId: 'cart1',
+ *   lineIdsToDelete: [
+ *    {
+ *      offerPriceId: 'line1'
+ *    },
+ *    {
+ *      offerPriceId: '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>;
+/**
+ * 📋 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.
+ *
+ * 🛠 **Endpoint**: `GET /v2/shop/carts/{cartId}/lines [cART551]`
+ *
+ * | 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.      |
+ *
+ * 📤 **Returns**:
+ * A `Promise<GetCartLinesResponse>` containing the lines of the cart.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const cartLines = await getCartLines({
+ *   cartId: 'cart1',
+ *   currency: 'USD',
+ *   pageable: { page: 1, size: 10 },
+ *   supplierId: ['supplier1']
+ * });
+ * ```
+ *
+ * @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>;
+/**
+ * ✏️ Updates the lines of a cart.
+ *
+ * This function sends a request to update specific lines of a shopping cart.
+ *
+ * 🛠 **Endpoint**: `PUT /v2/shop/carts/{cartId}/lines [cART150]`
+ *
+ * | Parameter         | Type       | Required   | Description                            |
+ * |-------------------|------------|------------|----------------------------------------|
+ * | `cartId`          | `string`   | ✅         | The ID of the cart.                    |
+ * | `linesToUpdate`   | `FoCartLineToAdd[]` | ✅         | Details of the lines to update.        |
+ *
+ * 📤 **Returns**:
+ * A `Promise<UpdateCartLinesResponse>` containing the updated lines' information.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const response = await updateCartLines({
+ *   cartId: 'cart1',
+ *   linesToUpdate: [
+ *     { offerPriceId: 'line1', quantity: 3, updateAction: 'update' }
+ *   ]
+ * });
+ * ```
+ *
+ * @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>;
+/**
+ * ✏️ Updates the lines of a cart by variant.
+ *
+ * This function sends a request to update cart lines based on product variants.
+ *
+ * 🛠 **Endpoint**: `PUT /v2/shop/carts/{cartId}/lines-by-variant [cART151]`
+ *
+ * | Parameter         | Type       | Required   | Description                            |
+ * |-------------------|------------|------------|----------------------------------------|
+ * | `cartId`          | `string`   | ✅         | The ID of the cart.                    |
+ * | `linesToUpdate`   | `FoCartLineToAddByVariant[]` | ✅         | Details of the lines to update.        |
+ *
+ * 📤 **Returns**:
+ * A `Promise<UpdateCartLinesByVariantResponse>` containing the updated lines' information.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const response = await updateCartLinesByVariant({
+ *   cartId: 'cart1',
+ *   linesToUpdate: [
+ *     { offerPriceId: 'variant1', quantity: 2, updateAction: 'update' }
+ *   ]
+ * });
+ * ```
+ *
+ * @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>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/services/cart/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,oBAAoB,EACpB,mBAAmB,EACnB,oBAAoB,EACpB,iBAAiB,EACjB,eAAe,EACf,kBAAkB,EAClB,gBAAgB,EAChB,oBAAoB,EACpB,kCAAkC,EAClC,sBAAsB,EACtB,uBAAuB,EACvB,yBAAyB,EACzB,oBAAoB,EACpB,uBAAuB,EACvB,yBAAyB,EACzB,kCAAkC,EAClC,gCAAgC,EAChC,kBAAkB,EACnB,MAAM,eAAe,CAAC;AAEvB;;GAEG;AAEH;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,WAAW,IAAI,OAAO,CAAC,mBAAmB,CAAC,CAOhE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAsB,QAAQ,CAC5B,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,gBAAgB,CAAC,CAkB3B;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAsB,UAAU,CAC9B,MAAM,EAAE,oBAAoB,GAC3B,OAAO,CAAC,kBAAkB,CAAC,CAY7B;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAsB,UAAU,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAU5E;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAsB,OAAO,CAC3B,MAAM,EAAE,iBAAiB,GACxB,OAAO,CAAC,eAAe,CAAC,CAgB1B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAsB,UAAU,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAW5E;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAsB,wBAAwB,CAC5C,MAAM,EAAE,kCAAkC,GACzC,OAAO,CAAC,MAAM,CAAC,CAYjB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAsB,eAAe,CACnC,MAAM,EAAE,yBAAyB,GAChC,OAAO,CAAC,uBAAuB,CAAC,CAelC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,wBAAsB,YAAY,CAChC,MAAM,EAAE,sBAAsB,GAC7B,OAAO,CAAC,oBAAoB,CAAC,CA4B/B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAsB,eAAe,CACnC,MAAM,EAAE,yBAAyB,GAChC,OAAO,CAAC,uBAAuB,CAAC,CAalC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAsB,wBAAwB,CAC5C,MAAM,EAAE,kCAAkC,GACzC,OAAO,CAAC,gCAAgC,CAAC,CAa3C"}