@commercengine/storefront-sdk 0.11.1 → 0.12.0

package/dist/index.iife.js

@@ -2291,6 +2291,130 @@ Object.defineProperty(exports, '__esModule', { value: true });
 			}));
 		}
 		/**
+		* Get all available coupons
+		*
+		* @param headers - Optional header parameters (customer_group_id, etc.)
+		* @returns Promise with all available coupons
+		* @example
+		* ```typescript
+		* // Get all available coupons
+		* const { data, error } = await sdk.cart.getAvailableCoupons();
+		*
+		* if (error) {
+		*   console.error("Failed to get available coupons:", error.message);
+		* } else {
+		*   const coupons = data.coupons || [];
+		*   console.log("Available coupons:", coupons.length);
+		*   coupons.forEach(coupon => {
+		*     console.log("Coupon:", coupon.code, "Discount:", coupon.discount_amount);
+		*   });
+		* }
+		*
+		* // Override customer group ID for this specific request
+		* const { data: overrideData, error: overrideError } = await sdk.cart.getAvailableCoupons({
+		*   "x-customer-group-id": "01H9GROUP12345ABC" // Override default SDK config
+		* });
+		* ```
+		*/
+		async getAvailableCoupons(headers) {
+			const mergedHeaders = this.mergeHeaders(headers);
+			return this.executeRequest(() => this.client.GET("/carts/available-coupons", { params: { header: mergedHeaders } }));
+		}
+		/**
+		* Get all available promotions
+		*
+		* @param headers - Optional header parameters (customer_group_id, etc.)
+		* @returns Promise with all available promotions
+		* @example
+		* ```typescript
+		* // Get all available promotions
+		* const { data, error } = await sdk.cart.getAvailablePromotions();
+		*
+		* if (error) {
+		*   console.error("Failed to get available promotions:", error.message);
+		* } else {
+		*   const promotions = data.promotions || [];
+		*   console.log("Available promotions:", promotions.length);
+		*   promotions.forEach(promotion => {
+		*     console.log("Promotion:", promotion.name, "Type:", promotion.promotion_type);
+		*   });
+		* }
+		*
+		* // Override customer group ID for this specific request
+		* const { data: overrideData, error: overrideError } = await sdk.cart.getAvailablePromotions({
+		*   "x-customer-group-id": "01H9GROUP12345ABC" // Override default SDK config
+		* });
+		* ```
+		*/
+		async getAvailablePromotions(headers) {
+			const mergedHeaders = this.mergeHeaders(headers);
+			return this.executeRequest(() => this.client.GET("/carts/available-promotions", { params: { header: mergedHeaders } }));
+		}
+		/**
+		* Evaluate promotions
+		*
+		* @param cartId - The ID of the cart
+		* @returns Promise with evaluated promotions
+		* @example
+		* ```typescript
+		* const { data, error } = await sdk.cart.evaluatePromotions({
+		*   id: "01H9CART12345ABCDE"
+		* });
+		*
+		* if (error) {
+		*   console.error("Failed to evaluate promotions:", error.message);
+		* } else {
+		*   const applicable = data.applicable_promotions || [];
+		*   const inapplicable = data.inapplicable_promotions || [];
+		*
+		*   console.log("Applicable promotions:", applicable.length);
+		*   applicable.forEach(promo => {
+		*     console.log(`- ${promo.name}: ${promo.savings_message}`);
+		*   });
+		*
+		*   console.log("Inapplicable promotions:", inapplicable.length);
+		*   inapplicable.forEach(promo => {
+		*     console.log(`- ${promo.name}: ${promo.reason}`);
+		*   });
+		* }
+		* ```
+		*/
+		async evaluatePromotions(cartId) {
+			return this.executeRequest(() => this.client.GET("/carts/{id}/evaluate-promotions", { params: { path: cartId } }));
+		}
+		/**
+		* Evaluate coupons
+		*
+		* @param cartId - The ID of the cart
+		* @returns Promise with evaluated coupons
+		* @example
+		* ```typescript
+		* const { data, error } = await sdk.cart.evaluateCoupons({
+		*   id: "01H9CART12345ABCDE"
+		* });
+		*
+		* if (error) {
+		*   console.error("Failed to evaluate coupons:", error.message);
+		* } else {
+		*   const applicable = data.applicable_coupons || [];
+		*   const inapplicable = data.inapplicable_coupons || [];
+		*
+		*   console.log("Applicable coupons:", applicable.length);
+		*   applicable.forEach(coupon => {
+		*     console.log(`- ${coupon.code}: Save $${coupon.estimated_discount}`);
+		*   });
+		*
+		*   console.log("Inapplicable coupons:", inapplicable.length);
+		*   inapplicable.forEach(coupon => {
+		*     console.log(`- ${coupon.code}: ${coupon.reason}`);
+		*   });
+		* }
+		* ```
+		*/
+		async evaluateCoupons(cartId) {
+			return this.executeRequest(() => this.client.GET("/carts/{id}/evaluate-coupons", { params: { path: cartId } }));
+		}
+		/**
 		* Redeem loyalty points
 		*
 		* @param cartId - The ID of the cart
@@ -2349,12 +2473,18 @@ Object.defineProperty(exports, '__esModule', { value: true });
 		* @returns Promise with updated cart
 		* @example
 		* ```typescript
+		* // For delivery fulfillment with shipments
 		* const { data, error } = await sdk.cart.updateFulfillmentPreference(
 		*   { id: "01H9CART12345ABCDE" },
 		*   {
 		*     fulfillment_type: "delivery",
-		*     shipping_provider_id: "01H9SHIP12345FAST",
-		*     courier_company_id: "01H9COY12345FAST", // Optional
+		*     shipments: [
+		*       {
+		*         id: "01H9SHIP12345ABCDE",
+		*         shipping_provider_id: "01H9PROV12345FAST",
+		*         courier_company_id: "01H9COY12345FAST" // Optional
+		*       }
+		*     ]
 		*   }
 		* );
 		*
@@ -2364,6 +2494,15 @@ Object.defineProperty(exports, '__esModule', { value: true });
 		*   console.log("Fulfillment preference updated:", data.cart.fulfillment_preference?.fulfillment_type);
 		*   console.log("Shipping cost:", data.cart.shipping_amount);
 		* }
+		*
+		* // For collect-in-store fulfillment
+		* const { data: collectData, error: collectError } = await sdk.cart.updateFulfillmentPreference(
+		*   { id: "01H9CART12345ABCDE" },
+		*   {
+		*     fulfillment_type: "collect-in-store",
+		*     pickup_location_id: "01H9STORE12345ABC"
+		*   }
+		* );
 		* ```
 		*/
 		async updateFulfillmentPreference(cartId, body) {
@@ -2373,6 +2512,100 @@ Object.defineProperty(exports, '__esModule', { value: true });
 			}));
 		}
 		/**
+		* Check fulfillment serviceability
+		*
+		* Checks if fulfillment (delivery or collect-in-store) is available to the specified pincode
+		* based on shipping zones and inventories.
+		*
+		* @param body - Fulfillment check body (cart-based or items-based)
+		* @returns Promise with fulfillment serviceability result
+		* @example
+		* ```typescript
+		* // Cart-based fulfillment check
+		* const { data, error } = await sdk.cart.checkPincodeDeliverability({
+		*   cart_id: "cart_01H9XYZ12345ABCDE",
+		*   delivery_pincode: "400001",
+		*   fulfillment_type: "delivery" // optional: "delivery" | "collect-in-store"
+		* });
+		*
+		* // Items-based fulfillment check
+		* const { data, error } = await sdk.cart.checkPincodeDeliverability({
+		*   delivery_pincode: "400001",
+		*   items: [
+		*     { product_id: "prod_123", variant_id: "var_456" },
+		*     { product_id: "prod_789", variant_id: null }
+		*   ]
+		*   // fulfillment_type is optional
+		* });
+		*
+		* if (error) {
+		*   console.error("Failed to check fulfillment serviceability:", error.message);
+		* } else {
+		*   console.log("Serviceable:", data.is_serviceable);
+		*
+		*   if (!data.is_serviceable && data.unserviceable_items) {
+		*     data.unserviceable_items.forEach(item => {
+		*       console.log(`Unserviceable: ${item.product_name}, max available: ${item.max_available_quantity}`);
+		*     });
+		*   }
+		* }
+		* ```
+		*/
+		async checkPincodeDeliverability(body) {
+			return this.executeRequest(() => this.client.POST("/fulfillment/serviceability", { body }));
+		}
+		/**
+		* Get fulfillment options for an order
+		*
+		* @param body - Fulfillment options body containing cart_id and delivery_pincode
+		* @returns Promise with fulfillment options including collect and delivery methods
+		* @example
+		* ```typescript
+		* const { data, error } = await sdk.cart.getFulfillmentOptions({
+		*   cart_id: "cart_01H9XYZ12345ABCDE",
+		*   delivery_pincode: "400001"
+		* });
+		*
+		* if (error) {
+		*   console.error("Failed to get fulfillment options:", error.message);
+		* } else {
+		*   // Check summary information
+		*   console.log("Collect available:", data.summary.collect_available);
+		*   console.log("Deliver available:", data.summary.deliver_available);
+		*   console.log("Recommended fulfillment type:", data.summary.recommended_fulfillment_type);
+		*
+		*   // Access collect options
+		*   if (data.collect && data.collect.length > 0) {
+		*     console.log("Available stores for collection:");
+		*     data.collect.forEach(store => {
+		*       console.log(`${store.name} - ${store.distance_km}km away, ETA: ${store.collect_eta_minutes} minutes`);
+		*     });
+		*   }
+		*
+		*   // Access delivery options (with shipments)
+		*   if (data.deliver && data.deliver.is_serviceable) {
+		*     console.log("Available shipments and shipping methods:");
+		*     data.deliver.shipments.forEach(shipment => {
+		*       console.log(`Shipment ${shipment.id}:`);
+		*       console.log(`  Items: ${shipment.items.length}`);
+		*       shipment.shipping_methods.forEach(method => {
+		*         console.log(`  - ${method.name}: ${method.shipping_amount}, ${method.estimated_delivery_days} days`);
+		*         // Access courier companies for auto shipping methods
+		*         if (method.courier_companies) {
+		*           method.courier_companies.forEach(courier => {
+		*             console.log(`    Courier: ${courier.name} - ${courier.shipping_amount}, ${courier.estimated_delivery_days} days`);
+		*           });
+		*         }
+		*       });
+		*     });
+		*   }
+		* }
+		* ```
+		*/
+		async getFulfillmentOptions(body) {
+			return this.executeRequest(() => this.client.POST("/carts/fulfillment-options", { body }));
+		}
+		/**
 		* Use credit balance
 		*
 		* @param cartId - The ID of the cart
@@ -2508,130 +2741,6 @@ Object.defineProperty(exports, '__esModule', { value: true });
 				body
 			}));
 		}
-		/**
-		* Get all available coupons
-		*
-		* @param headers - Optional header parameters (customer_group_id, etc.)
-		* @returns Promise with all available coupons
-		* @example
-		* ```typescript
-		* // Get all available coupons
-		* const { data, error } = await sdk.cart.getAvailableCoupons();
-		*
-		* if (error) {
-		*   console.error("Failed to get available coupons:", error.message);
-		* } else {
-		*   const coupons = data.coupons || [];
-		*   console.log("Available coupons:", coupons.length);
-		*   coupons.forEach(coupon => {
-		*     console.log("Coupon:", coupon.code, "Discount:", coupon.discount_amount);
-		*   });
-		* }
-		*
-		* // Override customer group ID for this specific request
-		* const { data: overrideData, error: overrideError } = await sdk.cart.getAvailableCoupons({
-		*   "x-customer-group-id": "01H9GROUP12345ABC" // Override default SDK config
-		* });
-		* ```
-		*/
-		async getAvailableCoupons(headers) {
-			const mergedHeaders = this.mergeHeaders(headers);
-			return this.executeRequest(() => this.client.GET("/carts/available-coupons", { params: { header: mergedHeaders } }));
-		}
-		/**
-		* Get all available promotions
-		*
-		* @param headers - Optional header parameters (customer_group_id, etc.)
-		* @returns Promise with all available promotions
-		* @example
-		* ```typescript
-		* // Get all available promotions
-		* const { data, error } = await sdk.cart.getAvailablePromotions();
-		*
-		* if (error) {
-		*   console.error("Failed to get available promotions:", error.message);
-		* } else {
-		*   const promotions = data.promotions || [];
-		*   console.log("Available promotions:", promotions.length);
-		*   promotions.forEach(promotion => {
-		*     console.log("Promotion:", promotion.name, "Type:", promotion.promotion_type);
-		*   });
-		* }
-		*
-		* // Override customer group ID for this specific request
-		* const { data: overrideData, error: overrideError } = await sdk.cart.getAvailablePromotions({
-		*   "x-customer-group-id": "01H9GROUP12345ABC" // Override default SDK config
-		* });
-		* ```
-		*/
-		async getAvailablePromotions(headers) {
-			const mergedHeaders = this.mergeHeaders(headers);
-			return this.executeRequest(() => this.client.GET("/carts/available-promotions", { params: { header: mergedHeaders } }));
-		}
-		/**
-		* Evaluate promotions
-		*
-		* @param cartId - The ID of the cart
-		* @returns Promise with evaluated promotions
-		* @example
-		* ```typescript
-		* const { data, error } = await sdk.cart.evaluatePromotions({
-		*   id: "01H9CART12345ABCDE"
-		* });
-		*
-		* if (error) {
-		*   console.error("Failed to evaluate promotions:", error.message);
-		* } else {
-		*   const applicable = data.applicable_promotions || [];
-		*   const inapplicable = data.inapplicable_promotions || [];
-		*
-		*   console.log("Applicable promotions:", applicable.length);
-		*   applicable.forEach(promo => {
-		*     console.log(`- ${promo.name}: ${promo.savings_message}`);
-		*   });
-		*
-		*   console.log("Inapplicable promotions:", inapplicable.length);
-		*   inapplicable.forEach(promo => {
-		*     console.log(`- ${promo.name}: ${promo.reason}`);
-		*   });
-		* }
-		* ```
-		*/
-		async evaluatePromotions(cartId) {
-			return this.executeRequest(() => this.client.GET("/carts/{id}/evaluate-promotions", { params: { path: cartId } }));
-		}
-		/**
-		* Evaluate coupons
-		*
-		* @param cartId - The ID of the cart
-		* @returns Promise with evaluated coupons
-		* @example
-		* ```typescript
-		* const { data, error } = await sdk.cart.evaluateCoupons({
-		*   id: "01H9CART12345ABCDE"
-		* });
-		*
-		* if (error) {
-		*   console.error("Failed to evaluate coupons:", error.message);
-		* } else {
-		*   const applicable = data.applicable_coupons || [];
-		*   const inapplicable = data.inapplicable_coupons || [];
-		*
-		*   console.log("Applicable coupons:", applicable.length);
-		*   applicable.forEach(coupon => {
-		*     console.log(`- ${coupon.code}: Save $${coupon.estimated_discount}`);
-		*   });
-		*
-		*   console.log("Inapplicable coupons:", inapplicable.length);
-		*   inapplicable.forEach(coupon => {
-		*     console.log(`- ${coupon.code}: ${coupon.reason}`);
-		*   });
-		* }
-		* ```
-		*/
-		async evaluateCoupons(cartId) {
-			return this.executeRequest(() => this.client.GET("/carts/{id}/evaluate-coupons", { params: { path: cartId } }));
-		}
 	};
 
 //#endregion
