@djust-b2b/djust-front-sdk 1.17.2 → 1.18.0

package/lib/index.d.ts

@@ -25,6 +25,7 @@ export declare const DjustSDK: {
     getIncident({ incidentId, idType, }: import("./services/incident/definitions").getIncidentParameters): Promise<import("./services/incident/definitions").getIncidentResponse>;
     createOrderLogisticIncident({ logisticOrderId, idType, customField, reasonCode, }: import("./services/incident/definitions").createOrderLogisticIncidentParameters): Promise<import("./services/incident/definitions").createOrderLogisticIncidentResponse>;
     createOrderLogisticLineIncident({ logisticOrderId, idType, customFieldIdType, orderLines, reasonCode, }: import("./services/incident/definitions").createOrderLogisticLineIncidentParameters): Promise<import("./services/incident/definitions").createOrderLogisticLineIncidentResponse>;
+    createOrderLogisticIncidentThread({ logisticOrderId, incidentId, idType, customField, message, name, reasonCode, }: import("./services/incident/definitions").createOrderLogisticIncidentThreadParameters): Promise<import("./services/incident/definitions").createOrderLogisticIncidentThreadResponse>;
     getCommercialOrders({ locale, nbPreviewLines, }: import("./interfaces").GetCommercialOrdersParameters): Promise<import("./interfaces").GetCommercialOrdersResponse>;
     createCommercialOrder({ nbPreviewLines, channel, customFields, locale, origin, originId, paymentInfo, }: import("./interfaces").CreateCommercialOrderParameters): Promise<import("./interfaces").CreateCommercialOrderResponse>;
     getCommercialOrder({ orderId, idType, locale, nbPreviewLines, }: import("./interfaces").GetCommercialOrderParameters): Promise<import("./interfaces").GetCommercialOrderResponse>;

package/lib/interfaces/models/incident.d.ts

@@ -28,3 +28,9 @@ export interface IncidentCreatedDto {
     externalId: string;
     incidentId: string;
 }
+export interface IncidentThreadDto {
+    messageExternalId: string;
+    messageId: string;
+    threadExternalId: string;
+    threadId: string;
+}

package/lib/services/commercial-order/index.js

@@ -101,6 +101,7 @@ async function createCommercialOrder({ nbPreviewLines, channel, customFields, lo
             channel,
             customFields,
             locale,
+            origin,
             originId,
             paymentInfo,
         }),

package/lib/services/incident/definitions.d.ts

@@ -1,4 +1,4 @@
-import { IncidentDto, IncidentStatus, IncidentIdType, IncidentLogisticOrder, IncidentCreatedDto } from "../../interfaces/models/incident";
+import { IncidentDto, IncidentStatus, IncidentIdType, IncidentLogisticOrder, IncidentCreatedDto, IncidentThreadDto } from "../../interfaces/models/incident";
 import { CustomFieldValueRequest } from "../../interfaces/models/custom-field";
 /**
  * Request parameters type definitions
@@ -37,6 +37,18 @@ export interface createOrderLogisticLineIncidentParameters {
     }[];
     reasonCode: string[];
 }
+export interface createOrderLogisticIncidentThreadParameters {
+    logisticOrderId: string;
+    incidentId: string;
+    idType: IncidentIdType;
+    customField: {
+        customFieldValues: CustomFieldValueRequest[];
+        idType: IncidentIdType;
+    };
+    name: string;
+    message: string;
+    reasonCode: string[];
+}
 /**
  * Request response type definitions
  */
@@ -48,3 +60,5 @@ export interface createOrderLogisticIncidentResponse extends IncidentCreatedDto
 }
 export interface createOrderLogisticLineIncidentResponse extends IncidentCreatedDto {
 }
+export interface createOrderLogisticIncidentThreadResponse extends IncidentThreadDto {
+}

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

