@gofynd/fdk-client-javascript 1.4.2-beta.7 → 1.4.4

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 (254) hide show
  1. package/README.md +1 -10
  2. package/application.d.ts +3 -3
  3. package/common.d.ts +3 -3
  4. package/index.d.ts +15 -15
  5. package/package.json +5 -3
  6. package/partner.d.ts +3 -3
  7. package/platform.d.ts +3 -3
  8. package/public.d.ts +2 -2
  9. package/sdk/application/ApplicationAPIClient.d.ts +1 -1
  10. package/sdk/application/ApplicationAPIClient.js +0 -1
  11. package/sdk/application/ApplicationClient.d.ts +17 -17
  12. package/sdk/application/ApplicationConfig.d.ts +3 -3
  13. package/sdk/application/Cart/CartApplicationClient.d.ts +58 -58
  14. package/sdk/application/Cart/CartApplicationClient.js +56 -56
  15. package/sdk/application/Cart/CartApplicationValidator.d.ts +1 -1
  16. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +72 -72
  17. package/sdk/application/Catalog/CatalogApplicationClient.js +69 -69
  18. package/sdk/application/Common/CommonApplicationClient.d.ts +6 -6
  19. package/sdk/application/Common/CommonApplicationClient.js +4 -4
  20. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +8 -8
  21. package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
  22. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
  23. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +34 -34
  24. package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -32
  25. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +1 -1
  26. package/sdk/application/Content/ContentApplicationClient.d.ts +48 -48
  27. package/sdk/application/Content/ContentApplicationClient.js +45 -45
  28. package/sdk/application/Content/ContentApplicationModel.d.ts +18 -18
  29. package/sdk/application/Content/ContentApplicationModel.js +26 -26
  30. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +7 -7
  31. package/sdk/application/FileStorage/FileStorageApplicationClient.js +15 -9
  32. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +1 -1
  33. package/sdk/application/Lead/LeadApplicationClient.d.ts +12 -12
  34. package/sdk/application/Lead/LeadApplicationClient.js +10 -10
  35. package/sdk/application/Lead/LeadApplicationModel.d.ts +64 -77
  36. package/sdk/application/Lead/LeadApplicationModel.js +42 -52
  37. package/sdk/application/Lead/LeadApplicationValidator.d.ts +1 -1
  38. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +24 -24
  39. package/sdk/application/Logistic/LogisticApplicationClient.js +22 -22
  40. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +1 -1
  41. package/sdk/application/Order/OrderApplicationClient.d.ts +19 -30
  42. package/sdk/application/Order/OrderApplicationClient.js +17 -97
  43. package/sdk/application/Order/OrderApplicationValidator.d.ts +2 -16
  44. package/sdk/application/Order/OrderApplicationValidator.js +0 -13
  45. package/sdk/application/Payment/PaymentApplicationClient.d.ts +91 -91
  46. package/sdk/application/Payment/PaymentApplicationClient.js +94 -94
  47. package/sdk/application/Payment/PaymentApplicationModel.d.ts +5 -2
  48. package/sdk/application/Payment/PaymentApplicationModel.js +4 -2
  49. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +6 -6
  50. package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
  51. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +29 -29
  52. package/sdk/application/PosCart/PosCartApplicationClient.js +27 -27
  53. package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +1 -1
  54. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +9 -9
  55. package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
  56. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +1 -1
  57. package/sdk/application/Share/ShareApplicationClient.d.ts +9 -9
  58. package/sdk/application/Share/ShareApplicationClient.js +7 -7
  59. package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
  60. package/sdk/application/Share/ShareApplicationModel.js +2 -0
  61. package/sdk/application/Share/ShareApplicationValidator.d.ts +1 -1
  62. package/sdk/application/Theme/ThemeApplicationClient.d.ts +10 -10
  63. package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
  64. package/sdk/application/Theme/ThemeApplicationModel.d.ts +25 -32
  65. package/sdk/application/Theme/ThemeApplicationModel.js +30 -40
  66. package/sdk/application/User/UserApplicationClient.d.ts +76 -76
  67. package/sdk/application/User/UserApplicationClient.js +74 -74
  68. package/sdk/application/User/UserApplicationModel.d.ts +44 -13
  69. package/sdk/application/User/UserApplicationModel.js +17 -13
  70. package/sdk/application/User/UserApplicationValidator.d.ts +1 -1
  71. package/sdk/application/index.d.ts +18 -18
  72. package/sdk/common/AxiosHelper.d.ts +1 -1
  73. package/sdk/common/AxiosHelper.js +38 -17
  74. package/sdk/common/Clickstream.js +22 -16
  75. package/sdk/common/curlHelper.js +1 -3
  76. package/sdk/common/utils.d.ts +15 -0
  77. package/sdk/common/utils.js +30 -0
  78. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +3 -3
  79. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +2 -2
  80. package/sdk/partner/Lead/LeadPartnerClient.d.ts +3 -3
  81. package/sdk/partner/Lead/LeadPartnerClient.js +1 -1
  82. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +5 -5
  83. package/sdk/partner/Logistics/LogisticsPartnerClient.js +4 -4
  84. package/sdk/partner/OAuthClient.d.ts +4 -4
  85. package/sdk/partner/PartnerAPIClient.d.ts +1 -1
  86. package/sdk/partner/PartnerAPIClient.js +0 -1
  87. package/sdk/partner/PartnerClient.d.ts +6 -6
  88. package/sdk/partner/PartnerConfig.d.ts +4 -4
  89. package/sdk/partner/Theme/ThemePartnerClient.d.ts +20 -20
  90. package/sdk/partner/Theme/ThemePartnerClient.js +19 -19
  91. package/sdk/partner/Theme/ThemePartnerModel.d.ts +25 -32
  92. package/sdk/partner/Theme/ThemePartnerModel.js +30 -40
  93. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +3 -3
  94. package/sdk/partner/Webhook/WebhookPartnerClient.js +2 -2
  95. package/sdk/partner/index.d.ts +7 -7
  96. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -8
  97. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +6 -6
  98. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -1
  99. package/sdk/platform/Billing/BillingPlatformClient.d.ts +25 -25
  100. package/sdk/platform/Billing/BillingPlatformClient.js +23 -23
  101. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +1 -1
  102. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +115 -115
  103. package/sdk/platform/Cart/CartPlatformApplicationClient.js +113 -113
  104. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +1 -1
  105. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +147 -146
  106. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +146 -145
  107. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1 -1
  108. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +156 -156
  109. package/sdk/platform/Catalog/CatalogPlatformClient.js +153 -153
  110. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +65 -28
  111. package/sdk/platform/Catalog/CatalogPlatformModel.js +68 -36
  112. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1 -1
  113. package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -5
  114. package/sdk/platform/Common/CommonPlatformClient.js +3 -3
  115. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +133 -133
  116. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +131 -131
  117. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +1 -1
  118. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +4 -4
  119. package/sdk/platform/Communication/CommunicationPlatformClient.js +2 -2
  120. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +12 -0
  121. package/sdk/platform/Communication/CommunicationPlatformModel.js +12 -0
  122. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +28 -28
  123. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +25 -25
  124. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -0
  125. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +2 -0
  126. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +1 -1
  127. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +52 -52
  128. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +50 -50
  129. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +1 -1
  130. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +31 -31
  131. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +29 -29
  132. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +1 -1
  133. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +128 -128
  134. package/sdk/platform/Content/ContentPlatformApplicationClient.js +131 -131
  135. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +5 -5
  136. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
  137. package/sdk/platform/Content/ContentPlatformClient.d.ts +33 -33
  138. package/sdk/platform/Content/ContentPlatformClient.js +37 -37
  139. package/sdk/platform/Content/ContentPlatformModel.d.ts +18 -18
  140. package/sdk/platform/Content/ContentPlatformModel.js +26 -26
  141. package/sdk/platform/Content/ContentPlatformValidator.d.ts +5 -5
  142. package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
  143. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +24 -24
  144. package/sdk/platform/Discount/DiscountPlatformClient.js +22 -22
  145. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +1 -1
  146. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +24 -23
  147. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +32 -25
  148. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
  149. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +15 -15
  150. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +28 -19
  151. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +12 -1
  152. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +16 -2
  153. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +1 -1
  154. package/sdk/platform/Finance/FinancePlatformClient.d.ts +30 -30
  155. package/sdk/platform/Finance/FinancePlatformClient.js +28 -28
  156. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +1 -1
  157. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +19 -19
  158. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +17 -17
  159. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +1 -1
  160. package/sdk/platform/Lead/LeadPlatformClient.d.ts +20 -20
  161. package/sdk/platform/Lead/LeadPlatformClient.js +18 -18
  162. package/sdk/platform/Lead/LeadPlatformModel.d.ts +62 -77
  163. package/sdk/platform/Lead/LeadPlatformModel.js +40 -52
  164. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +1 -1
  165. package/sdk/platform/OAuthClient.d.ts +3 -3
  166. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +12 -12
  167. package/sdk/platform/Order/OrderPlatformApplicationClient.js +10 -10
  168. package/sdk/platform/Order/OrderPlatformClient.d.ts +111 -122
  169. package/sdk/platform/Order/OrderPlatformClient.js +109 -204
  170. package/sdk/platform/Order/OrderPlatformModel.d.ts +18 -2
  171. package/sdk/platform/Order/OrderPlatformModel.js +12 -2
  172. package/sdk/platform/Order/OrderPlatformValidator.d.ts +2 -34
  173. package/sdk/platform/Order/OrderPlatformValidator.js +0 -20
  174. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -6
  175. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
  176. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +1 -1
  177. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +97 -97
  178. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +95 -95
  179. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +1 -1
  180. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +13 -13
  181. package/sdk/platform/Payment/PaymentPlatformClient.js +11 -11
  182. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +7 -0
  183. package/sdk/platform/Payment/PaymentPlatformModel.js +3 -0
  184. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +1 -1
  185. package/sdk/platform/PlatformAPIClient.d.ts +1 -1
  186. package/sdk/platform/PlatformAPIClient.js +0 -1
  187. package/sdk/platform/PlatformApplicationClient.d.ts +16 -16
  188. package/sdk/platform/PlatformClient.d.ts +19 -21
  189. package/sdk/platform/PlatformClient.js +0 -4
  190. package/sdk/platform/PlatformConfig.d.ts +4 -4
  191. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +14 -14
  192. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
  193. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +1 -1
  194. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +42 -42
  195. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +40 -40
  196. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +1 -1
  197. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +55 -54
  198. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +53 -52
  199. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2 -2
  200. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +4 -2
  201. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +1 -1
  202. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +7 -7
  203. package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
  204. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
  205. package/sdk/platform/Share/SharePlatformModel.d.ts +4 -0
  206. package/sdk/platform/Share/SharePlatformModel.js +4 -0
  207. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +42 -112
  208. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +40 -597
  209. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +2 -101
  210. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -92
  211. package/sdk/platform/Theme/ThemePlatformClient.d.ts +8 -8
  212. package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
  213. package/sdk/platform/Theme/ThemePlatformModel.d.ts +25 -32
  214. package/sdk/platform/Theme/ThemePlatformModel.js +30 -40
  215. package/sdk/platform/Theme/ThemePlatformValidator.d.ts +1 -1
  216. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +37 -37
  217. package/sdk/platform/User/UserPlatformApplicationClient.js +35 -35
  218. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +1 -1
  219. package/sdk/platform/User/UserPlatformModel.d.ts +48 -13
  220. package/sdk/platform/User/UserPlatformModel.js +21 -13
  221. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +20 -19
  222. package/sdk/platform/Webhook/WebhookPlatformClient.js +18 -17
  223. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +2 -2
  224. package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
  225. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +1 -1
  226. package/sdk/platform/index.d.ts +24 -25
  227. package/sdk/platform/index.js +0 -2
  228. package/sdk/public/Billing/BillingPublicClient.d.ts +3 -3
  229. package/sdk/public/Billing/BillingPublicClient.js +4 -4
  230. package/sdk/public/Billing/BillingPublicValidator.d.ts +2 -2
  231. package/sdk/public/Billing/BillingPublicValidator.js +2 -2
  232. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -3
  233. package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -1
  234. package/sdk/public/Content/ContentPublicClient.d.ts +2 -2
  235. package/sdk/public/Content/ContentPublicValidator.d.ts +2 -2
  236. package/sdk/public/Content/ContentPublicValidator.js +3 -3
  237. package/sdk/public/Inventory/InventoryPublicClient.d.ts +2 -2
  238. package/sdk/public/Inventory/InventoryPublicModel.d.ts +8 -8
  239. package/sdk/public/Inventory/InventoryPublicModel.js +8 -8
  240. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +1 -1
  241. package/sdk/public/Partner/PartnerPublicClient.d.ts +3 -3
  242. package/sdk/public/Partner/PartnerPublicClient.js +1 -1
  243. package/sdk/public/PublicAPIClient.d.ts +1 -1
  244. package/sdk/public/PublicClient.d.ts +7 -7
  245. package/sdk/public/Webhook/WebhookPublicClient.d.ts +4 -4
  246. package/sdk/public/Webhook/WebhookPublicClient.js +2 -2
  247. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +1 -1
  248. package/sdk/public/index.d.ts +8 -8
  249. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +0 -152
  250. package/sdk/platform/Inventory/InventoryPlatformClient.js +0 -1017
  251. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +0 -1355
  252. package/sdk/platform/Inventory/InventoryPlatformModel.js +0 -1544
  253. package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +0 -171
  254. package/sdk/platform/Inventory/InventoryPlatformValidator.js +0 -159
