@gofynd/fdk-client-javascript 3.9.0 → 3.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -234,7 +234,7 @@ console.log("Active Theme: ", response.information.name);
234
234
  The above code will log the curl command in the console
235
235
 
236
236
  ```bash
237
- curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 3.9.0' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
237
+ curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 3.11.0' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
238
238
  Active Theme: Emerge
239
239
  ```
240
240
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@gofynd/fdk-client-javascript",
3
- "version": "3.9.0",
3
+ "version": "3.11.0",
4
4
  "description": "",
5
5
  "main": "index.js",
6
6
  "scripts": {
@@ -47,6 +47,7 @@ export namespace AVAILABLE_PAGE_TYPE {
47
47
  const RETURN_POLICY: string;
48
48
  const ORDER_STATUS: string;
49
49
  const LOCATE_US: string;
50
+ const SINGLE_PAGE_CHECKOUT: string;
50
51
  }
51
52
  export const NAVIGATORS: {
52
53
  "about-us": {
@@ -301,4 +302,8 @@ export const NAVIGATORS: {
301
302
  name: string;
302
303
  link: string;
303
304
  };
305
+ "single-page-checkout": {
306
+ name: string;
307
+ link: string;
308
+ };
304
309
  };
@@ -47,6 +47,7 @@ const AVAILABLE_PAGE_TYPE = {
47
47
  RETURN_POLICY: "return-policy",
48
48
  ORDER_STATUS: "order-status",
49
49
  LOCATE_US: "locate-us",
50
+ SINGLE_PAGE_CHECKOUT: "single-page-checkout",
50
51
  };
51
52
 
52
53
  Object.freeze(AVAILABLE_PAGE_TYPE);
@@ -334,6 +335,10 @@ const NAVIGATORS = {
334
335
  name: "Locate us",
335
336
  link: "/locate-us",
336
337
  },
338
+ "single-page-checkout": {
339
+ name: "Single Page Checkout",
340
+ link: "/cart/checkout",
341
+ },
337
342
  };
338
343
 
339
344
  module.exports = {
@@ -673,7 +673,8 @@ export = ThemePartnerModel;
673
673
  * | "shipping-policy"
674
674
  * | "return-policy"
675
675
  * | "order-status"
676
- * | "locate-us"} PageType
676
+ * | "locate-us"
677
+ * | "single-page-checkout"} PageType
677
678
  */
678
679
  declare class ThemePartnerModel {
679
680
  }
@@ -1895,4 +1896,4 @@ type ActionPage = {
1895
1896
  * @returns {PageType}
1896
1897
  */
1897
1898
  declare function PageType(): PageType;
1898
- type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-emails" | "profile-phones" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us";
1899
+ type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-emails" | "profile-phones" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us" | "single-page-checkout";
@@ -765,7 +765,8 @@ const Joi = require("joi");
765
765
  * | "shipping-policy"
766
766
  * | "return-policy"
767
767
  * | "order-status"
768
- * | "locate-us"} PageType
768
+ * | "locate-us"
769
+ * | "single-page-checkout"} PageType
769
770
  */
770
771
 
771
772
  class ThemePartnerModel {
@@ -1774,7 +1775,9 @@ class ThemePartnerModel {
1774
1775
 
1775
1776
  "order-status",
1776
1777
 
1777
- "locate-us"
1778
+ "locate-us",
1779
+
1780
+ "single-page-checkout"
1778
1781
  );
1779
1782
  }
1780
1783
  }
@@ -331,8 +331,8 @@ export = CartPlatformModel;
331
331
  * @property {CompareObject} [cart_quantity]
332
332
  * @property {string[]} [available_zones] - List of all zones on which promotion
333
333
  * is applicable
334
- * @property {number[]} [item_exclude_company] - List of all company id on which
335
- * promotion is not applicable
334
+ * @property {number[]} [item_exclude_company] - List of all company ids on
335
+ * which promotion is not applicable
336
336
  * @property {number[]} [item_id] - List of all item ids on which promotion is applicable
337
337
  * @property {number[]} [item_l1_category] - List of all L1 category on which
338
338
  * promotion is applicable
@@ -353,8 +353,8 @@ export = CartPlatformModel;
353
353
  * promotion is not applicable
354
354
  * @property {number[]} [item_department] - List of all departments ids on which
355
355
  * promotion is applicable
356
- * @property {number[]} [item_exclude_store] - List of all item store ids on
357
- * which promotion is not applicable
356
+ * @property {number[]} [item_exclude_store] - List of all store ids on which
357
+ * promotion is not applicable
358
358
  * @property {number[]} [item_brand] - List of all brand ids on which promotion
359
359
  * is applicable
360
360
  * @property {number[]} [item_exclude_department] - List of all department ids
@@ -377,10 +377,46 @@ export = CartPlatformModel;
377
377
  * @property {string[]} [item_sku] - List of all item sku on which promotion is applicable
378
378
  * @property {ItemSizeMapping} [meta]
379
379
  */
380
+ /**
381
+ * @typedef DiscountItemCriteria
382
+ * @property {number[]} [item_store] - List of all store ids on which promotion
383
+ * is applicable
384
+ * @property {number[]} [item_company] - List of all company ids on which
385
+ * promotion is applicable
386
+ * @property {number[]} [item_brand] - List of all brand ids on which promotion
387
+ * is applicable
388
+ * @property {number[]} [item_exclude_brand] - List of all brand ids on which
389
+ * promotion is not applicable
390
+ * @property {number[]} [item_category] - List of all L3 category on which
391
+ * promotion is applicable
392
+ * @property {number[]} [item_exclude_category] - List of all L3 category on
393
+ * which promotion is not applicable
394
+ * @property {number[]} [item_l1_category] - List of all L1 category on which
395
+ * promotion is applicable
396
+ * @property {number[]} [item_exclude_l1_category] - List of all item ids on
397
+ * which promotion is not applicable
398
+ * @property {number[]} [item_l2_category] - List of all L2 category on which
399
+ * promotion is applicable
400
+ * @property {number[]} [item_exclude_l2_category] - List of all L2 category on
401
+ * which promotion is not applicable
402
+ * @property {number[]} [item_department] - List of all departments ids on which
403
+ * promotion is applicable
404
+ * @property {number[]} [item_exclude_department] - List of all department ids
405
+ * on which promotion is not applicable
406
+ * @property {number[]} [item_id] - List of all item ids on which promotion is applicable
407
+ * @property {number[]} [item_exclude_id] - List of all item ids on which
408
+ * promotion is not applicable
409
+ * @property {string[]} [buy_rules] - Buy rules that apply to this discount
410
+ * @property {string[]} [available_zones] - List of all zones ids on which
411
+ * promotion is applicable
412
+ * @property {string[]} [product_tags] - Product tags that qualify for the discount
413
+ * @property {boolean} [all_items] - Whether the discount applies to all items
414
+ */
380
415
  /**
381
416
  * @typedef DiscountOffer
382
417
  * @property {number} [max_discount_amount] - Maximum discount amount in promotion
383
- * @property {number} [discount_price] - Discount price in promotion
418
+ * @property {number} [discount_price] - Discount price which is price after
419
+ * deducting discount amount in fixed price promotion
384
420
  * @property {boolean} [apportion_discount] - Flag to distribute discount for each article
385
421
  * @property {boolean} [partial_can_ret] - Flag indicated return the product partially
386
422
  * @property {number} [max_usage_per_transaction] - Maximum usage per
@@ -390,6 +426,8 @@ export = CartPlatformModel;
390
426
  * @property {number} [discount_amount] - Discount amount in promotion
391
427
  * @property {number} [discount_percentage] - Discount percentage in promotion
392
428
  * @property {number} [max_offer_quantity] - Maximum quantity of product in promotion
429
+ * @property {number} [item_sequence_number] - Cart sequence number of item for
430
+ * which offer is valid
393
431
  */
394
432
  /**
395
433
  * @typedef DiscountRule
@@ -730,7 +768,6 @@ export = CartPlatformModel;
730
768
  * @property {Object} [meta] - Meta data related to article
731
769
  * @property {boolean} [allowed_refund] - Flag indicating whether refunds are
732
770
  * allowed at article level
733
- * @property {number} [article_index] - Index of the line item in the cart
734
771
  * @property {number} [min_price_threshold] - Minimum allowed net price for the
735
772
  * article. If the article's price after all discounts and adjustments falls
736
773
  * below this threshold, the price adjustment will be automatically removed.
@@ -2440,17 +2477,30 @@ export = CartPlatformModel;
2440
2477
  * @property {string} [size] - Selected size for the free gift item.
2441
2478
  * @property {string[]} [item_images_url] - List of free gift product images URL
2442
2479
  */
2480
+ /**
2481
+ * @typedef DiscountOfferRule
2482
+ * @property {string} [discount_type] - Discount offer type of the promotion
2483
+ * @property {DiscountOffer} [offer]
2484
+ * @property {DiscountItemCriteria} [item_criteria]
2485
+ * @property {string} [buy_condition] - Logical condition expression for buy rules
2486
+ * @property {number} [discounted_price] - Price of product after applying this
2487
+ * discount rule of promotion. Note - returned only when store id is provided
2488
+ * in request params.
2489
+ * @property {string[]} [matched_buy_rules] - List of buy rules that are
2490
+ * matching with item for this promotion
2491
+ * @property {ItemSizeMapping} [meta]
2492
+ */
2443
2493
  /**
2444
2494
  * @typedef PromotionOffer
2445
2495
  * @property {string} [id] - Promotion unique identifier
2446
- * @property {Object} [buy_rules] - Buy rules of promotions
2496
+ * @property {BuyRuleItemCriteria} [buy_rules]
2447
2497
  * @property {string} [offer_text] - Offer title of promotion that used to display
2448
2498
  * @property {string} [promotion_type] - Type of Promotion like percentage,
2449
2499
  * amount, bogo etc.
2450
2500
  * @property {string} [promotion_name] - Name of the promotion
2451
2501
  * @property {string} [promotion_group] - Group of promotion belongs to
2452
2502
  * @property {string} [valid_till] - Datetime ISOString for promotion end date
2453
- * @property {Object[]} [discount_rules] - Discount rules of promotions
2503
+ * @property {DiscountOfferRule[]} [discount_rules] - Discount rules of promotions
2454
2504
  * @property {FreeGiftItems[]} [free_gift_items] - Details of free gift items
2455
2505
  * @property {string} [description] - Offer details including T&C
2456
2506
  */
