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

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

@@ -1,120 +1,82 @@
 import { GetProductVariantAttributesParameters, GetProductVariantAttributesResponse, GetProductVariantSuppliersParameters, GetProductVariantSuppliersResponse, GetProductVariantsListParameters, GetProductVariantsListResponse } from "./definitions";
 /**
- * APICODE(pVAR300)
- * Retrieves a paginated list of product variants.
+ * 📄 Fetches a paginated list of product variants.
  *
- * This function fetches a list of product variants associated with a specific product SKU.
+ * This function retrieves a list of product variants associated with a specific product SKU.
+ * Pagination and sorting options are available to refine the results.
  *
- * @param {GetProductVariantsListParameters} params - The parameters to filter the product variants list, including:
- * #### productSku - `string` | <strong style={{ color: 'red' }}>required</strong>
- * The SKU of the product to fetch variants for.
+ * 🛠 **Endpoint**: `GET /v1/shop/product-variants`
  *
- * #### locale - `string` | optional
- * The locale for the product variants.
+ * | Parameter       | Type         | Required | Description                                                   |
+ * |-----------------|--------------|----------|---------------------------------------------------------------|
+ * | `productSku`    | `string`     | ✅       | The SKU of the product to fetch variants for.                 |
+ * | `locale`        | `string`     | ❌       | The locale for the product variants.                          |
+ * | `pageable.page` | `number`     | ✅       | The page number to fetch (0-based index).                     |
+ * | `pageable.size` | `number`     | ✅       | The number of items per page.                                 |
+ * | `pageable.sort` | `string[]`   | ❌       | Sorting criteria (e.g., `["name,asc"]`).                      |
  *
- * #### pageable - `object` | optional
- * Pagination details, including:
- * - `page`: The page number.
- * - `size`: The number of items per page.
- * - `sort`: Sorting criteria.
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetProductVariantsListResponse` object, containing the paginated list of product variants with metadata.
  *
- * @returns {Promise<GetProductVariantsListResponse>} - A promise that resolves with the paginated list of product variants.
- *
- * @example
- * #### input
+ * 🛠 **Example usage**:
  * ```typescript
- * await getProductVariantsList({
+ * const variants = await getProductVariantsList({
  *   productSku: 'product123',
  *   locale: 'en-US',
- *   pageable: { page: 1, size: 10, sort: 'name,asc' },
+ *   pageable: { page: 0, size: 10, sort: ['name,asc'] },
  * });
+ * console.log(variants);
  * ```
- * #### output
- * ```json
- * {
- *   "content": [
- *     { "id": "variant1", "name": "Variant 1" },
- *     { "id": "variant2", "name": "Variant 2" }
- *   ],
- *   "pageable": {
- *     "page": 1,
- *     "size": 10,
- *     "totalPages": 5
- *   }
- * }
- * ```
+ *
+ * @param {GetProductVariantsListParameters} params - The parameters for fetching product variants.
+ * @throws {Error} If `productSku` is missing.
+ * @returns {Promise<GetProductVariantsListResponse>} A promise resolving to the product variants response.
  */
 export declare function getProductVariantsList({ productSku, locale, pageable, }: GetProductVariantsListParameters): Promise<GetProductVariantsListResponse>;
 /**
- * APICODE(vSUP300)
- * Retrieves suppliers of a specific product variant.
+ * 📄 Fetches suppliers of a specific product variant.
+ *
+ * This function retrieves a list of suppliers associated with a specific product variant ID.
  *
- * This function fetches a list of suppliers associated with a product variant.
+ * 🛠 **Endpoint**: `GET /v1/shop/product-variants/{productVariantId}/suppliers`
  *
- * @param {GetProductVariantSuppliersParameters} params - The parameters to identify the product variant, including:
- * #### productVariantId - `string` | <strong style={{ color: 'red' }}>required</strong>
- * The ID of the product variant to fetch suppliers for.
+ * | Parameter           | Type         | Required | Description                                     |
+ * |---------------------|--------------|----------|-------------------------------------------------|
+ * | `productVariantId`  | `string`     | ✅       | The ID of the product variant to fetch suppliers for. |
  *
- * @returns {Promise<GetProductVariantSuppliersResponse>} - A promise that resolves with the suppliers of the product variant.
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetProductVariantSuppliersResponse` object, containing the list of suppliers for the product variant.
  *
- * @example
- * #### input
+ * 🛠 **Example usage**:
  * ```typescript
- * await getProductVariantSuppliers({ productVariantId: 'variant123' });
- * ```
- * #### output
- * ```json
- * {
- *   "suppliers": [
- *     { "id": "supplier1", "name": "Supplier 1" },
- *     { "id": "supplier2", "name": "Supplier 2" }
- *   ]
- * }
+ * const suppliers = await getProductVariantSuppliers({
+ *   productVariantId: 'variant123',
+ * });
+ * console.log(suppliers);
  * ```
+ *
+ * @param {GetProductVariantSuppliersParameters} params - The parameters for fetching product variant suppliers.
+ * @throws {Error} If `productVariantId` is missing.
+ * @returns {Promise<GetProductVariantSuppliersResponse>} A promise resolving to the product variant suppliers response.
  */
 export declare function getProductVariantSuppliers({ productVariantId, }: GetProductVariantSuppliersParameters): Promise<GetProductVariantSuppliersResponse>;
 /**
- * ## 🛒 APICODE(vATT300) - Fetch Product Variant Attributes
- *
- * Retrieves detailed attributes of a product variant identified by SKU, ID, or external ID.
- * This metadata includes key details such as **color**, **size**, and **material**, making it easier to describe the variant.
+ * 📄 Fetches attributes of a product variant.
  *
- * ---
+ * This function retrieves detailed attributes of a product variant identified by SKU, ID, or external ID.
  *
- * ### 📥 Parameters
+ * 🛠 **Endpoint**: `GET /v1/shop/products/{productIdentifier}/variant-attributes`
  *
- * | Parameter           | Type     | Required | Description                                                                 |
- * |---------------------|----------|----------|-----------------------------------------------------------------------------|
- * | `productIdentifier` | `string` | ✅ Yes    | The unique identifier of the product variant (e.g., SKU, ID, external ID). |
- * | `productIdType`     | `string` | ✅ Yes    | The type of the identifier: `"sku"`, `"id"`, or `"externalId"`.            |
- * | `locale`            | `string` | ❌ No     | The locale for localized data (e.g., `"en-US"`, `"fr-FR"`). Defaults to the system locale. |
+ * | Parameter           | Type         | Required | Description                                                   |
+ * |---------------------|--------------|----------|---------------------------------------------------------------|
+ * | `productIdentifier` | `string`     | ✅       | The unique identifier of the product variant (e.g., SKU, ID, external ID). |
+ * | `productIdType`     | `string`     | ✅       | The type of the identifier (`sku`, `id`, or `externalId`).    |
+ * | `locale`            | `string`     | ❌       | The locale for localized data (e.g., `en-US`, `fr-FR`). Defaults to system locale. |
  *
- * ---
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetProductVariantAttributesResponse` object, containing metadata such as **color**, **size**, or **material**.
  *
- * ### 📤 Returns
- * **Type:** `Promise<GetProductVariantAttributesResponse>`
- * Resolves with the following structure:
- *
- * ```typescript
- * {
- *   attributes: Array<{
- *     id: string;
- *     name: string;
- *     value: string | number;
- *     type: string;
- *     isRequired: boolean;
- *     description: string;
- *   }>;
- *   locale: string;
- *   productIdentifier: string;
- * }
- * ```
- *
- * ---
- *
- * ### 🧑‍💻 Example Usage
- *
- * **Basic Example:**
+ * 🛠 **Example usage**:
  * ```typescript
  * const attributes = await getProductVariantAttributes({
  *   productIdentifier: 'sku123',
@@ -124,77 +86,8 @@ export declare function getProductVariantSuppliers({ productVariantId, }: GetPro
  * console.log(attributes);
  * ```
  *
- * **Alternative Locale:**
- * ```typescript
- * const attributes = await getProductVariantAttributes({
- *   productIdentifier: 'prod789',
- *   productIdType: 'externalId',
- *   locale: 'fr-FR',
- * });
- * console.log(attributes);
- * ```
- *
- * ---
- *
- * ### 📝 Example Input
- * ```json
- * {
- *   "productIdentifier": "sku123",
- *   "productIdType": "sku",
- *   "locale": "en-US"
- * }
- * ```
- *
- * ---
- *
- * ### 📦 Example Output
- * ```json
- * {
- *   "attributes": [
- *     {
- *       "id": "attr1",
- *       "name": "Color",
- *       "value": "Red",
- *       "type": "text",
- *       "isRequired": true,
- *       "description": "The color of the product variant."
- *     },
- *     {
- *       "id": "attr2",
- *       "name": "Size",
- *       "value": "M",
- *       "type": "text",
- *       "isRequired": false,
- *       "description": "The size of the product variant."
- *     }
- *   ],
- *   "locale": "en-US",
- *   "productIdentifier": "sku123"
- * }
- * ```
- *
- * ---
- *
- * ### 🚨 Error Responses
- *
- * | Code  | Message                                  | Description                                          |
- * |-------|------------------------------------------|------------------------------------------------------|
- * | `400` | `Bad Request`                            | Missing or invalid `productIdentifier` or `productIdType`. |
- * | `404` | `Not Found`                              | The specified product variant does not exist.       |
- * | `500` | `Internal Server Error`                  | Unexpected error on the server.                    |
- *
- * ---
- *
- * ### 📚 Notes
- * - Ensure the `productIdType` matches the `productIdentifier` value to avoid mismatched requests.
- * - Providing a valid `locale` is recommended for fetching localized attribute data when applicable.
- * - This API version supports strict versioning; ensure compatibility with your application's requirements.
- *
- * ---
- *
- * ### 🔗 Additional Resources
- * - [API Authentication Guide](https://docs.example.com/api-authentication)
- * - [Product Variants Documentation](https://docs.example.com/product-variants)
- * - [Common Error Codes](https://docs.example.com/error-codes)
+ * @param {GetProductVariantAttributesParameters} params - The parameters for fetching product variant attributes.
+ * @throws {Error} If `productIdentifier` or `productIdType` is missing.
+ * @returns {Promise<GetProductVariantAttributesResponse>} A promise resolving to the product variant attributes response.
  */
 export declare function getProductVariantAttributes({ productIdentifier, productIdType, locale, }: GetProductVariantAttributesParameters): Promise<GetProductVariantAttributesResponse>;

