@djust-b2b/djust-front-sdk 3.0.0-beta.9 → 3.0.1

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

@@ -0,0 +1,388 @@
+import { CreateProductReviewParameters, CreateProductReviewResponse, GetProductOffersParameters, GetProductOffersResponse, GetProductParameters, GetProductReviewsParameters, GetProductReviewsResponse, GetProductStatReviewsParameters, GetProductStatReviewsResponse, GetProductVariantAttributesParameters, GetProductVariantAttributesResponse, GetProductVariantOffersParameters, GetProductVariantOffersResponse, GetProductVariantSuppliersParameters, GetProductVariantSuppliersResponse, GetProductsListParameters, GetProductsListResponse, GetRelatedProductsParameters, AutoCompleteSearchProductsParameters, SearchProductsResponse, UpdateProductReviewParameters, UpdateProductReviewResponse, GetProductPaginatedOffersParameters, GetProductPaginatedOffersResponse, GetRelatedProductsResponse } from "./definitions";
+/**
+ * 📄 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);
+ * ```
+ */
+export declare function autoCompleteSearchProducts({ input, locale, currency, pageable, aggregation, productTags, }: AutoCompleteSearchProductsParameters): Promise<SearchProductsResponse>;
+/**
+ * 📄 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.               |
+ * | `hasOfferPrice`   | `boolean`    | ❌       | If `true`, only products with an offer price. Default `false`. |
+ * | `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);
+ * ```
+ */
+export declare function getProductsList({ locale, filters, pageable, hasOfferPrice, }: GetProductsListParameters): Promise<GetProductsListResponse>;
+/**
+ * 📄 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"
+ *     }
+ *   ]
+ * }
+ * ```
+ */
+export declare function getProductVariantOffers({ productIdentifier, productIdType, currency, withoutPrice, }: GetProductVariantOffersParameters): Promise<GetProductVariantOffersResponse>;
+/**
+ * 📄 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);
+ * ```
+ */
+export declare function getProductVariantSuppliers({ productVariantId, }: GetProductVariantSuppliersParameters): Promise<GetProductVariantSuppliersResponse>;
+/**
+ * 📄 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);
+ * ```
+ */
+export declare function getProduct({ productIdentifier, productIdType, locale, }: GetProductParameters): Promise<GetProductsListResponse>;
+/**
+ * @deprecated
+ *
+ * 📄 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);
+ * ```
+ * SWAGGER [PRODUCT-502]
+ */
+export declare function getProductOffers({ productIdentifier, productIdType, locale, currency, withoutPrice, }: GetProductOffersParameters): Promise<GetProductOffersResponse>;
+/**
+ * 📄 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);
+ * ```
+ */
+export declare function getRelatedProducts({ productIdentifier, productIdType, locale, currency, pageable, }: GetRelatedProductsParameters): Promise<GetRelatedProductsResponse>;
+/**
+ * 📄 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);
+ * ```
+ */
+export declare function getProductReviews({ productIdentifier, productIdType, }: GetProductReviewsParameters): Promise<GetProductReviewsResponse>;
+/**
+ * 📄 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);
+ * ```
+ */
+export declare function getProductStatReviews({ productIdentifier, productIdType, }: GetProductStatReviewsParameters): Promise<GetProductStatReviewsResponse>;
+/**
+ * 📄 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);
+ * ```
+ */
+export declare function getProductVariantAttributes({ productIdentifier, productIdType, locale, }: GetProductVariantAttributesParameters): Promise<GetProductVariantAttributesResponse>;
+/**
+ * 📄 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);
+ * ```
+ */
+export declare function createProductReview({ message, productSku, rating, }: CreateProductReviewParameters): Promise<CreateProductReviewResponse>;
+/**
+ * 📄 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);
+ * ```
+ */
+export declare function updateProductReview({ productReviewId, message, rating, }: UpdateProductReviewParameters): Promise<UpdateProductReviewResponse>;
+/**
+ * 📄 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
+ */
+export declare function getProductPaginatedOffers({ productIdentifier, productIdType, currency, locale, withoutPrices, pageable, }: GetProductPaginatedOffersParameters): Promise<GetProductPaginatedOffersResponse>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/services/product/index.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,6BAA6B,EAC7B,2BAA2B,EAC3B,0BAA0B,EAC1B,wBAAwB,EACxB,oBAAoB,EACpB,2BAA2B,EAC3B,yBAAyB,EACzB,+BAA+B,EAC/B,6BAA6B,EAC7B,qCAAqC,EACrC,mCAAmC,EACnC,iCAAiC,EACjC,+BAA+B,EAC/B,oCAAoC,EACpC,kCAAkC,EAClC,yBAAyB,EACzB,uBAAuB,EACvB,4BAA4B,EAC5B,oCAAoC,EACpC,sBAAsB,EACtB,6BAA6B,EAC7B,2BAA2B,EAC3B,mCAAmC,EACnC,iCAAiC,EACjC,0BAA0B,EAC3B,MAAM,eAAe,CAAC;AAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAsB,0BAA0B,CAAC,EAC/C,KAAK,EACL,MAAM,EACN,QAAQ,EACR,QAAQ,EACR,WAAW,EACX,WAAW,GACZ,EAAE,oCAAoC,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAmBxE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAsB,eAAe,CAAC,EACpC,MAAM,EACN,OAAO,EACP,QAAQ,EACR,aAAqB,GACtB,EAAE,yBAAyB,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAiB9D;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,wBAAsB,uBAAuB,CAAC,EAC5C,iBAAiB,EACjB,aAAa,EACb,QAAQ,EACR,YAAY,GACb,EAAE,iCAAiC,GAAG,OAAO,CAAC,+BAA+B,CAAC,CAc9E;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,wBAAsB,0BAA0B,CAAC,EAC/C,gBAAgB,GACjB,EAAE,oCAAoC,GAAG,OAAO,CAAC,kCAAkC,CAAC,CASpF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,wBAAsB,UAAU,CAAC,EAC/B,iBAAiB,EACjB,aAAa,EACb,MAAM,GACP,EAAE,oBAAoB,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAazD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAsB,gBAAgB,CAAC,EACrC,iBAAiB,EACjB,aAAa,EACb,MAAM,EACN,QAAQ,EACR,YAAY,GACb,EAAE,0BAA0B,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAehE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AAEH,wBAAsB,kBAAkB,CAAC,EACvC,iBAAiB,EACjB,aAAa,EACb,MAAM,EACN,QAAQ,EACR,QAAQ,GACT,EAAE,4BAA4B,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAiBpE;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH,wBAAsB,iBAAiB,CAAC,EACtC,iBAAiB,EACjB,aAAa,GACd,EAAE,2BAA2B,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAYlE;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH,wBAAsB,qBAAqB,CAAC,EAC1C,iBAAiB,EACjB,aAAa,GACd,EAAE,+BAA+B,GAAG,OAAO,CAAC,6BAA6B,CAAC,CAY1E;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,wBAAsB,2BAA2B,CAAC,EAChD,iBAAiB,EACjB,aAAa,EACb,MAAM,GACP,EAAE,qCAAqC,GAAG,OAAO,CAAC,mCAAmC,CAAC,CAatF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,wBAAsB,mBAAmB,CAAC,EACxC,OAAO,EACP,UAAU,EACV,MAAM,GACP,EAAE,6BAA6B,GAAG,OAAO,CAAC,2BAA2B,CAAC,CActE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,wBAAsB,mBAAmB,CAAC,EACxC,eAAe,EACf,OAAO,EACP,MAAM,GACP,EAAE,6BAA6B,GAAG,OAAO,CAAC,2BAA2B,CAAC,CAatE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAsB,yBAAyB,CAAC,EAC9C,iBAAiB,EACjB,aAAa,EACb,QAAQ,EACR,MAAM,EACN,aAAa,EACb,QAAQ,GACT,EAAE,mCAAmC,GAAG,OAAO,CAAC,iCAAiC,CAAC,CAkBlF"}