@commercengine/storefront-sdk 0.10.2 → 0.11.0

package/dist/index.js

@@ -2875,27 +2875,80 @@ var OrderClient = class extends StorefrontAPIClient {
 	* @returns Promise with order details
 	* @example
 	* ```typescript
-	* // Example with PayU payment gateway
+	* // Juspay Hyper Checkout - Redirects to hosted payment page
 	* const { data, error } = await sdk.order.createOrder({
 	*   cart_id: "cart_01H9XYZ12345ABCDE",
-	*   payment_gateway: "PAYU",
-	*   payment_gateway_params: {
-	*     payment_gateway: "PAYU",
-	*     furl: "https://yourapp.com/payment/failure",
-	*     surl: "https://yourapp.com/payment/success"
+	*   payment_method: {
+	*     payment_provider_slug: "juspay",
+	*     integration_type: "hyper-checkout",
+	*     gateway_reference_id: "gateway_ref_123",
+	*     return_url: "https://yourapp.com/payment/return",
+	*     action: "paymentPage"
 	*   }
 	* });
 	*
-	* // Example with Juspay payment gateway
+	* // Juspay Express Checkout - New Card
 	* const { data, error } = await sdk.order.createOrder({
 	*   cart_id: "cart_01H9XYZ12345ABCDE",
-	*   payment_gateway: "JUSPAY",
-	*   payment_gateway_params: {
-	*     payment_gateway: "JUSPAY",
-	*     action: "paymentPage",
-	*     integration_type: "hyper-checkout",
+	*   payment_method: {
+	*     payment_provider_slug: "juspay",
+	*     integration_type: "express-checkout",
+	*     gateway_reference_id: "gateway_ref_123",
+	*     return_url: "https://yourapp.com/payment/return",
+	*     payment_method_type: "CARD",
+	*     payment_method: "VISA",
+	*     auth_type: "OTP",
+	*     save_to_locker: true,
+	*     card_number: "4111111111111111",
+	*     card_exp_month: "12",
+	*     card_exp_year: "2025",
+	*     name_on_card: "John Doe",
+	*     card_security_code: "123"
+	*   }
+	* });
+	*
+	* // Juspay Express Checkout - Saved Card Token
+	* const { data, error } = await sdk.order.createOrder({
+	*   cart_id: "cart_01H9XYZ12345ABCDE",
+	*   payment_method: {
+	*     payment_provider_slug: "juspay",
+	*     integration_type: "express-checkout",
+	*     gateway_reference_id: "gateway_ref_123",
 	*     return_url: "https://yourapp.com/payment/return",
-	*     gateway_reference_id: "juspay_gateway_ref_123"
+	*     get_client_auth_token: true,
+	*     payment_method_type: "CARD",
+	*     payment_method: "VISA",
+	*     auth_type: "OTP",
+	*     save_to_locker: false,
+	*     card_token: "token_abc123",
+	*     card_security_code: "123"
+	*   }
+	* });
+	*
+	* // Juspay Express Checkout - UPI Collect
+	* const { data, error } = await sdk.order.createOrder({
+	*   cart_id: "cart_01H9XYZ12345ABCDE",
+	*   payment_method: {
+	*     payment_provider_slug: "juspay",
+	*     integration_type: "express-checkout",
+	*     gateway_reference_id: "gateway_ref_123",
+	*     return_url: "https://yourapp.com/payment/return",
+	*     payment_method_type: "UPI",
+	*     payment_method: "UPI_COLLECT",
+	*     upi_vpa: "user@upi"
+	*   }
+	* });
+	*
+	* // Juspay Express Checkout - Net Banking
+	* const { data, error } = await sdk.order.createOrder({
+	*   cart_id: "cart_01H9XYZ12345ABCDE",
+	*   payment_method: {
+	*     payment_provider_slug: "juspay",
+	*     integration_type: "express-checkout",
+	*     gateway_reference_id: "gateway_ref_123",
+	*     return_url: "https://yourapp.com/payment/return",
+	*     payment_method_type: "NB",
+	*     payment_method: "NB_HDFC"
 	*   }
 	* });
 	*
@@ -2905,6 +2958,17 @@ var OrderClient = class extends StorefrontAPIClient {
 	*   console.log("Order created:", data.order.id);
 	*   console.log("Payment required:", data.payment_required);
 	*   console.log("Payment info:", data.payment_info);
+	*
+	*   // For hyper-checkout, redirect to payment page
+	*   if ("payment_links" in data.payment_info) {
+	*     window.location.href = data.payment_info.payment_links?.web;
+	*   }
+	*
+	*   // For express-checkout with OTP authentication
+	*   if ("payment" in data.payment_info && data.payment_info.payment?.authentication?.params) {
+	*     const { id: txn_id, challenge_id } = data.payment_info.payment.authentication.params;
+	*     // Use txn_id and challenge_id with sdk.payments.authenticateDirectOtp()
+	*   }
 	* }
 	* ```
 	*/
@@ -3092,28 +3156,32 @@ var OrderClient = class extends StorefrontAPIClient {
 	* @returns Promise with payment information
 	* @example
 	* ```typescript
-	* // Example with PayU payment gateway
+	* // Juspay Hyper Checkout - Redirects to hosted payment page
 	* const { data, error } = await sdk.order.retryOrderPayment(
 	*   { order_number: "ORD-2024-001" },
 	*   {
-	*     payment_gateway_params: {
-	*       payment_gateway: "PAYU",
-	*       furl: "https://yourapp.com/payment/failure",
-	*       surl: "https://yourapp.com/payment/success"
+	*     payment_method: {
+	*       payment_provider_slug: "juspay",
+	*       integration_type: "hyper-checkout",
+	*       gateway_reference_id: "gateway_ref_123",
+	*       return_url: "https://yourapp.com/payment/return",
+	*       action: "paymentPage"
 	*     }
 	*   }
 	* );
 	*
-	* // Example with Juspay payment gateway
+	* // Juspay Express Checkout - UPI Collect
 	* const { data, error } = await sdk.order.retryOrderPayment(
 	*   { order_number: "ORD-2024-001" },
 	*   {
-	*     payment_gateway_params: {
-	*       payment_gateway: "JUSPAY",
-	*       action: "paymentPage",
-	*       integration_type: "hyper-checkout",
+	*     payment_method: {
+	*       payment_provider_slug: "juspay",
+	*       integration_type: "express-checkout",
+	*       gateway_reference_id: "gateway_ref_123",
 	*       return_url: "https://yourapp.com/payment/return",
-	*       gateway_reference_id: "juspay_gateway_ref_123"
+	*       payment_method_type: "UPI",
+	*       payment_method: "UPI_COLLECT",
+	*       upi_vpa: "user@upi"
 	*     }
 	*   }
 	* );
@@ -3123,7 +3191,11 @@ var OrderClient = class extends StorefrontAPIClient {
 	* } else {
 	*   console.log("Payment retry initiated");
 	*   console.log("Payment info:", data.payment_info);
-	*   console.log("Transaction ID:", data.payment_info.transaction_id);
+	*
+	*   // For hyper-checkout, redirect to payment page
+	*   if ("payment_links" in data.payment_info) {
+	*     window.location.href = data.payment_info.payment_links?.web;
+	*   }
 	* }
 	* ```
 	*/
@@ -3135,6 +3207,126 @@ var OrderClient = class extends StorefrontAPIClient {
 	}
 };
 
+//#endregion
+//#region src/lib/payments.ts
+/**
+* Client for interacting with payment endpoints
+*/
+var PaymentsClient = class extends StorefrontAPIClient {
+	/**
+	* List all available payment methods
+	*
+	* @returns Promise with list of payment methods
+	* @example
+	* ```typescript
+	* const { data, error } = await sdk.payments.listPaymentMethods();
+	*
+	* if (error) {
+	*   console.error("Failed to list payment methods:", error.message);
+	* } else {
+	*   console.log("Payment methods:", data.payment_methods);
+	*
+	*   data.payment_methods?.forEach(method => {
+	*     console.log("Payment method:", method.name);
+	*     console.log("Gateway:", method.payment_gateway);
+	*   });
+	* }
+	* ```
+	*/
+	async listPaymentMethods() {
+		return this.executeRequest(() => this.client.GET("/payments/payment-methods", {}));
+	}
+	/**
+	* Verify a UPI Virtual Payment Address (VPA)
+	*
+	* @description The Virtual Payment Address or VPA is a unique ID given to an individual
+	* using the Unified Payment Interface (UPI) service to send or receive money.
+	* Validating the VPA helps reduce payment failure rates due to incorrect VPA.
+	*
+	* @param queryParams - Query parameters containing the VPA to verify
+	* @returns Promise with VPA verification result
+	* @example
+	* ```typescript
+	* const { data, error } = await sdk.payments.verifyVpa({
+	*   vpa: "user@upi"
+	* });
+	*
+	* if (error) {
+	*   console.error("Failed to verify VPA:", error.message);
+	* } else {
+	*   console.log("VPA:", data.vpa);
+	*   console.log("Status:", data.status);
+	*
+	*   if (data.status === "VALID") {
+	*     console.log("VPA is valid and can be used for UPI payments");
+	*   } else {
+	*     console.log("VPA is invalid, please check and try again");
+	*   }
+	* }
+	* ```
+	*/
+	async verifyVpa(queryParams) {
+		return this.executeRequest(() => this.client.GET("/payments/verify-vpa", { params: { query: queryParams } }));
+	}
+	/**
+	* Authenticate a direct OTP for payment verification
+	*
+	* @description Used to authenticate OTP during payment flows that require 2FA verification.
+	* The txn_id and challenge_id can be obtained from the create order API response
+	* under the payment_info.authentication.params object.
+	*
+	* @param body - OTP authentication request body
+	* @returns Promise with authentication result
+	* @example
+	* ```typescript
+	* // After creating an order, if OTP authentication is required:
+	* const { data, error } = await sdk.payments.authenticateDirectOtp({
+	*   txn_id: "txn_01H9XYZ12345ABCDE",
+	*   challenge_id: "challenge_01H9XYZ12345ABCDE",
+	*   otp: "123456"
+	* });
+	*
+	* if (error) {
+	*   console.error("OTP authentication failed:", error.message);
+	* } else {
+	*   console.log("Authentication success:", data.success);
+	*   console.log("Message:", data.message);
+	* }
+	* ```
+	*/
+	async authenticateDirectOtp(body) {
+		return this.executeRequest(() => this.client.POST("/payments/authenticate-direct-otp", { body }));
+	}
+	/**
+	* Resend a direct OTP for payment verification
+	*
+	* @description Used to resend OTP during payment flows that require 2FA verification.
+	* The txn_id and challenge_id can be obtained from the create order API response
+	* under the payment_info.authentication.params object.
+	*
+	* @param body - OTP resend request body
+	* @returns Promise with new payment info containing updated OTP challenge
+	* @example
+	* ```typescript
+	* // If user didn't receive OTP or it expired:
+	* const { data, error } = await sdk.payments.resendDirectOtp({
+	*   txn_id: "txn_01H9XYZ12345ABCDE",
+	*   challenge_id: "challenge_01H9XYZ12345ABCDE"
+	* });
+	*
+	* if (error) {
+	*   console.error("Failed to resend OTP:", error.message);
+	* } else {
+	*   console.log("OTP resent successfully");
+	*   console.log("New payment info:", data.payment_info);
+	* }
+	* ```
+	*/
+	async resendDirectOtp(body) {
+		return this.executeRequest(() => this.client.POST("/payments/resend-direct-otp", { body }));
+	}
+};
+
 //#endregion
 //#region src/lib/shipping.ts
 /**
@@ -3738,6 +3930,10 @@ var StorefrontSDK = class {
 	*/
 	order;
 	/**
+	* Client for payment-related endpoints
+	*/
+	payments;
+	/**
 	* Client for store config-related endpoints
 	*/
 	store;
@@ -3774,6 +3970,7 @@ var StorefrontSDK = class {
 		this.helpers = new HelpersClient(config);
 		this.shipping = new ShippingClient(config);
 		this.order = new OrderClient(config);
+		this.payments = new PaymentsClient(config);
 		this.store = new StoreConfigClient(config);
 	}
 	/**
@@ -3794,6 +3991,7 @@ var StorefrontSDK = class {
 		await this.helpers.setTokens(accessToken, refreshToken);
 		await this.shipping.setTokens(accessToken, refreshToken);
 		await this.order.setTokens(accessToken, refreshToken);
+		await this.payments.setTokens(accessToken, refreshToken);
 		await this.store.setTokens(accessToken, refreshToken);
 	}
 	/**
@@ -3811,6 +4009,7 @@ var StorefrontSDK = class {
 		await this.helpers.clearTokens();
 		await this.shipping.clearTokens();
 		await this.order.clearTokens();
+		await this.payments.clearTokens();
 		await this.store.clearTokens();
 	}
 	/**
@@ -3826,6 +4025,7 @@ var StorefrontSDK = class {
 		this.helpers.setApiKey(apiKey);
 		this.shipping.setApiKey(apiKey);
 		this.order.setApiKey(apiKey);
+		this.payments.setApiKey(apiKey);
 		this.store.setApiKey(apiKey);
 	}
 	/**
@@ -3839,6 +4039,7 @@ var StorefrontSDK = class {
 		this.helpers.clearApiKey();
 		this.shipping.clearApiKey();
 		this.order.clearApiKey();
+		this.payments.clearApiKey();
 		this.store.clearApiKey();
 	}
 	/**
@@ -3917,6 +4118,7 @@ var StorefrontSDK = class {
 		this.helpers.setDefaultHeaders(headers);
 		this.shipping.setDefaultHeaders(headers);
 		this.order.setDefaultHeaders(headers);
+		this.payments.setDefaultHeaders(headers);
 		this.store.setDefaultHeaders(headers);
 	}
 	/**
@@ -3931,5 +4133,5 @@ var StorefrontSDK = class {
 var src_default = StorefrontSDK;
 
 //#endregion
-export { AuthClient, BrowserTokenStorage, CartClient, CatalogClient, CookieTokenStorage, CustomerClient, Environment, HelpersClient, MemoryTokenStorage, OrderClient, ResponseUtils, ShippingClient, StoreConfigClient, StorefrontAPIClient, StorefrontSDK, src_default as default };
+export { AuthClient, BrowserTokenStorage, CartClient, CatalogClient, CookieTokenStorage, CustomerClient, Environment, HelpersClient, MemoryTokenStorage, OrderClient, PaymentsClient, ResponseUtils, ShippingClient, StoreConfigClient, StorefrontAPIClient, StorefrontSDK, src_default as default };
 //# sourceMappingURL=index.js.map