@gofynd/fdk-client-javascript 3.3.5 → 3.4.0

package/sdk/platform/Cart/CartPlatformModel.d.ts

@@ -184,7 +184,7 @@ export = CartPlatformModel;
  */
 /**
  * @typedef Page
- * @property {number} [item_total] - The total number of items on the page.
+ * @property {number} [item_total] - The total number of all items across all pages.
  * @property {string} [next_id] - The identifier for the next page.
  * @property {boolean} [has_previous] - Indicates whether there is a previous page.
  * @property {boolean} [has_next] - Indicates whether there is a next page.
@@ -944,6 +944,39 @@ export = CartPlatformModel;
  * @property {string} [store_code] - A unique code or identifier for the store,
  *   often used for internal reference
  */
+/**
+ * @typedef FulfillmentOptionSchema
+ * @property {string} [slug] - Unique identifier for the delivery type.
+ * @property {string} [description] - Description of the delivery service.
+ * @property {boolean} [is_default] - Indicates if this is the default delivery option.
+ * @property {string} [id] - Unique ID of the delivery service.
+ * @property {string} [type] - Type of fulfillment option.
+ * @property {string} [name] - Name of the delivery service.
+ */
+/**
+ * @typedef StoreTimingSchema
+ * @property {number} [hour] - The hour of the store in 24-hour format (e.g., 9 for 9 AM).
+ * @property {number} [minute] - The minute of the store (e.g., 30 for 9:30 AM).
+ */
+/**
+ * @typedef StoreHoursSchema
+ * @property {string} [weekday] - The day of the week (e.g., "Monday", "Tuesday").
+ * @property {StoreTimingSchema} [opening]
+ * @property {StoreTimingSchema} [closing]
+ * @property {boolean} [open] - Indicates whether the store is open on the
+ *   specified weekday.
+ */
+/**
+ * @typedef PickupStoreDetailSchema
+ * @property {number} [store_id] - A unique identifier for the store.
+ * @property {string} [name] - The name of the store or pickup location.
+ * @property {string} [pincode] - The postal code of the store's location.
+ * @property {number} [distance] - The distance between the store and the
+ *   customer's location.
+ * @property {string} [address] - The full address of the store.
+ * @property {Object} [store_hours] - The store's operational hours for each day
+ *   of the week.
+ */
 /**
  * @typedef ProductArticle
  * @property {string} [seller_identifier] - List of identifiers used by sellers
@@ -975,6 +1008,9 @@ export = CartPlatformModel;
  * @property {Object} [meta] - Meta data of article in cart
  * @property {string} [size] - Size of the article added in cart
  * @property {StoreInfo} [store]
+ * @property {FulfillmentOptionSchema} [fulfillment_option]
+ * @property {PickupStoreDetailSchema} [pickup_store_detail]
+ * @property {number} [item_index] - Specify the index of article in cart.
  * @property {string[]} [tags] - A list of article tags
  */
 /**
@@ -1380,6 +1416,16 @@ export = CartPlatformModel;
  * @typedef CartCommonConfig
  * @property {DeliveryChargesConfig} [delivery_charges_config]
  */
+/**
+ * @typedef PlatformAlternatePickupPerson
+ * @property {boolean} [enabled] - Indicates whether an alternate pickup person
+ *   is enabled.
+ * @property {string} [name] - Name of the alternate pickup person.
+ * @property {string} [email] - Email address of the alternate pickup person.
+ * @property {string} [phone] - Phone number of the alternate pickup person.
+ * @property {string} [country_phone_code] - Country phone code of the alternate
+ *   pickup person (e.g., "+91").
+ */
 /**
  * @typedef CartDetailResult
  * @property {number} [cart_id] - Unique identifier of the user cart
@@ -1421,6 +1467,7 @@ export = CartPlatformModel;
  * @property {string} [pan_no] - Permanent Account Number of the user
  * @property {Object} [custom_cart_meta] - Custom meta details added cart
  *   checkout API payload
+ * @property {PlatformAlternatePickupPerson} [alternate_pickup_person]
  * @property {boolean} [free_gift_selection_available] - Determines if the cart
  *   has available promotion free gift items to choose on its added items
  */
