@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
@@ -4,33 +4,26 @@ export = CatalogPlatformApplicationValidator;
4
4
  * @property {string} id - A `id` is a unique identifier of a collection.
5
5
  * @property {CatalogPlatformModel.CollectionItemUpdateSchema} body
6
6
  */
7
- /**
8
- * @typedef AddProductsInPriceFactoryByZoneIdParam
9
- * @property {string} id - An `id` is a unique identifier for a particular price factory.
10
- * @property {CatalogPlatformModel.CreatePriceFactoryProductRequest} body
11
- */
12
- /**
13
- * @typedef ClearCollectionItemsPriorityParam
14
- * @property {string} id - A `id` is a unique identifier of a collection.
15
- */
16
7
  /**
17
8
  * @typedef CreateAppCategoryReturnConfigurationParam
18
9
  * @property {CatalogPlatformModel.BaseAppCategoryReturnConfig} body
19
10
  */
20
- /**
21
- * @typedef CreateAppPriceFactoryParam
22
- * @property {CatalogPlatformModel.CreateAppPriceFactoryRequestSchema} body
23
- */
24
11
  /**
25
12
  * @typedef CreateAppReturnConfigurationParam
26
13
  * @property {CatalogPlatformModel.CreateUpdateAppReturnConfig} body
27
14
  */
28
- /**
29
- * @typedef CreateAutocompleteSettingsParam
30
- * @property {CatalogPlatformModel.AutocompleteRequestSchema} body
31
- */
32
15
  /**
33
16
  * @typedef CreateCollectionParam
17
+ * @property {string} [q] - Get collection list filtered by q string,
18
+ * @property {string} [scheduleStatus] - Get collection list filtered by scheduled status,
19
+ * @property {string} [type] - Type of the collections
20
+ * @property {string[]} [tags] - Each response will contain next_id param, which
21
+ * should be sent back to make pagination work.
22
+ * @property {boolean} [isActive] - Get collections filtered by active status.
23
+ * @property {number} [pageNo] - The page number to navigate through the given
24
+ * set of results.
25
+ * @property {number} [pageSize] - Number of items to retrieve in each page.
26
+ * Default is 12.
34
27
  * @property {CatalogPlatformModel.CreateCollection} body
35
28
  */
36
29
  /**
@@ -54,58 +47,17 @@ export = CatalogPlatformApplicationValidator;
54
47
  * @typedef CreateGroupConfigurationParam
55
48
  * @property {string} configType - A `config_type` is a unique identifier for a
56
49
  * particular group configuration type.
57
- * @property {CatalogPlatformModel.AppConfigurationCreateDetail} body
50
+ * @property {CatalogPlatformModel.AppConfigurationDetail} body
58
51
  */
59
52
  /**
60
53
  * @typedef CreateListingConfigurationParam
61
54
  * @property {string} configType - A `config_type` is a unique identifier for a
62
55
  * particular listing configuration type.
63
- * @property {CatalogPlatformModel.AppConfigurationsFilter} body
64
- */
65
- /**
66
- * @typedef CreateMerchandisingRuleBoostActionParam
67
- * @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
68
- * unique identifier for a particular merchandising rule.
69
- * @property {CatalogPlatformModel.PostMerchandisingRuleBoostAction} body
70
- */
71
- /**
72
- * @typedef CreateMerchandisingRuleBuryActionParam
73
- * @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
74
- * unique identifier for a particular merchandising rule.
75
- * @property {CatalogPlatformModel.PostMerchandisingRuleBoostAction} body
76
- */
77
- /**
78
- * @typedef CreateMerchandisingRuleHideActionParam
79
- * @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
80
- * unique identifier for a particular merchandising rule.
81
- * @property {CatalogPlatformModel.HideRequest} body
82
- */
83
- /**
84
- * @typedef CreateMerchandisingRulePinActionParam
85
- * @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
86
- * unique identifier for a particular merchandising rule.
87
- * @property {CatalogPlatformModel.PinRequest} body
88
- */
89
- /**
90
- * @typedef CreateMerchandisingRuleQueryParam
91
- * @property {CatalogPlatformModel.MerchandisingRuleQueryPost} body
92
- */
93
- /**
94
- * @typedef CreateProductPriceFactoryBulkJobParam
95
- * @property {string} id - An `id` is a unique identifier for a particular price factory.
96
- * @property {CatalogPlatformModel.CreateAppPriceFactoryProductBulkJobRequest} body
56
+ * @property {CatalogPlatformModel.AppConfigurationsSort} body
97
57
  */
98
58
  /**
99
59
  * @typedef CreateSearchConfigurationParam
100
- * @property {CatalogPlatformModel.CreateSearchConfigurationRequest} body
101
- */
102
- /**
103
- * @typedef CreateSearchRerankParam
104
- * @property {CatalogPlatformModel.CreateSearchRerankRequest} body
105
- */
106
- /**
107
- * @typedef CreateSynonymsParam
108
- * @property {CatalogPlatformModel.SynonymCreateRequestSchema} body
60
+ * @property {CatalogPlatformModel.CreateSearchConfigurationRequestSchema} body
109
61
  */
110
62
  /**
111
63
  * @typedef DeleteAppCategoryReturnConfigurationParam
@@ -134,49 +86,18 @@ export = CatalogPlatformApplicationValidator;
134
86
  * @property {string} configId - A `config_id` is a unique identifier of a
135
87
  * particular configuration.
136
88
  */
137
- /**
138
- * @typedef DeleteMerchandisingRuleParam
139
- * @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
140
- * unique identifier for a particular merchandising rule.
141
- */
142
- /**
143
- * @typedef DeleteMerchandisingRulesPreviewParam
144
- * @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
145
- * unique identifier for a particular merchandising rule.
146
- */
147
89
  /** @typedef DeleteSearchConfigurationParam */
148
90
  /**
149
91
  * @typedef DeleteSearchKeywordsParam
150
92
  * @property {string} id - A `id` is a unique identifier for a particular
151
93
  * detail. Pass the `id` of the keywords which you want to delete.
152
94
  */
153
- /**
154
- * @typedef DeleteSearchRerankConfigurationParam
155
- * @property {string} id - An `id` is the identifier for a particular search
156
- * rerank configuration. channel.
157
- */
158
- /**
159
- * @typedef DeleteSynonymParam
160
- * @property {string} id - A `id` is a unique identifier of a synonym that is to
161
- * be deleted.
162
- */
163
- /**
164
- * @typedef EditAppPriceFactoryParam
165
- * @property {string} id - An `id` is a unique identifier for a particular price factory.
166
- * @property {CatalogPlatformModel.EditAppPriceFactoryRequestSchema} body
167
- */
168
- /**
169
- * @typedef ExportProductsInPriceFactoryParam
170
- * @property {string} id - An `id` is a unique identifier for a particular price factory.
171
- * @property {CatalogPlatformModel.CreateAppPriceFactoryProductExportJobRequest} body
172
- */
173
- /** @typedef ExportSynonymsParam */
174
95
  /**
175
96
  * @typedef GetAllCollectionsParam
176
97
  * @property {string} [q] - Get collection list filtered by q string,
177
98
  * @property {string} [scheduleStatus] - Get collection list filtered by scheduled status,
178
99
  * @property {string} [type] - Type of the collections
179
- * @property {string[]} [tag] - Each response will contain next_id param, which
100
+ * @property {string[]} [tags] - Each response will contain next_id param, which
180
101
  * should be sent back to make pagination work.
181
102
  * @property {boolean} [isActive] - Get collections filtered by active status.
182
103
  * @property {number} [pageNo] - The page number to navigate through the given
@@ -184,17 +105,7 @@ export = CatalogPlatformApplicationValidator;
184
105
  * @property {number} [pageSize] - Number of items to retrieve in each page.
185
106
  * Default is 12.
186
107
  */
187
- /**
188
- * @typedef GetAllSearchKeywordParam
189
- * @property {number} [pageNo] - The page number to navigate through the given
190
- * set of results
191
- * @property {number} [pageSize] - Number of items to retrieve in each page.
192
- * Default is 12.
193
- * @property {string} [q] - Search query with words name.Use this parameter to
194
- * search keywords by words.
195
- * @property {boolean} [isActive] - Can query for keywords based on whether they
196
- * are active or inactive.
197
- */
108
+ /** @typedef GetAllSearchKeywordParam */
198
109
  /**
199
110
  * @typedef GetAppCategoryReturnConfigParam
200
111
  * @property {string} [q] - Get return configurations for categories by matching
@@ -239,49 +150,10 @@ export = CatalogPlatformApplicationValidator;
239
150
  * Default is 20.
240
151
  * @property {string[]} [tags] - Get locations filtered by tags.
241
152
  * @property {string[]} [storeTypes] - Get locations filtered by store types.
242
- * @property {number[]} [companyUids] - Filter stores by company IDs available
243
- * in the application.
244
- */
245
- /**
246
- * @typedef GetAppPriceByIdParam
247
- * @property {number} itemId - Unique identifier of the product
248
- * @property {number[]} [storeIds] - An array of unique identifiers representing
249
- * the store locations from which the product pricing should be fetched. If
250
- * not provided, pricing for all applicable store locations will be returned.
251
- * @property {string[]} [factoryTypeIds] - An array of unique factory type
252
- * identifiers that specify that pricing from which factory type should be
253
- * retrieved. This parameter allows filtering the price based on factory types.
254
- * @property {number} [sellerId] - The company uid for which we want to fetch
255
- * discounted pricing for a product
256
- */
257
- /**
258
- * @typedef GetAppPriceFactoriesParam
259
- * @property {boolean} [isActive] - Gets price factory filtered by active status.
260
- * @property {string} [factoryTypeId] - Gets price factory filtered by factory_type_id.
261
- * @property {string} [code] - Gets price factory filtered by pricezone code.
262
- * @property {number} [pageNo] - The page number to navigate through the given
263
- * set of results.
264
- * @property {number} [pageSize] - Number of items to retrieve in each page.
265
- * Default is 12.
266
- */
267
- /**
268
- * @typedef GetAppPriceFactoryParam
269
- * @property {string} id - An `id` is a unique identifier for a particular price factory.
270
153
  */
271
154
  /**
272
155
  * @typedef GetAppProductParam
273
- * @property {number} itemId - Product id for a particular product.
274
- */
275
- /**
276
- * @typedef GetAppProductPricesParam
277
- * @property {number[]} [itemIds] - List of item ids to get product prices
278
- * filtered by items.
279
- * @property {string[]} [factoryTypeIds] - List of factory type ids to get
280
- * product prices filtered by factory type id.
281
- * @property {number} [pageNo] - The page number to navigate through the given
282
- * set of results
283
- * @property {number} [pageSize] - Number of items to retrieve in each page.
284
- * Default is 10.
156
+ * @property {string} itemId - Product id for a particular product.
285
157
  */
286
158
  /**
287
159
  * @typedef GetAppProductsParam
@@ -303,7 +175,7 @@ export = CatalogPlatformApplicationValidator;
303
175
  * set of results
304
176
  * @property {number} [pageSize] - Number of items to retrieve in each page.
305
177
  * Default is 12.
306
- * @property {string} [q] - Search query with brand name.Use this parameter to
178
+ * @property {string} [q] - Search query with brand name. Use this parameter to
307
179
  * search brands by brand name.
308
180
  */