@@ -2496,7 +2546,7 @@ export = CartPlatformModel;
2496
2546
  declare class CartPlatformModel {
2497
2547
  }
2498
2548
  declare namespace CartPlatformModel {
2499
- export { RedeemLoyaltyPoints, 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, BuyRuleItemCriteria, 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, OverrideCheckoutData, 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 };
2549
+ export { RedeemLoyaltyPoints, 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, BuyRuleItemCriteria, DiscountItemCriteria, 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, OverrideCheckoutData, 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, DiscountOfferRule, PromotionOffer, PromotionOffersDetails, PromotionPaymentOffer, PromotionPaymentOffersDetails, ValidationError, OrderingSource };
2500
2550
  }
2501
2551
  /** @returns {RedeemLoyaltyPoints} */
2502
2552
  declare function RedeemLoyaltyPoints(): RedeemLoyaltyPoints;
@@ -3287,8 +3337,8 @@ type BuyRuleItemCriteria = {
3287
3337
  */
3288
3338
  available_zones?: string[];
3289
3339
  /**
3290
- * - List of all company id on which
3291
- * promotion is not applicable
3340
+ * - List of all company ids on
3341
+ * which promotion is not applicable
3292
3342
  */
3293
3343
  item_exclude_company?: number[];
3294
3344
  /**
@@ -3339,8 +3389,8 @@ type BuyRuleItemCriteria = {
3339
3389
  */
3340
3390
  item_department?: number[];
3341
3391
  /**
3342
- * - List of all item store ids on
3343
- * which promotion is not applicable
3392
+ * - List of all store ids on which
3393
+ * promotion is not applicable
3344
3394
  */
3345
3395
  item_exclude_store?: number[];
3346
3396
  /**
@@ -3395,6 +3445,96 @@ type BuyRuleItemCriteria = {
3395
3445
  item_sku?: string[];
3396
3446
  meta?: ItemSizeMapping;
3397
3447
  };
3448
+ /** @returns {DiscountItemCriteria} */
3449
+ declare function DiscountItemCriteria(): DiscountItemCriteria;
3450
+ type DiscountItemCriteria = {
3451
+ /**
3452
+ * - List of all store ids on which promotion
3453
+ * is applicable
3454
+ */
3455
+ item_store?: number[];
3456
+ /**
3457
+ * - List of all company ids on which
3458
+ * promotion is applicable
3459
+ */
3460
+ item_company?: number[];
3461
+ /**
3462
+ * - List of all brand ids on which promotion
3463
+ * is applicable
3464
+ */
3465
+ item_brand?: number[];
3466
+ /**
3467
+ * - List of all brand ids on which
3468
+ * promotion is not applicable
3469
+ */
3470
+ item_exclude_brand?: number[];
3471
+ /**
3472
+ * - List of all L3 category on which
3473
+ * promotion is applicable
3474
+ */
3475
+ item_category?: number[];
3476
+ /**
3477
+ * - List of all L3 category on
3478
+ * which promotion is not applicable
3479
+ */
3480
+ item_exclude_category?: number[];
3481
+ /**
3482
+ * - List of all L1 category on which
3483
+ * promotion is applicable
3484
+ */
3485
+ item_l1_category?: number[];
3486
+ /**
3487
+ * - List of all item ids on
3488
+ * which promotion is not applicable
3489
+ */
3490
+ item_exclude_l1_category?: number[];
3491
+ /**
3492
+ * - List of all L2 category on which
3493
+ * promotion is applicable
3494
+ */
3495
+ item_l2_category?: number[];
3496
+ /**
3497
+ * - List of all L2 category on
3498
+ * which promotion is not applicable
3499
+ */
3500
+ item_exclude_l2_category?: number[];
3501
+ /**
3502
+ * - List of all departments ids on which
3503
+ * promotion is applicable
3504
+ */
3505
+ item_department?: number[];
3506
+ /**
3507
+ * - List of all department ids
3508
+ * on which promotion is not applicable
3509
+ */
3510
+ item_exclude_department?: number[];
3511
+ /**
3512
+ * - List of all item ids on which promotion is applicable
3513
+ */
3514
+ item_id?: number[];
3515
+ /**
3516
+ * - List of all item ids on which
3517
+ * promotion is not applicable
3518
+ */
3519
+ item_exclude_id?: number[];
3520
+ /**
3521
+ * - Buy rules that apply to this discount
3522
+ */
3523
+ buy_rules?: string[];
3524
+ /**
3525
+ * - List of all zones ids on which
3526
+ * promotion is applicable
3527
+ */
3528
+ available_zones?: string[];
3529
+ /**
3530
+ * - Product tags that qualify for the discount
3531
+ */
3532
+ product_tags?: string[];
3533
+ /**
3534
+ * - Whether the discount applies to all items
3535
+ */
3536
+ all_items?: boolean;
3537
+ };
3398
3538
  /** @returns {DiscountOffer} */
3399
3539
  declare function DiscountOffer(): DiscountOffer;
3400
3540
  type DiscountOffer = {
@@ -3403,7 +3543,8 @@ type DiscountOffer = {
3403
3543
  */
3404
3544
  max_discount_amount?: number;
3405
3545
  /**
3406
- * - Discount price in promotion
3546
+ * - Discount price which is price after
3547
+ * deducting discount amount in fixed price promotion
3407
3548
  */
3408
3549
  discount_price?: number;
3409
3550
  /**
@@ -3439,6 +3580,11 @@ type DiscountOffer = {
3439
3580
  * - Maximum quantity of product in promotion
3440
3581
  */
3441
3582
  max_offer_quantity?: number;
3583
+ /**
3584
+ * - Cart sequence number of item for
3585
+ * which offer is valid
3586
+ */
3587
+ item_sequence_number?: number;
3442
3588
  };
3443
3589
  /** @returns {DiscountRule} */
3444
3590
  declare function DiscountRule(): DiscountRule;
@@ -4279,10 +4425,6 @@ type Article = {
4279
4425
  * allowed at article level
4280
4426
  */
4281
4427
  allowed_refund?: boolean;
4282
- /**
4283
- * - Index of the line item in the cart
4284
- */
4285
- article_index?: number;
4286
4428
  /**
4287
4429
  * - Minimum allowed net price for the
4288
4430
  * article. If the article's price after all discounts and adjustments falls
@@ -8619,6 +8761,32 @@ type FreeGiftItems = {
8619
8761
  */
8620
8762
  item_images_url?: string[];
8621
8763
  };
8764
+ /** @returns {DiscountOfferRule} */
8765
+ declare function DiscountOfferRule(): DiscountOfferRule;
8766
+ type DiscountOfferRule = {
8767
+ /**
8768
+ * - Discount offer type of the promotion
8769
+ */
8770
+ discount_type?: string;
8771
+ offer?: DiscountOffer;
8772
+ item_criteria?: DiscountItemCriteria;
8773
+ /**
8774
+ * - Logical condition expression for buy rules
8775
+ */
8776
+ buy_condition?: string;
8777
+ /**
8778
+ * - Price of product after applying this
8779
+ * discount rule of promotion. Note - returned only when store id is provided
8780
+ * in request params.
8781
+ */
8782
+ discounted_price?: number;
8783
+ /**
8784
+ * - List of buy rules that are
8785
+ * matching with item for this promotion
8786
+ */
8787
+ matched_buy_rules?: string[];
8788
+ meta?: ItemSizeMapping;
8789
+ };
8622
8790
  /** @returns {PromotionOffer} */
8623
8791
  declare function PromotionOffer(): PromotionOffer;
8624
8792
  type PromotionOffer = {
@@ -8626,10 +8794,7 @@ type PromotionOffer = {
8626
8794
  * - Promotion unique identifier
8627
8795
  */
8628
8796
  id?: string;
8629
- /**
8630
- * - Buy rules of promotions
8631
- */
8632
- buy_rules?: any;
8797
+ buy_rules?: BuyRuleItemCriteria;
8633
8798
  /**
8634
8799
  * - Offer title of promotion that used to display
8635
8800
  */
@@ -8654,7 +8819,7 @@ type PromotionOffer = {
8654
8819
  /**
8655
8820
  * - Discount rules of promotions
8656
8821
  */
8657
- discount_rules?: any[];
8822
+ discount_rules?: DiscountOfferRule[];
8658
8823
  /**
8659
8824
  * - Details of free gift items
8660
8825
  */
@@ -367,8 +367,8 @@ const Joi = require("joi");
367
367
  * @property {CompareObject} [cart_quantity]
368
368
  * @property {string[]} [available_zones] - List of all zones on which promotion
369
369
  * is applicable
370
- * @property {number[]} [item_exclude_company] - List of all company id on which
371
- * promotion is not applicable
370
+ * @property {number[]} [item_exclude_company] - List of all company ids on
371
+ * which promotion is not applicable
372
372
  * @property {number[]} [item_id] - List of all item ids on which promotion is applicable
373
373
  * @property {number[]} [item_l1_category] - List of all L1 category on which
374
374
  * promotion is applicable
@@ -389,8 +389,8 @@ const Joi = require("joi");
389
389
  * promotion is not applicable
390
390
  * @property {number[]} [item_department] - List of all departments ids on which
391
391
  * promotion is applicable
392
- * @property {number[]} [item_exclude_store] - List of all item store ids on
393
- * which promotion is not applicable
392
+ * @property {number[]} [item_exclude_store] - List of all store ids on which
393
+ * promotion is not applicable
394
394
  * @property {number[]} [item_brand] - List of all brand ids on which promotion
395
395
  * is applicable
396
396
  * @property {number[]} [item_exclude_department] - List of all department ids
@@ -414,10 +414,47 @@ const Joi = require("joi");
414
414
  * @property {ItemSizeMapping} [meta]
415
415
  */
416
416
 
417
+ /**
418
+ * @typedef DiscountItemCriteria
419
+ * @property {number[]} [item_store] - List of all store ids on which promotion
420
+ * is applicable
421
+ * @property {number[]} [item_company] - List of all company ids on which
422
+ * promotion is applicable
423
+ * @property {number[]} [item_brand] - List of all brand ids on which promotion
424
+ * is applicable
425
+ * @property {number[]} [item_exclude_brand] - List of all brand ids on which
426
+ * promotion is not applicable
427
+ * @property {number[]} [item_category] - List of all L3 category on which
428
+ * promotion is applicable
429
+ * @property {number[]} [item_exclude_category] - List of all L3 category on
430
+ * which promotion is not applicable
431
+ * @property {number[]} [item_l1_category] - List of all L1 category on which
432
+ * promotion is applicable
433
+ * @property {number[]} [item_exclude_l1_category] - List of all item ids on
434
+ * which promotion is not applicable
435
+ * @property {number[]} [item_l2_category] - List of all L2 category on which
436
+ * promotion is applicable
437
+ * @property {number[]} [item_exclude_l2_category] - List of all L2 category on
438
+ * which promotion is not applicable
439
+ * @property {number[]} [item_department] - List of all departments ids on which
440
+ * promotion is applicable
441
+ * @property {number[]} [item_exclude_department] - List of all department ids
442
+ * on which promotion is not applicable
443
+ * @property {number[]} [item_id] - List of all item ids on which promotion is applicable
444
+ * @property {number[]} [item_exclude_id] - List of all item ids on which
445
+ * promotion is not applicable
446
+ * @property {string[]} [buy_rules] - Buy rules that apply to this discount
447
+ * @property {string[]} [available_zones] - List of all zones ids on which
448
+ * promotion is applicable
449
+ * @property {string[]} [product_tags] - Product tags that qualify for the discount
450
+ * @property {boolean} [all_items] - Whether the discount applies to all items
451
+ */
452
+
417
453
  /**
418
454
  * @typedef DiscountOffer
419
455
  * @property {number} [max_discount_amount] - Maximum discount amount in promotion
420
- * @property {number} [discount_price] - Discount price in promotion
456
+ * @property {number} [discount_price] - Discount price which is price after
457
+ * deducting discount amount in fixed price promotion
421
458
  * @property {boolean} [apportion_discount] - Flag to distribute discount for each article
422
459
  * @property {boolean} [partial_can_ret] - Flag indicated return the product partially
423
460
  * @property {number} [max_usage_per_transaction] - Maximum usage per
@@ -427,6 +464,8 @@ const Joi = require("joi");
427
464
  * @property {number} [discount_amount] - Discount amount in promotion
428
465
  * @property {number} [discount_percentage] - Discount percentage in promotion
429
466
  * @property {number} [max_offer_quantity] - Maximum quantity of product in promotion
467
+ * @property {number} [item_sequence_number] - Cart sequence number of item for
468
+ * which offer is valid
430
469
  */
431
470
 
432
471
  /**
@@ -793,7 +832,6 @@ const Joi = require("joi");
793
832
  * @property {Object} [meta] - Meta data related to article
794
833
  * @property {boolean} [allowed_refund] - Flag indicating whether refunds are
795
834
  * allowed at article level
796
- * @property {number} [article_index] - Index of the line item in the cart
797
835
  * @property {number} [min_price_threshold] - Minimum allowed net price for the
798
836
  * article. If the article's price after all discounts and adjustments falls
799
837
  * below this threshold, the price adjustment will be automatically removed.
@@ -2650,17 +2688,31 @@ const Joi = require("joi");
2650
2688
  * @property {string[]} [item_images_url] - List of free gift product images URL
2651
2689
  */
2652
2690
 
2691
+ /**
2692
+ * @typedef DiscountOfferRule
2693
+ * @property {string} [discount_type] - Discount offer type of the promotion
2694
+ * @property {DiscountOffer} [offer]
2695
+ * @property {DiscountItemCriteria} [item_criteria]
2696
+ * @property {string} [buy_condition] - Logical condition expression for buy rules
2697
+ * @property {number} [discounted_price] - Price of product after applying this
2698
+ * discount rule of promotion. Note - returned only when store id is provided
2699
+ * in request params.
2700
+ * @property {string[]} [matched_buy_rules] - List of buy rules that are
2701
+ * matching with item for this promotion
2702
+ * @property {ItemSizeMapping} [meta]
2703
+ */
2704
+
2653
2705
  /**
2654
2706
  * @typedef PromotionOffer
2655
2707
  * @property {string} [id] - Promotion unique identifier
2656
- * @property {Object} [buy_rules] - Buy rules of promotions
2708
+ * @property {BuyRuleItemCriteria} [buy_rules]
2657
2709
  * @property {string} [offer_text] - Offer title of promotion that used to display
2658
2710
  * @property {string} [promotion_type] - Type of Promotion like percentage,
2659
2711
  * amount, bogo etc.
2660
2712
  * @property {string} [promotion_name] - Name of the promotion
2661
2713
  * @property {string} [promotion_group] - Group of promotion belongs to
2662
2714
  * @property {string} [valid_till] - Datetime ISOString for promotion end date
2663
- * @property {Object[]} [discount_rules] - Discount rules of promotions
2715
+ * @property {DiscountOfferRule[]} [discount_rules] - Discount rules of promotions
2664
2716
  * @property {FreeGiftItems[]} [free_gift_items] - Details of free gift items
2665
2717
  * @property {string} [description] - Offer details including T&C
2666
2718
  */
@@ -3138,6 +3190,30 @@ class CartPlatformModel {
3138
3190
  });
3139
3191
  }
3140
3192
 
3193
+ /** @returns {DiscountItemCriteria} */
3194
+ static DiscountItemCriteria() {
3195
+ return Joi.object({
3196
+ item_store: Joi.array().items(Joi.number()),
3197
+ item_company: Joi.array().items(Joi.number()),
3198
+ item_brand: Joi.array().items(Joi.number()),
3199
+ item_exclude_brand: Joi.array().items(Joi.number()),
3200
+ item_category: Joi.array().items(Joi.number()),
3201
+ item_exclude_category: Joi.array().items(Joi.number()),
3202
+ item_l1_category: Joi.array().items(Joi.number()),
3203
+ item_exclude_l1_category: Joi.array().items(Joi.number()),
3204
+ item_l2_category: Joi.array().items(Joi.number()),
3205
+ item_exclude_l2_category: Joi.array().items(Joi.number()),
3206
+ item_department: Joi.array().items(Joi.number()),
3207
+ item_exclude_department: Joi.array().items(Joi.number()),
3208
+ item_id: Joi.array().items(Joi.number()),
3209
+ item_exclude_id: Joi.array().items(Joi.number()),
3210
+ buy_rules: Joi.array().items(Joi.string().allow("")),
3211
+ available_zones: Joi.array().items(Joi.string().allow("")),
3212
+ product_tags: Joi.array().items(Joi.string().allow("")),
3213
+ all_items: Joi.boolean(),
3214
+ });
3215
+ }
3216
+
3141
3217
  /** @returns {DiscountOffer} */
3142
3218
  static DiscountOffer() {
3143
3219
  return Joi.object({
@@ -3145,12 +3221,13 @@ class CartPlatformModel {
3145
3221
  discount_price: Joi.number(),
3146
3222
  apportion_discount: Joi.boolean(),
3147
3223
  partial_can_ret: Joi.boolean(),
3148
- max_usage_per_transaction: Joi.number().allow(null),
3224
+ max_usage_per_transaction: Joi.number(),
3149
3225
  min_offer_quantity: Joi.number(),
3150
3226
  code: Joi.string().allow(""),
3151
3227
  discount_amount: Joi.number(),
3152
3228
  discount_percentage: Joi.number(),
3153
3229
  max_offer_quantity: Joi.number(),
3230
+ item_sequence_number: Joi.number(),
3154
3231
  });
3155
3232
  }
3156
3233
 
@@ -3526,7 +3603,6 @@ class CartPlatformModel {
3526
3603
  quantity: Joi.number(),
3527
3604
  meta: Joi.object().pattern(/\S/, Joi.any()),
3528
3605
  allowed_refund: Joi.boolean(),
3529
- article_index: Joi.number(),
3530
3606
  min_price_threshold: Joi.number(),
3531
3607
  });
3532
3608
  }
@@ -5410,17 +5486,30 @@ class CartPlatformModel {
5410
5486
  });
5411
5487
  }
