@gofynd/fdk-client-javascript 3.14.0 → 3.16.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.
Files changed (69) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Order/OrderApplicationClient.d.ts +11 -1
  4. package/sdk/application/Order/OrderApplicationClient.js +50 -1
  5. package/sdk/application/Payment/PaymentApplicationClient.d.ts +0 -20
  6. package/sdk/application/Payment/PaymentApplicationClient.js +0 -77
  7. package/sdk/common/Constant.d.ts +13 -4
  8. package/sdk/common/Constant.js +17 -6
  9. package/sdk/partner/Lead/LeadPartnerModel.d.ts +2 -2
  10. package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
  11. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +2 -2
  12. package/sdk/partner/Logistics/LogisticsPartnerModel.js +1 -1
  13. package/sdk/partner/Theme/ThemePartnerModel.d.ts +5 -4
  14. package/sdk/partner/Theme/ThemePartnerModel.js +9 -6
  15. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +2 -2
  16. package/sdk/partner/Webhook/WebhookPartnerModel.js +1 -1
  17. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +2 -2
  18. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +1 -1
  19. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +10 -0
  20. package/sdk/platform/Cart/CartPlatformApplicationClient.js +95 -0
  21. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +47 -1
  22. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +29 -0
  23. package/sdk/platform/Cart/CartPlatformModel.d.ts +17 -3
  24. package/sdk/platform/Cart/CartPlatformModel.js +14 -1
  25. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +3 -3
  26. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +13 -16
  27. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +17 -20
  28. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +10 -11
  29. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +2 -2
  30. package/sdk/platform/Catalog/CatalogPlatformClient.js +1 -1
  31. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +63 -41
  32. package/sdk/platform/Catalog/CatalogPlatformModel.js +42 -34
  33. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +2 -2
  34. package/sdk/platform/Catalog/CatalogPlatformValidator.js +2 -2
  35. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +2 -2
  36. package/sdk/platform/Communication/CommunicationPlatformModel.js +1 -1
  37. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -2
  38. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +1 -1
  39. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +2 -2
  40. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1 -1
  41. package/sdk/platform/Content/ContentPlatformModel.d.ts +7 -6
  42. package/sdk/platform/Content/ContentPlatformModel.js +10 -7
  43. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +2 -2
  44. package/sdk/platform/Discount/DiscountPlatformModel.js +1 -1
  45. package/sdk/platform/Lead/LeadPlatformModel.d.ts +2 -2
  46. package/sdk/platform/Lead/LeadPlatformModel.js +1 -1
  47. package/sdk/platform/Order/OrderPlatformModel.d.ts +2 -2
  48. package/sdk/platform/Order/OrderPlatformModel.js +1 -1
  49. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +0 -23
  50. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +0 -161
  51. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +1 -19
  52. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +0 -24
  53. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +1 -159
  54. package/sdk/platform/Payment/PaymentPlatformModel.js +0 -112
  55. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +2 -2
  56. package/sdk/platform/Rewards/RewardsPlatformModel.js +1 -1
  57. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +67 -49
  58. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +45 -42
  59. package/sdk/platform/Share/SharePlatformModel.d.ts +2 -2
  60. package/sdk/platform/Share/SharePlatformModel.js +1 -1
  61. package/sdk/platform/Theme/ThemePlatformModel.d.ts +5 -4
  62. package/sdk/platform/Theme/ThemePlatformModel.js +9 -6
  63. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +3 -2
  64. package/sdk/platform/User/UserPlatformApplicationClient.js +5 -2
  65. package/sdk/platform/User/UserPlatformApplicationValidator.js +0 -1
  66. package/sdk/platform/User/UserPlatformModel.d.ts +17 -1
  67. package/sdk/platform/User/UserPlatformModel.js +15 -0
  68. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +2 -2
  69. package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
@@ -4601,6 +4601,101 @@ class Cart {
4601
4601
  return response;
4602
4602
  }
4603
4603
 