@@ -1,4 +1,4 @@
-import { getIncidentsParameters, getIncidentParameters, createOrderLogisticIncidentParameters, createOrderLogisticLineIncidentParameters, getIncidentsResponse, getIncidentResponse, createOrderLogisticIncidentResponse, createOrderLogisticLineIncidentResponse } from "./definitions";
+import { getIncidentsParameters, getIncidentParameters, createOrderLogisticIncidentParameters, createOrderLogisticLineIncidentParameters, getIncidentsResponse, getIncidentResponse, createOrderLogisticIncidentResponse, createOrderLogisticLineIncidentResponse, createOrderLogisticIncidentThreadParameters, createOrderLogisticIncidentThreadResponse } from "./definitions";
 /**
  * 🚚 Retrieves a list of incidents based on various filter criteria.
  *
@@ -139,3 +139,46 @@ export declare function createOrderLogisticIncident({ logisticOrderId, idType, c
  * @returns {Promise<createOrderLogisticLineIncidentResponse>} A promise resolving to the response containing the created incident's details.
  */
 export declare function createOrderLogisticLineIncident({ logisticOrderId, idType, customFieldIdType, orderLines, reasonCode, }: createOrderLogisticLineIncidentParameters): Promise<createOrderLogisticLineIncidentResponse>;
+/**
+ * 🚚 Creates a new incident thread for a specific logistic order on specific lines.
+ *
+ * This function allows the creation of a thread related to an incident for one or more lines within a logistic order.
+ * The `logisticOrderId`, `incidentId`, `customField`, `reasonCode` and `message` are required parameters.
+ * The `idType` is used for specifying additional information about the thread.
+ *
+ * 🛠 **Endpoint**: `POST /v2/shop/logistic-orders/${logisticOrderId}/incidents/${incidentId}/threads [ORDER-106]`
+ *
+ * | Parameter          | Type                                | Required   | Description                                              |
+ * |--------------------|-------------------------------------|------------|----------------------------------------------------------|
+ * | `logisticOrderId`  | `string`                            | ✅         | The ID of the logistic order on which the incident happened. |
+ * | `incidentId`       | `string`                            | ✅         | The ID of the incident for which thread is created. |
+ * | `idType`           | `IncidentIdType`                    | ❌         | The type of incident ID (e.g., `DJUST_ID`, `EXTERNAL_ID`). |
+ * | `name`             | `string`                            | ❌         | The name of the created thread. |
+ * | `message`          | `string`                            | ✅         | The message of the created thread. |
+ * | `customField`      | `{ customFieldValues: CustomFieldValueRequest[], idType: string}[]` | ✅         | An array of objects describing the custom field values to add to the thread. |
+ * | `reasonCode`       | `string[]`                          | ✅         | The reason codes for the incident related to the thread (e.g., `["PRODUCT_DEFECT"]`). |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `createOrderLogisticLineIncidentResponse` object,
+ * containing the `threadId` and `threadExternalId`, and the `messageId` and `messageExternalId` of the created thread.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const incident = await createOrderLogisticLineIncident({
+ *   logisticOrderId: "12345",
+ *   incidentId: "6789",
+ *   idType: "EXTERNAL_ID",
+ *   customField: [
+ *     { customFieldValues: [], idType: "DJUST_ID" }
+ *   ],
+ *   reasonCode: ["PRODUCT_DEFECT"],
+ *   name: "thread1",
+ *   message: "Message related to thread1"
+ * });
+ * ```
+ *
+ * @param {createOrderLogisticLineIncidentParameters} params - The parameters for creating the thread.
+ * @throws {Error} If `logisticOrderId`, `incidentId`, `customField`, `reasonCode` or `message` is missing.
+ * @returns {Promise<createOrderLogisticLineIncidentResponse>} A promise resolving to the response containing the created thread's details.
+ */
+export declare function createOrderLogisticIncidentThread({ logisticOrderId, incidentId, idType, customField, message, name, reasonCode, }: createOrderLogisticIncidentThreadParameters): Promise<createOrderLogisticIncidentThreadResponse>;