package/lib/services/product-variant/index.js

@@ -6,49 +6,37 @@ exports.getProductVariantAttributes = getProductVariantAttributes;
 const parameters_validation_1 = require("../../helpers/parameters-validation");
 const fetch_instance_1 = require("../../settings/fetch-instance");
 /**
- * APICODE(pVAR300)
- * Retrieves a paginated list of product variants.
+ * 📄 Fetches a paginated list of product variants.
  *
- * This function fetches a list of product variants associated with a specific product SKU.
+ * This function retrieves a list of product variants associated with a specific product SKU.
+ * Pagination and sorting options are available to refine the results.
  *
- * @param {GetProductVariantsListParameters} params - The parameters to filter the product variants list, including:
- * #### productSku - `string` | <strong style={{ color: 'red' }}>required</strong>
- * The SKU of the product to fetch variants for.
+ * 🛠 **Endpoint**: `GET /v1/shop/product-variants`
  *
- * #### locale - `string` | optional
- * The locale for the product variants.
+ * | Parameter       | Type         | Required | Description                                                   |
+ * |-----------------|--------------|----------|---------------------------------------------------------------|
+ * | `productSku`    | `string`     | ✅       | The SKU of the product to fetch variants for.                 |
+ * | `locale`        | `string`     | ❌       | The locale for the product variants.                          |
+ * | `pageable.page` | `number`     | ✅       | The page number to fetch (0-based index).                     |
+ * | `pageable.size` | `number`     | ✅       | The number of items per page.                                 |
+ * | `pageable.sort` | `string[]`   | ❌       | Sorting criteria (e.g., `["name,asc"]`).                      |
  *
- * #### pageable - `object` | optional
- * Pagination details, including:
- * - `page`: The page number.
- * - `size`: The number of items per page.
- * - `sort`: Sorting criteria.
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetProductVariantsListResponse` object, containing the paginated list of product variants with metadata.
  *
- * @returns {Promise<GetProductVariantsListResponse>} - A promise that resolves with the paginated list of product variants.
- *
- * @example
- * #### input
+ * 🛠 **Example usage**:
  * ```typescript
- * await getProductVariantsList({
+ * const variants = await getProductVariantsList({
  *   productSku: 'product123',
  *   locale: 'en-US',
- *   pageable: { page: 1, size: 10, sort: 'name,asc' },
+ *   pageable: { page: 0, size: 10, sort: ['name,asc'] },
  * });
+ * console.log(variants);
  * ```
- * #### output
- * ```json
- * {
- *   "content": [
- *     { "id": "variant1", "name": "Variant 1" },
- *     { "id": "variant2", "name": "Variant 2" }
- *   ],
- *   "pageable": {
- *     "page": 1,
- *     "size": 10,
- *     "totalPages": 5
- *   }
- * }
- * ```
+ *
+ * @param {GetProductVariantsListParameters} params - The parameters for fetching product variants.
+ * @throws {Error} If `productSku` is missing.
+ * @returns {Promise<GetProductVariantsListResponse>} A promise resolving to the product variants response.
  */
 async function getProductVariantsList({ productSku, locale, pageable, }) {
     (0, parameters_validation_1.required)({ productSku });
@@ -66,31 +54,30 @@ async function getProductVariantsList({ productSku, locale, pageable, }) {
     return data;
 }
 /**
- * APICODE(vSUP300)
- * Retrieves suppliers of a specific product variant.
+ * 📄 Fetches suppliers of a specific product variant.
+ *
+ * This function retrieves a list of suppliers associated with a specific product variant ID.
  *
- * This function fetches a list of suppliers associated with a product variant.
+ * 🛠 **Endpoint**: `GET /v1/shop/product-variants/{productVariantId}/suppliers`
  *
- * @param {GetProductVariantSuppliersParameters} params - The parameters to identify the product variant, including:
- * #### productVariantId - `string` | <strong style={{ color: 'red' }}>required</strong>
- * The ID of the product variant to fetch suppliers for.
+ * | Parameter           | Type         | Required | Description                                     |
+ * |---------------------|--------------|----------|-------------------------------------------------|
+ * | `productVariantId`  | `string`     | ✅       | The ID of the product variant to fetch suppliers for. |
  *
- * @returns {Promise<GetProductVariantSuppliersResponse>} - A promise that resolves with the suppliers of the product variant.
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetProductVariantSuppliersResponse` object, containing the list of suppliers for the product variant.
  *
- * @example
- * #### input
+ * 🛠 **Example usage**:
  * ```typescript
- * await getProductVariantSuppliers({ productVariantId: 'variant123' });
- * ```
- * #### output
- * ```json
- * {
- *   "suppliers": [
- *     { "id": "supplier1", "name": "Supplier 1" },
- *     { "id": "supplier2", "name": "Supplier 2" }
- *   ]
- * }
+ * const suppliers = await getProductVariantSuppliers({
+ *   productVariantId: 'variant123',
+ * });
+ * console.log(suppliers);
  * ```
+ *
+ * @param {GetProductVariantSuppliersParameters} params - The parameters for fetching product variant suppliers.
+ * @throws {Error} If `productVariantId` is missing.
+ * @returns {Promise<GetProductVariantSuppliersResponse>} A promise resolving to the product variant suppliers response.
  */
 async function getProductVariantSuppliers({ productVariantId, }) {
     (0, parameters_validation_1.required)({ productVariantId });
@@ -101,47 +88,22 @@ async function getProductVariantSuppliers({ productVariantId, }) {
     return data;
 }
 /**
- * ## 🛒 APICODE(vATT300) - Fetch Product Variant Attributes
- *
- * Retrieves detailed attributes of a product variant identified by SKU, ID, or external ID.
- * This metadata includes key details such as **color**, **size**, and **material**, making it easier to describe the variant.
+ * 📄 Fetches attributes of a product variant.
  *
- * ---
+ * This function retrieves detailed attributes of a product variant identified by SKU, ID, or external ID.
  *
- * ### 📥 Parameters
+ * 🛠 **Endpoint**: `GET /v1/shop/products/{productIdentifier}/variant-attributes`
  *
- * | Parameter           | Type     | Required | Description                                                                 |
- * |---------------------|----------|----------|-----------------------------------------------------------------------------|
- * | `productIdentifier` | `string` | ✅ Yes    | The unique identifier of the product variant (e.g., SKU, ID, external ID). |
- * | `productIdType`     | `string` | ✅ Yes    | The type of the identifier: `"sku"`, `"id"`, or `"externalId"`.            |
- * | `locale`            | `string` | ❌ No     | The locale for localized data (e.g., `"en-US"`, `"fr-FR"`). Defaults to the system locale. |
+ * | Parameter           | Type         | Required | Description                                                   |
+ * |---------------------|--------------|----------|---------------------------------------------------------------|
+ * | `productIdentifier` | `string`     | ✅       | The unique identifier of the product variant (e.g., SKU, ID, external ID). |
+ * | `productIdType`     | `string`     | ✅       | The type of the identifier (`sku`, `id`, or `externalId`).    |
+ * | `locale`            | `string`     | ❌       | The locale for localized data (e.g., `en-US`, `fr-FR`). Defaults to system locale. |
  *
- * ---
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetProductVariantAttributesResponse` object, containing metadata such as **color**, **size**, or **material**.
  *
- * ### 📤 Returns
- * **Type:** `Promise<GetProductVariantAttributesResponse>`
- * Resolves with the following structure:
- *
- * ```typescript
- * {
- *   attributes: Array<{
- *     id: string;
- *     name: string;
- *     value: string | number;
- *     type: string;
- *     isRequired: boolean;
- *     description: string;
- *   }>;
- *   locale: string;
- *   productIdentifier: string;
- * }
- * ```
- *
- * ---
- *
- * ### 🧑‍💻 Example Usage
- *
- * **Basic Example:**
+ * 🛠 **Example usage**:
  * ```typescript
  * const attributes = await getProductVariantAttributes({
  *   productIdentifier: 'sku123',
@@ -151,78 +113,9 @@ async function getProductVariantSuppliers({ productVariantId, }) {
  * console.log(attributes);
  * ```
  *
- * **Alternative Locale:**
- * ```typescript
- * const attributes = await getProductVariantAttributes({
- *   productIdentifier: 'prod789',
- *   productIdType: 'externalId',
- *   locale: 'fr-FR',
- * });
- * console.log(attributes);
- * ```
- *
- * ---
- *
- * ### 📝 Example Input
- * ```json
- * {
- *   "productIdentifier": "sku123",
- *   "productIdType": "sku",
- *   "locale": "en-US"
- * }
- * ```
- *
- * ---
- *
- * ### 📦 Example Output
- * ```json
- * {
- *   "attributes": [
- *     {
- *       "id": "attr1",
- *       "name": "Color",
- *       "value": "Red",
- *       "type": "text",
- *       "isRequired": true,
- *       "description": "The color of the product variant."
- *     },
- *     {
- *       "id": "attr2",
- *       "name": "Size",
- *       "value": "M",
- *       "type": "text",
- *       "isRequired": false,
- *       "description": "The size of the product variant."
- *     }
- *   ],
- *   "locale": "en-US",
- *   "productIdentifier": "sku123"
- * }
- * ```
- *
- * ---
- *
- * ### 🚨 Error Responses
- *
- * | Code  | Message                                  | Description                                          |
- * |-------|------------------------------------------|------------------------------------------------------|
- * | `400` | `Bad Request`                            | Missing or invalid `productIdentifier` or `productIdType`. |
- * | `404` | `Not Found`                              | The specified product variant does not exist.       |
- * | `500` | `Internal Server Error`                  | Unexpected error on the server.                    |
- *
- * ---
- *
- * ### 📚 Notes
- * - Ensure the `productIdType` matches the `productIdentifier` value to avoid mismatched requests.
- * - Providing a valid `locale` is recommended for fetching localized attribute data when applicable.
- * - This API version supports strict versioning; ensure compatibility with your application's requirements.
- *
- * ---
- *
- * ### 🔗 Additional Resources
- * - [API Authentication Guide](https://docs.example.com/api-authentication)
- * - [Product Variants Documentation](https://docs.example.com/product-variants)
- * - [Common Error Codes](https://docs.example.com/error-codes)
+ * @param {GetProductVariantAttributesParameters} params - The parameters for fetching product variant attributes.
+ * @throws {Error} If `productIdentifier` or `productIdType` is missing.
+ * @returns {Promise<GetProductVariantAttributesResponse>} A promise resolving to the product variant attributes response.
  */
 async function getProductVariantAttributes({ productIdentifier, productIdType, locale, }) {
     (0, parameters_validation_1.required)({ productIdentifier, productIdType });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@djust-b2b/djust-front-sdk",
-  "version": "1.15.0",
+  "version": "1.15.1",
   "description": "DJUST Front SDK is a versatile JavaScript Software Development Kit (SDK) ",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",