@gofynd/fdk-client-javascript 3.15.0 → 3.16.1

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 (64) 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/partner/Lead/LeadPartnerModel.d.ts +2 -2
  8. package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
  9. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +2 -2
  10. package/sdk/partner/Logistics/LogisticsPartnerModel.js +1 -1
  11. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +2 -2
  12. package/sdk/partner/Webhook/WebhookPartnerModel.js +1 -1
  13. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +2 -2
  14. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +1 -1
  15. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +10 -0
  16. package/sdk/platform/Cart/CartPlatformApplicationClient.js +95 -0
  17. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +47 -1
  18. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +29 -0
  19. package/sdk/platform/Cart/CartPlatformModel.d.ts +39 -7
  20. package/sdk/platform/Cart/CartPlatformModel.js +24 -3
  21. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +3 -3
  22. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +13 -16
  23. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +17 -20
  24. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +10 -11
  25. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +2 -2
  26. package/sdk/platform/Catalog/CatalogPlatformClient.js +1 -1
  27. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +58 -37
  28. package/sdk/platform/Catalog/CatalogPlatformModel.js +33 -28
  29. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +2 -2
  30. package/sdk/platform/Catalog/CatalogPlatformValidator.js +2 -2
  31. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +2 -2
  32. package/sdk/platform/Communication/CommunicationPlatformModel.js +1 -1
  33. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -2
  34. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +1 -1
  35. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +2 -2
  36. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1 -1
  37. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +11 -1
  38. package/sdk/platform/Content/ContentPlatformApplicationClient.js +85 -1
  39. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +24 -1
  40. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +15 -0
  41. package/sdk/platform/Content/ContentPlatformModel.d.ts +243 -3
  42. package/sdk/platform/Content/ContentPlatformModel.js +164 -1
  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/User/UserPlatformModel.d.ts +14 -0
  62. package/sdk/platform/User/UserPlatformModel.js +6 -0
  63. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +2 -2
  64. package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
@@ -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
  */
@@ -1206,14 +1206,20 @@ export = CartPlatformModel;
1206
1206
  */
1207
1207
  /**
1208
1208
  * @typedef ProductPrice
1209
- * @property {number} [marked] - Maximum price of the product
1209
+ * @property {number} [marked] - Original MRP of product.
1210
1210
  * @property {number} [add_on] - Price before promotion and coupon amount
1211
1211
  * applied for calculation
1212
1212
  * @property {string} [currency_code] - Currency code of the price defined for the product
1213
1213
  * @property {string} [currency_symbol] - Currency symbol of the price defined
1214
1214
  * for the product
1215
- * @property {number} [effective] - Selling price of the product
1215
+ * @property {number} [effective] - Price of the product after applying
1216
+ * inventory discount and before applying promotion, coupon and engage discount.
1216
1217
  * @property {number} [selling] - Selling price of the product
1218
+ * @property {number} [final_price] - Final price of the product in cart after
1219
+ * applying all discounts such as promotion, coupon and engage discount."
1220
+ * @property {number} [discount] - Net discount applied on product, contains
1221
+ * total discount amount including promotions, coupons and engage discount
1222
+ * [excluding inventory discount].
1217
1223
  */
1218
1224
  /**
1219
1225
  * @typedef ProductPriceInfo
@@ -1909,6 +1915,11 @@ export = CartPlatformModel;
1909
1915
  * @property {string} [free_gift_items_operation] - Field to determine if free
1910
1916
  * gift item to be removed from cart or it needs to be added.
1911
1917
  */
1918
+ /**
1919
+ * @typedef UpdateCartBreakup
1920
+ * @property {boolean} [store_credit] - Select `true` to include store credit in
1921
+ * cart breakup
1922
+ */
1912
1923
  /**
1913
1924
  * @typedef DeleteCartDetails
1914
1925
  * @property {string[]} [cart_id_list] - List of all cart ids, which need to delete
@@ -2542,7 +2553,7 @@ export = CartPlatformModel;
2542
2553
  declare class CartPlatformModel {
2543
2554
  }
2544
2555
  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 };
2556
+ 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
2557
  }
2547
2558
  /** @returns {RedeemLoyaltyPoints} */
2548
2559
  declare function RedeemLoyaltyPoints(): RedeemLoyaltyPoints;
@@ -3019,7 +3030,7 @@ type Page = {
3019
3030
  */
3020
3031
  current?: number;
3021
3032
  /**
3022
- * - The type of the page, such as 'PageType'.
3033
+ * - The type of the page, can be 'cursor' or 'number'.
3023
3034
  */
3024
3035
  type: string;
3025
3036
  /**
@@ -5502,7 +5513,7 @@ type CouponDetails = {
5502
5513
  declare function ProductPrice(): ProductPrice;
5503
5514
  type ProductPrice = {
5504
5515
  /**
5505
- * - Maximum price of the product
5516
+ * - Original MRP of product.
5506
5517
  */
5507
5518
  marked?: number;
5508
5519
  /**
@@ -5520,13 +5531,25 @@ type ProductPrice = {
5520
5531
  */
5521
5532
  currency_symbol?: string;
5522
5533
  /**
5523
- * - Selling price of the product
5534
+ * - Price of the product after applying
5535
+ * inventory discount and before applying promotion, coupon and engage discount.
5524
5536
  */
5525
5537
  effective?: number;
5526
5538
  /**
5527
5539
  * - Selling price of the product
5528
5540
  */
5529
5541
  selling?: number;
5542
+ /**
5543
+ * - Final price of the product in cart after
5544
+ * applying all discounts such as promotion, coupon and engage discount."
5545
+ */
5546
+ final_price?: number;
5547
+ /**
5548
+ * - Net discount applied on product, contains
5549
+ * total discount amount including promotions, coupons and engage discount
5550
+ * [excluding inventory discount].
5551
+ */
5552
+ discount?: number;
5530
5553
  };