309
181
  /**
@@ -311,12 +183,12 @@ export = CatalogPlatformApplicationValidator;
311
183
  * @property {string} [department] - The name of the department. Use this
312
184
  * parameter to filter products by a particular department. See below the list
313
185
  * of available departments. You can retrieve available departments from the
314
- * **v1.0/departments/** API
186
+ * "v1.0/departments/" API
315
187
  * @property {number} [pageNo] - The page number to navigate through the given
316
188
  * set of results
317
189
  * @property {number} [pageSize] - Number of items to retrieve in each page.
318
190
  * Default is 12.
319
- * @property {string} [q] - Search query with brand name.Use this parameter to
191
+ * @property {string} [q] - Search query with brand name. Use this parameter to
320
192
  * search brands by brand name.
321
193
  * @property {number[]} [brandId] - Helps to sort the brands list on the basis
322
194
  * of uid list.
@@ -329,8 +201,8 @@ export = CatalogPlatformApplicationValidator;
329
201
  * set of results
330
202
  * @property {number} [pageSize] - Number of items to retrieve in each page.
331
203
  * Default is 12.
332
- * @property {string} [q] - Search query with brand name.Use this parameter to
333
- * search brands by brand name.
204
+ * @property {string} [q] - A search query string. Use this parameter to filter
205
+ * results based on a keyword or specific value.
334
206
  */
335
207
  /**
336
208
  * @typedef GetApplicationDepartmentListingParam
@@ -338,31 +210,32 @@ export = CatalogPlatformApplicationValidator;
338
210
  * set of results
339
211
  * @property {number} [pageSize] - Number of items to retrieve in each page.
340
212
  * Default is 12.
341
- * @property {string} [q] - Search query with brand name.Use this parameter to
342
- * search department by name.
213
+ * @property {string} [q] - A search query string. Use this parameter to filter
214
+ * results based on a keyword or specific value.
343
215
  */
344
216
  /**
345
217
  * @typedef GetApplicationFilterKeysParam
346
218
  * @property {string} [c] - The search filter parameters for collection items.
347
- * All the parameter filtered from filter parameters will be passed in **c**
348
- * parameter in this format.
349
- * **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
219
+ * All the parameter filtered from filter parameters will be passed in "c"
220
+ * parameter in this format. "?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts"
350
221
  */
351
222
  /**
352
223
  * @typedef GetApplicationFilterValuesParam
353
- * @property {string} filterKey - A `filter_key` is a filter key for a for which
354
- * all the available filter values will returned. channel.
224
+ * @property {string} filterKey - A `filter_key` is a filter key which returns
225
+ * all the available filter values.
355
226
  * @property {string} [c] - The search filter parameters for collection items.
356
- * All the parameter filtered from filter parameters will be passed in **c**
357
- * parameter in this format.
358
- * **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
227
+ * All the parameter filtered from filter parameters will be passed in "c"
228
+ * parameter in this format. "?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts"
359
229
  * @property {string} [collectionId] - A `collection_id` is a unique identifier
360
- * for a particular collection. channel.
230
+ * for a particular collection.
361
231
  * @property {number} [pageNo] - The page number to navigate through the given
362
232
  * set of results
363
233
  * @property {number} [pageSize] - Number of items to retrieve in each page.
364
234
  * Default is 10.
365
- * @property {string} [q] - Get Values filtered by q string
235
+ * @property {string} [q] - The `q` parameter allows you to search and filter
236
+ * specific data within the filter options. It acts as a query keyword that
237
+ * can refine the results by matching relevant filter values, such as a
238
+ * category name or any other applicable filter criteria.
366
239
  */
367
240
  /**
368
241
  * @typedef GetApplicationProductsParam
@@ -392,43 +265,23 @@ export = CatalogPlatformApplicationValidator;
392
265
  * number. Default is cursor.
393
266
  * @property {string[]} [itemIds] - Item Ids of product
394
267
  */
395
- /**
396
- * @typedef GetAutocompleteConfigParam
397
- * @property {number} [pageNo] - The page number to navigate through the given
398
- * set of results
399
- * @property {number} [pageSize] - Number of items to retrieve in each page.
400
- * Default is 12.
401
- * @property {string} [q] - Search query with words name.Use this parameter to
402
- * search keywords by words.
403
- * @property {boolean} [isActive] - Can query for keywords based on whether they
404
- * are active or inactive.
405
- */
268
+ /** @typedef GetAutocompleteConfigParam */
406
269
  /**
407
270
  * @typedef GetAutocompleteKeywordDetailParam
408
271
  * @property {string} id - A `id` is a unique identifier for a particular
409
272
  * detail. Pass the `id` of the keywords which you want to retrieve.
410
273
  */
411
- /**
412
- * @typedef GetAutocompletePreviewParam
413
- * @property {string} [q] - Get suggestions related to `q` string.
414
- * @property {number} [categorySuggestion] - For getting related category suggestions.
415
- * @property {number} [brandSuggestion] - For getting related brand suggestions.
416
- * @property {number} [collectionSuggestion] - For getting collection suggestions.
417
- * @property {number} [productSuggestion] - For getting product suggestions.
418
- * @property {number} [querySuggestion] - For getting query suggestions.
419
- */
420
- /** @typedef GetAutocompleteSettingsParam */
421
274
  /** @typedef GetCatalogConfigurationParam */
422
275
  /**
423
276
  * @typedef GetCatalogInsightsParam
424
- * @property {string} [brand] - Brand slug
277
+ * @property {string} [brand] - Brand slug that is to be searched.
425
278
  */
426
279
  /**
427
280
  * @typedef GetCategoriesParam
428
281
  * @property {string} [department] - The name of the department. Use this
429
282
  * parameter to filter products by a particular department. See below the list
430
283
  * of available departments. You can retrieve available departments from the
431
- * **v1.0/departments/** API
284
+ * "v1.0/departments/" API
432
285
  */
433
286
  /**
434
287
  * @typedef GetCollectionDetailParam
@@ -441,14 +294,11 @@ export = CatalogPlatformApplicationValidator;
441
294
  * @property {string} id - A `id` is a unique identifier of a collection.
442
295
  * @property {string} [sortOn] - Each response will contain sort_on param, which
443
296
  * should be sent back to make pagination work.
297
+ * @property {string} [pageId] - Each response will contain next_id param, which
298
+ * should be sent back to make pagination work.
444
299
  * @property {number} [pageSize] - Number of items to retrieve in each page.
445
300
  * Default is 12.
446
301
  * @property {number} [pageNo] - Identifies the specific page of results being requested.
447
- * @property {boolean} [isPinned] - Number of items that are pinned and have
448
- * priority in each page. Default is 12.
449
- * @property {string} [q] - Get multiple products filtered by q string
450
- * @property {boolean} [isExcluded] - Number of items that are excluded from
451
- * collections in each page. Default is 12.
452
302
  */
453
303
  /**
454
304
  * @typedef GetConfigurationByTypeParam
@@ -460,18 +310,18 @@ export = CatalogPlatformApplicationValidator;
460
310
  * a specific type of configuration.
461
311
  * @property {string} [templateSlug] - Get configuration list filtered by
462
312
  * `template_slug` string. This is for the details and comparision groups.
313
+ * @property {number} [pageNo] - The page number to navigate through the given
314
+ * set of results.
315
+ * @property {number} [pageSize] - Number of items to retrieve in each page.
316
+ * @property {string} [q] - Get configuration list filtered by `q` string.
463
317
  */
464
318
  /** @typedef GetConfigurationsParam */
465
- /**
466
- * @typedef GetConfigurationsFilterMetadataParam
467
- * @property {string} filter - Filter whose values needs to be fetched.
468
- */
469
319
  /** @typedef GetDepartmentsParam */
470
320
  /**
471
321
  * @typedef GetDiscountedInventoryBySizeIdentifierParam
472
- * @property {number} itemId - Item code of the product of which size is to be get.
322
+ * @property {number} itemId - A `item_id` is a unique identifier for a specific product.
473
323
  * @property {number} sizeIdentifier - Size Identifier (Seller Identifier or
474
- * Primary Identifier) of which inventory is to get.
324
+ * Primary Identifier).
475
325
  * @property {number} [pageNo] - The page number to navigate through the given
476
326
  * set of results
477
327
  * @property {number} [pageSize] - Number of items to retrieve in each page.
@@ -499,65 +349,12 @@ export = CatalogPlatformApplicationValidator;
499
349
  * @property {number} [pageSize] - Number of items to retrieve in each page.
500
350
  * Default is 12.
501
351
  * @property {string} [search] - Get configuration list filtered by `search` string.
502
- * @property {number[]} [uids] - Only for categories config type, Get
503
- * configuration list filtered by `uids`.
504
- */
505
- /**
506
- * @typedef GetLivePreviewParam
507
- * @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
508
- * unique identifier for a particular merchandising rule.
509
- * @property {string} [searchKeyword] - A sample query that can be used to get a
510
- * live preview of the merchandising rule.
511
- */
512
- /**
513
- * @typedef GetMerchandisingQueryParam
514
- * @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
515
- * unique identifier for a particular merchandising rule.
516
- */
517
- /**
518
- * @typedef GetMerchandisingRuleBoostActionParam
519
- * @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
520
- * unique identifier for a particular merchandising rule.
521
- */
522
- /**
523
- * @typedef GetMerchandisingRuleBuryActionParam
524
- * @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
525
- * unique identifier for a particular merchandising rule.
526
- */
527
- /**
528
- * @typedef GetMerchandisingRuleHideActionParam
529
- * @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
530
- * unique identifier for a particular merchandising rule.
531
- */
532
- /**
533
- * @typedef GetMerchandisingRulePinActionParam
534
- * @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
535
- * unique identifier for a particular merchandising rule.
536
- */
537
- /**
538
- * @typedef GetMerchandisingRulesParam
539
- * @property {string} [pageId] - Each response will contain next_id param, which
540
- * should be sent back to make pagination work.
541
- * @property {number} [pageSize] - Number of items to retrieve in each page.
542
- * Default is 12.
543
352
  */
544
353
  /**
545
354
  * @typedef GetProductDetailBySlugParam
546
355
  * @property {string} slug - The unique identifier of a product. i.e; `slug` of
547
356
  * a product. You can retrieve these from the APIs that list products like
548
- * **v1.0/products/**
549
- */
550
- /**
551
- * @typedef GetProductsInPriceFactoryByZoneIdParam
552
- * @property {string} id - An `id` is a unique identifier for a particular price factory.
553
- * @property {string} zoneId - An `zone_id` is a unique identifier for a
554
- * particular price factory zone.
555
- * @property {number} [itemId] - Gets price factory filtered by item_id.
556
- * @property {string} [q] - Gets price factory filtered by search query.
557
- * @property {number} [pageNo] - The page number to navigate through the given
558
- * set of results.
559
- * @property {number} [pageSize] - Number of items to retrieve in each page.
560
- * Default is 12.
357
+ * "v1.0/products/"
561
358
  */
562
359
  /** @typedef GetQueryFiltersParam */
563
360
  /** @typedef GetSearchConfigurationParam */
@@ -566,69 +363,20 @@ export = CatalogPlatformApplicationValidator;
566
363
  * @property {string} id - A `id` is a unique identifier for a particular
