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

package/lib/services/incident/index.js

@@ -1,56 +1,57 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getOrderLogisticIncidents = getOrderLogisticIncidents;
-exports.getOrderLogisticIncident = getOrderLogisticIncident;
-exports.getOrderLogisticLineIncidents = getOrderLogisticLineIncidents;
+exports.getIncidents = getIncidents;
+exports.getIncident = getIncident;
 exports.createOrderLogisticIncident = createOrderLogisticIncident;
 exports.createOrderLogisticLineIncident = createOrderLogisticLineIncident;
-exports.getCustomerAccountIncidents = getCustomerAccountIncidents;
 const parameters_validation_1 = require("../../helpers/parameters-validation");
 const fetch_instance_1 = require("../../settings/fetch-instance");
 /**
- * 🚚 Fetches logistic order incidents.
+ * 🚚 Retrieves a list of incidents based on various filter criteria.
  *
- * This function retrieves a paginated list of incidents for a specific logistic order,
- * filtered by status and other parameters. The `logisticOrderId` parameter is mandatory
- * and validated before the request is executed.
+ * This function allows you to fetch incidents with detailed filtering options, such as customer account IDs, status, and sorting preferences.
  *
- * 🛠 **Endpoint**: `GET /v1/shop/logistic-orders/{logisticOrderId}/incidents [ORDER-557]`
+ * 🛠 **Endpoint**: `GET /v1/shop/incidents [ORDER-559]`
  *
- * | Parameter         | Type                            | Required   | Description                              |
- * |-------------------|---------------------------------|------------|------------------------------------------|
- * | `logisticOrderId` | `string`                       | ✅         | The ID of the logistic order to fetch incidents for. |
- * | `status`          | `IncidentStatus[]`             | ❌         | Array of statuses to filter incidents (e.g., `["OPEN"]`). |
- * | `idType`          | `IncidentIdType`               | ❌         | Specifies whether the ID is internal (`DJUST_ID`) or external (`EXTERNAL_ID`). |
- * | `page`            | `number`                       | ❌         | The page number for pagination.          |
- * | `size`            | `number`                       | ❌         | The number of results per page.          |
- * | `sort`            | `String[]`                    | ❌         | Sorting criteria (e.g., `["createdAt,desc"]`). |
+ * | Parameter             | Type               | Required | Description                                                                 |
+ * |-----------------------|--------------------|----------|-----------------------------------------------------------------------------|
+ * | `customerAccountIds`  | `string[]`        | ❌       | List of customer account IDs to filter incidents by.                       |
+ * | `linkedType`          | `string`          | ✅       | Type of entity linked to the incident (e.g., ORDER or ORDER_LINES).     |
+ * | `ids`                 | `string[]`        | ❌       | Specific incident IDs to retrieve.                                         |
+ * | `status`              | `IncidentStatus[]`| ❌       | List of statuses to filter incidents by (e.g., OPEN, ON_GOING, CLOSED).              |
+ * | `idType`              | `IncidentIdType`  | ❌       | Type of ID used for filtering (e.g., DJUST_ID, EXTERNAL_ID).                  |
+ * | `page`                | `number`          | ❌       | Page number for paginated results (starting at 0).                         |
+ * | `size`                | `number`          | ❌       | Number of incidents per page.                                              |
+ * | `sort`                | `string[]`        | ❌       | Sorting criteria in the format `field,(asc|desc)` (e.g., `status,desc`).   |
  *
  * 📤 **Returns**:
- * A `Promise` resolving to an array of `IncidentDto` objects representing the incidents.
+ * A `Promise<getIncidentsResponse>` containing a paginated list of incidents matching the filter criteria.
  *
  * 🛠 **Example usage**:
  * ```ts
- * const incidents = await getOrderLogisticIncidents({
- *   logisticOrderId: "12345",
- *   status: ["OPEN", "CLOSED"],
- *   idType: "EXTERNAL_ID",
- *   page: 1,
+ * const incidents = await getIncidents({
+ *   customerAccountIds: ["acc123", "acc456"],
+ *   linkedType: "ORDER",
+ *   status: ["OPEN", "ON_GOING"],
+ *   page: 0,
  *   size: 10,
  *   sort: ["createdAt,desc"],
  * });
  * ```
  *
- * @param {getOrderLogisticIncidentsParameters} params - The parameters for the request.
- * @throws {Error} If `logisticOrderId` is missing.
- * @returns {Promise<getOrderLogisticIncidentsResponse>} A promise resolving to the response containing the incidents.
+ * @param {getIncidentsParameters} params - The parameters for filtering and retrieving incidents.
+ * @throws {Error} If the required `linkedType` is missing.
+ * @returns {Promise<getIncidentsResponse>} A promise that resolves to a response object containing the incidents.
  */