5531
5554
  /** @returns {ProductPriceInfo} */
5532
5555
  declare function ProductPriceInfo(): ProductPriceInfo;
@@ -7335,6 +7358,15 @@ type PlatformUpdateCartDetails = {
7335
7358
  */
7336
7359
  free_gift_items_operation?: string;
7337
7360
  };
7361
+ /** @returns {UpdateCartBreakup} */
7362
+ declare function UpdateCartBreakup(): UpdateCartBreakup;
7363
+ type UpdateCartBreakup = {
7364
+ /**
7365
+ * - Select `true` to include store credit in
7366
+ * cart breakup
7367
+ */
7368
+ store_credit?: boolean;
7369
+ };
7338
7370
  /** @returns {DeleteCartDetails} */
7339
7371
  declare function DeleteCartDetails(): DeleteCartDetails;
7340
7372
  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
  */
@@ -1315,14 +1315,20 @@ const Joi = require("joi");
1315
1315
 
1316
1316
  /**
1317
1317
  * @typedef ProductPrice
1318
- * @property {number} [marked] - Maximum price of the product
1318
+ * @property {number} [marked] - Original MRP of product.
1319
1319
  * @property {number} [add_on] - Price before promotion and coupon amount
1320
1320
  * applied for calculation
1321
1321
  * @property {string} [currency_code] - Currency code of the price defined for the product
1322
1322
  * @property {string} [currency_symbol] - Currency symbol of the price defined
1323
1323
  * for the product
1324
- * @property {number} [effective] - Selling price of the product
1324
+ * @property {number} [effective] - Price of the product after applying
1325
+ * inventory discount and before applying promotion, coupon and engage discount.
1325
1326
  * @property {number} [selling] - Selling price of the product
1327
+ * @property {number} [final_price] - Final price of the product in cart after
1328
+ * applying all discounts such as promotion, coupon and engage discount."
1329
+ * @property {number} [discount] - Net discount applied on product, contains
1330
+ * total discount amount including promotions, coupons and engage discount
1331
+ * [excluding inventory discount].
1326
1332
  */
1327
1333
 
1328
1334
  /**
@@ -2073,6 +2079,12 @@ const Joi = require("joi");
2073
2079
  * gift item to be removed from cart or it needs to be added.
2074
2080
  */
2075
2081
 
2082
+ /**
2083
+ * @typedef UpdateCartBreakup
2084
+ * @property {boolean} [store_credit] - Select `true` to include store credit in
2085
+ * cart breakup
2086
+ */
2087
+
2076
2088
  /**
2077
2089
  * @typedef DeleteCartDetails
2078
2090
  * @property {string[]} [cart_id_list] - List of all cart ids, which need to delete
@@ -4107,6 +4119,8 @@ class CartPlatformModel {
4107
4119
  currency_symbol: Joi.string().allow(""),
4108
4120
  effective: Joi.number(),
4109
4121
  selling: Joi.number(),
4122
+ final_price: Joi.number(),
4123
+ discount: Joi.number(),
4110
4124
  });
4111
4125
  }
4112
4126
 
@@ -4859,6 +4873,13 @@ class CartPlatformModel {
4859
4873
  });
4860
4874
  }
4861
4875
 
4876
+ /** @returns {UpdateCartBreakup} */
4877
+ static UpdateCartBreakup() {
4878
+ return Joi.object({
4879
+ store_credit: Joi.boolean(),
4880
+ });
4881
+ }
4882
+
4862
4883
  /** @returns {DeleteCartDetails} */