5412
5488
 
5489
+ /** @returns {DiscountOfferRule} */
5490
+ static DiscountOfferRule() {
5491
+ return Joi.object({
5492
+ discount_type: Joi.string().allow(""),
5493
+ offer: CartPlatformModel.DiscountOffer(),
5494
+ item_criteria: CartPlatformModel.DiscountItemCriteria(),
5495
+ buy_condition: Joi.string().allow(""),
5496
+ discounted_price: Joi.number(),
5497
+ matched_buy_rules: Joi.array().items(Joi.string().allow("")),
5498
+ meta: CartPlatformModel.ItemSizeMapping(),
5499
+ });
5500
+ }
5501
+
5413
5502
  /** @returns {PromotionOffer} */
5414
5503
  static PromotionOffer() {
5415
5504
  return Joi.object({
5416
5505
  id: Joi.string().allow(""),
5417
- buy_rules: Joi.object().pattern(/\S/, Joi.any()),
5506
+ buy_rules: CartPlatformModel.BuyRuleItemCriteria(),
5418
5507
  offer_text: Joi.string().allow(""),
5419
5508
  promotion_type: Joi.string().allow(""),
5420
5509
  promotion_name: Joi.string().allow(""),
5421
5510
  promotion_group: Joi.string().allow(""),
5422
5511
  valid_till: Joi.string().allow(""),
5423
- discount_rules: Joi.array().items(Joi.any()),
5512
+ discount_rules: Joi.array().items(CartPlatformModel.DiscountOfferRule()),
5424
5513
  free_gift_items: Joi.array().items(CartPlatformModel.FreeGiftItems()),
5425
5514
  description: Joi.string().allow(""),
5426
5515
  });
@@ -4793,7 +4793,8 @@ export = CatalogPlatformModel;
4793
4793
  * | "shipping-policy"
4794
4794
  * | "return-policy"
4795
4795
  * | "order-status"
4796
- * | "locate-us"} PageType
4796
+ * | "locate-us"
4797
+ * | "single-page-checkout"} PageType
4797
4798
  */