-async function getOrderLogisticIncidents({ logisticOrderId, status, idType, page, size, sort, }) {
-    (0, parameters_validation_1.required)({ logisticOrderId });
+async function getIncidents({ customerAccountIds, linkedType, ids, status, idType, page, size, sort, }) {
+    (0, parameters_validation_1.required)({ linkedType });
     const { data } = await (0, fetch_instance_1.enhancedFetch)({
         method: "GET",
-        path: `/v1/shop/logistic-orders/${logisticOrderId}/incidents`,
+        path: `/v1/shop/incidents`,
         params: {
+            customerAccountIds,
+            linkedType,
+            ids,
             status,
             idType,
             page,
@@ -61,101 +62,43 @@ async function getOrderLogisticIncidents({ logisticOrderId, status, idType, page
     return data;
 }
 /**
- * 🚚 Fetches a specific logistic order incident.
+ * 🚚 Retrieves details of a specific incident.
  *
- * This function retrieves a specific incident for a logistic order, identified by both
- * the `logisticOrderId` and `incidentId`. Both parameters are mandatory and validated
- * before the request is executed.
+ * This function fetches detailed information about an incident identified by its ID, with an optional ID type for filtering.
  *
- * 🛠 **Endpoint**: `GET /v1/shop/logistic-orders/{logisticOrderId}/incidents/{incidentId} [ORDER-503]`
+ * 🛠 **Endpoint**: `GET /v1/shop/incidents/{incidentId} [ORDER-503]`
  *
- * | Parameter         | Type                            | Required   | Description                              |
- * |-------------------|---------------------------------|------------|------------------------------------------|
- * | `logisticOrderId` | `string`                       | ✅         | The ID of the logistic order to fetch the incident for. |
- * | `incidentId`      | `string`                       | ✅         | The ID of the specific incident to fetch. |
- * | `idType`          | `IncidentIdType`               | ❌         | Specifies whether the ID is internal (`DJUST_ID`) or external (`EXTERNAL_ID`). |
+ * | Parameter    | Type              | Required | Description                                                      |
+ * |--------------|-------------------|----------|------------------------------------------------------------------|
+ * | `incidentId` | `string`         | ✅       | The unique identifier of the incident to retrieve.              |
+ * | `idType`     | `IncidentIdType` | ❌       | The type of ID used (e.g., DJUST_ID, EXTERNAL_ID) for the incident. |
  *
  * 📤 **Returns**:
- * A `Promise` resolving to a single `getOrderLogisticIncidentResponse` object representing the incident.
+ * A `Promise<getIncidentResponse>` containing the details of the specified incident.
  *
  * 🛠 **Example usage**:
  * ```ts
- * const incident = await getOrderLogisticIncident({
- *   logisticOrderId: "12345",
- *   incidentId: "incident_1",
+ * const incident = await getIncident({
+ *   incidentId: "incident123",
  *   idType: "EXTERNAL_ID",
  * });
  * ```
  *
- * @param {getOrderLogisticIncidentParameters} params - The parameters for the request.
- * @throws {Error} If `logisticOrderId` or `incidentId` is missing.
- * @returns {Promise<getOrderLogisticIncidentResponse>} A promise resolving to the response containing the incident.
+ * @param {getIncidentParameters} params - The parameters for identifying the incident.
+ * @throws {Error} If the required `incidentId` is missing.
+ * @returns {Promise<getIncidentResponse>} A promise that resolves to the incident details.
  */
-async function getOrderLogisticIncident({ logisticOrderId, incidentId, idType, }) {
-    (0, parameters_validation_1.required)({ logisticOrderId, incidentId });
+async function getIncident({ incidentId, idType, }) {
+    (0, parameters_validation_1.required)({ incidentId });
     const { data } = await (0, fetch_instance_1.enhancedFetch)({
         method: "GET",
-        path: `/v1/shop/logistic-orders/${logisticOrderId}/incidents/${incidentId}`,
+        path: `/v1/shop/incidents/${incidentId}`,
         params: {
             idType,
         },
     });
     return data;
 }
-/**
- * 🚚 Fetches incidents for a specific line of a logistic order.
- *
- * This function retrieves a list of incidents for a specific line in a logistic order,
- * filtered by status and other parameters. The `logisticOrderId` and `lineId` parameters
- * are mandatory and validated before the request is executed.
- *
- * 🛠 **Endpoint**: `GET /v1/shop/logistic-orders/{logisticOrderId}/incidents/lines/{lineId} [ORDER-559]`
- *
- * | Parameter         | Type                            | Required   | Description                              |
- * |-------------------|---------------------------------|------------|------------------------------------------|
- * | `logisticOrderId` | `string`                       | ✅         | The ID of the logistic order to fetch incidents for. |
- * | `lineId`          | `string`                       | ✅         | The ID of the line in the logistic order to fetch incidents for. |
- * | `status`          | `IncidentStatus[]`             | ❌         | Array of statuses to filter incidents (e.g., `["OPEN"]`). |
- * | `idType`          | `IncidentIdType`               | ❌         | Specifies whether the ID is internal (`DJUST_ID`) or external (`EXTERNAL_ID`). |
- * | `page`            | `number`                       | ❌         | The page number for pagination.          |
- * | `size`            | `number`                       | ❌         | The number of results per page.          |
- * | `sort`            | `String[]`                     | ❌         | Sorting criteria (e.g., `["createdAt,desc"]`). |
- *
- * 📤 **Returns**:
- * A `Promise` resolving to an array of `getOrderLogisticLineIncidentsResponse` objects representing the incidents.
- *
- * 🛠 **Example usage**:
- * ```ts
- * const incidents = await getOrderLogisticLineIncidents({
- *   logisticOrderId: "12345",
- *   lineId: "line_1",
- *   status: ["OPEN"],
- *   idType: "EXTERNAL_ID",
- *   page: 1,
- *   size: 10,
- *   sort: ["createdAt,desc"],
- * });
- * ```
- *
- * @param {getOrderLogisticLineIncidentsParameters} params - The parameters for the request.
- * @throws {Error} If `logisticOrderId` or `lineId` is missing.
- * @returns {Promise<getOrderLogisticLineIncidentsResponse>} A promise resolving to the response containing the incidents.
- */
-async function getOrderLogisticLineIncidents({ logisticOrderId, lineId, status, idType, page, size, sort, }) {
-    (0, parameters_validation_1.required)({ logisticOrderId, lineId });
-    const { data } = await (0, fetch_instance_1.enhancedFetch)({
-        method: "GET",
-        path: `/v1/shop/logistic-orders/${logisticOrderId}/incidents/lines/${lineId}`,
-        params: {
-            status,
-            idType,
-            page,
-            size,
-            sort,
-        },
-    });
-    return data;
-}
 /**
  * 🚚 Creates a new incident for a specific logistic order.
  *
@@ -259,53 +202,3 @@ async function createOrderLogisticLineIncident({ logisticOrderId, idType, custom
     });
     return data;
 }
-/**
- * 🧑‍💼 Fetches incidents for a specific customer account.
- *
- * This function retrieves incidents associated with a particular customer account,
- * using parameters such as `status`, `page`, `size`, and `sort` to filter and paginate the results.
- * The `customerAccountId` is a mandatory parameter and is validated before making the request.
- *
- * 🛠 **Endpoint**: `GET /v1/shop/customer-accounts/{customerAccountId}/incidents [ACCOUNT-551]`
- *
- * | Parameter         | Type                            | Required   | Description                              |
- * |-------------------|---------------------------------|------------|------------------------------------------|
- * | `customerAccountId`| `string`                       | ✅         | The ID of the customer account for which incidents are to be fetched. |
- * | `status`          | `IncidentStatus[]`             | ❌         | Array of statuses to filter incidents by (e.g., `["OPEN"]`). |
- * | `page`            | `number`                       | ❌         | The page number for pagination.          |
- * | `size`            | `number`                       | ❌         | The number of results per page.          |
- * | `sort`            | `string[]`                     | ❌         | Sorting criteria (e.g., `["createdAt,desc"]`). |
- *
- * 📤 **Returns**:
- * A `Promise` resolving to an array of `getCustomerAccountIncidentsResponse` objects,
- * representing the incidents for the given customer account.
- *
- * 🛠 **Example usage**:
- * ```ts
- * const incidents = await getCustomerAccountIncidents({
- *   customerAccountId: "98765",
- *   status: ["OPEN"],
- *   page: 1,
- *   size: 10,
- *   sort: ["createdAt,desc"],
- * });
- * ```
- *
- * @param {getCustomerAccountIncidentsParameters} params - The parameters for the request.
- * @throws {Error} If `customerAccountId` is missing.
- * @returns {Promise<getCustomerAccountIncidentsResponse>} A promise resolving to the incidents response.
- */
-async function getCustomerAccountIncidents({ customerAccountId, status, page, size, sort, }) {
-    (0, parameters_validation_1.required)({ customerAccountId });
-    const { data } = await (0, fetch_instance_1.enhancedFetch)({
-        method: "GET",
-        path: `/v1/shop/customer-accounts/${customerAccountId}/incidents`,
-        params: {
-            status,
-            page,
-            size,
-            sort,
-        },
-    });
-    return data;
-}

package/lib/services/navigation-category/index.d.ts

@@ -1,132 +1,81 @@
 import { GetNavigationCategoriesParameters, GetNavigationCategoriesResponse, GetNavigationCategoryBreadcrumbsParameters, GetNavigationCategoryBreadcrumbsResponse, GetNavigationCategoryParameters, GetNavigationCategoryResponse } from "./definitions";
 /**
- * ## Get all navigation categories
- * ### APICODE(NAVCAT-550)
- * @returns {Promise<GetNavigationCategoriesResponse>} - The response with the navigation categories
- *
- * @example
- * ### input
- * ```typescript
- * const response = await getNavigationCategories({ locale: 'string' });
+ * 📄 Gets all navigation categories.
+ *
+ * Retrieves a list of all navigation categories available for the shop.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/navigation-category/online`
+ *
+ * | Parameter             | Type                          | Required   | Description                                                   |
+ * |-----------------------|-------------------------------|------------|---------------------------------------------------------------|
+ * | `locale`              | `string`                       | ✅         | Locale of the navigation categories to fetch.                |
+ *
+ * 📤 **Returns**:
+ * A `Promise<GetNavigationCategoriesResponse>` containing a list of navigation categories.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const categories = await getNavigationCategories({
+ *   locale: 'en-US',
+ * });
+ *
+ * console.log(categories);
  * ```
- * ### output
- * Response - <strong style={{ color: 'green' }}>200</strong> - OK
- * ```json
- * [
- *   {
- *      "active": true,
- *      "childrenCategories": [
- *        string
- *      ],
- *      "customFieldValues": [
- *        {
- *          "customField": {
- *            "externalId": "string",
- *            "id": "string",
- *            "name": {
- *              "additionalProp1": "string",
- *              "additionalProp2": "string",
- *              "additionalProp3": "string"
- *            },
- *            "type": "LONG_TEXT"
- *          },
- *          "value": {}
- *        }
- *      ],
- *      "externalId": "string",
- *      "id": "string",
- *      "name": "string"
- *    }
- * ]
  */
 export declare function getNavigationCategories({ locale, }: GetNavigationCategoriesParameters): Promise<GetNavigationCategoriesResponse>;
 /**
- * ## Get navigation category
- * ### APICODE(NAVCAT-501)
- * @param {GetNavigationCategoryParameters} params - The parameters for the function
- * #### locale - `string` | <strong style={{ color: 'red' }}>required</strong>
- * #### idType - `string` | <strong style={{ color: 'red' }}>required</strong>
- * #### navigationCategoryId - `string` | <strong style={{ color: 'red' }}>required</strong>
- *
- * @returns {Promise<GetNavigationCategoryResponse>} - The response with the navigation category
- *
- * @example
- * ### input
- * ```typescript
- * const response = await getNavigationCategory({ locale: 'string', idType: 'string', navigationCategoryId: 'string' });
+ * 📄 Gets a specific navigation category.
+ *
+ * Retrieves a specific navigation category based on its ID.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/navigation-category/{navigationCategoryId}`
+ *
+ * | Parameter             | Type                          | Required   | Description                                                   |
+ * |-----------------------|-------------------------------|------------|---------------------------------------------------------------|
+ * | `locale`              | `string`                       | ✅         | Locale of the navigation category.                            |
+ * | `idType`              | `string`                       | ✅         | Type of the ID used to identify the category (e.g., `id`, `slug`). |
+ * | `navigationCategoryId`| `string`                       | ✅         | ID of the navigation category to fetch.                       |
+ *
+ * 📤 **Returns**:
+ * A `Promise<GetNavigationCategoryResponse>` containing the specific navigation category.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const category = await getNavigationCategory({
+ *   locale: 'en-US',
+ *   idType: 'id',
+ *   navigationCategoryId: '123',
+ * });
+ *
+ * console.log(category);
  * ```
- * ### output
- * Response - <strong style={{ color: 'green' }}>200</strong> - OK
- * ```json
- * {
- *   "active": true,
- *   "childrenCategories": [
- *     string
- *   ],
- *   "customFieldValues": [
- *     {
- *       "customField": {
- *         "externalId": "string",
- *         "id": "string",
- *         "name": {
- *           "additionalProp1": "string",
- *           "additionalProp2": "string",
- *           "additionalProp3": "string"
- *         },
- *         "type": "LONG_TEXT"
- *       },
- *       "value": {}
- *     }
- *   ],
- *   "externalId": "string",
- *   "id": "string",
- *   "name": "string",
- * }
  */
 export declare function getNavigationCategory({ locale, idType, navigationCategoryId, }: GetNavigationCategoryParameters): Promise<GetNavigationCategoryResponse>;
 /**
- * ## Get navigation category breadcrumbs
- * ### APICODE(NAVCAT-502)
- * @param {GetNavigationCategoryBreadcrumbsParameters} params - The parameters for the function
- * #### locale - `string` | <strong style={{ color: 'red' }}>required</strong>
- * #### idType - `string` | <strong style={{ color: 'red' }}>required</strong>
- * #### navigationCategoryId - `string` | <strong style={{ color: 'red' }}>required</strong>
- *
- * @returns {Promise<GetNavigationCategoryBreadcrumbsResponse>} - The response with the navigation category breadcrumbs
- *
- * @example
- * ### input
- * ```typescript
- * const response = await getNavigationCategoryBreadcrumbs({ locale: 'string', idType: 'string', navigationCategoryId: 'string' });
+ * 📄 Gets breadcrumbs for a specific navigation category.
+ *
+ * Retrieves the breadcrumb trail for a specific navigation category, showing its hierarchy.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/navigation-category/{navigationCategoryId}/breadcrumb`
+ *
+ * | Parameter             | Type                          | Required   | Description                                                   |
+ * |-----------------------|-------------------------------|------------|---------------------------------------------------------------|
+ * | `locale`              | `string`                       | ✅         | Locale of the navigation category breadcrumbs.               |
+ * | `idType`              | `string`                       | ✅         | Type of the ID used to identify the category (e.g., `id`, `slug`). |
+ * | `navigationCategoryId`| `string`                       | ✅         | ID of the navigation category to fetch breadcrumbs for.      |
+ *
+ * 📤 **Returns**:
+ * A `Promise<GetNavigationCategoryBreadcrumbsResponse>` containing the breadcrumb trail for the navigation category.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const breadcrumbs = await getNavigationCategoryBreadcrumbs({
+ *   locale: 'en-US',
+ *   idType: 'id',
+ *   navigationCategoryId: '123',
+ * });
+ *
+ * console.log(breadcrumbs);
  * ```
- * ### output
- * Response - <strong style={{ color: 'green' }}>200</strong> - OK
- * ```json
- * [
- *   {
- *     "active": true,
- *     "childrenCategories": [
- *       string
- *     ],
- *     "customFieldValues": [
- *       {
- *         "customField": {
- *           "externalId": "string",
- *           "id": "string",
- *           "name": {
- *             "additionalProp1": "string",
- *             "additionalProp2": "string",
- *             "additionalProp3": "string"
- *           },
- *           "type": "LONG_TEXT"
- *         },
- *         "value": {}
- *       }
- *     ],
- *     "externalId": "string",
- *     "id": "string",
- *     "name": "string",
- *     "parent": "string"
- *   }
  */
 export declare function getNavigationCategoryBreadcrumbs({ locale, idType, navigationCategoryId, }: GetNavigationCategoryBreadcrumbsParameters): Promise<GetNavigationCategoryBreadcrumbsResponse>;