@gofynd/fdk-client-javascript 1.6.4 → 3.0.0-beta.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 (298) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/ApplicationClient.d.ts +0 -2
  4. package/sdk/application/ApplicationClient.js +0 -2
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +113 -93
  6. package/sdk/application/Cart/CartApplicationClient.js +270 -139
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +122 -138
  9. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
  10. package/sdk/application/Common/CommonApplicationClient.js +3 -3
  11. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +43 -3
  12. package/sdk/application/Communication/CommunicationApplicationClient.js +190 -3
  13. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +71 -36
  14. package/sdk/application/Configuration/ConfigurationApplicationClient.js +103 -29
  15. package/sdk/application/Content/ContentApplicationClient.d.ts +51 -21
  16. package/sdk/application/Content/ContentApplicationClient.js +197 -36
  17. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -6
  18. package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
  19. package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
  20. package/sdk/application/Lead/LeadApplicationClient.js +3 -3
  21. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +79 -64
  22. package/sdk/application/Logistic/LogisticApplicationClient.js +246 -264
  23. package/sdk/application/Order/OrderApplicationClient.d.ts +44 -24
  24. package/sdk/application/Order/OrderApplicationClient.js +140 -21
  25. package/sdk/application/Payment/PaymentApplicationClient.d.ts +211 -111
  26. package/sdk/application/Payment/PaymentApplicationClient.js +610 -109
  27. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
  28. package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
  29. package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
  30. package/sdk/application/Share/ShareApplicationClient.js +14 -14
  31. package/sdk/application/Theme/ThemeApplicationClient.d.ts +23 -3
  32. package/sdk/application/Theme/ThemeApplicationClient.js +103 -5
  33. package/sdk/application/User/UserApplicationClient.d.ts +13 -23
  34. package/sdk/application/User/UserApplicationClient.js +9 -57
  35. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
  36. package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
  37. package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +66 -0
  38. package/sdk/partner/Authorization/AuthorizationPartnerClient.js +431 -0
  39. package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +231 -0
  40. package/sdk/partner/Authorization/AuthorizationPartnerModel.js +152 -0
  41. package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +8 -0
  42. package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +39 -0
  43. package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +26 -0
  44. package/sdk/partner/Catalog/CatalogPartnerClient.js +173 -0
  45. package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +238 -0
  46. package/sdk/partner/Catalog/CatalogPartnerModel.js +248 -0
  47. package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +5 -0
  48. package/sdk/partner/Catalog/CatalogPartnerValidator.js +19 -0
  49. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -22
  50. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +12 -87
  51. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +33 -99
  52. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +25 -84
  53. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +0 -1
  54. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -10
  55. package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
  56. package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
  57. package/sdk/partner/Lead/LeadPartnerModel.d.ts +100 -49
  58. package/sdk/partner/Lead/LeadPartnerModel.js +100 -74
  59. package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
  60. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +33 -160
  61. package/sdk/partner/Logistics/LogisticsPartnerClient.js +66 -1180
  62. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +288 -1685
  63. package/sdk/partner/Logistics/LogisticsPartnerModel.js +226 -824
  64. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +1 -13
  65. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +14 -141
  66. package/sdk/partner/PartnerClient.d.ts +6 -0
  67. package/sdk/partner/PartnerClient.js +9 -0
  68. package/sdk/partner/Payment/PaymentPartnerClient.d.ts +116 -0
  69. package/sdk/partner/Payment/PaymentPartnerClient.js +857 -0
  70. package/sdk/partner/Payment/PaymentPartnerModel.d.ts +388 -0
  71. package/sdk/partner/Payment/PaymentPartnerModel.js +442 -0
  72. package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +14 -0
  73. package/sdk/partner/Payment/PaymentPartnerValidator.js +74 -0
  74. package/sdk/partner/Theme/ThemePartnerClient.d.ts +63 -21
  75. package/sdk/partner/Theme/ThemePartnerClient.js +396 -71
  76. package/sdk/partner/Theme/ThemePartnerModel.d.ts +104 -72
  77. package/sdk/partner/Theme/ThemePartnerModel.js +101 -75
  78. package/sdk/partner/Theme/ThemePartnerValidator.d.ts +5 -1
  79. package/sdk/partner/Theme/ThemePartnerValidator.js +42 -12
  80. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
  81. package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
  82. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +191 -670
  83. package/sdk/partner/Webhook/WebhookPartnerModel.js +159 -268
  84. package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
  85. package/sdk/partner/index.d.ts +3 -0
  86. package/sdk/partner/index.js +6 -0
  87. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +1 -4
  88. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
  89. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +5 -0
  90. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -1
  91. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
  92. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
  93. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +145 -49
  94. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +171 -20
  95. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
  96. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
  97. package/sdk/platform/Billing/BillingPlatformClient.d.ts +406 -15
  98. package/sdk/platform/Billing/BillingPlatformClient.js +3214 -76
  99. package/sdk/platform/Billing/BillingPlatformModel.d.ts +3798 -459
  100. package/sdk/platform/Billing/BillingPlatformModel.js +2577 -342
  101. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +465 -24
  102. package/sdk/platform/Billing/BillingPlatformValidator.js +490 -14
  103. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +284 -205
  104. package/sdk/platform/Cart/CartPlatformApplicationClient.js +671 -553
  105. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +165 -165
  106. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +108 -132
  107. package/sdk/platform/Cart/CartPlatformModel.d.ts +3136 -4788
  108. package/sdk/platform/Cart/CartPlatformModel.js +2850 -2031
  109. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1015 -419
  110. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +6450 -2010
  111. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1121 -230
  112. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +919 -127
  113. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +372 -574
  114. package/sdk/platform/Catalog/CatalogPlatformClient.js +1238 -1317
  115. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +8351 -9825
  116. package/sdk/platform/Catalog/CatalogPlatformModel.js +9662 -6881
  117. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +288 -235
  118. package/sdk/platform/Catalog/CatalogPlatformValidator.js +241 -183
  119. package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -6
  120. package/sdk/platform/Common/CommonPlatformClient.js +5 -6
  121. package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
  122. package/sdk/platform/Common/CommonPlatformModel.js +6 -6
  123. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +374 -234
  124. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +875 -583
  125. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +170 -139
  126. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +145 -126
  127. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +56 -3
  128. package/sdk/platform/Communication/CommunicationPlatformClient.js +307 -4
  129. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +424 -252
  130. package/sdk/platform/Communication/CommunicationPlatformModel.js +540 -320
  131. package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +62 -3
  132. package/sdk/platform/Communication/CommunicationPlatformValidator.js +48 -2
  133. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +68 -99
  134. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +84 -140
  135. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +238 -256
  136. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +222 -244
  137. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +20 -20
  138. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -20
  139. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +333 -118
  140. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1470 -409
  141. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +158 -55
  142. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +163 -41
  143. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +151 -61
  144. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +595 -101
  145. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +1199 -462
  146. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1008 -321
  147. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +80 -34
  148. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +79 -24
  149. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +253 -140
  150. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1087 -458
  151. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +221 -178
  152. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +220 -157
  153. package/sdk/platform/Content/ContentPlatformClient.d.ts +124 -123
  154. package/sdk/platform/Content/ContentPlatformClient.js +459 -379
  155. package/sdk/platform/Content/ContentPlatformModel.d.ts +833 -1307
  156. package/sdk/platform/Content/ContentPlatformModel.js +893 -582
  157. package/sdk/platform/Content/ContentPlatformValidator.d.ts +140 -150
  158. package/sdk/platform/Content/ContentPlatformValidator.js +131 -135
  159. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +60 -36
  160. package/sdk/platform/Discount/DiscountPlatformClient.js +85 -36
  161. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +46 -47
  162. package/sdk/platform/Discount/DiscountPlatformModel.js +42 -46
  163. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
  164. package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
  165. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -15
  166. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +24 -22
  167. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -4
  168. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -4
  169. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
  170. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
  171. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +75 -86
  172. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +60 -74
  173. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  174. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  175. package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
  176. package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
  177. package/sdk/platform/Finance/FinancePlatformModel.d.ts +2895 -0
  178. package/sdk/platform/Finance/FinancePlatformModel.js +2150 -0
  179. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
  180. package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
  181. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +17 -17
  182. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +33 -33
  183. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +19 -19
  184. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +14 -14
  185. package/sdk/platform/Lead/LeadPlatformClient.d.ts +4 -24
  186. package/sdk/platform/Lead/LeadPlatformClient.js +4 -160
  187. package/sdk/platform/Lead/LeadPlatformModel.d.ts +142 -57
  188. package/sdk/platform/Lead/LeadPlatformModel.js +162 -79
  189. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +3 -29
  190. package/sdk/platform/Lead/LeadPlatformValidator.js +2 -28
  191. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +94 -25
  192. package/sdk/platform/Order/OrderPlatformApplicationClient.js +600 -57
  193. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +115 -115
  194. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +120 -43
  195. package/sdk/platform/Order/OrderPlatformClient.d.ts +502 -293
  196. package/sdk/platform/Order/OrderPlatformClient.js +1466 -913
  197. package/sdk/platform/Order/OrderPlatformModel.d.ts +4103 -9109
  198. package/sdk/platform/Order/OrderPlatformModel.js +3198 -4245
  199. package/sdk/platform/Order/OrderPlatformValidator.d.ts +445 -612
  200. package/sdk/platform/Order/OrderPlatformValidator.js +316 -326
  201. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
  202. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
  203. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
  204. package/sdk/platform/Partner/PartnerPlatformModel.js +7 -7
  205. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +382 -135
  206. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +2453 -935
  207. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +306 -93
  208. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +305 -70
  209. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +66 -56
  210. package/sdk/platform/Payment/PaymentPlatformClient.js +269 -124
  211. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +3525 -1313
  212. package/sdk/platform/Payment/PaymentPlatformModel.js +3813 -1511
  213. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +64 -35
  214. package/sdk/platform/Payment/PaymentPlatformValidator.js +60 -34
  215. package/sdk/platform/PlatformClient.d.ts +2 -0
  216. package/sdk/platform/PlatformClient.js +4 -0
  217. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
  218. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
  219. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
  220. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
  221. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +14 -9
  222. package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -8
  223. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +344 -56
  224. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +2180 -302
  225. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +380 -54
  226. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +336 -37
  227. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +127 -213
  228. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +538 -1306
  229. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +3429 -2979
  230. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3642 -1785
  231. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +218 -392
  232. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +151 -290
  233. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +4 -16
  234. package/sdk/platform/Share/SharePlatformApplicationClient.js +8 -86
  235. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -23
  236. package/sdk/platform/Share/SharePlatformApplicationValidator.js +3 -16
  237. package/sdk/platform/Share/SharePlatformModel.d.ts +6 -50
  238. package/sdk/platform/Share/SharePlatformModel.js +3 -43
  239. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +26 -4
  240. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +157 -10
  241. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +21 -10
  242. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +23 -6
  243. package/sdk/platform/Theme/ThemePlatformClient.d.ts +18 -8
  244. package/sdk/platform/Theme/ThemePlatformClient.js +85 -8
  245. package/sdk/platform/Theme/ThemePlatformModel.d.ts +425 -17
  246. package/sdk/platform/Theme/ThemePlatformModel.js +329 -23
  247. package/sdk/platform/Theme/ThemePlatformValidator.d.ts +7 -3
  248. package/sdk/platform/Theme/ThemePlatformValidator.js +9 -2
  249. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +18 -71
  250. package/sdk/platform/User/UserPlatformApplicationClient.js +27 -412
  251. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +10 -114
  252. package/sdk/platform/User/UserPlatformApplicationValidator.js +7 -80
  253. package/sdk/platform/User/UserPlatformModel.d.ts +216 -264
  254. package/sdk/platform/User/UserPlatformModel.js +209 -216
  255. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
  256. package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
  257. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +428 -810
  258. package/sdk/platform/Webhook/WebhookPlatformModel.js +395 -444
  259. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
  260. package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
  261. package/sdk/platform/index.d.ts +1 -0
  262. package/sdk/platform/index.js +2 -0
  263. package/sdk/public/Billing/BillingPublicClient.d.ts +56 -0
  264. package/sdk/public/Billing/BillingPublicClient.js +397 -0
  265. package/sdk/public/Billing/BillingPublicModel.d.ts +919 -0
  266. package/sdk/public/Billing/BillingPublicModel.js +560 -0
  267. package/sdk/public/Billing/BillingPublicValidator.d.ts +43 -0
  268. package/sdk/public/Billing/BillingPublicValidator.js +50 -0
  269. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -4
  270. package/sdk/public/Configuration/ConfigurationPublicClient.js +97 -9
  271. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +102 -40
  272. package/sdk/public/Configuration/ConfigurationPublicModel.js +111 -29
  273. package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +11 -1
  274. package/sdk/public/Configuration/ConfigurationPublicValidator.js +12 -0
  275. package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
  276. package/sdk/public/Content/ContentPublicClient.js +183 -0
  277. package/sdk/public/Content/ContentPublicModel.d.ts +38 -1
  278. package/sdk/public/Content/ContentPublicModel.js +47 -1
  279. package/sdk/public/Content/ContentPublicValidator.d.ts +17 -1
  280. package/sdk/public/Content/ContentPublicValidator.js +19 -0
  281. package/sdk/public/PublicClient.d.ts +2 -2
  282. package/sdk/public/PublicClient.js +2 -2
  283. package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
  284. package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
  285. package/sdk/public/Webhook/WebhookPublicModel.d.ts +67 -215
  286. package/sdk/public/Webhook/WebhookPublicModel.js +61 -66
  287. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  288. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  289. package/sdk/public/index.d.ts +1 -1
  290. package/sdk/public/index.js +1 -1
  291. package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
  292. package/sdk/application/Finance/FinanceApplicationClient.js +0 -126
  293. package/sdk/public/Catalog/CatalogPublicClient.d.ts +0 -22
  294. package/sdk/public/Catalog/CatalogPublicClient.js +0 -138
  295. package/sdk/public/Catalog/CatalogPublicModel.d.ts +0 -155
  296. package/sdk/public/Catalog/CatalogPublicModel.js +0 -116
  297. package/sdk/public/Catalog/CatalogPublicValidator.d.ts +0 -55
  298. package/sdk/public/Catalog/CatalogPublicValidator.js +0 -35
@@ -13,46 +13,100 @@ declare class Catalog {
13
13
  * - Success response
14
14
  *
15
15
  * @name addCollectionItems
16
- * @summary: Create items in a collection
17
- * @description: Adds items to a collection specified by its id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/addCollectionItems/).
16
+ * @summary: Add items to a collection
17
+ * @description: Adds items to a collection specified by its `id`. See `CollectionItemRequest` for the list of attributes needed to add items to an collection. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/addCollectionItems/).
18
18
  */