4863
4884
  static DeleteCartDetails() {
4864
4885
  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
@@ -1546,16 +1546,6 @@ export = CatalogPlatformModel;
1546
1546
  * @property {SeoDetail} [seo]
1547
1547
  * @property {boolean} [is_visible] - Indicates if the collection is visible.
1548
1548
  */
1549
- /**
1550
- * @typedef GetCollectionItemsResponseSchema
1551
- * @property {ProductFilters[]} [filters] - An array of filters applicable to
1552
- * the products in the collection.
1553
- * @property {ApplicationProductsSchema[]} [items] - An array of products that
1554
- * belong to the collection.
1555
- * @property {Page} [page]
1556
- * @property {ProductSortOn[]} [sort_on] - Sorting options available for the
1557
- * products in the collection.
1558
- */
1559
1549
  /**
1560
1550
  * @typedef GetCollectionListingResponseSchema
1561
1551
  * @property {CollectionListingFilter} [filters]
@@ -1821,6 +1811,9 @@ export = CatalogPlatformModel;
1821
1811
  * @property {string} [_id] - A unique identifier for the collection, matching `uid`.
1822
1812
  * @property {string[]} [visible_facets_keys] - Keys representing visible facets
1823
1813
  * for filtering.
1814
+ * @property {string[]} [handpicked_collection_item_ids] - Array of item `uid`
1815
+ * that have been manually handpicked for this collection. Will be an empty
1816
+ * array if the collection type is not handpicked.
1824
1817
  */
1825
1818
  /**
1826
1819
  * @typedef CommonResponseSchemaCollection
@@ -1846,8 +1839,18 @@ export = CatalogPlatformModel;
1846
1839
  */
1847
1840
  /**
1848
1841
  * @typedef GetCollectionItemsResponseSchemaV2
1849
- * @property {ProductDetailV2[]} [items]
1850
- * @property {Page1} [page]
1842
+ * @property {CollectionItemV2[]} [items]
1843
+ * @property {Page} [page]
1844
+ */
1845
+ /**
1846
+ * @typedef CollectionItemV2
1847
+ * @property {string} name - The name of the product
1848
+ * @property {string} [short_description] - A brief description of the product
1849
+ * @property {Media[]} [medias] - Media items (images, videos) associated with the product
1850
+ * @property {string} slug - URL-friendly identifier for the product
1851
+ * @property {number} uid - Unique identifier for the product
1852
+ * @property {string} item_code - Item code or SKU of the product
1853
+ * @property {string} item_type - Type of the product
1851
1854
  */
1852
1855
  /**
1853
1856
  * @typedef Page1
@@ -2748,7 +2751,7 @@ export = CatalogPlatformModel;
2748
2751
  * @property {boolean} [has_previous] - Indicates whether there is a previous page.
2749
2752
  * @property {boolean} [has_next] - Indicates whether there is a next page.
2750
2753
  * @property {number} [current] - The current page number.
2751
- * @property {string} type - The type of the page, such as 'PageType'.
2754
+ * @property {string} type - The type of the page, can be 'cursor' or 'number'.
2752
2755
  * @property {number} [size] - The number of items per page.
2753
2756
  * @property {number} [page_size] - The number of items per page.
2754
2757
  */
@@ -4658,7 +4661,7 @@ export = CatalogPlatformModel;
4658
4661
  declare class CatalogPlatformModel {
4659
4662
  }
4660
4663
  declare namespace CatalogPlatformModel {
4661
- export { Action, ValidationErrors, AllSizes, AllowSingleRequestSchema, AppCatalogConfiguration, AppCategoryReturnConfig, AppCategoryReturnConfigResponseSchema, AppConfiguration, AppConfigurationDetail, AppConfigurationsSort, ApplicationBrandJson, ApplicationCategoryJson, ApplicationDepartment, ApplicationDepartmentJson, ApplicationDepartmentListingResponseSchema, ApplicationItemMOQ, Scores, ApplicationItemMeta, ApplicationItemSeoSitemap, ApplicationItemSEO, ApplicationProductsSchema, ApplicationProductListingResponseSchema, ApplicationStoreJson, AppReturnConfigResponseSchema, ArticleAssignment, ArticleAssignment1, ArticleQuery, ArticleStoreResponseSchema, AssignStore, AssignStoreArticle, AttributeDetailsGroup, AttributeMaster, AttributeMasterDetails, AttributeMasterFilter, AttributeMasterMandatoryDetails, AttributeMasterMeta, AttributeMasterSchema, AttributeSchemaRange, AutoCompleteMedia, AutocompleteAction, AutocompletePageAction, AutocompleteResult, BannerImage, BaseAppCategoryReturnConfig, BaseAppCategoryReturnConfigResponseSchema, Brand, BrandItem, BrandListingResponseSchema, ApplicationBrandListingItemSchema, ApplicationBrandListingSchema, ApplicationCategoryListingSchema, ApplicationCategoryListingItemSchema, BrandMeta, InventoryBrandMeta, BulkAssetResponseSchema, BulkHsnResponseSchema, BulkHsnUpsert, BulkInventoryGet, FailedRecord, BulkInventoryGetItems, BulkMeta, BulkProductJob, BulkJob, BulkProductRequestSchema, BulkResponseSchema, CatalogInsightBrand, CatalogInsightItem, CatalogInsightResponseSchema, CategoriesResponseSchema, Category, CategoryItems, CategoryListingResponseSchema, CategoryMapping, CategoryMappingValues, CategoryResponseSchema, Child, CollectionBadge, CollectionBanner, CollectionCreateResponseSchema, CollectionDetailResponseSchema, CollectionImage, CollectionItem, CollectionItemUpdate, CollectionListingFilter, CollectionListingFilterTag, CollectionListingFilterType, CollectionQuery, CollectionSchedule, CompanyBrandDetail, CompanyMeta, InventoryCompanyMeta, CompanyOptIn, ConfigErrorResponseSchema, ConfigSuccessResponseSchema, ConfigurationBucketPoints, ConfigurationListing, ConfigurationListingFilter, ConfigurationListingFilterConfig, ConfigurationListingFilterValue, ConfigurationListingSort, ConfigurationListingSortConfig, ConfigurationProduct, ConfigurationProductConfig, ConfigurationProductSimilar, ConfigurationProductVariant, ConfigurationProductVariantConfig, CreateAutocompleteKeyword, CreateAutocompleteWordsResponseSchema, CreateCollection, CreateSearchConfigurationRequestSchema, CreateSearchConfigurationResponseSchema, CreateSearchKeyword, CreateUpdateAppReturnConfig, CrossSellingData, CrossSellingResponseSchema, CustomOrder, DateMeta, DefaultKeyRequestSchema, DeleteAppCategoryReturnConfig, DeleteResponseSchema, DeleteSearchConfigurationResponseSchema, Department, DepartmentCategoryTree, DepartmentErrorResponseSchema, DepartmentIdentifier, DepartmentResponseSchema, DepartmentsResponseSchema, DimensionResponseSchema, InventoryDimensionResponseSchema, Document, EntityConfiguration, ErrorResponseSchema, FilerList, RawProduct, RawProductListingResponseSchema, GTIN, AttributeDetail, LatLong, ApplicationLocationAddressSchema, GetAddressSchema, GetAllSizes, GetAppCatalogConfiguration, GetAppCatalogEntityConfiguration, GetAutocompleteWordsData, GetAutocompleteWordsResponseSchema, GetCatalogConfigurationDetailsProduct, GetCatalogConfigurationDetailsSchemaListing, GetCatalogConfigurationMetaData, GetCollectionDetailNest, GetCollectionItemsResponseSchema, GetCollectionListingResponseSchema, GetCollectionQueryOptionResponseSchema, GetCompanySchema, ConditionItem, DataItem, ValueTypeItem, SortTypeItem, GetConfigMetadataResponseSchema, GetConfigMetadataValues, GetConfigResponseSchema, ConfigItem, AttributeConfig, GetDepartment, GetInventories, GetInventoriesResponseSchema, GetLocationSchema, GetOptInPlatform, GetProducts, ProductDetails, GetCollectionDetailResponseSchema, CommonResponseSchemaCollection, GetQueryFiltersKeysResponseSchema, GetQueryFiltersResponseSchema, GetCollectionItemsResponseSchemaV2, Page1, CollectionItemSchemaV2, CollectionItemUpdateSchema, CollectionQuerySchemaV2, ProductDetailV2, GetSearchConfigurationResponseSchema, GetSearchWordsData, GetSearchWordsDetailResponseSchema, GetSearchWordsResponseSchema, GlobalValidation, Guide, HSNCodesResponseSchema, HSNData, CreatedBySchema, ModifiedBySchema, HSNDataInsertV2, Hierarchy, HsnCode, HsnCodesListingResponseSchemaV2, HsnCodesObject, HsnUpsert, Image, ImageUrls, InvSize, InventoryBulkRequestSchema, InventoryConfig, InventoryCreateRequestSchema, InventoryExportAdvanceOption, InventoryExportFilter, InventoryExportJob, InventoryExportJobListResponseSchema, InventoryExportQuantityFilter, InventoryExportRequestSchema, InventoryExportResponseSchema, InventoryFailedReason, InventoryJobDetailResponseSchema, InventoryJobFilters, InventoryJobPayload, InventoryPage, AddInventoryRequestPayload, InventoryPayload, InventoryRequestSchema, InventoryRequestSchemaV2, InventoryResponseSchema, InventoryResponseItem, InventoryResponsePaginated, InventorySellerIdentifierResponsePaginated, ApplicationInventorySellerIdentifierResponsePaginated, InventorySellerResponseSchema, ApplicationInventorySellerResponseSchema, InventorySet, InventoryStockResponseSchema, InventoryUpdateResponseSchema, InventoryValidationResponseSchema, InvoiceCredSchema, InvoiceDetailsSchema, ItemQuery, Items, LimitedProductData, SizeGuideItem, ListSizeGuide, LocationDayWiseSchema, LocationIntegrationType, LocationListSchema, LocationManagerSchema, LocationTimingSchema, Logo, MOQData, ManufacturerResponseSchema, InventoryManufacturerResponseSchema, Media, Media1, DepartmentMedia, BrandMedia, BundleDetails, Meta, MetaDataListingFilterMetaResponseSchema, MetaDataListingFilterResponseSchema, MetaDataListingResponseSchema, MetaDataListingSortMetaResponseSchema, MetaDataListingSortResponseSchema, MetaFields, NetQuantity, NetQuantityResponseSchema, NextSchedule, LocationPriceRequestSchema, LocationQuantityRequestSchema, LocationPriceQuantitySuccessResponseSchema, OptInPostRequestSchema, OptinCompanyBrandDetailsView, OptinCompanyDetail, OptinCompanyMetrics, OptinStoreDetails, OwnerAppItemResponseSchema, PTErrorResponseSchema, Page, PageResponseSchema, PageResponseType, Price, ProductListingDetailPrice, PriceArticle, PriceMeta, ProdcutTemplateCategoriesResponseSchema, Product, ProductAttributesResponseSchema, ProductBrand, ProductBulkAssets, ProductBulkRequestSchema, ProductBulkRequestList, ProductConfigurationDownloads, ProductCreateSchemaV3, ProductUpdateSchemaV3, ProductPatchSchemaV3, ProductSizePatch, ProductDetail, ProductDetailAttribute, ProductDetailGroupedAttribute, ProductDownloadsResponseSchema, CollectionProductFilters, ProductFilters, GetQueryFiltersValuesResponseSchema, ProductFiltersKeysOnly, ProductFiltersKey, ProductQueryFiltersValue, CollectionProductFiltersValue, ProductFiltersValue, CollectionProductListingDetail, ProductCategory, ApplicationCategoryAction, ApplicationCategoryItem, ApplicationProductMedia, ApplicationProductCategoryItem, CategoryPageAction, CategoryQuery, CategoryImage, ProductListingDetail, ActionObject, PageAction, ProductListingPrice, ProductListingResponseSchema, ProductListingResponseV2, ProductPublish, ProductPublished, ProductReturnConfigSchema, ProductReturnConfigBaseSchema, Identifier, SizeDetails, ProductSchemaV2, ProductSize, ProductSizeDeleteDataResponseSchema, ProductSizeDeleteResponseSchema, CollectionProductSortOn, ProductSortOn, ProductTagsViewResponseSchema, CreatedBy, ModifiedBy, ProductTemplate, ProductTemplateDownloadsExport, ProductTemplateExportFilterRequestSchema, ProductTemplateExportResponseSchema, ProductVariants, ProductVariantsResponseSchema, Properties, Quantities, QuantitiesArticle, Quantity, QuantityBase, ReturnConfig, InventoryReturnConfig, ReturnConfig2, ReturnConfigResponseSchema, Sitemap, PageQuery, ApplicationCollectionItemSeoPage, ApplicationCollectionItemSeoAction, ApplicationItemSeoAction, ApplicationItemSeoBreadcrumbs, ApplicationCollectionItemSeoBreadcrumbs, ApplicationItemSeoMetaTagItem, ApplicationItemSeoMetaTags, Metatags, SizePromotionThreshold, SEOData, SearchKeywordResult, SearchableAttribute, SecondLevelChild, SellerPhoneNumber, CollectionSeoDetail, SeoDetail, SetSize, SingleCategoryResponseSchema, SingleProductResponseSchema, Size, SizeDistribution, SizeGuideResponseSchema, StoreAssignResponseSchema, StoreDetail, StoreMeta, SuccessResponseSchema, SuccessResponseObject, TaxIdentifier, TaxIdentifierV3, TaxSlab, TeaserTag, TemplateDetails, TemplateGlobalValidationData, TemplateValidationData, TemplatesResponseSchema, TemplatesGlobalValidationResponseSchema, TemplatesValidationResponseSchema, ThirdLevelChild, Trader, Trader1, TraderResponseSchema, UpdateCollection, UpdateSearchConfigurationRequestSchema, UpdateSearchConfigurationResponseSchema, CreateMarketplaceOptinResponseSchema, UserCommon, UserDetail, UserDetail1, UserInfo, UserSchema, RequestUserSchema, ValidateIdentifier, ValidateProduct, ValidateSizeGuide, VerifiedBy, WeightResponseSchema, InventoryWeightResponseSchema, BulkInventoryJob, Marketplaces, GetAllMarketplaces, UpdateMarketplaceOptinRequestSchema, UpdateMarketplaceOptinResponseSchema, Filters, FollowedProducts, FollowProduct, TaxReqBodyRule, TaxThreshold, TaxComponent, TaxComponentResponseSchema, TaxComponentName, CreateTaxComponentNameRequestSchema, TaxReqBodyVersion, CreateTaxRequestBody, TaxVersion, UpdateTaxVersionRequestBody, CreateTaxVersionRequestBody, TaxRule, TaxVersionDetail, CreateTax, UpdateTaxVersion, UpdateTaxRequestBody, TaxRuleItem, TaxRules, TaxVersionPastData, TaxRuleVersion, HSCodeItem, HSCodes, GetTaxComponents, ActionPage, ValidationError, Price1, MultiCategoriesSchema, NetQuantitySchema, CustomMeta, TaxStatusEnum, HsTypeEnum, PageType };
4664
+ export { Action, ValidationErrors, AllSizes, AllowSingleRequestSchema, AppCatalogConfiguration, AppCategoryReturnConfig, AppCategoryReturnConfigResponseSchema, AppConfiguration, AppConfigurationDetail, AppConfigurationsSort, ApplicationBrandJson, ApplicationCategoryJson, ApplicationDepartment, ApplicationDepartmentJson, ApplicationDepartmentListingResponseSchema, ApplicationItemMOQ, Scores, ApplicationItemMeta, ApplicationItemSeoSitemap, ApplicationItemSEO, ApplicationProductsSchema, ApplicationProductListingResponseSchema, ApplicationStoreJson, AppReturnConfigResponseSchema, ArticleAssignment, ArticleAssignment1, ArticleQuery, ArticleStoreResponseSchema, AssignStore, AssignStoreArticle, AttributeDetailsGroup, AttributeMaster, AttributeMasterDetails, AttributeMasterFilter, AttributeMasterMandatoryDetails, AttributeMasterMeta, AttributeMasterSchema, AttributeSchemaRange, AutoCompleteMedia, AutocompleteAction, AutocompletePageAction, AutocompleteResult, BannerImage, BaseAppCategoryReturnConfig, BaseAppCategoryReturnConfigResponseSchema, Brand, BrandItem, BrandListingResponseSchema, ApplicationBrandListingItemSchema, ApplicationBrandListingSchema, ApplicationCategoryListingSchema, ApplicationCategoryListingItemSchema, BrandMeta, InventoryBrandMeta, BulkAssetResponseSchema, BulkHsnResponseSchema, BulkHsnUpsert, BulkInventoryGet, FailedRecord, BulkInventoryGetItems, BulkMeta, BulkProductJob, BulkJob, BulkProductRequestSchema, BulkResponseSchema, CatalogInsightBrand, CatalogInsightItem, CatalogInsightResponseSchema, CategoriesResponseSchema, Category, CategoryItems, CategoryListingResponseSchema, CategoryMapping, CategoryMappingValues, CategoryResponseSchema, Child, CollectionBadge, CollectionBanner, CollectionCreateResponseSchema, CollectionDetailResponseSchema, CollectionImage, CollectionItem, CollectionItemUpdate, CollectionListingFilter, CollectionListingFilterTag, CollectionListingFilterType, CollectionQuery, CollectionSchedule, CompanyBrandDetail, CompanyMeta, InventoryCompanyMeta, CompanyOptIn, ConfigErrorResponseSchema, ConfigSuccessResponseSchema, ConfigurationBucketPoints, ConfigurationListing, ConfigurationListingFilter, ConfigurationListingFilterConfig, ConfigurationListingFilterValue, ConfigurationListingSort, ConfigurationListingSortConfig, ConfigurationProduct, ConfigurationProductConfig, ConfigurationProductSimilar, ConfigurationProductVariant, ConfigurationProductVariantConfig, CreateAutocompleteKeyword, CreateAutocompleteWordsResponseSchema, CreateCollection, CreateSearchConfigurationRequestSchema, CreateSearchConfigurationResponseSchema, CreateSearchKeyword, CreateUpdateAppReturnConfig, CrossSellingData, CrossSellingResponseSchema, CustomOrder, DateMeta, DefaultKeyRequestSchema, DeleteAppCategoryReturnConfig, DeleteResponseSchema, DeleteSearchConfigurationResponseSchema, Department, DepartmentCategoryTree, DepartmentErrorResponseSchema, DepartmentIdentifier, DepartmentResponseSchema, DepartmentsResponseSchema, DimensionResponseSchema, InventoryDimensionResponseSchema, Document, EntityConfiguration, ErrorResponseSchema, FilerList, RawProduct, RawProductListingResponseSchema, GTIN, AttributeDetail, LatLong, ApplicationLocationAddressSchema, GetAddressSchema, GetAllSizes, GetAppCatalogConfiguration, GetAppCatalogEntityConfiguration, GetAutocompleteWordsData, GetAutocompleteWordsResponseSchema, GetCatalogConfigurationDetailsProduct, GetCatalogConfigurationDetailsSchemaListing, GetCatalogConfigurationMetaData, GetCollectionDetailNest, GetCollectionListingResponseSchema, GetCollectionQueryOptionResponseSchema, GetCompanySchema, ConditionItem, DataItem, ValueTypeItem, SortTypeItem, GetConfigMetadataResponseSchema, GetConfigMetadataValues, GetConfigResponseSchema, ConfigItem, AttributeConfig, GetDepartment, GetInventories, GetInventoriesResponseSchema, GetLocationSchema, GetOptInPlatform, GetProducts, ProductDetails, GetCollectionDetailResponseSchema, CommonResponseSchemaCollection, GetQueryFiltersKeysResponseSchema, GetQueryFiltersResponseSchema, GetCollectionItemsResponseSchemaV2, CollectionItemV2, Page1, CollectionItemSchemaV2, CollectionItemUpdateSchema, CollectionQuerySchemaV2, ProductDetailV2, GetSearchConfigurationResponseSchema, GetSearchWordsData, GetSearchWordsDetailResponseSchema, GetSearchWordsResponseSchema, GlobalValidation, Guide, HSNCodesResponseSchema, HSNData, CreatedBySchema, ModifiedBySchema, HSNDataInsertV2, Hierarchy, HsnCode, HsnCodesListingResponseSchemaV2, HsnCodesObject, HsnUpsert, Image, ImageUrls, InvSize, InventoryBulkRequestSchema, InventoryConfig, InventoryCreateRequestSchema, InventoryExportAdvanceOption, InventoryExportFilter, InventoryExportJob, InventoryExportJobListResponseSchema, InventoryExportQuantityFilter, InventoryExportRequestSchema, InventoryExportResponseSchema, InventoryFailedReason, InventoryJobDetailResponseSchema, InventoryJobFilters, InventoryJobPayload, InventoryPage, AddInventoryRequestPayload, InventoryPayload, InventoryRequestSchema, InventoryRequestSchemaV2, InventoryResponseSchema, InventoryResponseItem, InventoryResponsePaginated, InventorySellerIdentifierResponsePaginated, ApplicationInventorySellerIdentifierResponsePaginated, InventorySellerResponseSchema, ApplicationInventorySellerResponseSchema, InventorySet, InventoryStockResponseSchema, InventoryUpdateResponseSchema, InventoryValidationResponseSchema, InvoiceCredSchema, InvoiceDetailsSchema, ItemQuery, Items, LimitedProductData, SizeGuideItem, ListSizeGuide, LocationDayWiseSchema, LocationIntegrationType, LocationListSchema, LocationManagerSchema, LocationTimingSchema, Logo, MOQData, ManufacturerResponseSchema, InventoryManufacturerResponseSchema, Media, Media1, DepartmentMedia, BrandMedia, BundleDetails, Meta, MetaDataListingFilterMetaResponseSchema, MetaDataListingFilterResponseSchema, MetaDataListingResponseSchema, MetaDataListingSortMetaResponseSchema, MetaDataListingSortResponseSchema, MetaFields, NetQuantity, NetQuantityResponseSchema, NextSchedule, LocationPriceRequestSchema, LocationQuantityRequestSchema, LocationPriceQuantitySuccessResponseSchema, OptInPostRequestSchema, OptinCompanyBrandDetailsView, OptinCompanyDetail, OptinCompanyMetrics, OptinStoreDetails, OwnerAppItemResponseSchema, PTErrorResponseSchema, Page, PageResponseSchema, PageResponseType, Price, ProductListingDetailPrice, PriceArticle, PriceMeta, ProdcutTemplateCategoriesResponseSchema, Product, ProductAttributesResponseSchema, ProductBrand, ProductBulkAssets, ProductBulkRequestSchema, ProductBulkRequestList, ProductConfigurationDownloads, ProductCreateSchemaV3, ProductUpdateSchemaV3, ProductPatchSchemaV3, ProductSizePatch, ProductDetail, ProductDetailAttribute, ProductDetailGroupedAttribute, ProductDownloadsResponseSchema, CollectionProductFilters, ProductFilters, GetQueryFiltersValuesResponseSchema, ProductFiltersKeysOnly, ProductFiltersKey, ProductQueryFiltersValue, CollectionProductFiltersValue, ProductFiltersValue, CollectionProductListingDetail, ProductCategory, ApplicationCategoryAction, ApplicationCategoryItem, ApplicationProductMedia, ApplicationProductCategoryItem, CategoryPageAction, CategoryQuery, CategoryImage, ProductListingDetail, ActionObject, PageAction, ProductListingPrice, ProductListingResponseSchema, ProductListingResponseV2, ProductPublish, ProductPublished, ProductReturnConfigSchema, ProductReturnConfigBaseSchema, Identifier, SizeDetails, ProductSchemaV2, ProductSize, ProductSizeDeleteDataResponseSchema, ProductSizeDeleteResponseSchema, CollectionProductSortOn, ProductSortOn, ProductTagsViewResponseSchema, CreatedBy, ModifiedBy, ProductTemplate, ProductTemplateDownloadsExport, ProductTemplateExportFilterRequestSchema, ProductTemplateExportResponseSchema, ProductVariants, ProductVariantsResponseSchema, Properties, Quantities, QuantitiesArticle, Quantity, QuantityBase, ReturnConfig, InventoryReturnConfig, ReturnConfig2, ReturnConfigResponseSchema, Sitemap, PageQuery, ApplicationCollectionItemSeoPage, ApplicationCollectionItemSeoAction, ApplicationItemSeoAction, ApplicationItemSeoBreadcrumbs, ApplicationCollectionItemSeoBreadcrumbs, ApplicationItemSeoMetaTagItem, ApplicationItemSeoMetaTags, Metatags, SizePromotionThreshold, SEOData, SearchKeywordResult, SearchableAttribute, SecondLevelChild, SellerPhoneNumber, CollectionSeoDetail, SeoDetail, SetSize, SingleCategoryResponseSchema, SingleProductResponseSchema, Size, SizeDistribution, SizeGuideResponseSchema, StoreAssignResponseSchema, StoreDetail, StoreMeta, SuccessResponseSchema, SuccessResponseObject, TaxIdentifier, TaxIdentifierV3, TaxSlab, TeaserTag, TemplateDetails, TemplateGlobalValidationData, TemplateValidationData, TemplatesResponseSchema, TemplatesGlobalValidationResponseSchema, TemplatesValidationResponseSchema, ThirdLevelChild, Trader, Trader1, TraderResponseSchema, UpdateCollection, UpdateSearchConfigurationRequestSchema, UpdateSearchConfigurationResponseSchema, CreateMarketplaceOptinResponseSchema, UserCommon, UserDetail, UserDetail1, UserInfo, UserSchema, RequestUserSchema, ValidateIdentifier, ValidateProduct, ValidateSizeGuide, VerifiedBy, WeightResponseSchema, InventoryWeightResponseSchema, BulkInventoryJob, Marketplaces, GetAllMarketplaces, UpdateMarketplaceOptinRequestSchema, UpdateMarketplaceOptinResponseSchema, Filters, FollowedProducts, FollowProduct, TaxReqBodyRule, TaxThreshold, TaxComponent, TaxComponentResponseSchema, TaxComponentName, CreateTaxComponentNameRequestSchema, TaxReqBodyVersion, CreateTaxRequestBody, TaxVersion, UpdateTaxVersionRequestBody, CreateTaxVersionRequestBody, TaxRule, TaxVersionDetail, CreateTax, UpdateTaxVersion, UpdateTaxRequestBody, TaxRuleItem, TaxRules, TaxVersionPastData, TaxRuleVersion, HSCodeItem, HSCodes, GetTaxComponents, ActionPage, ValidationError, Price1, MultiCategoriesSchema, NetQuantitySchema, CustomMeta, TaxStatusEnum, HsTypeEnum, PageType };
4662
4665
  }
4663
4666
  /** @returns {Action} */
4664
4667
  declare function Action(): Action;
@@ -7808,26 +7811,6 @@ type GetCollectionDetailNest = {
7808
7811
  */
7809
7812
  is_visible?: boolean;
7810
7813
  };
7811
- /** @returns {GetCollectionItemsResponseSchema} */
7812
- declare function GetCollectionItemsResponseSchema(): GetCollectionItemsResponseSchema;
7813
- type GetCollectionItemsResponseSchema = {
7814
- /**
7815
- * - An array of filters applicable to
7816
- * the products in the collection.
7817
- */
7818
- filters?: ProductFilters[];
7819
- /**
7820
- * - An array of products that
7821
- * belong to the collection.
7822
- */
7823
- items?: ApplicationProductsSchema[];
7824
- page?: Page;
7825
- /**
7826
- * - Sorting options available for the
7827
- * products in the collection.
7828
- */
7829
- sort_on?: ProductSortOn[];
7830
- };
7831
7814
  /** @returns {GetCollectionListingResponseSchema} */
7832
7815
  declare function GetCollectionListingResponseSchema(): GetCollectionListingResponseSchema;
7833
7816
  type GetCollectionListingResponseSchema = {
@@ -8428,6 +8411,12 @@ type GetCollectionDetailResponseSchema = {
8428
8411
  * for filtering.
8429
8412
  */
8430
8413
  visible_facets_keys?: string[];
8414
+ /**
8415
+ * - Array of item `uid`
8416
+ * that have been manually handpicked for this collection. Will be an empty
8417
+ * array if the collection type is not handpicked.
8418
+ */
8419
+ handpicked_collection_item_ids?: string[];
8431
8420
  };
8432
8421
  /** @returns {CommonResponseSchemaCollection} */
8433
8422
  declare function CommonResponseSchemaCollection(): CommonResponseSchemaCollection;
@@ -8478,8 +8467,40 @@ type GetQueryFiltersResponseSchema = {
8478
8467
  /** @returns {GetCollectionItemsResponseSchemaV2} */
8479
8468
  declare function GetCollectionItemsResponseSchemaV2(): GetCollectionItemsResponseSchemaV2;
8480
8469
  type GetCollectionItemsResponseSchemaV2 = {
8481
- items?: ProductDetailV2[];
8482
- page?: Page1;
8470
+ items?: CollectionItemV2[];
8471
+ page?: Page;
8472
+ };
8473
+ /** @returns {CollectionItemV2} */
8474
+ declare function CollectionItemV2(): CollectionItemV2;
8475
+ type CollectionItemV2 = {
8476
+ /**
8477
+ * - The name of the product
8478
+ */
8479
+ name: string;
8480
+ /**
8481
+ * - A brief description of the product
8482
+ */
8483
+ short_description?: string;
8484
+ /**
8485
+ * - Media items (images, videos) associated with the product
8486
+ */
8487
+ medias?: Media[];
8488
+ /**
8489
+ * - URL-friendly identifier for the product
8490
+ */
8491
+ slug: string;
8492
+ /**
8493
+ * - Unique identifier for the product
8494
+ */
8495
+ uid: number;
8496
+ /**
8497
+ * - Item code or SKU of the product
8498
+ */
8499
+ item_code: string;
8500
+ /**
8501
+ * - Type of the product
8502
+ */
8503
+ item_type: string;
8483
8504
  };
8484
8505
  /** @returns {Page1} */
8485
8506
  declare function Page1(): Page1;
@@ -10443,7 +10464,7 @@ type Page = {
10443
10464
  */
10444
10465
  current?: number;
10445
10466
  /**
10446
- * - The type of the page, such as 'PageType'.
10467
+ * - The type of the page, can be 'cursor' or 'number'.
10447
10468
  */
10448
10469
  type: string;
10449
10470
  /**