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

package/lib/services/product/index.js

@@ -17,7 +17,35 @@ exports.getProductPaginatedOffers = getProductPaginatedOffers;
 const parameters_validation_1 = require("../../helpers/parameters-validation");
 const fetch_instance_1 = require("../../settings/fetch-instance");
 /**
- * Search product with text expression for search and autocomplete
+ * 📄 Search products with a text expression for search and autocomplete.
+ *
+ * This function provides product search and autocomplete capabilities.
+ *
+ * 🛠 **Endpoint**: `GET /v2/shop/autocomplete`
+ *
+ * | Parameter       | Type         | Required | Description                                 |
+ * |-----------------|--------------|----------|---------------------------------------------|
+ * | `input`         | `string`     | ✅       | The text expression to search for.         |
+ * | `locale`        | `string`     | ✅       | The locale for the search.                 |
+ * | `currency`      | `string`     | ✅       | The currency for price formatting.         |
+ * | `pageable.page` | `number`     | ❌       | The page number to fetch (0-based index).  |
+ * | `pageable.size` | `number`     | ❌       | The number of items per page.              |
+ * | `aggregation`   | `boolean`    | ❌       | Whether to include aggregation data.       |
+ * | `productTags`   | `string[]`   | ❌       | Filters by product tags.                   |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `SearchProductsResponse` containing the matched products.
+ *
+ * 🛠 **Example usage**:
+ * ```typescript
+ * const products = await autoCompleteSearchProducts({
+ *   input: 'laptop',
+ *   locale: 'en-US',
+ *   currency: 'USD',
+ *   pageable: { page: 0, size: 10 },
+ * });
+ * console.log(products);
+ * ```
  */
 async function autoCompleteSearchProducts({ input, locale, currency, pageable, aggregation, productTags, }) {
     (0, parameters_validation_1.required)({ input, locale, currency });
@@ -32,13 +60,34 @@ async function autoCompleteSearchProducts({ input, locale, currency, pageable, a
             productTags,
             page: pageable === null || pageable === void 0 ? void 0 : pageable.page,
             size: pageable === null || pageable === void 0 ? void 0 : pageable.size,
-            sort: pageable === null || pageable === void 0 ? void 0 : pageable.sort,
         },
     });
     return data;
 }
 /**
- * Get thumbnails of a product regrouping product, stat reviews, attributs and bestOffer
+ * 📄 Fetches a list of products with thumbnails, reviews, attributes, and best offers.
+ *
+ * 🛠 **Endpoint**: `GET /v2/shop/search`
+ *
+ * | Parameter       | Type         | Required | Description                                 |
+ * |-----------------|--------------|----------|---------------------------------------------|
+ * | `locale`        | `string`     | ✅       | The locale for product data.               |
+ * | `filters`       | `object`     | ❌       | Filters for narrowing down search results. |
+ * | `pageable.page` | `number`     | ❌       | The page number to fetch (0-based index).  |
+ * | `pageable.size` | `number`     | ❌       | The number of items per page.              |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetProductsListResponse` containing the products and their metadata.
+ *
+ * 🛠 **Example usage**:
+ * ```typescript
+ * const products = await getProductsList({
+ *   locale: 'en-US',
+ *   filters: { category: 'electronics' },
+ *   pageable: { page: 1, size: 20 },
+ * });
+ * console.log(products);
+ * ```
  */
 async function getProductsList({ locale, filters, pageable, }) {
     (0, parameters_validation_1.required)({ locale });
@@ -50,13 +99,34 @@ async function getProductsList({ locale, filters, pageable, }) {
             locale,
             page: pageable === null || pageable === void 0 ? void 0 : pageable.page,
             size: pageable === null || pageable === void 0 ? void 0 : pageable.size,
-            sort: pageable === null || pageable === void 0 ? void 0 : pageable.sort,
         },
     });
     return data;
 }
 /**
- * Get a paginated list of a product's variants
+ * 📄 Fetches product variants by product SKU.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/product-variants`
+ *
+ * | Parameter       | Type         | Required | Description                                |
+ * |-----------------|--------------|----------|--------------------------------------------|
+ * | `productSku`    | `string`     | ✅       | The SKU of the product.                   |
+ * | `locale`        | `string`     | ❌       | The locale for product variants.          |
+ * | `pageable.page` | `number`     | ❌       | The page number to fetch (0-based index). |
+ * | `pageable.size` | `number`     | ❌       | The number of items per page.             |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetProductVariantsListResponse` containing the product variants.
+ *
+ * 🛠 **Example usage**:
+ * ```typescript
+ * const variants = await getProductVariantsList({
+ *   productSku: 'sku123',
+ *   locale: 'en-US',
+ *   pageable: { page: 0, size: 10 },
+ * });
+ * console.log(variants);
+ * ```
  */
 async function getProductVariantsList({ productSku, locale, pageable, }) {
     (0, parameters_validation_1.required)({ productSku });
@@ -68,13 +138,58 @@ async function getProductVariantsList({ productSku, locale, pageable, }) {
             locale,
             page: pageable === null || pageable === void 0 ? void 0 : pageable.page,
             size: pageable === null || pageable === void 0 ? void 0 : pageable.size,
-            sort: pageable === null || pageable === void 0 ? void 0 : pageable.sort,
         },
     });
     return data;
 }
 /**
- * Get List offers of a product variant by sku, id or externalId
+ * 📄 Fetches offers for a specific product variant.
+ *
+ * Retrieves the list of offers available for a product variant identified by SKU, ID, or external ID.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/product-variants/{productIdentifier}/offers`
+ *
+ * | Parameter             | Type        | Required   | Description                                                   |
+ * |-----------------------|-------------|------------|---------------------------------------------------------------|
+ * | `productIdentifier`   | `string`    | ✅         | Unique identifier for the product variant (e.g., SKU, ID).    |
+ * | `productIdType`       | `string`    | ✅         | The type of identifier: `"sku"`, `"id"`, or `"externalId"`.   |
+ * | `currency`            | `string`    | ✅         | Currency in which offers should be returned (e.g., `"USD"`).  |
+ *
+ * 📤 **Returns**:
+ * A `Promise<GetProductVariantOffersResponse>` containing a list of offers for the product variant.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const offers = await getProductVariantOffers({
+ *   productIdentifier: 'sku123',
+ *   productIdType: 'sku',
+ *   currency: 'USD',
+ * });
+ *
+ * console.log(offers);
+ * ```
+ *
+ * **Example Response**:
+ * ```json
+ * {
+ *   "offers": [
+ *     {
+ *       "id": "offer1",
+ *       "price": 19.99,
+ *       "currency": "USD",
+ *       "availability": "In Stock",
+ *       "seller": "Seller A"
+ *     },
+ *     {
+ *       "id": "offer2",
+ *       "price": 17.99,
+ *       "currency": "USD",
+ *       "availability": "Limited Stock",
+ *       "seller": "Seller B"
+ *     }
+ *   ]
+ * }
+ * ```
  */
 async function getProductVariantOffers({ productIdentifier, productIdType, currency, }) {
     (0, parameters_validation_1.required)({ productIdentifier, productIdType });
@@ -89,7 +204,27 @@ async function getProductVariantOffers({ productIdentifier, productIdType, curre
     return data;
 }
 /**
- * Get suppliers of a product variant
+ * 📄 Fetches suppliers associated with a product variant.
+ *
+ * Retrieves a list of suppliers for a given product variant.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/product-variants/{productVariantId}/suppliers`
+ *
+ * | Parameter             | Type                          | Required   | Description                                                   |
+ * |-----------------------|-------------------------------|------------|---------------------------------------------------------------|
+ * | `productVariantId`    | `string`                     | ✅         | ID of the product variant.                                    |
+ *
+ * 📤 **Returns**:
+ * A `Promise<GetProductVariantSuppliersResponse>` containing the list of suppliers.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const suppliers = await getProductVariantSuppliers({
+ *   productVariantId: 'variant123',
+ * });
+ *
+ * console.log(suppliers);
+ * ```
  */
 async function getProductVariantSuppliers({ productVariantId, }) {
     (0, parameters_validation_1.required)({ productVariantId });
@@ -100,7 +235,31 @@ async function getProductVariantSuppliers({ productVariantId, }) {
     return data;
 }
 /**
- * Get a product by sku, id or externalId
+ * 📄 Fetches details for a specific product.
+ *
+ * Retrieves information about a product identified by SKU, ID, or external ID.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/products/{productIdentifier}`
+ *
+ * | Parameter             | Type        | Required   | Description                                                   |
+ * |-----------------------|-------------|------------|---------------------------------------------------------------|
+ * | `productIdentifier`   | `string`    | ✅         | Unique identifier for the product (e.g., SKU, ID).            |
+ * | `productIdType`       | `string`    | ✅         | The type of identifier: `"sku"`, `"id"`, or `"externalId"`.   |
+ * | `locale`              | `string`    | ✅         | Locale for the product details (e.g., `"en_US"`).             |
+ *
+ * 📤 **Returns**:
+ * A `Promise<GetProductsListResponse>` containing the product details.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const product = await getProduct({
+ *   productIdentifier: 'sku123',
+ *   productIdType: 'sku',
+ *   locale: 'en_US',
+ * });
+ *
+ * console.log(product);
+ * ```
  */
 async function getProduct({ productIdentifier, productIdType, locale, }) {
     (0, parameters_validation_1.required)({ productIdentifier, productIdType });
@@ -115,7 +274,28 @@ async function getProduct({ productIdentifier, productIdType, locale, }) {
     return data;
 }
 /**
- * Get offers of a product by sku, id or externalId
+ * 📄 Fetches product offers by SKU, ID, or external ID.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/products/{productIdentifier}/offers`
+ *
+ * | Parameter           | Type         | Required | Description                                     |
+ * |---------------------|--------------|----------|-------------------------------------------------|
+ * | `productIdentifier` | `string`     | ✅       | The unique identifier of the product.          |
+ * | `productIdType`     | `string`     | ✅       | The type of the identifier (`sku`, `id`, etc.).|
+ * | `currency`          | `string`     | ✅       | The currency for the offer details.            |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetProductVariantOffersResponse` containing the offers.
+ *
+ * 🛠 **Example usage**:
+ * ```typescript
+ * const offers = await getProductVariantOffers({
+ *   productIdentifier: 'sku123',
+ *   productIdType: 'sku',
+ *   currency: 'USD',
+ * });
+ * console.log(offers);
+ * ```
  */
 async function getProductOffers({ productIdentifier, productIdType, locale, currency, }) {
     (0, parameters_validation_1.required)({ productIdentifier, productIdType });
@@ -131,7 +311,35 @@ async function getProductOffers({ productIdentifier, productIdType, locale, curr
     return data;
 }
 /**
- * Get related products of a product by sku, id or externalId
+ * 📄 Fetches related products for a specific product.
+ *
+ * Retrieves a paginated list of related products identified by SKU, ID, or external ID.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/products/{productIdentifier}/related-products`
+ *
+ * | Parameter             | Type        | Required   | Description                                                   |
+ * |-----------------------|-------------|------------|---------------------------------------------------------------|
+ * | `productIdentifier`   | `string`    | ✅         | Unique identifier for the product (e.g., SKU, ID).            |
+ * | `productIdType`       | `string`    | ✅         | The type of identifier: `"sku"`, `"id"`, or `"externalId"`.   |
+ * | `locale`              | `string`    | ✅         | Locale for the related products (e.g., `"en_US"`).            |
+ * | `currency`            | `string`    | ✅         | Currency for the related products (e.g., `"USD"`).            |
+ * | `pageable`            | `object`    | ❌         | Pagination details: `page`, `size`, `sort`.                   |
+ *
+ * 📤 **Returns**:
+ * A `Promise<GetRelatedProductsParameters>` containing related products.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const relatedProducts = await getRelatedProducts({
+ *   productIdentifier: 'sku123',
+ *   productIdType: 'sku',
+ *   locale: 'en_US',
+ *   currency: 'USD',
+ *   pageable: { page: 1, size: 10 },
+ * });
+ *
+ * console.log(relatedProducts);
+ * ```
  */
 async function getRelatedProducts({ productIdentifier, productIdType, locale, currency, pageable, }) {
     (0, parameters_validation_1.required)({ productIdentifier, productIdType });
@@ -150,7 +358,29 @@ async function getRelatedProducts({ productIdentifier, productIdType, locale, cu
     return data;
 }
 /**
- * Get reviews of a product by sku, id or externalId
+ * 📄 Fetches reviews for a specific product.
+ *
+ * Retrieves a list of reviews for a product identified by SKU, ID, or external ID.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/products/{productIdentifier}/reviews`
+ *
+ * | Parameter             | Type        | Required   | Description                                                   |
+ * |-----------------------|-------------|------------|---------------------------------------------------------------|
+ * | `productIdentifier`   | `string`    | ✅         | Unique identifier for the product (e.g., SKU, ID).            |
+ * | `productIdType`       | `string`    | ✅         | The type of identifier: `"sku"`, `"id"`, or `"externalId"`.   |
+ *
+ * 📤 **Returns**:
+ * A `Promise<GetProductReviewsResponse>` containing the reviews.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const reviews = await getProductReviews({
+ *   productIdentifier: 'sku123',
+ *   productIdType: 'sku',
+ * });
+ *
+ * console.log(reviews);
+ * ```
  */
 async function getProductReviews({ productIdentifier, productIdType, }) {
     (0, parameters_validation_1.required)({ productIdentifier, productIdType });
@@ -164,7 +394,29 @@ async function getProductReviews({ productIdentifier, productIdType, }) {
     return data;
 }
 /**
- * Get stat reviews of a product by sku, id or externalId
+ * 📄 Fetches statistical review data for a specific product.
+ *
+ * Retrieves aggregate review statistics for a product identified by SKU, ID, or external ID.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/products/{productIdentifier}/stat-reviews`
+ *
+ * | Parameter             | Type        | Required   | Description                                                   |
+ * |-----------------------|-------------|------------|---------------------------------------------------------------|
+ * | `productIdentifier`   | `string`    | ✅         | Unique identifier for the product (e.g., SKU, ID).            |
+ * | `productIdType`       | `string`    | ✅         | The type of identifier: `"sku"`, `"id"`, or `"externalId"`.   |
+ *
+ * 📤 **Returns**:
+ * A `Promise<GetProductStatReviewsResponse>` containing review statistics.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const stats = await getProductStatReviews({
+ *   productIdentifier: 'sku123',
+ *   productIdType: 'sku',
+ * });
+ *
+ * console.log(stats);
+ * ```
  */
 async function getProductStatReviews({ productIdentifier, productIdType, }) {
     (0, parameters_validation_1.required)({ productIdentifier, productIdType });
@@ -178,7 +430,31 @@ async function getProductStatReviews({ productIdentifier, productIdType, }) {
     return data;
 }
 /**
- * Get attributes of a product variant by sku, id or externalId
+ * 📄 Fetches attributes for a product variant.
+ *
+ * Retrieves attributes for a product variant identified by SKU, ID, or external ID.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/products/{productIdentifier}/variant-attributes`
+ *
+ * | Parameter             | Type        | Required   | Description                                                   |
+ * |-----------------------|-------------|------------|---------------------------------------------------------------|
+ * | `productIdentifier`   | `string`    | ✅         | Unique identifier for the product variant (e.g., SKU, ID).    |
+ * | `productIdType`       | `string`    | ✅         | The type of identifier: `"sku"`, `"id"`, or `"externalId"`.   |
+ * | `locale`              | `string`    | ✅         | Locale for the attributes (e.g., `"en_US"`).                  |
+ *
+ * 📤 **Returns**:
+ * A `Promise<GetProductVariantAttributesResponse>` containing variant attributes.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const attributes = await getProductVariantAttributes({
+ *   productIdentifier: 'sku123',
+ *   productIdType: 'sku',
+ *   locale: 'en_US',
+ * });
+ *
+ * console.log(attributes);
+ * ```
  */
 async function getProductVariantAttributes({ productIdentifier, productIdType, locale, }) {
     (0, parameters_validation_1.required)({ productIdentifier, productIdType });
@@ -193,7 +469,31 @@ async function getProductVariantAttributes({ productIdentifier, productIdType, l
     return data;
 }
 /**
- * Create a review for a product
+ * 📄 Creates a review for a product.
+ *
+ * Submits a review for a specific product based on its SKU.
+ *
+ * 🛠 **Endpoint**: `POST /v1/shop/reviews`
+ *
+ * | Parameter             | Type                          | Required   | Description                                                   |
+ * |-----------------------|-------------------------------|------------|---------------------------------------------------------------|
+ * | `message`             | `string`                     | ✅         | Review content.                                               |
+ * | `productSku`          | `string`                     | ✅         | SKU of the product to review.                                |
+ * | `rating`              | `number`                     | ✅         | Rating (e.g., 1 to 5).                                        |
+ *
+ * 📤 **Returns**:
+ * A `Promise<CreateProductReviewResponse>` indicating the result of the operation.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const review = await createProductReview({
+ *   message: 'Great product!',
+ *   productSku: 'sku123',
+ *   rating: 5,
+ * });
+ *
+ * console.log(review);
+ * ```
  */
 async function createProductReview({ message, productSku, rating, }) {
     (0, parameters_validation_1.required)({ message, productSku, rating });
@@ -209,7 +509,31 @@ async function createProductReview({ message, productSku, rating, }) {
     return data;
 }
 /**
- * Update a review for a product
+ * 📄 Updates an existing review for a product.
+ *
+ * Modifies the content and/or rating of an existing review for a specific product.
+ *
+ * 🛠 **Endpoint**: `PUT /v1/shop/reviews/{productReviewId}`
+ *
+ * | Parameter             | Type                          | Required   | Description                                                   |
+ * |-----------------------|-------------------------------|------------|---------------------------------------------------------------|
+ * | `productReviewId`     | `string`                       | ✅         | ID of the review to update.                                   |
+ * | `message`             | `string`                       | ✅         | New review content.                                           |
+ * | `rating`              | `number`                       | ✅         | New rating (e.g., 1 to 5).                                     |
+ *
+ * 📤 **Returns**:
+ * A `Promise<UpdateProductReviewResponse>` indicating the result of the operation.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const updatedReview = await updateProductReview({
+ *   productReviewId: 'review123',
+ *   message: 'Updated my thoughts, still a great product!',
+ *   rating: 4,
+ * });
+ *
+ * console.log(updatedReview);
+ * ```
  */
 async function updateProductReview({ productReviewId, message, rating, }) {
     (0, parameters_validation_1.required)({ productReviewId, message, rating });
@@ -224,7 +548,32 @@ async function updateProductReview({ productReviewId, message, rating, }) {
     return data;
 }
 /**
- * Get paginated offers of a product by sku, id or externalId
+ * 📄 Fetches paginated offers for a product.
+ *
+ * Retrieves offers for a product identified by SKU, ID, or external ID, with pagination support.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/products/{productIdentifier}/paginated-offers`
+ *
+ * | Parameter             | Type        | Required   | Description                                                   |
+ * |-----------------------|-------------|------------|---------------------------------------------------------------|
+ * | `productIdentifier`   | `string`    | ✅         | Unique identifier for the product (e.g., SKU, ID).            |
+ * | `productIdType`       | `string`    | ✅         | The type of identifier: `"sku"`, `"id"`, or `"externalId"`.   |
+ * | `currency`            | `string`    | ✅         | Currency for the offers (e.g., `"USD"`).                      |
+ * | `locale`              | `string`    | ✅         | Locale for the offers (e.g., `"en_US"`).                      |
+ * | `withoutPrices`       | `boolean`   | ❌         | Whether to exclude prices from the response.                  |
+ * | `pageable`            | `object`    | ❌         | Pagination details: `page`, `size`, `sort`.                   |
+ *
+ * 📤 **Returns**:
+ * A `Promise<GetProductPaginatedOffersResponse>` containing paginated offers.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const offers = await getProductPaginatedOffers({
+ *   productIdentifier: 'sku123',
+ *   productIdType: 'sku',
+ *   currency: 'USD',
+ *   locale: 'en_US',
+ *   pageable: { page: 1, size
  */
 async function getProductPaginatedOffers({ productIdentifier, productIdType, currency, locale, withoutPrices, pageable, }) {
     (0, parameters_validation_1.required)({ productIdentifier, productIdType });