@@ -3679,10 +3788,14 @@ Object.defineProperty(exports, '__esModule', { value: true });
 		/**
 		* List all available payment methods
 		*
+		* @param queryParams - Query parameters containing the payment method type and payment provider slug
 		* @returns Promise with list of payment methods
 		* @example
 		* ```typescript
-		* const { data, error } = await sdk.payments.listPaymentMethods();
+		* const { data, error } = await sdk.payments.listPaymentMethods({
+		*   payment_method_type: "card",
+		*   payment_provider_slug: "payu"
+		* });
 		*
 		* if (error) {
 		*   console.error("Failed to list payment methods:", error.message);
@@ -3696,8 +3809,8 @@ Object.defineProperty(exports, '__esModule', { value: true });
 		* }
 		* ```
 		*/
-		async listPaymentMethods() {
-			return this.executeRequest(() => this.client.GET("/payments/payment-methods", {}));
+		async listPaymentMethods(queryParams) {
+			return this.executeRequest(() => this.client.GET("/payments/payment-methods", { params: { query: queryParams } }));
 		}
 		/**
 		* Verify a UPI Virtual Payment Address (VPA)
@@ -3732,6 +3845,29 @@ Object.defineProperty(exports, '__esModule', { value: true });
 			return this.executeRequest(() => this.client.GET("/payments/verify-vpa", { params: { query: queryParams } }));
 		}
 		/**
+		* Get card information
+		*
+		* Retrieves card information based on the initial 9 digits (card BIN) of the card number.
+		*
+		* @param queryParams - Query parameters containing the card BIN
+		* @returns Promise with card information
+		* @example
+		* ```typescript
+		* const { data, error } = await sdk.payments.getCardInfo({
+		*   cardbin: "411111111"
+		* });
+		*
+		* if (error) {
+		*   console.error("Failed to get card information:", error.message);
+		* } else {
+		*   console.log("Card information:", data.card_info);
+		* }
+		* ```
+		*/
+		async getCardInfo(queryParams) {
+			return this.executeRequest(() => this.client.GET("/payments/card-info", { params: { query: queryParams } }));
+		}
+		/**
 		* Authenticate a direct OTP for payment verification
 		*
 		* @description Used to authenticate OTP during payment flows that require 2FA verification.
@@ -3790,82 +3926,6 @@ Object.defineProperty(exports, '__esModule', { value: true });
 		}
 	};
 
-//#endregion
-//#region src/lib/shipping.ts
-/**
-	* Client for interacting with shipping endpoints
-	*/
-	var ShippingClient = class extends StorefrontAPIClient {
-		/**
-		* Check pincode deliverability
-		*
-		* @param pathParams - Path parameters
-		* @returns Promise with pincode deliverability result
-		* @example
-		* ```typescript
-		* const { data, error } = await sdk.shipping.checkPincodeDeliverability({
-		*   pincode: "400001"
-		* });
-		*
-		* if (error) {
-		*   console.error("Failed to check pincode serviceability:", error.message);
-		* } else {
-		*   console.log("Pincode serviceable:", data.is_serviceable);
-		*
-		*   if (data.is_serviceable) {
-		*     console.log("Delivery is available to this pincode");
-		*   } else {
-		*     console.log("Delivery is not available to this pincode");
-		*   }
-		* }
-		* ```
-		*/
-		async checkPincodeDeliverability(pathParams) {
-			return this.executeRequest(() => this.client.GET("/shipping/serviceability/{pincode}", { params: { path: pathParams } }));
-		}
-		/**
-		* Get fulfillment options for an order
-		*
-		* @param body - Fulfillment options body containing cart_id and delivery_pincode
-		* @returns Promise with fulfillment options including collect and delivery methods
-		* @example
-		* ```typescript
-		* const { data, error } = await sdk.shipping.getFulfillmentOptions({
-		*   cart_id: "cart_01H9XYZ12345ABCDE",
-		*   delivery_pincode: "400001"
-		* });
-		*
-		* if (error) {
-		*   console.error("Failed to get fulfillment options:", error.message);
-		* } else {
-		*   // Check summary information
-		*   console.log("Collect available:", data.summary.collect_available);
-		*   console.log("Deliver available:", data.summary.deliver_available);
-		*   console.log("Recommended fulfillment type:", data.summary.recommended_fulfillment_type);
-		*
-		*   // Access collect options
-		*   if (data.collect && data.collect.length > 0) {
-		*     console.log("Available stores for collection:");
-		*     data.collect.forEach(store => {
-		*       console.log(`${store.name} - ${store.distance_km}km away, ETA: ${store.collect_eta_minutes} minutes`);
-		*     });
-		*   }
-		*
-		*   // Access delivery options
-		*   if (data.deliver && data.deliver.is_serviceable) {
-		*     console.log("Available shipping methods:");
-		*     data.deliver.shipping_methods.forEach(method => {
-		*       console.log(`${method.name} - ${method.shipping_amount}, ${method.estimated_delivery_days} days`);
-		*     });
-		*   }
-		* }
-		* ```
-		*/
-		async getFulfillmentOptions(body) {
-			return this.executeRequest(() => this.client.POST("/shipping/fulfillment-options", { body }));
-		}
-	};
-
 //#endregion
 //#region src/lib/helper.ts
 /**
@@ -4323,6 +4383,29 @@ Object.defineProperty(exports, '__esModule', { value: true });
 		async listSavedPaymentMethods(pathParams) {
 			return this.executeRequest(() => this.client.GET("/customers/{customer_id}/payment-methods", { params: { path: pathParams } }));
 		}
+		/**
+		* List all saved cards for a customer
+		*
+		* @param pathParams - Path parameters
+		* @returns Promise with cards
+		*
+		* @example
+		* ```typescript
+		* const { data, error } = await sdk.customer.listCustomerCards({
+		*   customer_id: "customer_123"
+		* });
+		*
+		* if (error) {
+		*   console.error("Failed to list customer cards:", error);
+		*   return;
+		* }
+		*
+		* console.log("Customer cards:", data.cards);
+		* ```
+		*/
+		async listCustomerCards(pathParams) {
+			return this.executeRequest(() => this.client.GET("/customers/{customer_id}/cards", { params: { path: pathParams } }));
+		}
 	};
 
 //#endregion
