@djust-b2b/djust-front-sdk 2.13.0 → 2.14.0

package/lib/index.d.ts

@@ -20,6 +20,7 @@ export declare const DjustSDK: {
     getPaymentDetails({ details, }: import("./services/payment/definitions").GetPaymentDetailsRequest): Promise<import("./services/payment/definitions").GetPaymentDetailsResponse>;
     getPaymentMethods({ reference, countryCode, referenceType, locale, }: import("./services/payment/definitions").GetPaymentMethodsRequest): Promise<import("./services/payment/definitions").GetPaymentMethodsResponse>;
     deleteStoredPaymentMethodById({ storedPaymentMethodId, }: import("./services/payment/definitions").DeleteStoredPaymentMethodByIdRequest): Promise<void>;
+    precheckPurchaseCardL3({ reference, referenceType, }: import("./services/payment/definitions").PrecheckPurchaseCardL3Request): Promise<import("./services/payment/definitions").PrecheckPurchaseCardL3Response>;
     getCustomFields(params: import("./services/custom-field/definitions").GetCustomFieldParameters): Promise<import("./services/custom-field/definitions").GetCustomFieldResponse>;
     postMediaCustomField(params: import("./services/custom-field/definitions").PostMediaCustomFieldParameters): Promise<string>;
     getMediaUrl(params: import("./services/custom-field/definitions").GetMediaUrlParameters): Promise<string>;

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

@@ -63,3 +63,16 @@ export interface GetPaymentMethodsResponse {
 export interface DeleteStoredPaymentMethodByIdRequest {
     storedPaymentMethodId: string;
 }
+export interface PrecheckPurchaseCardL3Request {
+    reference: string;
+    referenceType?: PaymentReferenceType;
+}
+export interface PrecheckPurchaseCardL3Response {
+    ready: boolean;
+    missingFields?: {
+        scope: string;
+        field: string;
+        path: string;
+        source: string;
+    }[];
+}

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

@@ -1,4 +1,4 @@
-import { GetPaymentDetailsRequest, GetPaymentDetailsResponse, DeleteStoredPaymentMethodByIdRequest, GetPaymentMethodsRequest, GetPaymentMethodsResponse, InitPaymentRequest, InitPaymentResponse } from "./definitions";
+import { GetPaymentDetailsRequest, GetPaymentDetailsResponse, DeleteStoredPaymentMethodByIdRequest, GetPaymentMethodsRequest, GetPaymentMethodsResponse, InitPaymentRequest, InitPaymentResponse, PrecheckPurchaseCardL3Request, PrecheckPurchaseCardL3Response } from "./definitions";
 /**
  * 💳 Initializes a payment transaction.
  *
@@ -126,3 +126,24 @@ export declare function getPaymentMethods({ reference, countryCode, referenceTyp
  * @returns {Promise<void>} A promise resolving when the stored payment method is successfully deleted
  */
 export declare function deleteStoredPaymentMethodById({ storedPaymentMethodId, }: DeleteStoredPaymentMethodByIdRequest): Promise<void>;
+/**
+ * 💳 Prechecks a purchase card L3.
+ *
+ * This endpoint prechecks a purchase card L3.
+ * The `reference` parameter is mandatory and validated before the request is executed.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/payments/precheck` [PAY-502]
+ *
+ * | Parameter      | Type     | Required | Description                                    |
+ * |----------------|----------|----------|------------------------------------------------|
+ * | `reference`    | `string` | ✅       | The payment reference identifier.             |
+ * | `referenceType`| `string` | ❌       | The type of reference.                        |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `PrecheckPurchaseCardL3Response` containing the result of the precheck.
+ *
+ * @param {PrecheckPurchaseCardL3Request} params - The parameters for the precheck
+ * @throws {Error} If `reference` is missing
+ * @returns {Promise<PrecheckPurchaseCardL3Response>} A promise resolving to the response containing the result of the precheck
+ */
+export declare function precheckPurchaseCardL3({ reference, referenceType, }: PrecheckPurchaseCardL3Request): Promise<PrecheckPurchaseCardL3Response>;

package/lib/services/payment/index.js

@@ -4,6 +4,7 @@ exports.initPayment = initPayment;
 exports.getPaymentDetails = getPaymentDetails;
 exports.getPaymentMethods = getPaymentMethods;
 exports.deleteStoredPaymentMethodById = deleteStoredPaymentMethodById;
+exports.precheckPurchaseCardL3 = precheckPurchaseCardL3;
 const parameters_validation_1 = require("../../helpers/parameters-validation");
 const fetch_instance_1 = require("../../settings/fetch-instance");
 /**
@@ -184,3 +185,35 @@ async function deleteStoredPaymentMethodById({ storedPaymentMethodId, }) {
         path: `/v1/shop/payments/stored-payment-methods/${storedPaymentMethodId}`,
     });
 }
+/**
+ * 💳 Prechecks a purchase card L3.
+ *
+ * This endpoint prechecks a purchase card L3.
+ * The `reference` parameter is mandatory and validated before the request is executed.
+ *
+ * 🛠 **Endpoint**: `GET /v1/shop/payments/precheck` [PAY-502]
+ *
+ * | Parameter      | Type     | Required | Description                                    |
+ * |----------------|----------|----------|------------------------------------------------|
+ * | `reference`    | `string` | ✅       | The payment reference identifier.             |
+ * | `referenceType`| `string` | ❌       | The type of reference.                        |
+ *
+ * 📤 **Returns**:
+ * A `Promise` resolving to a `PrecheckPurchaseCardL3Response` containing the result of the precheck.
+ *
+ * @param {PrecheckPurchaseCardL3Request} params - The parameters for the precheck
+ * @throws {Error} If `reference` is missing
+ * @returns {Promise<PrecheckPurchaseCardL3Response>} A promise resolving to the response containing the result of the precheck
+ */
+async function precheckPurchaseCardL3({ reference, referenceType, }) {
+    (0, parameters_validation_1.required)({ reference });
+    const { data } = await (0, fetch_instance_1.enhancedFetch)({
+        method: "GET",
+        path: `/v1/shop/payments/precheck`,
+        params: {
+            reference,
+            referenceType,
+        },
+    });
+    return data;
+}

package/package.json

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