4798
4799
  declare class CatalogPlatformModel {
4799
4800
  }
@@ -15104,4 +15105,4 @@ type HsTypeEnum = "HS" | "SAC";
15104
15105
  * @returns {PageType}
15105
15106
  */
15106
15107
  declare function PageType(): PageType;
15107
- type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-emails" | "profile-phones" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us";
15108
+ type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-emails" | "profile-phones" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us" | "single-page-checkout";
@@ -5242,7 +5242,8 @@ const Joi = require("joi");
5242
5242
  * | "shipping-policy"
5243
5243
  * | "return-policy"
5244
5244
  * | "order-status"
5245
- * | "locate-us"} PageType
5245
+ * | "locate-us"
5246
+ * | "single-page-checkout"} PageType
5246
5247
  */
5247
5248
 
5248
5249
  class CatalogPlatformModel {
@@ -10860,7 +10861,9 @@ class CatalogPlatformModel {
10860
10861
 
10861
10862
  "order-status",
10862
10863
 
10863
- "locate-us"
10864
+ "locate-us",
10865
+
10866
+ "single-page-checkout"
10864
10867
  );
10865
10868
  }
10866
10869
  }
@@ -400,10 +400,12 @@ export = CompanyProfilePlatformModel;
400
400
  */
401
401
  /**
402
402
  * @typedef LocationSchema
403
- * @property {string} code
403
+ * @property {string} code - A unique identifier for the store location. Must be
404
+ * a non-empty string with a maximum length of 100 characters.
404
405
  * @property {InvoiceDetailsSchema} [gst_credentials]
405
406
  * @property {SellerPhoneNumber[]} [contact_numbers]
406
- * @property {string} name
407
+ * @property {string} name - The value of the name. Should be a non-empty string
408
+ * and length should not exceed 300 characters.
407
409
  * @property {Object} [_custom_json]
408
410
  * @property {Object} [warnings]
409
411
  * @property {AddressSchema} address
@@ -418,7 +420,8 @@ export = CompanyProfilePlatformModel;
418
420
  * @property {boolean} [credit_note]
419
421
  * @property {HolidaySchemaSchema[]} [holiday]
420
422
  * @property {ProductReturnConfigSchema} [product_return_config]
421
- * @property {string} display_name
423
+ * @property {string} display_name - The value of the display_name. Should be a
424
+ * non-empty string and length should not exceed 300 characters.
422
425
  * @property {string[]} [notification_emails]
423
426
  * @property {string[]} [tags]
424
427
  * @property {boolean} [default_order_acceptance_timing] - Flag to set
@@ -921,9 +924,17 @@ type AddressSchema = {
921
924
  /** @returns {LocationSchema} */
922
925
  declare function LocationSchema(): LocationSchema;
923
926
  type LocationSchema = {
927
+ /**
928
+ * - A unique identifier for the store location. Must be
929
+ * a non-empty string with a maximum length of 100 characters.
930
+ */
924
931
  code: string;
925
932
  gst_credentials?: InvoiceDetailsSchema;
926
933
  contact_numbers?: SellerPhoneNumber[];
934
+ /**
935
+ * - The value of the name. Should be a non-empty string
936
+ * and length should not exceed 300 characters.
937
+ */
927
938
  name: string;
928
939
  _custom_json?: any;
929
940
  warnings?: any;
@@ -939,6 +950,10 @@ type LocationSchema = {
939
950
  credit_note?: boolean;
940
951
  holiday?: HolidaySchemaSchema[];
941
952
  product_return_config?: ProductReturnConfigSchema;
953
+ /**
954
+ * - The value of the display_name. Should be a
955
+ * non-empty string and length should not exceed 300 characters.
956
+ */
942
957
  display_name: string;
943
958
  notification_emails?: string[];
944
959
  tags?: string[];
@@ -442,10 +442,12 @@ const Joi = require("joi");
442
442
 
443
443
  /**
444
444
  * @typedef LocationSchema
445
- * @property {string} code
445
+ * @property {string} code - A unique identifier for the store location. Must be
446
+ * a non-empty string with a maximum length of 100 characters.
446
447
  * @property {InvoiceDetailsSchema} [gst_credentials]
447
448
  * @property {SellerPhoneNumber[]} [contact_numbers]
448
- * @property {string} name
449
+ * @property {string} name - The value of the name. Should be a non-empty string
450
+ * and length should not exceed 300 characters.
449
451
  * @property {Object} [_custom_json]
450
452
  * @property {Object} [warnings]
451
453
  * @property {AddressSchema} address
@@ -460,7 +462,8 @@ const Joi = require("joi");
460
462
  * @property {boolean} [credit_note]
461
463
  * @property {HolidaySchemaSchema[]} [holiday]
462
464
  * @property {ProductReturnConfigSchema} [product_return_config]
463
- * @property {string} display_name
465
+ * @property {string} display_name - The value of the display_name. Should be a
466
+ * non-empty string and length should not exceed 300 characters.
464
467
  * @property {string[]} [notification_emails]
465
468
  * @property {string[]} [tags]
466
469
  * @property {boolean} [default_order_acceptance_timing] - Flag to set
@@ -1552,7 +1552,8 @@ export = ContentPlatformModel;
1552
1552
  * | "shipping-policy"
1553
1553
  * | "return-policy"
1554
1554
  * | "order-status"
1555
- * | "locate-us"} PageType
1555
+ * | "locate-us"
1556
+ * | "single-page-checkout"} PageType
1556
1557
  */
1557
1558
  declare class ContentPlatformModel {
1558
1559
  }
@@ -4409,4 +4410,4 @@ type GenerationEntityType = "title" | "description";
4409
4410
  * @returns {PageType}
4410
4411
  */
4411
4412
  declare function PageType(): PageType;
4412
- type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-emails" | "profile-phones" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us";
4413
+ type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-emails" | "profile-phones" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us" | "single-page-checkout";
@@ -1747,7 +1747,8 @@ const Joi = require("joi");
1747
1747
  * | "shipping-policy"
1748
1748
  * | "return-policy"
1749
1749
  * | "order-status"
1750
- * | "locate-us"} PageType
1750
+ * | "locate-us"
1751
+ * | "single-page-checkout"} PageType
1751
1752
  */
1752
1753
 
1753
1754
  class ContentPlatformModel {
@@ -3897,7 +3898,9 @@ class ContentPlatformModel {
3897
3898
 
3898
3899
  "order-status",
3899
3900
 
3900
- "locate-us"
3901
+ "locate-us",
3902
+
3903
+ "single-page-checkout"
3901
3904
  );
3902
3905
  }
3903
3906
  }
@@ -796,7 +796,7 @@ declare class Order {
796
796
  *
797
797
  * @name updateShipmentStatus
798
798
  * @summary: Update a shipment's status
799
- * @description: It is used for updating the shipment in the following scenarios:\n• Full Confirmation\n• Partial Confirmation\n• Change the status of a shipment\n• Full Cancellation\n• Partial Cancellation\n• Assign the shipment to DP. Click <a href=\"https://docs.fynd.com/partners/commerce/miscellaneous/updateShipmentStatus\">here</a> to get the example payload. Also, refer to the <a href=\"https://docs.fynd.com/partners/commerce/getting-started/oms-states/\">OMS Sates</a> for the complete status list. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updateShipmentStatus/).
799
+ * @description: It is used for updating the shipment in the following scenarios: Full Confirmation, Partial Confirmation, Change the status of a shipment, Full Cancellation, Partial Cancellation, Assign the shipment to DP. Click <a href='/commerce/miscellaneous/updateShipmentStatus'>here</a> to get the example payload. Also, refer to the <a href='/commerce/getting-started/oms-states/'>OMS States</a> for the complete status list. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updateShipmentStatus/).
800
800
  */