567
364
  * detail. Pass the `id` of the keywords which you want to retrieve.
568
365
  */
569
- /** @typedef GetSearchRerankParam */
570
- /**
571
- * @typedef GetSearchRerankDetailParam
572
- * @property {string} id - An `id` is the identifier for a particular search
573
- * rerank configuration. channel.
574
- */
575
- /**
576
- * @typedef GetSynonymsParam
577
- * @property {string} [id] - Mongo id of the particular synonym
578
- * @property {string} [name] - Synonym name
579
- * @property {string} [type] - Synonym type - oneway/twoway
580
- */
581
- /**
582
- * @typedef PollBulkSynonymsParam
583
- * @property {string} id - Id of the bulk job that needs to be polled.
584
- */
585
- /**
586
- * @typedef PollPriceFactoryJobsParam
587
- * @property {string} id - An `id` is a unique identifier for a particular price factory.
588
- * @property {string} [startDate] - Date that filters the jobs created after this date
589
- * @property {string} [endDate] - Date that filters the jobs created before this date
590
- * @property {string[]} [stage] - Filter jobs by the stage
591
- * @property {boolean} [isActive] - Filter active or inactive jobs
592
- * @property {string} [q] - Pass unique identifier for a particular job to poll
593
- * @property {string[]} [type] - Pass type for a particular job to poll
594
- */
595
- /**
596
- * @typedef PollProductPriceFactoryBulkJobParam
597
- * @property {string} id - An `id` is a unique identifier for a particular price factory.
598
- * @property {string} jobId - A `job_id` is a unique identifier for a particular bulk job.
599
- */
600
- /**
601
- * @typedef ProcessBulkSynonymsParam
602
- * @property {CatalogPlatformModel.SynonymBulkProcessRequestSchema} body
603
- */
604
- /**
605
- * @typedef ProcessProductPriceFactoryBulkJobParam
606
- * @property {string} id - An `id` is a unique identifier for a particular price factory.
607
- * @property {string} jobId - A `job_id` is a unique identifier for a particular bulk job.
608
- * @property {CatalogPlatformModel.CreateAppPriceFactoryProductBulkJobRequest} body
609
- */
610
- /**
611
- * @typedef SampleBulkSynonymsFileParam
612
- * @property {string} type - Type of the file
613
- */
614
- /**
615
- * @typedef SaveMerchandisingRulesParam
616
- * @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
617
- * unique identifier for a particular merchandising rule.
618
- * @property {CatalogPlatformModel.MerchandisingRuleSave} body
619
- */
620
366
  /**
621
367
  * @typedef UpdateAllowSingleParam
622
- * @property {CatalogPlatformModel.AllowSingleRequest} body
368
+ * @property {CatalogPlatformModel.AllowSingleRequestSchema} body
623
369
  */
624
370
  /**
625
371
  * @typedef UpdateAppBrandParam
626
- * @property {number} brandUid - Brand id for which the custom_json is associated.
372
+ * @property {number} brandUid - A `brand id` is a unique identifier for a
373
+ * particular brand.
627
374
  * @property {CatalogPlatformModel.ApplicationBrandJson} body
628
375
  */
629
376
  /**
630
377
  * @typedef UpdateAppCategoryParam
631
- * @property {number} categoryUid - Category id for which the custom_json is associated.
378
+ * @property {string} categoryUid - A `category id` is a unique identifier for a
379
+ * particular category.
632
380
  * @property {CatalogPlatformModel.ApplicationCategoryJson} body
633
381
  */
634
382
  /**
@@ -637,8 +385,8 @@ export = CatalogPlatformApplicationValidator;
637
385
  */
638
386
  /**
639
387
  * @typedef UpdateAppDepartmentParam
640
- * @property {number} departmentUid - Department id for which the custom_json is
641
- * associated.
388
+ * @property {number} departmentUid - A `department id` is a unique identifier
389
+ * for a particular department.
642
390
  * @property {CatalogPlatformModel.ApplicationDepartmentJson} body
643
391
  */
644
392
  /**
@@ -648,7 +396,7 @@ export = CatalogPlatformApplicationValidator;
648
396
  */
649
397
  /**
650
398
  * @typedef UpdateAppProductParam
651
- * @property {number} itemId - Product id for which the custom_meta is associated.
399
+ * @property {number} itemId - A `item_id` is a unique identifier for a particular item.
652
400
  * @property {CatalogPlatformModel.ApplicationItemMeta} body
653
401
  */
654
402
  /**
@@ -661,12 +409,6 @@ export = CatalogPlatformApplicationValidator;
661
409
  * detail. Pass the `id` of the keywords which you want to delete.
662
410
  * @property {CatalogPlatformModel.CreateAutocompleteKeyword} body
663
411
  */
664
- /**
665
- * @typedef UpdateAutocompleteSettingsParam
666
- * @property {string} id - An `id` is a unique identifier for a particular
667
- * autocomplete settings config.
668
- * @property {CatalogPlatformModel.AutocompleteRequestSchema} body
669
- */
670
412
  /**
671
413
  * @typedef UpdateCollectionParam
672
414
  * @property {string} id - A `id` is a unique identifier of a collection.
@@ -674,7 +416,7 @@ export = CatalogPlatformApplicationValidator;
674
416
  */
675
417
  /**
676
418
  * @typedef UpdateDefaultSortParam
677
- * @property {CatalogPlatformModel.DefaultKeyRequest} body
419
+ * @property {CatalogPlatformModel.DefaultKeyRequestSchema} body
678
420
  */
679
421
  /**
680
422
  * @typedef UpdateGroupConfigurationParam
@@ -690,41 +432,11 @@ export = CatalogPlatformApplicationValidator;
690
432
  * particular listing configuration type.
691
433
  * @property {string} configId - A `config_id` is a unique identifier of a
692
434
  * particular configuration.
693
- * @property {CatalogPlatformModel.AppConfigurationsFilterResponse} body
694
- */
695
- /**
696
- * @typedef UpdateMerchandisingRuleBoostActionParam
697
- * @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
698
- * unique identifier for a particular merchandising rule.
699
- * @property {CatalogPlatformModel.PostMerchandisingRuleBoostAction} body
700
- */
701
- /**
702
- * @typedef UpdateMerchandisingRuleBuryActionParam
703
- * @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
704
- * unique identifier for a particular merchandising rule.
705
- * @property {CatalogPlatformModel.PostMerchandisingRuleBoostAction} body
706
- */
707
- /**
708
- * @typedef UpdateMerchandisingRuleHideActionParam
709
- * @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
710
- * unique identifier for a particular merchandising rule.
711
- * @property {CatalogPlatformModel.HideRequest} body
712
- */
713
- /**
714
- * @typedef UpdateMerchandisingRulePinActionParam
715
- * @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
716
- * unique identifier for a particular merchandising rule.
717
- * @property {CatalogPlatformModel.PinRequest} body
718
- */
719
- /**
720
- * @typedef UpdateMerchandisingRuleQueryParam
721
- * @property {string} merchandisingRuleId - A `merchandising_rule_id` is a
722
- * unique identifier for a particular merchandising rule.
723
- * @property {CatalogPlatformModel.MerchandisingRuleQueryPost} body
435
+ * @property {CatalogPlatformModel.AppConfigurationsSort} body
724
436
  */
725
437
  /**
726
438
  * @typedef UpdateSearchConfigurationParam
727
- * @property {CatalogPlatformModel.UpdateSearchConfigurationRequest} body
439
+ * @property {CatalogPlatformModel.UpdateSearchConfigurationRequestSchema} body
728
440
  */
729
441
  /**
730
442
  * @typedef UpdateSearchKeywordsParam
@@ -732,47 +444,13 @@ export = CatalogPlatformApplicationValidator;
732
444
  * detail. Pass the `id` of the keywords which you want to delete.
733
445
  * @property {CatalogPlatformModel.CreateSearchKeyword} body
734
446
  */
