@gofynd/fdk-client-javascript 3.1.0-beta.1 → 3.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (304) hide show
  1. package/README.md +1 -1
  2. package/package.json +2 -2
  3. package/sdk/application/ApplicationClient.d.ts +2 -0
  4. package/sdk/application/ApplicationClient.js +2 -0
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +81 -101
  6. package/sdk/application/Cart/CartApplicationClient.js +173 -511
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +214 -447
  9. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
  10. package/sdk/application/Common/CommonApplicationClient.js +4 -19
  11. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -43
  12. package/sdk/application/Communication/CommunicationApplicationClient.js +4 -214
  13. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +41 -54
  14. package/sdk/application/Configuration/ConfigurationApplicationClient.js +39 -192
  15. package/sdk/application/Content/ContentApplicationClient.d.ts +61 -61
  16. package/sdk/application/Content/ContentApplicationClient.js +183 -366
  17. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
  18. package/sdk/application/FileStorage/FileStorageApplicationClient.js +11 -30
  19. package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
  20. package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
  21. package/sdk/application/Lead/LeadApplicationClient.d.ts +6 -6
  22. package/sdk/application/Lead/LeadApplicationClient.js +24 -55
  23. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +28 -117
  24. package/sdk/application/Logistic/LogisticApplicationClient.js +99 -492
  25. package/sdk/application/Order/OrderApplicationClient.d.ts +31 -51
  26. package/sdk/application/Order/OrderApplicationClient.js +89 -293
  27. package/sdk/application/Payment/PaymentApplicationClient.d.ts +108 -218
  28. package/sdk/application/Payment/PaymentApplicationClient.js +100 -1081
  29. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -14
  30. package/sdk/application/Rewards/RewardsApplicationClient.js +13 -66
  31. package/sdk/application/Share/ShareApplicationClient.d.ts +11 -11
  32. package/sdk/application/Share/ShareApplicationClient.js +35 -89
  33. package/sdk/application/Theme/ThemeApplicationClient.d.ts +5 -25
  34. package/sdk/application/Theme/ThemeApplicationClient.js +24 -150
  35. package/sdk/application/User/UserApplicationClient.d.ts +23 -13
  36. package/sdk/application/User/UserApplicationClient.js +49 -407
  37. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
  38. package/sdk/application/Webhook/WebhookApplicationClient.js +4 -11
  39. package/sdk/common/Utility.d.ts +1 -1
  40. package/sdk/common/Utility.js +10 -7
  41. package/sdk/common/Validator.d.ts +1 -0
  42. package/sdk/common/Validator.js +20 -0
  43. package/sdk/common/utils.d.ts +0 -1
  44. package/sdk/common/utils.js +0 -14
  45. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +10 -54
  46. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +32 -364
  47. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +54 -1
  48. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +43 -0
  49. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -5
  50. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -35
  51. package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
  52. package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
  53. package/sdk/partner/Lead/LeadPartnerModel.d.ts +52 -98
  54. package/sdk/partner/Lead/LeadPartnerModel.js +76 -100
  55. package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
  56. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +172 -41
  57. package/sdk/partner/Logistics/LogisticsPartnerClient.js +1222 -85
  58. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1921 -297
  59. package/sdk/partner/Logistics/LogisticsPartnerModel.js +973 -258
  60. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +13 -1
  61. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +148 -16
  62. package/sdk/partner/PartnerClient.d.ts +0 -6
  63. package/sdk/partner/PartnerClient.js +0 -9
  64. package/sdk/partner/Theme/ThemePartnerClient.d.ts +21 -63
  65. package/sdk/partner/Theme/ThemePartnerClient.js +67 -392
  66. package/sdk/partner/Theme/ThemePartnerModel.d.ts +72 -104
  67. package/sdk/partner/Theme/ThemePartnerModel.js +75 -101
  68. package/sdk/partner/Theme/ThemePartnerValidator.d.ts +1 -5
  69. package/sdk/partner/Theme/ThemePartnerValidator.js +12 -42
  70. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
  71. package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
  72. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +673 -189
  73. package/sdk/partner/Webhook/WebhookPartnerModel.js +270 -159
  74. package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
  75. package/sdk/partner/index.d.ts +0 -3
  76. package/sdk/partner/index.js +0 -6
  77. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
  78. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
  79. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +3 -3
  80. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -3
  81. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
  82. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
  83. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +49 -145
  84. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +20 -171
  85. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
  86. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
  87. package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
  88. package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
  89. package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
  90. package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
  91. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
  92. package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
  93. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +172 -251
  94. package/sdk/platform/Cart/CartPlatformApplicationClient.js +577 -648
  95. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +270 -165
  96. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +192 -108
  97. package/sdk/platform/Cart/CartPlatformModel.d.ts +4554 -3154
  98. package/sdk/platform/Cart/CartPlatformModel.js +1935 -2854
  99. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +380 -976
  100. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2004 -6464
  101. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +161 -1082
  102. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +80 -884
  103. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +568 -325
  104. package/sdk/platform/Catalog/CatalogPlatformClient.js +1560 -1162
  105. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9772 -7871
  106. package/sdk/platform/Catalog/CatalogPlatformModel.js +6978 -9516
  107. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +231 -240
  108. package/sdk/platform/Catalog/CatalogPlatformValidator.js +180 -188
  109. package/sdk/platform/Common/CommonPlatformClient.d.ts +6 -5
  110. package/sdk/platform/Common/CommonPlatformClient.js +6 -5
  111. package/sdk/platform/Common/CommonPlatformModel.d.ts +19 -25
  112. package/sdk/platform/Common/CommonPlatformModel.js +11 -14
  113. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +240 -376
  114. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +589 -874
  115. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +139 -170
  116. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +126 -145
  117. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +3 -56
  118. package/sdk/platform/Communication/CommunicationPlatformClient.js +4 -307
  119. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +330 -502
  120. package/sdk/platform/Communication/CommunicationPlatformModel.js +376 -610
  121. package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +3 -62
  122. package/sdk/platform/Communication/CommunicationPlatformValidator.js +2 -48
  123. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +72 -100
  124. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +88 -146
  125. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +270 -241
  126. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +248 -226
  127. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +20 -31
  128. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -25
  129. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +117 -332
  130. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +409 -1470
  131. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +55 -158
  132. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +41 -163
  133. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +65 -142
  134. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +103 -568
  135. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +562 -1289
  136. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +368 -1037
  137. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +34 -80
  138. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +24 -79
  139. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +302 -248
  140. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1292 -773
  141. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +330 -218
  142. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +325 -208
  143. package/sdk/platform/Content/ContentPlatformClient.d.ts +279 -118
  144. package/sdk/platform/Content/ContentPlatformClient.js +1617 -492
  145. package/sdk/platform/Content/ContentPlatformModel.d.ts +2391 -924
  146. package/sdk/platform/Content/ContentPlatformModel.js +1314 -970
  147. package/sdk/platform/Content/ContentPlatformValidator.d.ts +272 -134
  148. package/sdk/platform/Content/ContentPlatformValidator.js +295 -118
  149. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +53 -43
  150. package/sdk/platform/Discount/DiscountPlatformClient.js +53 -43
  151. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +383 -110
  152. package/sdk/platform/Discount/DiscountPlatformModel.js +117 -108
  153. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
  154. package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
  155. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -163
  156. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -1078
  157. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -141
  158. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -177
  159. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
  160. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
  161. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +30 -1123
  162. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +24 -1135
  163. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  164. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  165. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +17 -17
  166. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +33 -33
  167. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +19 -19
  168. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +14 -14
  169. package/sdk/platform/Lead/LeadPlatformClient.d.ts +24 -4
  170. package/sdk/platform/Lead/LeadPlatformClient.js +160 -4
  171. package/sdk/platform/Lead/LeadPlatformModel.d.ts +60 -140
  172. package/sdk/platform/Lead/LeadPlatformModel.js +81 -162
  173. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +29 -3
  174. package/sdk/platform/Lead/LeadPlatformValidator.js +28 -2
  175. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +19 -98
  176. package/sdk/platform/Order/OrderPlatformApplicationClient.js +27 -662
  177. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +91 -118
  178. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +32 -127
  179. package/sdk/platform/Order/OrderPlatformClient.d.ts +406 -403
  180. package/sdk/platform/Order/OrderPlatformClient.js +1200 -1343
  181. package/sdk/platform/Order/OrderPlatformModel.d.ts +8665 -4505
  182. package/sdk/platform/Order/OrderPlatformModel.js +4088 -3601
  183. package/sdk/platform/Order/OrderPlatformValidator.d.ts +666 -442
  184. package/sdk/platform/Order/OrderPlatformValidator.js +353 -312
  185. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
  186. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
  187. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +67 -19
  188. package/sdk/platform/Partner/PartnerPlatformModel.js +26 -17
  189. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +135 -382
  190. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +937 -2452
  191. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +100 -306
  192. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +74 -305
  193. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +56 -66
  194. package/sdk/platform/Payment/PaymentPlatformClient.js +124 -269
  195. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +1307 -3536
  196. package/sdk/platform/Payment/PaymentPlatformModel.js +1389 -3692
  197. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +35 -64
  198. package/sdk/platform/Payment/PaymentPlatformValidator.js +34 -60
  199. package/sdk/platform/PlatformClient.d.ts +0 -2
  200. package/sdk/platform/PlatformClient.js +0 -4
  201. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
  202. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
  203. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
  204. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
  205. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +12 -12
  206. package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -10
  207. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +64 -136
  208. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +111 -521
  209. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +75 -117
  210. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +50 -105
  211. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +160 -149
  212. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +766 -545
  213. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +6196 -3978
  214. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3181 -3895
  215. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +294 -220
  216. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +205 -149
  217. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +16 -4
  218. package/sdk/platform/Share/SharePlatformApplicationClient.js +86 -8
  219. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +23 -6
  220. package/sdk/platform/Share/SharePlatformApplicationValidator.js +16 -3
  221. package/sdk/platform/Share/SharePlatformModel.d.ts +53 -9
  222. package/sdk/platform/Share/SharePlatformModel.js +45 -5
  223. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +17 -37
  224. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +66 -204
  225. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +25 -26
  226. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +20 -31
  227. package/sdk/platform/Theme/ThemePlatformClient.d.ts +8 -18
  228. package/sdk/platform/Theme/ThemePlatformClient.js +8 -85
  229. package/sdk/platform/Theme/ThemePlatformModel.d.ts +17 -425
  230. package/sdk/platform/Theme/ThemePlatformModel.js +23 -329
  231. package/sdk/platform/Theme/ThemePlatformValidator.d.ts +3 -7
  232. package/sdk/platform/Theme/ThemePlatformValidator.js +2 -9
  233. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +81 -18
  234. package/sdk/platform/User/UserPlatformApplicationClient.js +491 -27
  235. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +126 -10
  236. package/sdk/platform/User/UserPlatformApplicationValidator.js +92 -7
  237. package/sdk/platform/User/UserPlatformModel.d.ts +317 -218
  238. package/sdk/platform/User/UserPlatformModel.js +253 -210
  239. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
  240. package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
  241. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +813 -426
  242. package/sdk/platform/Webhook/WebhookPlatformModel.js +446 -395
  243. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
  244. package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
  245. package/sdk/platform/index.d.ts +0 -1
  246. package/sdk/platform/index.js +0 -2
  247. package/sdk/public/Catalog/CatalogPublicClient.d.ts +22 -0
  248. package/sdk/public/Catalog/CatalogPublicClient.js +133 -0
  249. package/sdk/public/Catalog/CatalogPublicModel.d.ts +158 -0
  250. package/sdk/public/Catalog/CatalogPublicModel.js +116 -0
  251. package/sdk/public/Catalog/CatalogPublicValidator.d.ts +55 -0
  252. package/sdk/public/Catalog/CatalogPublicValidator.js +35 -0
  253. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +4 -14
  254. package/sdk/public/Configuration/ConfigurationPublicClient.js +10 -113
  255. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +46 -114
  256. package/sdk/public/Configuration/ConfigurationPublicModel.js +32 -117
  257. package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +1 -11
  258. package/sdk/public/Configuration/ConfigurationPublicValidator.js +0 -12
  259. package/sdk/public/Content/ContentPublicClient.d.ts +36 -25
  260. package/sdk/public/Content/ContentPublicClient.js +254 -280
  261. package/sdk/public/Content/ContentPublicModel.d.ts +151 -38
  262. package/sdk/public/Content/ContentPublicModel.js +98 -44
  263. package/sdk/public/Content/ContentPublicValidator.d.ts +18 -17
  264. package/sdk/public/Content/ContentPublicValidator.js +26 -19
  265. package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
  266. package/sdk/public/Partner/PartnerPublicClient.js +6 -11
  267. package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
  268. package/sdk/public/Partner/PartnerPublicModel.js +81 -71
  269. package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
  270. package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
  271. package/sdk/public/PublicClient.d.ts +2 -0
  272. package/sdk/public/PublicClient.js +4 -0
  273. package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
  274. package/sdk/public/Webhook/WebhookPublicClient.js +9 -48
  275. package/sdk/public/Webhook/WebhookPublicModel.d.ts +215 -67
  276. package/sdk/public/Webhook/WebhookPublicModel.js +66 -61
  277. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  278. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  279. package/sdk/public/index.d.ts +1 -0
  280. package/sdk/public/index.js +2 -0
  281. package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +0 -66
  282. package/sdk/partner/Authorization/AuthorizationPartnerClient.js +0 -431
  283. package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +0 -231
  284. package/sdk/partner/Authorization/AuthorizationPartnerModel.js +0 -152
  285. package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +0 -8
  286. package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +0 -39
  287. package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +0 -26
  288. package/sdk/partner/Catalog/CatalogPartnerClient.js +0 -173
  289. package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +0 -238
  290. package/sdk/partner/Catalog/CatalogPartnerModel.js +0 -248
  291. package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +0 -5
  292. package/sdk/partner/Catalog/CatalogPartnerValidator.js +0 -19
  293. package/sdk/partner/Payment/PaymentPartnerClient.d.ts +0 -116
  294. package/sdk/partner/Payment/PaymentPartnerClient.js +0 -857
  295. package/sdk/partner/Payment/PaymentPartnerModel.d.ts +0 -388
  296. package/sdk/partner/Payment/PaymentPartnerModel.js +0 -442
  297. package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +0 -14
  298. package/sdk/partner/Payment/PaymentPartnerValidator.js +0 -74
  299. package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
  300. package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
  301. package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2895
  302. package/sdk/platform/Finance/FinancePlatformModel.js +0 -2150
  303. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
  304. package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