package/lib/services/incident/index.js

@@ -4,6 +4,7 @@ exports.getIncidents = getIncidents;
 exports.getIncident = getIncident;
 exports.createOrderLogisticIncident = createOrderLogisticIncident;
 exports.createOrderLogisticLineIncident = createOrderLogisticLineIncident;
+exports.createOrderLogisticIncidentThread = createOrderLogisticIncidentThread;
 const parameters_validation_1 = require("../../helpers/parameters-validation");
 const fetch_instance_1 = require("../../settings/fetch-instance");
 /**
@@ -202,3 +203,62 @@ async function createOrderLogisticLineIncident({ logisticOrderId, idType, custom
     });
     return data;
 }
+/**
+ * 🚚 Creates a new incident thread for a specific logistic order on specific lines.
+ *
+ * This function allows the creation of a thread related to an incident for one or more lines within a logistic order.
+ * The `logisticOrderId`, `incidentId`, `customField`, `reasonCode` and `message` are required parameters.
+ * The `idType` is used for specifying additional information about the thread.
+ *
+ * 🛠 **Endpoint**: `POST /v2/shop/logistic-orders/${logisticOrderId}/incidents/${incidentId}/threads [ORDER-106]`
+ *
+ * | Parameter          | Type                                | Required   | Description                                              |
+ * |--------------------|-------------------------------------|------------|----------------------------------------------------------|
+ * | `logisticOrderId`  | `string`                            | ✅         | The ID of the logistic order on which the incident happened. |
+ * | `incidentId`       | `string`                            | ✅         | The ID of the incident for which thread is created. |
+ * | `idType`           | `IncidentIdType`                    | ❌         | The type of incident ID (e.g., `DJUST_ID`, `EXTERNAL_ID`). |
+ * | `name`             | `string`                            | ❌         | The name of the created thread. |
+ * | `message`          | `string`                            | ✅         | The message of the created thread. |
+ * | `customField`      | `{ customFieldValues: CustomFieldValueRequest[], idType: string}[]` | ✅         | An array of objects describing the custom field values to add to the thread. |
+ * | `reasonCode`       | `string[]`                          | ✅         | The reason codes for the incident related to the thread (e.g., `["PRODUCT_DEFECT"]`). |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `createOrderLogisticLineIncidentResponse` object,
+ * containing the `threadId` and `threadExternalId`, and the `messageId` and `messageExternalId` of the created thread.
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const incident = await createOrderLogisticLineIncident({
+ *   logisticOrderId: "12345",
+ *   incidentId: "6789",
+ *   idType: "EXTERNAL_ID",
+ *   customField: [
+ *     { customFieldValues: [], idType: "DJUST_ID" }
+ *   ],
+ *   reasonCode: ["PRODUCT_DEFECT"],
+ *   name: "thread1",
+ *   message: "Message related to thread1"
+ * });
+ * ```
+ *
+ * @param {createOrderLogisticLineIncidentParameters} params - The parameters for creating the thread.
+ * @throws {Error} If `logisticOrderId`, `incidentId`, `customField`, `reasonCode` or `message` is missing.
+ * @returns {Promise<createOrderLogisticLineIncidentResponse>} A promise resolving to the response containing the created thread's details.
+ */
+async function createOrderLogisticIncidentThread({ logisticOrderId, incidentId, idType, customField, message, name, reasonCode, }) {
+    (0, parameters_validation_1.required)({ logisticOrderId, incidentId, reasonCode, message, name });
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+        method: "POST",
+        path: `/v2/shop/logistic-orders/${logisticOrderId}/incidents/${incidentId}/threads`,
+        params: {
+            idType,
+        },
+        body: JSON.stringify({
+            customField,
+            message,
+            name,
+            reasonCode,
+        }),
+    });
+    return data;
+}

package/package.json

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