@djust-b2b/djust-front-sdk 1.12.0 → 1.13.0

package/lib/services/supplier/index.js

@@ -6,24 +6,83 @@ exports.getSupplierEvaluations = getSupplierEvaluations;
 const parameters_validation_1 = require("../../helpers/parameters-validation");
 const fetch_instance_1 = require("../../settings/fetch-instance");
 /**
- * Get suppliers
+ * 📄 Fetches a paginated list of suppliers.
+ *
+ * This function retrieves a list of suppliers based on the provided pagination parameters.
+ * If no specific filters or sorting are provided, it fetches the default paginated list.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/suppliers`
+ *
+ * | Parameter            | Type                          | Required   | Description                                                   |
+ * |----------------------|-------------------------------|------------|---------------------------------------------------------------|
+ * | `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., `["createdAt,desc"]`).                |
+ * | `supplierStatus`     | `string`                     | ❌         | Available values : ACTIVE, INACTIVE, SUSPENDED                |
+ * | `supplierIds`        | `string[]`                   | ❌         | Only returns information from its suppliers id                |
+ * | `idType`             | `string[]`                   | ❌         | Specifies the type of the id (ex: DJUST_ID, EXTERNAL_ID )     |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetSuppliersResponse` object,
+ * containing the paginated list of suppliers with metadata such as total pages, size, and current page.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const suppliers = await getSuppliers({
+ *   pageable: { page: 0, size: 10, sort: ["createdAt,desc"] },
+ *   supplierStatus: 'ACTIVE',
+ *   idType: 'EXTERNAL_ID'
+ * });
+ *
+ * console.log(suppliers);
+ * ```
+ *
+ * @param {GetSuppliersParameters} params - The pagination parameters for fetching suppliers.
+ * @throws {Error} If `pageable` is missing or invalid.
+ * @returns {Promise<GetSuppliersResponse>} A promise resolving to the paginated suppliers response.
  */
-async function getSuppliers({ pageable, }) {
+async function getSuppliers({ pageable, supplierStatus, supplierIds, idType, }) {
     (0, parameters_validation_1.required)({ pageable });
     const { data } = await (0, fetch_instance_1.enhancedFetch)({
         method: "GET",
-        path: `/v1/shop/autocomplete`,
+        path: `/v1/shop/suppliers`,
         params: {
             pageable,
             page: pageable.page,
             size: pageable.size,
             sort: pageable.sort,
+            supplierStatus,
+            supplierIds,
+            idType,
         },
     });
     return data;
 }
 /**
- * Get a supplier
+ * 📄 Fetches the details of a specific supplier.
+ *
+ * This function retrieves detailed information about a supplier, identified by its unique `supplierId` and optional `idType`.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/suppliers/{supplierId}`
+ *
+ * | Parameter      | Type       | Required   | Description                                             |
+ * |----------------|------------|------------|---------------------------------------------------------|
+ * | `supplierId`   | `string`   | ✅         | The unique id of the supplier to fetch.                 |
+ * | `idType`       | `string`   | ❌         | Specifies the type of the id (ex: DJUST_ID, EXTERNAL_ID)|
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetSupplierResponse` object, containing the details of the supplier.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const supplier = await getSupplier({ supplierId: "supplier123", idType: "DJUST_ID" });
+ *
+ * console.log(supplier);
+ * ```
+ *
+ * @param {GetSupplierParameters} params - The parameters for fetching the supplier details.
+ * @throws {Error} If `supplierId` is missing.
+ * @returns {Promise<GetSupplierResponse>} A promise resolving to the supplier details.
  */
 async function getSupplier({ supplierId, idType, }) {
     (0, parameters_validation_1.required)({ supplierId, idType });
@@ -37,7 +96,39 @@ async function getSupplier({ supplierId, idType, }) {
     return data;
 }
 /**
- * Get supplier evaluations
+ * 📄 Fetches evaluations for a specific supplier.
+ *
+ * This function retrieves a list of evaluations associated with a supplier, identified by its `supplierId`.
+ * Pagination and sorting options are available to refine the results.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/suppliers/{supplierId}/evaluations`
+ *
+ * | Parameter            | Type                          | Required   | Description                                                   |
+ * |----------------------|-------------------------------|------------|---------------------------------------------------------------|
+ * | `supplierId`         | `string`                     | ✅         | The unique id of the supplier.                                |
+ * | `idType`             | `string`                     | ❌         | Specifies the type of the id (ex: DJUST_ID, EXTERNAL_ID)      |
+ * | `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., `["createdAt,desc"]`).                |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `GetSupplierEvaluationsResponse` object,
+ * containing the paginated list of supplier evaluations with metadata.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const evaluations = await getSupplierEvaluations({
+ *   supplierId: "supplier123",
+ *   idType: "EXTERNAL_ID",
+ *   pageable: { page: 1, size: 10, sort: ["createdAt,desc"] },
+ * });
+ *
+ * console.log(evaluations);
+ * ```
+ *
+ * @param {GetSupplierEvaluationsParameters} params - The parameters for fetching supplier evaluations.
+ * @throws {Error} If `supplierId` or `pageable` is missing.
+ * @returns {Promise<GetSupplierEvaluationsResponse>} A promise resolving to the supplier evaluations response.
  */
 async function getSupplierEvaluations({ supplierId, idType, pageable, }) {
     (0, parameters_validation_1.required)({ supplierId, idType });

package/package.json

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