@djust-b2b/djust-front-sdk 2.5.0 → 2.5.1

package/lib/index.d.ts

@@ -1,6 +1,10 @@
 export declare const DjustSDK: {
     initialize: (initConfig: import("./settings/fetch-instance").ClientConfig) => void;
     updateConfiguration: (newConfig: Partial<import("./settings/fetch-instance").ClientConfig>) => void;
+    initPayment({ browserInfo, countryCode, customerUserIP, paymentMethodData, reference, referenceType, returnPath, storePaymentMethod, }: import("./services/payment/definitions").InitPaymentRequest): Promise<import("./services/payment/definitions").InitPaymentResponse>;
+    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>;
     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/index.js

@@ -50,6 +50,7 @@ const LogisticOrderServices = __importStar(require("./services/logistic-order"))
 const IncidentServices = __importStar(require("./services/incident"));
 const OfferServices = __importStar(require("./services/offer-inventories"));
 const CustomFieldServices = __importStar(require("./services/custom-field"));
+const PaymentServices = __importStar(require("./services/payment"));
 const fetch_instance_1 = require("./settings/fetch-instance");
 exports.DjustSDK = {
     ...AuthServices,
@@ -65,6 +66,7 @@ exports.DjustSDK = {
     ...IncidentServices,
     ...OfferServices,
     ...CustomFieldServices,
+    ...PaymentServices,
     initialize: fetch_instance_1.initialize,
     updateConfiguration: fetch_instance_1.updateConfiguration,
 };

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

@@ -3,6 +3,7 @@ import { PaymentReferenceType } from "../../interfaces/models/payment";
 /**
  * Request parameters type definitions
  */
+export type ResultCode = "AuthenticationFinished" | "AuthenticationNotRequired" | "Authorised" | "Cancelled" | "ChallengeShopper" | "Error" | "IdentifyShopper" | "PartiallyAuthorised" | "Pending" | "PresentToShopper" | "Received" | "RedirectShopper" | "Refused";
 export interface GetCommercialOrdersParameters {
     locale: string;
     nbPreviewLines?: number;
@@ -14,35 +15,38 @@ export interface GetCommercialOrdersParameters {
     isValidated?: boolean;
 }
 export interface InitPaymentRequest {
-    bankTransfer?: boolean;
     browserInfo: BrowserInfo;
-    commercialOrder?: boolean;
     countryCode: string;
-    customerUserIP: string;
-    paymentMethodData: object;
+    customerUserIP?: string;
+    paymentMethodData?: Record<string, unknown>;
     reference: string;
-    referenceType?: PaymentReferenceType;
+    referenceType?: string;
     returnPath: string;
     storePaymentMethod?: boolean;
 }
 export interface InitPaymentResponse {
     action: {
-        type: string;
+        type: "bankTransfer" | "redirect" | "threeDS2" | "await" | "qrCode" | "voucher" | "sdk";
         beneficiary: string;
         bic: string;
         iban: string;
         paymentMethodType: string;
+        paymentData: string;
         totalAmountCurrency: string;
         totalAmountValue: number;
         url: string;
+        method: string;
+        authorisationToken: string;
+        subtype: string;
+        token: string;
     };
     pspReference: string;
-    resultCode: string;
+    resultCode: ResultCode;
 }
-export interface AddPaymentDetailsRequest {
+export interface GetPaymentDetailsRequest {
     details: string;
 }
-export interface AddPaymentDetailsResponse {
+export interface GetPaymentDetailsResponse {
     pspReference: string;
     resultCode: string;
 }

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

@@ -1,4 +1,4 @@
-import { AddPaymentDetailsRequest, AddPaymentDetailsResponse, DeleteStoredPaymentMethodByIdRequest, GetPaymentMethodsRequest, GetPaymentMethodsResponse, InitPaymentRequest, InitPaymentResponse } from "./definitions";
+import { GetPaymentDetailsRequest, GetPaymentDetailsResponse, DeleteStoredPaymentMethodByIdRequest, GetPaymentMethodsRequest, GetPaymentMethodsResponse, InitPaymentRequest, InitPaymentResponse } from "./definitions";
 /**
  * 💳 Initializes a payment transaction.
  *
@@ -15,12 +15,10 @@ import { AddPaymentDetailsRequest, AddPaymentDetailsResponse, DeleteStoredPaymen
  *
  * | Parameter           | Type                | Required | Description                                    |
  * |---------------------|---------------------|----------|------------------------------------------------|
- * | `bankTransfer`      | `BankTransfer`      | ✅       | Bank transfer configuration.                  |
  * | `browserInfo`       | `BrowserInfo`       | ✅       | Browser information for 3DS authentication.   |
- * | `commercialOrder`   | `CommercialOrder`   | ❌       | Commercial order details.                     |
  * | `countryCode`       | `string`            | ✅       | Country code for payment processing.          |
- * | `customerUserIP`    | `string`            | ✅       | Customer's IP address.                        |
- * | `paymentMethodData` | `PaymentMethodData` | ✅       | Payment method configuration.                 |
+ * | `customerUserIP`    | `string`            | ❌       | Customer's IP address.                        |
+ * | `paymentMethodData` | `PaymentMethodData` | ❌       | Payment method configuration.                 |
  * | `reference`         | `string`            | ✅       | Payment reference identifier.                 |
  * | `referenceType`     | `string`            | ❌       | Type of reference.                            |
  * | `returnPath`        | `string`            | ✅       | Return URL after payment completion.          |
@@ -32,7 +30,6 @@ import { AddPaymentDetailsRequest, AddPaymentDetailsResponse, DeleteStoredPaymen
  *  🛠 **Example usage**:
  * ```ts
  * const response = await initPayment({
- *   bankTransfer: false,
  *   browserInfo: {
  *     acceptHeader: "......",
  *     colorDepth: 24,
@@ -44,7 +41,6 @@ import { AddPaymentDetailsRequest, AddPaymentDetailsResponse, DeleteStoredPaymen
  *     timeZoneOffset: 0,
  *     userAgent: "......",
  *   },
- *   commercialOrder: false,
  *   countryCode: "FR",
  *   customerUserIP: "127.0.0.1",
  *   paymentMethodData: {
@@ -63,11 +59,11 @@ import { AddPaymentDetailsRequest, AddPaymentDetailsResponse, DeleteStoredPaymen
  * @throws {Error} If required parameters are missing
  * @returns {Promise<InitPaymentResponse>} A promise resolving to the payment initialization response
  */
-export declare function initPayment({ bankTransfer, browserInfo, commercialOrder, countryCode, customerUserIP, paymentMethodData, reference, referenceType, returnPath, storePaymentMethod, }: InitPaymentRequest): Promise<InitPaymentResponse>;
+export declare function initPayment({ browserInfo, countryCode, customerUserIP, paymentMethodData, reference, referenceType, returnPath, storePaymentMethod, }: InitPaymentRequest): Promise<InitPaymentResponse>;
 /**
- * 💳 Adds payment details.
+ * 💳 Gets payment details.
  *
- * This function adds additional details to an existing payment transaction.
+ * This function gets additional details to an existing payment transaction.
  * The `details` parameter is mandatory and validated before the request is executed.
  *
  * 🛠 **Endpoint**: `POST /v1/shop/payments/details` [PAY-102]
@@ -83,7 +79,7 @@ export declare function initPayment({ bankTransfer, browserInfo, commercialOrder
  * @throws {Error} If `details` is missing
  * @returns {Promise<AddPaymentDetailsResponse>} A promise resolving to the response containing the result
  */
-export declare function addPaymentDetails({ details, }: AddPaymentDetailsRequest): Promise<AddPaymentDetailsResponse>;
+export declare function getPaymentDetails({ details, }: GetPaymentDetailsRequest): Promise<GetPaymentDetailsResponse>;
 /**
  * 💳 Gets available payment methods.
  *

package/lib/services/payment/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.initPayment = initPayment;
-exports.addPaymentDetails = addPaymentDetails;
+exports.getPaymentDetails = getPaymentDetails;
 exports.getPaymentMethods = getPaymentMethods;
 exports.deleteStoredPaymentMethodById = deleteStoredPaymentMethodById;
 const parameters_validation_1 = require("../../helpers/parameters-validation");
@@ -22,12 +22,10 @@ const fetch_instance_1 = require("../../settings/fetch-instance");
  *
  * | Parameter           | Type                | Required | Description                                    |
  * |---------------------|---------------------|----------|------------------------------------------------|
- * | `bankTransfer`      | `BankTransfer`      | ✅       | Bank transfer configuration.                  |
  * | `browserInfo`       | `BrowserInfo`       | ✅       | Browser information for 3DS authentication.   |
- * | `commercialOrder`   | `CommercialOrder`   | ❌       | Commercial order details.                     |
  * | `countryCode`       | `string`            | ✅       | Country code for payment processing.          |
- * | `customerUserIP`    | `string`            | ✅       | Customer's IP address.                        |
- * | `paymentMethodData` | `PaymentMethodData` | ✅       | Payment method configuration.                 |
+ * | `customerUserIP`    | `string`            | ❌       | Customer's IP address.                        |
+ * | `paymentMethodData` | `PaymentMethodData` | ❌       | Payment method configuration.                 |
  * | `reference`         | `string`            | ✅       | Payment reference identifier.                 |
  * | `referenceType`     | `string`            | ❌       | Type of reference.                            |
  * | `returnPath`        | `string`            | ✅       | Return URL after payment completion.          |
@@ -39,7 +37,6 @@ const fetch_instance_1 = require("../../settings/fetch-instance");
  *  🛠 **Example usage**:
  * ```ts
  * const response = await initPayment({
- *   bankTransfer: false,
  *   browserInfo: {
  *     acceptHeader: "......",
  *     colorDepth: 24,
@@ -51,7 +48,6 @@ const fetch_instance_1 = require("../../settings/fetch-instance");
  *     timeZoneOffset: 0,
  *     userAgent: "......",
  *   },
- *   commercialOrder: false,
  *   countryCode: "FR",
  *   customerUserIP: "127.0.0.1",
  *   paymentMethodData: {
@@ -70,13 +66,10 @@ const fetch_instance_1 = require("../../settings/fetch-instance");
  * @throws {Error} If required parameters are missing
  * @returns {Promise<InitPaymentResponse>} A promise resolving to the payment initialization response
  */
-async function initPayment({ bankTransfer, browserInfo, commercialOrder, countryCode, customerUserIP, paymentMethodData, reference, referenceType, returnPath, storePaymentMethod, }) {
+async function initPayment({ browserInfo, countryCode, customerUserIP, paymentMethodData, reference, referenceType, returnPath, storePaymentMethod, }) {
     (0, parameters_validation_1.required)({
-        bankTransfer,
         browserInfo,
         countryCode,
-        customerUserIP,
-        paymentMethodData,
         reference,
         returnPath,
     });
@@ -84,9 +77,7 @@ async function initPayment({ bankTransfer, browserInfo, commercialOrder, country
         method: "POST",
         path: `/v1/shop/payments`,
         body: JSON.stringify({
-            bankTransfer,
             browserInfo,
-            commercialOrder,
             countryCode,
             customerUserIP,
             paymentMethodData,
@@ -99,9 +90,9 @@ async function initPayment({ bankTransfer, browserInfo, commercialOrder, country
     return data;
 }
 /**
- * 💳 Adds payment details.
+ * 💳 Gets payment details.
  *
- * This function adds additional details to an existing payment transaction.
+ * This function gets additional details to an existing payment transaction.
  * The `details` parameter is mandatory and validated before the request is executed.
  *
  * 🛠 **Endpoint**: `POST /v1/shop/payments/details` [PAY-102]
@@ -117,7 +108,7 @@ async function initPayment({ bankTransfer, browserInfo, commercialOrder, country
  * @throws {Error} If `details` is missing
  * @returns {Promise<AddPaymentDetailsResponse>} A promise resolving to the response containing the result
  */
-async function addPaymentDetails({ details, }) {
+async function getPaymentDetails({ details, }) {
     (0, parameters_validation_1.required)({ details });
     const { data } = await (0, fetch_instance_1.enhancedFetch)({
         method: "POST",

package/package.json

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