@@ -4385,10 +4468,6 @@ Object.defineProperty(exports, '__esModule', { value: true });
 		*/
 		helpers;
 		/**
-		* Client for shipping-related endpoints
-		*/
-		shipping;
-		/**
 		* Client for order-related endpoints
 		*/
 		order;
@@ -4431,7 +4510,6 @@ Object.defineProperty(exports, '__esModule', { value: true });
 			this.auth = new AuthClient(config);
 			this.customer = new CustomerClient(config);
 			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);
@@ -4452,7 +4530,6 @@ Object.defineProperty(exports, '__esModule', { value: true });
 			await this.auth.setTokens(accessToken, refreshToken);
 			await this.customer.setTokens(accessToken, refreshToken);
 			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);
@@ -4470,7 +4547,6 @@ Object.defineProperty(exports, '__esModule', { value: true });
 			await this.auth.clearTokens();
 			await this.customer.clearTokens();
 			await this.helpers.clearTokens();
-			await this.shipping.clearTokens();
 			await this.order.clearTokens();
 			await this.payments.clearTokens();
 			await this.store.clearTokens();
@@ -4486,7 +4562,6 @@ Object.defineProperty(exports, '__esModule', { value: true });
 			this.auth.setApiKey(apiKey);
 			this.customer.setApiKey(apiKey);
 			this.helpers.setApiKey(apiKey);