@@ -1452,6 +1499,10 @@ export = CartPlatformModel;
  * @property {boolean} [pos] - Filed to determine whether user is making request
  *   from pos or not
  * @property {string} [seller_identifier] - Add items using seller identifier for store os
+ * @property {string} [fulfillment_option_slug] - Specifies the fulfillment
+ *   method, indicating whether an order is for home delivery or store pickup
+ * @property {number} [pickup_store_id] - Unique identifier of the pickup store
+ *   selected by the user from which user wants to pickup the product.
  */
 /**
  * @typedef AddCartCreation
@@ -1498,6 +1549,10 @@ export = CartPlatformModel;
  *   product falls to be updated
  * @property {CartProductIdentifer} identifiers
  * @property {string} [article_id] - Article id of the product in cart
+ * @property {string} [fulfillment_option_slug] - Specifies the fulfillment
+ *   method, indicating whether an order is for home delivery or store pickup
+ * @property {number} [pickup_store_id] - Unique identifier of the pickup store
+ *   selected by the user from which user
  */
 /**
  * @typedef FreeGiftItemCreation
@@ -1737,10 +1792,16 @@ export = CartPlatformModel;
  * @typedef CartItemCountResult
  * @property {number} [user_cart_items_count] - Item count present in cart
  */
+/**
+ * @typedef DiscountRules
+ * @property {number} [discounted_price] - Discount will be reflected in the
+ *   cart upon adding the product.
+ */
 /**
  * @typedef Coupon
  * @property {string} [title] - Coupon Title of the coupon applied denotes name
  *   of the coupon
+ * @property {DiscountRules[]} [rule] - Discount rules of coupons
  * @property {number} [max_discount_value] - Maximum discount value of the
  *   coupon applied to cart
  * @property {string} [coupon_code] - Coupon code of the coupon applied on cart
@@ -1890,6 +1951,7 @@ export = CartPlatformModel;
  * @property {string} [dp_id] - Delivery partner id of the shipment
  * @property {string} [fulfillment_type] - Fulfilment type of shipment
  * @property {ShipmentArticle[]} [articles] - List of articles in shipment
+ * @property {FulfillmentOptionSchema} [fulfillment_option]
  */
 /**
  * @typedef PlatformCartShipmentsResult
@@ -1932,6 +1994,8 @@ export = CartPlatformModel;
  * @property {number} [quantity] - Quantity of product in shipment
  * @property {string} shipment_type - Shipment delivery type
  * @property {string} article_uid - Article unique id for shipment
+ * @property {number} [item_index] - Item index determines the position in the
+ *   list where the product should be updated.
  */
 /**
  * @typedef UpdateCartShipmentCreation
@@ -1944,6 +2008,7 @@ export = CartPlatformModel;
  * @property {string} [gstin] - GSTIN number to be added in user cart
  * @property {Object} [pick_up_customer_details] - Customer contact details for
  *   customer pickup at store
+ * @property {PlatformAlternatePickupPerson} [alternate_pickup_person]
  * @property {string} [checkout_mode] - Checkout mode of user cart
  * @property {Object} [gift_details] - Gift details is open json which can
  *   include gift message
@@ -2170,6 +2235,8 @@ export = CartPlatformModel;
  *   mode selected to do the payment
  * @property {string} [merchant_code] - Merchant code of the payment mode
  *   selected to do the payment
+ * @property {string[]} [payment_source_bag_id] - Previous bag IDs for which an
+ *   exchange has been performed.
  */
 /**
  * @typedef PaymentMethod
@@ -2341,7 +2408,7 @@ export = CartPlatformModel;
 declare class CartPlatformModel {
 }
 declare namespace CartPlatformModel {
-    export { CouponDateMeta, Ownership, CouponAuthor, State, PaymentAllowValue, PaymentModes, PriceRange, PostOrder, BulkBundleRestriction, UsesRemaining, UsesRestriction, Restrictions, Validation, CouponAction, CouponSchedule, Rule, DisplayMetaDict, DisplayMeta, Identifier, Validity, RuleDefinition, CouponAdd, Page, CouponsResult, SuccessMessage, OperationErrorResult, CouponUpdate, CouponPartialUpdate, CouponCreateResult, DisplayMeta1, Ownership1, CompareObject, ItemSizeMapping, ItemCriteria, DiscountOffer, DiscountRule, PaymentAllowValue1, PromotionPaymentModes, UserRegistered, PostOrder1, UsesRemaining1, UsesRestriction1, Restrictions1, PromotionSchedule, PromotionAction, PromotionAuthor, Visibility, PromotionDateMeta, PromotionListItem, PromotionsResult, PromotionAdd, PromotionAddResult, PromotionUpdate, PromotionUpdateResult, PromotionPartialUpdate, ActivePromosResult, Charges, DeliveryCharges, CartMetaConfigUpdate, CartMetaConfigAdd, Article, PriceAdjustmentRestrictions, Collection, PriceAdjustmentUpdate, PriceAdjustment, PriceAdjustmentResult, GetPriceAdjustmentResult, PriceAdjustmentAdd, DistributionRule, Distribution, DistributionLogic, CartItem, OpenapiCartDetailsCreation, CouponBreakup, DisplayBreakup, LoyaltyPoints, RawBreakup, CartBreakup, ProductImage, Tags, BaseInfo, ActionQuery, ProductActionParams, ProductActionPage, ProductAction, CategoryInfo, CartProduct, BasePrice, ArticlePriceInfo, StoreInfo, ProductArticle, Ownership2, DiscountRulesApp, AppliedFreeArticles, BuyRules, AppliedPromotion, PromiseFormatted, PromiseISOFormat, PromiseTimestamp, ShipmentPromise, CouponDetails, ProductPrice, ProductPriceInfo, ProductMaxQuantityInfo, CartProductIdentifer, ProductAvailabilitySize, ProductAvailability, PromoMeta, CartProductInfo, OpenapiCartDetailsResult, OpenApiErrorResult, ShippingAddress, OpenApiCartServiceabilityCreation, OpenApiCartServiceabilityResult, OpenApiFiles, CartItemMeta, MultiTenderPaymentMeta, MultiTenderPaymentMethod, OpenApiOrderItem, OpenApiPlatformCheckoutReq, OpenApiCheckoutResult, AbandonedCart, AbandonedCartResult, PaymentSelectionLock, CartCurrency, CartDetailCoupon, ChargesThreshold, DeliveryChargesConfig, CartCommonConfig, CartDetailResult, AddProductCart, AddCartCreation, AddCartDetailResult, CartItemInfo, UpdateProductCart, FreeGiftItemCreation, UpdateCartCreation, UpdateCartDetailResult, OverrideCartItemPromo, OverrideCartItem, OverrideCheckoutReq, OverrideCheckoutResult, GetShareCartLinkCreation, GetShareCartLinkResult, SharedCartDetails, SharedCart, SharedCartResult, CartList, MultiCartResult, UpdateUserCartMapping, UserInfo, UserCartMappingResult, PlatformAddCartDetails, PlatformUpdateCartDetails, DeleteCartDetails, DeleteCartDetailResult, CartItemCountResult, Coupon, PageCoupon, GetCouponResult, ApplyCouponDetails, GeoLocation, PlatformAddress, ValidationConfig, PlatformGetAddressesDetails, SaveAddressDetails, UpdateAddressDetails, DeleteAddressResult, PlatformSelectCartAddress, ShipmentArticle, PlatformShipmentDetails, PlatformCartShipmentsResult, UpdateCartShipmentItem, UpdateCartShipmentCreation, PlatformCartMetaCreation, CartMetaDetails, CartMetaMissingDetails, StaffCheckout, CustomerDetails, Files, CartCheckoutCustomMeta, OrderTag, PlatformCartCheckoutDetailCreation, CheckCart, CartCheckoutDetails, CartCheckoutResult, CartDeliveryModesDetails, PickupStoreDetail, StoreDetails, CartPaymentUpdate, CouponValidity, PaymentCouponValidate, PaymentMeta, PaymentMethod, PlatformCartCheckoutDetailV2Creation, UpdateCartPaymentRequestV2, PriceMinMax, ItemPriceDetails, ArticlePriceDetails, FreeGiftItems, PromotionOffer, PromotionOffersDetails, PromotionPaymentOffer, PromotionPaymentOffersDetails, ValidationError, OrderingSource };
+    export { CouponDateMeta, Ownership, CouponAuthor, State, PaymentAllowValue, PaymentModes, PriceRange, PostOrder, BulkBundleRestriction, UsesRemaining, UsesRestriction, Restrictions, Validation, CouponAction, CouponSchedule, Rule, DisplayMetaDict, DisplayMeta, Identifier, Validity, RuleDefinition, CouponAdd, Page, CouponsResult, SuccessMessage, OperationErrorResult, CouponUpdate, CouponPartialUpdate, CouponCreateResult, DisplayMeta1, Ownership1, CompareObject, ItemSizeMapping, ItemCriteria, DiscountOffer, DiscountRule, PaymentAllowValue1, PromotionPaymentModes, UserRegistered, PostOrder1, UsesRemaining1, UsesRestriction1, Restrictions1, PromotionSchedule, PromotionAction, PromotionAuthor, Visibility, PromotionDateMeta, PromotionListItem, PromotionsResult, PromotionAdd, PromotionAddResult, PromotionUpdate, PromotionUpdateResult, PromotionPartialUpdate, ActivePromosResult, Charges, DeliveryCharges, CartMetaConfigUpdate, CartMetaConfigAdd, Article, PriceAdjustmentRestrictions, Collection, PriceAdjustmentUpdate, PriceAdjustment, PriceAdjustmentResult, GetPriceAdjustmentResult, PriceAdjustmentAdd, DistributionRule, Distribution, DistributionLogic, CartItem, OpenapiCartDetailsCreation, CouponBreakup, DisplayBreakup, LoyaltyPoints, RawBreakup, CartBreakup, ProductImage, Tags, BaseInfo, ActionQuery, ProductActionParams, ProductActionPage, ProductAction, CategoryInfo, CartProduct, BasePrice, ArticlePriceInfo, StoreInfo, FulfillmentOptionSchema, StoreTimingSchema, StoreHoursSchema, PickupStoreDetailSchema, ProductArticle, Ownership2, DiscountRulesApp, AppliedFreeArticles, BuyRules, AppliedPromotion, PromiseFormatted, PromiseISOFormat, PromiseTimestamp, ShipmentPromise, CouponDetails, ProductPrice, ProductPriceInfo, ProductMaxQuantityInfo, CartProductIdentifer, ProductAvailabilitySize, ProductAvailability, PromoMeta, CartProductInfo, OpenapiCartDetailsResult, OpenApiErrorResult, ShippingAddress, OpenApiCartServiceabilityCreation, OpenApiCartServiceabilityResult, OpenApiFiles, CartItemMeta, MultiTenderPaymentMeta, MultiTenderPaymentMethod, OpenApiOrderItem, OpenApiPlatformCheckoutReq, OpenApiCheckoutResult, AbandonedCart, AbandonedCartResult, PaymentSelectionLock, CartCurrency, CartDetailCoupon, ChargesThreshold, DeliveryChargesConfig, CartCommonConfig, PlatformAlternatePickupPerson, CartDetailResult, AddProductCart, AddCartCreation, AddCartDetailResult, CartItemInfo, UpdateProductCart, FreeGiftItemCreation, UpdateCartCreation, UpdateCartDetailResult, OverrideCartItemPromo, OverrideCartItem, OverrideCheckoutReq, OverrideCheckoutResult, GetShareCartLinkCreation, GetShareCartLinkResult, SharedCartDetails, SharedCart, SharedCartResult, CartList, MultiCartResult, UpdateUserCartMapping, UserInfo, UserCartMappingResult, PlatformAddCartDetails, PlatformUpdateCartDetails, DeleteCartDetails, DeleteCartDetailResult, CartItemCountResult, DiscountRules, Coupon, PageCoupon, GetCouponResult, ApplyCouponDetails, GeoLocation, PlatformAddress, ValidationConfig, PlatformGetAddressesDetails, SaveAddressDetails, UpdateAddressDetails, DeleteAddressResult, PlatformSelectCartAddress, ShipmentArticle, PlatformShipmentDetails, PlatformCartShipmentsResult, UpdateCartShipmentItem, UpdateCartShipmentCreation, PlatformCartMetaCreation, CartMetaDetails, CartMetaMissingDetails, StaffCheckout, CustomerDetails, Files, CartCheckoutCustomMeta, OrderTag, PlatformCartCheckoutDetailCreation, CheckCart, CartCheckoutDetails, CartCheckoutResult, CartDeliveryModesDetails, PickupStoreDetail, StoreDetails, CartPaymentUpdate, CouponValidity, PaymentCouponValidate, PaymentMeta, PaymentMethod, PlatformCartCheckoutDetailV2Creation, UpdateCartPaymentRequestV2, PriceMinMax, ItemPriceDetails, ArticlePriceDetails, FreeGiftItems, PromotionOffer, PromotionOffersDetails, PromotionPaymentOffer, PromotionPaymentOffersDetails, ValidationError, OrderingSource };
 }
 /** @returns {CouponDateMeta} */
 declare function CouponDateMeta(): CouponDateMeta;