19
19
  addCollectionItems({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.AddCollectionItemsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CommonResponseSchemaCollection>;
20
+ /**
21
+ * @param {CatalogPlatformApplicationValidator.AddProductsInPriceFactoryByZoneIdParam} arg
22
+ * - Arg object
23
+ *
24
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
25
+ * @param {import("../PlatformAPIClient").Options} - Options
26
+ * @returns {Promise<CatalogPlatformModel.CreatePriceFactoryProductResponse>}
27
+ * - Success response
28
+ *
29
+ * @name addProductsInPriceFactoryByZoneId
30
+ * @summary: Add products to price factory
31
+ * @description: This API allows to add products in price factory. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/addProductsInPriceFactoryByZoneId/).
32
+ */
33
+ addProductsInPriceFactoryByZoneId({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.AddProductsInPriceFactoryByZoneIdParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreatePriceFactoryProductResponse>;
34
+ /**
35
+ * @param {CatalogPlatformApplicationValidator.ClearCollectionItemsPriorityParam} arg
36
+ * - Arg object
37
+ *
38
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
39
+ * @param {import("../PlatformAPIClient").Options} - Options
40
+ * @returns {Promise<CatalogPlatformModel.CommonResponseSchemaCollection>}
41
+ * - Success response
42
+ *
43
+ * @name clearCollectionItemsPriority
44
+ * @summary: Clear priorities set for collection items.
45
+ * @description: Clear priorities set for collection items. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/clearCollectionItemsPriority/).
46
+ */
47
+ clearCollectionItemsPriority({ id, requestHeaders }?: CatalogPlatformApplicationValidator.ClearCollectionItemsPriorityParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CommonResponseSchemaCollection>;
20
48
  /**
21
49
  * @param {CatalogPlatformApplicationValidator.CreateAppCategoryReturnConfigurationParam} arg
22
50
  * - Arg object
23
51
  *
24
52
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
25
53
  * @param {import("../PlatformAPIClient").Options} - Options
26
- * @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
54
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
27
55
  * @name createAppCategoryReturnConfiguration
28
- * @summary: Create return configuration
29
- * @description: Create Category level sales channel Return Configuration setttings - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createAppCategoryReturnConfiguration/).
56
+ * @summary: Create Category level Application Return Configuration setttings
57
+ * @description: Create Category level Application Return Configuration setttings - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createAppCategoryReturnConfiguration/).
58
+ */
59
+ createAppCategoryReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateAppCategoryReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
60
+ /**
61
+ * @param {CatalogPlatformApplicationValidator.CreateAppPriceFactoryParam} arg
62
+ * - Arg object
63
+ *
64
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
65
+ * @param {import("../PlatformAPIClient").Options} - Options
66
+ * @returns {Promise<CatalogPlatformModel.CreateAppPriceFactoryResponse>} -
67
+ * Success response
68
+ * @name createAppPriceFactory
69
+ * @summary: Create price factory
70
+ * @description: This API allows to create price factory. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createAppPriceFactory/).
30
71
  */
31
- createAppCategoryReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateAppCategoryReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
72
+ createAppPriceFactory({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateAppPriceFactoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateAppPriceFactoryResponse>;
32
73
  /**
33
74
  * @param {CatalogPlatformApplicationValidator.CreateAppReturnConfigurationParam} arg
34
75
  * - Arg object
35
76
  *
36
77
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
37
78
  * @param {import("../PlatformAPIClient").Options} - Options
38
- * @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
79
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
39
80
  * @name createAppReturnConfiguration
40
- * @summary: Create product return configuration
41
- * @description: This allows you to configure all return-related settings, such as is_returnable and return window etc. for sales channel level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createAppReturnConfiguration/).
81
+ * @summary: Create Return configuration level set for an application
82
+ * @description: Create Return configuration level set for an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createAppReturnConfiguration/).
42
83
  */
43
- createAppReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateAppReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
84
+ createAppReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateAppReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
44
85
  /**
45
- * @param {CatalogPlatformApplicationValidator.CreateCollectionParam} arg - Arg object
86
+ * @param {CatalogPlatformApplicationValidator.CreateAutocompleteSettingsParam} arg
87
+ * - Arg object
88
+ *
46
89
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
47
90
  * @param {import("../PlatformAPIClient").Options} - Options
48
- * @returns {Promise<CatalogPlatformModel.CollectionCreateResponseSchema>}
91
+ * @returns {Promise<CatalogPlatformModel.AutocompleteUpsertResponseSchema>}
49
92
  * - Success response
50
93
  *
94
+ * @name createAutocompleteSettings
95
+ * @summary: Create autocomplete settings config for an application
96
+ * @description: This API allows to create autocomplete settings for an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createAutocompleteSettings/).
97
+ */
98
+ createAutocompleteSettings({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateAutocompleteSettingsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AutocompleteUpsertResponseSchema>;
99
+ /**
100
+ * @param {CatalogPlatformApplicationValidator.CreateCollectionParam} arg - Arg object
101
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
102
+ * @param {import("../PlatformAPIClient").Options} - Options
103
+ * @returns {Promise<CatalogPlatformModel.CollectionCreateResponse>} -
104
+ * Success response
51
105
  * @name createCollection
52
- * @summary: Create a collection
53
- * @description: Create a collection for a sales channel linked to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCollection/).
106
+ * @summary: Add a Collection
107
+ * @description: Create a collection to the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCollection/).
54
108
  */
55
- createCollection({ body, q, scheduleStatus, type, tags, isActive, pageNo, pageSize, requestHeaders, }?: CatalogPlatformApplicationValidator.CreateCollectionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CollectionCreateResponseSchema>;
109
+ createCollection({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateCollectionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CollectionCreateResponse>;
56
110
  /**
57
111
  * @param {CatalogPlatformApplicationValidator.CreateConfigurationByTypeParam} arg
58
112
  * - Arg object
@@ -62,8 +116,8 @@ declare class Catalog {
62
116
  * @returns {Promise<CatalogPlatformModel.GetAppCatalogConfiguration>} -
63
117
  * Success response
64
118
  * @name createConfigurationByType
65
- * @summary: Create configuration
66
- * @description: Add configuration details based on a specific type in the catalog for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createConfigurationByType/).
119
+ * @summary: Create configuration by type.
120
+ * @description: Add configuration for categories & brands. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createConfigurationByType/).
67
121
  */
68
122
  createConfigurationByType({ type, body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateConfigurationByTypeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAppCatalogConfiguration>;
69
123
  /**
@@ -75,8 +129,8 @@ declare class Catalog {
75
129
  * @returns {Promise<CatalogPlatformModel.GetAppCatalogConfiguration>} -
76
130
  * Success response
77
131
  * @name createConfigurationProductListing
78
- * @summary: Create product listing configuration
79
- * @description: Add configuration for products & listing specific to a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createConfigurationProductListing/).
132
+ * @summary: Create configuration for product listing.
133
+ * @description: Add configuration for products & listing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createConfigurationProductListing/).
80
134
  */
81
135
  createConfigurationProductListing({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateConfigurationProductListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAppCatalogConfiguration>;
82
136
  /**
@@ -85,14 +139,14 @@ declare class Catalog {
85
139
  *
86
140
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
87
141
  * @param {import("../PlatformAPIClient").Options} - Options
88
- * @returns {Promise<CatalogPlatformModel.CreateAutocompleteWordsResponseSchema>}
142
+ * @returns {Promise<CatalogPlatformModel.CreateAutocompleteWordsResponse>}
89
143
  * - Success response
90
144
  *
91
145
  * @name createCustomAutocompleteRule
92
- * @summary: Create autocomplete configurations
93
- * @description: Create custom autocomplete keyword configurations for a specific sales channel to map any endpoint with these keywords. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCustomAutocompleteRule/).
146
+ * @summary: Create custom autocomplete rules.
147
+ * @description: Generate and add custom autocomplete rules to the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCustomAutocompleteRule/).
94
148
  */
95
- createCustomAutocompleteRule({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateCustomAutocompleteRuleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateAutocompleteWordsResponseSchema>;
149
+ createCustomAutocompleteRule({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateCustomAutocompleteRuleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateAutocompleteWordsResponse>;
96
150
  /**
97
151
  * @param {CatalogPlatformApplicationValidator.CreateCustomKeywordParam} arg
98
152
  * - Arg object
@@ -101,8 +155,8 @@ declare class Catalog {
101
155
  * @param {import("../PlatformAPIClient").Options} - Options
102
156
  * @returns {Promise<CatalogPlatformModel.GetSearchWordsData>} - Success response
103
157
  * @name createCustomKeyword
104
- * @summary: Create search keywords
105
- * @description: Create a Custom Search Keywords for a specific company and sales channel allows you to map certail conditions with the keywords to give you ultimate results. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCustomKeyword/).
158
+ * @summary: Create custom search keywords.
159
+ * @description: Create a Custom Search Keywords. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCustomKeyword/).
106
160
  */
107
161
  createCustomKeyword({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateCustomKeywordParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchWordsData>;
108
162
  /**
@@ -113,8 +167,8 @@ declare class Catalog {
113
167
  * @param {import("../PlatformAPIClient").Options} - Options
114
168
  * @returns {Promise<CatalogPlatformModel.AppConfigurationDetail>} - Success response
115
169
  * @name createGroupConfiguration
116
- * @summary: Create group configuration
117
- * @description: Create group configuration for a specific config_type for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createGroupConfiguration/).
170
+ * @summary: Create group configuration.
171
+ * @description: Create configuration for group configuration types. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createGroupConfiguration/).
118
172
  */
119
173
  createGroupConfiguration({ configType, body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateGroupConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppConfigurationDetail>;
120
174
  /**
@@ -123,50 +177,155 @@ declare class Catalog {
123
177
  *
124
178
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
125
179
  * @param {import("../PlatformAPIClient").Options} - Options
126
- * @returns {Promise<CatalogPlatformModel.AppConfigurationsSort>} - Success response
180
+ * @returns {Promise<CatalogPlatformModel.AppConfigurationsFilterResponse>}
181
+ * - Success response
182
+ *
127
183
  * @name createListingConfiguration
128
- * @summary: Create listing configuration
129
- * @description: Add configuration for product catalog listing specific to a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createListingConfiguration/).
184
+ * @summary: Create listing configuration.
185
+ * @description: Add configuration for catalog listing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createListingConfiguration/).
186
+ */
187
+ createListingConfiguration({ configType, body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateListingConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppConfigurationsFilterResponse>;
188
+ /**
189
+ * @param {CatalogPlatformApplicationValidator.CreateMerchandisingRuleBoostActionParam} arg
190
+ * - Arg object
191
+ *
192
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
193
+ * @param {import("../PlatformAPIClient").Options} - Options
194
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseMerchandising>} -
195
+ * Success response
196
+ * @name createMerchandisingRuleBoostAction
197
+ * @summary: Create Merchandising Rule's Boost action details
198
+ * @description: This allows you to create Boost action of a merchandising rule. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createMerchandisingRuleBoostAction/).
199
+ */
200
+ createMerchandisingRuleBoostAction({ merchandisingRuleId, body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateMerchandisingRuleBoostActionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseMerchandising>;
201
+ /**
202
+ * @param {CatalogPlatformApplicationValidator.CreateMerchandisingRuleBuryActionParam} arg
203
+ * - Arg object
204
+ *
205
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
206
+ * @param {import("../PlatformAPIClient").Options} - Options
207
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseMerchandising>} -
208
+ * Success response
209
+ * @name createMerchandisingRuleBuryAction
210
+ * @summary: Get Merchandising Rule's Bury action details
211
+ * @description: This allows you to create Bury action of a merchandising rule. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createMerchandisingRuleBuryAction/).
212
+ */
213
+ createMerchandisingRuleBuryAction({ merchandisingRuleId, body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateMerchandisingRuleBuryActionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseMerchandising>;
214
+ /**
215
+ * @param {CatalogPlatformApplicationValidator.CreateMerchandisingRuleHideActionParam} arg
216
+ * - Arg object
217
+ *
218
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
219
+ * @param {import("../PlatformAPIClient").Options} - Options
220
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseMerchandising>} -
221
+ * Success response
222
+ * @name createMerchandisingRuleHideAction
223
+ * @summary: Create Merchandising Rule's Hide action details
224
+ * @description: This allows you to create hide action of a merchandising rule. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createMerchandisingRuleHideAction/).
225
+ */
226
+ createMerchandisingRuleHideAction({ merchandisingRuleId, body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateMerchandisingRuleHideActionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseMerchandising>;
227
+ /**
228
+ * @param {CatalogPlatformApplicationValidator.CreateMerchandisingRulePinActionParam} arg
229
+ * - Arg object
230
+ *
231
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
232
+ * @param {import("../PlatformAPIClient").Options} - Options
233
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseMerchandising>} -
234
+ * Success response
235
+ * @name createMerchandisingRulePinAction
236
+ * @summary: Create Merchandising Rule's action details
237
+ * @description: This allows you to create pin action of a merchandising rule. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createMerchandisingRulePinAction/).
238
+ */
239
+ createMerchandisingRulePinAction({ merchandisingRuleId, body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateMerchandisingRulePinActionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseMerchandising>;
240
+ /**
241
+ * @param {CatalogPlatformApplicationValidator.CreateMerchandisingRuleQueryParam} arg
242
+ * - Arg object
243
+ *
244
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
245
+ * @param {import("../PlatformAPIClient").Options} - Options
246
+ * @returns {Promise<CatalogPlatformModel.MerchandiseQueryResponse>} -
247
+ * Success response
248
+ * @name createMerchandisingRuleQuery
249
+ * @summary: Create a Merchandising Rule's query
250
+ * @description: This allows you to Create a merchandising rule's query. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createMerchandisingRuleQuery/).
251
+ */
252
+ createMerchandisingRuleQuery({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateMerchandisingRuleQueryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.MerchandiseQueryResponse>;
253
+ /**
254
+ * @param {CatalogPlatformApplicationValidator.CreateProductPriceFactoryBulkJobParam} arg
255
+ * - Arg object
256
+ *
257
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
258
+ * @param {import("../PlatformAPIClient").Options} - Options
259
+ * @returns {Promise<CatalogPlatformModel.CreateAppPriceFactoryProductBulkJobResponse>}
260
+ * - Success response
261
+ *
262
+ * @name createProductPriceFactoryBulkJob
263
+ * @summary: Add products in price factory in bulk
264
+ * @description: This API allows to create bulk job for adding products in price factory. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductPriceFactoryBulkJob/).
130
265
  */
131
- createListingConfiguration({ configType, body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateListingConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppConfigurationsSort>;
266
+ createProductPriceFactoryBulkJob({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateProductPriceFactoryBulkJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateAppPriceFactoryProductBulkJobResponse>;
132
267
  /**
133
268
  * @param {CatalogPlatformApplicationValidator.CreateSearchConfigurationParam} arg
134
269
  * - Arg object
135
270
  *
136
271
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
137
272
  * @param {import("../PlatformAPIClient").Options} - Options
138
- * @returns {Promise<CatalogPlatformModel.CreateSearchConfigurationResponseSchema>}
273
+ * @returns {Promise<CatalogPlatformModel.CreateSearchConfigurationResponse>}
139
274
  * - Success response
140
275
  *
141
276
  * @name createSearchConfiguration
142
277
  * @summary: Create search configuration
143
- * @description: Create search configuration for the catalog for a specific company and sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createSearchConfiguration/).
278
+ * @description: Create search configuration for the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createSearchConfiguration/).
279
+ */
280
+ createSearchConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateSearchConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateSearchConfigurationResponse>;
281
+ /**
282
+ * @param {CatalogPlatformApplicationValidator.CreateSearchRerankParam} arg
283
+ * - Arg object
284
+ *
285
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
286
+ * @param {import("../PlatformAPIClient").Options} - Options
287
+ * @returns {Promise<CatalogPlatformModel.CreateSearchRerankResponse>} -
288
+ * Success response
289
+ * @name createSearchRerank
290
+ * @summary: Create search rerank for an application
291
+ * @description: This view allows you to create search rerank attributes for an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createSearchRerank/).
292
+ */
293
+ createSearchRerank({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateSearchRerankParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateSearchRerankResponse>;
294
+ /**
295
+ * @param {CatalogPlatformApplicationValidator.CreateSynonymsParam} arg - Arg object
296
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
297
+ * @param {import("../PlatformAPIClient").Options} - Options
298
+ * @returns {Promise<CatalogPlatformModel.SynonymCreateResponseSchema>} -
299
+ * Success response
300
+ * @name createSynonyms
301
+ * @summary: create oneway/ twoway search synonyms for an application
302
+ * @description: This view allows you to create search synonyms for an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createSynonyms/).
144
303
  */
145
- createSearchConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateSearchConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateSearchConfigurationResponseSchema>;
304
+ createSynonyms({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateSynonymsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SynonymCreateResponseSchema>;
146
305
  /**
147
306
  * @param {CatalogPlatformApplicationValidator.DeleteAppCategoryReturnConfigurationParam} arg
148
307
  * - Arg object
149
308
  *
150
309
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
151
310
  * @param {import("../PlatformAPIClient").Options} - Options
152
- * @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
311
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
153
312
  * @name deleteAppCategoryReturnConfiguration
154
- * @summary: Delete product return configuration
155
- * @description: Delete Category level sales channel Return Configuration setttings - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteAppCategoryReturnConfiguration/).
313
+ * @summary: Delete Category level Application Return Configuration setttings
314
+ * @description: Delete Category level Application Return Configuration setttings - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteAppCategoryReturnConfiguration/).
156
315
  */
157
- deleteAppCategoryReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteAppCategoryReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
316
+ deleteAppCategoryReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteAppCategoryReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
158
317
  /**
159
318
  * @param {CatalogPlatformApplicationValidator.DeleteAutocompleteKeywordParam} arg
160
319
  * - Arg object
161
320
  *
162
321
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
163
322
  * @param {import("../PlatformAPIClient").Options} - Options
164
- * @returns {Promise<CatalogPlatformModel.DeleteResponseSchema>} - Success response
323
+ * @returns {Promise<CatalogPlatformModel.DeleteResponse>} - Success response
165
324
  * @name deleteAutocompleteKeyword
166
- * @summary: Delete autocomplete keyword
167
- * @description: Delete custom autocomplete keyword configurations for a specific sales channel by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteAutocompleteKeyword/).
325
+ * @summary: Delete autocomplete keywords.
326
+ * @description: Delete a keywords by it's id. Returns an object that tells whether the keywords was deleted successfully - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteAutocompleteKeyword/).
168
327
  */
169
- deleteAutocompleteKeyword({ id, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteAutocompleteKeywordParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DeleteResponseSchema>;
328
+ deleteAutocompleteKeyword({ id, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteAutocompleteKeywordParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DeleteResponse>;
170
329
  /**
171
330
  * @param {CatalogPlatformApplicationValidator.DeleteCollectionParam} arg - Arg object
172
331
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -175,7 +334,7 @@ declare class Catalog {
175
334
  * - Success response
176
335
  *
177
336
  * @name deleteCollection
178
- * @summary: Delete a collection
337
+ * @summary: Delete a collection.
179
338
  * @description: Delete a collection by it's id. Returns an object that tells whether the collection was deleted successfully - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteCollection/).
180
339
  */
181
340
  deleteCollection({ id, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteCollectionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CommonResponseSchemaCollection>;
@@ -185,149 +344,202 @@ declare class Catalog {
185
344
  *
186
345
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
187
346
  * @param {import("../PlatformAPIClient").Options} - Options
188
- * @returns {Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>} -
189
- * Success response
347
+ * @returns {Promise<any>} - Success response
190
348
  * @name deleteGroupConfiguration
191
- * @summary: Delete group configuration
192
- * @description: Delete group configurations by its slug for a specific config_type for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteGroupConfiguration/).
349
+ * @summary: Delete group configuration.
350
+ * @description: Delete configuration of the product config type of the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteGroupConfiguration/).
193
351
  */
194
- deleteGroupConfiguration({ configType, groupSlug, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteGroupConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>;
352
+ deleteGroupConfiguration({ configType, groupSlug, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteGroupConfigurationParam, { responseHeaders }?: object): Promise<any>;
195
353
  /**
196
354
  * @param {CatalogPlatformApplicationValidator.DeleteListingConfigurationParam} arg
197
355
  * - Arg object
198
356
  *
199
357
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
200
358
  * @param {import("../PlatformAPIClient").Options} - Options
201
- * @returns {Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>} -
202
- * Success response
359
+ * @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
203
360
  * @name deleteListingConfiguration
204
- * @summary: Delete listing configuration
205
- * @description: Remove a specific product listing configuration by its config_id for a specific config_type for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteListingConfiguration/).
361
+ * @summary: Delete listing configuration.
362
+ * @description: Remove a specific listing configuration from the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteListingConfiguration/).
363
+ */
364
+ deleteListingConfiguration({ configType, configId, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteListingConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponse>;
365
+ /**
366
+ * @param {CatalogPlatformApplicationValidator.DeleteMerchandisingRuleParam} arg
367
+ * - Arg object
368
+ *
369
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
370
+ * @param {import("../PlatformAPIClient").Options} - Options
371
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseMerchandising>} -
372
+ * Success response
373
+ * @name deleteMerchandisingRule
374
+ * @summary: Delete a Merchandising Rule
375
+ * @description: This allows you to Update a merchandising rule. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteMerchandisingRule/).
376
+ */
377
+ deleteMerchandisingRule({ merchandisingRuleId, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteMerchandisingRuleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseMerchandising>;
378
+ /**
379
+ * @param {CatalogPlatformApplicationValidator.DeleteMerchandisingRulesPreviewParam} arg
380
+ * - Arg object
381
+ *
382
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
383
+ * @param {import("../PlatformAPIClient").Options} - Options
384
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseMerchandising>} -
385
+ * Success response
386
+ * @name deleteMerchandisingRulesPreview
387
+ * @summary: Delete a Merchandising Rule's preview
388
+ * @description: This allows you to Update a merchandising rule's preview. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteMerchandisingRulesPreview/).
206
389
  */
207
- deleteListingConfiguration({ configType, configId, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteListingConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>;
390
+ deleteMerchandisingRulesPreview({ merchandisingRuleId, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteMerchandisingRulesPreviewParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseMerchandising>;
208
391
  /**
209
392
  * @param {CatalogPlatformApplicationValidator.DeleteSearchConfigurationParam} arg
210
393
  * - Arg object
211
394
  *
212
395
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
213
396
  * @param {import("../PlatformAPIClient").Options} - Options
214
- * @returns {Promise<CatalogPlatformModel.DeleteSearchConfigurationResponseSchema>}
397
+ * @returns {Promise<CatalogPlatformModel.DeleteSearchConfigurationResponse>}
215
398
  * - Success response
216
399
  *
217
400
  * @name deleteSearchConfiguration
218
- * @summary: Delete search configuration
219
- * @description: Delete Search Configuration for a specific sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteSearchConfiguration/).
401
+ * @summary: Delete Search Configuration
402
+ * @description: Delete search configuration in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteSearchConfiguration/).
220
403
  */
221
- deleteSearchConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.DeleteSearchConfigurationResponseSchema>;
404
+ deleteSearchConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.DeleteSearchConfigurationResponse>;
222
405
  /**
223
406
  * @param {CatalogPlatformApplicationValidator.DeleteSearchKeywordsParam} arg
224
407
  * - Arg object
225
408
  *
226
409
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
227
410
  * @param {import("../PlatformAPIClient").Options} - Options
228
- * @returns {Promise<CatalogPlatformModel.DeleteResponseSchema>} - Success response
411
+ * @returns {Promise<CatalogPlatformModel.DeleteResponse>} - Success response
229
412
  * @name deleteSearchKeywords
230
- * @summary: Delete search keywords
231
- * @description: Delete a search keywords by its id for a specific company and sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteSearchKeywords/).
413
+ * @summary: Delete search keywords.
414
+ * @description: Delete a keywords by it's id. Returns an object that tells whether the keywords was deleted successfully - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteSearchKeywords/).
232
415
  */
233
- deleteSearchKeywords({ id, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteSearchKeywordsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DeleteResponseSchema>;
416
+ deleteSearchKeywords({ id, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteSearchKeywordsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DeleteResponse>;
234
417
  /**
235
- * @param {CatalogPlatformApplicationValidator.GetAllCollectionsParam} arg
418
+ * @param {CatalogPlatformApplicationValidator.DeleteSearchRerankConfigurationParam} arg
236
419
  * - Arg object
237
420
  *
238
421
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
239
422
  * @param {import("../PlatformAPIClient").Options} - Options
240
- * @returns {Promise<CatalogPlatformModel.GetCollectionListingResponseSchema>}
423
+ * @returns {Promise<CatalogPlatformModel.DeleteSearchRerankConfigurationResponse>}
241
424
  * - Success response
242
425
  *
243
- * @name getAllCollections
244
- * @summary: List collections
245
- * @description: Retrieve all collections based on criteria such as collection name, schedule status, and active status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllCollections/).
426
+ * @name deleteSearchRerankConfiguration
427
+ * @summary: Delete search rerank configuration for an application
428
+ * @description: This view allows you to delete search rerank configuration for an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteSearchRerankConfiguration/).
246
429
  */
247
- getAllCollections({ q, scheduleStatus, type, tags, isActive, pageNo, pageSize, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAllCollectionsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCollectionListingResponseSchema>;
430
+ deleteSearchRerankConfiguration({ id, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteSearchRerankConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DeleteSearchRerankConfigurationResponse>;
248
431
  /**
249
- * @param {Object} arg - Arg object.
250
- * @param {string} arg.companyId - A `company_id` is a unique identifier for
251
- * a particular seller account.
252
- * @param {string} arg.applicationId - A `application_id` is a unique
253
- * identifier for a particular sale channel.
254
- * @param {string} [arg.q] - Get collection list filtered by q string,
255
- * @param {string} [arg.scheduleStatus] - Get collection list filtered by
256
- * scheduled status,
257
- * @param {string} [arg.type] - Type of the collections
258
- * @param {string[]} [arg.tags] - Each response will contain next_id param,
259
- * which should be sent back to make pagination work.
260
- * @param {boolean} [arg.isActive] - Get collections filtered by active status.
261
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
262
- * page. Default is 12.
263
- * @returns {Paginator<CatalogPlatformModel.GetCollectionListingResponseSchema>}
264
- * @summary: List collections
265
- * @description: Retrieve all collections based on criteria such as collection name, schedule status, and active status.
432
+ * @param {CatalogPlatformApplicationValidator.DeleteSynonymParam} arg - Arg object
433
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
434
+ * @param {import("../PlatformAPIClient").Options} - Options
435
+ * @returns {Promise<CatalogPlatformModel.SynonymDeleteResponseSchema>} -
436
+ * Success response
437
+ * @name deleteSynonym
438
+ * @summary: Delete synonym for an application.
439
+ * @description: This view allows you to delete synonym for an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteSynonym/).
266
440
  */
267
- getAllCollectionsPaginator({ companyId, applicationId, q, scheduleStatus, type, tags, isActive, pageSize, }?: {
268
- companyId: string;
269
- applicationId: string;
270
- q?: string;
271
- scheduleStatus?: string;
272
- type?: string;
273
- tags?: string[];
274
- isActive?: boolean;
275
- pageSize?: number;
276
- }): Paginator<CatalogPlatformModel.GetCollectionListingResponseSchema>;
441
+ deleteSynonym({ id, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteSynonymParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SynonymDeleteResponseSchema>;
277
442
  /**
278
- * @param {CatalogPlatformApplicationValidator.GetAllSearchKeywordParam} arg
443
+ * @param {CatalogPlatformApplicationValidator.EditAppPriceFactoryParam} arg
444
+ * - Arg object
445
+ *
446
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
447
+ * @param {import("../PlatformAPIClient").Options} - Options
448
+ * @returns {Promise<CatalogPlatformModel.AppPriceFactory>} - Success response
449
+ * @name editAppPriceFactory
450
+ * @summary: Edit a price factory
451
+ * @description: This API allows to update price factory. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/editAppPriceFactory/).
452
+ */
453
+ editAppPriceFactory({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.EditAppPriceFactoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppPriceFactory>;
454
+ /**
455
+ * @param {CatalogPlatformApplicationValidator.ExportProductsInPriceFactoryParam} arg
456
+ * - Arg object
457
+ *
458
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
459
+ * @param {import("../PlatformAPIClient").Options} - Options
460
+ * @returns {Promise<CatalogPlatformModel.CreateAppPriceFactoryProductExportJobResponse>}
461
+ * - Success response
462
+ *
463
+ * @name exportProductsInPriceFactory
464
+ * @summary: Export products of price factory.
465
+ * @description: This API allows to export products in price factory. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/exportProductsInPriceFactory/).
466
+ */
467
+ exportProductsInPriceFactory({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.ExportProductsInPriceFactoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateAppPriceFactoryProductExportJobResponse>;
468
+ /**
469
+ * @param {CatalogPlatformApplicationValidator.ExportSynonymsParam} arg - Arg object
470
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
471
+ * @param {import("../PlatformAPIClient").Options} - Options
472
+ * @returns {Promise<CatalogPlatformModel.SynonymExportResponseSchema>} -
473
+ * Success response
474
+ * @name exportSynonyms
475
+ * @summary: Export synonym for an application.
476
+ * @description: This API allows you to start a job creates a csv file containing all the synonyms for that application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/exportSynonyms/).
477
+ */
478
+ exportSynonyms({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.SynonymExportResponseSchema>;
479
+ /**
480
+ * @param {CatalogPlatformApplicationValidator.GetAllCollectionsParam} arg
279
481
  * - Arg object
280
482
  *
281
483
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
282
484
  * @param {import("../PlatformAPIClient").Options} - Options
283
- * @returns {Promise<CatalogPlatformModel.GetSearchWordsResponseSchema>} -
485
+ * @returns {Promise<CatalogPlatformModel.GetCollectionListingResponse>} -
284
486
  * Success response
487
+ * @name getAllCollections
488
+ * @summary: Retrieve all collections.
489
+ * @description: A Collection allows you to organize your products into hierarchical groups. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllCollections/).
490
+ */
491
+ getAllCollections({ q, scheduleStatus, type, tag, isActive, pageNo, pageSize, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAllCollectionsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCollectionListingResponse>;
492
+ /**
493
+ * @param {CatalogPlatformApplicationValidator.GetAllSearchKeywordParam} arg
494
+ * - Arg object
495
+ *
496
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
497
+ * @param {import("../PlatformAPIClient").Options} - Options
498
+ * @returns {Promise<CatalogPlatformModel.GetSearchWordsResponse>} - Success response
285
499
  * @name getAllSearchKeyword
286
- * @summary: List search keywords
287
- * @description: Get all custom search keywords for a specific company and sales channel allows you to map certain conditions with the keywords to give you ultimate results. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllSearchKeyword/).
500
+ * @summary: Get all search keywords.
501
+ * @description: Custom Search Keyword allows you to map conditions with keywords to give you the ultimate results - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllSearchKeyword/).
288
502
  */
289
- getAllSearchKeyword({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchWordsResponseSchema>;
503
+ getAllSearchKeyword({ pageNo, pageSize, q, isActive, requestHeaders }?: CatalogPlatformApplicationValidator.GetAllSearchKeywordParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchWordsResponse>;
290
504
  /**
291
505
  * @param {CatalogPlatformApplicationValidator.GetAppCategoryReturnConfigParam} arg
292
506
  * - Arg object
293
507
  *
294
508
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
295
509
  * @param {import("../PlatformAPIClient").Options} - Options
296
- * @returns {Promise<CatalogPlatformModel.BaseAppCategoryReturnConfigResponseSchema>}
510
+ * @returns {Promise<CatalogPlatformModel.BaseAppCategoryReturnConfigResponse>}
297
511
  * - Success response
298
512
  *
299
513
  * @name getAppCategoryReturnConfig
300
- * @summary: Get category return configuration
301
- * @description: Get all category level configuration level set for an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppCategoryReturnConfig/).
514
+ * @summary: Get all category level configuration level set for an application
515
+ * @description: Get all category level configuration level set for an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppCategoryReturnConfig/).
302
516
  */
303
- getAppCategoryReturnConfig({ q, pageNo, pageSize, requestHeaders }?: CatalogPlatformApplicationValidator.GetAppCategoryReturnConfigParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BaseAppCategoryReturnConfigResponseSchema>;
517
+ getAppCategoryReturnConfig({ q, pageNo, pageSize, requestHeaders }?: CatalogPlatformApplicationValidator.GetAppCategoryReturnConfigParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BaseAppCategoryReturnConfigResponse>;
304
518
  /**
305
519
  * @param {CatalogPlatformApplicationValidator.GetAppInventoryParam} arg - Arg object
306
520
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
307
521
  * @param {import("../PlatformAPIClient").Options} - Options
308
- * @returns {Promise<CatalogPlatformModel.InventoryStockResponseSchema>} -
309
- * Success response
522
+ * @returns {Promise<CatalogPlatformModel.InventoryStockResponse>} - Success response
310
523
  * @name getAppInventory
311
- * @summary: List sales channel inventory
312
- * @description: Retrieve inventory data related to the sales channel. this can be used to get the Inventory status of products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppInventory/).
524
+ * @summary: Get application inventory.
525
+ * @description: Retrieve inventory data related to the application. Retrieve the available Inventory of the products. Use this API to get the Inventory status of products with the filters of timestamp, store_ids, brand_ids, item_id, Items, Pagination - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppInventory/).
313
526
  */
314
- getAppInventory({ itemIds, storeIds, brandIds, sellerIdentifiers, timestamp, pageSize, pageId, qtyGt, qtyLt, qtyType, fromDate, toDate, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryStockResponseSchema>;
527
+ getAppInventory({ itemIds, storeIds, brandIds, sellerIdentifiers, timestamp, pageSize, pageId, qtyGt, qtyLt, qtyType, fromDate, toDate, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryStockResponse>;
315
528
  /**
316
529
  * @param {CatalogPlatformApplicationValidator.GetAppLocationsParam} arg - Arg object
317
530
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
318
531
  * @param {import("../PlatformAPIClient").Options} - Options
319
- * @returns {Promise<CatalogPlatformModel.LocationListSchema>} - Success response
532
+ * @returns {Promise<CatalogPlatformModel.LocationListSerializer>} - Success response
320
533
  * @name getAppLocations
321
- * @summary: List sales channels
322
- * @description: Retrieve all stores associated with a sales channel, with support for searching by store name and filtering by store type and status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppLocations/).
534
+ * @summary: Get application locations.
535
+ * @description: Retrieve locations specific to the application. View all the locations asscoiated to a application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppLocations/).
323
536
  */
324
- getAppLocations({ storeType, uid, q, stage, pageNo, pageSize, tags, storeTypes, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppLocationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.LocationListSchema>;
537
+ getAppLocations({ storeType, uid, q, stage, pageNo, pageSize, tags, storeTypes, companyUids, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppLocationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.LocationListSerializer>;
325
538
  /**
326
539
  * @param {Object} arg - Arg object.
327
- * @param {number} arg.companyId - A `company_id` is a unique identifier for
328
- * a particular seller account.
329
- * @param {string} arg.applicationId - A `application_id` is a unique
330
- * identifier for a particular sale channel.
540
+ * @param {number} arg.companyId - Id of the company whose locations are to fetched
541
+ * @param {string} arg.applicationId - Id of the application whose locations
542
+ * are to fetched
331
543
  * @param {string} [arg.storeType] - Helps to sort the location list on the
332
544
  * basis of location type.
333
545
  * @param {number[]} [arg.uid] - Helps to sort the location list on the
@@ -339,11 +551,13 @@ declare class Catalog {
339
551
  * page. Default is 20.
340
552
  * @param {string[]} [arg.tags] - Get locations filtered by tags.
341
553
  * @param {string[]} [arg.storeTypes] - Get locations filtered by store types.
342
- * @returns {Paginator<CatalogPlatformModel.LocationListSchema>}
343
- * @summary: List sales channels
344
- * @description: Retrieve all stores associated with a sales channel, with support for searching by store name and filtering by store type and status.
554
+ * @param {number[]} [arg.companyUids] - Filter stores by company IDs
555
+ * available in the application.
556
+ * @returns {Paginator<CatalogPlatformModel.LocationListSerializer>}
557
+ * @summary: Get application locations.
558
+ * @description: Retrieve locations specific to the application. View all the locations asscoiated to a application.
345
559
  */
346
- getAppLocationsPaginator({ companyId, applicationId, storeType, uid, q, stage, pageSize, tags, storeTypes, }?: {
560
+ getAppLocationsPaginator({ companyId, applicationId, storeType, uid, q, stage, pageSize, tags, storeTypes, companyUids, }?: {
347
561
  companyId: number;
348
562
  applicationId: string;
349
563
  storeType?: string;
@@ -353,74 +567,144 @@ declare class Catalog {
353
567
  pageSize?: number;
354
568
  tags?: string[];
355
569
  storeTypes?: string[];
356
- }): Paginator<CatalogPlatformModel.LocationListSchema>;
570
+ companyUids?: number[];
571
+ }): Paginator<CatalogPlatformModel.LocationListSerializer>;
357
572
  /**
358
- * @param {CatalogPlatformApplicationValidator.GetAppProductParam} arg - Arg object
573
+ * @param {CatalogPlatformApplicationValidator.GetAppPriceByIdParam} arg - Arg object
574
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
575
+ * @param {import("../PlatformAPIClient").Options} - Options
576
+ * @returns {Promise<CatalogPlatformModel.AppPriceByIdResponse>} - Success response
577
+ * @name getAppPriceById
578
+ * @summary: Get pricing of a product
579
+ * @description: Retrieve the discounted price of a specific product for a given application. This endpoint allows filtering by stores, factory types, and sellers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppPriceById/).
580
+ */
581
+ getAppPriceById({ itemId, storeIds, factoryTypeIds, sellerId, requestHeaders }?: CatalogPlatformApplicationValidator.GetAppPriceByIdParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppPriceByIdResponse>;
582
+ /**
583
+ * @param {CatalogPlatformApplicationValidator.GetAppPriceFactoriesParam} arg
584
+ * - Arg object
585
+ *
359
586
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
360
587
  * @param {import("../PlatformAPIClient").Options} - Options
361
- * @returns {Promise<CatalogPlatformModel.OwnerAppItemResponseSchema>} -
588
+ * @returns {Promise<CatalogPlatformModel.GetAppPriceFactoryResponse>} -
362
589
  * Success response
590
+ * @name getAppPriceFactories
591
+ * @summary: Get price factory
592
+ * @description: This API allows to get price factories. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppPriceFactories/).
593
+ */
594
+ getAppPriceFactories({ isActive, factoryTypeId, code, pageNo, pageSize, requestHeaders }?: CatalogPlatformApplicationValidator.GetAppPriceFactoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAppPriceFactoryResponse>;
595
+ /**
596
+ * @param {CatalogPlatformApplicationValidator.GetAppPriceFactoryParam} arg
597
+ * - Arg object
598
+ *
599
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
600
+ * @param {import("../PlatformAPIClient").Options} - Options
601
+ * @returns {Promise<CatalogPlatformModel.AppPriceFactory>} - Success response
602
+ * @name getAppPriceFactory
603
+ * @summary: Get price factory
604
+ * @description: This API allows to get price factory. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppPriceFactory/).
605
+ */
606
+ getAppPriceFactory({ id, requestHeaders }?: CatalogPlatformApplicationValidator.GetAppPriceFactoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppPriceFactory>;
607
+ /**
608
+ * @param {CatalogPlatformApplicationValidator.GetAppProductParam} arg - Arg object
609
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
610
+ * @param {import("../PlatformAPIClient").Options} - Options
611
+ * @returns {Promise<CatalogPlatformModel.OwnerAppItemResponse>} - Success response
363
612
  * @name getAppProduct
364
- * @summary: Get sales channel product
365
- * @description: Retrieve sales channel product details by its item_id and depending upon filters sent in request. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppProduct/).
613
+ * @summary: Retrieve application product data.
614
+ * @description: Products are the core resource of an application. If successful, returns a Company Application Product resource in the response body depending upon filter sent. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppProduct/).
615
+ */
616
+ getAppProduct({ itemId, requestHeaders }?: CatalogPlatformApplicationValidator.GetAppProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.OwnerAppItemResponse>;
617
+ /**
618
+ * @param {CatalogPlatformApplicationValidator.GetAppProductPricesParam} arg
619
+ * - Arg object
620
+ *
621
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
622
+ * @param {import("../PlatformAPIClient").Options} - Options
623
+ * @returns {Promise<CatalogPlatformModel.ProductPrices>} - Success response
624
+ * @name getAppProductPrices
625
+ * @summary: Get product prices
626
+ * @description: This API allows to get product prices. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppProductPrices/).
366
627
  */
367
- getAppProduct({ itemId, requestHeaders }?: CatalogPlatformApplicationValidator.GetAppProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.OwnerAppItemResponseSchema>;
628
+ getAppProductPrices({ itemIds, factoryTypeIds, pageNo, pageSize, requestHeaders }?: CatalogPlatformApplicationValidator.GetAppProductPricesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductPrices>;
368
629
  /**
369
630
  * @param {CatalogPlatformApplicationValidator.GetAppProductsParam} arg - Arg object
370
631
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
371
632
  * @param {import("../PlatformAPIClient").Options} - Options
372
- * @returns {Promise<CatalogPlatformModel.RawProductListingResponseSchema>}
633
+ * @returns {Promise<CatalogPlatformModel.RawProductListingResponse>} -
634
+ * Success response
635
+ * @name getAppProducts
636
+ * @summary: Get application products.
637
+ * @description: Retrieve products specific to the application. Products are the core resource of an application. Products can be associated by categories, collections, brands and more. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppProducts/).
638
+ */
639
+ getAppProducts({ brandIds, categoryIds, departmentIds, tags, itemIds, pageNo, pageSize, q, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.RawProductListingResponse>;
640
+ /**
641
+ * @param {CatalogPlatformApplicationValidator.GetAppReturnConfigurationParam} arg
642
+ * - Arg object
643
+ *
644
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
645
+ * @param {import("../PlatformAPIClient").Options} - Options
646
+ * @returns {Promise<CatalogPlatformModel.AppReturnConfigResponse>} - Success response
647
+ * @name getAppReturnConfiguration
648
+ * @summary: Get Return configuration level set for an application
649
+ * @description: Get Product Return configuration set at an application level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppReturnConfiguration/).
650
+ */
651
+ getAppReturnConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppReturnConfigResponse>;
652
+ /**
653
+ * @param {CatalogPlatformApplicationValidator.GetAppicationProductsParam} arg
654
+ * - Arg object
655
+ *
656
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
657
+ * @param {import("../PlatformAPIClient").Options} - Options
658
+ * @returns {Promise<CatalogPlatformModel.ApplicationProductListingResponse>}
373
659
  * - Success response
374
660
  *
375
- * @name getAppProducts
376
- * @summary: List sales channel products
377
- * @description: Retrieve products specific to the sales channel, with filtering options available for brand, category, department, tags, item IDs, product name, and pagination support - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppProducts/).
661
+ * @name getAppicationProducts
662
+ * @summary: Get application products.
663
+ * @description: Retrieve products associated with the application. List all the products associated with a brand, collection or category in a requested sort order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppicationProducts/).
378
664
  */
379
- getAppProducts({ brandIds, categoryIds, departmentIds, tags, itemIds, pageNo, pageSize, q, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.RawProductListingResponseSchema>;
665
+ getAppicationProducts({ q, f, c, filters, isDependent, sortOn, pageId, pageSize, pageNo, pageType, itemIds, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppicationProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ApplicationProductListingResponse>;
380
666
  /**
381
667
  * @param {Object} arg - Arg object.
382
668
  * @param {number} arg.companyId - A `company_id` is a unique identifier for
383
669
  * a particular seller account.
384
670
  * @param {string} arg.applicationId - A `application_id` is a unique
385
671
  * identifier for a particular sale channel.
386
- * @param {number[]} [arg.brandIds] - Get multiple products filtered by Brand Ids
387
- * @param {number[]} [arg.categoryIds] - Get multiple products filtered by
388
- * Category Ids
389
- * @param {number[]} [arg.departmentIds] - Get multiple products filtered by
390
- * Department Ids
391
- * @param {string[]} [arg.tags] - Get multiple products filtered by tags
392
- * @param {number[]} [arg.itemIds] - Get multiple products filtered by Item Ids
672
+ * @param {string} [arg.q] - The search query. This can be a partial or
673
+ * complete name of a either a product, brand or category
674
+ * @param {string} [arg.f] - The search filter parameters. All the parameter
675
+ * filtered from filter parameters will be passed in **f** parameter in
676
+ * this format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
677
+ * @param {string} [arg.c] - The search filter parameters for collection
678
+ * items. All the parameter filtered from filter parameters will be passed
679
+ * in **c** parameter in this format.
680
+ * **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
681
+ * @param {boolean} [arg.filters] - Pass `filters` parameter to fetch the
682
+ * filter details. This flag is used to fetch all filters
683
+ * @param {boolean} [arg.isDependent] - This query parameter is used to get
684
+ * the dependent products in the listing.
685
+ * @param {string} [arg.sortOn] - The order to sort the list of products on.
686
+ * The supported sort parameters are popularity, price, redemption and
687
+ * discount in either ascending or descending order. See the supported
688
+ * values below.
393
689
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
394
- * page. Default is 10.
395
- * @param {string} [arg.q] - Search with Item Code, Name, Slug or Identifier.
396
- * @returns {Paginator<CatalogPlatformModel.RawProductListingResponseSchema>}
397
- * @summary: List sales channel products
398
- * @description: Retrieve products specific to the sales channel, with filtering options available for brand, category, department, tags, item IDs, product name, and pagination support
690
+ * page. Default is 12.
691
+ * @param {string[]} [arg.itemIds] - Item Ids of product
692
+ * @returns {Paginator<CatalogPlatformModel.ApplicationProductListingResponse>}
693
+ * @summary: Get application products.
694
+ * @description: Retrieve products associated with the application. List all the products associated with a brand, collection or category in a requested sort order.
399
695
  */
400
- getAppProductsPaginator({ companyId, applicationId, brandIds, categoryIds, departmentIds, tags, itemIds, pageSize, q, }?: {
696
+ getAppicationProductsPaginator({ companyId, applicationId, q, f, c, filters, isDependent, sortOn, pageSize, itemIds, }?: {
401
697
  companyId: number;
402
698
  applicationId: string;
403
- brandIds?: number[];
404
- categoryIds?: number[];
405
- departmentIds?: number[];
406
- tags?: string[];
407
- itemIds?: number[];
408
- pageSize?: number;
409
699
  q?: string;
410
- }): Paginator<CatalogPlatformModel.RawProductListingResponseSchema>;
411
- /**
412
- * @param {CatalogPlatformApplicationValidator.GetAppReturnConfigurationParam} arg
413
- * - Arg object
414
- *
415
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
416
- * @param {import("../PlatformAPIClient").Options} - Options
417
- * @returns {Promise<CatalogPlatformModel.AppReturnConfigResponseSchema>} -
418
- * Success response
419
- * @name getAppReturnConfiguration
420
- * @summary: Get product-return configuration
421
- * @description: Get Product Return configuration set at an sales channel level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppReturnConfiguration/).
422
- */
423
- getAppReturnConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppReturnConfigResponseSchema>;
700
+ f?: string;
701
+ c?: string;
702
+ filters?: boolean;
703
+ isDependent?: boolean;
704
+ sortOn?: string;
705
+ pageSize?: number;
706
+ itemIds?: string[];
707
+ }): Paginator<CatalogPlatformModel.ApplicationProductListingResponse>;
424
708
  /**
425
709
  * @param {CatalogPlatformApplicationValidator.GetApplicationBrandListingParam} arg
426
710
  * - Arg object
@@ -430,8 +714,8 @@ declare class Catalog {
430
714
  * @returns {Promise<CatalogPlatformModel.ApplicationBrandListingSchema>} -
431
715
  * Success response
432
716
  * @name getApplicationBrandListing
433
- * @summary: List sales channel brands
434
- * @description: Retrieve brand listings related to the sales channel. A brand is the name under which a product is being sold - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationBrandListing/).
717
+ * @summary: Get application brand listing.
718
+ * @description: Retrieve brand listings related to the application. A brand is the name under which a product is being sold - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationBrandListing/).
435
719
  */
436
720
  getApplicationBrandListing({ pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationBrandListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ApplicationBrandListingSchema>;
437
721
  /**
@@ -442,11 +726,11 @@ declare class Catalog {
442
726
  * identifier for a particular sale channel.
443
727
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
444
728
  * page. Default is 12.
445
- * @param {string} [arg.q] - Search query with brand name. Use this
446
- * parameter to search brands by brand name.
729
+ * @param {string} [arg.q] - Search query with brand name.Use this parameter
730
+ * to search brands by brand name.
447
731
  * @returns {Paginator<CatalogPlatformModel.ApplicationBrandListingSchema>}
448
- * @summary: List sales channel brands
449
- * @description: Retrieve brand listings related to the sales channel. A brand is the name under which a product is being sold
732
+ * @summary: Get application brand listing.
733
+ * @description: Retrieve brand listings related to the application. A brand is the name under which a product is being sold
450
734
  */
451
735
  getApplicationBrandListingPaginator({ companyId, applicationId, pageSize, q, }?: {
452
736
  companyId: string;
@@ -460,41 +744,40 @@ declare class Catalog {
460
744
  *
461
745
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
462
746
  * @param {import("../PlatformAPIClient").Options} - Options
463
- * @returns {Promise<CatalogPlatformModel.BrandListingResponseSchema>} -
464
- * Success response
747
+ * @returns {Promise<CatalogPlatformModel.BrandListingResponse>} - Success response
465
748
  * @name getApplicationBrands
466
- * @summary: List brands
467
- * @description: List all the brands. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationBrands/).
749
+ * @summary: Get application brands.
750
+ * @description: List all the brands. A brand is the name under which a product is being sold. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationBrands/).
468
751
  */
469
- getApplicationBrands({ department, pageNo, pageSize, q, brandId, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationBrandsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BrandListingResponseSchema>;
752
+ getApplicationBrands({ department, pageNo, pageSize, q, brandId, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationBrandsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BrandListingResponse>;
470
753
  /**
471
754
  * @param {Object} arg - Arg object.
472
- * @param {string} arg.companyId - A `company_id` is a unique identifier for
755
+ * @param {number} arg.companyId - A `company_id` is a unique identifier for
473
756
  * a particular seller account.
474
757
  * @param {string} arg.applicationId - A `application_id` is a unique
475
758
  * identifier for a particular sale channel.
476
759
  * @param {string} [arg.department] - The name of the department. Use this
477
760
  * parameter to filter products by a particular department. See below the
478
761
  * list of available departments. You can retrieve available departments
479
- * from the "v1.0/departments/" API
762
+ * from the **v1.0/departments/** API
480
763
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
481
764
  * page. Default is 12.
482
- * @param {string} [arg.q] - Search query with brand name. Use this
483
- * parameter to search brands by brand name.
765
+ * @param {string} [arg.q] - Search query with brand name.Use this parameter
766
+ * to search brands by brand name.
484
767
  * @param {number[]} [arg.brandId] - Helps to sort the brands list on the
485
768
  * basis of uid list.
486
- * @returns {Paginator<CatalogPlatformModel.BrandListingResponseSchema>}
487
- * @summary: List brands
488
- * @description: List all the brands.
769
+ * @returns {Paginator<CatalogPlatformModel.BrandListingResponse>}
770
+ * @summary: Get application brands.
771
+ * @description: List all the brands. A brand is the name under which a product is being sold.
489
772
  */
490
773
  getApplicationBrandsPaginator({ companyId, applicationId, department, pageSize, q, brandId, }?: {
491
- companyId: string;
774
+ companyId: number;
492
775
  applicationId: string;
493
776
  department?: string;
494
777
  pageSize?: number;
495
778
  q?: string;
496
779
  brandId?: number[];
497
- }): Paginator<CatalogPlatformModel.BrandListingResponseSchema>;
780
+ }): Paginator<CatalogPlatformModel.BrandListingResponse>;
498
781
  /**
499
782
  * @param {CatalogPlatformApplicationValidator.GetApplicationCategoryListingParam} arg
500
783
  * - Arg object
@@ -505,13 +788,13 @@ declare class Catalog {
505
788
  * - Success response
506
789
  *
507
790
  * @name getApplicationCategoryListing
508
- * @summary: List sales channel categories
509
- * @description: Retrieve category listings related to the sales channel , with the ability to filter results based on department ,category names etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationCategoryListing/).
791
+ * @summary: Get application category listing.
792
+ * @description: Retrieve category listings related to the application. A brand is the name under which a product is being sold. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationCategoryListing/).
510
793
  */
511
794
  getApplicationCategoryListing({ departmentId, pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationCategoryListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ApplicationCategoryListingSchema>;
512
795
  /**
513
796
  * @param {Object} arg - Arg object.
514
- * @param {string} arg.companyId - A `company_id` is a unique identifier for
797
+ * @param {number} arg.companyId - A `company_id` is a unique identifier for
515
798
  * a particular seller account.
516
799
  * @param {string} arg.applicationId - A `application_id` is a unique
517
800
  * identifier for a particular sale channel.
@@ -519,14 +802,14 @@ declare class Catalog {
519
802
  * identifier for a particular department.
520
803
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
521
804
  * page. Default is 12.
522
- * @param {string} [arg.q] - A search query string. Use this parameter to
523
- * filter results based on a keyword or specific value.
805
+ * @param {string} [arg.q] - Search query with brand name.Use this parameter
806
+ * to search brands by brand name.
524
807
  * @returns {Paginator<CatalogPlatformModel.ApplicationCategoryListingSchema>}
525
- * @summary: List sales channel categories
526
- * @description: Retrieve category listings related to the sales channel , with the ability to filter results based on department ,category names etc.
808
+ * @summary: Get application category listing.
809
+ * @description: Retrieve category listings related to the application. A brand is the name under which a product is being sold.
527
810
  */
528
811
  getApplicationCategoryListingPaginator({ companyId, applicationId, departmentId, pageSize, q, }?: {
529
- companyId: string;
812
+ companyId: number;
530
813
  applicationId: string;
531
814
  departmentId?: number;
532
815
  pageSize?: number;
@@ -538,14 +821,14 @@ declare class Catalog {
538
821
  *
539
822
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
540
823
  * @param {import("../PlatformAPIClient").Options} - Options
541
- * @returns {Promise<CatalogPlatformModel.ApplicationDepartmentListingResponseSchema>}
824
+ * @returns {Promise<CatalogPlatformModel.ApplicationDepartmentListingResponse>}
542
825
  * - Success response
543
826
  *
544
827
  * @name getApplicationDepartmentListing
545
- * @summary: List sales channel departments
546
- * @description: Retrieve department listings related to the sales channel. Departments are used to categorize similar products, and you can filter the results based on department names - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationDepartmentListing/).
828
+ * @summary: Get application department listing.
829
+ * @description: Retrieve department listings related to the application. Departments are a way to categorise similar products. A product can lie in multiple departments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationDepartmentListing/).
547
830
  */
548
- getApplicationDepartmentListing({ pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationDepartmentListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ApplicationDepartmentListingResponseSchema>;
831
+ getApplicationDepartmentListing({ pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationDepartmentListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ApplicationDepartmentListingResponse>;
549
832
  /**
550
833
  * @param {Object} arg - Arg object.
551
834
  * @param {number} arg.companyId - A `company_id` is a unique identifier for
@@ -554,131 +837,97 @@ declare class Catalog {
554
837
  * identifier for a particular sale channel.
555
838
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
556
839
  * page. Default is 12.
557
- * @param {string} [arg.q] - A search query string. Use this parameter to
558
- * filter results based on a keyword or specific value.
559
- * @returns {Paginator<CatalogPlatformModel.ApplicationDepartmentListingResponseSchema>}
560
- * @summary: List sales channel departments
561
- * @description: Retrieve department listings related to the sales channel. Departments are used to categorize similar products, and you can filter the results based on department names
840
+ * @param {string} [arg.q] - Search query with brand name.Use this parameter
841
+ * to search department by name.
842
+ * @returns {Paginator<CatalogPlatformModel.ApplicationDepartmentListingResponse>}
843
+ * @summary: Get application department listing.
844
+ * @description: Retrieve department listings related to the application. Departments are a way to categorise similar products. A product can lie in multiple departments.
562
845
  */
563
846
  getApplicationDepartmentListingPaginator({ companyId, applicationId, pageSize, q, }?: {
564
847
  companyId: number;
565
848
  applicationId: string;
566
849
  pageSize?: number;
567
850
  q?: string;
568
- }): Paginator<CatalogPlatformModel.ApplicationDepartmentListingResponseSchema>;
851
+ }): Paginator<CatalogPlatformModel.ApplicationDepartmentListingResponse>;
569
852
  /**
570
853
  * @param {CatalogPlatformApplicationValidator.GetApplicationFilterKeysParam} arg
571
854
  * - Arg object
572
855
  *
573
856
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
574
857
  * @param {import("../PlatformAPIClient").Options} - Options
575
- * @returns {Promise<CatalogPlatformModel.GetQueryFiltersKeysResponseSchema>}
576
- * - Success response
577
- *
858
+ * @returns {Promise<CatalogPlatformModel.GetQueryFiltersKeysResponse>} -
859
+ * Success response
578
860
  * @name getApplicationFilterKeys
579
- * @summary: List filter keys
580
- * @description: Retrieve the details of all applicable product filters, such as Color, Brand, and Category, indicating the criteria keys where filters can be applied. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationFilterKeys/).
861
+ * @summary: Get filters keys of the filter options.
862
+ * @description: Get query filters keys to configure a collection - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationFilterKeys/).
581
863
  */
582
- getApplicationFilterKeys({ c, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationFilterKeysParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetQueryFiltersKeysResponseSchema>;
864
+ getApplicationFilterKeys({ c, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationFilterKeysParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetQueryFiltersKeysResponse>;
583
865
  /**
584
866
  * @param {CatalogPlatformApplicationValidator.GetApplicationFilterValuesParam} arg
585
867
  * - Arg object
586
868
  *
587
869
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
588
870
  * @param {import("../PlatformAPIClient").Options} - Options
589
- * @returns {Promise<CatalogPlatformModel.GetQueryFiltersValuesResponseSchema>}
590
- * - Success response
591
- *
871
+ * @returns {Promise<CatalogPlatformModel.GetQueryFiltersValuesResponse>} -
872
+ * Success response
592
873
  * @name getApplicationFilterValues
593
- * @summary: List product filters
594
- * @description: This API is designed to retrieve the filter values for all available options within the selected filter, such as "red" for color.
595
- * - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationFilterValues/).
874
+ * @summary: Get values of the selected value for the filter options.
875
+ * @description: Get query filters keys to configure a collection - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationFilterValues/).
596
876
  */
597
- getApplicationFilterValues({ filterKey, c, collectionId, pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationFilterValuesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetQueryFiltersValuesResponseSchema>;
877
+ getApplicationFilterValues({ filterKey, c, collectionId, pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationFilterValuesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetQueryFiltersValuesResponse>;
598
878
  /**
599
- * @param {CatalogPlatformApplicationValidator.GetApplicationProductsParam} arg
879
+ * @param {CatalogPlatformApplicationValidator.GetAutocompleteConfigParam} arg
600
880
  * - Arg object
601
881
  *
602
882
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
603
883
  * @param {import("../PlatformAPIClient").Options} - Options
604
- * @returns {Promise<CatalogPlatformModel.ApplicationProductListingResponseSchema>}
605
- * - Success response
606
- *
607
- * @name getApplicationProducts
608
- * @summary: List sales channel products
609
- * @description: Retrieve products associated with the sales channel. List all the products associated with a brand, collection or category in a requested sort order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationProducts/).
884
+ * @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>} -
885
+ * Success response
886
+ * @name getAutocompleteConfig
887
+ * @summary: Get autocomplete configuration.
888
+ * @description: Custom Autocomplete Keyword allows you to map conditions with keywords to give you the ultimate results - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAutocompleteConfig/).
610
889
  */
611
- getApplicationProducts({ q, f, c, filters, isDependent, sortOn, pageId, pageSize, pageNo, pageType, itemIds, requestHeaders, }?: CatalogPlatformApplicationValidator.GetApplicationProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ApplicationProductListingResponseSchema>;
890
+ getAutocompleteConfig({ pageNo, pageSize, q, isActive, requestHeaders }?: CatalogPlatformApplicationValidator.GetAutocompleteConfigParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>;
612
891
  /**
613
- * @param {Object} arg - Arg object.
614
- * @param {number} arg.companyId - A `company_id` is a unique identifier for
615
- * a particular seller account.
616
- * @param {string} arg.applicationId - A `application_id` is a unique
617
- * identifier for a particular sale channel.
618
- * @param {string} [arg.q] - The search query. This can be a partial or
619
- * complete name of a either a product, brand or category
620
- * @param {string} [arg.f] - The search filter parameters. All the parameter
621
- * filtered from filter parameters will be passed in **f** parameter in
622
- * this format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
623
- * @param {string} [arg.c] - The search filter parameters for collection
624
- * items. All the parameter filtered from filter parameters will be passed
625
- * in **c** parameter in this format.
626
- * **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
627
- * @param {boolean} [arg.filters] - Pass `filters` parameter to fetch the
628
- * filter details. This flag is used to fetch all filters
629
- * @param {boolean} [arg.isDependent] - This query parameter is used to get
630
- * the dependent products in the listing.
631
- * @param {string} [arg.sortOn] - The order to sort the list of products on.
632
- * The supported sort parameters are popularity, price, redemption and
633
- * discount in either ascending or descending order. See the supported
634
- * values below.
635
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
636
- * page. Default is 12.
637
- * @param {string[]} [arg.itemIds] - Item Ids of product
638
- * @returns {Paginator<CatalogPlatformModel.ApplicationProductListingResponseSchema>}
639
- * @summary: List sales channel products
640
- * @description: Retrieve products associated with the sales channel. List all the products associated with a brand, collection or category in a requested sort order.
892
+ * @param {CatalogPlatformApplicationValidator.GetAutocompleteKeywordDetailParam} arg
893
+ * - Arg object
894
+ *
895
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
896
+ * @param {import("../PlatformAPIClient").Options} - Options
897
+ * @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsData>} -
898
+ * Success response
899
+ * @name getAutocompleteKeywordDetail
900
+ * @summary: Get autocomplete keyword details.
901
+ * @description: Retrieve detailed information about a specific autocomplete keyword. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAutocompleteKeywordDetail/).
641
902
  */
642
- getApplicationProductsPaginator({ companyId, applicationId, q, f, c, filters, isDependent, sortOn, pageSize, itemIds, }?: {
643
- companyId: number;
644
- applicationId: string;
645
- q?: string;
646
- f?: string;
647
- c?: string;
648
- filters?: boolean;
649
- isDependent?: boolean;
650
- sortOn?: string;
651
- pageSize?: number;
652
- itemIds?: string[];
653
- }): Paginator<CatalogPlatformModel.ApplicationProductListingResponseSchema>;
903
+ getAutocompleteKeywordDetail({ id, requestHeaders }?: CatalogPlatformApplicationValidator.GetAutocompleteKeywordDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAutocompleteWordsData>;
654
904
  /**
655
- * @param {CatalogPlatformApplicationValidator.GetAutocompleteConfigParam} arg
905
+ * @param {CatalogPlatformApplicationValidator.GetAutocompletePreviewParam} arg
656
906
  * - Arg object
657
907
  *
658
908
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
659
909
  * @param {import("../PlatformAPIClient").Options} - Options
660
- * @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponseSchema>}
910
+ * @returns {Promise<CatalogPlatformModel.AutocompletePreviewResponseSchema>}
661
911
  * - Success response
662
912
  *
663
- * @name getAutocompleteConfig
664
- * @summary: Get autocomplete configuration
665
- * @description: Get custom autocomplete keyword configuration for a specific sales channel which allows you to map any endpoint with these keywords to give you the ultimate suggestion results. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAutocompleteConfig/).
913
+ * @name getAutocompletePreview
914
+ * @summary: Get autocomplete suggestions as per config for an application
915
+ * @description: This API allows to get autocomplete suggestions as per config. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAutocompletePreview/).
666
916
  */
667
- getAutocompleteConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAutocompleteWordsResponseSchema>;
917
+ getAutocompletePreview({ q, categorySuggestion, brandSuggestion, collectionSuggestion, productSuggestion, querySuggestion, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAutocompletePreviewParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AutocompletePreviewResponseSchema>;
668
918
  /**
669
- * @param {CatalogPlatformApplicationValidator.GetAutocompleteKeywordDetailParam} arg
919
+ * @param {CatalogPlatformApplicationValidator.GetAutocompleteSettingsParam} arg
670
920
  * - Arg object
671
921
  *
672
922
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
673
923
  * @param {import("../PlatformAPIClient").Options} - Options
674
- * @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponseSchema>}
675
- * - Success response
676
- *
677
- * @name getAutocompleteKeywordDetail
678
- * @summary: Get autocomplete keyword
679
- * @description: Retrieve detailed information about a specific autocomplete keyword for a specific sales channel by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAutocompleteKeywordDetail/).
924
+ * @returns {Promise<CatalogPlatformModel.AutocompleteResponseSchema>} -
925
+ * Success response
926
+ * @name getAutocompleteSettings
927
+ * @summary: Get autocomplete settings config for an application
928
+ * @description: This API allows to get autocomplete settings config for an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAutocompleteSettings/).
680
929
  */
681
- getAutocompleteKeywordDetail({ id, requestHeaders }?: CatalogPlatformApplicationValidator.GetAutocompleteKeywordDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAutocompleteWordsResponseSchema>;
930
+ getAutocompleteSettings({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.AutocompleteResponseSchema>;
682
931
  /**
683
932
  * @param {CatalogPlatformApplicationValidator.GetCatalogConfigurationParam} arg
684
933
  * - Arg object
@@ -689,8 +938,8 @@ declare class Catalog {
689
938
  * - Success response
690
939
  *
691
940
  * @name getCatalogConfiguration
692
- * @summary: Get catalog configuration meta data
693
- * @description: Retrieve configuration meta data for the catalog specific to a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCatalogConfiguration/).
941
+ * @summary: Retrieve catalog configuration.
942
+ * @description: Retrieve configuration meta details for the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCatalogConfiguration/).
694
943
  */
695
944
  getCatalogConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCatalogConfigurationMetaData>;
696
945
  /**
@@ -699,38 +948,35 @@ declare class Catalog {
699
948
  *
700
949
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
701
950
  * @param {import("../PlatformAPIClient").Options} - Options
702
- * @returns {Promise<CatalogPlatformModel.CatalogInsightResponseSchema>} -
703
- * Success response
951
+ * @returns {Promise<CatalogPlatformModel.CatalogInsightResponse>} - Success response
704
952
  * @name getCatalogInsights
705
- * @summary: Get catalog counts
706
- * @description: Retrieve the count of catalog related data like products, brands, departments and categories that have been made live as per configuration of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCatalogInsights/).
953
+ * @summary: Get catalog insights.
954
+ * @description: Retrieve the count of catalog related data like products, brands, departments and categories that have been made live as per configuration of the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCatalogInsights/).
707
955
  */
708
- getCatalogInsights({ brand, requestHeaders }?: CatalogPlatformApplicationValidator.GetCatalogInsightsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CatalogInsightResponseSchema>;
956
+ getCatalogInsights({ brand, requestHeaders }?: CatalogPlatformApplicationValidator.GetCatalogInsightsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CatalogInsightResponse>;
709
957
  /**
710
958
  * @param {CatalogPlatformApplicationValidator.GetCategoriesParam} arg - Arg object
711
959
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
712
960
  * @param {import("../PlatformAPIClient").Options} - Options
713
- * @returns {Promise<CatalogPlatformModel.CategoryListingResponseSchema>} -
714
- * Success response
961
+ * @returns {Promise<CatalogPlatformModel.CategoryListingResponse>} - Success response
715
962
  * @name getCategories
716
- * @summary: List categories
717
- * @description: Retrieve a list of categories associated to company and sales channel. user can filter on departments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCategories/).
963
+ * @summary: Get categories.
964
+ * @description: Retrieve a list of categories. Optionally pass filter the brands by the department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCategories/).
718
965
  */
719
- getCategories({ department, requestHeaders }?: CatalogPlatformApplicationValidator.GetCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryListingResponseSchema>;
966
+ getCategories({ department, requestHeaders }?: CatalogPlatformApplicationValidator.GetCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryListingResponse>;
720
967
  /**
721
968
  * @param {CatalogPlatformApplicationValidator.GetCollectionDetailParam} arg
722
969
  * - Arg object
723
970
  *
724
971
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
725
972
  * @param {import("../PlatformAPIClient").Options} - Options
726
- * @returns {Promise<CatalogPlatformModel.GetCollectionDetailResponseSchema>}
727
- * - Success response
728
- *
973
+ * @returns {Promise<CatalogPlatformModel.GetCollectionDetailResponse>} -
974
+ * Success response
729
975
  * @name getCollectionDetail
730
- * @summary: Get a collection
976
+ * @summary: Get collection details.
731
977
  * @description: Get the details of a collection by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCollectionDetail/).
732
978
  */
733
- getCollectionDetail({ slug, requestHeaders }?: CatalogPlatformApplicationValidator.GetCollectionDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCollectionDetailResponseSchema>;
979
+ getCollectionDetail({ slug, requestHeaders }?: CatalogPlatformApplicationValidator.GetCollectionDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCollectionDetailResponse>;
734
980
  /**
735
981
  * @param {CatalogPlatformApplicationValidator.GetCollectionItemsParam} arg
736
982
  * - Arg object
@@ -741,10 +987,10 @@ declare class Catalog {
741
987
  * - Success response
742
988
  *
743
989
  * @name getCollectionItems
744
- * @summary: List items of collection
745
- * @description: Get items from a collection specified by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCollectionItems/).
990
+ * @summary: Get the items for a collection
991
+ * @description: Get items from a collection specified by its `id`. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCollectionItems/).
746
992
  */
747
- getCollectionItems({ id, sortOn, pageId, pageSize, pageNo, requestHeaders }?: CatalogPlatformApplicationValidator.GetCollectionItemsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCollectionItemsResponseSchema>;
993
+ getCollectionItems({ id, sortOn, pageSize, pageNo, isPinned, q, isExcluded, requestHeaders, }?: CatalogPlatformApplicationValidator.GetCollectionItemsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCollectionItemsResponseSchema>;
748
994
  /**
749
995
  * @param {CatalogPlatformApplicationValidator.GetConfigurationByTypeParam} arg
750
996
  * - Arg object
@@ -755,8 +1001,8 @@ declare class Catalog {
755
1001
  * - Success response
756
1002
  *
757
1003
  * @name getConfigurationByType
758
- * @summary: Get configuration
759
- * @description: Retrieve configuration details based on a specific type in the catalog for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getConfigurationByType/).
1004
+ * @summary: Retrieve configuration by type.
1005
+ * @description: Retrieve configuration details based on a specific type in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getConfigurationByType/).
760
1006
  */
761
1007
  getConfigurationByType({ type, requestHeaders }?: CatalogPlatformApplicationValidator.GetConfigurationByTypeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAppCatalogEntityConfiguration>;
762
1008
  /**
@@ -765,14 +1011,13 @@ declare class Catalog {
765
1011
  *
766
1012
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
767
1013
  * @param {import("../PlatformAPIClient").Options} - Options
768
- * @returns {Promise<CatalogPlatformModel.GetConfigMetadataResponseSchema>}
769
- * - Success response
770
- *
1014
+ * @returns {Promise<CatalogPlatformModel.GetConfigMetadataResponse>} -
1015
+ * Success response
771
1016
  * @name getConfigurationMetadata
772
- * @summary: Get configuration metadata
773
- * @description: Retrieve the configuraion metadata details for specific config_type for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getConfigurationMetadata/).
1017
+ * @summary: Retrieve configuration metadata.
1018
+ * @description: Retrieve the configuraion metadata details for catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getConfigurationMetadata/).
774
1019
  */
775
- getConfigurationMetadata({ configType, templateSlug, pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetConfigurationMetadataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetConfigMetadataResponseSchema>;
1020
+ getConfigurationMetadata({ configType, templateSlug, requestHeaders }?: CatalogPlatformApplicationValidator.GetConfigurationMetadataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetConfigMetadataResponse>;
776
1021
  /**
777
1022
  * @param {CatalogPlatformApplicationValidator.GetConfigurationsParam} arg
778
1023
  * - Arg object
@@ -782,84 +1027,157 @@ declare class Catalog {
782
1027
  * @returns {Promise<CatalogPlatformModel.GetAppCatalogConfiguration>} -
783
1028
  * Success response
784
1029
  * @name getConfigurations
785
- * @summary: Get product configurations
786
- * @description: Retrieve a detailed configurations for product catalog specific to a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getConfigurations/).
1030
+ * @summary: Retrieve configurations.
1031
+ * @description: Retrieve a configured details for catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getConfigurations/).
787
1032
  */
788
1033
  getConfigurations({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAppCatalogConfiguration>;
1034
+ /**
1035
+ * @param {CatalogPlatformApplicationValidator.GetConfigurationsFilterMetadataParam} arg
1036
+ * - Arg object
1037
+ *
1038
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1039
+ * @param {import("../PlatformAPIClient").Options} - Options
1040
+ * @returns {Promise<CatalogPlatformModel.FilterResponse>} - Success response
1041
+ * @name getConfigurationsFilterMetadata
1042
+ * @summary: Get filter details for application
1043
+ * @description: configured details for catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getConfigurationsFilterMetadata/).
1044
+ */
1045
+ getConfigurationsFilterMetadata({ filter, requestHeaders }?: CatalogPlatformApplicationValidator.GetConfigurationsFilterMetadataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.FilterResponse>;
789
1046
  /**
790
1047
  * @param {CatalogPlatformApplicationValidator.GetDepartmentsParam} arg - Arg object
791
1048
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
792
1049
  * @param {import("../PlatformAPIClient").Options} - Options
793
- * @returns {Promise<CatalogPlatformModel.DepartmentResponseSchema>} -
794
- * Success response
1050
+ * @returns {Promise<CatalogPlatformModel.DepartmentResponse>} - Success response
795
1051
  * @name getDepartments
796
- * @summary: List departments
797
- * @description: Retrieve a list of departments associated with a comapny and sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getDepartments/).
1052
+ * @summary: Get departments.
1053
+ * @description: Retrieve a list of departments. Departments are a way to categorise similar products. A product can lie in multiple departments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getDepartments/).
798
1054
  */
799
- getDepartments({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentResponseSchema>;
1055
+ getDepartments({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentResponse>;
800
1056
  /**
801
1057
  * @param {CatalogPlatformApplicationValidator.GetDiscountedInventoryBySizeIdentifierParam} arg
802
1058
  * - Arg object
803
1059
  *
804
1060
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
805
1061
  * @param {import("../PlatformAPIClient").Options} - Options
806
- * @returns {Promise<CatalogPlatformModel.ApplicationInventorySellerIdentifierResponsePaginated>}
1062
+ * @returns {Promise<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>}
807
1063
  * - Success response
808
1064
  *
809
1065
  * @name getDiscountedInventoryBySizeIdentifier
810
- * @summary: Get discounted inventory
1066
+ * @summary: Get discounted inventory by size identifier.
811
1067
  * @description: Allows to retrieve Inventory data for particular company grouped by size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getDiscountedInventoryBySizeIdentifier/).
812
1068
  */
813
- getDiscountedInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize, locationIds, requestHeaders, }?: CatalogPlatformApplicationValidator.GetDiscountedInventoryBySizeIdentifierParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ApplicationInventorySellerIdentifierResponsePaginated>;
814
- /**
815
- * @param {Object} arg - Arg object.
816
- * @param {number} arg.companyId - A `company_id` is a unique identifier for
817
- * a particular seller account.
818
- * @param {string} arg.applicationId - A `application_id` is a unique
819
- * identifier for a particular sale channel.
820
- * @param {number} arg.itemId - A `item_id` is a unique identifier for a
821
- * specific product.
822
- * @param {number} arg.sizeIdentifier - Size Identifier (Seller Identifier
823
- * or Primary Identifier).
824
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
825
- * page. Default is 12.
826
- * @param {number[]} [arg.locationIds] - Search by store ids.
827
- * @returns {Paginator<CatalogPlatformModel.ApplicationInventorySellerIdentifierResponsePaginated>}
828
- * @summary: Get discounted inventory
829
- * @description: Allows to retrieve Inventory data for particular company grouped by size and store.
830
- */
831
- getDiscountedInventoryBySizeIdentifierPaginator({ companyId, applicationId, itemId, sizeIdentifier, pageSize, locationIds, }?: {
832
- companyId: number;
833
- applicationId: string;
834
- itemId: number;
835
- sizeIdentifier: number;
836
- pageSize?: number;
837
- locationIds?: number[];
838
- }): Paginator<CatalogPlatformModel.ApplicationInventorySellerIdentifierResponsePaginated>;
1069
+ getDiscountedInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize, locationIds, requestHeaders, }?: CatalogPlatformApplicationValidator.GetDiscountedInventoryBySizeIdentifierParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>;
839
1070
  /**
840
1071
  * @param {CatalogPlatformApplicationValidator.GetGroupConfigurationsParam} arg
841
1072
  * - Arg object
842
1073
  *
843
1074
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
844
1075
  * @param {import("../PlatformAPIClient").Options} - Options
845
- * @returns {Promise<CatalogPlatformModel.GetConfigResponseSchema>} - Success response
1076
+ * @returns {Promise<CatalogPlatformModel.GetConfigResponse>} - Success response
846
1077
  * @name getGroupConfigurations
847
- * @summary: Get group configurations
848
- * @description: Retrieve the details of product group configurations based on config types for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getGroupConfigurations/).
1078
+ * @summary: Retrieve group configurations.
1079
+ * @description: Retrieve the details of the application configured configurations of group config types. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getGroupConfigurations/).
849
1080
  */
850
- getGroupConfigurations({ configType, pageNo, pageSize, search, templateSlug, requestHeaders }?: CatalogPlatformApplicationValidator.GetGroupConfigurationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetConfigResponseSchema>;
1081
+ getGroupConfigurations({ configType, pageNo, pageSize, search, templateSlug, requestHeaders }?: CatalogPlatformApplicationValidator.GetGroupConfigurationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetConfigResponse>;
851
1082
  /**
852
1083
  * @param {CatalogPlatformApplicationValidator.GetListingConfigurationsParam} arg
853
1084
  * - Arg object
854
1085
  *
855
1086
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
856
1087
  * @param {import("../PlatformAPIClient").Options} - Options
857
- * @returns {Promise<CatalogPlatformModel.GetConfigResponseSchema>} - Success response
1088
+ * @returns {Promise<CatalogPlatformModel.GetListingConfigResponse>} -
1089
+ * Success response
858
1090
  * @name getListingConfigurations
859
- * @summary: Get listing configurations
860
- * @description: Retrieve product listing configurations based on specific config_type for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getListingConfigurations/).
1091
+ * @summary: Retrieve listing configurations.
1092
+ * @description: Retrieve the details of the application configured configurations of listing config types. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getListingConfigurations/).
1093
+ */
1094
+ getListingConfigurations({ configType, pageNo, pageSize, search, uids, requestHeaders }?: CatalogPlatformApplicationValidator.GetListingConfigurationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetListingConfigResponse>;
1095
+ /**
1096
+ * @param {CatalogPlatformApplicationValidator.GetLivePreviewParam} arg - Arg object
1097
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1098
+ * @param {import("../PlatformAPIClient").Options} - Options
1099
+ * @returns {Promise<CatalogPlatformModel.ProductListingResponse>} - Success response
1100
+ * @name getLivePreview
1101
+ * @summary: Get live preview of a Merchandising Rule
1102
+ * @description: This allows you to get live preview of a merchandising rule. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getLivePreview/).
861
1103
  */
862
- getListingConfigurations({ configType, pageNo, pageSize, search, requestHeaders }?: CatalogPlatformApplicationValidator.GetListingConfigurationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetConfigResponseSchema>;
1104
+ getLivePreview({ merchandisingRuleId, searchKeyword, requestHeaders }?: CatalogPlatformApplicationValidator.GetLivePreviewParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductListingResponse>;
1105
+ /**
1106
+ * @param {CatalogPlatformApplicationValidator.GetMerchandisingQueryParam} arg
1107
+ * - Arg object
1108
+ *
1109
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1110
+ * @param {import("../PlatformAPIClient").Options} - Options
1111
+ * @returns {Promise<CatalogPlatformModel.SearchResponseSchema>} - Success response
1112
+ * @name getMerchandisingQuery
1113
+ * @summary: Get Merchandising Rule's query details
1114
+ * @description: This allows you to get details of a merchandising rule's query. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getMerchandisingQuery/).
1115
+ */
1116
+ getMerchandisingQuery({ merchandisingRuleId, requestHeaders }?: CatalogPlatformApplicationValidator.GetMerchandisingQueryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SearchResponseSchema>;
1117
+ /**
1118
+ * @param {CatalogPlatformApplicationValidator.GetMerchandisingRuleBoostActionParam} arg
1119
+ * - Arg object
1120
+ *
1121
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1122
+ * @param {import("../PlatformAPIClient").Options} - Options
1123
+ * @returns {Promise<CatalogPlatformModel.GetMerchandisingRuleBoostAction>}
1124
+ * - Success response
1125
+ *
1126
+ * @name getMerchandisingRuleBoostAction
1127
+ * @summary: Get Merchandising Rule's Boost action details
1128
+ * @description: This allows you to get details of Boost action of a merchandising rule. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getMerchandisingRuleBoostAction/).
1129
+ */
1130
+ getMerchandisingRuleBoostAction({ merchandisingRuleId, requestHeaders }?: CatalogPlatformApplicationValidator.GetMerchandisingRuleBoostActionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetMerchandisingRuleBoostAction>;
1131
+ /**
1132
+ * @param {CatalogPlatformApplicationValidator.GetMerchandisingRuleBuryActionParam} arg
1133
+ * - Arg object
1134
+ *
1135
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1136
+ * @param {import("../PlatformAPIClient").Options} - Options
1137
+ * @returns {Promise<CatalogPlatformModel.GetMerchandisingRuleBuryAction>}
1138
+ * - Success response
1139
+ *
1140
+ * @name getMerchandisingRuleBuryAction
1141
+ * @summary: Get Merchandising Rule's Bury action details
1142
+ * @description: This allows you to get details of Bury action of a merchandising rule. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getMerchandisingRuleBuryAction/).
1143
+ */
1144
+ getMerchandisingRuleBuryAction({ merchandisingRuleId, requestHeaders }?: CatalogPlatformApplicationValidator.GetMerchandisingRuleBuryActionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetMerchandisingRuleBuryAction>;
1145
+ /**
1146
+ * @param {CatalogPlatformApplicationValidator.GetMerchandisingRuleHideActionParam} arg
1147
+ * - Arg object
1148
+ *
1149
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1150
+ * @param {import("../PlatformAPIClient").Options} - Options
1151
+ * @returns {Promise<CatalogPlatformModel.HideResponse>} - Success response
1152
+ * @name getMerchandisingRuleHideAction
1153
+ * @summary: Get Merchandising Rule's Hide action details
1154
+ * @description: This allows you to get details of hide action of a merchandising rule. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getMerchandisingRuleHideAction/).
1155
+ */
1156
+ getMerchandisingRuleHideAction({ merchandisingRuleId, requestHeaders }?: CatalogPlatformApplicationValidator.GetMerchandisingRuleHideActionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HideResponse>;
1157
+ /**
1158
+ * @param {CatalogPlatformApplicationValidator.GetMerchandisingRulePinActionParam} arg
1159
+ * - Arg object
1160
+ *
1161
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1162
+ * @param {import("../PlatformAPIClient").Options} - Options
1163
+ * @returns {Promise<CatalogPlatformModel.PinResponse>} - Success response
1164
+ * @name getMerchandisingRulePinAction
1165
+ * @summary: Get Merchandising Rule's action details
1166
+ * @description: This allows you to get details of pin action of a merchandising rule. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getMerchandisingRulePinAction/).
1167
+ */
1168
+ getMerchandisingRulePinAction({ merchandisingRuleId, requestHeaders }?: CatalogPlatformApplicationValidator.GetMerchandisingRulePinActionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.PinResponse>;
1169
+ /**
1170
+ * @param {CatalogPlatformApplicationValidator.GetMerchandisingRulesParam} arg
1171
+ * - Arg object
1172
+ *
1173
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1174
+ * @param {import("../PlatformAPIClient").Options} - Options
1175
+ * @returns {Promise<CatalogPlatformModel.MerchandisingRulesList>} - Success response
1176
+ * @name getMerchandisingRules
1177
+ * @summary: Get list of all Merchandising Rule's details
1178
+ * @description: This allows you to get details of all merchandising rule's details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getMerchandisingRules/).
1179
+ */
1180
+ getMerchandisingRules({ pageId, pageSize, requestHeaders }?: CatalogPlatformApplicationValidator.GetMerchandisingRulesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.MerchandisingRulesList>;
863
1181
  /**
864
1182
  * @param {CatalogPlatformApplicationValidator.GetProductDetailBySlugParam} arg
865
1183
  * - Arg object
@@ -868,156 +1186,305 @@ declare class Catalog {
868
1186
  * @param {import("../PlatformAPIClient").Options} - Options
869
1187
  * @returns {Promise<CatalogPlatformModel.ProductDetail>} - Success response
870
1188
  * @name getProductDetailBySlug
871
- * @summary: Get product details
872
- * @description: Retrieve detailed product information using a product slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductDetailBySlug/).
1189
+ * @summary: Get product details by slug.
1190
+ * @description: Retrieve detailed product information using a product slug. Products are the core resource of an application. Products can be associated by categories, collections, brands and more. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductDetailBySlug/).
873
1191
  */
874
1192
  getProductDetailBySlug({ slug, requestHeaders }?: CatalogPlatformApplicationValidator.GetProductDetailBySlugParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDetail>;
1193
+ /**
1194
+ * @param {CatalogPlatformApplicationValidator.GetProductsInPriceFactoryByZoneIdParam} arg
1195
+ * - Arg object
1196
+ *
1197
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1198
+ * @param {import("../PlatformAPIClient").Options} - Options
1199
+ * @returns {Promise<CatalogPlatformModel.CreateAppPriceFactoryProductsResponse>}
1200
+ * - Success response
1201
+ *
1202
+ * @name getProductsInPriceFactoryByZoneId
1203
+ * @summary: Get products listed in price factory
1204
+ * @description: This API allows to get products in price factory. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductsInPriceFactoryByZoneId/).
1205
+ */
1206
+ getProductsInPriceFactoryByZoneId({ id, zoneId, itemId, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformApplicationValidator.GetProductsInPriceFactoryByZoneIdParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateAppPriceFactoryProductsResponse>;
875
1207
  /**
876
1208
  * @param {CatalogPlatformApplicationValidator.GetQueryFiltersParam} arg - Arg object
877
1209
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
878
1210
  * @param {import("../PlatformAPIClient").Options} - Options
879
- * @returns {Promise<CatalogPlatformModel.GetQueryFiltersResponseSchema>} -
880
- * Success response
1211
+ * @returns {Promise<CatalogPlatformModel.GetQueryFiltersResponse>} - Success response
881
1212
  * @name getQueryFilters
882
- * @summary: Get collection query filters
883
- * @description: Retrieve query filters to configure a collection for a company and a sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getQueryFilters/).
1213
+ * @summary: Retrieve query filters.
1214
+ * @description: Retrieve query filters to configure a collection - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getQueryFilters/).
884
1215
  */
885
- getQueryFilters({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetQueryFiltersResponseSchema>;
1216
+ getQueryFilters({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetQueryFiltersResponse>;
886
1217
  /**
887
1218
  * @param {CatalogPlatformApplicationValidator.GetSearchConfigurationParam} arg
888
1219
  * - Arg object
889
1220
  *
890
1221
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
891
1222
  * @param {import("../PlatformAPIClient").Options} - Options
892
- * @returns {Promise<CatalogPlatformModel.GetSearchConfigurationResponseSchema>}
1223
+ * @returns {Promise<CatalogPlatformModel.GetSearchConfigurationResponse>}
893
1224
  * - Success response
894
1225
  *
895
1226
  * @name getSearchConfiguration
896
- * @summary: Get Search configuration
897
- * @description: Get search configuration for a specific company and sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSearchConfiguration/).
1227
+ * @summary: Get Search Configuration
1228
+ * @description: Get search configuration in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSearchConfiguration/).
898
1229
  */
899
- getSearchConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchConfigurationResponseSchema>;
1230
+ getSearchConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchConfigurationResponse>;
900
1231
  /**
901
1232
  * @param {CatalogPlatformApplicationValidator.GetSearchKeywordsParam} arg
902
1233
  * - Arg object
903
1234
  *
904
1235
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
905
1236
  * @param {import("../PlatformAPIClient").Options} - Options
906
- * @returns {Promise<CatalogPlatformModel.GetSearchWordsDetailResponseSchema>}
1237
+ * @returns {Promise<CatalogPlatformModel.GetSearchWordsData>} - Success response
1238
+ * @name getSearchKeywords
1239
+ * @summary: Retrieve search keywords.
1240
+ * @description: Retrieve a list of search keywords from the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSearchKeywords/).
1241
+ */
1242
+ getSearchKeywords({ id, requestHeaders }?: CatalogPlatformApplicationValidator.GetSearchKeywordsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchWordsData>;
1243
+ /**
1244
+ * @param {CatalogPlatformApplicationValidator.GetSearchRerankParam} arg - Arg object
1245
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1246
+ * @param {import("../PlatformAPIClient").Options} - Options
1247
+ * @returns {Promise<CatalogPlatformModel.GetSearchRerankResponse>} - Success response
1248
+ * @name getSearchRerank
1249
+ * @summary: Get search rerank for an application
1250
+ * @description: This view allows you to create search rerank attributes for an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSearchRerank/).
1251
+ */
1252
+ getSearchRerank({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchRerankResponse>;
1253
+ /**
1254
+ * @param {CatalogPlatformApplicationValidator.GetSearchRerankDetailParam} arg
1255
+ * - Arg object
1256
+ *
1257
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1258
+ * @param {import("../PlatformAPIClient").Options} - Options
1259
+ * @returns {Promise<CatalogPlatformModel.GetSearchRerankDetailResponse>} -
1260
+ * Success response
1261
+ * @name getSearchRerankDetail
1262
+ * @summary: Get search rerank for an application
1263
+ * @description: This view allows you to retrieve search rerank attribute detail for an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSearchRerankDetail/).
1264
+ */
1265
+ getSearchRerankDetail({ id, requestHeaders }?: CatalogPlatformApplicationValidator.GetSearchRerankDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchRerankDetailResponse>;
1266
+ /**
1267
+ * @param {CatalogPlatformApplicationValidator.GetSynonymsParam} arg - Arg object
1268
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1269
+ * @param {import("../PlatformAPIClient").Options} - Options
1270
+ * @returns {Promise<CatalogPlatformModel.SynonymListResponseSchema>} -
1271
+ * Success response
1272
+ * @name getSynonyms
1273
+ * @summary: List search synonyms for an application
1274
+ * @description: This view allows you to list down the available synonyms for an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSynonyms/).
1275
+ */
1276
+ getSynonyms({ id, name, type, requestHeaders }?: CatalogPlatformApplicationValidator.GetSynonymsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SynonymListResponseSchema>;
1277
+ /**
1278
+ * @param {CatalogPlatformApplicationValidator.PollBulkSynonymsParam} arg - Arg object
1279
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1280
+ * @param {import("../PlatformAPIClient").Options} - Options
1281
+ * @returns {Promise<CatalogPlatformModel.SynonymBulkPollResponseSchema>} -
1282
+ * Success response
1283
+ * @name pollBulkSynonyms
1284
+ * @summary: poll a particular synonym bulk job for status
1285
+ * @description: This view allows you to poll for the status of the respective bulk upload job - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/pollBulkSynonyms/).
1286
+ */
1287
+ pollBulkSynonyms({ id, requestHeaders }?: CatalogPlatformApplicationValidator.PollBulkSynonymsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SynonymBulkPollResponseSchema>;
1288
+ /**
1289
+ * @param {CatalogPlatformApplicationValidator.PollPriceFactoryJobsParam} arg
1290
+ * - Arg object
1291
+ *
1292
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1293
+ * @param {import("../PlatformAPIClient").Options} - Options
1294
+ * @returns {Promise<CatalogPlatformModel.CreateAppPriceFactoryProductExportJobPollResponse>}
907
1295
  * - Success response
908
1296
  *
909
- * @name getSearchKeywords
910
- * @summary: Get search keywords
911
- * @description: Retrieve a list of a specific list of keywords by its id for a specific company and sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSearchKeywords/).
1297
+ * @name pollPriceFactoryJobs
1298
+ * @summary: poll job for adding products in price factory
1299
+ * @description: This API allows to poll job for adding products in price factory. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/pollPriceFactoryJobs/).
912
1300
  */
913
- getSearchKeywords({ id, requestHeaders }?: CatalogPlatformApplicationValidator.GetSearchKeywordsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchWordsDetailResponseSchema>;
1301
+ pollPriceFactoryJobs({ id, requestHeaders }?: CatalogPlatformApplicationValidator.PollPriceFactoryJobsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateAppPriceFactoryProductExportJobPollResponse>;
914
1302
  /**
915
- * @param {CatalogPlatformApplicationValidator.UpdateAllowSingleParam} arg
1303
+ * @param {CatalogPlatformApplicationValidator.PollProductPriceFactoryBulkJobParam} arg
916
1304
  * - Arg object
917
1305
  *
918
1306
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
919
1307
  * @param {import("../PlatformAPIClient").Options} - Options
920
- * @returns {Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>} -
1308
+ * @returns {Promise<CatalogPlatformModel.CreateAppPriceFactoryProductBulkJobPollResponse>}
1309
+ * - Success response
1310
+ *
1311
+ * @name pollProductPriceFactoryBulkJob
1312
+ * @summary: Poll bulk job for adding products in price factory.
1313
+ * @description: This API allows to poll bulk job for adding products in price factory. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/pollProductPriceFactoryBulkJob/).
1314
+ */
1315
+ pollProductPriceFactoryBulkJob({ id, jobId, requestHeaders }?: CatalogPlatformApplicationValidator.PollProductPriceFactoryBulkJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateAppPriceFactoryProductBulkJobPollResponse>;
1316
+ /**
1317
+ * @param {CatalogPlatformApplicationValidator.ProcessBulkSynonymsParam} arg
1318
+ * - Arg object
1319
+ *
1320
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1321
+ * @param {import("../PlatformAPIClient").Options} - Options
1322
+ * @returns {Promise<CatalogPlatformModel.SynonymBulkProcessResponseSchema>}
1323
+ * - Success response
1324
+ *
1325
+ * @name processBulkSynonyms
1326
+ * @summary: process csv/xls/xlsx file with synonyms and insert onto db
1327
+ * @description: This view allows you to process a list of one-way/two-way synonyms - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/processBulkSynonyms/).
1328
+ */
1329
+ processBulkSynonyms({ body, requestHeaders }?: CatalogPlatformApplicationValidator.ProcessBulkSynonymsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SynonymBulkProcessResponseSchema>;
1330
+ /**
1331
+ * @param {CatalogPlatformApplicationValidator.ProcessProductPriceFactoryBulkJobParam} arg
1332
+ * - Arg object
1333
+ *
1334
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1335
+ * @param {import("../PlatformAPIClient").Options} - Options
1336
+ * @returns {Promise<CatalogPlatformModel.CreateAppPriceFactoryProductBulkJobResponse>}
1337
+ * - Success response
1338
+ *
1339
+ * @name processProductPriceFactoryBulkJob
1340
+ * @summary: Process bulk job for adding products in price factory.
1341
+ * @description: This API allows to process bulk job for adding products in price factory. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/processProductPriceFactoryBulkJob/).
1342
+ */
1343
+ processProductPriceFactoryBulkJob({ id, jobId, body, requestHeaders }?: CatalogPlatformApplicationValidator.ProcessProductPriceFactoryBulkJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateAppPriceFactoryProductBulkJobResponse>;
1344
+ /**
1345
+ * @param {CatalogPlatformApplicationValidator.SampleBulkSynonymsFileParam} arg
1346
+ * - Arg object
1347
+ *
1348
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1349
+ * @param {import("../PlatformAPIClient").Options} - Options
1350
+ * @returns {Promise<string>} - Success response
1351
+ * @name sampleBulkSynonymsFile
1352
+ * @summary: Get sample file for bulk synonyms upload
1353
+ * @description: This api return you the sample file for bulk synonyms upload - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/sampleBulkSynonymsFile/).
1354
+ */
1355
+ sampleBulkSynonymsFile({ type, requestHeaders }?: CatalogPlatformApplicationValidator.SampleBulkSynonymsFileParam, { responseHeaders }?: object): Promise<string>;
1356
+ /**
1357
+ * @param {CatalogPlatformApplicationValidator.SaveMerchandisingRulesParam} arg
1358
+ * - Arg object
1359
+ *
1360
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1361
+ * @param {import("../PlatformAPIClient").Options} - Options
1362
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseMerchandising>} -
921
1363
  * Success response
1364
+ * @name saveMerchandisingRules
1365
+ * @summary: Save a Merchandising Rule
1366
+ * @description: This allows you to Save a merchandising rule's preview state. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/saveMerchandisingRules/).
1367
+ */
1368
+ saveMerchandisingRules({ merchandisingRuleId, body, requestHeaders }?: CatalogPlatformApplicationValidator.SaveMerchandisingRulesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseMerchandising>;
1369
+ /**
1370
+ * @param {CatalogPlatformApplicationValidator.UpdateAllowSingleParam} arg
1371
+ * - Arg object
1372
+ *
1373
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1374
+ * @param {import("../PlatformAPIClient").Options} - Options
1375
+ * @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
922
1376
  * @name updateAllowSingle
923
- * @summary: Update 'Allow Single' setting
924
- * @description: Modify allow single flag for filters of the sales channel for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAllowSingle/).
1377
+ * @summary: Update 'Allow Single' setting.
1378
+ * @description: Modify allow single flag for filters of the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAllowSingle/).
925
1379
  */
926
- updateAllowSingle({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAllowSingleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>;
1380
+ updateAllowSingle({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAllowSingleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponse>;
927
1381
  /**
928
1382
  * @param {CatalogPlatformApplicationValidator.UpdateAppBrandParam} arg - Arg object
929
1383
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
930
1384
  * @param {import("../PlatformAPIClient").Options} - Options
931
- * @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
1385
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
932
1386
  * @name updateAppBrand
933
- * @summary: Update sales channel brand
934
- * @description: Modify data associated to the brand for that particular sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppBrand/).
1387
+ * @summary: Update application brand.
1388
+ * @description: Modify data associated to a item custom meta. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppBrand/).
935
1389
  */
936
- updateAppBrand({ brandUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppBrandParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
1390
+ updateAppBrand({ brandUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppBrandParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
937
1391
  /**
938
1392
  * @param {CatalogPlatformApplicationValidator.UpdateAppCategoryParam} arg
939
1393
  * - Arg object
940
1394
  *
941
1395
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
942
1396
  * @param {import("../PlatformAPIClient").Options} - Options
943
- * @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
1397
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
944
1398
  * @name updateAppCategory
945
- * @summary: Update sales channel category
946
- * @description: Modify category data related to the sales channel . - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppCategory/).
1399
+ * @summary: Update application category.
1400
+ * @description: Modify category data related to the application. Helps to update data associated to a item custom meta. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppCategory/).
947
1401
  */
948
- updateAppCategory({ categoryUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppCategoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
1402
+ updateAppCategory({ categoryUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppCategoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
949
1403
  /**
950
1404
  * @param {CatalogPlatformApplicationValidator.UpdateAppCategoryReturnConfigurationParam} arg
951
1405
  * - Arg object
952
1406
  *
953
1407
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
954
1408
  * @param {import("../PlatformAPIClient").Options} - Options
955
- * @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
1409
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
956
1410
  * @name updateAppCategoryReturnConfiguration
957
- * @summary: Update return Configuration
958
- * @description: Update Category level sales channel Return Configuration setttings - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppCategoryReturnConfiguration/).
1411
+ * @summary: Update Category level Application Return Configuration setttings
1412
+ * @description: Update Category level Application Return Configuration setttings - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppCategoryReturnConfiguration/).
959
1413
  */
960
- updateAppCategoryReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppCategoryReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
1414
+ updateAppCategoryReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppCategoryReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
961
1415
  /**
962
1416
  * @param {CatalogPlatformApplicationValidator.UpdateAppDepartmentParam} arg
963
1417
  * - Arg object
964
1418
  *
965
1419
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
966
1420
  * @param {import("../PlatformAPIClient").Options} - Options
967
- * @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
1421
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
968
1422
  * @name updateAppDepartment
969
- * @summary: Update sales channel department
970
- * @description: Modify department data associated to the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppDepartment/).
1423
+ * @summary: Update application department.
1424
+ * @description: Modify department data related to the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppDepartment/).
971
1425
  */
972
- updateAppDepartment({ departmentUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppDepartmentParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
1426
+ updateAppDepartment({ departmentUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppDepartmentParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
973
1427
  /**
974
1428
  * @param {CatalogPlatformApplicationValidator.UpdateAppLocationParam} arg
975
1429
  * - Arg object
976
1430
  *
977
1431
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
978
1432
  * @param {import("../PlatformAPIClient").Options} - Options
979
- * @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
1433
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
980
1434
  * @name updateAppLocation
981
- * @summary: Update sales channel location
982
- * @description: Modify location data related to the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppLocation/).
1435
+ * @summary: Update application location.
1436
+ * @description: Modify location data related to the application. Helps to update data associated to a item custom meta - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppLocation/).
983
1437
  */
984
- updateAppLocation({ storeUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppLocationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
1438
+ updateAppLocation({ storeUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppLocationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
985
1439
  /**
986
1440
  * @param {CatalogPlatformApplicationValidator.UpdateAppProductParam} arg - Arg object
987
1441
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
988
1442
  * @param {import("../PlatformAPIClient").Options} - Options
989
- * @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
1443
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
990
1444
  * @name updateAppProduct
991
- * @summary: Update sales channel product
992
- * @description: Allows to update data associated to a item by its item_id for a sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppProduct/).
1445
+ * @summary: Update application product data.
1446
+ * @description: Allows to update data associated to a item custom meta. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppProduct/).
993
1447
  */
994
- updateAppProduct({ itemId, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
1448
+ updateAppProduct({ itemId, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
995
1449
  /**
996
1450
  * @param {CatalogPlatformApplicationValidator.UpdateAppReturnConfigurationParam} arg
997
1451
  * - Arg object
998
1452
  *
999
1453
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1000
1454
  * @param {import("../PlatformAPIClient").Options} - Options
1001
- * @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
1455
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
1002
1456
  * @name updateAppReturnConfiguration
1003
- * @summary: Update product return configuration
1004
- * @description: Update Return configuration level set for an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppReturnConfiguration/).
1457
+ * @summary: Update Return configuration level set for an application
1458
+ * @description: Update Return configuration level set for an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppReturnConfiguration/).
1005
1459
  */
1006
- updateAppReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
1460
+ updateAppReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
1007
1461
  /**
1008
1462
  * @param {CatalogPlatformApplicationValidator.UpdateAutocompleteKeywordParam} arg
1009
1463
  * - Arg object
1010
1464
  *
1011
1465
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1012
1466
  * @param {import("../PlatformAPIClient").Options} - Options
1013
- * @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponseSchema>}
1467
+ * @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsData>} -
1468
+ * Success response
1469
+ * @name updateAutocompleteKeyword
1470
+ * @summary: Update autocomplete keywords.
1471
+ * @description: Update a mapping by it's id. On successful request, returns the updated Keyword mapping - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAutocompleteKeyword/).
1472
+ */
1473
+ updateAutocompleteKeyword({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAutocompleteKeywordParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAutocompleteWordsData>;
1474
+ /**
1475
+ * @param {CatalogPlatformApplicationValidator.UpdateAutocompleteSettingsParam} arg
1476
+ * - Arg object
1477
+ *
1478
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1479
+ * @param {import("../PlatformAPIClient").Options} - Options
1480
+ * @returns {Promise<CatalogPlatformModel.AutocompleteUpsertResponseSchema>}
1014
1481
  * - Success response
1015
1482
  *
1016
- * @name updateAutocompleteKeyword
1017
- * @summary: Update autocomplete keyword
1018
- * @description: Update a specific autocomplete keyword configuration by its id for a specific sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAutocompleteKeyword/).
1483
+ * @name updateAutocompleteSettings
1484
+ * @summary: Update autocomplete settings config for an application
1485
+ * @description: This API allows to update autocomplete settings for an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAutocompleteSettings/).
1019
1486
  */
1020
- updateAutocompleteKeyword({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAutocompleteKeywordParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAutocompleteWordsResponseSchema>;
1487
+ updateAutocompleteSettings({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAutocompleteSettingsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AutocompleteUpsertResponseSchema>;
1021
1488
  /**
1022
1489
  * @param {CatalogPlatformApplicationValidator.UpdateCollectionParam} arg - Arg object
1023
1490
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -1034,13 +1501,12 @@ declare class Catalog {
1034
1501
  *
1035
1502
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1036
1503
  * @param {import("../PlatformAPIClient").Options} - Options
1037
- * @returns {Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>} -
1038
- * Success response
1504
+ * @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
1039
1505
  * @name updateDefaultSort
1040
- * @summary: Update default sorting
1041
- * @description: Modify the default sort key configuration for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateDefaultSort/).
1506
+ * @summary: Update default sorting.
1507
+ * @description: Modify the default sort key configuration for the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateDefaultSort/).
1042
1508
  */
1043
- updateDefaultSort({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateDefaultSortParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>;
1509
+ updateDefaultSort({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateDefaultSortParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponse>;
1044
1510
  /**
1045
1511
  * @param {CatalogPlatformApplicationValidator.UpdateGroupConfigurationParam} arg
1046
1512
  * - Arg object
@@ -1049,8 +1515,8 @@ declare class Catalog {
1049
1515
  * @param {import("../PlatformAPIClient").Options} - Options
1050
1516
  * @returns {Promise<CatalogPlatformModel.AppConfigurationDetail>} - Success response
1051
1517
  * @name updateGroupConfiguration
1052
- * @summary: Update group configuration
1053
- * @description: Modify group configurations by its slug for specific config_type for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateGroupConfiguration/).
1518
+ * @summary: Update group configuration.
1519
+ * @description: Modify the group configurations for the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateGroupConfiguration/).
1054
1520
  */
1055
1521
  updateGroupConfiguration({ configType, groupSlug, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateGroupConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppConfigurationDetail>;
1056
1522
  /**
@@ -1059,26 +1525,93 @@ declare class Catalog {
1059
1525
  *
1060
1526
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1061
1527
  * @param {import("../PlatformAPIClient").Options} - Options
1062
- * @returns {Promise<CatalogPlatformModel.AppConfigurationsSort>} - Success response
1528
+ * @returns {Promise<CatalogPlatformModel.AppConfigurationsFilterResponse>}
1529
+ * - Success response
1530
+ *
1063
1531
  * @name updateListingConfiguration
1064
- * @summary: Update listing configuration
1065
- * @description: Modify a specific product listing configuration by its config_id for a specific config_type for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateListingConfiguration/).
1532
+ * @summary: Update listing configuration.
1533
+ * @description: Modify the details and settings of an existing listing configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateListingConfiguration/).
1534
+ */
1535
+ updateListingConfiguration({ configType, configId, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateListingConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppConfigurationsFilterResponse>;
1536
+ /**
1537
+ * @param {CatalogPlatformApplicationValidator.UpdateMerchandisingRuleBoostActionParam} arg
1538
+ * - Arg object
1539
+ *
1540
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1541
+ * @param {import("../PlatformAPIClient").Options} - Options
1542
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseMerchandising>} -
1543
+ * Success response
1544
+ * @name updateMerchandisingRuleBoostAction
1545
+ * @summary: Update Merchandising Rule's Boost action details
1546
+ * @description: This allows you to update Boost action of a merchandising rule. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateMerchandisingRuleBoostAction/).
1547
+ */
1548
+ updateMerchandisingRuleBoostAction({ merchandisingRuleId, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateMerchandisingRuleBoostActionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseMerchandising>;
1549
+ /**
1550
+ * @param {CatalogPlatformApplicationValidator.UpdateMerchandisingRuleBuryActionParam} arg
1551
+ * - Arg object
1552
+ *
1553
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1554
+ * @param {import("../PlatformAPIClient").Options} - Options
1555
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseMerchandising>} -
1556
+ * Success response
1557
+ * @name updateMerchandisingRuleBuryAction
1558
+ * @summary: Update Merchandising Rule's Bury action details
1559
+ * @description: This allows you to update Bury action of a merchandising rule. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateMerchandisingRuleBuryAction/).
1066
1560
  */
1067
- updateListingConfiguration({ configType, configId, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateListingConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppConfigurationsSort>;
1561
+ updateMerchandisingRuleBuryAction({ merchandisingRuleId, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateMerchandisingRuleBuryActionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseMerchandising>;
1562
+ /**
1563
+ * @param {CatalogPlatformApplicationValidator.UpdateMerchandisingRuleHideActionParam} arg
1564
+ * - Arg object
1565
+ *
1566
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1567
+ * @param {import("../PlatformAPIClient").Options} - Options
1568
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseMerchandising>} -
1569
+ * Success response
1570
+ * @name updateMerchandisingRuleHideAction
1571
+ * @summary: Update Merchandising Rule's Hide action details
1572
+ * @description: This allows you to update hide action of a merchandising rule. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateMerchandisingRuleHideAction/).
1573
+ */
1574
+ updateMerchandisingRuleHideAction({ merchandisingRuleId, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateMerchandisingRuleHideActionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseMerchandising>;
1575
+ /**
1576
+ * @param {CatalogPlatformApplicationValidator.UpdateMerchandisingRulePinActionParam} arg
1577
+ * - Arg object
1578
+ *
1579
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1580
+ * @param {import("../PlatformAPIClient").Options} - Options
1581
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseMerchandising>} -
1582
+ * Success response
1583
+ * @name updateMerchandisingRulePinAction
1584
+ * @summary: Update Merchandising Rule's action details
1585
+ * @description: This allows you to update pin action of a merchandising rule. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateMerchandisingRulePinAction/).
1586
+ */
1587
+ updateMerchandisingRulePinAction({ merchandisingRuleId, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateMerchandisingRulePinActionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseMerchandising>;
1588
+ /**
1589
+ * @param {CatalogPlatformApplicationValidator.UpdateMerchandisingRuleQueryParam} arg
1590
+ * - Arg object
1591
+ *
1592
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1593
+ * @param {import("../PlatformAPIClient").Options} - Options
1594
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseMerchandising>} -
1595
+ * Success response
1596
+ * @name updateMerchandisingRuleQuery
1597
+ * @summary: Update a Merchandising Rule's query
1598
+ * @description: This allows you to Update a merchandising rule's query. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateMerchandisingRuleQuery/).
1599
+ */
1600
+ updateMerchandisingRuleQuery({ merchandisingRuleId, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateMerchandisingRuleQueryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseMerchandising>;
1068
1601
  /**
1069
1602
  * @param {CatalogPlatformApplicationValidator.UpdateSearchConfigurationParam} arg
1070
1603
  * - Arg object
1071
1604
  *
1072
1605
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1073
1606
  * @param {import("../PlatformAPIClient").Options} - Options
1074
- * @returns {Promise<CatalogPlatformModel.UpdateSearchConfigurationResponseSchema>}
1607
+ * @returns {Promise<CatalogPlatformModel.UpdateSearchConfigurationResponse>}
1075
1608
  * - Success response
1076
1609
  *
1077
1610
  * @name updateSearchConfiguration
1078
- * @summary: Update search configuration
1079
- * @description: Allows you to modify searchable attributes for an sales channel. searchable attributes are the fields on which the products are searched. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateSearchConfiguration/).
1611
+ * @summary: Update search configuration for an application
1612
+ * @description: This view allows you to modify searchable attributes for an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateSearchConfiguration/).
1080
1613
  */
1081
- updateSearchConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateSearchConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.UpdateSearchConfigurationResponseSchema>;
1614
+ updateSearchConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateSearchConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.UpdateSearchConfigurationResponse>;
1082
1615
  /**
1083
1616
  * @param {CatalogPlatformApplicationValidator.UpdateSearchKeywordsParam} arg
1084
1617
  * - Arg object
@@ -1087,10 +1620,73 @@ declare class Catalog {
1087
1620
  * @param {import("../PlatformAPIClient").Options} - Options
1088
1621
  * @returns {Promise<CatalogPlatformModel.GetSearchWordsData>} - Success response
1089
1622
  * @name updateSearchKeywords
1090
- * @summary: Update search keywords
1091
- * @description: Update a specific search keyword by its id for a specific company and sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateSearchKeywords/).
1623
+ * @summary: Update search keywords.
1624
+ * @description: Update Search Keyword by its id. On successful request, returns the updated collection - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateSearchKeywords/).
1092
1625
  */
1093
1626
  updateSearchKeywords({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateSearchKeywordsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchWordsData>;
1627
+ /**
1628
+ * @param {CatalogPlatformApplicationValidator.UpdateSearchRerankConfigurationParam} arg
1629
+ * - Arg object
1630
+ *
1631
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1632
+ * @param {import("../PlatformAPIClient").Options} - Options
1633
+ * @returns {Promise<CatalogPlatformModel.UpdateSearchRerankResponse>} -
1634
+ * Success response
1635
+ * @name updateSearchRerankConfiguration
1636
+ * @summary: Update search rerank for an application
1637
+ * @description: This view allows you to update search rerank attribute for an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateSearchRerankConfiguration/).
1638
+ */
1639
+ updateSearchRerankConfiguration({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateSearchRerankConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.UpdateSearchRerankResponse>;
1640
+ /**
1641
+ * @param {CatalogPlatformApplicationValidator.UpdateSynonymsParam} arg - Arg object
1642
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1643
+ * @param {import("../PlatformAPIClient").Options} - Options
1644
+ * @returns {Promise<CatalogPlatformModel.SynonymUpdateResponseSchema>} -
1645
+ * Success response
1646
+ * @name updateSynonyms
1647
+ * @summary: Update synonym attributes for an application
1648
+ * @description: This view allows you to modify synonym attributes for a particular application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateSynonyms/).
1649
+ */
1650
+ updateSynonyms({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateSynonymsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SynonymUpdateResponseSchema>;
1651
+ /**
1652
+ * @param {CatalogPlatformApplicationValidator.UploadSynonymsParam} arg - Arg object
1653
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1654
+ * @param {import("../PlatformAPIClient").Options} - Options
1655
+ * @returns {Promise<CatalogPlatformModel.SynonymUploadResponseSchema>} -
1656
+ * Success response
1657
+ * @name uploadSynonyms
1658
+ * @summary: Upload csv/xls/xlsx file with synonyms
1659
+ * @description: This API allows you to upload a list of one-way/two-way synonyms - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/uploadSynonyms/).
1660
+ */
1661
+ uploadSynonyms({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UploadSynonymsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SynonymUploadResponseSchema>;
1662
+ /**
1663
+ * @param {CatalogPlatformApplicationValidator.ValidateBulkSynonymsParam} arg
1664
+ * - Arg object
1665
+ *
1666
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1667
+ * @param {import("../PlatformAPIClient").Options} - Options
1668
+ * @returns {Promise<CatalogPlatformModel.SynonymBulkValidateResponseSchema>}
1669
+ * - Success response
1670
+ *
1671
+ * @name validateBulkSynonyms
1672
+ * @summary: Validate csv/xls/xlsx file with synonyms
1673
+ * @description: This view allows you to validate the file uploaded for synonyms - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/validateBulkSynonyms/).
1674
+ */
1675
+ validateBulkSynonyms({ body, requestHeaders }?: CatalogPlatformApplicationValidator.ValidateBulkSynonymsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SynonymBulkValidateResponseSchema>;
1676
+ /**
1677
+ * @param {CatalogPlatformApplicationValidator.ValidateProductPriceFactoryBulkJobParam} arg
1678
+ * - Arg object
1679
+ *
1680
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1681
+ * @param {import("../PlatformAPIClient").Options} - Options
1682
+ * @returns {Promise<CatalogPlatformModel.CreateAppPriceFactoryProductBulkJobValidateResponse>}
1683
+ * - Success response
1684
+ *
1685
+ * @name validateProductPriceFactoryBulkJob
1686
+ * @summary: Validate bulk job for adding products in price factory.
1687
+ * @description: This API allows to validate bulk job for adding products in price factory. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/validateProductPriceFactoryBulkJob/).
1688
+ */
1689
+ validateProductPriceFactoryBulkJob({ id, jobId, body, requestHeaders }?: CatalogPlatformApplicationValidator.ValidateProductPriceFactoryBulkJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateAppPriceFactoryProductBulkJobValidateResponse>;
1094
1690
  }
1095
1691
  import CatalogPlatformApplicationValidator = require("./CatalogPlatformApplicationValidator");
1096
1692
  import CatalogPlatformModel = require("./CatalogPlatformModel");