801
801
  updateShipmentStatus({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdateShipmentStatusResponseBody>;
802
802
  /**
@@ -5251,7 +5251,7 @@ class Order {
5251
5251
  *
5252
5252
  * @name updateShipmentStatus
5253
5253
  * @summary: Update a shipment's status
5254
- * @description: It is used for updating the shipment in the following scenarios:\n• Full Confirmation\n• Partial Confirmation\n• Change the status of a shipment\n• Full Cancellation\n• Partial Cancellation\n• Assign the shipment to DP. Click <a href=\"https://docs.fynd.com/partners/commerce/miscellaneous/updateShipmentStatus\">here</a> to get the example payload. Also, refer to the <a href=\"https://docs.fynd.com/partners/commerce/getting-started/oms-states/\">OMS Sates</a> for the complete status list. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updateShipmentStatus/).
5254
+ * @description: It is used for updating the shipment in the following scenarios: Full Confirmation, Partial Confirmation, Change the status of a shipment, Full Cancellation, Partial Cancellation, Assign the shipment to DP. Click <a href='/commerce/miscellaneous/updateShipmentStatus'>here</a> to get the example payload. Also, refer to the <a href='/commerce/getting-started/oms-states/'>OMS States</a> for the complete status list. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updateShipmentStatus/).
5255
5255
  */
5256
5256
  async updateShipmentStatus(
5257
5257
  { body, requestHeaders } = { requestHeaders: {} },
@@ -901,6 +901,7 @@ export = OrderPlatformModel;
901
901
  * @property {string} [ordering_channel_logo]
902
902
  * @property {Prices} [prices]
903
903
  * @property {PriceAdjustmentCharge[]} [charges]
904
+ * @property {LoyaltyDiscountDetails} [loyalty_discount_details]
904
905
  */
905
906
  /**
906
907
  * @typedef Meta
@@ -2815,6 +2816,8 @@ export = OrderPlatformModel;
2815
2816
  * used in the transaction.
2816
2817
  * @property {number} [amount_to_be_collected] - Total amount to be collected in
2817
2818
  * scenarios involving multiple payment methods.
2819
+ * @property {number} [loyalty_discount] - Amount reduced from the payable price
2820
+ * when the customer applies loyalty program points while placing the order.
2818
2821
  */
2819
2822
  /**
2820
2823
  * @typedef ChargeDistributionSchema
@@ -2897,6 +2900,8 @@ export = OrderPlatformModel;
2897
2900
  * purchased by the customer, usable for future transactions.
2898
2901
  * @property {number} [amount_to_be_collected] - Amount to be collected from the
2899
2902
  * customer when multiple payment methods are utilized for a single order.
2903
+ * @property {number} [loyalty_discount] - Amount reduced from the payable price
2904
+ * when the customer applies loyalty program points while placing the order.
2900
2905
  */
2901
2906
  /**
2902
2907
  * @typedef Identifier
@@ -2988,6 +2993,8 @@ export = OrderPlatformModel;
2988
2993
  * @property {boolean} added_to_fynd_cash - Indicates whether the amount has
2989
2994
  * been added to Fynd cash for future use.
2990
2995
  * @property {TaxComponent[]} [taxes] - Applied Tax Components
2996
+ * @property {number} [loyalty_discount] - Amount reduced from the payable price
2997
+ * when the customer applies loyalty program points while placing the order.
2991
2998
  */
2992
2999
  /**
2993
3000
  * @typedef GSTDetailsData
@@ -3541,6 +3548,16 @@ export = OrderPlatformModel;
3541
3548
  * @property {Object} [links] - An object containing additional links relevant
3542
3549
  * to the invoice, which may include related documents or resources.
3543
3550
  */
3551
+ /**
3552
+ * @typedef LoyaltyDiscountDetails
3553
+ * @property {number} [discount] - Discount amount applied by redeeming loyalty
3554
+ * points while placing the order. Represents the monetary value of loyalty
3555
+ * points redeemed.
3556
+ * @property {string} [ownership] - Indicates who bears the cost of the loyalty
3557
+ * discount, such as the seller or the marketplace.
3558
+ * @property {boolean} [is_applied] - Specifies whether the loyalty discount has
3559
+ * been applied to the order.
3560
+ */
3544
3561
  /**
3545
3562
  * @typedef OrderDetailsData
3546
3563
  * @property {string} [order_date] - Represents the date and time when the order
@@ -3570,6 +3587,7 @@ export = OrderPlatformModel;
3570
3587
  * Please use ordering_source instead to ensure accurate order tracking and processing.
3571
3588
  * @property {string} [ordering_source] - To uniquely identify the source
3572
3589
  * through which order has been placed (e.g, marketplace, gofynd).
3590
+ * @property {LoyaltyDiscountDetails} [loyalty_discount_details]
3573
3591
  * @property {Object} [meta] - Meta data of the order contains additional,
3574
3592
  * potentially dynamic information about the order.
3575
3593
  */
@@ -4369,6 +4387,7 @@ export = OrderPlatformModel;
4369
4387
  * is created, including mobile applications, web interfaces, social media
4370
4388
  * integrations, or external APIs.
4371
4389
  * @property {CurrencySchema} [currency]
4390
+ * @property {LoyaltyDiscountDetails} [loyalty_discount_details]
4372
4391
  */
4373
4392
  /**
4374
4393
  * @typedef OrderDetailsResponseSchema
@@ -4437,6 +4456,7 @@ export = OrderPlatformModel;
4437
4456
  * @property {CurrencyInfo} [currency_info]
4438
4457
  * @property {Prices} [prices]
4439
4458
  * @property {OrderingCurrencyPrices} [ordering_currency_prices]
4459
+ * @property {LoyaltyDiscountDetails} [loyalty_discount_details]
4440
4460
  */
4441
4461
  /**
4442
4462
  * @typedef OrderListingResponseSchema
@@ -5100,7 +5120,7 @@ export = OrderPlatformModel;
5100
5120
  declare class OrderPlatformModel {
5101
5121
  }
5102
5122
  declare namespace OrderPlatformModel {
5103
- export { InvalidateShipmentCachePayload, InvalidateShipmentCacheNestedResponseSchema, InvalidateShipmentCacheResponseSchema, UpdatePackingErrorResponseSchema, ErrorResponseSchema, StoreReassign, StoreReassignResponseSchema, LockManagerEntities, UpdateShipmentLockPayload, OriginalFilter, Bags, CheckResponseSchema, UpdateShipmentLockResponseSchema, AnnouncementResponseSchema, AnnouncementsResponseSchema, BaseResponseSchema, ErrorDetail, ProductsReasonsFilters, ProductsReasonsData, ProductsReasons, EntityReasonData, EntitiesReasons, ReasonsData, Products, OrderItemDataUpdates, ProductsDataUpdatesFilters, ProductsDataUpdates, EntitiesDataUpdates, OrderDataUpdates, SellerQCDetailsSchema, EntityStatusDataSchema, DataUpdatesFiltersSchema, EntityStatusDataUpdates, DataUpdates, TransitionComments, ShipmentsRequestSchema, UpdatedAddressSchema, UpdateAddressRequestBody, StatuesRequestSchema, UpdateShipmentStatusRequestSchema, ShipmentsResponseSchema, DPConfiguration, PaymentConfig, LockStateMessage, CreateOrderConfig, StatuesResponseSchema, UpdateShipmentStatusResponseBody, OrderUser, OrderPriority, ArticleDetails, LocationDetails, ShipmentDetails, ShipmentConfig, ShipmentData, MarketPlacePdf, AffiliateBag, UserData, OrderInfo, AffiliateAppConfigMeta, AffiliateAppConfig, AffiliateInventoryArticleAssignmentConfig, AffiliateInventoryPaymentConfig, AffiliateInventoryStoreConfig, AffiliateInventoryOrderConfig, AffiliateInventoryLogisticsConfig, AffiliateInventoryConfig, AffiliateConfig, Affiliate, AffiliateStoreIdMapping, OrderConfig, CreateOrderResponseSchema, DispatchManifest, SuccessResponseSchema, ActionInfo, GetActionsResponseSchema, HistoryReason, RefundInformation, HistoryMeta, HistoryDict, ShipmentHistoryResponseSchema, PostHistoryFilters, PostHistoryData, PostHistoryDict, PostShipmentHistory, SmsDataPayload, SendSmsPayload, OrderDetails, Meta, ShipmentDetail, OrderStatusData, OrderStatusResult, SendSmsResponseSchema, Dimension, UpdatePackagingDimensionsPayload, UpdatePackagingDimensionsResponseSchema, Tax, AmountSchema, Charge, LineItem, ProcessingDates, Tag, ProcessAfterConfig, SystemMessages, Shipment, GeoLocationSchema, ShippingInfo, BillingInfo, UserInfo, TaxInfo, PaymentMethod, PaymentInfo, CreateOrderAPI, CreateOrderErrorReponse, PaymentMethods, CreateChannelPaymentInfo, CreateChannelConfig, CreateChannelConfigData, CreateChannelConifgErrorResponseSchema, UploadManifestConsent, CreateChannelConfigResponseSchema, PlatformOrderUpdate, ResponseDetail, FyndOrderIdList, OrderStatus, BagStateTransitionMap, RoleBaseStateTransitionMapping, FetchCreditBalanceRequestPayload, CreditBalanceInfo, FetchCreditBalanceResponsePayload, RefundModeConfigRequestPayload, RefundOption, RefundModeFormat, RefundModeInfo, RefundModeConfigResponsePayload, AttachUserOtpData, AttachUserInfo, AttachOrderUser, AttachOrderUserResponseSchema, SendUserMobileOTP, PointBlankOtpData, SendUserMobileOtpResponseSchema, VerifyOtpData, VerifyMobileOTP, VerifyOtpResponseData, VerifyOtpResponseSchema, BulkReportsFiltersSchema, BulkReportsDownloadRequestSchema, BulkReportsDownloadResponseSchema, APIFailedResponseSchema, BulkStateTransistionRequestSchema, BulkStateTransistionResponseSchema, ShipmentActionInfo, BulkActionListingData, BulkListinPage, BulkListingResponseSchema, JobDetailsData, JobDetailsResponseSchema, JobFailedResponseSchema, ManifestPageInfo, ManifestItemDetails, ManifestShipmentListing, DateRange, Filters, ManifestFile, ManifestMediaUpdate, PDFMeta, TotalShipmentPricesCount, ManifestMeta, Manifest, ManifestList, ManifestDetails, FiltersRequestSchema, ProcessManifest, ProcessManifestResponseSchema, ProcessManifestItemResponseSchema, FilterInfoOption, FiltersInfo, ManifestFiltersResponseSchema, PageDetails, EInvoiceIrnDetails, EInvoiceErrorDetails, EInvoiceDetails, EInvoiceResponseData, EInvoiceRetry, EInvoiceRetryResponseSchema, EInvoiceErrorInfo, EInvoiceErrorResponseData, EInvoiceErrorResponseSchema, EInvoiceErrorResponseDetails, EInvoiceRetryShipmentData, CourierPartnerTrackingDetails, CourierPartnerTrackingResponseSchema, LogsChannelDetails, LogPaymentDetails, FailedOrdersItem, FailedOrderLogs, FailedOrderLogDetails, GenerateInvoiceIDResponseData, GenerateInvoiceIDErrorResponseData, GenerateInvoiceIDRequestSchema, GenerateInvoiceIDResponseSchema, GenerateInvoiceIDErrorResponseSchema, ManifestResponseSchema, ProcessManifestRequestSchema, ManifestItems, ManifestErrorResponseSchema, ConfigData, ConfigUpdatedResponseSchema, FlagData, Flags, Filter, PostHook, PreHook, Config, TransitionConfigCondition, TransitionConfigData, TransitionConfigPayload, RuleListRequestSchema, RuleErrorResponseSchema, RMAPageInfo, RuleAction, QuestionSetItem, Reason, Conditions, RuleItem, RuleError, RuleListResponseSchema, UpdateShipmentPaymentMode, CommonErrorResponseSchema, ExceptionErrorResponseSchema, ProductSchema, PaymentMethodSchema, ActionDetailSchema, PaymentMetaDataSchema, PaymentMetaLogoURLSchema, ValidationError, Page, BagReasonMeta, QuestionSet, BagReasons, ShipmentBagReasons, ShipmentStatus, UserDataInfo, Address, ShipmentListingChannel, Prices, ChargeDistributionSchema, ChargeDistributionLogic, ChargeAmountCurrency, ChargeAmount, PriceAdjustmentCharge, OrderingCurrencyPrices, Identifier, TaxComponent, FinancialBreakup, GSTDetailsData, BagStateMapper, BagStatusHistory, Dimensions, ReturnConfig, Weight, Article, ShipmentListingBrand, ReplacementDetails, AffiliateMeta, AffiliateBagDetails, PlatformArticleAttributes, PlatformItem, Dates, BagReturnableCancelableStatus, BagUnit, ShipmentItemFulFillingStore, Currency, OrderingCurrency, ConversionRate, CurrencyInfo, ShipmentItem, ShipmentInternalPlatformViewResponseSchema, TrackingList, InvoiceInfo, OrderDetailsData, UserDetailsData, PhoneDetails, ContactDetails, CompanyDetails, OrderingStoreDetails, DPDetailsData, BuyerDetails, DebugInfo, EinvoiceInfo, Formatted, ShipmentTags, LockData, ShipmentTimeStamp, ShipmentMeta, PDFLinks, AffiliateDetails, BagConfigs, OrderBagArticle, OrderBrandName, AffiliateBagsDetails, BagPaymentMethods, DiscountRules, ItemCriterias, BuyRules, PriceMinMax, ItemPriceDetails, FreeGiftItems, AppliedFreeArticles, AppliedPromos, CurrentStatus, OrderBags, FulfillingStore, ShipmentPayments, ShipmentStatusData, ShipmentLockDetails, FulfillmentOption, PlatformShipment, ShipmentInfoResponseSchema, TaxDetails, PaymentInfoData, CurrencySchema, OrderData, OrderDetailsResponseSchema, SubLane, SuperLane, LaneConfigResponseSchema, PlatformBreakupValues, PlatformChannel, PlatformOrderItems, OrderListingResponseSchema, PlatformTrack, PlatformShipmentTrack, AdvanceFilterInfo, FiltersResponseSchema, URL, FileResponseSchema, BulkActionTemplate, BulkActionTemplateResponseSchema, PlatformShipmentReasonsResponseSchema, ShipmentResponseReasons, ShipmentReasonsResponseSchema, StoreAddress, EInvoicePortalDetails, StoreEinvoice, StoreEwaybill, StoreGstCredentials, Document, StoreDocuments, StoreMeta, Store, Brand, Item, ArticleStatusDetails, Company, ShipmentGstDetails, DeliverySlotDetails, InvoiceDetails, UserDetails, WeightData, BagDetails, BagDetailsPlatformResponseSchema, BagsPage, BagData, GetBagsPlatformResponseSchema, GeneratePosOrderReceiptResponseSchema, Templates, AllowedTemplatesResponseSchema, TemplateDownloadResponseSchema, Error, BulkFailedResponseSchema, OrderingSource };
5123
+ export { InvalidateShipmentCachePayload, InvalidateShipmentCacheNestedResponseSchema, InvalidateShipmentCacheResponseSchema, UpdatePackingErrorResponseSchema, ErrorResponseSchema, StoreReassign, StoreReassignResponseSchema, LockManagerEntities, UpdateShipmentLockPayload, OriginalFilter, Bags, CheckResponseSchema, UpdateShipmentLockResponseSchema, AnnouncementResponseSchema, AnnouncementsResponseSchema, BaseResponseSchema, ErrorDetail, ProductsReasonsFilters, ProductsReasonsData, ProductsReasons, EntityReasonData, EntitiesReasons, ReasonsData, Products, OrderItemDataUpdates, ProductsDataUpdatesFilters, ProductsDataUpdates, EntitiesDataUpdates, OrderDataUpdates, SellerQCDetailsSchema, EntityStatusDataSchema, DataUpdatesFiltersSchema, EntityStatusDataUpdates, DataUpdates, TransitionComments, ShipmentsRequestSchema, UpdatedAddressSchema, UpdateAddressRequestBody, StatuesRequestSchema, UpdateShipmentStatusRequestSchema, ShipmentsResponseSchema, DPConfiguration, PaymentConfig, LockStateMessage, CreateOrderConfig, StatuesResponseSchema, UpdateShipmentStatusResponseBody, OrderUser, OrderPriority, ArticleDetails, LocationDetails, ShipmentDetails, ShipmentConfig, ShipmentData, MarketPlacePdf, AffiliateBag, UserData, OrderInfo, AffiliateAppConfigMeta, AffiliateAppConfig, AffiliateInventoryArticleAssignmentConfig, AffiliateInventoryPaymentConfig, AffiliateInventoryStoreConfig, AffiliateInventoryOrderConfig, AffiliateInventoryLogisticsConfig, AffiliateInventoryConfig, AffiliateConfig, Affiliate, AffiliateStoreIdMapping, OrderConfig, CreateOrderResponseSchema, DispatchManifest, SuccessResponseSchema, ActionInfo, GetActionsResponseSchema, HistoryReason, RefundInformation, HistoryMeta, HistoryDict, ShipmentHistoryResponseSchema, PostHistoryFilters, PostHistoryData, PostHistoryDict, PostShipmentHistory, SmsDataPayload, SendSmsPayload, OrderDetails, Meta, ShipmentDetail, OrderStatusData, OrderStatusResult, SendSmsResponseSchema, Dimension, UpdatePackagingDimensionsPayload, UpdatePackagingDimensionsResponseSchema, Tax, AmountSchema, Charge, LineItem, ProcessingDates, Tag, ProcessAfterConfig, SystemMessages, Shipment, GeoLocationSchema, ShippingInfo, BillingInfo, UserInfo, TaxInfo, PaymentMethod, PaymentInfo, CreateOrderAPI, CreateOrderErrorReponse, PaymentMethods, CreateChannelPaymentInfo, CreateChannelConfig, CreateChannelConfigData, CreateChannelConifgErrorResponseSchema, UploadManifestConsent, CreateChannelConfigResponseSchema, PlatformOrderUpdate, ResponseDetail, FyndOrderIdList, OrderStatus, BagStateTransitionMap, RoleBaseStateTransitionMapping, FetchCreditBalanceRequestPayload, CreditBalanceInfo, FetchCreditBalanceResponsePayload, RefundModeConfigRequestPayload, RefundOption, RefundModeFormat, RefundModeInfo, RefundModeConfigResponsePayload, AttachUserOtpData, AttachUserInfo, AttachOrderUser, AttachOrderUserResponseSchema, SendUserMobileOTP, PointBlankOtpData, SendUserMobileOtpResponseSchema, VerifyOtpData, VerifyMobileOTP, VerifyOtpResponseData, VerifyOtpResponseSchema, BulkReportsFiltersSchema, BulkReportsDownloadRequestSchema, BulkReportsDownloadResponseSchema, APIFailedResponseSchema, BulkStateTransistionRequestSchema, BulkStateTransistionResponseSchema, ShipmentActionInfo, BulkActionListingData, BulkListinPage, BulkListingResponseSchema, JobDetailsData, JobDetailsResponseSchema, JobFailedResponseSchema, ManifestPageInfo, ManifestItemDetails, ManifestShipmentListing, DateRange, Filters, ManifestFile, ManifestMediaUpdate, PDFMeta, TotalShipmentPricesCount, ManifestMeta, Manifest, ManifestList, ManifestDetails, FiltersRequestSchema, ProcessManifest, ProcessManifestResponseSchema, ProcessManifestItemResponseSchema, FilterInfoOption, FiltersInfo, ManifestFiltersResponseSchema, PageDetails, EInvoiceIrnDetails, EInvoiceErrorDetails, EInvoiceDetails, EInvoiceResponseData, EInvoiceRetry, EInvoiceRetryResponseSchema, EInvoiceErrorInfo, EInvoiceErrorResponseData, EInvoiceErrorResponseSchema, EInvoiceErrorResponseDetails, EInvoiceRetryShipmentData, CourierPartnerTrackingDetails, CourierPartnerTrackingResponseSchema, LogsChannelDetails, LogPaymentDetails, FailedOrdersItem, FailedOrderLogs, FailedOrderLogDetails, GenerateInvoiceIDResponseData, GenerateInvoiceIDErrorResponseData, GenerateInvoiceIDRequestSchema, GenerateInvoiceIDResponseSchema, GenerateInvoiceIDErrorResponseSchema, ManifestResponseSchema, ProcessManifestRequestSchema, ManifestItems, ManifestErrorResponseSchema, ConfigData, ConfigUpdatedResponseSchema, FlagData, Flags, Filter, PostHook, PreHook, Config, TransitionConfigCondition, TransitionConfigData, TransitionConfigPayload, RuleListRequestSchema, RuleErrorResponseSchema, RMAPageInfo, RuleAction, QuestionSetItem, Reason, Conditions, RuleItem, RuleError, RuleListResponseSchema, UpdateShipmentPaymentMode, CommonErrorResponseSchema, ExceptionErrorResponseSchema, ProductSchema, PaymentMethodSchema, ActionDetailSchema, PaymentMetaDataSchema, PaymentMetaLogoURLSchema, ValidationError, Page, BagReasonMeta, QuestionSet, BagReasons, ShipmentBagReasons, ShipmentStatus, UserDataInfo, Address, ShipmentListingChannel, Prices, ChargeDistributionSchema, ChargeDistributionLogic, ChargeAmountCurrency, ChargeAmount, PriceAdjustmentCharge, OrderingCurrencyPrices, Identifier, TaxComponent, FinancialBreakup, GSTDetailsData, BagStateMapper, BagStatusHistory, Dimensions, ReturnConfig, Weight, Article, ShipmentListingBrand, ReplacementDetails, AffiliateMeta, AffiliateBagDetails, PlatformArticleAttributes, PlatformItem, Dates, BagReturnableCancelableStatus, BagUnit, ShipmentItemFulFillingStore, Currency, OrderingCurrency, ConversionRate, CurrencyInfo, ShipmentItem, ShipmentInternalPlatformViewResponseSchema, TrackingList, InvoiceInfo, LoyaltyDiscountDetails, OrderDetailsData, UserDetailsData, PhoneDetails, ContactDetails, CompanyDetails, OrderingStoreDetails, DPDetailsData, BuyerDetails, DebugInfo, EinvoiceInfo, Formatted, ShipmentTags, LockData, ShipmentTimeStamp, ShipmentMeta, PDFLinks, AffiliateDetails, BagConfigs, OrderBagArticle, OrderBrandName, AffiliateBagsDetails, BagPaymentMethods, DiscountRules, ItemCriterias, BuyRules, PriceMinMax, ItemPriceDetails, FreeGiftItems, AppliedFreeArticles, AppliedPromos, CurrentStatus, OrderBags, FulfillingStore, ShipmentPayments, ShipmentStatusData, ShipmentLockDetails, FulfillmentOption, PlatformShipment, ShipmentInfoResponseSchema, TaxDetails, PaymentInfoData, CurrencySchema, OrderData, OrderDetailsResponseSchema, SubLane, SuperLane, LaneConfigResponseSchema, PlatformBreakupValues, PlatformChannel, PlatformOrderItems, OrderListingResponseSchema, PlatformTrack, PlatformShipmentTrack, AdvanceFilterInfo, FiltersResponseSchema, URL, FileResponseSchema, BulkActionTemplate, BulkActionTemplateResponseSchema, PlatformShipmentReasonsResponseSchema, ShipmentResponseReasons, ShipmentReasonsResponseSchema, StoreAddress, EInvoicePortalDetails, StoreEinvoice, StoreEwaybill, StoreGstCredentials, Document, StoreDocuments, StoreMeta, Store, Brand, Item, ArticleStatusDetails, Company, ShipmentGstDetails, DeliverySlotDetails, InvoiceDetails, UserDetails, WeightData, BagDetails, BagDetailsPlatformResponseSchema, BagsPage, BagData, GetBagsPlatformResponseSchema, GeneratePosOrderReceiptResponseSchema, Templates, AllowedTemplatesResponseSchema, TemplateDownloadResponseSchema, Error, BulkFailedResponseSchema, OrderingSource };
5104
5124
  }
5105
5125
  /** @returns {InvalidateShipmentCachePayload} */
5106
5126
  declare function InvalidateShipmentCachePayload(): InvalidateShipmentCachePayload;
@@ -6853,6 +6873,7 @@ type OrderDetails = {
6853
6873
  ordering_channel_logo?: string;
6854
6874
  prices?: Prices;
6855
6875
  charges?: PriceAdjustmentCharge[];
6876
+ loyalty_discount_details?: LoyaltyDiscountDetails;
6856
6877
  };
6857
6878
  /** @returns {Meta} */
6858
6879
  declare function Meta(): Meta;
@@ -10815,6 +10836,11 @@ type Prices = {
10815
10836
  * scenarios involving multiple payment methods.
10816
10837
  */
10817
10838
  amount_to_be_collected?: number;
10839
+ /**
10840
+ * - Amount reduced from the payable price
10841
+ * when the customer applies loyalty program points while placing the order.
10842
+ */
10843
+ loyalty_discount?: number;
10818
10844
  };
10819
10845
  /** @returns {ChargeDistributionSchema} */
10820
10846
  declare function ChargeDistributionSchema(): ChargeDistributionSchema;
@@ -10993,6 +11019,11 @@ type OrderingCurrencyPrices = {
10993
11019
  * customer when multiple payment methods are utilized for a single order.
10994
11020
  */
10995
11021
  amount_to_be_collected?: number;
11022
+ /**
11023
+ * - Amount reduced from the payable price
11024
+ * when the customer applies loyalty program points while placing the order.
11025
+ */
11026
+ loyalty_discount?: number;
10996
11027
  };
10997
11028
  /** @returns {Identifier} */
10998
11029
  declare function Identifier(): Identifier;
@@ -11198,6 +11229,11 @@ type FinancialBreakup = {
11198
11229
  * - Applied Tax Components
11199
11230
  */
11200
11231
  taxes?: TaxComponent[];
11232
+ /**
11233
+ * - Amount reduced from the payable price
11234
+ * when the customer applies loyalty program points while placing the order.
11235
+ */
11236
+ loyalty_discount?: number;
11201
11237
  };
11202
11238
  /** @returns {GSTDetailsData} */
11203
11239
  declare function GSTDetailsData(): GSTDetailsData;
@@ -12384,6 +12420,26 @@ type InvoiceInfo = {
12384
12420
  */
12385
12421
  links?: any;
12386
12422
  };
12423
+ /** @returns {LoyaltyDiscountDetails} */
12424
+ declare function LoyaltyDiscountDetails(): LoyaltyDiscountDetails;
12425
+ type LoyaltyDiscountDetails = {
12426
+ /**
12427
+ * - Discount amount applied by redeeming loyalty
12428
+ * points while placing the order. Represents the monetary value of loyalty
12429
+ * points redeemed.
12430
+ */
12431
+ discount?: number;
12432
+ /**
12433
+ * - Indicates who bears the cost of the loyalty
12434
+ * discount, such as the seller or the marketplace.
12435
+ */
12436
+ ownership?: string;
12437
+ /**
12438
+ * - Specifies whether the loyalty discount has
12439
+ * been applied to the order.
12440
+ */
12441
+ is_applied?: boolean;
12442
+ };
12387
12443
  /** @returns {OrderDetailsData} */
12388
12444
  declare function OrderDetailsData(): OrderDetailsData;
12389
12445
  type OrderDetailsData = {
@@ -12450,6 +12506,7 @@ type OrderDetailsData = {
12450
12506
  * through which order has been placed (e.g, marketplace, gofynd).
12451
12507
  */
12452
12508
  ordering_source?: string;
12509
+ loyalty_discount_details?: LoyaltyDiscountDetails;
12453
12510
  /**
12454
12511
  * - Meta data of the order contains additional,
12455
12512
  * potentially dynamic information about the order.
@@ -14151,6 +14208,7 @@ type OrderData = {
14151
14208
  */
14152
14209
  source?: string;
14153
14210
  currency?: CurrencySchema;
14211
+ loyalty_discount_details?: LoyaltyDiscountDetails;
14154
14212
  };
14155
14213
  /** @returns {OrderDetailsResponseSchema} */
14156
14214
  declare function OrderDetailsResponseSchema(): OrderDetailsResponseSchema;
@@ -14262,6 +14320,7 @@ type PlatformOrderItems = {
14262
14320
  currency_info?: CurrencyInfo;
14263
14321
  prices?: Prices;
14264
14322
  ordering_currency_prices?: OrderingCurrencyPrices;
14323
+ loyalty_discount_details?: LoyaltyDiscountDetails;
14265
14324
  };
14266
14325
  /** @returns {OrderListingResponseSchema} */
14267
14326
  declare function OrderListingResponseSchema(): OrderListingResponseSchema;
@@ -988,6 +988,7 @@ const Joi = require("joi");
988
988
  * @property {string} [ordering_channel_logo]
989
989
  * @property {Prices} [prices]
990
990
  * @property {PriceAdjustmentCharge[]} [charges]
991
+ * @property {LoyaltyDiscountDetails} [loyalty_discount_details]
991
992
  */
992
993
 
993
994
  /**
@@ -3061,6 +3062,8 @@ const Joi = require("joi");
3061
3062
  * used in the transaction.
3062
3063
  * @property {number} [amount_to_be_collected] - Total amount to be collected in
3063
3064
  * scenarios involving multiple payment methods.
3065
+ * @property {number} [loyalty_discount] - Amount reduced from the payable price
3066
+ * when the customer applies loyalty program points while placing the order.
3064
3067
  */
3065
3068
 
3066
3069
  /**
@@ -3149,6 +3152,8 @@ const Joi = require("joi");
3149
3152
  * purchased by the customer, usable for future transactions.
3150
3153
  * @property {number} [amount_to_be_collected] - Amount to be collected from the
3151
3154
  * customer when multiple payment methods are utilized for a single order.
3155
+ * @property {number} [loyalty_discount] - Amount reduced from the payable price
3156
+ * when the customer applies loyalty program points while placing the order.
3152
3157
  */
3153
3158
 
3154
3159
  /**
@@ -3243,6 +3248,8 @@ const Joi = require("joi");
3243
3248
  * @property {boolean} added_to_fynd_cash - Indicates whether the amount has
3244
3249
  * been added to Fynd cash for future use.
3245
3250
  * @property {TaxComponent[]} [taxes] - Applied Tax Components
3251
+ * @property {number} [loyalty_discount] - Amount reduced from the payable price
3252
+ * when the customer applies loyalty program points while placing the order.
3246
3253
  */
3247
3254
 
3248
3255
  /**
@@ -3822,6 +3829,17 @@ const Joi = require("joi");
3822
3829
  * to the invoice, which may include related documents or resources.
3823
3830
  */
3824
3831
 
3832
+ /**
3833
+ * @typedef LoyaltyDiscountDetails
3834
+ * @property {number} [discount] - Discount amount applied by redeeming loyalty
3835
+ * points while placing the order. Represents the monetary value of loyalty
3836
+ * points redeemed.
3837
+ * @property {string} [ownership] - Indicates who bears the cost of the loyalty
3838
+ * discount, such as the seller or the marketplace.
3839
+ * @property {boolean} [is_applied] - Specifies whether the loyalty discount has
3840
+ * been applied to the order.
3841
+ */
3842
+
3825
3843
  /**
3826
3844
  * @typedef OrderDetailsData
3827
3845
  * @property {string} [order_date] - Represents the date and time when the order
@@ -3851,6 +3869,7 @@ const Joi = require("joi");
3851
3869
  * Please use ordering_source instead to ensure accurate order tracking and processing.
3852
3870
  * @property {string} [ordering_source] - To uniquely identify the source
3853
3871
  * through which order has been placed (e.g, marketplace, gofynd).
3872
+ * @property {LoyaltyDiscountDetails} [loyalty_discount_details]
3854
3873
  * @property {Object} [meta] - Meta data of the order contains additional,
3855
3874
  * potentially dynamic information about the order.
3856
3875
  */
@@ -4692,6 +4711,7 @@ const Joi = require("joi");
4692
4711
  * is created, including mobile applications, web interfaces, social media
4693
4712
  * integrations, or external APIs.
4694
4713
  * @property {CurrencySchema} [currency]
4714
+ * @property {LoyaltyDiscountDetails} [loyalty_discount_details]
4695
4715
  */
4696
4716
 
4697
4717
  /**
@@ -4767,6 +4787,7 @@ const Joi = require("joi");
4767
4787
  * @property {CurrencyInfo} [currency_info]
4768
4788
  * @property {Prices} [prices]
4769
4789
  * @property {OrderingCurrencyPrices} [ordering_currency_prices]
4790
+ * @property {LoyaltyDiscountDetails} [loyalty_discount_details]
4770
4791
  */
4771
4792
 
4772
4793
  /**
@@ -6432,6 +6453,7 @@ class OrderPlatformModel {
6432
6453
  ordering_channel_logo: Joi.string().allow("").allow(null),
6433
6454
  prices: OrderPlatformModel.Prices(),
6434
6455
  charges: Joi.array().items(OrderPlatformModel.PriceAdjustmentCharge()),
6456
+ loyalty_discount_details: OrderPlatformModel.LoyaltyDiscountDetails(),
6435
6457
  });
6436
6458
  }
6437
6459
 
@@ -8251,6 +8273,7 @@ class OrderPlatformModel {
8251
8273
  fynd_credits: Joi.number().allow(null),
8252
8274
  gift_price: Joi.number().allow(null),
8253
8275
  amount_to_be_collected: Joi.number().allow(null),
8276
+ loyalty_discount: Joi.number(),
8254
8277
  });
8255
8278
  }
8256
8279
 
@@ -8322,6 +8345,7 @@ class OrderPlatformModel {
8322
8345
  fynd_credits: Joi.number().allow(null),
8323
8346
  gift_price: Joi.number().allow(null),
8324
8347
  amount_to_be_collected: Joi.number().allow(null),
8348
+ loyalty_discount: Joi.number(),
8325
8349
  });
8326
8350
  }
8327
8351
 
@@ -8378,6 +8402,7 @@ class OrderPlatformModel {
8378
8402
  total_units: Joi.number().required(),
8379
8403
  added_to_fynd_cash: Joi.boolean().required(),
8380
8404
  taxes: Joi.array().items(OrderPlatformModel.TaxComponent()),
8405
+ loyalty_discount: Joi.number(),
8381
8406
  });
8382
8407
  }
8383
8408
 
@@ -8522,7 +8547,7 @@ class OrderPlatformModel {
8522
8547
  box_type: Joi.string().allow("").allow(null),
8523
8548
  quantity: Joi.number().allow(null),
8524
8549
  size_level_total_qty: Joi.number().allow(null),
8525
- loyalty_discount: Joi.number().allow(null),
8550
+ loyalty_discount: Joi.number(),
8526
8551
  replacement_details: OrderPlatformModel.ReplacementDetails(),
8527
8552
  channel_shipment_id: Joi.string().allow("").allow(null),
8528
8553
  marketplace_invoice_id: Joi.string().allow("").allow(null),
@@ -8542,7 +8567,7 @@ class OrderPlatformModel {
8542
8567
  affiliate_order_id: Joi.string().allow("").required(),
8543
8568
  employee_discount: Joi.number().allow(null),
8544
8569
  affiliate_bag_id: Joi.string().allow("").required(),
8545
- loyalty_discount: Joi.number().allow(null),
8570
+ loyalty_discount: Joi.number(),
8546
8571
  });
8547
8572
  }
8548
8573
 
@@ -8774,6 +8799,15 @@ class OrderPlatformModel {
8774
8799
  });
8775
8800
  }
8776
8801
 
8802
+ /** @returns {LoyaltyDiscountDetails} */
8803
+ static LoyaltyDiscountDetails() {
8804
+ return Joi.object({
8805
+ discount: Joi.number(),
8806
+ ownership: Joi.string().allow(""),
8807
+ is_applied: Joi.boolean(),
8808
+ });
8809
+ }
8810
+
8777
8811
  /** @returns {OrderDetailsData} */
8778
8812
  static OrderDetailsData() {
8779
8813
  return Joi.object({
@@ -8791,6 +8825,7 @@ class OrderPlatformModel {
8791
8825
  order_value: Joi.string().allow("").allow(null),
8792
8826
  ordering_channel: Joi.string().allow("").allow(null),
8793
8827
  ordering_source: Joi.string().allow(""),
8828
+ loyalty_discount_details: OrderPlatformModel.LoyaltyDiscountDetails(),
8794
8829
  meta: Joi.object().pattern(/\S/, Joi.any()),
8795
8830
  });
8796
8831
  }
@@ -9426,6 +9461,7 @@ class OrderPlatformModel {
9426
9461
  affiliate_id: Joi.string().allow(""),
9427
9462
  source: Joi.string().allow(""),
9428
9463
  currency: OrderPlatformModel.CurrencySchema(),
9464
+ loyalty_discount_details: OrderPlatformModel.LoyaltyDiscountDetails(),
9429
9465
  });
9430
9466
  }
9431
9467
 
@@ -9503,6 +9539,7 @@ class OrderPlatformModel {
9503
9539
  currency_info: OrderPlatformModel.CurrencyInfo(),
9504
9540
  prices: OrderPlatformModel.Prices(),
9505
9541
  ordering_currency_prices: OrderPlatformModel.OrderingCurrencyPrices(),
9542
+ loyalty_discount_details: OrderPlatformModel.LoyaltyDiscountDetails(),
9506
9543
  });
9507
9544
  }
9508
9545
 
@@ -601,7 +601,8 @@ export = ThemePlatformModel;
601
601
  * | "shipping-policy"
602
602
  * | "return-policy"
603
603
  * | "order-status"
604
- * | "locate-us"} PageType
604
+ * | "locate-us"
605
+ * | "single-page-checkout"} PageType
605
606
  */