4604
+ /**
4605
+ * @param {CartPlatformApplicationValidator.UpdateCartBreakupParam} arg - Arg object
4606
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
4607
+ * @param {import("../PlatformAPIClient").Options} - Options
4608
+ * @returns {Promise<CartPlatformModel.UpdateCartDetailResult>} - Success response
4609
+ * @name updateCartBreakup
4610
+ * @summary: Update cart breakup values
4611
+ * @description: Updates the cart breakup based on the enabled features and user preferences. This endpoint allows customers to modify how their cart totals are calculated — including options such as applying store credits, loyalty points, discounts, and other promotional benefits. The API recalculates and returns the updated breakup reflecting the selected configurations in real-time. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/cart/updateCartBreakup/).
4612
+ */
4613
+ async updateCartBreakup(
4614
+ { body, xOrderingSource, id, i, b, buyNow, requestHeaders } = {
4615
+ requestHeaders: {},
4616
+ },
4617
+ { responseHeaders } = { responseHeaders: false }
4618
+ ) {
4619
+ const {
4620
+ error,
4621
+ } = CartPlatformApplicationValidator.updateCartBreakup().validate(
4622
+ {
4623
+ body,
4624
+ xOrderingSource,
4625
+ id,
4626
+ i,
4627
+ b,
4628
+ buyNow,
4629
+ },
4630
+ { abortEarly: false, allowUnknown: true }
4631
+ );
4632
+ if (error) {
4633
+ return Promise.reject(new FDKClientValidationError(error));
4634
+ }
4635
+
4636
+ // Showing warrnings if extra unknown parameters are found
4637
+ const {
4638
+ error: warrning,
4639
+ } = CartPlatformApplicationValidator.updateCartBreakup().validate(
4640
+ {
4641
+ body,
4642
+ xOrderingSource,
4643
+ id,
4644
+ i,
4645
+ b,
4646
+ buyNow,
4647
+ },
4648
+ { abortEarly: false, allowUnknown: false }
4649
+ );
4650
+ if (warrning) {
4651
+ Logger({
4652
+ level: "WARN",
4653
+ message: `Parameter Validation warrnings for platform > Cart > updateCartBreakup \n ${warrning}`,
4654
+ });
4655
+ }
4656
+
4657
+ const query_params = {};
4658
+ query_params["id"] = id;
4659
+ query_params["i"] = i;
4660
+ query_params["b"] = b;
4661
+ query_params["buy_now"] = buyNow;
4662
+
4663
+ const response = await PlatformAPIClient.execute(
4664
+ this.config,
4665
+ "patch",
4666
+ `/service/platform/cart/v1.0/company/${this.config.companyId}/application/${this.applicationId}/detail`,
4667
+ query_params,
4668
+ body,
4669
+ requestHeaders,
4670
+ { responseHeaders }
4671
+ );
4672
+
4673
+ let responseData = response;
4674
+ if (responseHeaders) {
4675
+ responseData = response[0];
4676
+ }
4677
+
4678
+ const {
4679
+ error: res_error,
4680
+ } = CartPlatformModel.UpdateCartDetailResult().validate(responseData, {
4681
+ abortEarly: false,
4682
+ allowUnknown: true,
4683
+ });
4684
+
4685
+ if (res_error) {
4686
+ if (this.config.options.strictResponseCheck === true) {
4687
+ return Promise.reject(new FDKResponseValidationError(res_error));
4688
+ } else {
4689
+ Logger({
4690
+ level: "WARN",
4691
+ message: `Response Validation Warnings for platform > Cart > updateCartBreakup \n ${res_error}`,
4692
+ });
4693
+ }
4694
+ }
4695
+
4696
+ return response;
4697
+ }
4698
+
4604
4699
  /**
4605
4700
  * @param {CartPlatformApplicationValidator.UpdateCartMetaParam} arg - Arg object
4606
4701
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -371,6 +371,21 @@ export = CartPlatformApplicationValidator;
371
371
  * @property {boolean} [b]
372
372
  * @property {CartPlatformModel.UpdateCartCreation} body
373
373
  */