-			this.shipping.setApiKey(apiKey);
 			this.order.setApiKey(apiKey);
 			this.payments.setApiKey(apiKey);
 			this.store.setApiKey(apiKey);
@@ -4500,7 +4575,6 @@ Object.defineProperty(exports, '__esModule', { value: true });
 			this.auth.clearApiKey();
 			this.customer.clearApiKey();
 			this.helpers.clearApiKey();
-			this.shipping.clearApiKey();
 			this.order.clearApiKey();
 			this.payments.clearApiKey();
 			this.store.clearApiKey();
@@ -4579,7 +4653,6 @@ Object.defineProperty(exports, '__esModule', { value: true });
 			this.auth.setDefaultHeaders(headers);
 			this.customer.setDefaultHeaders(headers);
 			this.helpers.setDefaultHeaders(headers);
-			this.shipping.setDefaultHeaders(headers);
 			this.order.setDefaultHeaders(headers);
 			this.payments.setDefaultHeaders(headers);
 			this.store.setDefaultHeaders(headers);
@@ -4608,7 +4681,6 @@ exports.MemoryTokenStorage = MemoryTokenStorage;
 exports.OrderClient = OrderClient;
 exports.PaymentsClient = PaymentsClient;
 exports.ResponseUtils = ResponseUtils;
-exports.ShippingClient = ShippingClient;
 exports.StoreConfigClient = StoreConfigClient;
 exports.StorefrontAPIClient = StorefrontAPIClient;
 exports.StorefrontSDK = StorefrontSDK;