606
607
  declare class ThemePlatformModel {
607
608
  }
@@ -1664,4 +1665,4 @@ type ActionPage = {
1664
1665
  * @returns {PageType}
1665
1666
  */
1666
1667
  declare function PageType(): PageType;
1667
- type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-emails" | "profile-phones" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us";
1668
+ type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-emails" | "profile-phones" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status" | "locate-us" | "single-page-checkout";
@@ -684,7 +684,8 @@ const Joi = require("joi");
684
684
  * | "shipping-policy"
685
685
  * | "return-policy"
686
686
  * | "order-status"
687
- * | "locate-us"} PageType
687
+ * | "locate-us"
688
+ * | "single-page-checkout"} PageType
688
689
  */
689
690
 
690
691
  class ThemePlatformModel {
@@ -1592,7 +1593,9 @@ class ThemePlatformModel {
1592
1593
 
1593
1594
  "order-status",
1594
1595
 
1595
- "locate-us"
1596
+ "locate-us",
1597
+
1598
+ "single-page-checkout"
1596
1599
  );
1597
1600
  }
1598
1601
  }
@@ -399,7 +399,7 @@ export = UserPlatformModel;
399
399
  */
400
400
  /**
401
401
  * @typedef CreateUserRequestSchema
402
- * @property {string} phone_number
402
+ * @property {string} [phone_number]
403
403
  * @property {string} [email]
404
404
  * @property {string} [first_name]
405
405
  * @property {string} [last_name]
@@ -1487,7 +1487,7 @@ type CreateUserGroup = {
1487
1487
  /** @returns {CreateUserRequestSchema} */