374
+ /**
375
+ * @typedef UpdateCartBreakupParam
376
+ * @property {string} [xOrderingSource] - Identifier for the ordering source
377
+ * (e.g., web, mobile app, POS). Used to determine the origin of the order
378
+ * request and apply source-specific rules.
379
+ * @property {string} [id] - Unique identifier of the cart for which the breakup
380
+ * needs to be updated.
381
+ * @property {boolean} [i] - Set to `true` to include all items currently added
382
+ * to the cart in the response.
383
+ * @property {boolean} [b] - Set to `true` to include the detailed price breakup
384
+ * of each cart item in the response.
385
+ * @property {boolean} [buyNow] - Set to `true` to initialize a "Buy Now" cart
386
+ * flow, enabling direct checkout for a single item.
387
+ * @property {CartPlatformModel.UpdateCartBreakup} body
388
+ */
374
389
  /**
375
390
  * @typedef UpdateCartMetaParam
376
391
  * @property {string} [id]
@@ -550,6 +565,8 @@ declare class CartPlatformApplicationValidator {
550
565
  static updateAddress(): UpdateAddressParam;
551
566
  /** @returns {UpdateCartParam} */
552
567
  static updateCart(): UpdateCartParam;
568
+ /** @returns {UpdateCartBreakupParam} */
569
+ static updateCartBreakup(): UpdateCartBreakupParam;
553
570
  /** @returns {UpdateCartMetaParam} */
554
571
  static updateCartMeta(): UpdateCartMetaParam;
555
572
  /** @returns {UpdateCartMetaConfigParam} */
@@ -574,7 +591,7 @@ declare class CartPlatformApplicationValidator {
574
591
  static validateCouponForPayment(): ValidateCouponForPaymentParam;
575
592
  }
576
593
  declare namespace CartPlatformApplicationValidator {
577
- export { AddAddressParam, AddItemsParam, AddPriceAdjustmentParam, ApplyCouponParam, ApplyLoyaltyPointsParam, CheckCartServiceabilityParam, CheckoutCartParam, CreateCartMetaConfigParam, CreateCouponParam, CreatePromotionParam, DeleteCartParam, DeleteCouponParam, DeletePromotionParam, FetchAndvalidateCartItemsParam, FetchCartMetaConfigParam, GetAbandonedCartParam, GetAbandonedCartDetailsParam, GetAddressByIdParam, GetAddressesParam, GetAppCouponsParam, GetAvailableDeliveryModesParam, GetCartParam, GetCartListParam, GetCartShareLinkParam, GetCartSharedItemsParam, GetCouponByIdParam, GetCouponCodeExistsParam, GetCouponOptionValuesParam, GetCouponsParam, GetItemCountParam, GetPriceAdjustmentsParam, GetPromosCouponConfigParam, GetPromotionByIdParam, GetPromotionCodeExistsParam, GetPromotionOffersParam, GetPromotionPaymentOffersParam, GetPromotionsParam, GetShipmentsParam, GetStoreAddressByUidParam, OverrideCartParam, PlatformAddItemsParam, PlatformCheckoutCartParam, PlatformCheckoutCartV2Param, PlatformUpdateCartParam, RemoveAddressParam, RemoveCouponParam, RemovePriceAdjustmentParam, SelectAddressParam, SelectPaymentModeParam, SelectPaymentModeV2Param, UpdateAddressParam, UpdateCartParam, UpdateCartMetaParam, UpdateCartMetaConfigParam, UpdateCartUserParam, UpdateCartWithSharedItemsParam, UpdateCouponParam, UpdateCouponPartiallyParam, UpdatePriceAdjustmentParam, UpdatePromotionParam, UpdatePromotionPartiallyParam, UpdateShipmentsParam, ValidateCouponForPaymentParam };
594
+ export { AddAddressParam, AddItemsParam, AddPriceAdjustmentParam, ApplyCouponParam, ApplyLoyaltyPointsParam, CheckCartServiceabilityParam, CheckoutCartParam, CreateCartMetaConfigParam, CreateCouponParam, CreatePromotionParam, DeleteCartParam, DeleteCouponParam, DeletePromotionParam, FetchAndvalidateCartItemsParam, FetchCartMetaConfigParam, GetAbandonedCartParam, GetAbandonedCartDetailsParam, GetAddressByIdParam, GetAddressesParam, GetAppCouponsParam, GetAvailableDeliveryModesParam, GetCartParam, GetCartListParam, GetCartShareLinkParam, GetCartSharedItemsParam, GetCouponByIdParam, GetCouponCodeExistsParam, GetCouponOptionValuesParam, GetCouponsParam, GetItemCountParam, GetPriceAdjustmentsParam, GetPromosCouponConfigParam, GetPromotionByIdParam, GetPromotionCodeExistsParam, GetPromotionOffersParam, GetPromotionPaymentOffersParam, GetPromotionsParam, GetShipmentsParam, GetStoreAddressByUidParam, OverrideCartParam, PlatformAddItemsParam, PlatformCheckoutCartParam, PlatformCheckoutCartV2Param, PlatformUpdateCartParam, RemoveAddressParam, RemoveCouponParam, RemovePriceAdjustmentParam, SelectAddressParam, SelectPaymentModeParam, SelectPaymentModeV2Param, UpdateAddressParam, UpdateCartParam, UpdateCartBreakupParam, UpdateCartMetaParam, UpdateCartMetaConfigParam, UpdateCartUserParam, UpdateCartWithSharedItemsParam, UpdateCouponParam, UpdateCouponPartiallyParam, UpdatePriceAdjustmentParam, UpdatePromotionParam, UpdatePromotionPartiallyParam, UpdateShipmentsParam, ValidateCouponForPaymentParam };
578
595
  }