@@ -13,100 +13,46 @@ declare class Catalog {
13
13
  * - Success response
14
14
  *
15
15
  * @name 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/).
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/).
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>;
48
20
  /**
49
21
  * @param {CatalogPlatformApplicationValidator.CreateAppCategoryReturnConfigurationParam} arg
50
22
  * - Arg object
51
23
  *
52
24
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
53
25
  * @param {import("../PlatformAPIClient").Options} - Options
54
- * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
26
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
55
27
  * @name 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/).
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/).
71
30
  */
72
- createAppPriceFactory({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateAppPriceFactoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateAppPriceFactoryResponse>;
31
+ createAppCategoryReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateAppCategoryReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
73
32
  /**
74
33
  * @param {CatalogPlatformApplicationValidator.CreateAppReturnConfigurationParam} arg
75
34
  * - Arg object
76
35
  *
77
36
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
78
37
  * @param {import("../PlatformAPIClient").Options} - Options
79
- * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
38
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
80
39
  * @name 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/).
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/).
83
42
  */
84
- createAppReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateAppReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
43
+ createAppReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateAppReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
85
44
  /**
86
- * @param {CatalogPlatformApplicationValidator.CreateAutocompleteSettingsParam} arg
87
- * - Arg object
88
- *
45
+ * @param {CatalogPlatformApplicationValidator.CreateCollectionParam} arg - Arg object
89
46
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
90
47
  * @param {import("../PlatformAPIClient").Options} - Options
91
- * @returns {Promise<CatalogPlatformModel.AutocompleteUpsertResponseSchema>}
48
+ * @returns {Promise<CatalogPlatformModel.CollectionCreateResponseSchema>}
92
49
  * - Success response
93
50
  *
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
105
51
  * @name 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/).
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/).
108
54
  */
109
- createCollection({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateCollectionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CollectionCreateResponse>;
55
+ createCollection({ body, q, scheduleStatus, type, tags, isActive, pageNo, pageSize, requestHeaders, }?: CatalogPlatformApplicationValidator.CreateCollectionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CollectionCreateResponseSchema>;
110
56
  /**
111
57
  * @param {CatalogPlatformApplicationValidator.CreateConfigurationByTypeParam} arg
112
58
  * - Arg object
@@ -116,8 +62,8 @@ declare class Catalog {
116
62
  * @returns {Promise<CatalogPlatformModel.GetAppCatalogConfiguration>} -
117
63
  * Success response
118
64
  * @name 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/).
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/).
121
67
  */
122
68
  createConfigurationByType({ type, body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateConfigurationByTypeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAppCatalogConfiguration>;
123
69
  /**
@@ -129,8 +75,8 @@ declare class Catalog {
129
75
  * @returns {Promise<CatalogPlatformModel.GetAppCatalogConfiguration>} -
130
76
  * Success response
131
77
  * @name 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/).
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/).
134
80
  */
135
81
  createConfigurationProductListing({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateConfigurationProductListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAppCatalogConfiguration>;
136
82
  /**
@@ -139,14 +85,14 @@ declare class Catalog {
139
85
  *
140
86
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
141
87
  * @param {import("../PlatformAPIClient").Options} - Options
142
- * @returns {Promise<CatalogPlatformModel.CreateAutocompleteWordsResponse>}
88
+ * @returns {Promise<CatalogPlatformModel.CreateAutocompleteWordsResponseSchema>}
143
89
  * - Success response
144
90
  *
145
91
  * @name 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/).
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/).
148
94
  */
149
- createCustomAutocompleteRule({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateCustomAutocompleteRuleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateAutocompleteWordsResponse>;
95
+ createCustomAutocompleteRule({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateCustomAutocompleteRuleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateAutocompleteWordsResponseSchema>;
150
96
  /**
151
97
  * @param {CatalogPlatformApplicationValidator.CreateCustomKeywordParam} arg
152
98
  * - Arg object
@@ -155,8 +101,8 @@ declare class Catalog {
155
101
  * @param {import("../PlatformAPIClient").Options} - Options
156
102
  * @returns {Promise<CatalogPlatformModel.GetSearchWordsData>} - Success response
157
103
  * @name 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/).
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/).
160
106
  */
161
107
  createCustomKeyword({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateCustomKeywordParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchWordsData>;
162
108
  /**
@@ -167,8 +113,8 @@ declare class Catalog {
167
113
  * @param {import("../PlatformAPIClient").Options} - Options
168
114
  * @returns {Promise<CatalogPlatformModel.AppConfigurationDetail>} - Success response
169
115
  * @name 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/).
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/).
172
118
  */
173
119
  createGroupConfiguration({ configType, body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateGroupConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppConfigurationDetail>;
174
120
  /**
@@ -177,155 +123,50 @@ declare class Catalog {
177
123
  *
178
124
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
179
125
  * @param {import("../PlatformAPIClient").Options} - Options
180
- * @returns {Promise<CatalogPlatformModel.AppConfigurationsFilterResponse>}
181
- * - Success response
182
- *
126
+ * @returns {Promise<CatalogPlatformModel.AppConfigurationsSort>} - Success response
183
127
  * @name 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/).
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/).
238
130
  */
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/).
265
- */
266
- createProductPriceFactoryBulkJob({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateProductPriceFactoryBulkJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateAppPriceFactoryProductBulkJobResponse>;
131
+ createListingConfiguration({ configType, body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateListingConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppConfigurationsSort>;
267
132
  /**
268
133
  * @param {CatalogPlatformApplicationValidator.CreateSearchConfigurationParam} arg
269
134
  * - Arg object
270
135
  *
271
136
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
272
137
  * @param {import("../PlatformAPIClient").Options} - Options
273
- * @returns {Promise<CatalogPlatformModel.CreateSearchConfigurationResponse>}
138
+ * @returns {Promise<CatalogPlatformModel.CreateSearchConfigurationResponseSchema>}
274
139
  * - Success response
275
140
  *
276
141
  * @name createSearchConfiguration
277
142
  * @summary: Create search configuration
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/).
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/).
303
144
  */
304
- createSynonyms({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateSynonymsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SynonymCreateResponseSchema>;
145
+ createSearchConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateSearchConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateSearchConfigurationResponseSchema>;
305
146
  /**
306
147
  * @param {CatalogPlatformApplicationValidator.DeleteAppCategoryReturnConfigurationParam} arg
307
148
  * - Arg object
308
149
  *
309
150
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
310
151
  * @param {import("../PlatformAPIClient").Options} - Options
311
- * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
152
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
312
153
  * @name 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/).
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/).
315
156
  */
316
- deleteAppCategoryReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteAppCategoryReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
157
+ deleteAppCategoryReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteAppCategoryReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
317
158
  /**
318
159
  * @param {CatalogPlatformApplicationValidator.DeleteAutocompleteKeywordParam} arg
319
160
  * - Arg object
320
161
  *
321
162
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
322
163
  * @param {import("../PlatformAPIClient").Options} - Options
323
- * @returns {Promise<CatalogPlatformModel.DeleteResponse>} - Success response
164
+ * @returns {Promise<CatalogPlatformModel.DeleteResponseSchema>} - Success response
324
165
  * @name 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/).
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/).
327
168
  */
328
- deleteAutocompleteKeyword({ id, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteAutocompleteKeywordParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DeleteResponse>;
169
+ deleteAutocompleteKeyword({ id, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteAutocompleteKeywordParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DeleteResponseSchema>;
329
170
  /**
330
171
  * @param {CatalogPlatformApplicationValidator.DeleteCollectionParam} arg - Arg object
331
172
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -334,7 +175,7 @@ declare class Catalog {
334
175
  * - Success response
335
176
  *
336
177
  * @name deleteCollection
337
- * @summary: Delete a collection.
178
+ * @summary: Delete a collection
338
179
  * @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/).
339
180
  */
340
181
  deleteCollection({ id, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteCollectionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CommonResponseSchemaCollection>;
@@ -344,202 +185,149 @@ declare class Catalog {
344
185
  *
345
186
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
346
187
  * @param {import("../PlatformAPIClient").Options} - Options
347
- * @returns {Promise<any>} - Success response
188
+ * @returns {Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>} -
189
+ * Success response
348
190
  * @name 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/).
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/).
351
193
  */
352
- deleteGroupConfiguration({ configType, groupSlug, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteGroupConfigurationParam, { responseHeaders }?: object): Promise<any>;
194
+ deleteGroupConfiguration({ configType, groupSlug, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteGroupConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>;
353
195
  /**
354
196
  * @param {CatalogPlatformApplicationValidator.DeleteListingConfigurationParam} arg
355
197
  * - Arg object
356
198
  *
357
199
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
358
200
  * @param {import("../PlatformAPIClient").Options} - Options
359
- * @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
360
- * @name 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>} -
201
+ * @returns {Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>} -
372
202
  * 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/).
203
+ * @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/).
389
206
  */
390
- deleteMerchandisingRulesPreview({ merchandisingRuleId, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteMerchandisingRulesPreviewParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseMerchandising>;
207
+ deleteListingConfiguration({ configType, configId, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteListingConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>;
391
208
  /**
392
209
  * @param {CatalogPlatformApplicationValidator.DeleteSearchConfigurationParam} arg
393
210
  * - Arg object
394
211
  *
395
212
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
396
213
  * @param {import("../PlatformAPIClient").Options} - Options
397
- * @returns {Promise<CatalogPlatformModel.DeleteSearchConfigurationResponse>}
214
+ * @returns {Promise<CatalogPlatformModel.DeleteSearchConfigurationResponseSchema>}
398
215
  * - Success response
399
216
  *
400
217
  * @name 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/).
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/).
403
220
  */
404
- deleteSearchConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.DeleteSearchConfigurationResponse>;
221
+ deleteSearchConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.DeleteSearchConfigurationResponseSchema>;
405
222
  /**
406
223
  * @param {CatalogPlatformApplicationValidator.DeleteSearchKeywordsParam} arg
407
224
  * - Arg object
408
225
  *
409
226
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
410
227
  * @param {import("../PlatformAPIClient").Options} - Options
411
- * @returns {Promise<CatalogPlatformModel.DeleteResponse>} - Success response
228
+ * @returns {Promise<CatalogPlatformModel.DeleteResponseSchema>} - Success response
412
229
  * @name 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/).
415
- */
416
- deleteSearchKeywords({ id, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteSearchKeywordsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DeleteResponse>;
417
- /**
418
- * @param {CatalogPlatformApplicationValidator.DeleteSearchRerankConfigurationParam} arg
419
- * - Arg object
420
- *
421
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
422
- * @param {import("../PlatformAPIClient").Options} - Options
423
- * @returns {Promise<CatalogPlatformModel.DeleteSearchRerankConfigurationResponse>}
424
- * - Success response
425
- *
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/).
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/).
429
232
  */
430
- deleteSearchRerankConfiguration({ id, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteSearchRerankConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DeleteSearchRerankConfigurationResponse>;
233
+ deleteSearchKeywords({ id, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteSearchKeywordsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DeleteResponseSchema>;
431
234
  /**
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/).
440
- */
441
- deleteSynonym({ id, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteSynonymParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SynonymDeleteResponseSchema>;
442
- /**
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
235
+ * @param {CatalogPlatformApplicationValidator.GetAllCollectionsParam} arg
456
236
  * - Arg object
457
237
  *
458
238
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
459
239
  * @param {import("../PlatformAPIClient").Options} - Options
460
- * @returns {Promise<CatalogPlatformModel.CreateAppPriceFactoryProductExportJobResponse>}
240
+ * @returns {Promise<CatalogPlatformModel.GetCollectionListingResponseSchema>}
461
241
  * - Success response
462
242
  *
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/).
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/).
477
246
  */
478
- exportSynonyms({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.SynonymExportResponseSchema>;
247
+ getAllCollections({ q, scheduleStatus, type, tags, isActive, pageNo, pageSize, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAllCollectionsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCollectionListingResponseSchema>;
479
248
  /**
480
- * @param {CatalogPlatformApplicationValidator.GetAllCollectionsParam} arg
481
- * - Arg object
482
- *
483
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
484
- * @param {import("../PlatformAPIClient").Options} - Options
485
- * @returns {Promise<CatalogPlatformModel.GetCollectionListingResponse>} -
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/).
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.
490
266
  */
491
- getAllCollections({ q, scheduleStatus, type, tag, isActive, pageNo, pageSize, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAllCollectionsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCollectionListingResponse>;
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>;
492
277
  /**
493
278
  * @param {CatalogPlatformApplicationValidator.GetAllSearchKeywordParam} arg
494
279
  * - Arg object
495
280
  *
496
281
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
497
282
  * @param {import("../PlatformAPIClient").Options} - Options
498
- * @returns {Promise<CatalogPlatformModel.GetSearchWordsResponse>} - Success response
283
+ * @returns {Promise<CatalogPlatformModel.GetSearchWordsResponseSchema>} -
284
+ * Success response
499
285
  * @name 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/).
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/).
502
288
  */
503
- getAllSearchKeyword({ pageNo, pageSize, q, isActive, requestHeaders }?: CatalogPlatformApplicationValidator.GetAllSearchKeywordParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchWordsResponse>;
289
+ getAllSearchKeyword({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchWordsResponseSchema>;
504
290
  /**
505
291
  * @param {CatalogPlatformApplicationValidator.GetAppCategoryReturnConfigParam} arg
506
292
  * - Arg object
507
293
  *
508
294
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
509
295
  * @param {import("../PlatformAPIClient").Options} - Options
510
- * @returns {Promise<CatalogPlatformModel.BaseAppCategoryReturnConfigResponse>}
296
+ * @returns {Promise<CatalogPlatformModel.BaseAppCategoryReturnConfigResponseSchema>}
511
297
  * - Success response
512
298
  *
513
299
  * @name 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/).
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/).
516
302
  */
517
- getAppCategoryReturnConfig({ q, pageNo, pageSize, requestHeaders }?: CatalogPlatformApplicationValidator.GetAppCategoryReturnConfigParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BaseAppCategoryReturnConfigResponse>;
303
+ getAppCategoryReturnConfig({ q, pageNo, pageSize, requestHeaders }?: CatalogPlatformApplicationValidator.GetAppCategoryReturnConfigParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BaseAppCategoryReturnConfigResponseSchema>;
518
304
  /**
519
305
  * @param {CatalogPlatformApplicationValidator.GetAppInventoryParam} arg - Arg object
520
306
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
521
307
  * @param {import("../PlatformAPIClient").Options} - Options
522
- * @returns {Promise<CatalogPlatformModel.InventoryStockResponse>} - Success response
308
+ * @returns {Promise<CatalogPlatformModel.InventoryStockResponseSchema>} -
309
+ * Success response
523
310
  * @name 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/).
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/).
526
313
  */
527
- getAppInventory({ itemIds, storeIds, brandIds, sellerIdentifiers, timestamp, pageSize, pageId, qtyGt, qtyLt, qtyType, fromDate, toDate, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryStockResponse>;
314
+ getAppInventory({ itemIds, storeIds, brandIds, sellerIdentifiers, timestamp, pageSize, pageId, qtyGt, qtyLt, qtyType, fromDate, toDate, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryStockResponseSchema>;
528
315
  /**
529
316
  * @param {CatalogPlatformApplicationValidator.GetAppLocationsParam} arg - Arg object
530
317
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
531
318
  * @param {import("../PlatformAPIClient").Options} - Options
532
- * @returns {Promise<CatalogPlatformModel.LocationListSerializer>} - Success response
319
+ * @returns {Promise<CatalogPlatformModel.LocationListSchema>} - Success response
533
320
  * @name 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/).
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/).
536
323
  */
537
- getAppLocations({ storeType, uid, q, stage, pageNo, pageSize, tags, storeTypes, companyUids, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppLocationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.LocationListSerializer>;
324
+ getAppLocations({ storeType, uid, q, stage, pageNo, pageSize, tags, storeTypes, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppLocationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.LocationListSchema>;
538
325
  /**
539
326
  * @param {Object} arg - Arg object.
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
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.
543
331
  * @param {string} [arg.storeType] - Helps to sort the location list on the
544
332
  * basis of location type.
545
333
  * @param {number[]} [arg.uid] - Helps to sort the location list on the
@@ -551,13 +339,11 @@ declare class Catalog {
551
339
  * page. Default is 20.
552
340
  * @param {string[]} [arg.tags] - Get locations filtered by tags.
553
341
  * @param {string[]} [arg.storeTypes] - Get locations filtered by store types.
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.
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.
559
345
  */
560
- getAppLocationsPaginator({ companyId, applicationId, storeType, uid, q, stage, pageSize, tags, storeTypes, companyUids, }?: {
346
+ getAppLocationsPaginator({ companyId, applicationId, storeType, uid, q, stage, pageSize, tags, storeTypes, }?: {
561
347
  companyId: number;
562
348
  applicationId: string;
563
349
  storeType?: string;
@@ -567,88 +353,74 @@ declare class Catalog {
567
353
  pageSize?: number;
568
354
  tags?: string[];
569
355
  storeTypes?: string[];
570
- companyUids?: number[];
571
- }): Paginator<CatalogPlatformModel.LocationListSerializer>;
572
- /**
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
- *
586
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
587
- * @param {import("../PlatformAPIClient").Options} - Options
588
- * @returns {Promise<CatalogPlatformModel.GetAppPriceFactoryResponse>} -
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>;
356
+ }): Paginator<CatalogPlatformModel.LocationListSchema>;
607
357
  /**
608
358
  * @param {CatalogPlatformApplicationValidator.GetAppProductParam} arg - Arg object
609
359
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
610
360
  * @param {import("../PlatformAPIClient").Options} - Options
611
- * @returns {Promise<CatalogPlatformModel.OwnerAppItemResponse>} - Success response
361
+ * @returns {Promise<CatalogPlatformModel.OwnerAppItemResponseSchema>} -
362
+ * Success response
612
363
  * @name 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/).
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/).
627
366
  */
628
- getAppProductPrices({ itemIds, factoryTypeIds, pageNo, pageSize, requestHeaders }?: CatalogPlatformApplicationValidator.GetAppProductPricesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductPrices>;
367
+ getAppProduct({ itemId, requestHeaders }?: CatalogPlatformApplicationValidator.GetAppProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.OwnerAppItemResponseSchema>;
629
368
  /**
630
369
  * @param {CatalogPlatformApplicationValidator.GetAppProductsParam} arg - Arg object
631
370
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
632
371
  * @param {import("../PlatformAPIClient").Options} - Options
633
- * @returns {Promise<CatalogPlatformModel.RawProductListingResponse>} -
634
- * Success response
372
+ * @returns {Promise<CatalogPlatformModel.RawProductListingResponseSchema>}
373
+ * - Success response
374
+ *
635
375
  * @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/).
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/).
638
378
  */
639
- getAppProducts({ brandIds, categoryIds, departmentIds, tags, itemIds, pageNo, pageSize, q, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.RawProductListingResponse>;
379
+ getAppProducts({ brandIds, categoryIds, departmentIds, tags, itemIds, pageNo, pageSize, q, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.RawProductListingResponseSchema>;
380
+ /**
381
+ * @param {Object} arg - Arg object.
382
+ * @param {number} arg.companyId - A `company_id` is a unique identifier for
383
+ * a particular seller account.
384
+ * @param {string} arg.applicationId - A `application_id` is a unique
385
+ * 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
393
+ * @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
399
+ */
400
+ getAppProductsPaginator({ companyId, applicationId, brandIds, categoryIds, departmentIds, tags, itemIds, pageSize, q, }?: {
401
+ companyId: number;
402
+ applicationId: string;
403
+ brandIds?: number[];
404
+ categoryIds?: number[];
405
+ departmentIds?: number[];
406
+ tags?: string[];
407
+ itemIds?: number[];
408
+ pageSize?: number;
409
+ q?: string;
410
+ }): Paginator<CatalogPlatformModel.RawProductListingResponseSchema>;
640
411
  /**
641
412
  * @param {CatalogPlatformApplicationValidator.GetAppReturnConfigurationParam} arg
642
413
  * - Arg object
643
414
  *
644
415
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
645
416
  * @param {import("../PlatformAPIClient").Options} - Options
646
- * @returns {Promise<CatalogPlatformModel.AppReturnConfigResponse>} - Success response
417
+ * @returns {Promise<CatalogPlatformModel.AppReturnConfigResponseSchema>} -
418
+ * Success response
647
419
  * @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/).
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/).
650
422
  */
651
- getAppReturnConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppReturnConfigResponse>;
423
+ getAppReturnConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppReturnConfigResponseSchema>;
652
424
  /**
653
425
  * @param {CatalogPlatformApplicationValidator.GetApplicationBrandListingParam} arg
654
426
  * - Arg object
@@ -658,8 +430,8 @@ declare class Catalog {
658
430
  * @returns {Promise<CatalogPlatformModel.ApplicationBrandListingSchema>} -
659
431
  * Success response
660
432
  * @name getApplicationBrandListing
661
- * @summary: Get application brand listing.
662
- * @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/).
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/).
663
435
  */
664
436
  getApplicationBrandListing({ pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationBrandListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ApplicationBrandListingSchema>;
665
437
  /**
@@ -670,11 +442,11 @@ declare class Catalog {
670
442
  * identifier for a particular sale channel.
671
443
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
672
444
  * page. Default is 12.
673
- * @param {string} [arg.q] - Search query with brand name.Use this parameter
674
- * to search brands by brand name.
445
+ * @param {string} [arg.q] - Search query with brand name. Use this
446
+ * parameter to search brands by brand name.
675
447
  * @returns {Paginator<CatalogPlatformModel.ApplicationBrandListingSchema>}
676
- * @summary: Get application brand listing.
677
- * @description: Retrieve brand listings related to the application. A brand is the name under which a product is being sold
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
678
450
  */
679
451
  getApplicationBrandListingPaginator({ companyId, applicationId, pageSize, q, }?: {
680
452
  companyId: string;
@@ -688,40 +460,41 @@ declare class Catalog {
688
460
  *
689
461
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
690
462
  * @param {import("../PlatformAPIClient").Options} - Options
691
- * @returns {Promise<CatalogPlatformModel.BrandListingResponse>} - Success response
463
+ * @returns {Promise<CatalogPlatformModel.BrandListingResponseSchema>} -
464
+ * Success response
692
465
  * @name getApplicationBrands
693
- * @summary: Get application brands.
694
- * @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/).
466
+ * @summary: List brands
467
+ * @description: List all the brands. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationBrands/).
695
468
  */
696
- getApplicationBrands({ department, pageNo, pageSize, q, brandId, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationBrandsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BrandListingResponse>;
469
+ getApplicationBrands({ department, pageNo, pageSize, q, brandId, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationBrandsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BrandListingResponseSchema>;
697
470
  /**
698
471
  * @param {Object} arg - Arg object.
699
- * @param {number} arg.companyId - A `company_id` is a unique identifier for
472
+ * @param {string} arg.companyId - A `company_id` is a unique identifier for
700
473
  * a particular seller account.
701
474
  * @param {string} arg.applicationId - A `application_id` is a unique
702
475
  * identifier for a particular sale channel.
703
476
  * @param {string} [arg.department] - The name of the department. Use this
704
477
  * parameter to filter products by a particular department. See below the
705
478
  * list of available departments. You can retrieve available departments
706
- * from the **v1.0/departments/** API
479
+ * from the "v1.0/departments/" API
707
480
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
708
481
  * page. Default is 12.
709
- * @param {string} [arg.q] - Search query with brand name.Use this parameter
710
- * to search brands by brand name.
482
+ * @param {string} [arg.q] - Search query with brand name. Use this
483
+ * parameter to search brands by brand name.
711
484
  * @param {number[]} [arg.brandId] - Helps to sort the brands list on the
712
485
  * basis of uid list.
713
- * @returns {Paginator<CatalogPlatformModel.BrandListingResponse>}
714
- * @summary: Get application brands.
715
- * @description: List all the brands. A brand is the name under which a product is being sold.
486
+ * @returns {Paginator<CatalogPlatformModel.BrandListingResponseSchema>}
487
+ * @summary: List brands
488
+ * @description: List all the brands.
716
489
  */
717
490
  getApplicationBrandsPaginator({ companyId, applicationId, department, pageSize, q, brandId, }?: {
718
- companyId: number;
491
+ companyId: string;
719
492
  applicationId: string;
720
493
  department?: string;
721
494
  pageSize?: number;
722
495
  q?: string;
723
496
  brandId?: number[];
724
- }): Paginator<CatalogPlatformModel.BrandListingResponse>;
497
+ }): Paginator<CatalogPlatformModel.BrandListingResponseSchema>;
725
498
  /**
726
499
  * @param {CatalogPlatformApplicationValidator.GetApplicationCategoryListingParam} arg
727
500
  * - Arg object
@@ -732,13 +505,13 @@ declare class Catalog {
732
505
  * - Success response
733
506
  *
734
507
  * @name getApplicationCategoryListing
735
- * @summary: Get application category listing.
736
- * @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/).
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/).
737
510
  */
738
511
  getApplicationCategoryListing({ departmentId, pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationCategoryListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ApplicationCategoryListingSchema>;
739
512
  /**
740
513
  * @param {Object} arg - Arg object.
741
- * @param {number} arg.companyId - A `company_id` is a unique identifier for
514
+ * @param {string} arg.companyId - A `company_id` is a unique identifier for
742
515
  * a particular seller account.
743
516
  * @param {string} arg.applicationId - A `application_id` is a unique
744
517
  * identifier for a particular sale channel.
@@ -746,14 +519,14 @@ declare class Catalog {
746
519
  * identifier for a particular department.
747
520
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
748
521
  * page. Default is 12.
749
- * @param {string} [arg.q] - Search query with brand name.Use this parameter
750
- * to search brands by brand name.
522
+ * @param {string} [arg.q] - A search query string. Use this parameter to
523
+ * filter results based on a keyword or specific value.
751
524
  * @returns {Paginator<CatalogPlatformModel.ApplicationCategoryListingSchema>}
752
- * @summary: Get application category listing.
753
- * @description: Retrieve category listings related to the application. A brand is the name under which a product is being sold.
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.
754
527
  */
755
528
  getApplicationCategoryListingPaginator({ companyId, applicationId, departmentId, pageSize, q, }?: {
756
- companyId: number;
529
+ companyId: string;
757
530
  applicationId: string;
758
531
  departmentId?: number;
759
532
  pageSize?: number;
@@ -765,14 +538,14 @@ declare class Catalog {
765
538
  *
766
539
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
767
540
  * @param {import("../PlatformAPIClient").Options} - Options
768
- * @returns {Promise<CatalogPlatformModel.ApplicationDepartmentListingResponse>}
541
+ * @returns {Promise<CatalogPlatformModel.ApplicationDepartmentListingResponseSchema>}
769
542
  * - Success response
770
543
  *
771
544
  * @name getApplicationDepartmentListing
772
- * @summary: Get application department listing.
773
- * @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/).
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/).
774
547
  */
775
- getApplicationDepartmentListing({ pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationDepartmentListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ApplicationDepartmentListingResponse>;
548
+ getApplicationDepartmentListing({ pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationDepartmentListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ApplicationDepartmentListingResponseSchema>;
776
549
  /**
777
550
  * @param {Object} arg - Arg object.
778
551
  * @param {number} arg.companyId - A `company_id` is a unique identifier for
@@ -781,58 +554,61 @@ declare class Catalog {
781
554
  * identifier for a particular sale channel.
782
555
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
783
556
  * page. Default is 12.
784
- * @param {string} [arg.q] - Search query with brand name.Use this parameter
785
- * to search department by name.
786
- * @returns {Paginator<CatalogPlatformModel.ApplicationDepartmentListingResponse>}
787
- * @summary: Get application department listing.
788
- * @description: Retrieve department listings related to the application. Departments are a way to categorise similar products. A product can lie in multiple departments.
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
789
562
  */
790
563
  getApplicationDepartmentListingPaginator({ companyId, applicationId, pageSize, q, }?: {
791
564
  companyId: number;
792
565
  applicationId: string;
793
566
  pageSize?: number;
794
567
  q?: string;
795
- }): Paginator<CatalogPlatformModel.ApplicationDepartmentListingResponse>;
568
+ }): Paginator<CatalogPlatformModel.ApplicationDepartmentListingResponseSchema>;
796
569
  /**
797
570
  * @param {CatalogPlatformApplicationValidator.GetApplicationFilterKeysParam} arg
798
571
  * - Arg object
799
572
  *
800
573
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
801
574
  * @param {import("../PlatformAPIClient").Options} - Options
802
- * @returns {Promise<CatalogPlatformModel.GetQueryFiltersKeysResponse>} -
803
- * Success response
575
+ * @returns {Promise<CatalogPlatformModel.GetQueryFiltersKeysResponseSchema>}
576
+ * - Success response
577
+ *
804
578
  * @name getApplicationFilterKeys
805
- * @summary: Get filters keys of the filter options.
806
- * @description: Get query filters keys to configure a collection - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/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/).
807
581
  */
808
- getApplicationFilterKeys({ c, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationFilterKeysParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetQueryFiltersKeysResponse>;
582
+ getApplicationFilterKeys({ c, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationFilterKeysParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetQueryFiltersKeysResponseSchema>;
809
583
  /**
810
584
  * @param {CatalogPlatformApplicationValidator.GetApplicationFilterValuesParam} arg
811
585
  * - Arg object
812
586
  *
813
587
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
814
588
  * @param {import("../PlatformAPIClient").Options} - Options
815
- * @returns {Promise<CatalogPlatformModel.GetQueryFiltersValuesResponse>} -
816
- * Success response
589
+ * @returns {Promise<CatalogPlatformModel.GetQueryFiltersValuesResponseSchema>}
590
+ * - Success response
591
+ *
817
592
  * @name getApplicationFilterValues
818
- * @summary: Get values of the selected value for the filter options.
819
- * @description: Get query filters keys to configure a collection - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/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/).
820
596
  */
821
- getApplicationFilterValues({ filterKey, c, collectionId, pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationFilterValuesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetQueryFiltersValuesResponse>;
597
+ getApplicationFilterValues({ filterKey, c, collectionId, pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationFilterValuesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetQueryFiltersValuesResponseSchema>;
822
598
  /**
823
599
  * @param {CatalogPlatformApplicationValidator.GetApplicationProductsParam} arg
824
600
  * - Arg object
825
601
  *
826
602
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
827
603
  * @param {import("../PlatformAPIClient").Options} - Options
828
- * @returns {Promise<CatalogPlatformModel.ApplicationProductListingResponse>}
604
+ * @returns {Promise<CatalogPlatformModel.ApplicationProductListingResponseSchema>}
829
605
  * - Success response
830
606
  *
831
607
  * @name getApplicationProducts
832
- * @summary: Get application products.
833
- * @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/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/).
834
610
  */
835
- getApplicationProducts({ q, f, c, filters, isDependent, sortOn, pageId, pageSize, pageNo, pageType, itemIds, requestHeaders, }?: CatalogPlatformApplicationValidator.GetApplicationProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ApplicationProductListingResponse>;
611
+ getApplicationProducts({ q, f, c, filters, isDependent, sortOn, pageId, pageSize, pageNo, pageType, itemIds, requestHeaders, }?: CatalogPlatformApplicationValidator.GetApplicationProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ApplicationProductListingResponseSchema>;
836
612
  /**
837
613
  * @param {Object} arg - Arg object.
838
614
  * @param {number} arg.companyId - A `company_id` is a unique identifier for
@@ -859,9 +635,9 @@ declare class Catalog {
859
635
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
860
636
  * page. Default is 12.
861
637
  * @param {string[]} [arg.itemIds] - Item Ids of product
862
- * @returns {Paginator<CatalogPlatformModel.ApplicationProductListingResponse>}
863
- * @summary: Get application products.
864
- * @description: Retrieve products associated with the application. List all the products associated with a brand, collection or category in a requested sort order.
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.
865
641
  */
866
642
  getApplicationProductsPaginator({ companyId, applicationId, q, f, c, filters, isDependent, sortOn, pageSize, itemIds, }?: {
867
643
  companyId: number;
@@ -874,60 +650,35 @@ declare class Catalog {
874
650
  sortOn?: string;
875
651
  pageSize?: number;
876
652
  itemIds?: string[];
877
- }): Paginator<CatalogPlatformModel.ApplicationProductListingResponse>;
653
+ }): Paginator<CatalogPlatformModel.ApplicationProductListingResponseSchema>;
878
654
  /**
879
655
  * @param {CatalogPlatformApplicationValidator.GetAutocompleteConfigParam} arg
880
656
  * - Arg object
881
657
  *
882
658
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
883
659
  * @param {import("../PlatformAPIClient").Options} - Options
884
- * @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>} -
885
- * Success response
660
+ * @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponseSchema>}
661
+ * - Success response
662
+ *
886
663
  * @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/).
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/).
889
666
  */
890
- getAutocompleteConfig({ pageNo, pageSize, q, isActive, requestHeaders }?: CatalogPlatformApplicationValidator.GetAutocompleteConfigParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>;
667
+ getAutocompleteConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAutocompleteWordsResponseSchema>;
891
668
  /**
892
669
  * @param {CatalogPlatformApplicationValidator.GetAutocompleteKeywordDetailParam} arg
893
670
  * - Arg object
894
671
  *
895
672
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
896
673
  * @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/).
902
- */
903
- getAutocompleteKeywordDetail({ id, requestHeaders }?: CatalogPlatformApplicationValidator.GetAutocompleteKeywordDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAutocompleteWordsData>;
904
- /**
905
- * @param {CatalogPlatformApplicationValidator.GetAutocompletePreviewParam} arg
906
- * - Arg object
907
- *
908
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
909
- * @param {import("../PlatformAPIClient").Options} - Options
910
- * @returns {Promise<CatalogPlatformModel.AutocompletePreviewResponseSchema>}
674
+ * @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponseSchema>}
911
675
  * - Success response
912
676
  *
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/).
916
- */
917
- getAutocompletePreview({ q, categorySuggestion, brandSuggestion, collectionSuggestion, productSuggestion, querySuggestion, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAutocompletePreviewParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AutocompletePreviewResponseSchema>;
918
- /**
919
- * @param {CatalogPlatformApplicationValidator.GetAutocompleteSettingsParam} arg
920
- * - Arg object
921
- *
922
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
923
- * @param {import("../PlatformAPIClient").Options} - Options
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/).
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/).
929
680
  */
930
- getAutocompleteSettings({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.AutocompleteResponseSchema>;
681
+ getAutocompleteKeywordDetail({ id, requestHeaders }?: CatalogPlatformApplicationValidator.GetAutocompleteKeywordDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAutocompleteWordsResponseSchema>;
931
682
  /**
932
683
  * @param {CatalogPlatformApplicationValidator.GetCatalogConfigurationParam} arg
933
684
  * - Arg object
@@ -938,8 +689,8 @@ declare class Catalog {
938
689
  * - Success response
939
690
  *
940
691
  * @name 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/).
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/).
943
694
  */
944
695
  getCatalogConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCatalogConfigurationMetaData>;
945
696
  /**
@@ -948,35 +699,38 @@ declare class Catalog {
948
699
  *
949
700
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
950
701
  * @param {import("../PlatformAPIClient").Options} - Options
951
- * @returns {Promise<CatalogPlatformModel.CatalogInsightResponse>} - Success response
702
+ * @returns {Promise<CatalogPlatformModel.CatalogInsightResponseSchema>} -
703
+ * Success response
952
704
  * @name 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/).
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/).
955
707
  */
956
- getCatalogInsights({ brand, requestHeaders }?: CatalogPlatformApplicationValidator.GetCatalogInsightsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CatalogInsightResponse>;
708
+ getCatalogInsights({ brand, requestHeaders }?: CatalogPlatformApplicationValidator.GetCatalogInsightsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CatalogInsightResponseSchema>;
957
709
  /**
958
710
  * @param {CatalogPlatformApplicationValidator.GetCategoriesParam} arg - Arg object
959
711
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
960
712
  * @param {import("../PlatformAPIClient").Options} - Options
961
- * @returns {Promise<CatalogPlatformModel.CategoryListingResponse>} - Success response
713
+ * @returns {Promise<CatalogPlatformModel.CategoryListingResponseSchema>} -
714
+ * Success response
962
715
  * @name 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/).
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/).
965
718
  */
966
- getCategories({ department, requestHeaders }?: CatalogPlatformApplicationValidator.GetCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryListingResponse>;
719
+ getCategories({ department, requestHeaders }?: CatalogPlatformApplicationValidator.GetCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryListingResponseSchema>;
967
720
  /**
968
721
  * @param {CatalogPlatformApplicationValidator.GetCollectionDetailParam} arg
969
722
  * - Arg object
970
723
  *
971
724
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
972
725
  * @param {import("../PlatformAPIClient").Options} - Options
973
- * @returns {Promise<CatalogPlatformModel.GetCollectionDetailResponse>} -
974
- * Success response
726
+ * @returns {Promise<CatalogPlatformModel.GetCollectionDetailResponseSchema>}
727
+ * - Success response
728
+ *
975
729
  * @name getCollectionDetail
976
- * @summary: Get collection details.
730
+ * @summary: Get a collection
977
731
  * @description: Get the details of a collection by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCollectionDetail/).
978
732
  */
979
- getCollectionDetail({ slug, requestHeaders }?: CatalogPlatformApplicationValidator.GetCollectionDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCollectionDetailResponse>;
733
+ getCollectionDetail({ slug, requestHeaders }?: CatalogPlatformApplicationValidator.GetCollectionDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCollectionDetailResponseSchema>;
980
734
  /**
981
735
  * @param {CatalogPlatformApplicationValidator.GetCollectionItemsParam} arg
982
736
  * - Arg object
@@ -987,10 +741,10 @@ declare class Catalog {
987
741
  * - Success response
988
742
  *
989
743
  * @name 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/).
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/).
992
746
  */
993
- getCollectionItems({ id, sortOn, pageSize, pageNo, isPinned, q, isExcluded, requestHeaders, }?: CatalogPlatformApplicationValidator.GetCollectionItemsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCollectionItemsResponseSchema>;
747
+ getCollectionItems({ id, sortOn, pageId, pageSize, pageNo, requestHeaders }?: CatalogPlatformApplicationValidator.GetCollectionItemsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCollectionItemsResponseSchema>;
994
748
  /**
995
749
  * @param {CatalogPlatformApplicationValidator.GetConfigurationByTypeParam} arg
996
750
  * - Arg object
@@ -1001,8 +755,8 @@ declare class Catalog {
1001
755
  * - Success response
1002
756
  *
1003
757
  * @name 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/).
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/).
1006
760
  */
1007
761
  getConfigurationByType({ type, requestHeaders }?: CatalogPlatformApplicationValidator.GetConfigurationByTypeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAppCatalogEntityConfiguration>;
1008
762
  /**
@@ -1011,13 +765,14 @@ declare class Catalog {
1011
765
  *
1012
766
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1013
767
  * @param {import("../PlatformAPIClient").Options} - Options
1014
- * @returns {Promise<CatalogPlatformModel.GetConfigMetadataResponse>} -
1015
- * Success response
768
+ * @returns {Promise<CatalogPlatformModel.GetConfigMetadataResponseSchema>}
769
+ * - Success response
770
+ *
1016
771
  * @name 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/).
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/).
1019
774
  */
1020
- getConfigurationMetadata({ configType, templateSlug, requestHeaders }?: CatalogPlatformApplicationValidator.GetConfigurationMetadataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetConfigMetadataResponse>;
775
+ getConfigurationMetadata({ configType, templateSlug, pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetConfigurationMetadataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetConfigMetadataResponseSchema>;
1021
776
  /**
1022
777
  * @param {CatalogPlatformApplicationValidator.GetConfigurationsParam} arg
1023
778
  * - Arg object
@@ -1027,157 +782,84 @@ declare class Catalog {
1027
782
  * @returns {Promise<CatalogPlatformModel.GetAppCatalogConfiguration>} -
1028
783
  * Success response
1029
784
  * @name 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/).
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/).
1032
787
  */
1033
788
  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>;
1046
789
  /**
1047
790
  * @param {CatalogPlatformApplicationValidator.GetDepartmentsParam} arg - Arg object
1048
791
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1049
792
  * @param {import("../PlatformAPIClient").Options} - Options
1050
- * @returns {Promise<CatalogPlatformModel.DepartmentResponse>} - Success response
793
+ * @returns {Promise<CatalogPlatformModel.DepartmentResponseSchema>} -
794
+ * Success response
1051
795
  * @name 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/).
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/).
1054
798
  */
1055
- getDepartments({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentResponse>;
799
+ getDepartments({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentResponseSchema>;
1056
800
  /**
1057
801
  * @param {CatalogPlatformApplicationValidator.GetDiscountedInventoryBySizeIdentifierParam} arg
1058
802
  * - Arg object
1059
803
  *
1060
804
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1061
805
  * @param {import("../PlatformAPIClient").Options} - Options
1062
- * @returns {Promise<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>}
806
+ * @returns {Promise<CatalogPlatformModel.ApplicationInventorySellerIdentifierResponsePaginated>}
1063
807
  * - Success response
1064
808
  *
1065
809
  * @name getDiscountedInventoryBySizeIdentifier
1066
- * @summary: Get discounted inventory by size identifier.
810
+ * @summary: Get discounted inventory
1067
811
  * @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/).
1068
812
  */
1069
- getDiscountedInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize, locationIds, requestHeaders, }?: CatalogPlatformApplicationValidator.GetDiscountedInventoryBySizeIdentifierParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>;
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>;
1070
839
  /**
1071
840
  * @param {CatalogPlatformApplicationValidator.GetGroupConfigurationsParam} arg
1072
841
  * - Arg object
1073
842
  *
1074
843
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1075
844
  * @param {import("../PlatformAPIClient").Options} - Options
1076
- * @returns {Promise<CatalogPlatformModel.GetConfigResponse>} - Success response
845
+ * @returns {Promise<CatalogPlatformModel.GetConfigResponseSchema>} - Success response
1077
846
  * @name 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/).
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/).
1080
849
  */
1081
- getGroupConfigurations({ configType, pageNo, pageSize, search, templateSlug, requestHeaders }?: CatalogPlatformApplicationValidator.GetGroupConfigurationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetConfigResponse>;
850
+ getGroupConfigurations({ configType, pageNo, pageSize, search, templateSlug, requestHeaders }?: CatalogPlatformApplicationValidator.GetGroupConfigurationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetConfigResponseSchema>;
1082
851
  /**
1083
852
  * @param {CatalogPlatformApplicationValidator.GetListingConfigurationsParam} arg
1084
853
  * - Arg object
1085
854
  *
1086
855
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1087
856
  * @param {import("../PlatformAPIClient").Options} - Options
1088
- * @returns {Promise<CatalogPlatformModel.GetListingConfigResponse>} -
1089
- * Success response
857
+ * @returns {Promise<CatalogPlatformModel.GetConfigResponseSchema>} - Success response
1090
858
  * @name 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/).
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/).
1093
861
  */
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/).
1103
- */
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>;
862
+ getListingConfigurations({ configType, pageNo, pageSize, search, requestHeaders }?: CatalogPlatformApplicationValidator.GetListingConfigurationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetConfigResponseSchema>;
1181
863
  /**
1182
864
  * @param {CatalogPlatformApplicationValidator.GetProductDetailBySlugParam} arg
1183
865
  * - Arg object
@@ -1186,305 +868,156 @@ declare class Catalog {
1186
868
  * @param {import("../PlatformAPIClient").Options} - Options
1187
869
  * @returns {Promise<CatalogPlatformModel.ProductDetail>} - Success response
1188
870
  * @name 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/).
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/).
1191
873
  */
1192
874
  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>;
1207
875
  /**
1208
876
  * @param {CatalogPlatformApplicationValidator.GetQueryFiltersParam} arg - Arg object
1209
877
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1210
878
  * @param {import("../PlatformAPIClient").Options} - Options
1211
- * @returns {Promise<CatalogPlatformModel.GetQueryFiltersResponse>} - Success response
879
+ * @returns {Promise<CatalogPlatformModel.GetQueryFiltersResponseSchema>} -
880
+ * Success response
1212
881
  * @name 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/).
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/).
1215
884
  */
1216
- getQueryFilters({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetQueryFiltersResponse>;
885
+ getQueryFilters({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetQueryFiltersResponseSchema>;
1217
886
  /**
1218
887
  * @param {CatalogPlatformApplicationValidator.GetSearchConfigurationParam} arg
1219
888
  * - Arg object
1220
889
  *
1221
890
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1222
891
  * @param {import("../PlatformAPIClient").Options} - Options
1223
- * @returns {Promise<CatalogPlatformModel.GetSearchConfigurationResponse>}
892
+ * @returns {Promise<CatalogPlatformModel.GetSearchConfigurationResponseSchema>}
1224
893
  * - Success response
1225
894
  *
1226
895
  * @name 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/).
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/).
1229
898
  */
1230
- getSearchConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchConfigurationResponse>;
899
+ getSearchConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchConfigurationResponseSchema>;
1231
900
  /**
1232
901
  * @param {CatalogPlatformApplicationValidator.GetSearchKeywordsParam} arg
1233
902
  * - Arg object
1234
903
  *
1235
904
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1236
905
  * @param {import("../PlatformAPIClient").Options} - Options
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>}
1295
- * - Success response
1296
- *
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/).
1300
- */
1301
- pollPriceFactoryJobs({ id, startDate, endDate, stage, isActive, q, type, requestHeaders }?: CatalogPlatformApplicationValidator.PollPriceFactoryJobsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateAppPriceFactoryProductExportJobPollResponse>;
1302
- /**
1303
- * @param {CatalogPlatformApplicationValidator.PollProductPriceFactoryBulkJobParam} arg
1304
- * - Arg object
1305
- *
1306
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1307
- * @param {import("../PlatformAPIClient").Options} - Options
1308
- * @returns {Promise<CatalogPlatformModel.CreateAppPriceFactoryProductBulkJobPollResponse>}
906
+ * @returns {Promise<CatalogPlatformModel.GetSearchWordsDetailResponseSchema>}
1309
907
  * - Success response
1310
908
  *
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>} -
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/).
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/).
1367
912
  */
1368
- saveMerchandisingRules({ merchandisingRuleId, body, requestHeaders }?: CatalogPlatformApplicationValidator.SaveMerchandisingRulesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseMerchandising>;
913
+ getSearchKeywords({ id, requestHeaders }?: CatalogPlatformApplicationValidator.GetSearchKeywordsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchWordsDetailResponseSchema>;
1369
914
  /**
1370
915
  * @param {CatalogPlatformApplicationValidator.UpdateAllowSingleParam} arg
1371
916
  * - Arg object
1372
917
  *
1373
918
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1374
919
  * @param {import("../PlatformAPIClient").Options} - Options
1375
- * @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
920
+ * @returns {Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>} -
921
+ * Success response
1376
922
  * @name 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/).
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/).
1379
925
  */
1380
- updateAllowSingle({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAllowSingleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponse>;
926
+ updateAllowSingle({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAllowSingleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>;
1381
927
  /**
1382
928
  * @param {CatalogPlatformApplicationValidator.UpdateAppBrandParam} arg - Arg object
1383
929
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1384
930
  * @param {import("../PlatformAPIClient").Options} - Options
1385
- * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
931
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
1386
932
  * @name 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/).
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/).
1389
935
  */
1390
- updateAppBrand({ brandUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppBrandParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
936
+ updateAppBrand({ brandUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppBrandParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
1391
937
  /**
1392
938
  * @param {CatalogPlatformApplicationValidator.UpdateAppCategoryParam} arg
1393
939
  * - Arg object
1394
940
  *
1395
941
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1396
942
  * @param {import("../PlatformAPIClient").Options} - Options
1397
- * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
943
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
1398
944
  * @name 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/).
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/).
1401
947
  */
1402
- updateAppCategory({ categoryUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppCategoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
948
+ updateAppCategory({ categoryUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppCategoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
1403
949
  /**
1404
950
  * @param {CatalogPlatformApplicationValidator.UpdateAppCategoryReturnConfigurationParam} arg
1405
951
  * - Arg object
1406
952
  *
1407
953
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1408
954
  * @param {import("../PlatformAPIClient").Options} - Options
1409
- * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
955
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
1410
956
  * @name 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/).
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/).
1413
959
  */
1414
- updateAppCategoryReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppCategoryReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
960
+ updateAppCategoryReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppCategoryReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
1415
961
  /**
1416
962
  * @param {CatalogPlatformApplicationValidator.UpdateAppDepartmentParam} arg
1417
963
  * - Arg object
1418
964
  *
1419
965
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1420
966
  * @param {import("../PlatformAPIClient").Options} - Options
1421
- * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
967
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
1422
968
  * @name 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/).
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/).
1425
971
  */
1426
- updateAppDepartment({ departmentUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppDepartmentParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
972
+ updateAppDepartment({ departmentUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppDepartmentParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
1427
973
  /**
1428
974
  * @param {CatalogPlatformApplicationValidator.UpdateAppLocationParam} arg
1429
975
  * - Arg object
1430
976
  *
1431
977
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1432
978
  * @param {import("../PlatformAPIClient").Options} - Options
1433
- * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
979
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
1434
980
  * @name 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/).
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/).
1437
983
  */
1438
- updateAppLocation({ storeUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppLocationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
984
+ updateAppLocation({ storeUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppLocationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
1439
985
  /**
1440
986
  * @param {CatalogPlatformApplicationValidator.UpdateAppProductParam} arg - Arg object
1441
987
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1442
988
  * @param {import("../PlatformAPIClient").Options} - Options
1443
- * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
989
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
1444
990
  * @name 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/).
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/).
1447
993
  */
1448
- updateAppProduct({ itemId, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
994
+ updateAppProduct({ itemId, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
1449
995
  /**
1450
996
  * @param {CatalogPlatformApplicationValidator.UpdateAppReturnConfigurationParam} arg
1451
997
  * - Arg object
1452
998
  *
1453
999
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1454
1000
  * @param {import("../PlatformAPIClient").Options} - Options
1455
- * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
1001
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
1456
1002
  * @name 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/).
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/).
1459
1005
  */
1460
- updateAppReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
1006
+ updateAppReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
1461
1007
  /**
1462
1008
  * @param {CatalogPlatformApplicationValidator.UpdateAutocompleteKeywordParam} arg
1463
1009
  * - Arg object
1464
1010
  *
1465
1011
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1466
1012
  * @param {import("../PlatformAPIClient").Options} - Options
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>}
1013
+ * @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponseSchema>}
1481
1014
  * - Success response
1482
1015
  *
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/).
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/).
1486
1019
  */
1487
- updateAutocompleteSettings({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAutocompleteSettingsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AutocompleteUpsertResponseSchema>;
1020
+ updateAutocompleteKeyword({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAutocompleteKeywordParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAutocompleteWordsResponseSchema>;
1488
1021
  /**
1489
1022
  * @param {CatalogPlatformApplicationValidator.UpdateCollectionParam} arg - Arg object
1490
1023
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -1501,12 +1034,13 @@ declare class Catalog {
1501
1034
  *
1502
1035
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1503
1036
  * @param {import("../PlatformAPIClient").Options} - Options
1504
- * @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
1037
+ * @returns {Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>} -
1038
+ * Success response
1505
1039
  * @name 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/).
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/).
1508
1042
  */
1509
- updateDefaultSort({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateDefaultSortParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponse>;
1043
+ updateDefaultSort({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateDefaultSortParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponseSchema>;
1510
1044
  /**
1511
1045
  * @param {CatalogPlatformApplicationValidator.UpdateGroupConfigurationParam} arg
1512
1046
  * - Arg object
@@ -1515,8 +1049,8 @@ declare class Catalog {
1515
1049
  * @param {import("../PlatformAPIClient").Options} - Options
1516
1050
  * @returns {Promise<CatalogPlatformModel.AppConfigurationDetail>} - Success response
1517
1051
  * @name 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/).
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/).
1520
1054
  */
1521
1055
  updateGroupConfiguration({ configType, groupSlug, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateGroupConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppConfigurationDetail>;
1522
1056
  /**
@@ -1525,93 +1059,26 @@ declare class Catalog {
1525
1059
  *
1526
1060
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1527
1061
  * @param {import("../PlatformAPIClient").Options} - Options
1528
- * @returns {Promise<CatalogPlatformModel.AppConfigurationsFilterResponse>}
1529
- * - Success response
1530
- *
1062
+ * @returns {Promise<CatalogPlatformModel.AppConfigurationsSort>} - Success response
1531
1063
  * @name 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/).
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/).
1547
1066
  */
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/).
1560
- */
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>;
1067
+ updateListingConfiguration({ configType, configId, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateListingConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppConfigurationsSort>;
1601
1068
  /**
1602
1069
  * @param {CatalogPlatformApplicationValidator.UpdateSearchConfigurationParam} arg
1603
1070
  * - Arg object
1604
1071
  *
1605
1072
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1606
1073
  * @param {import("../PlatformAPIClient").Options} - Options
1607
- * @returns {Promise<CatalogPlatformModel.UpdateSearchConfigurationResponse>}
1074
+ * @returns {Promise<CatalogPlatformModel.UpdateSearchConfigurationResponseSchema>}
1608
1075
  * - Success response
1609
1076
  *
1610
1077
  * @name 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/).
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/).
1613
1080
  */
1614
- updateSearchConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateSearchConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.UpdateSearchConfigurationResponse>;
1081
+ updateSearchConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateSearchConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.UpdateSearchConfigurationResponseSchema>;
1615
1082
  /**
1616
1083
  * @param {CatalogPlatformApplicationValidator.UpdateSearchKeywordsParam} arg
1617
1084
  * - Arg object
@@ -1620,73 +1087,10 @@ declare class Catalog {
1620
1087
  * @param {import("../PlatformAPIClient").Options} - Options
1621
1088
  * @returns {Promise<CatalogPlatformModel.GetSearchWordsData>} - Success response
1622
1089
  * @name 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/).
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/).
1625
1092
  */
1626
1093
  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>;
1690
1094
  }
1691
1095
  import CatalogPlatformApplicationValidator = require("./CatalogPlatformApplicationValidator");
1692
1096
  import CatalogPlatformModel = require("./CatalogPlatformModel");