1488
1488
  declare function CreateUserRequestSchema(): CreateUserRequestSchema;
1489
1489
  type CreateUserRequestSchema = {
1490
- phone_number: string;
1490
+ phone_number?: string;
1491
1491
  email?: string;
1492
1492
  first_name?: string;
1493
1493
  last_name?: string;
@@ -446,7 +446,7 @@ const Joi = require("joi");
446
446
 
447
447
  /**
448
448
  * @typedef CreateUserRequestSchema
449
- * @property {string} phone_number
449
+ * @property {string} [phone_number]
450
450
  * @property {string} [email]
451
451
  * @property {string} [first_name]
452
452
  * @property {string} [last_name]
@@ -1266,7 +1266,7 @@ class UserPlatformModel {
1266
1266
  /** @returns {CreateUserRequestSchema} */
1267
1267
  static CreateUserRequestSchema() {
1268
1268
  return Joi.object({
1269
- phone_number: Joi.string().allow("").required(),
1269
+ phone_number: Joi.string().allow(""),
1270
1270
  email: Joi.string().allow(""),
1271
1271
  first_name: Joi.string().allow(""),
1272
1272
  last_name: Joi.string().allow(""),
package/utility.d.ts ADDED
@@ -0,0 +1,3 @@
1
+ import Utility = require("./sdk/common/Utility");
2
+ import Constant = require("./sdk/common/Constant");
3
+ export { Utility, Constant };
package/utility.js ADDED
@@ -0,0 +1,7 @@
1
+ const Utility = require('./sdk/common/Utility');
2
+ const Constant = require('./sdk/common/Constant');
3
+
4
+ module.exports = {
5
+ Utility,
6
+ Constant,
7
+ };