@@ -42,8 +42,8 @@ declare class Catalog {
42
42
  * @param {import("../ApplicationAPIClient").Options} - Options
43
43
  * @returns {Promise<CatalogApplicationModel.FollowPostResponse>} - Success response
44
44
  * @name followById
45
- * @summary: Follows an item by ID.
46
- * @description: Adds a product, brand, or item to the user's followed list by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/followById/).
45
+ * @summary: Create item, brand, product
46
+ * @description: Adds a product, brand, or item to the user's followed list by collection Id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/followById/).
47
47
  */
48
48
  followById({ collectionType, collectionId, requestHeaders }?: CatalogApplicationValidator.FollowByIdParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.FollowPostResponse>;
49
49
  /**
@@ -52,7 +52,7 @@ declare class Catalog {
52
52
  * @param {import("../ApplicationAPIClient").Options} - Options
53
53
  * @returns {Promise<CatalogApplicationModel.BrandDetailResponse>} - Success response
54
54
  * @name getBrandDetailBySlug
55
- * @summary: Retrieves detailed brand info by slug.
55
+ * @summary: Get a brand
56
56
  * @description: Retrieve metadata of a brand such as name, information, logo, banner, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getBrandDetailBySlug/).
57
57
  */
58
58
  getBrandDetailBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetBrandDetailBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.BrandDetailResponse>;
@@ -62,8 +62,8 @@ declare class Catalog {
62
62
  * @param {import("../ApplicationAPIClient").Options} - Options
63
63
  * @returns {Promise<CatalogApplicationModel.BrandListingResponse>} - Success response
64
64
  * @name getBrands
65
- * @summary: Fetches all available brands.
66
- * @description: Retrieves a comprehensive list of all brands in the catalog under which a product is sold. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getBrands/).
65
+ * @summary: List brands
66
+ * @description: Retrieves a list of all the availabe brands. Filtering can be applied on department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getBrands/).
67
67
  */
68
68
  getBrands({ department, pageNo, pageSize, requestHeaders }?: CatalogApplicationValidator.GetBrandsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.BrandListingResponse>;
69
69
  /**
@@ -74,8 +74,8 @@ declare class Catalog {
74
74
  * from the endpoint /service/application/catalog/v1.0/departments/
75
75
  * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
76
76
  * @returns {Paginator<CatalogApplicationModel.BrandListingResponse>}
77
- * @summary: Fetches all available brands.
78
- * @description: Retrieves a comprehensive list of all brands in the catalog under which a product is sold.
77
+ * @summary: List brands
78
+ * @description: Retrieves a list of all the availabe brands. Filtering can be applied on department.
79
79
  */
80
80
  getBrandsPaginator({ department, pageSize }?: {
81
81
  department?: string;
@@ -88,8 +88,8 @@ declare class Catalog {
88
88
  * @returns {Promise<CatalogApplicationModel.CategoryListingResponse>} -
89
89
  * Success response
90
90
  * @name getCategories
91
- * @summary: Lists all product categories.
92
- * @description: Retrieves a list of all available product categories. Also filter the categories by department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCategories/).
91
+ * @summary: List product categories
92
+ * @description: Retrieves a list of all available product categories. Also user can filter the categories by department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCategories/).
93
93
  */
94
94
  getCategories({ department, requestHeaders }?: CatalogApplicationValidator.GetCategoriesParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.CategoryListingResponse>;
95
95
  /**
@@ -98,7 +98,7 @@ declare class Catalog {
98
98
  * @param {import("../ApplicationAPIClient").Options} - Options
99
99
  * @returns {Promise<CatalogApplicationModel.CategoryMetaResponse>} - Success response
100
100
  * @name getCategoryDetailBySlug
101
- * @summary: Retrieves category details by slug.
101
+ * @summary: Get category by slug
102
102
  * @description: Retrieve detailed information about a specific product category using its slug and Retrieve metadata of a category such as name, information, logo, banner, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCategoryDetailBySlug/).
103
103
  */
104
104
  getCategoryDetailBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetCategoryDetailBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.CategoryMetaResponse>;
@@ -111,7 +111,7 @@ declare class Catalog {
111
111
  * @returns {Promise<CatalogApplicationModel.CollectionDetailResponse>} -
112
112
  * Success response
113
113
  * @name getCollectionDetailBySlug
114
- * @summary: Retrieves collection details by slug.
114
+ * @summary: Get a collection
115
115
  * @description: Retrieve detailed information about a specific collection using its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCollectionDetailBySlug/).
116
116
  */
117
117
  getCollectionDetailBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetCollectionDetailBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.CollectionDetailResponse>;
@@ -123,8 +123,8 @@ declare class Catalog {
123
123
  * @returns {Promise<CatalogApplicationModel.ProductListingResponse>} -
124
124
  * Success response
125
125
  * @name getCollectionItemsBySlug
126
- * @summary: Lists items in a collection by slug.
127
- * @description: Retrieve items in a specific collection identified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCollectionItemsBySlug/).
126
+ * @summary: Lists items of collection
127
+ * @description: Fetch items within a particular collection identified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCollectionItemsBySlug/).
128
128
  */
129
129
  getCollectionItemsBySlug({ slug, f, q, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?: CatalogApplicationValidator.GetCollectionItemsBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductListingResponse>;
130
130
  /**
@@ -145,8 +145,8 @@ declare class Catalog {
145
145
  * either ascending or descending order. See the supported values below.
146
146
  * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
147
147
  * @returns {Paginator<CatalogApplicationModel.ProductListingResponse>}
148
- * @summary: Lists items in a collection by slug.
149
- * @description: Retrieve items in a specific collection identified by its slug.
148
+ * @summary: Lists items of collection
149
+ * @description: Fetch items within a particular collection identified by its slug.
150
150
  */
151
151
  getCollectionItemsBySlugPaginator({ slug, f, q, filters, sortOn, pageSize, }?: {
152
152
  slug: string;
@@ -164,8 +164,8 @@ declare class Catalog {
164
164
  * - Success response
165
165
  *
166
166
  * @name getCollections
167
- * @summary: Fetches all available collections.
168
- * @description: Retrieves a list of curated product collections. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCollections/).
167
+ * @summary: List Collection
168
+ * @description: Retrieve a list of curated product collections with filtering options based on tags and collection names. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCollections/).
169
169
  */
170
170
  getCollections({ pageNo, pageSize, tag, q, requestHeaders }?: CatalogApplicationValidator.GetCollectionsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.GetCollectionListingResponse>;
171
171
  /**
@@ -174,8 +174,8 @@ declare class Catalog {
174
174
  * @param {string[]} [arg.tag] - List of tags to filter collections
175
175
  * @param {string} [arg.q] - Name of the collection to filter collection
176
176
  * @returns {Paginator<CatalogApplicationModel.GetCollectionListingResponse>}
177
- * @summary: Fetches all available collections.
178
- * @description: Retrieves a list of curated product collections.
177
+ * @summary: List Collection
178
+ * @description: Retrieve a list of curated product collections with filtering options based on tags and collection names.
179
179
  */
180
180
  getCollectionsPaginator({ pageSize, tag, q }?: {
181
181
  pageSize?: number;
@@ -192,7 +192,7 @@ declare class Catalog {
192
192
  * - Success response
193
193
  *
194
194
  * @name getComparedFrequentlyProductBySlug
195
- * @summary: Retrieves products frequently compared with a given product.
195
+ * @summary: List frequent products
196
196
  * @description: Retrieve products that are often compared to the product specified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getComparedFrequentlyProductBySlug/).
197
197
  */
198
198
  getComparedFrequentlyProductBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetComparedFrequentlyProductBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductFrequentlyComparedSimilarResponse>;
@@ -202,8 +202,8 @@ declare class Catalog {
202
202
  * @param {import("../ApplicationAPIClient").Options} - Options
203
203
  * @returns {Promise<CatalogApplicationModel.DepartmentResponse>} - Success response
204
204
  * @name getDepartments
205
- * @summary: Lists all departments.
206
- * @description: Retrieves a list of all available product departments. Departments are a way to categorise similar products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getDepartments/).
205
+ * @summary: List departments
206
+ * @description: Retrieve a list of all departments associated with available products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getDepartments/).
207
207
  */
208
208
  getDepartments({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogApplicationModel.DepartmentResponse>;
209
209
  /**
@@ -212,8 +212,8 @@ declare class Catalog {
212
212
  * @param {import("../ApplicationAPIClient").Options} - Options
213
213
  * @returns {Promise<CatalogApplicationModel.FollowIdsResponse>} - Success response
214
214
  * @name getFollowIds
215
- * @summary: Fetches IDs of followed items.
216
- * @description: Retrieves the IDs of all items the user is currently following like Products, Brands and Collections. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getFollowIds/).
215
+ * @summary: List Ids of followed item, brand, product
216
+ * @description: Retrieves the IDs of all items the user is currently following like Products, Brands and Collections - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getFollowIds/).
217
217
  */
218
218
  getFollowIds({ collectionType, requestHeaders }?: CatalogApplicationValidator.GetFollowIdsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.FollowIdsResponse>;
219
219
  /**
@@ -223,7 +223,7 @@ declare class Catalog {
223
223
  * @returns {Promise<CatalogApplicationModel.GetFollowListingResponse>} -
224
224
  * Success response
225
225
  * @name getFollowedListing
226
- * @summary: Retrieves user's followed listings.
226
+ * @summary: List followed products/brands
227
227
  * @description: Retrieve a list of products or brands the user is following. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getFollowedListing/).
228
228
  */
229
229
  getFollowedListing({ collectionType, pageId, pageSize, requestHeaders }?: CatalogApplicationValidator.GetFollowedListingParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.GetFollowListingResponse>;
@@ -233,7 +233,7 @@ declare class Catalog {
233
233
  * products, brands, or collections.
234
234
  * @param {number} [arg.pageSize] - Page ID to retrieve next set of results.
235
235
  * @returns {Paginator<CatalogApplicationModel.GetFollowListingResponse>}
236
- * @summary: Retrieves user's followed listings.
236
+ * @summary: List followed products/brands
237
237
  * @description: Retrieve a list of products or brands the user is following.
238
238
  */
239
239
  getFollowedListingPaginator({ collectionType, pageSize }?: {
@@ -247,8 +247,8 @@ declare class Catalog {
247
247
  * @returns {Promise<CatalogApplicationModel.FollowerCountResponse>} -
248
248
  * Success response
249
249
  * @name getFollowerCountById
250
- * @summary: Retrieves follower count for an item.
251
- * @description: Retrieves the total number of followers for a specific item by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getFollowerCountById/).
250
+ * @summary: Get follower count
251
+ * @description: Retrieves the total number of followers for a specific item by its Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getFollowerCountById/).
252
252
  */
253
253
  getFollowerCountById({ collectionType, collectionId, requestHeaders }?: CatalogApplicationValidator.GetFollowerCountByIdParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.FollowerCountResponse>;
254
254
  /**
@@ -257,7 +257,7 @@ declare class Catalog {
257
257
  * @param {import("../ApplicationAPIClient").Options} - Options
258
258
  * @returns {Promise<CatalogApplicationModel.HomeListingResponse>} - Success response
259
259
  * @name getHomeProducts
260
- * @summary: Fetches homepage-featured products.
260
+ * @summary: List homepage-featured products
261
261
  * @description: List all the products associated with a brand, collection or category in a random order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getHomeProducts/).
262
262
  */
263
263
  getHomeProducts({ sortOn, pageId, pageSize, requestHeaders }?: CatalogApplicationValidator.GetHomeProductsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.HomeListingResponse>;
@@ -268,7 +268,7 @@ declare class Catalog {
268
268
  * either ascending or descending order.
269
269
  * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
270
270
  * @returns {Paginator<CatalogApplicationModel.HomeListingResponse>}
271
- * @summary: Fetches homepage-featured products.
271
+ * @summary: List homepage-featured products
272
272
  * @description: List all the products associated with a brand, collection or category in a random order.
273
273
  */
274
274
  getHomeProductsPaginator({ sortOn, pageSize }?: {
@@ -282,8 +282,8 @@ declare class Catalog {
282
282
  * @returns {Promise<CatalogApplicationModel.ApplicationStoreListing>} -
283
283
  * Success response
284
284
  * @name getInStockLocations
285
- * @summary: Finds in-stock locations for products.
286
- * @description: Lists locations where specified products are currently in stock. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getInStockLocations/).
285
+ * @summary: List stores with inventory
286
+ * @description: Lists stores where specified products are currently in stock. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getInStockLocations/).
287
287
  */
288
288
  getInStockLocations({ pageNo, pageSize, q, city, range, latitude, longitude, requestHeaders, }?: CatalogApplicationValidator.GetInStockLocationsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ApplicationStoreListing>;
289
289
  /**
@@ -298,8 +298,8 @@ declare class Catalog {
298
298
  * @param {number} [arg.longitude] - Longitude of the location from where
299
299
  * one wants to retreive the nearest stores, e.g. 19.1174114
300
300
  * @returns {Paginator<CatalogApplicationModel.ApplicationStoreListing>}
301
- * @summary: Finds in-stock locations for products.
302
- * @description: Lists locations where specified products are currently in stock.
301
+ * @summary: List stores with inventory
302
+ * @description: Lists stores where specified products are currently in stock.
303
303
  */
304
304
  getInStockLocationsPaginator({ pageSize, q, city, range, latitude, longitude, }?: {
305
305
  pageSize?: number;
@@ -315,8 +315,8 @@ declare class Catalog {
315
315
  * @param {import("../ApplicationAPIClient").Options} - Options
316
316
  * @returns {Promise<CatalogApplicationModel.StoreDetails>} - Success response
317
317
  * @name getLocationDetailsById
318
- * @summary: Retrieves location details by ID.
319
- * @description: Retrieves detailed information about a specific location using its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getLocationDetailsById/).
318
+ * @summary: Get selling location
319
+ * @description: This API retrieves comprehensive details about a store based on its location Id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getLocationDetailsById/).
320
320
  */
321
321
  getLocationDetailsById({ locationId, requestHeaders }?: CatalogApplicationValidator.GetLocationDetailsByIdParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.StoreDetails>;
322
322
  /**
@@ -325,7 +325,7 @@ declare class Catalog {
325
325
  * @param {import("../ApplicationAPIClient").Options} - Options
326
326
  * @returns {Promise<CatalogApplicationModel.ProductBundle>} - Success response
327
327
  * @name getProductBundlesBySlug
328
- * @summary: Fetches product bundles by slug.
328
+ * @summary: List product bundles
329
329
  * @description: Retrieve products bundles to the one specified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductBundlesBySlug/).
330
330
  */
331
331
  getProductBundlesBySlug({ slug, id, requestHeaders }?: CatalogApplicationValidator.GetProductBundlesBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductBundle>;
@@ -338,8 +338,8 @@ declare class Catalog {
338
338
  * @returns {Promise<CatalogApplicationModel.ProductsComparisonResponse>} -
339
339
  * Success response
340
340
  * @name getProductComparisonBySlugs
341
- * @summary: Compares multiple products by slugs.
342
- * @description: Retrieves side-by-side comparisons of multiple products identified by their slugs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductComparisonBySlugs/).
341
+ * @summary: List products for comparison
342
+ * @description: Retrives all the products that have same category. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductComparisonBySlugs/).
343
343
  */
344
344
  getProductComparisonBySlugs({ slug, requestHeaders }?: CatalogApplicationValidator.GetProductComparisonBySlugsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductsComparisonResponse>;
345
345
  /**
@@ -348,8 +348,8 @@ declare class Catalog {
348
348
  * @param {import("../ApplicationAPIClient").Options} - Options
349
349
  * @returns {Promise<CatalogApplicationModel.ProductDetail>} - Success response
350
350
  * @name getProductDetailBySlug
351
- * @summary: Fetches detailed product information by slug.
352
- * @description: Retrieve a product by its slug value. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductDetailBySlug/).
351
+ * @summary: Get a product
352
+ * @description: Fetches properties related to Product such as price, attributes, HSN code, SKU code, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductDetailBySlug/).
353
353
  */
354
354
  getProductDetailBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetProductDetailBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductDetail>;
355
355
  /**
@@ -359,7 +359,7 @@ declare class Catalog {
359
359
  * @returns {Promise<CatalogApplicationModel.ProductSizePriceResponseV3>} -
360
360
  * Success response
361
361
  * @name getProductPriceBySlug
362
- * @summary: Retrieves product price by slug.
362
+ * @summary: Get product price
363
363
  * @description: Retrieve the price of a product size at all the selling locations near to a PIN Code. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductPriceBySlug/).
364
364
  */
365
365
  getProductPriceBySlug({ slug, size, storeId, moq, requestHeaders }?: CatalogApplicationValidator.GetProductPriceBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductSizePriceResponseV3>;
@@ -371,8 +371,8 @@ declare class Catalog {
371
371
  * - Success response
372
372
  *
373
373
  * @name getProductSellersBySlug
374
- * @summary: Lists sellers for a product by slug.
375
- * @description: Retrieve a list of all sellers offering a specific product identified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductSellersBySlug/).
374
+ * @summary: List sellers
375
+ * @description: Retrieve a list of all sellers offering a specific product identified by its slug and size - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductSellersBySlug/).
376
376
  */
377
377
  getProductSellersBySlug({ slug, size, strategy, pageNo, pageSize, requestHeaders }?: CatalogApplicationValidator.GetProductSellersBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductSizeSellersResponseV3>;
378
378
  /**
@@ -387,8 +387,8 @@ declare class Catalog {
387
387
  * eg, fast-delivery, low-price, optimal.
388
388
  * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
389
389
  * @returns {Paginator<CatalogApplicationModel.ProductSizeSellersResponseV3>}
390
- * @summary: Lists sellers for a product by slug.
391
- * @description: Retrieve a list of all sellers offering a specific product identified by its slug.
390
+ * @summary: List sellers
391
+ * @description: Retrieve a list of all sellers offering a specific product identified by its slug and size
392
392
  */
393
393
  getProductSellersBySlugPaginator({ slug, size, strategy, pageSize }?: {
394
394
  slug: string;
@@ -402,8 +402,8 @@ declare class Catalog {
402
402
  * @param {import("../ApplicationAPIClient").Options} - Options
403
403
  * @returns {Promise<CatalogApplicationModel.ProductSizes>} - Success response
404
404
  * @name getProductSizesBySlug
405
- * @summary: Retrieves available sizes for a product by slug.
406
- * @description: Retrieve the size options available for a specific product based on its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductSizesBySlug/).
405
+ * @summary: List sizes
406
+ * @description: Provides detailed information about a product, including its availability (sellable), available sizes with quantities, dimensions, weight, availability status, price details (marked, effective, selling), minimum order quantity (MOQ). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductSizesBySlug/).
407
407
  */
408
408
  getProductSizesBySlug({ slug, storeId, requestHeaders }?: CatalogApplicationValidator.GetProductSizesBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductSizes>;
409
409
  /**
@@ -413,8 +413,8 @@ declare class Catalog {
413
413
  * @returns {Promise<CatalogApplicationModel.ProductStockStatusResponse>} -
414
414
  * Success response
415
415
  * @name getProductStockByIds
416
- * @summary: Checks product stock by IDs.
417
- * @description: Retrieves the current stock status for products identified by their IDs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductStockByIds/).
416
+ * @summary: Get product stocks
417
+ * @description: Retrieves the current stock status for products identified by their IDs. such as SKU,ALU,EAN etc - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductStockByIds/).
418
418
  */
419
419
  getProductStockByIds({ itemId, alu, skuCode, ean, upc, requestHeaders }?: CatalogApplicationValidator.GetProductStockByIdsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductStockStatusResponse>;
420
420
  /**
@@ -425,8 +425,8 @@ declare class Catalog {
425
425
  * @param {import("../ApplicationAPIClient").Options} - Options
426
426
  * @returns {Promise<CatalogApplicationModel.ProductStockPolling>} - Success response
427
427
  * @name getProductStockForTimeByIds
428
- * @summary: Fetches future stock data for products.
429
- * @description: Retrieves projected stock levels for specified products at a future time. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductStockForTimeByIds/).
428
+ * @summary: List future stock
429
+ * @description: Retrives the available stock levels for all products associated with a particular sales channel at a specified future time. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductStockForTimeByIds/).
430
430
  */
431
431
  getProductStockForTimeByIds({ timestamp, pageSize, pageId, requestHeaders }?: CatalogApplicationValidator.GetProductStockForTimeByIdsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductStockPolling>;
432
432
  /**
@@ -434,8 +434,8 @@ declare class Catalog {
434
434
  * @param {string} arg.timestamp - Timestamp in UTC format (2020-07-23T10:27:50Z)
435
435
  * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
436
436
  * @returns {Paginator<CatalogApplicationModel.ProductStockPolling>}
437
- * @summary: Fetches future stock data for products.
438
- * @description: Retrieves projected stock levels for specified products at a future time.
437
+ * @summary: List future stock
438
+ * @description: Retrives the available stock levels for all products associated with a particular sales channel at a specified future time.
439
439
  */
440
440
  getProductStockForTimeByIdsPaginator({ timestamp, pageSize }?: {
441
441
  timestamp: string;
@@ -449,7 +449,7 @@ declare class Catalog {
449
449
  * @returns {Promise<CatalogApplicationModel.ProductVariantsResponse>} -
450
450
  * Success response
451
451
  * @name getProductVariantsBySlug
452
- * @summary: Retrieves product variants by slug.
452
+ * @summary: List product variant
453
453
  * @description: Retrieves all available variants of a specific product identified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductVariantsBySlug/).
454
454
  */
455
455
  getProductVariantsBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetProductVariantsBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductVariantsResponse>;
@@ -460,8 +460,8 @@ declare class Catalog {
460
460
  * @returns {Promise<CatalogApplicationModel.ProductListingResponse>} -
461
461
  * Success response
462
462
  * @name getProducts
463
- * @summary: Lists all products.
464
- * @description: Retrieves a list of all products in the catalog. Choose a sort order or make arbitrary search queries by entering the product name, brand, category or collection. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProducts/).
463
+ * @summary: List products
464
+ * @description: Retrieves a list of all products available in the catalog. It supports filtering based on product name, brand, department, category, collection, and more, while also offering sorting options based on factors like price, ratings, discounts, and other relevant criteria. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProducts/).
465
465
  */
466
466
  getProducts({ q, f, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?: CatalogApplicationValidator.GetProductsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductListingResponse>;
467
467
  /**
@@ -479,8 +479,8 @@ declare class Catalog {
479
479
  * either ascending or descending order. See the supported values below.
480
480
  * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
481
481
  * @returns {Paginator<CatalogApplicationModel.ProductListingResponse>}
482
- * @summary: Lists all products.
483
- * @description: Retrieves a list of all products in the catalog. Choose a sort order or make arbitrary search queries by entering the product name, brand, category or collection.
482
+ * @summary: List products
483
+ * @description: Retrieves a list of all products available in the catalog. It supports filtering based on product name, brand, department, category, collection, and more, while also offering sorting options based on factors like price, ratings, discounts, and other relevant criteria.
484
484
  */
485
485
  getProductsPaginator({ q, f, filters, sortOn, pageSize }?: {
486
486
  q?: string;
@@ -495,8 +495,8 @@ declare class Catalog {
495
495
  * @param {import("../ApplicationAPIClient").Options} - Options
496
496
  * @returns {Promise<CatalogApplicationModel.AutoCompleteResponse>} - Success response
497
497
  * @name getSearchResults
498
- * @summary: Retrieves search result listings.
499
- * @description: Retrieves products that match the user's search criteria. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getSearchResults/).
498
+ * @summary: List product, brand, category
499
+ * @description: Retrieve products, brands, or categories based on a search query, which can be a partial or full name match. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getSearchResults/).
500
500
  */
501
501
  getSearchResults({ q, requestHeaders }?: CatalogApplicationValidator.GetSearchResultsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.AutoCompleteResponse>;
502
502
  /**
@@ -508,8 +508,8 @@ declare class Catalog {
508
508
  * @returns {Promise<CatalogApplicationModel.ProductCompareResponse>} -
509
509
  * Success response
510
510
  * @name getSimilarComparisonProductBySlug
511
- * @summary: Fetches similar products for comparison.
512
- * @description: Gets products similar to the one identified by the given slug for comparison. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getSimilarComparisonProductBySlug/).
511
+ * @summary: List similar products
512
+ * @description: Retrives all products within the same category as the one specified by the provided slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getSimilarComparisonProductBySlug/).
513
513
  */
514
514
  getSimilarComparisonProductBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetSimilarComparisonProductBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductCompareResponse>;
515
515
  /**
@@ -518,8 +518,8 @@ declare class Catalog {
518
518
  * @param {import("../ApplicationAPIClient").Options} - Options
519
519
  * @returns {Promise<CatalogApplicationModel.StoreListingResponse>} - Success response
520
520
  * @name getStores
521
- * @summary: Lists available stores.
522
- * @description: Retrieves a list of all physical or online stores. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getStores/).
521
+ * @summary: List available stores
522
+ * @description: Retrieves a list of all stores associated with sales channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getStores/).
523
523
  */
524
524
  getStores({ pageNo, pageSize, q, city, range, latitude, longitude, tags, requestHeaders, }?: CatalogApplicationValidator.GetStoresParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.StoreListingResponse>;
525
525
  /**
@@ -535,8 +535,8 @@ declare class Catalog {
535
535
  * one wants to retreive the nearest stores, e.g. 19.1174114
536
536
  * @param {string} [arg.tags] - Search stores based on tags.
537
537
  * @returns {Paginator<CatalogApplicationModel.StoreListingResponse>}
538
- * @summary: Lists available stores.
539
- * @description: Retrieves a list of all physical or online stores.
538
+ * @summary: List available stores
539
+ * @description: Retrieves a list of all stores associated with sales channel
540
540
  */
541
541
  getStoresPaginator({ pageSize, q, city, range, latitude, longitude, tags, }?: {
542
542
  pageSize?: number;
@@ -553,11 +553,11 @@ declare class Catalog {
553
553
  * @param {import("../ApplicationAPIClient").Options} - Options
554
554
  * @returns {Promise<CatalogApplicationModel.FollowPostResponse>} - Success response
555
555
  * @name unfollowById
556
- * @summary: Unfollows an item by ID.
557
- * @description: Removes a followed item, brand, or product based on its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/unfollowById/).
556
+ * @summary: Delete item, brand, product
557
+ * @description: Removes a followed item, brand, or product using its collection ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/unfollowById/).
558
558
  */
559
559
  unfollowById({ collectionType, collectionId, requestHeaders }?: CatalogApplicationValidator.UnfollowByIdParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.FollowPostResponse>;
560
560
  }
561
- import CatalogApplicationValidator = require("./CatalogApplicationValidator");
562
- import CatalogApplicationModel = require("./CatalogApplicationModel");
563
- import Paginator = require("../../common/Paginator");
561
+ import CatalogApplicationValidator = require("sdk/output/javascript/code/sdk/application/Catalog/CatalogApplicationValidator");
562
+ import CatalogApplicationModel = require("sdk/output/javascript/code/sdk/application/Catalog/CatalogApplicationModel");
563
+ import Paginator = require("sdk/output/javascript/code/sdk/common/Paginator");