735
- /**
736
- * @typedef UpdateSearchRerankConfigurationParam
737
- * @property {string} id - An `id` is the identifier for a particular search
738
- * rerank configuration. channel.
739
- * @property {CatalogPlatformModel.UpdateSearchRerankRequest} body
740
- */
741
- /**
742
- * @typedef UpdateSynonymsParam
743
- * @property {string} id - An `id` is a unique identifier for a particular
744
- * synonym channel.
745
- * @property {CatalogPlatformModel.SynonymCreateRequestSchema} body
746
- */
747
- /**
748
- * @typedef UploadSynonymsParam
749
- * @property {CatalogPlatformModel.SynonymUploadRequestSchema} body
750
- */
751
- /**
752
- * @typedef ValidateBulkSynonymsParam
753
- * @property {CatalogPlatformModel.SynonymBulkValidateRequestSchema} body
754
- */
755
- /**
756
- * @typedef ValidateProductPriceFactoryBulkJobParam
757
- * @property {string} id - An `id` is a unique identifier for a particular price factory.
758
- * @property {string} jobId - A `job_id` is a unique identifier for a particular bulk job.
759
- * @property {CatalogPlatformModel.CreateAppPriceFactoryProductBulkJobRequest} body
760
- */
761
447
  declare class CatalogPlatformApplicationValidator {
762
448
  /** @returns {AddCollectionItemsParam} */
763
449
  static addCollectionItems(): AddCollectionItemsParam;
764
- /** @returns {AddProductsInPriceFactoryByZoneIdParam} */
765
- static addProductsInPriceFactoryByZoneId(): AddProductsInPriceFactoryByZoneIdParam;
766
- /** @returns {ClearCollectionItemsPriorityParam} */
767
- static clearCollectionItemsPriority(): ClearCollectionItemsPriorityParam;
768
450
  /** @returns {CreateAppCategoryReturnConfigurationParam} */
769
451
  static createAppCategoryReturnConfiguration(): CreateAppCategoryReturnConfigurationParam;
770
- /** @returns {CreateAppPriceFactoryParam} */
771
- static createAppPriceFactory(): CreateAppPriceFactoryParam;
772
452
  /** @returns {CreateAppReturnConfigurationParam} */
773
453
  static createAppReturnConfiguration(): CreateAppReturnConfigurationParam;
774
- /** @returns {CreateAutocompleteSettingsParam} */
775
- static createAutocompleteSettings(): CreateAutocompleteSettingsParam;
776
454
  /** @returns {CreateCollectionParam} */
777
455
  static createCollection(): CreateCollectionParam;
778
456
  /** @returns {CreateConfigurationByTypeParam} */
@@ -787,24 +465,8 @@ declare class CatalogPlatformApplicationValidator {
787
465
  static createGroupConfiguration(): CreateGroupConfigurationParam;
788
466
  /** @returns {CreateListingConfigurationParam} */
789
467
  static createListingConfiguration(): CreateListingConfigurationParam;
790
- /** @returns {CreateMerchandisingRuleBoostActionParam} */
791
- static createMerchandisingRuleBoostAction(): CreateMerchandisingRuleBoostActionParam;
792
- /** @returns {CreateMerchandisingRuleBuryActionParam} */
793
- static createMerchandisingRuleBuryAction(): CreateMerchandisingRuleBuryActionParam;
794
- /** @returns {CreateMerchandisingRuleHideActionParam} */
795
- static createMerchandisingRuleHideAction(): CreateMerchandisingRuleHideActionParam;
796
- /** @returns {CreateMerchandisingRulePinActionParam} */
797
- static createMerchandisingRulePinAction(): CreateMerchandisingRulePinActionParam;
798
- /** @returns {CreateMerchandisingRuleQueryParam} */
799
- static createMerchandisingRuleQuery(): CreateMerchandisingRuleQueryParam;
800
- /** @returns {CreateProductPriceFactoryBulkJobParam} */
801
- static createProductPriceFactoryBulkJob(): CreateProductPriceFactoryBulkJobParam;
802
468
  /** @returns {CreateSearchConfigurationParam} */
803
469
  static createSearchConfiguration(): CreateSearchConfigurationParam;
804
- /** @returns {CreateSearchRerankParam} */
805
- static createSearchRerank(): CreateSearchRerankParam;
806
- /** @returns {CreateSynonymsParam} */
807
- static createSynonyms(): CreateSynonymsParam;
808
470
  /** @returns {DeleteAppCategoryReturnConfigurationParam} */
809
471
  static deleteAppCategoryReturnConfiguration(): DeleteAppCategoryReturnConfigurationParam;
810
472
  /** @returns {DeleteAutocompleteKeywordParam} */
@@ -815,44 +477,22 @@ declare class CatalogPlatformApplicationValidator {
815
477
  static deleteGroupConfiguration(): DeleteGroupConfigurationParam;
816
478
  /** @returns {DeleteListingConfigurationParam} */
817
479
  static deleteListingConfiguration(): DeleteListingConfigurationParam;
818
- /** @returns {DeleteMerchandisingRuleParam} */
819
- static deleteMerchandisingRule(): DeleteMerchandisingRuleParam;
820
- /** @returns {DeleteMerchandisingRulesPreviewParam} */
821
- static deleteMerchandisingRulesPreview(): DeleteMerchandisingRulesPreviewParam;
822
480
  /** @returns {DeleteSearchConfigurationParam} */
823
481
  static deleteSearchConfiguration(): any;
824
482
  /** @returns {DeleteSearchKeywordsParam} */
825
483
  static deleteSearchKeywords(): DeleteSearchKeywordsParam;
826
- /** @returns {DeleteSearchRerankConfigurationParam} */
827
- static deleteSearchRerankConfiguration(): DeleteSearchRerankConfigurationParam;
828
- /** @returns {DeleteSynonymParam} */
829
- static deleteSynonym(): DeleteSynonymParam;
830
- /** @returns {EditAppPriceFactoryParam} */
831
- static editAppPriceFactory(): EditAppPriceFactoryParam;
832
- /** @returns {ExportProductsInPriceFactoryParam} */
833
- static exportProductsInPriceFactory(): ExportProductsInPriceFactoryParam;
834
- /** @returns {ExportSynonymsParam} */
835
- static exportSynonyms(): any;
836
484
  /** @returns {GetAllCollectionsParam} */
837
485
  static getAllCollections(): GetAllCollectionsParam;
838
486
  /** @returns {GetAllSearchKeywordParam} */
839
- static getAllSearchKeyword(): GetAllSearchKeywordParam;
487
+ static getAllSearchKeyword(): any;
840
488
  /** @returns {GetAppCategoryReturnConfigParam} */
841
489
  static getAppCategoryReturnConfig(): GetAppCategoryReturnConfigParam;
842
490
  /** @returns {GetAppInventoryParam} */
843
491
  static getAppInventory(): GetAppInventoryParam;
844
492
  /** @returns {GetAppLocationsParam} */
845
493
  static getAppLocations(): GetAppLocationsParam;
846
- /** @returns {GetAppPriceByIdParam} */
847
- static getAppPriceById(): GetAppPriceByIdParam;
848
- /** @returns {GetAppPriceFactoriesParam} */
849
- static getAppPriceFactories(): GetAppPriceFactoriesParam;
850
- /** @returns {GetAppPriceFactoryParam} */
851
- static getAppPriceFactory(): GetAppPriceFactoryParam;
852
494
  /** @returns {GetAppProductParam} */
853
495
  static getAppProduct(): GetAppProductParam;
854
- /** @returns {GetAppProductPricesParam} */
855
- static getAppProductPrices(): GetAppProductPricesParam;
856
496
  /** @returns {GetAppProductsParam} */
857
497
  static getAppProducts(): GetAppProductsParam;
858
498
  /** @returns {GetAppReturnConfigurationParam} */
@@ -872,13 +512,9 @@ declare class CatalogPlatformApplicationValidator {
872
512
  /** @returns {GetApplicationProductsParam} */
873
513
  static getApplicationProducts(): GetApplicationProductsParam;
874
514
  /** @returns {GetAutocompleteConfigParam} */
875
- static getAutocompleteConfig(): GetAutocompleteConfigParam;
515
+ static getAutocompleteConfig(): any;
876
516
  /** @returns {GetAutocompleteKeywordDetailParam} */
877
517
  static getAutocompleteKeywordDetail(): GetAutocompleteKeywordDetailParam;
878
- /** @returns {GetAutocompletePreviewParam} */
879
- static getAutocompletePreview(): GetAutocompletePreviewParam;
880
- /** @returns {GetAutocompleteSettingsParam} */
881
- static getAutocompleteSettings(): any;
882
518
  /** @returns {GetCatalogConfigurationParam} */
883
519
  static getCatalogConfiguration(): any;
884
520
  /** @returns {GetCatalogInsightsParam} */
@@ -895,8 +531,6 @@ declare class CatalogPlatformApplicationValidator {
895
531
  static getConfigurationMetadata(): GetConfigurationMetadataParam;
896
532
  /** @returns {GetConfigurationsParam} */
897
533
  static getConfigurations(): any;
898
- /** @returns {GetConfigurationsFilterMetadataParam} */
899
- static getConfigurationsFilterMetadata(): GetConfigurationsFilterMetadataParam;
900
534
  /** @returns {GetDepartmentsParam} */
901
535
  static getDepartments(): any;
902
536
  /** @returns {GetDiscountedInventoryBySizeIdentifierParam} */
@@ -905,50 +539,14 @@ declare class CatalogPlatformApplicationValidator {
905
539
  static getGroupConfigurations(): GetGroupConfigurationsParam;
906
540
  /** @returns {GetListingConfigurationsParam} */
907
541
  static getListingConfigurations(): GetListingConfigurationsParam;
908
- /** @returns {GetLivePreviewParam} */
909
- static getLivePreview(): GetLivePreviewParam;
910
- /** @returns {GetMerchandisingQueryParam} */
911
- static getMerchandisingQuery(): GetMerchandisingQueryParam;
912
- /** @returns {GetMerchandisingRuleBoostActionParam} */
913
- static getMerchandisingRuleBoostAction(): GetMerchandisingRuleBoostActionParam;
914
- /** @returns {GetMerchandisingRuleBuryActionParam} */
915
- static getMerchandisingRuleBuryAction(): GetMerchandisingRuleBuryActionParam;
916
- /** @returns {GetMerchandisingRuleHideActionParam} */
917
- static getMerchandisingRuleHideAction(): GetMerchandisingRuleHideActionParam;
918
- /** @returns {GetMerchandisingRulePinActionParam} */
919
- static getMerchandisingRulePinAction(): GetMerchandisingRulePinActionParam;
920
- /** @returns {GetMerchandisingRulesParam} */
921
- static getMerchandisingRules(): GetMerchandisingRulesParam;
922
542
  /** @returns {GetProductDetailBySlugParam} */
923
543
  static getProductDetailBySlug(): GetProductDetailBySlugParam;
924
- /** @returns {GetProductsInPriceFactoryByZoneIdParam} */
925
- static getProductsInPriceFactoryByZoneId(): GetProductsInPriceFactoryByZoneIdParam;
926
544
  /** @returns {GetQueryFiltersParam} */
927
545
  static getQueryFilters(): any;
928
546
  /** @returns {GetSearchConfigurationParam} */
929
547
  static getSearchConfiguration(): any;
930
548
  /** @returns {GetSearchKeywordsParam} */
931
549
  static getSearchKeywords(): GetSearchKeywordsParam;
932
- /** @returns {GetSearchRerankParam} */
933
- static getSearchRerank(): any;
934
- /** @returns {GetSearchRerankDetailParam} */
935
- static getSearchRerankDetail(): GetSearchRerankDetailParam;
936
- /** @returns {GetSynonymsParam} */
937
- static getSynonyms(): GetSynonymsParam;
938
- /** @returns {PollBulkSynonymsParam} */
939
- static pollBulkSynonyms(): PollBulkSynonymsParam;
940
- /** @returns {PollPriceFactoryJobsParam} */
941
- static pollPriceFactoryJobs(): PollPriceFactoryJobsParam;
942
- /** @returns {PollProductPriceFactoryBulkJobParam} */
943
- static pollProductPriceFactoryBulkJob(): PollProductPriceFactoryBulkJobParam;
944
- /** @returns {ProcessBulkSynonymsParam} */
945
- static processBulkSynonyms(): ProcessBulkSynonymsParam;
946
- /** @returns {ProcessProductPriceFactoryBulkJobParam} */
947
- static processProductPriceFactoryBulkJob(): ProcessProductPriceFactoryBulkJobParam;
948
- /** @returns {SampleBulkSynonymsFileParam} */
949
- static sampleBulkSynonymsFile(): SampleBulkSynonymsFileParam;
950
- /** @returns {SaveMerchandisingRulesParam} */
951
- static saveMerchandisingRules(): SaveMerchandisingRulesParam;
952
550
  /** @returns {UpdateAllowSingleParam} */
953
551
  static updateAllowSingle(): UpdateAllowSingleParam;
954
552
  /** @returns {UpdateAppBrandParam} */
@@ -967,8 +565,6 @@ declare class CatalogPlatformApplicationValidator {
967
565
  static updateAppReturnConfiguration(): UpdateAppReturnConfigurationParam;
968
566
  /** @returns {UpdateAutocompleteKeywordParam} */
969
567
  static updateAutocompleteKeyword(): UpdateAutocompleteKeywordParam;
970
- /** @returns {UpdateAutocompleteSettingsParam} */
971
- static updateAutocompleteSettings(): UpdateAutocompleteSettingsParam;
972
568
  /** @returns {UpdateCollectionParam} */
973
569
  static updateCollection(): UpdateCollectionParam;
974
570
  /** @returns {UpdateDefaultSortParam} */
@@ -977,33 +573,13 @@ declare class CatalogPlatformApplicationValidator {
977
573
  static updateGroupConfiguration(): UpdateGroupConfigurationParam;
978
574
  /** @returns {UpdateListingConfigurationParam} */
979
575
  static updateListingConfiguration(): UpdateListingConfigurationParam;
980
- /** @returns {UpdateMerchandisingRuleBoostActionParam} */
981
- static updateMerchandisingRuleBoostAction(): UpdateMerchandisingRuleBoostActionParam;
982
- /** @returns {UpdateMerchandisingRuleBuryActionParam} */
983
- static updateMerchandisingRuleBuryAction(): UpdateMerchandisingRuleBuryActionParam;
984
- /** @returns {UpdateMerchandisingRuleHideActionParam} */
985
- static updateMerchandisingRuleHideAction(): UpdateMerchandisingRuleHideActionParam;
986
- /** @returns {UpdateMerchandisingRulePinActionParam} */
987
- static updateMerchandisingRulePinAction(): UpdateMerchandisingRulePinActionParam;
988
- /** @returns {UpdateMerchandisingRuleQueryParam} */
989
- static updateMerchandisingRuleQuery(): UpdateMerchandisingRuleQueryParam;
990
576
  /** @returns {UpdateSearchConfigurationParam} */
991
577
  static updateSearchConfiguration(): UpdateSearchConfigurationParam;
992
578
  /** @returns {UpdateSearchKeywordsParam} */
993
579
  static updateSearchKeywords(): UpdateSearchKeywordsParam;
994
- /** @returns {UpdateSearchRerankConfigurationParam} */
995
- static updateSearchRerankConfiguration(): UpdateSearchRerankConfigurationParam;
996
- /** @returns {UpdateSynonymsParam} */
997
- static updateSynonyms(): UpdateSynonymsParam;
998
- /** @returns {UploadSynonymsParam} */
999
- static uploadSynonyms(): UploadSynonymsParam;
1000
- /** @returns {ValidateBulkSynonymsParam} */
1001
- static validateBulkSynonyms(): ValidateBulkSynonymsParam;
1002
- /** @returns {ValidateProductPriceFactoryBulkJobParam} */
1003
- static validateProductPriceFactoryBulkJob(): ValidateProductPriceFactoryBulkJobParam;
1004
580
  }
1005
581
  declare namespace CatalogPlatformApplicationValidator {
1006
- export { AddCollectionItemsParam, AddProductsInPriceFactoryByZoneIdParam, ClearCollectionItemsPriorityParam, CreateAppCategoryReturnConfigurationParam, CreateAppPriceFactoryParam, CreateAppReturnConfigurationParam, CreateAutocompleteSettingsParam, CreateCollectionParam, CreateConfigurationByTypeParam, CreateConfigurationProductListingParam, CreateCustomAutocompleteRuleParam, CreateCustomKeywordParam, CreateGroupConfigurationParam, CreateListingConfigurationParam, CreateMerchandisingRuleBoostActionParam, CreateMerchandisingRuleBuryActionParam, CreateMerchandisingRuleHideActionParam, CreateMerchandisingRulePinActionParam, CreateMerchandisingRuleQueryParam, CreateProductPriceFactoryBulkJobParam, CreateSearchConfigurationParam, CreateSearchRerankParam, CreateSynonymsParam, DeleteAppCategoryReturnConfigurationParam, DeleteAutocompleteKeywordParam, DeleteCollectionParam, DeleteGroupConfigurationParam, DeleteListingConfigurationParam, DeleteMerchandisingRuleParam, DeleteMerchandisingRulesPreviewParam, DeleteSearchConfigurationParam, DeleteSearchKeywordsParam, DeleteSearchRerankConfigurationParam, DeleteSynonymParam, EditAppPriceFactoryParam, ExportProductsInPriceFactoryParam, ExportSynonymsParam, GetAllCollectionsParam, GetAllSearchKeywordParam, GetAppCategoryReturnConfigParam, GetAppInventoryParam, GetAppLocationsParam, GetAppPriceByIdParam, GetAppPriceFactoriesParam, GetAppPriceFactoryParam, GetAppProductParam, GetAppProductPricesParam, GetAppProductsParam, GetAppReturnConfigurationParam, GetApplicationBrandListingParam, GetApplicationBrandsParam, GetApplicationCategoryListingParam, GetApplicationDepartmentListingParam, GetApplicationFilterKeysParam, GetApplicationFilterValuesParam, GetApplicationProductsParam, GetAutocompleteConfigParam, GetAutocompleteKeywordDetailParam, GetAutocompletePreviewParam, GetAutocompleteSettingsParam, GetCatalogConfigurationParam, GetCatalogInsightsParam, GetCategoriesParam, GetCollectionDetailParam, GetCollectionItemsParam, GetConfigurationByTypeParam, GetConfigurationMetadataParam, GetConfigurationsParam, GetConfigurationsFilterMetadataParam, GetDepartmentsParam, GetDiscountedInventoryBySizeIdentifierParam, GetGroupConfigurationsParam, GetListingConfigurationsParam, GetLivePreviewParam, GetMerchandisingQueryParam, GetMerchandisingRuleBoostActionParam, GetMerchandisingRuleBuryActionParam, GetMerchandisingRuleHideActionParam, GetMerchandisingRulePinActionParam, GetMerchandisingRulesParam, GetProductDetailBySlugParam, GetProductsInPriceFactoryByZoneIdParam, GetQueryFiltersParam, GetSearchConfigurationParam, GetSearchKeywordsParam, GetSearchRerankParam, GetSearchRerankDetailParam, GetSynonymsParam, PollBulkSynonymsParam, PollPriceFactoryJobsParam, PollProductPriceFactoryBulkJobParam, ProcessBulkSynonymsParam, ProcessProductPriceFactoryBulkJobParam, SampleBulkSynonymsFileParam, SaveMerchandisingRulesParam, UpdateAllowSingleParam, UpdateAppBrandParam, UpdateAppCategoryParam, UpdateAppCategoryReturnConfigurationParam, UpdateAppDepartmentParam, UpdateAppLocationParam, UpdateAppProductParam, UpdateAppReturnConfigurationParam, UpdateAutocompleteKeywordParam, UpdateAutocompleteSettingsParam, UpdateCollectionParam, UpdateDefaultSortParam, UpdateGroupConfigurationParam, UpdateListingConfigurationParam, UpdateMerchandisingRuleBoostActionParam, UpdateMerchandisingRuleBuryActionParam, UpdateMerchandisingRuleHideActionParam, UpdateMerchandisingRulePinActionParam, UpdateMerchandisingRuleQueryParam, UpdateSearchConfigurationParam, UpdateSearchKeywordsParam, UpdateSearchRerankConfigurationParam, UpdateSynonymsParam, UploadSynonymsParam, ValidateBulkSynonymsParam, ValidateProductPriceFactoryBulkJobParam };
582
+ export { AddCollectionItemsParam, CreateAppCategoryReturnConfigurationParam, CreateAppReturnConfigurationParam, CreateCollectionParam, CreateConfigurationByTypeParam, CreateConfigurationProductListingParam, CreateCustomAutocompleteRuleParam, CreateCustomKeywordParam, CreateGroupConfigurationParam, CreateListingConfigurationParam, CreateSearchConfigurationParam, DeleteAppCategoryReturnConfigurationParam, DeleteAutocompleteKeywordParam, DeleteCollectionParam, DeleteGroupConfigurationParam, DeleteListingConfigurationParam, DeleteSearchConfigurationParam, DeleteSearchKeywordsParam, GetAllCollectionsParam, GetAllSearchKeywordParam, GetAppCategoryReturnConfigParam, GetAppInventoryParam, GetAppLocationsParam, GetAppProductParam, GetAppProductsParam, GetAppReturnConfigurationParam, GetApplicationBrandListingParam, GetApplicationBrandsParam, GetApplicationCategoryListingParam, GetApplicationDepartmentListingParam, GetApplicationFilterKeysParam, GetApplicationFilterValuesParam, GetApplicationProductsParam, GetAutocompleteConfigParam, GetAutocompleteKeywordDetailParam, GetCatalogConfigurationParam, GetCatalogInsightsParam, GetCategoriesParam, GetCollectionDetailParam, GetCollectionItemsParam, GetConfigurationByTypeParam, GetConfigurationMetadataParam, GetConfigurationsParam, GetDepartmentsParam, GetDiscountedInventoryBySizeIdentifierParam, GetGroupConfigurationsParam, GetListingConfigurationsParam, GetProductDetailBySlugParam, GetQueryFiltersParam, GetSearchConfigurationParam, GetSearchKeywordsParam, UpdateAllowSingleParam, UpdateAppBrandParam, UpdateAppCategoryParam, UpdateAppCategoryReturnConfigurationParam, UpdateAppDepartmentParam, UpdateAppLocationParam, UpdateAppProductParam, UpdateAppReturnConfigurationParam, UpdateAutocompleteKeywordParam, UpdateCollectionParam, UpdateDefaultSortParam, UpdateGroupConfigurationParam, UpdateListingConfigurationParam, UpdateSearchConfigurationParam, UpdateSearchKeywordsParam };
1007
583
  }
1008
584
  type AddCollectionItemsParam = {
1009
585
  /**
@@ -1012,32 +588,44 @@ type AddCollectionItemsParam = {
1012
588
  id: string;
1013
589
  body: CatalogPlatformModel.CollectionItemUpdateSchema;
1014
590
  };
1015
- type AddProductsInPriceFactoryByZoneIdParam = {
1016
- /**
1017
- * - An `id` is a unique identifier for a particular price factory.
1018
- */
1019
- id: string;
1020
- body: CatalogPlatformModel.CreatePriceFactoryProductRequest;
1021
- };
1022
- type ClearCollectionItemsPriorityParam = {
1023
- /**
1024
- * - A `id` is a unique identifier of a collection.
1025
- */
1026
- id: string;
1027
- };
1028
591
  type CreateAppCategoryReturnConfigurationParam = {
1029
592
  body: CatalogPlatformModel.BaseAppCategoryReturnConfig;
1030
593
  };
1031
- type CreateAppPriceFactoryParam = {
1032
- body: CatalogPlatformModel.CreateAppPriceFactoryRequestSchema;
1033
- };
1034
594
  type CreateAppReturnConfigurationParam = {
1035
595
  body: CatalogPlatformModel.CreateUpdateAppReturnConfig;
1036
596
  };
1037
- type CreateAutocompleteSettingsParam = {
1038
- body: CatalogPlatformModel.AutocompleteRequestSchema;
1039
- };
1040
597
  type CreateCollectionParam = {
598
+ /**
599
+ * - Get collection list filtered by q string,
600
+ */
601
+ q?: string;
602
+ /**
603
+ * - Get collection list filtered by scheduled status,
604
+ */
605
+ scheduleStatus?: string;
606
+ /**
607
+ * - Type of the collections
608
+ */
609
+ type?: string;
610
+ /**
611
+ * - Each response will contain next_id param, which
612
+ * should be sent back to make pagination work.
613
+ */
614
+ tags?: string[];
615
+ /**
616
+ * - Get collections filtered by active status.
617
+ */
618
+ isActive?: boolean;
619
+ /**
620
+ * - The page number to navigate through the given
621
+ * set of results.
622
+ */
623
+ pageNo?: number;
624
+ /**
625
+ * - Number of items to retrieve in each page.
626
+ * Default is 12.
627
+ */
628
+ pageSize?: number;
1041
629
  body: CatalogPlatformModel.CreateCollection;
1042
630
  };
1043
631
  type CreateConfigurationByTypeParam = {
@@ -1062,7 +650,7 @@ type CreateGroupConfigurationParam = {
1062
650
  * particular group configuration type.
1063
651
  */
1064
652
  configType: string;
1065
- body: CatalogPlatformModel.AppConfigurationCreateDetail;
653
+ body: CatalogPlatformModel.AppConfigurationDetail;
1066
654
  };
1067
655
  type CreateListingConfigurationParam = {
1068
656
  /**
@@ -1070,58 +658,10 @@ type CreateListingConfigurationParam = {
1070
658
  * particular listing configuration type.
1071
659
  */
1072
660
  configType: string;
1073
- body: CatalogPlatformModel.AppConfigurationsFilter;
1074
- };
1075
- type CreateMerchandisingRuleBoostActionParam = {
1076
- /**
1077
- * - A `merchandising_rule_id` is a
1078
- * unique identifier for a particular merchandising rule.
1079
- */
1080
- merchandisingRuleId: string;
1081
- body: CatalogPlatformModel.PostMerchandisingRuleBoostAction;
1082
- };
1083
- type CreateMerchandisingRuleBuryActionParam = {
1084
- /**
1085
- * - A `merchandising_rule_id` is a
1086
- * unique identifier for a particular merchandising rule.
1087
- */
1088
- merchandisingRuleId: string;
1089
- body: CatalogPlatformModel.PostMerchandisingRuleBoostAction;
1090
- };
1091
- type CreateMerchandisingRuleHideActionParam = {
1092
- /**
1093
- * - A `merchandising_rule_id` is a
1094
- * unique identifier for a particular merchandising rule.
1095
- */
1096
- merchandisingRuleId: string;
1097
- body: CatalogPlatformModel.HideRequest;
1098
- };
1099
- type CreateMerchandisingRulePinActionParam = {
1100
- /**
1101
- * - A `merchandising_rule_id` is a
1102
- * unique identifier for a particular merchandising rule.
1103
- */
1104
- merchandisingRuleId: string;
1105
- body: CatalogPlatformModel.PinRequest;
1106
- };
1107
- type CreateMerchandisingRuleQueryParam = {
1108
- body: CatalogPlatformModel.MerchandisingRuleQueryPost;
1109
- };
1110
- type CreateProductPriceFactoryBulkJobParam = {
1111
- /**
1112
- * - An `id` is a unique identifier for a particular price factory.
1113
- */
1114
- id: string;
1115
- body: CatalogPlatformModel.CreateAppPriceFactoryProductBulkJobRequest;
661
+ body: CatalogPlatformModel.AppConfigurationsSort;
1116
662
  };
1117
663
  type CreateSearchConfigurationParam = {
1118
- body: CatalogPlatformModel.CreateSearchConfigurationRequest;
1119
- };
1120
- type CreateSearchRerankParam = {
1121
- body: CatalogPlatformModel.CreateSearchRerankRequest;
1122
- };
1123
- type CreateSynonymsParam = {
1124
- body: CatalogPlatformModel.SynonymCreateRequestSchema;
664
+ body: CatalogPlatformModel.CreateSearchConfigurationRequestSchema;
1125
665
  };
1126
666
  type DeleteAppCategoryReturnConfigurationParam = {
1127
667
  body: CatalogPlatformModel.DeleteAppCategoryReturnConfig;
@@ -1163,20 +703,6 @@ type DeleteListingConfigurationParam = {
1163
703
  */
1164
704
  configId: string;
1165
705
  };
1166
- type DeleteMerchandisingRuleParam = {
1167
- /**
1168
- * - A `merchandising_rule_id` is a
1169
- * unique identifier for a particular merchandising rule.
1170
- */
1171
- merchandisingRuleId: string;
1172
- };
1173
- type DeleteMerchandisingRulesPreviewParam = {
1174
- /**
1175
- * - A `merchandising_rule_id` is a
1176
- * unique identifier for a particular merchandising rule.
1177
- */
1178
- merchandisingRuleId: string;
1179
- };
1180
706
  type DeleteSearchKeywordsParam = {
1181
707
  /**
1182
708
  * - A `id` is a unique identifier for a particular
@@ -1184,34 +710,6 @@ type DeleteSearchKeywordsParam = {
1184
710
  */
1185
711
  id: string;
1186
712
  };
1187
- type DeleteSearchRerankConfigurationParam = {
1188
- /**
1189
- * - An `id` is the identifier for a particular search
1190
- * rerank configuration. channel.
1191
- */
1192
- id: string;
1193
- };
1194
- type DeleteSynonymParam = {
1195
- /**
1196
- * - A `id` is a unique identifier of a synonym that is to
1197
- * be deleted.
1198
- */
1199
- id: string;
1200
- };
1201
- type EditAppPriceFactoryParam = {
1202
- /**
1203
- * - An `id` is a unique identifier for a particular price factory.
1204
- */
1205
- id: string;
1206
- body: CatalogPlatformModel.EditAppPriceFactoryRequestSchema;
1207
- };
1208
- type ExportProductsInPriceFactoryParam = {
1209
- /**
1210
- * - An `id` is a unique identifier for a particular price factory.
1211
- */
1212
- id: string;
1213
- body: CatalogPlatformModel.CreateAppPriceFactoryProductExportJobRequest;
1214
- };
1215
713
  type GetAllCollectionsParam = {
1216
714
  /**
1217
715
  * - Get collection list filtered by q string,
@@ -1229,7 +727,7 @@ type GetAllCollectionsParam = {
1229
727
  * - Each response will contain next_id param, which
1230
728
  * should be sent back to make pagination work.
1231
729
  */
1232
- tag?: string[];
730
+ tags?: string[];
1233
731
  /**
1234
732
  * - Get collections filtered by active status.
1235
733
  */
@@ -1245,7 +743,12 @@ type GetAllCollectionsParam = {
1245
743
  */
1246
744
  pageSize?: number;
1247
745
  };
1248
- type GetAllSearchKeywordParam = {
746
+ type GetAppCategoryReturnConfigParam = {
747
+ /**
748
+ * - Get return configurations for categories by matching
749
+ * the search string with category names.
750
+ */
751
+ q?: string;
1249
752
  /**
1250
753
  * - The page number to navigate through the given
1251
754
  * set of results
@@ -1253,44 +756,17 @@ type GetAllSearchKeywordParam = {
1253
756
  pageNo?: number;
1254
757
  /**
1255
758
  * - Number of items to retrieve in each page.
1256
- * Default is 12.
759
+ * Default is 10.
1257
760
  */
1258
761
  pageSize?: number;
762
+ };
763
+ type GetAppInventoryParam = {
1259
764
  /**
1260
- * - Search query with words name.Use this parameter to
1261
- * search keywords by words.
765
+ * - The Item Id of the product.
1262
766
  */
1263
- q?: string;
767
+ itemIds?: number[];
1264
768
  /**
1265
- * - Can query for keywords based on whether they
1266
- * are active or inactive.
1267
- */
1268
- isActive?: boolean;
1269
- };
1270
- type GetAppCategoryReturnConfigParam = {
1271
- /**
1272
- * - Get return configurations for categories by matching
1273
- * the search string with category names.
1274
- */
1275
- q?: string;
1276
- /**
1277
- * - The page number to navigate through the given
1278
- * set of results
1279
- */
1280
- pageNo?: number;
1281
- /**
1282
- * - Number of items to retrieve in each page.
1283
- * Default is 10.
1284
- */
1285
- pageSize?: number;
1286
- };
1287
- type GetAppInventoryParam = {
1288
- /**
1289
- * - The Item Id of the product.
1290
- */
1291
- itemIds?: number[];
1292
- /**
1293
- * - The Store Id of products to fetch inventory.
769
+ * - The Store Id of products to fetch inventory.
1294
770
  */
1295
771
  storeIds?: number[];
1296
772
  /**
@@ -1377,92 +853,12 @@ type GetAppLocationsParam = {
1377
853
  * - Get locations filtered by store types.
1378
854
  */
1379
855
  storeTypes?: string[];
1380
- /**
1381
- * - Filter stores by company IDs available
1382
- * in the application.
1383
- */
1384
- companyUids?: number[];
1385
- };
1386
- type GetAppPriceByIdParam = {
1387
- /**
1388
- * - Unique identifier of the product
1389
- */
1390
- itemId: number;
1391
- /**
1392
- * - An array of unique identifiers representing
1393
- * the store locations from which the product pricing should be fetched. If
1394
- * not provided, pricing for all applicable store locations will be returned.
1395
- */
1396
- storeIds?: number[];
1397
- /**
1398
- * - An array of unique factory type
1399
- * identifiers that specify that pricing from which factory type should be
1400
- * retrieved. This parameter allows filtering the price based on factory types.
1401
- */
1402
- factoryTypeIds?: string[];
1403
- /**
1404
- * - The company uid for which we want to fetch
1405
- * discounted pricing for a product
1406
- */
1407
- sellerId?: number;
1408
- };
1409
- type GetAppPriceFactoriesParam = {
1410
- /**
1411
- * - Gets price factory filtered by active status.
1412
- */
1413
- isActive?: boolean;
1414
- /**
1415
- * - Gets price factory filtered by factory_type_id.
1416
- */
1417
- factoryTypeId?: string;
1418
- /**
1419
- * - Gets price factory filtered by pricezone code.
1420
- */
1421
- code?: string;
1422
- /**
1423
- * - The page number to navigate through the given
1424
- * set of results.
1425
- */
1426
- pageNo?: number;
1427
- /**
1428
- * - Number of items to retrieve in each page.
1429
- * Default is 12.
1430
- */
1431
- pageSize?: number;
1432
- };
1433
- type GetAppPriceFactoryParam = {
1434
- /**
1435
- * - An `id` is a unique identifier for a particular price factory.
1436
- */
1437
- id: string;
1438
856
  };
1439
857
  type GetAppProductParam = {
1440
858
  /**
1441
859
  * - Product id for a particular product.
1442
860
  */
1443
- itemId: number;
1444
- };
1445
- type GetAppProductPricesParam = {
1446
- /**
1447
- * - List of item ids to get product prices
1448
- * filtered by items.
1449
- */
1450
- itemIds?: number[];
1451
- /**
1452
- * - List of factory type ids to get
1453
- * product prices filtered by factory type id.
1454
- */
1455
- factoryTypeIds?: string[];
1456
- /**
1457
- * - The page number to navigate through the given
1458
- * set of results
1459
- */
1460
- pageNo?: number;
1461
- /**
1462
- * - Number of items to retrieve in each page.
1463
- * Default is 10.
1464
- */
1465
- pageSize?: number;
861
+ itemId: string;
1466
862
  };
1467
863
  type GetAppProductsParam = {
1468
864
  /**
@@ -1512,7 +908,7 @@ type GetApplicationBrandListingParam = {
1512
908
  */
1513
909
  pageSize?: number;
1514
910
  /**
1515
- * - Search query with brand name.Use this parameter to
911
+ * - Search query with brand name. Use this parameter to
1516
912
  * search brands by brand name.
1517
913
  */
1518
914
  q?: string;
@@ -1522,7 +918,7 @@ type GetApplicationBrandsParam = {
1522
918
  * - The name of the department. Use this
1523
919
  * parameter to filter products by a particular department. See below the list
1524
920
  * of available departments. You can retrieve available departments from the
1525
- * **v1.0/departments/** API
921
+ * "v1.0/departments/" API
1526
922
  */
1527
923
  department?: string;
1528
924
  /**
@@ -1536,7 +932,7 @@ type GetApplicationBrandsParam = {
1536
932
  */
1537
933
  pageSize?: number;
1538
934
  /**
1539
- * - Search query with brand name.Use this parameter to
935
+ * - Search query with brand name. Use this parameter to
1540
936
  * search brands by brand name.
1541
937
  */
1542
938
  q?: string;
@@ -1563,8 +959,8 @@ type GetApplicationCategoryListingParam = {
1563
959
  */
1564
960
  pageSize?: number;
1565
961
  /**
1566
- * - Search query with brand name.Use this parameter to
1567
- * search brands by brand name.
962
+ * - A search query string. Use this parameter to filter
963
+ * results based on a keyword or specific value.
1568
964
  */
1569
965
  q?: string;
1570
966
  };
@@ -1580,36 +976,34 @@ type GetApplicationDepartmentListingParam = {
1580
976
  */
1581
977
  pageSize?: number;
1582
978
  /**
1583
- * - Search query with brand name.Use this parameter to
1584
- * search department by name.
979
+ * - A search query string. Use this parameter to filter
980
+ * results based on a keyword or specific value.
1585
981
  */
1586
982
  q?: string;
1587
983
  };
1588
984
  type GetApplicationFilterKeysParam = {
1589
985
  /**
1590
986
  * - The search filter parameters for collection items.
1591
- * All the parameter filtered from filter parameters will be passed in **c**
1592
- * parameter in this format.
1593
- * **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
987
+ * All the parameter filtered from filter parameters will be passed in "c"
988
+ * parameter in this format. "?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts"
1594
989
  */
1595
990
  c?: string;
1596
991
  };
1597
992
  type GetApplicationFilterValuesParam = {
1598
993
  /**
1599
- * - A `filter_key` is a filter key for a for which
1600
- * all the available filter values will returned. channel.
994
+ * - A `filter_key` is a filter key which returns
995
+ * all the available filter values.
1601
996
  */
1602
997
  filterKey: string;
1603
998
  /**
1604
999
  * - The search filter parameters for collection items.
1605
- * All the parameter filtered from filter parameters will be passed in **c**
1606
- * parameter in this format.
1607
- * **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
1000
+ * All the parameter filtered from filter parameters will be passed in "c"
1001
+ * parameter in this format. "?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts"
1608
1002
  */
1609
1003
  c?: string;
1610
1004
  /**
1611
1005
  * - A `collection_id` is a unique identifier
1612
- * for a particular collection. channel.
1006
+ * for a particular collection.
1613
1007
  */
1614
1008
  collectionId?: string;
1615
1009
  /**
@@ -1623,7 +1017,10 @@ type GetApplicationFilterValuesParam = {
1623
1017
  */
1624
1018
  pageSize?: number;
1625
1019
  /**
1626
- * - Get Values filtered by q string
1020
+ * - The `q` parameter allows you to search and filter
1021
+ * specific data within the filter options. It acts as a query keyword that
1022
+ * can refine the results by matching relevant filter values, such as a
1023
+ * category name or any other applicable filter criteria.
1627
1024
  */
1628
1025
  q?: string;
1629
1026
  };
@@ -1687,28 +1084,6 @@ type GetApplicationProductsParam = {
1687
1084
  */
1688
1085
  itemIds?: string[];
1689
1086
  };
1690
- type GetAutocompleteConfigParam = {
1691
- /**
1692
- * - The page number to navigate through the given
1693
- * set of results
1694
- */
1695
- pageNo?: number;
1696
- /**
1697
- * - Number of items to retrieve in each page.
1698
- * Default is 12.
1699
- */
1700
- pageSize?: number;
1701
- /**
1702
- * - Search query with words name.Use this parameter to
1703
- * search keywords by words.
1704
- */
1705
- q?: string;
1706
- /**
1707
- * - Can query for keywords based on whether they
1708
- * are active or inactive.
1709
- */
1710
- isActive?: boolean;
1711
- };
1712
1087
  type GetAutocompleteKeywordDetailParam = {
1713
1088
  /**
1714
1089
  * - A `id` is a unique identifier for a particular
@@ -1716,35 +1091,9 @@ type GetAutocompleteKeywordDetailParam = {
1716
1091
  */
1717
1092
  id: string;
1718
1093
  };
1719
- type GetAutocompletePreviewParam = {
1720
- /**
1721
- * - Get suggestions related to `q` string.
1722
- */
1723
- q?: string;
1724
- /**
1725
- * - For getting related category suggestions.
1726
- */
1727
- categorySuggestion?: number;
1728
- /**
1729
- * - For getting related brand suggestions.
1730
- */
1731
- brandSuggestion?: number;
1732
- /**
1733
- * - For getting collection suggestions.
1734
- */
1735
- collectionSuggestion?: number;
1736
- /**
1737
- * - For getting product suggestions.
1738
- */
1739
- productSuggestion?: number;
1740
- /**
1741
- * - For getting query suggestions.
1742
- */
1743
- querySuggestion?: number;
1744
- };
1745
1094
  type GetCatalogInsightsParam = {
1746
1095
  /**
1747
- * - Brand slug
1096
+ * - Brand slug that is to be searched.
1748
1097
  */
1749
1098
  brand?: string;
1750
1099
  };
@@ -1753,7 +1102,7 @@ type GetCategoriesParam = {
1753
1102
  * - The name of the department. Use this
1754
1103
  * parameter to filter products by a particular department. See below the list
1755
1104
  * of available departments. You can retrieve available departments from the
1756
- * **v1.0/departments/** API
1105
+ * "v1.0/departments/" API
1757
1106
  */
1758
1107
  department?: string;
1759
1108
  };
@@ -1775,6 +1124,11 @@ type GetCollectionItemsParam = {
1775
1124
  * should be sent back to make pagination work.
1776
1125
  */
1777
1126
  sortOn?: string;
1127
+ /**
1128
+ * - Each response will contain next_id param, which
1129
+ * should be sent back to make pagination work.
1130
+ */
1131
+ pageId?: string;
1778
1132
  /**
1779
1133
  * - Number of items to retrieve in each page.
1780
1134
  * Default is 12.
@@ -1784,20 +1138,6 @@ type GetCollectionItemsParam = {
1784
1138
  * - Identifies the specific page of results being requested.
1785
1139
  */
1786
1140
  pageNo?: number;
1787
- /**
1788
- * - Number of items that are pinned and have
1789
- * priority in each page. Default is 12.
1790
- */
1791
- isPinned?: boolean;
1792
- /**
1793
- * - Get multiple products filtered by q string
1794
- */
1795
- q?: string;
1796
- /**
1797
- * - Number of items that are excluded from
1798
- * collections in each page. Default is 12.
1799
- */
1800
- isExcluded?: boolean;
1801
1141
  };
1802
1142
  type GetConfigurationByTypeParam = {
1803
1143
  /**
@@ -1816,21 +1156,28 @@ type GetConfigurationMetadataParam = {
1816
1156
  * `template_slug` string. This is for the details and comparision groups.
1817
1157
  */
1818
1158
  templateSlug?: string;
1819
- };
1820
- type GetConfigurationsFilterMetadataParam = {
1821
1159
  /**
1822
- * - Filter whose values needs to be fetched.
1160
+ * - The page number to navigate through the given
1161
+ * set of results.
1823
1162
  */
1824
- filter: string;
1163
+ pageNo?: number;
1164
+ /**
1165
+ * - Number of items to retrieve in each page.
1166
+ */
1167
+ pageSize?: number;
1168
+ /**
1169
+ * - Get configuration list filtered by `q` string.
1170
+ */
1171
+ q?: string;
1825
1172
  };
1826
1173
  type GetDiscountedInventoryBySizeIdentifierParam = {
1827
1174
  /**
1828
- * - Item code of the product of which size is to be get.
1175
+ * - A `item_id` is a unique identifier for a specific product.
1829
1176
  */
1830
1177
  itemId: number;
1831
1178
  /**
1832
1179
  * - Size Identifier (Seller Identifier or
1833
- * Primary Identifier) of which inventory is to get.
1180
+ * Primary Identifier).
1834
1181
  */
1835
1182
  sizeIdentifier: number;
1836
1183
  /**
@@ -1894,108 +1241,15 @@ type GetListingConfigurationsParam = {
1894
1241
  * - Get configuration list filtered by `search` string.
1895
1242
  */
1896
1243
  search?: string;
1897
- /**
1898
- * - Only for categories config type, Get
1899
- * configuration list filtered by `uids`.
1900
- */
1901
- uids?: number[];
1902
- };
1903
- type GetLivePreviewParam = {
1904
- /**
1905
- * - A `merchandising_rule_id` is a
1906
- * unique identifier for a particular merchandising rule.
1907
- */
1908
- merchandisingRuleId: string;
1909
- /**
1910
- * - A sample query that can be used to get a
1911
- * live preview of the merchandising rule.
1912
- */
1913
- searchKeyword?: string;
1914
- };
1915
- type GetMerchandisingQueryParam = {
1916
- /**
1917
- * - A `merchandising_rule_id` is a
1918
- * unique identifier for a particular merchandising rule.
1919
- */
1920
- merchandisingRuleId: string;
1921
- };
1922
- type GetMerchandisingRuleBoostActionParam = {
1923
- /**
1924
- * - A `merchandising_rule_id` is a
1925
- * unique identifier for a particular merchandising rule.
1926
- */
1927
- merchandisingRuleId: string;
1928
- };
1929
- type GetMerchandisingRuleBuryActionParam = {
1930
- /**
1931
- * - A `merchandising_rule_id` is a
1932
- * unique identifier for a particular merchandising rule.
1933
- */
1934
- merchandisingRuleId: string;
1935
- };
1936
- type GetMerchandisingRuleHideActionParam = {
1937
- /**
1938
- * - A `merchandising_rule_id` is a
1939
- * unique identifier for a particular merchandising rule.
1940
- */
1941
- merchandisingRuleId: string;
1942
- };
1943
- type GetMerchandisingRulePinActionParam = {
1944
- /**
1945
- * - A `merchandising_rule_id` is a
1946
- * unique identifier for a particular merchandising rule.
1947
- */
1948
- merchandisingRuleId: string;
1949
- };
1950
- type GetMerchandisingRulesParam = {
1951
- /**
1952
- * - Each response will contain next_id param, which
1953
- * should be sent back to make pagination work.
1954
- */
1955
- pageId?: string;
1956
- /**
1957
- * - Number of items to retrieve in each page.
1958
- * Default is 12.
1959
- */
1960
- pageSize?: number;
1961
1244
  };
1962
1245
  type GetProductDetailBySlugParam = {
1963
1246
  /**
1964
1247
  * - The unique identifier of a product. i.e; `slug` of
1965
1248
  * a product. You can retrieve these from the APIs that list products like
1966
- * **v1.0/products/**
1249
+ * "v1.0/products/"
1967
1250
  */
1968
1251
  slug: string;
1969
1252
  };
1970
- type GetProductsInPriceFactoryByZoneIdParam = {
1971
- /**
1972
- * - An `id` is a unique identifier for a particular price factory.
1973
- */
1974
- id: string;
1975
- /**
1976
- * - An `zone_id` is a unique identifier for a
1977
- * particular price factory zone.
1978
- */
1979
- zoneId: string;
1980
- /**
1981
- * - Gets price factory filtered by item_id.
1982
- */
1983
- itemId?: number;
1984
- /**
1985
- * - Gets price factory filtered by search query.
1986
- */
1987
- q?: string;
1988
- /**
1989
- * - The page number to navigate through the given
1990
- * set of results.
1991
- */
1992
- pageNo?: number;
1993
- /**
1994
- * - Number of items to retrieve in each page.
1995
- * Default is 12.
1996
- */
1997
- pageSize?: number;
1998
- };
1999
1253
  type GetSearchKeywordsParam = {
2000
1254
  /**
2001
1255
  * - A `id` is a unique identifier for a particular
@@ -2003,116 +1257,23 @@ type GetSearchKeywordsParam = {
2003
1257
  */
2004
1258
  id: string;
2005
1259
  };
2006
- type GetSearchRerankDetailParam = {
2007
- /**
2008
- * - An `id` is the identifier for a particular search
2009
- * rerank configuration. channel.
2010
- */
2011
- id: string;
2012
- };
2013
- type GetSynonymsParam = {
2014
- /**
2015
- * - Mongo id of the particular synonym
2016
- */
2017
- id?: string;
2018
- /**
2019
- * - Synonym name
2020
- */
2021
- name?: string;
2022
- /**
2023
- * - Synonym type - oneway/twoway
2024
- */
2025
- type?: string;
2026
- };
2027
- type PollBulkSynonymsParam = {
2028
- /**
2029
- * - Id of the bulk job that needs to be polled.
2030
- */
2031
- id: string;
2032
- };
2033
- type PollPriceFactoryJobsParam = {
2034
- /**
2035
- * - An `id` is a unique identifier for a particular price factory.
2036
- */
2037
- id: string;
2038
- /**
2039
- * - Date that filters the jobs created after this date
2040
- */
2041
- startDate?: string;
2042
- /**
2043
- * - Date that filters the jobs created before this date
2044
- */
2045
- endDate?: string;
2046
- /**
2047
- * - Filter jobs by the stage
2048
- */
2049
- stage?: string[];
2050
- /**
2051
- * - Filter active or inactive jobs
2052
- */
2053
- isActive?: boolean;
2054
- /**
2055
- * - Pass unique identifier for a particular job to poll
2056
- */
2057
- q?: string;
2058
- /**
2059
- * - Pass type for a particular job to poll
2060
- */
2061
- type?: string[];
2062
- };
2063
- type PollProductPriceFactoryBulkJobParam = {
2064
- /**
2065
- * - An `id` is a unique identifier for a particular price factory.
2066
- */
2067
- id: string;
2068
- /**
2069
- * - A `job_id` is a unique identifier for a particular bulk job.
2070
- */
2071
- jobId: string;
2072
- };
2073
- type ProcessBulkSynonymsParam = {
2074
- body: CatalogPlatformModel.SynonymBulkProcessRequestSchema;
2075
- };
2076
- type ProcessProductPriceFactoryBulkJobParam = {
2077
- /**
2078
- * - An `id` is a unique identifier for a particular price factory.
2079
- */
2080
- id: string;
2081
- /**
2082
- * - A `job_id` is a unique identifier for a particular bulk job.
2083
- */
2084
- jobId: string;
2085
- body: CatalogPlatformModel.CreateAppPriceFactoryProductBulkJobRequest;
2086
- };
2087
- type SampleBulkSynonymsFileParam = {
2088
- /**
2089
- * - Type of the file
2090
- */
2091
- type: string;
2092
- };
2093
- type SaveMerchandisingRulesParam = {
2094
- /**
2095
- * - A `merchandising_rule_id` is a
2096
- * unique identifier for a particular merchandising rule.
2097
- */
2098
- merchandisingRuleId: string;
2099
- body: CatalogPlatformModel.MerchandisingRuleSave;
2100
- };
2101
1260
  type UpdateAllowSingleParam = {
2102
- body: CatalogPlatformModel.AllowSingleRequest;
1261
+ body: CatalogPlatformModel.AllowSingleRequestSchema;
2103
1262
  };
2104
1263
  type UpdateAppBrandParam = {
2105
1264
  /**
2106
- * - Brand id for which the custom_json is associated.
1265
+ * - A `brand id` is a unique identifier for a
1266
+ * particular brand.
2107
1267
  */
2108
1268
  brandUid: number;
2109
1269
  body: CatalogPlatformModel.ApplicationBrandJson;
2110
1270
  };
2111
1271
  type UpdateAppCategoryParam = {
2112
1272
  /**
2113
- * - Category id for which the custom_json is associated.
1273
+ * - A `category id` is a unique identifier for a
1274
+ * particular category.
2114
1275
  */
2115
- categoryUid: number;
1276
+ categoryUid: string;
2116
1277
  body: CatalogPlatformModel.ApplicationCategoryJson;
2117
1278
  };
2118
1279
  type UpdateAppCategoryReturnConfigurationParam = {
@@ -2120,8 +1281,8 @@ type UpdateAppCategoryReturnConfigurationParam = {
2120
1281
  };
2121
1282
  type UpdateAppDepartmentParam = {
2122
1283
  /**
2123
- * - Department id for which the custom_json is
2124
- * associated.
1284
+ * - A `department id` is a unique identifier
1285
+ * for a particular department.
2125
1286
  */
2126
1287
  departmentUid: number;
2127
1288
  body: CatalogPlatformModel.ApplicationDepartmentJson;
@@ -2135,7 +1296,7 @@ type UpdateAppLocationParam = {
2135
1296
  };
2136
1297
  type UpdateAppProductParam = {
2137
1298
  /**
2138
- * - Product id for which the custom_meta is associated.
1299
+ * - A `item_id` is a unique identifier for a particular item.
2139
1300
  */
2140
1301
  itemId: number;
2141
1302
  body: CatalogPlatformModel.ApplicationItemMeta;
@@ -2151,14 +1312,6 @@ type UpdateAutocompleteKeywordParam = {
2151
1312
  id: string;
2152
1313
  body: CatalogPlatformModel.CreateAutocompleteKeyword;
2153
1314
  };
2154
- type UpdateAutocompleteSettingsParam = {
2155
- /**
2156
- * - An `id` is a unique identifier for a particular
2157
- * autocomplete settings config.
2158
- */
2159
- id: string;
2160
- body: CatalogPlatformModel.AutocompleteRequestSchema;
2161
- };
2162
1315
  type UpdateCollectionParam = {
2163
1316
  /**
2164
1317
  * - A `id` is a unique identifier of a collection.
@@ -2167,7 +1320,7 @@ type UpdateCollectionParam = {
2167
1320
  body: CatalogPlatformModel.UpdateCollection;
2168
1321
  };
2169
1322
  type UpdateDefaultSortParam = {
2170
- body: CatalogPlatformModel.DefaultKeyRequest;
1323
+ body: CatalogPlatformModel.DefaultKeyRequestSchema;
2171
1324
  };
2172
1325
  type UpdateGroupConfigurationParam = {
2173
1326
  /**
@@ -2193,50 +1346,10 @@ type UpdateListingConfigurationParam = {
2193
1346
  * particular configuration.
2194
1347
  */
2195
1348
  configId: string;
2196
- body: CatalogPlatformModel.AppConfigurationsFilterResponse;
2197
- };
2198
- type UpdateMerchandisingRuleBoostActionParam = {
2199
- /**
2200
- * - A `merchandising_rule_id` is a
2201
- * unique identifier for a particular merchandising rule.
2202
- */
2203
- merchandisingRuleId: string;
2204
- body: CatalogPlatformModel.PostMerchandisingRuleBoostAction;
2205
- };
2206
- type UpdateMerchandisingRuleBuryActionParam = {
2207
- /**
2208
- * - A `merchandising_rule_id` is a
2209
- * unique identifier for a particular merchandising rule.
2210
- */
2211
- merchandisingRuleId: string;
2212
- body: CatalogPlatformModel.PostMerchandisingRuleBoostAction;
2213
- };
2214
- type UpdateMerchandisingRuleHideActionParam = {
2215
- /**
2216
- * - A `merchandising_rule_id` is a
2217
- * unique identifier for a particular merchandising rule.
2218
- */
2219
- merchandisingRuleId: string;
2220
- body: CatalogPlatformModel.HideRequest;
2221
- };
2222
- type UpdateMerchandisingRulePinActionParam = {
2223
- /**
2224
- * - A `merchandising_rule_id` is a
2225
- * unique identifier for a particular merchandising rule.
2226
- */
2227
- merchandisingRuleId: string;
2228
- body: CatalogPlatformModel.PinRequest;
2229
- };
2230
- type UpdateMerchandisingRuleQueryParam = {
2231
- /**
2232
- * - A `merchandising_rule_id` is a
2233
- * unique identifier for a particular merchandising rule.
2234
- */
2235
- merchandisingRuleId: string;
2236
- body: CatalogPlatformModel.MerchandisingRuleQueryPost;
1349
+ body: CatalogPlatformModel.AppConfigurationsSort;
2237
1350
  };
2238
1351
  type UpdateSearchConfigurationParam = {
2239
- body: CatalogPlatformModel.UpdateSearchConfigurationRequest;
1352
+ body: CatalogPlatformModel.UpdateSearchConfigurationRequestSchema;
2240
1353
  };
2241
1354
  type UpdateSearchKeywordsParam = {
2242
1355
  /**
@@ -2246,47 +1359,13 @@ type UpdateSearchKeywordsParam = {
2246
1359
  id: string;
2247
1360
  body: CatalogPlatformModel.CreateSearchKeyword;
2248
1361
  };
2249
- type UpdateSearchRerankConfigurationParam = {
2250
- /**
2251
- * - An `id` is the identifier for a particular search
2252
- * rerank configuration. channel.
2253
- */
2254
- id: string;
2255
- body: CatalogPlatformModel.UpdateSearchRerankRequest;
2256
- };
2257
- type UpdateSynonymsParam = {
2258
- /**
2259
- * - An `id` is a unique identifier for a particular
2260
- * synonym channel.
2261
- */
2262
- id: string;
2263
- body: CatalogPlatformModel.SynonymCreateRequestSchema;
2264
- };
2265
- type UploadSynonymsParam = {
2266
- body: CatalogPlatformModel.SynonymUploadRequestSchema;
2267
- };
2268
- type ValidateBulkSynonymsParam = {
2269
- body: CatalogPlatformModel.SynonymBulkValidateRequestSchema;
2270
- };
2271
- type ValidateProductPriceFactoryBulkJobParam = {
2272
- /**
2273
- * - An `id` is a unique identifier for a particular price factory.
2274
- */
2275
- id: string;
2276
- /**
2277
- * - A `job_id` is a unique identifier for a particular bulk job.
2278
- */
2279
- jobId: string;
2280
- body: CatalogPlatformModel.CreateAppPriceFactoryProductBulkJobRequest;
2281
- };
2282
1362
  type DeleteSearchConfigurationParam = any;
2283
- type ExportSynonymsParam = any;
1363
+ type GetAllSearchKeywordParam = any;
2284
1364
  type GetAppReturnConfigurationParam = any;
2285
- type GetAutocompleteSettingsParam = any;
1365
+ type GetAutocompleteConfigParam = any;
2286
1366
  type GetCatalogConfigurationParam = any;
2287
1367
  type GetConfigurationsParam = any;
2288
1368
  type GetDepartmentsParam = any;
2289
1369
  type GetQueryFiltersParam = any;
2290
1370
  type GetSearchConfigurationParam = any;
2291
- type GetSearchRerankParam = any;
2292
1371
  import CatalogPlatformModel = require("./CatalogPlatformModel");