579
596
  type AddAddressParam = {
580
597
  body: CartPlatformModel.PlatformAddress;
@@ -1094,6 +1111,35 @@ type UpdateCartParam = {
1094
1111
  b?: boolean;
1095
1112
  body: CartPlatformModel.UpdateCartCreation;
1096
1113
  };
1114
+ type UpdateCartBreakupParam = {
1115
+ /**
1116
+ * - Identifier for the ordering source
1117
+ * (e.g., web, mobile app, POS). Used to determine the origin of the order
1118
+ * request and apply source-specific rules.
1119
+ */
1120
+ xOrderingSource?: string;
1121
+ /**
1122
+ * - Unique identifier of the cart for which the breakup
1123
+ * needs to be updated.
1124
+ */
1125
+ id?: string;
1126
+ /**
1127
+ * - Set to `true` to include all items currently added
1128
+ * to the cart in the response.
1129
+ */
1130
+ i?: boolean;
1131
+ /**
1132
+ * - Set to `true` to include the detailed price breakup
1133
+ * of each cart item in the response.
1134
+ */
1135
+ b?: boolean;
1136
+ /**
1137
+ * - Set to `true` to initialize a "Buy Now" cart
1138
+ * flow, enabling direct checkout for a single item.
1139
+ */
1140
+ buyNow?: boolean;
1141
+ body: CartPlatformModel.UpdateCartBreakup;
1142
+ };
1097
1143
  type UpdateCartMetaParam = {
1098
1144
  id?: string;
1099
1145
  buyNow?: boolean;
@@ -426,6 +426,22 @@ const CartPlatformModel = require("./CartPlatformModel");
426
426
  * @property {CartPlatformModel.UpdateCartCreation} body
427
427
  */
428
428
 
429
+ /**
430
+ * @typedef UpdateCartBreakupParam
431
+ * @property {string} [xOrderingSource] - Identifier for the ordering source
432
+ * (e.g., web, mobile app, POS). Used to determine the origin of the order
433
+ * request and apply source-specific rules.
434
+ * @property {string} [id] - Unique identifier of the cart for which the breakup
435
+ * needs to be updated.
436
+ * @property {boolean} [i] - Set to `true` to include all items currently added
437
+ * to the cart in the response.
438
+ * @property {boolean} [b] - Set to `true` to include the detailed price breakup
439
+ * of each cart item in the response.
440
+ * @property {boolean} [buyNow] - Set to `true` to initialize a "Buy Now" cart
441
+ * flow, enabling direct checkout for a single item.
442
+ * @property {CartPlatformModel.UpdateCartBreakup} body
443
+ */
444
+
429
445
  /**
430
446
  * @typedef UpdateCartMetaParam
431
447
  * @property {string} [id]
@@ -1020,6 +1036,19 @@ class CartPlatformApplicationValidator {
1020
1036
  }).required();
1021
1037
  }
1022
1038
 
1039
+ /** @returns {UpdateCartBreakupParam} */
1040
+ static updateCartBreakup() {
1041
+ return Joi.object({
1042
+ xOrderingSource: Joi.string().allow(""),
1043
+
1044
+ id: Joi.string().allow(""),
1045
+ i: Joi.boolean(),
1046
+ b: Joi.boolean(),
1047
+ buyNow: Joi.boolean(),
1048
+ body: CartPlatformModel.UpdateCartBreakup().required(),
1049
+ }).required();
1050
+ }
1051
+
1023
1052
  /** @returns {UpdateCartMetaParam} */
1024
1053
  static updateCartMeta() {
1025
1054
  return Joi.object({
@@ -194,7 +194,7 @@ export = CartPlatformModel;
194
194
  * @property {boolean} [has_previous] - Indicates whether there is a previous page.
195
195
  * @property {boolean} [has_next] - Indicates whether there is a next page.
196
196
  * @property {number} [current] - The current page number.
197
- * @property {string} type - The type of the page, such as 'PageType'.
197
+ * @property {string} type - The type of the page, can be 'cursor' or 'number'.
198
198
  * @property {number} [size] - The number of items per page.
199
199
  * @property {number} [page_size] - The number of items per page.
200
200
  */
@@ -1909,6 +1909,11 @@ export = CartPlatformModel;
1909
1909
  * @property {string} [free_gift_items_operation] - Field to determine if free
1910
1910
  * gift item to be removed from cart or it needs to be added.
1911
1911
  */
1912
+ /**
1913
+ * @typedef UpdateCartBreakup
1914
+ * @property {boolean} [store_credit] - Select `true` to include store credit in
1915
+ * cart breakup
1916
+ */
1912
1917
  /**
1913
1918
  * @typedef DeleteCartDetails
1914
1919
  * @property {string[]} [cart_id_list] - List of all cart ids, which need to delete
@@ -2542,7 +2547,7 @@ export = CartPlatformModel;
2542
2547
  declare class CartPlatformModel {
2543
2548
  }
2544
2549
  declare namespace CartPlatformModel {
2545
- 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 };
2550
+ 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, UpdateCartBreakup, 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 };
2546
2551
  }
2547
2552
  /** @returns {RedeemLoyaltyPoints} */
2548
2553
  declare function RedeemLoyaltyPoints(): RedeemLoyaltyPoints;
@@ -3019,7 +3024,7 @@ type Page = {
3019
3024
  */
3020
3025
  current?: number;
3021
3026
  /**
3022
- * - The type of the page, such as 'PageType'.
3027
+ * - The type of the page, can be 'cursor' or 'number'.
3023
3028
  */
3024
3029
  type: string;
3025
3030
  /**
@@ -7335,6 +7340,15 @@ type PlatformUpdateCartDetails = {
7335
7340
  */
7336
7341
  free_gift_items_operation?: string;
7337
7342
  };
7343
+ /** @returns {UpdateCartBreakup} */
7344
+ declare function UpdateCartBreakup(): UpdateCartBreakup;
7345
+ type UpdateCartBreakup = {
7346
+ /**
7347
+ * - Select `true` to include store credit in
7348
+ * cart breakup
7349
+ */
7350
+ store_credit?: boolean;
7351
+ };
7338
7352
  /** @returns {DeleteCartDetails} */
7339
7353
  declare function DeleteCartDetails(): DeleteCartDetails;
7340
7354
  type DeleteCartDetails = {
@@ -218,7 +218,7 @@ const Joi = require("joi");
218
218
  * @property {boolean} [has_previous] - Indicates whether there is a previous page.
219
219
  * @property {boolean} [has_next] - Indicates whether there is a next page.
220
220
  * @property {number} [current] - The current page number.
221
- * @property {string} type - The type of the page, such as 'PageType'.
221
+ * @property {string} type - The type of the page, can be 'cursor' or 'number'.
222
222
  * @property {number} [size] - The number of items per page.
223
223
  * @property {number} [page_size] - The number of items per page.
224
224
  */
@@ -2073,6 +2073,12 @@ const Joi = require("joi");
2073
2073
  * gift item to be removed from cart or it needs to be added.
2074
2074
  */
2075
2075
 
2076
+ /**
2077
+ * @typedef UpdateCartBreakup
2078
+ * @property {boolean} [store_credit] - Select `true` to include store credit in
2079
+ * cart breakup
2080
+ */
2081
+
2076
2082
  /**
2077
2083
  * @typedef DeleteCartDetails
2078
2084
  * @property {string[]} [cart_id_list] - List of all cart ids, which need to delete
@@ -4859,6 +4865,13 @@ class CartPlatformModel {
4859
4865
  });
4860
4866
  }
4861
4867
 
4868
+ /** @returns {UpdateCartBreakup} */
4869
+ static UpdateCartBreakup() {
4870
+ return Joi.object({
4871
+ store_credit: Joi.boolean(),
4872
+ });
4873
+ }
4874
+
4862
4875
  /** @returns {DeleteCartDetails} */
4863
4876
  static DeleteCartDetails() {
4864
4877
  return Joi.object({
@@ -750,14 +750,14 @@ declare class Catalog {
750
750
  *
751
751
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
752
752
  * @param {import("../PlatformAPIClient").Options} - Options
753
- * @returns {Promise<CatalogPlatformModel.GetCollectionItemsResponseSchema>}
753
+ * @returns {Promise<CatalogPlatformModel.GetCollectionItemsResponseSchemaV2>}
754
754
  * - Success response
755
755
  *
756
756
  * @name getCollectionItems
757
757
  * @summary: List items of collection
758
- * @description: Get items from a collection specified by its id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getCollectionItems/).
758
+ * @description: Get items from a collection specified by its collection_id with enhanced search capabilities. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getCollectionItems/).
759
759
  */
760
- getCollectionItems({ id, sortOn, pageId, pageSize, pageNo, requestHeaders }?: CatalogPlatformApplicationValidator.GetCollectionItemsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCollectionItemsResponseSchema>;
760
+ getCollectionItems({ collectionId, pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetCollectionItemsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCollectionItemsResponseSchemaV2>;
761
761
  /**
762
762
  * @param {CatalogPlatformApplicationValidator.GetConfigurationByTypeParam} arg
763
763
  * - Arg object
@@ -4000,15 +4000,15 @@ class Catalog {
4000
4000
  *
4001
4001
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
4002
4002
  * @param {import("../PlatformAPIClient").Options} - Options
4003
- * @returns {Promise<CatalogPlatformModel.GetCollectionItemsResponseSchema>}
4003
+ * @returns {Promise<CatalogPlatformModel.GetCollectionItemsResponseSchemaV2>}
4004
4004
  * - Success response
4005
4005
  *
4006
4006
  * @name getCollectionItems
4007
4007
  * @summary: List items of collection
4008
- * @description: Get items from a collection specified by its id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getCollectionItems/).
4008
+ * @description: Get items from a collection specified by its collection_id with enhanced search capabilities. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/catalog/getCollectionItems/).
4009
4009
  */
4010
4010
  async getCollectionItems(
4011
- { id, sortOn, pageId, pageSize, pageNo, requestHeaders } = {
4011
+ { collectionId, pageNo, pageSize, q, requestHeaders } = {
4012
4012
  requestHeaders: {},
4013
4013
  },
4014
4014
  { responseHeaders } = { responseHeaders: false }
@@ -4017,11 +4017,10 @@ class Catalog {
4017
4017
  error,
4018
4018
  } = CatalogPlatformApplicationValidator.getCollectionItems().validate(
4019
4019
  {
4020
- id,
4021
- sortOn,
4022
- pageId,
4023
- pageSize,
4020
+ collectionId,
4024
4021
  pageNo,
4022
+ pageSize,
4023
+ q,
4025
4024
  },
4026
4025
  { abortEarly: false, allowUnknown: true }
4027
4026
  );
@@ -4034,11 +4033,10 @@ class Catalog {
4034
4033
  error: warrning,
4035
4034
  } = CatalogPlatformApplicationValidator.getCollectionItems().validate(
4036
4035
  {
4037
- id,
4038
- sortOn,
4039
- pageId,
4040
- pageSize,
4036
+ collectionId,
4041
4037
  pageNo,
4038
+ pageSize,
4039
+ q,
4042
4040
  },
4043
4041
  { abortEarly: false, allowUnknown: false }
4044
4042
  );
@@ -4050,15 +4048,14 @@ class Catalog {
4050
4048
  }
4051
4049
 
4052
4050
  const query_params = {};
4053
- query_params["sort_on"] = sortOn;
4054
- query_params["page_id"] = pageId;
4055
- query_params["page_size"] = pageSize;
4056
4051
  query_params["page_no"] = pageNo;
4052
+ query_params["page_size"] = pageSize;
4053
+ query_params["q"] = q;
4057
4054
 
4058
4055
  const response = await PlatformAPIClient.execute(
4059
4056
  this.config,
4060
4057
  "get",
4061
- `/service/platform/catalog/v1.0/company/${this.config.companyId}/application/${this.applicationId}/collections/${id}/items/`,
4058
+ `/service/platform/catalog/v2.0/company/${this.config.companyId}/application/${this.applicationId}/collections/${collectionId}/items/`,
4062
4059
  query_params,
4063
4060
  undefined,
4064
4061
  requestHeaders,
@@ -4072,7 +4069,7 @@ class Catalog {
4072
4069
 
4073
4070
  const {
4074
4071
  error: res_error,
4075
- } = CatalogPlatformModel.GetCollectionItemsResponseSchema().validate(
4072
+ } = CatalogPlatformModel.GetCollectionItemsResponseSchemaV2().validate(
4076
4073
  responseData,
4077
4074
  { abortEarly: false, allowUnknown: true }
4078
4075
  );
@@ -296,14 +296,14 @@ export = CatalogPlatformApplicationValidator;
296
296
  */
297
297
  /**
298
298
  * @typedef GetCollectionItemsParam
299
- * @property {string} id - A `id` is a unique identifier of a collection.
300
- * @property {string} [sortOn] - Each response will contain sort_on param, which
301
- * should be sent back to make pagination work.
302
- * @property {string} [pageId] - Each response will contain next_id param, which
303
- * should be sent back to make pagination work.
299
+ * @property {string} collectionId - A `collection_id` is a unique identifier of
300
+ * a collection.
301
+ * @property {number} [pageNo] - The page number to navigate through the given
302
+ * set of results
304
303
  * @property {number} [pageSize] - Number of items to retrieve in each page.
305
- * Default is 12.
306
- * @property {number} [pageNo] - Identifies the specific page of results being requested.
304
+ * Default is 10.
305
+ * @property {string} [q] - Query string to search collection items by substring
306
+ * match on item's name (case-insensitive) or exact item_code.
307
307
  */
308
308
  /**
309
309
  * @typedef GetConfigurationByTypeParam
@@ -1152,28 +1152,25 @@ type GetCollectionDetailParam = {
1152
1152
  };
1153
1153
  type GetCollectionItemsParam = {
1154
1154
  /**
1155
- * - A `id` is a unique identifier of a collection.
1155
+ * - A `collection_id` is a unique identifier of
1156
+ * a collection.
1156
1157
  */
1157
- id: string;
1158
+ collectionId: string;
1158
1159
  /**
1159
- * - Each response will contain sort_on param, which
1160
- * should be sent back to make pagination work.
1161
- */
1162
- sortOn?: string;
1163
- /**
1164
- * - Each response will contain next_id param, which
1165
- * should be sent back to make pagination work.
1160
+ * - The page number to navigate through the given
1161
+ * set of results
1166
1162
  */
1167
- pageId?: string;
1163
+ pageNo?: number;
1168
1164
  /**
1169
1165
  * - Number of items to retrieve in each page.
1170
- * Default is 12.
1166
+ * Default is 10.
1171
1167
  */
1172
1168
  pageSize?: number;
1173
1169
  /**
1174
- * - Identifies the specific page of results being requested.
1170
+ * - Query string to search collection items by substring
1171
+ * match on item's name (case-insensitive) or exact item_code.
1175
1172
  */
1176
- pageNo?: number;
1173
+ q?: string;
1177
1174
  };
1178
1175
  type GetConfigurationByTypeParam = {
1179
1176
  /**
@@ -339,14 +339,14 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
339
339
 
340
340
  /**
341
341
  * @typedef GetCollectionItemsParam
342
- * @property {string} id - A `id` is a unique identifier of a collection.
343
- * @property {string} [sortOn] - Each response will contain sort_on param, which
344
- * should be sent back to make pagination work.
345
- * @property {string} [pageId] - Each response will contain next_id param, which
346
- * should be sent back to make pagination work.
342
+ * @property {string} collectionId - A `collection_id` is a unique identifier of
343
+ * a collection.
344
+ * @property {number} [pageNo] - The page number to navigate through the given
345
+ * set of results
347
346
  * @property {number} [pageSize] - Number of items to retrieve in each page.
348
- * Default is 12.
349
- * @property {number} [pageNo] - Identifies the specific page of results being requested.
347
+ * Default is 10.
348
+ * @property {string} [q] - Query string to search collection items by substring
349
+ * match on item's name (case-insensitive) or exact item_code.
350
350
  */
351
351
 
352
352
  /**
@@ -883,11 +883,10 @@ class CatalogPlatformApplicationValidator {
883
883
  /** @returns {GetCollectionItemsParam} */
884
884
  static getCollectionItems() {
885
885
  return Joi.object({
886
- id: Joi.string().allow("").required(),
887
- sortOn: Joi.string().allow(""),
888
- pageId: Joi.string().allow(""),
889
- pageSize: Joi.number(),
886
+ collectionId: Joi.string().allow("").required(),
890
887
  pageNo: Joi.number(),
888
+ pageSize: Joi.number(),
889
+ q: Joi.string().allow(""),
891
890
  }).required();
892
891
  }
893
892
 
@@ -896,7 +896,7 @@ declare class Catalog {
896
896
  listCategories({ level, department, q, pageNo, pageSize, uids, slug, requestHeaders }?: CatalogPlatformValidator.ListCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryResponseSchema>;
897
897
  /**
898
898
  * @param {Object} arg - Arg object.
899
- * @param {string} [arg.level] - Get category for multiple levels
899
+ * @param {number[]} [arg.level] - Get category for multiple levels
900
900
  * @param {number} [arg.department] - Get category for multiple departments filtered
901
901
  * @param {string} [arg.q] - Get multiple categories filtered by search string
902
902
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
@@ -908,7 +908,7 @@ declare class Catalog {
908
908
  * @description: Retrieve a list of categories data associated to a specific company and queries passed in the request.
909
909
  */
910
910
  listCategoriesPaginator({ level, department, q, pageSize, uids, slug }?: {
911
- level?: string;
911
+ level?: number[];
912
912
  department?: number;
913
913
  q?: string;
914
914
  pageSize?: number;
@@ -5945,7 +5945,7 @@ class Catalog {
5945
5945
 
5946
5946
  /**
5947
5947
  * @param {Object} arg - Arg object.
5948
- * @param {string} [arg.level] - Get category for multiple levels
5948
+ * @param {number[]} [arg.level] - Get category for multiple levels
5949
5949
  * @param {number} [arg.department] - Get category for multiple departments filtered
5950
5950
  * @param {string} [arg.q] - Get multiple categories filtered by search string
5951
5951
  * @param {number} [arg.pageSize] - Number of items to retrieve in each