@djust-b2b/djust-front-sdk 1.26.2 → 1.27.1

package/lib/index.d.ts

@@ -23,6 +23,7 @@ export declare const DjustSDK: {
     deleteCommercialOrder(commercialOrderId: string): Promise<void>;
     updateCommercialOrderLines({ commercialOrderId, customFieldIdType, lineIdType, lineType, updateOrderCommercialLines, updateOrderLineIdType, updateOrderLineType, }: import("./interfaces").UpdateCommercialOrderLinesParameters): Promise<import("./interfaces").UpdateCommercialOrderLinesResponse>;
     deleteCommercialOrderLines({ commercialOrderId, body, }: import("./interfaces").DeleteCommercialOrderLinesParameters): Promise<import("./interfaces").DeleteCommercialOrderLinesResponse>;
+    punchoutOciCommercialOrder({ tenantConfigurationKey, commercialOrderId, locale, }: import("./interfaces").PunchoutOciCommercialOrderParameters): Promise<any>;
     getLogisticOrders({ approvalIds, locale, logisticStatus, incident, paymentOptions, nbPreviewLines, page, size, sort, }: import("./interfaces").GetLogisticOrdersParameters): Promise<import("./interfaces").GetLogisticOrdersResponse>;
     logisticOrdersPaginatedList({ page, size, sort, nbPreviewLines, accountCustomFieldValueCriteria, approvalIds, connectedUserOnly, creationDateFrom, creationDateTo, customerAccountIds, incident, locale, logisticStatus, offerCustomFieldValueCriteria, orderLogisticCustomFieldValueCriteria, paymentOptions, supplierIds, updateDateFrom, updateDateTo, }: import("./interfaces").GetPaginatedLogisticOrdersParameters): Promise<import("./interfaces").GetPaginatedLogisticOrdersResponse>;
     getLogisticOrderCustomFields({ customFieldIds, page, size, sort, }: import("./interfaces").GetLogisticOrderCustomFieldsParameters): Promise<import("./interfaces").GetLogisticOrderCustomFieldsResponse>;

package/lib/services/commercial-order/definitions.d.ts

@@ -82,6 +82,11 @@ export interface UpdateOrderLogisticCustomFieldParameters {
     orderLogisticId: string;
     customFieldsValues: CustomFieldValueRequest[];
 }
+export interface PunchoutOciCommercialOrderParameters {
+    tenantConfigurationKey: string;
+    commercialOrderId: string;
+    locale: string;
+}
 /**
  * Response type definitions
  */

package/lib/services/commercial-order/index.d.ts

@@ -1,4 +1,4 @@
-import { CreateCommercialOrderCardRegistrationParameters, CreateCommercialOrderCardRegistrationResponse, CreateCommercialOrderParameters, CreateCommercialOrderResponse, CreateCommercialOrderV2Parameters, CreateCommercialOrderV2Response, UpdateCommercialOrderParameters, DeleteCommercialOrderLinesParameters, DeleteCommercialOrderLinesResponse, UpdateCommercialOrderLinesParameters, UpdateCommercialOrderLinesResponse, CreateCommercialOrderPreauthorizationParameters, CreateCommercialOrderPreauthorizationResponse, GetCommercialOrderParameters, GetCommercialOrderPaymentPageUrlParameters, GetCommercialOrderResponse, GetCommercialOrdersParameters, GetCommercialOrdersResponse, SetCommercialOrderStatusAsCreatedParameters, SetCommercialOrderStatusAsOnHoldParameters, UpdateCommercialOrderBillingInformationParameters, UpdateCommercialOrderShippingAddressParameters, UpdateCommercialOrderShippingInformationParameters, UpdateCommercialOrderShippingTypeParameters } from "./definitions";
+import { CreateCommercialOrderCardRegistrationParameters, CreateCommercialOrderCardRegistrationResponse, CreateCommercialOrderParameters, CreateCommercialOrderResponse, CreateCommercialOrderV2Parameters, CreateCommercialOrderV2Response, UpdateCommercialOrderParameters, DeleteCommercialOrderLinesParameters, DeleteCommercialOrderLinesResponse, UpdateCommercialOrderLinesParameters, UpdateCommercialOrderLinesResponse, CreateCommercialOrderPreauthorizationParameters, CreateCommercialOrderPreauthorizationResponse, GetCommercialOrderParameters, GetCommercialOrderPaymentPageUrlParameters, GetCommercialOrderResponse, GetCommercialOrdersParameters, GetCommercialOrdersResponse, SetCommercialOrderStatusAsCreatedParameters, SetCommercialOrderStatusAsOnHoldParameters, UpdateCommercialOrderBillingInformationParameters, UpdateCommercialOrderShippingAddressParameters, UpdateCommercialOrderShippingInformationParameters, UpdateCommercialOrderShippingTypeParameters, PunchoutOciCommercialOrderParameters } from "./definitions";
 /**
  * COMMERCIAL ORDER ENDPOINT
  */
@@ -555,3 +555,35 @@ export declare function updateCommercialOrderLines({ commercialOrderId, customFi
  * @returns {Promise<DeleteCommercialOrderLinesResponse>} A promise resolving when the commercial order lines are successfully deleted.
  */
 export declare function deleteCommercialOrderLines({ commercialOrderId, body, }: DeleteCommercialOrderLinesParameters): Promise<DeleteCommercialOrderLinesResponse>;
+/**
+ * 🚚 Punchout for specific commercial order.
+ *
+ * This function retrieves commercial order's data needed for the punchout, with order identified by the `commercialOrderId`.
+ * This `commercialOrderId` parameter is required and validated before the request is executed.
+ *
+ * 🛠 **Endpoint**: `GET /punchout/oci/${tenantConfigurationKey}/commercial-orders/${commercialOrderId}` [ORDER-150]
+ *
+ * | Parameter                          | Type                                 | Required        | Description                                                    |
+ * |------------------------------------|--------------------------------------|-----------------|----------------------------------------------------------------|
+ * | `tenantConfigurationKey`           | `string`                             | ✅              | The combination of tenant id and tenant OCI                          |
+ * | `commercialOrderId`                | `string`                             | ✅              | The ID of the commercial order whose lines are to be deleted   |
+ * | `locale`                           | `string`                             | ✅              | The locale in which to return the commercial order.            |
+
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving when the punchout data are successfully retrieved
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const response = await punchoutOciCommercialOrder({
+ *    tenantConfigurationKey: "0000000300-0000000001",
+ *    commercialOrderId: "commercialOrder123",
+ *    locale: "EN",
+ * });
+ * ```
+ *
+ * @param {PunchoutOciCommercialOrderParameters} params - The parameters for the request.
+ * @throws {Error} If `commercialOrderId` or `tenantConfigurationKey` is missing.
+ * @returns {Promise<Map(<string,string>)>} A promise resolving when the punchout data are successfully retrieved.
+ */
+export declare function punchoutOciCommercialOrder({ tenantConfigurationKey, commercialOrderId, locale, }: PunchoutOciCommercialOrderParameters): Promise<any>;

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

@@ -17,6 +17,7 @@ exports.updateCommercialOrderShippingType = updateCommercialOrderShippingType;
 exports.deleteCommercialOrder = deleteCommercialOrder;
 exports.updateCommercialOrderLines = updateCommercialOrderLines;
 exports.deleteCommercialOrderLines = deleteCommercialOrderLines;
+exports.punchoutOciCommercialOrder = punchoutOciCommercialOrder;
 const parameters_validation_1 = require("../../helpers/parameters-validation");
 const fetch_instance_1 = require("../../settings/fetch-instance");
 /**
@@ -752,3 +753,45 @@ async function deleteCommercialOrderLines({ commercialOrderId, body, }) {
     });
     return data;
 }
+/**
+ * 🚚 Punchout for specific commercial order.
+ *
+ * This function retrieves commercial order's data needed for the punchout, with order identified by the `commercialOrderId`.
+ * This `commercialOrderId` parameter is required and validated before the request is executed.
+ *
+ * 🛠 **Endpoint**: `GET /punchout/oci/${tenantConfigurationKey}/commercial-orders/${commercialOrderId}` [ORDER-150]
+ *
+ * | Parameter                          | Type                                 | Required        | Description                                                    |
+ * |------------------------------------|--------------------------------------|-----------------|----------------------------------------------------------------|
+ * | `tenantConfigurationKey`           | `string`                             | ✅              | The combination of tenant id and tenant OCI                          |
+ * | `commercialOrderId`                | `string`                             | ✅              | The ID of the commercial order whose lines are to be deleted   |
+ * | `locale`                           | `string`                             | ✅              | The locale in which to return the commercial order.            |
+
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving when the punchout data are successfully retrieved
+ *
+ * 🛠 **Example usage**:
+ * ```ts
+ * const response = await punchoutOciCommercialOrder({
+ *    tenantConfigurationKey: "0000000300-0000000001",
+ *    commercialOrderId: "commercialOrder123",
+ *    locale: "EN",
+ * });
+ * ```
+ *
+ * @param {PunchoutOciCommercialOrderParameters} params - The parameters for the request.
+ * @throws {Error} If `commercialOrderId` or `tenantConfigurationKey` is missing.
+ * @returns {Promise<Map(<string,string>)>} A promise resolving when the punchout data are successfully retrieved.
+ */
+async function punchoutOciCommercialOrder({ tenantConfigurationKey, commercialOrderId, locale, }) {
+    (0, parameters_validation_1.required)({ commercialOrderId, tenantConfigurationKey });
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+        method: "GET",
+        path: `/cxml/punchout/oci/${tenantConfigurationKey}/commercial-orders/${commercialOrderId}`,
+        params: {
+            locale,
+        },
+    });
+    return data;
+}

package/package.json

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