@@ -2789,7 +2856,7 @@ type CouponAdd = {
 declare function Page(): Page;
 type Page = {
     /**
-     * - The total number of items on the page.
+     * - The total number of all items across all pages.
      */
     item_total?: number;
     /**
@@ -4647,6 +4714,91 @@ type StoreInfo = {
      */
     store_code?: string;
 };
+/** @returns {FulfillmentOptionSchema} */
+declare function FulfillmentOptionSchema(): FulfillmentOptionSchema;
+type FulfillmentOptionSchema = {
+    /**
+     * - Unique identifier for the delivery type.
+     */
+    slug?: string;
+    /**
+     * - Description of the delivery service.
+     */
+    description?: string;
+    /**
+     * - Indicates if this is the default delivery option.
+     */
+    is_default?: boolean;
+    /**
+     * - Unique ID of the delivery service.
+     */
+    id?: string;
+    /**
+     * - Type of fulfillment option.
+     */
+    type?: string;
+    /**
+     * - Name of the delivery service.
+     */
+    name?: string;
+};
+/** @returns {StoreTimingSchema} */
+declare function StoreTimingSchema(): StoreTimingSchema;
+type StoreTimingSchema = {
+    /**
+     * - The hour of the store in 24-hour format (e.g., 9 for 9 AM).
+     */
+    hour?: number;
+    /**
+     * - The minute of the store (e.g., 30 for 9:30 AM).
+     */
+    minute?: number;
+};
+/** @returns {StoreHoursSchema} */
+declare function StoreHoursSchema(): StoreHoursSchema;
+type StoreHoursSchema = {
+    /**
+     * - The day of the week (e.g., "Monday", "Tuesday").
+     */
+    weekday?: string;
+    opening?: StoreTimingSchema;
+    closing?: StoreTimingSchema;
+    /**
+     * - Indicates whether the store is open on the
+     * specified weekday.
+     */
+    open?: boolean;
+};
+/** @returns {PickupStoreDetailSchema} */
+declare function PickupStoreDetailSchema(): PickupStoreDetailSchema;
+type PickupStoreDetailSchema = {
+    /**
+     * - A unique identifier for the store.
+     */
+    store_id?: number;
+    /**
+     * - The name of the store or pickup location.
+     */
+    name?: string;
+    /**
+     * - The postal code of the store's location.
+     */
+    pincode?: string;
+    /**
+     * - The distance between the store and the
+     * customer's location.
+     */
+    distance?: number;
+    /**
+     * - The full address of the store.
+     */
+    address?: string;
+    /**
+     * - The store's operational hours for each day
+     * of the week.
+     */
+    store_hours?: any;
+};
 /** @returns {ProductArticle} */
 declare function ProductArticle(): ProductArticle;
 type ProductArticle = {
@@ -4727,6 +4879,12 @@ type ProductArticle = {
      */
     size?: string;
     store?: StoreInfo;
+    fulfillment_option?: FulfillmentOptionSchema;
+    pickup_store_detail?: PickupStoreDetailSchema;
+    /**
+     * - Specify the index of article in cart.
+     */
+    item_index?: number;
     /**
      * - A list of article tags
      */
@@ -5797,6 +5955,32 @@ declare function CartCommonConfig(): CartCommonConfig;
 type CartCommonConfig = {
     delivery_charges_config?: DeliveryChargesConfig;
 };
+/** @returns {PlatformAlternatePickupPerson} */
+declare function PlatformAlternatePickupPerson(): PlatformAlternatePickupPerson;
+type PlatformAlternatePickupPerson = {
+    /**
+     * - Indicates whether an alternate pickup person
+     * is enabled.
+     */
+    enabled?: boolean;
+    /**
+     * - Name of the alternate pickup person.
+     */
+    name?: string;
+    /**
+     * - Email address of the alternate pickup person.
+     */
+    email?: string;
+    /**
+     * - Phone number of the alternate pickup person.
+     */
+    phone?: string;
+    /**
+     * - Country phone code of the alternate
+     * pickup person (e.g., "+91").
+     */
+    country_phone_code?: string;
+};
 /** @returns {CartDetailResult} */
 declare function CartDetailResult(): CartDetailResult;
 type CartDetailResult = {
@@ -5902,6 +6086,7 @@ type CartDetailResult = {
      * checkout API payload
      */
     custom_cart_meta?: any;
+    alternate_pickup_person?: PlatformAlternatePickupPerson;
     /**
      * - Determines if the cart
      * has available promotion free gift items to choose on its added items
@@ -5985,6 +6170,16 @@ type AddProductCart = {
      * - Add items using seller identifier for store os
      */
     seller_identifier?: string;
+    /**
+     * - Specifies the fulfillment
+     * method, indicating whether an order is for home delivery or store pickup
+     */
+    fulfillment_option_slug?: string;
+    /**
+     * - Unique identifier of the pickup store
+     * selected by the user from which user wants to pickup the product.
+     */
+    pickup_store_id?: number;
 };
 /** @returns {AddCartCreation} */
 declare function AddCartCreation(): AddCartCreation;
@@ -6101,6 +6296,16 @@ type UpdateProductCart = {
      * - Article id of the product in cart
      */
     article_id?: string;
+    /**
+     * - Specifies the fulfillment
+     * method, indicating whether an order is for home delivery or store pickup
+     */
+    fulfillment_option_slug?: string;
+    /**
+     * - Unique identifier of the pickup store
+     * selected by the user from which user
+     */
+    pickup_store_id?: number;
 };
 /** @returns {FreeGiftItemCreation} */
 declare function FreeGiftItemCreation(): FreeGiftItemCreation;
@@ -6701,6 +6906,15 @@ type CartItemCountResult = {
      */
     user_cart_items_count?: number;
 };
+/** @returns {DiscountRules} */
+declare function DiscountRules(): DiscountRules;
+type DiscountRules = {
+    /**
+     * - Discount will be reflected in the
+     * cart upon adding the product.
+     */
+    discounted_price?: number;
+};
 /** @returns {Coupon} */
 declare function Coupon(): Coupon;
 type Coupon = {
@@ -6709,6 +6923,10 @@ type Coupon = {
      * of the coupon
      */
     title?: string;
+    /**
+     * - Discount rules of coupons
+     */
+    rule?: DiscountRules[];
     /**
      * - Maximum discount value of the
      * coupon applied to cart
@@ -7117,6 +7335,7 @@ type PlatformShipmentDetails = {
      * - List of articles in shipment
      */
     articles?: ShipmentArticle[];
+    fulfillment_option?: FulfillmentOptionSchema;
 };
 /** @returns {PlatformCartShipmentsResult} */
 declare function PlatformCartShipmentsResult(): PlatformCartShipmentsResult;
@@ -7230,6 +7449,11 @@ type UpdateCartShipmentItem = {
      * - Article unique id for shipment
      */
     article_uid: string;
+    /**
+     * - Item index determines the position in the
+     * list where the product should be updated.
+     */
+    item_index?: number;
 };
 /** @returns {UpdateCartShipmentCreation} */
 declare function UpdateCartShipmentCreation(): UpdateCartShipmentCreation;
@@ -7253,6 +7477,7 @@ type PlatformCartMetaCreation = {
      * customer pickup at store
      */
     pick_up_customer_details?: any;
+    alternate_pickup_person?: PlatformAlternatePickupPerson;
     /**
      * - Checkout mode of user cart
      */
@@ -7794,6 +8019,11 @@ type PaymentMeta = {
      * selected to do the payment
      */
     merchant_code?: string;
+    /**
+     * - Previous bag IDs for which an
+     * exchange has been performed.
+     */
+    payment_source_bag_id?: string[];
 };
 /** @returns {PaymentMethod} */
 declare function PaymentMethod(): PaymentMethod;