@gofynd/fdk-client-javascript 1.1.6 → 1.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 (321) hide show
  1. package/README.md +12 -0
  2. package/index.js +0 -3
  3. package/package.json +1 -1
  4. package/sdk/application/ApplicationAPIClient.d.ts +15 -1
  5. package/sdk/application/ApplicationAPIClient.js +8 -1
  6. package/sdk/application/ApplicationClient.d.ts +37 -6
  7. package/sdk/application/ApplicationClient.js +31 -0
  8. package/sdk/application/ApplicationConfig.d.ts +52 -12
  9. package/sdk/application/ApplicationConfig.js +37 -2
  10. package/sdk/application/ApplicationModels.d.ts +46 -1
  11. package/sdk/application/ApplicationModels.js +18 -0
  12. package/sdk/application/Cart/CartApplicationClient.d.ts +172 -357
  13. package/sdk/application/Cart/CartApplicationClient.js +620 -483
  14. package/sdk/application/Cart/CartApplicationModel.d.ts +2054 -96
  15. package/sdk/application/Cart/CartApplicationModel.js +1224 -93
  16. package/sdk/application/Cart/CartApplicationValidator.d.ts +508 -30
  17. package/sdk/application/Cart/CartApplicationValidator.js +270 -15
  18. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +234 -413
  19. package/sdk/application/Catalog/CatalogApplicationClient.js +777 -630
  20. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2218 -117
  21. package/sdk/application/Catalog/CatalogApplicationModel.js +1499 -170
  22. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +798 -31
  23. package/sdk/application/Catalog/CatalogApplicationValidator.js +318 -3
  24. package/sdk/application/Common/CommonApplicationClient.d.ts +14 -21
  25. package/sdk/application/Common/CommonApplicationClient.js +50 -33
  26. package/sdk/application/Common/CommonApplicationModel.d.ts +448 -19
  27. package/sdk/application/Common/CommonApplicationModel.js +224 -16
  28. package/sdk/application/Common/CommonApplicationValidator.d.ts +42 -4
  29. package/sdk/application/Common/CommonApplicationValidator.js +21 -3
  30. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +25 -18
  31. package/sdk/application/Communication/CommunicationApplicationClient.js +74 -47
  32. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +190 -14
  33. package/sdk/application/Communication/CommunicationApplicationModel.js +124 -7
  34. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +27 -4
  35. package/sdk/application/Communication/CommunicationApplicationValidator.js +21 -5
  36. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +113 -112
  37. package/sdk/application/Configuration/ConfigurationApplicationClient.js +381 -260
  38. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +2453 -110
  39. package/sdk/application/Configuration/ConfigurationApplicationModel.js +1254 -108
  40. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +160 -8
  41. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +88 -4
  42. package/sdk/application/Content/ContentApplicationClient.d.ts +120 -138
  43. package/sdk/application/Content/ContentApplicationClient.js +409 -277
  44. package/sdk/application/Content/ContentApplicationModel.d.ts +1627 -105
  45. package/sdk/application/Content/ContentApplicationModel.js +1202 -109
  46. package/sdk/application/Content/ContentApplicationValidator.d.ts +214 -12
  47. package/sdk/application/Content/ContentApplicationValidator.js +113 -3
  48. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +20 -29
  49. package/sdk/application/FileStorage/FileStorageApplicationClient.js +68 -47
  50. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +299 -20
  51. package/sdk/application/FileStorage/FileStorageApplicationModel.js +209 -16
  52. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +55 -5
  53. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +33 -6
  54. package/sdk/application/Lead/LeadApplicationClient.d.ts +50 -53
  55. package/sdk/application/Lead/LeadApplicationClient.js +169 -103
  56. package/sdk/application/Lead/LeadApplicationModel.d.ts +1405 -54
  57. package/sdk/application/Lead/LeadApplicationModel.js +619 -73
  58. package/sdk/application/Lead/LeadApplicationValidator.d.ts +91 -9
  59. package/sdk/application/Lead/LeadApplicationValidator.js +51 -6
  60. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +34 -33
  61. package/sdk/application/Logistic/LogisticApplicationClient.js +110 -73
  62. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +399 -28
  63. package/sdk/application/Logistic/LogisticApplicationModel.js +293 -24
  64. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +48 -6
  65. package/sdk/application/Logistic/LogisticApplicationValidator.js +34 -6
  66. package/sdk/application/Order/OrderApplicationClient.d.ts +81 -133
  67. package/sdk/application/Order/OrderApplicationClient.js +297 -217
  68. package/sdk/application/Order/OrderApplicationModel.d.ts +1101 -66
  69. package/sdk/application/Order/OrderApplicationModel.js +776 -57
  70. package/sdk/application/Order/OrderApplicationValidator.d.ts +249 -14
  71. package/sdk/application/Order/OrderApplicationValidator.js +114 -5
  72. package/sdk/application/Payment/PaymentApplicationClient.d.ts +341 -356
  73. package/sdk/application/Payment/PaymentApplicationClient.js +1077 -703
  74. package/sdk/application/Payment/PaymentApplicationModel.d.ts +3125 -99
  75. package/sdk/application/Payment/PaymentApplicationModel.js +1158 -62
  76. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +494 -41
  77. package/sdk/application/Payment/PaymentApplicationValidator.js +297 -25
  78. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +178 -350
  79. package/sdk/application/PosCart/PosCartApplicationClient.js +636 -491
  80. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1823 -89
  81. package/sdk/application/PosCart/PosCartApplicationModel.js +1117 -85
  82. package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +480 -29
  83. package/sdk/application/PosCart/PosCartApplicationValidator.js +262 -15
  84. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +49 -47
  85. package/sdk/application/Rewards/RewardsApplicationClient.js +160 -102
  86. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +343 -22
  87. package/sdk/application/Rewards/RewardsApplicationModel.js +230 -15
  88. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +70 -7
  89. package/sdk/application/Rewards/RewardsApplicationValidator.js +45 -6
  90. package/sdk/application/Share/ShareApplicationClient.d.ts +44 -50
  91. package/sdk/application/Share/ShareApplicationClient.js +165 -97
  92. package/sdk/application/Share/ShareApplicationModel.d.ts +230 -15
  93. package/sdk/application/Share/ShareApplicationModel.js +154 -16
  94. package/sdk/application/Share/ShareApplicationValidator.d.ts +86 -8
  95. package/sdk/application/Share/ShareApplicationValidator.js +48 -4
  96. package/sdk/application/Theme/ThemeApplicationClient.d.ts +25 -27
  97. package/sdk/application/Theme/ThemeApplicationClient.js +83 -54
  98. package/sdk/application/Theme/ThemeApplicationModel.d.ts +621 -48
  99. package/sdk/application/Theme/ThemeApplicationModel.js +464 -40
  100. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +49 -5
  101. package/sdk/application/Theme/ThemeApplicationValidator.js +26 -3
  102. package/sdk/application/User/UserApplicationClient.d.ts +219 -303
  103. package/sdk/application/User/UserApplicationClient.js +819 -522
  104. package/sdk/application/User/UserApplicationModel.d.ts +1390 -101
  105. package/sdk/application/User/UserApplicationModel.js +983 -44
  106. package/sdk/application/User/UserApplicationValidator.d.ts +457 -33
  107. package/sdk/application/User/UserApplicationValidator.js +265 -31
  108. package/sdk/common/AxiosHelper.js +8 -2
  109. package/sdk/common/Paginator.d.ts +27 -12
  110. package/sdk/common/Paginator.js +15 -0
  111. package/sdk/common/RequestSigner.js +0 -1
  112. package/sdk/partner/PartnerAPIClient.d.ts +15 -1
  113. package/sdk/partner/PartnerAPIClient.js +8 -1
  114. package/sdk/partner/PartnerClient.d.ts +20 -3
  115. package/sdk/partner/PartnerClient.js +17 -0
  116. package/sdk/partner/PartnerConfig.d.ts +40 -14
  117. package/sdk/partner/PartnerConfig.js +31 -6
  118. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +26 -25
  119. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +82 -53
  120. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +202 -17
  121. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +139 -10
  122. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +42 -5
  123. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +26 -4
  124. package/sdk/platform/Billing/BillingPlatformClient.d.ts +88 -97
  125. package/sdk/platform/Billing/BillingPlatformClient.js +310 -191
  126. package/sdk/platform/Billing/BillingPlatformModel.d.ts +1211 -68
  127. package/sdk/platform/Billing/BillingPlatformModel.js +824 -59
  128. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +153 -12
  129. package/sdk/platform/Billing/BillingPlatformValidator.js +87 -8
  130. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +392 -634
  131. package/sdk/platform/Cart/CartPlatformApplicationClient.js +1480 -957
  132. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +827 -57
  133. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +492 -34
  134. package/sdk/platform/Cart/CartPlatformModel.d.ts +3639 -175
  135. package/sdk/platform/Cart/CartPlatformModel.js +2368 -212
  136. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +438 -615
  137. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1449 -984
  138. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1081 -49
  139. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +482 -23
  140. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +573 -824
  141. package/sdk/platform/Catalog/CatalogPlatformClient.js +1773 -1264
  142. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6871 -326
  143. package/sdk/platform/Catalog/CatalogPlatformModel.js +4215 -349
  144. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1331 -71
  145. package/sdk/platform/Catalog/CatalogPlatformValidator.js +611 -30
  146. package/sdk/platform/Common/CommonPlatformClient.d.ts +14 -21
  147. package/sdk/platform/Common/CommonPlatformClient.js +48 -33
  148. package/sdk/platform/Common/CommonPlatformModel.d.ts +448 -19
  149. package/sdk/platform/Common/CommonPlatformModel.js +224 -16
  150. package/sdk/platform/Common/CommonPlatformValidator.d.ts +42 -4
  151. package/sdk/platform/Common/CommonPlatformValidator.js +21 -3
  152. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +457 -279
  153. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +1423 -553
  154. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +581 -42
  155. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +294 -22
  156. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +18 -5
  157. package/sdk/platform/Communication/CommunicationPlatformClient.js +58 -19
  158. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1630 -102
  159. package/sdk/platform/Communication/CommunicationPlatformModel.js +1150 -85
  160. package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +16 -3
  161. package/sdk/platform/Communication/CommunicationPlatformValidator.js +11 -3
  162. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +102 -111
  163. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +321 -225
  164. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +830 -43
  165. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +612 -78
  166. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +180 -13
  167. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +98 -10
  168. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +232 -212
  169. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +737 -438
  170. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +293 -22
  171. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +184 -17
  172. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +166 -178
  173. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +519 -310
  174. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +4504 -188
  175. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2242 -204
  176. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +332 -19
  177. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +153 -10
  178. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +495 -560
  179. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1777 -987
  180. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +872 -62
  181. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +487 -35
  182. package/sdk/platform/Content/ContentPlatformModel.d.ts +1661 -108
  183. package/sdk/platform/Content/ContentPlatformModel.js +1217 -113
  184. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +67 -101
  185. package/sdk/platform/Discount/DiscountPlatformClient.js +240 -176
  186. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +242 -15
  187. package/sdk/platform/Discount/DiscountPlatformModel.js +162 -10
  188. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +185 -13
  189. package/sdk/platform/Discount/DiscountPlatformValidator.js +88 -8
  190. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +32 -41
  191. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +106 -74
  192. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +77 -6
  193. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +41 -6
  194. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +39 -54
  195. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +124 -99
  196. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +299 -20
  197. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +207 -16
  198. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +98 -8
  199. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +54 -7
  200. package/sdk/platform/Finance/FinancePlatformClient.d.ts +85 -91
  201. package/sdk/platform/Finance/FinancePlatformClient.js +272 -180
  202. package/sdk/platform/Finance/FinancePlatformModel.d.ts +619 -50
  203. package/sdk/platform/Finance/FinancePlatformModel.js +458 -30
  204. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +123 -15
  205. package/sdk/platform/Finance/FinancePlatformValidator.js +95 -16
  206. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +99 -97
  207. package/sdk/platform/Inventory/InventoryPlatformClient.js +288 -199
  208. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +1354 -61
  209. package/sdk/platform/Inventory/InventoryPlatformModel.js +916 -83
  210. package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +168 -12
  211. package/sdk/platform/Inventory/InventoryPlatformValidator.js +82 -6
  212. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +86 -106
  213. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +326 -186
  214. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +180 -14
  215. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +94 -9
  216. package/sdk/platform/Lead/LeadPlatformClient.d.ts +75 -101
  217. package/sdk/platform/Lead/LeadPlatformClient.js +240 -174
  218. package/sdk/platform/Lead/LeadPlatformModel.d.ts +1403 -54
  219. package/sdk/platform/Lead/LeadPlatformModel.js +618 -73
  220. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +173 -12
  221. package/sdk/platform/Lead/LeadPlatformValidator.js +85 -8
  222. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +18 -14
  223. package/sdk/platform/Order/OrderPlatformApplicationClient.js +56 -29
  224. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +26 -4
  225. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +16 -3
  226. package/sdk/platform/Order/OrderPlatformClient.d.ts +343 -556
  227. package/sdk/platform/Order/OrderPlatformClient.js +969 -762
  228. package/sdk/platform/Order/OrderPlatformModel.d.ts +4967 -247
  229. package/sdk/platform/Order/OrderPlatformModel.js +3249 -259
  230. package/sdk/platform/Order/OrderPlatformValidator.d.ts +758 -37
  231. package/sdk/platform/Order/OrderPlatformValidator.js +351 -22
  232. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +28 -36
  233. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +103 -59
  234. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +66 -6
  235. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +32 -4
  236. package/sdk/platform/Partner/PartnerPlatformClient.d.ts +68 -107
  237. package/sdk/platform/Partner/PartnerPlatformClient.js +253 -174
  238. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +767 -45
  239. package/sdk/platform/Partner/PartnerPlatformModel.js +524 -41
  240. package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +207 -13
  241. package/sdk/platform/Partner/PartnerPlatformValidator.js +87 -5
  242. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +255 -260
  243. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +860 -504
  244. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +348 -30
  245. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +221 -19
  246. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +73 -73
  247. package/sdk/platform/Payment/PaymentPlatformClient.js +238 -154
  248. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2658 -93
  249. package/sdk/platform/Payment/PaymentPlatformModel.js +1035 -36
  250. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +111 -11
  251. package/sdk/platform/Payment/PaymentPlatformValidator.js +68 -7
  252. package/sdk/platform/PlatformAPIClient.d.ts +16 -1
  253. package/sdk/platform/PlatformAPIClient.js +9 -1
  254. package/sdk/platform/PlatformApplicationClient.d.ts +22 -1798
  255. package/sdk/platform/PlatformApplicationClient.js +17 -1899
  256. package/sdk/platform/PlatformClient.d.ts +29 -12579
  257. package/sdk/platform/PlatformClient.js +26 -15085
  258. package/sdk/platform/PlatformConfig.d.ts +37 -11
  259. package/sdk/platform/PlatformConfig.js +32 -6
  260. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +80 -92
  261. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +307 -177
  262. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +149 -12
  263. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +82 -8
  264. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +371 -23
  265. package/sdk/platform/Rewards/RewardsPlatformModel.js +246 -16
  266. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +120 -89
  267. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +349 -201
  268. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +128 -12
  269. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +85 -11
  270. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +148 -178
  271. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +454 -329
  272. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1399 -96
  273. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1022 -71
  274. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +280 -18
  275. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +134 -11
  276. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +38 -47
  277. package/sdk/platform/Share/SharePlatformApplicationClient.js +137 -73
  278. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +87 -7
  279. package/sdk/platform/Share/SharePlatformApplicationValidator.js +42 -5
  280. package/sdk/platform/Share/SharePlatformModel.d.ts +250 -16
  281. package/sdk/platform/Share/SharePlatformModel.js +165 -17
  282. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +149 -183
  283. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +579 -330
  284. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +308 -24
  285. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +162 -10
  286. package/sdk/platform/Theme/ThemePlatformModel.d.ts +621 -48
  287. package/sdk/platform/Theme/ThemePlatformModel.js +464 -40
  288. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +119 -151
  289. package/sdk/platform/User/UserPlatformApplicationClient.js +411 -244
  290. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +235 -18
  291. package/sdk/platform/User/UserPlatformApplicationValidator.js +126 -12
  292. package/sdk/platform/User/UserPlatformModel.d.ts +1390 -101
  293. package/sdk/platform/User/UserPlatformModel.js +983 -44
  294. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +38 -47
  295. package/sdk/platform/Webhook/WebhookPlatformClient.js +137 -87
  296. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +242 -16
  297. package/sdk/platform/Webhook/WebhookPlatformModel.js +167 -18
  298. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +83 -7
  299. package/sdk/platform/Webhook/WebhookPlatformValidator.js +43 -5
  300. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -21
  301. package/sdk/public/Configuration/ConfigurationPublicClient.js +46 -33
  302. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +473 -19
  303. package/sdk/public/Configuration/ConfigurationPublicModel.js +224 -16
  304. package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +42 -4
  305. package/sdk/public/Configuration/ConfigurationPublicValidator.js +21 -3
  306. package/sdk/public/Inventory/InventoryPublicClient.d.ts +48 -48
  307. package/sdk/public/Inventory/InventoryPublicClient.js +146 -98
  308. package/sdk/public/Inventory/InventoryPublicModel.d.ts +392 -21
  309. package/sdk/public/Inventory/InventoryPublicModel.js +267 -27
  310. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +90 -8
  311. package/sdk/public/Inventory/InventoryPublicValidator.js +44 -4
  312. package/sdk/public/PublicClient.d.ts +19 -3
  313. package/sdk/public/PublicClient.js +16 -0
  314. package/sdk/public/PublicConfig.d.ts +27 -6
  315. package/sdk/public/PublicConfig.js +17 -1
  316. package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -11
  317. package/sdk/public/Webhook/WebhookPublicClient.js +42 -27
  318. package/sdk/public/Webhook/WebhookPublicModel.d.ts +242 -16
  319. package/sdk/public/Webhook/WebhookPublicModel.js +167 -18
  320. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +18 -3
  321. package/sdk/public/Webhook/WebhookPublicValidator.js +14 -4
@@ -4,236 +4,187 @@ declare class Catalog {
4
4
  config: any;
5
5
  applicationId: any;
6
6
  /**
7
- * @param {Object} arg - Arg object.
8
- * @param {string} arg.id - A `id` is a unique identifier of a collection.
9
- * @param {CollectionItemUpdate} arg.body
10
- * @returns {Promise<UpdatedResponse>} - Success response
7
+ * @param {CatalogPlatformApplicationValidator.AddCollectionItemsParam} arg
8
+ * - Arg object
9
+ *
10
+ * @param {import("../PlatformAPIClient").Options} - Options
11
+ * @returns {Promise<CatalogPlatformModel.UpdatedResponse>} - Success response
12
+ * @name addCollectionItems
11
13
  * @summary: Add items to a collection
12
- * @description: Adds items to a collection specified by its `id`. See `CollectionItemRequest` for the list of attributes needed to add items to an collection.
14
+ * @description: Adds items to a collection specified by its `id`. See `CollectionItemRequest` for the list of attributes needed to add items to an collection. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/addCollectionItems/).
13
15
  */
14
- addCollectionItems({ id, body }?: {
15
- id: string;
16
- body: CollectionItemUpdate;
17
- }): Promise<UpdatedResponse>;
16
+ addCollectionItems({ id, body }?: CatalogPlatformApplicationValidator.AddCollectionItemsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.UpdatedResponse>;
18
17
  /**
19
- * @param {Object} arg - Arg object.
20
- * @param {CreateCollection} arg.body
21
- * @returns {Promise<CollectionCreateResponse>} - Success response
18
+ * @param {CatalogPlatformApplicationValidator.CreateCollectionParam} arg - Arg object
19
+ * @param {import("../PlatformAPIClient").Options} - Options
20
+ * @returns {Promise<CatalogPlatformModel.CollectionCreateResponse>} -
21
+ * Success response
22
+ * @name createCollection
22
23
  * @summary: Add a Collection
23
- * @description: Create a collection. See `CreateCollectionRequestSchema` for the list of attributes needed to create a collection and collections/query-options for the available options to create a collection. On successful request, returns a paginated list of collections specified in `CollectionCreateResponse`
24
+ * @description: Create a collection. See `CreateCollectionRequestSchema` for the list of attributes needed to create a collection and collections/query-options for the available options to create a collection. On successful request, returns a paginated list of collections specified in `CollectionCreateResponse` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCollection/).
24
25
  */
25
- createCollection({ body }?: {
26
- body: CreateCollection;
27
- }): Promise<CollectionCreateResponse>;
26
+ createCollection({ body }?: CatalogPlatformApplicationValidator.CreateCollectionParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.CollectionCreateResponse>;
28
27
  /**
29
- * @param {Object} arg - Arg object.
30
- * @param {string} arg.type - Type can be brands, categories etc.
31
- * @param {AppConfiguration} arg.body
32
- * @returns {Promise<GetAppCatalogConfiguration>} - Success response
28
+ * @param {CatalogPlatformApplicationValidator.CreateConfigurationByTypeParam} arg
29
+ * - Arg object
30
+ *
31
+ * @param {import("../PlatformAPIClient").Options} - Options
32
+ * @returns {Promise<CatalogPlatformModel.GetAppCatalogConfiguration>} -
33
+ * Success response
34
+ * @name createConfigurationByType
33
35
  * @summary: Add configuration for categories and brands
34
- * @description: Add configuration for categories & brands.
36
+ * @description: Add configuration for categories & brands. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createConfigurationByType/).
35
37
  */
36
- createConfigurationByType({ type, body }?: {
37
- type: string;
38
- body: AppConfiguration;
39
- }): Promise<GetAppCatalogConfiguration>;
38
+ createConfigurationByType({ type, body }?: CatalogPlatformApplicationValidator.CreateConfigurationByTypeParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.GetAppCatalogConfiguration>;
40
39
  /**
41
- * @param {Object} arg - Arg object.
42
- * @param {AppConfiguration} arg.body
43
- * @returns {Promise<GetAppCatalogConfiguration>} - Success response
40
+ * @param {CatalogPlatformApplicationValidator.CreateConfigurationProductListingParam} arg
41
+ * - Arg object
42
+ *
43
+ * @param {import("../PlatformAPIClient").Options} - Options
44
+ * @returns {Promise<CatalogPlatformModel.GetAppCatalogConfiguration>} -
45
+ * Success response
46
+ * @name createConfigurationProductListing
44
47
  * @summary: Add configuration for products & listings
45
- * @description: Add configuration for products & listing.
46
- */
47
- createConfigurationProductListing({ body }?: {
48
- body: AppConfiguration;
49
- }): Promise<GetAppCatalogConfiguration>;
50
- /**
51
- * @param {Object} arg - Arg object.
52
- * @param {CreateAutocompleteKeyword} arg.body
53
- * @returns {Promise<CreateAutocompleteWordsResponse>} - Success response
48
+ * @description: Add configuration for products & listing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createConfigurationProductListing/).
49
+ */
50
+ createConfigurationProductListing({ body }?: CatalogPlatformApplicationValidator.CreateConfigurationProductListingParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.GetAppCatalogConfiguration>;
51
+ /**
52
+ * @param {CatalogPlatformApplicationValidator.CreateCustomAutocompleteRuleParam} arg
53
+ * - Arg object
54
+ *
55
+ * @param {import("../PlatformAPIClient").Options} - Options
56
+ * @returns {Promise<CatalogPlatformModel.CreateAutocompleteWordsResponse>}
57
+ * - Success response
58
+ *
59
+ * @name createCustomAutocompleteRule
54
60
  * @summary: Add a Custom Autocomplete Keywords
55
- * @description: Create a Custom Autocomplete Keywords. See `CreateAutocompleteKeywordSchema` for the list of attributes needed to create a mapping and /collections/query-options for the available options to create a rule. On successful request, returns a paginated list of collections specified in `CreateAutocompleteKeywordSchema`
61
+ * @description: Create a Custom Autocomplete Keywords. See `CreateAutocompleteKeywordSchema` for the list of attributes needed to create a mapping and /collections/query-options for the available options to create a rule. On successful request, returns a paginated list of collections specified in `CreateAutocompleteKeywordSchema` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCustomAutocompleteRule/).
56
62
  */
57
- createCustomAutocompleteRule({ body }?: {
58
- body: CreateAutocompleteKeyword;
59
- }): Promise<CreateAutocompleteWordsResponse>;
63
+ createCustomAutocompleteRule({ body }?: CatalogPlatformApplicationValidator.CreateCustomAutocompleteRuleParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.CreateAutocompleteWordsResponse>;
60
64
  /**
61
- * @param {Object} arg - Arg object.
62
- * @param {CreateSearchKeyword} arg.body
63
- * @returns {Promise<GetSearchWordsData>} - Success response
65
+ * @param {CatalogPlatformApplicationValidator.CreateCustomKeywordParam} arg
66
+ * - Arg object
67
+ *
68
+ * @param {import("../PlatformAPIClient").Options} - Options
69
+ * @returns {Promise<CatalogPlatformModel.GetSearchWordsData>} - Success response
70
+ * @name createCustomKeyword
64
71
  * @summary: Add a Custom Search Keywords
65
- * @description: Create a Custom Search Keywords. See `CreateSearchKeywordSchema` for the list of attributes needed to create a mapping and /collections/query-options for the available options to create a rule. On successful request, returns a paginated list of collections specified in `CreateSearchKeywordSchema`
72
+ * @description: Create a Custom Search Keywords. See `CreateSearchKeywordSchema` for the list of attributes needed to create a mapping and /collections/query-options for the available options to create a rule. On successful request, returns a paginated list of collections specified in `CreateSearchKeywordSchema` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCustomKeyword/).
66
73
  */
67
- createCustomKeyword({ body }?: {
68
- body: CreateSearchKeyword;
69
- }): Promise<GetSearchWordsData>;
74
+ createCustomKeyword({ body }?: CatalogPlatformApplicationValidator.CreateCustomKeywordParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.GetSearchWordsData>;
70
75
  /**
71
- * @param {Object} arg - Arg object.
72
- * @param {string} arg.configType - A `config_type` is a unique identifier
73
- * for a particular group configuration type.
74
- * @param {AppConfigurationDetail} arg.body
75
- * @returns {Promise<AppConfigurationDetail>} - Success response
76
+ * @param {CatalogPlatformApplicationValidator.CreateGroupConfigurationParam} arg
77
+ * - Arg object
78
+ *
79
+ * @param {import("../PlatformAPIClient").Options} - Options
80
+ * @returns {Promise<CatalogPlatformModel.AppConfigurationDetail>} - Success response
81
+ * @name createGroupConfiguration
76
82
  * @summary: Create configuration for Group config types.
77
- * @description: Create configuration for Group config types.
83
+ * @description: Create configuration for Group config types. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createGroupConfiguration/).
78
84
  */
79
- createGroupConfiguration({ configType, body }?: {
80
- configType: string;
81
- body: AppConfigurationDetail;
82
- }): Promise<AppConfigurationDetail>;
85
+ createGroupConfiguration({ configType, body }?: CatalogPlatformApplicationValidator.CreateGroupConfigurationParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.AppConfigurationDetail>;
83
86
  /**
84
- * @param {Object} arg - Arg object.
85
- * @param {string} arg.configType - A `config_type` is a unique identifier
86
- * for a particular listing configuration type.
87
- * @param {AppConfigurationsSort} arg.body
88
- * @returns {Promise<AppConfigurationsSort>} - Success response
87
+ * @param {CatalogPlatformApplicationValidator.CreateListingConfigurationParam} arg
88
+ * - Arg object
89
+ *
90
+ * @param {import("../PlatformAPIClient").Options} - Options
91
+ * @returns {Promise<CatalogPlatformModel.AppConfigurationsSort>} - Success response
92
+ * @name createListingConfiguration
89
93
  * @summary: Add configuration for listings
90
- * @description: Add configuration for listing.
94
+ * @description: Add configuration for listing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createListingConfiguration/).
91
95
  */
92
- createListingConfiguration({ configType, body }?: {
93
- configType: string;
94
- body: AppConfigurationsSort;
95
- }): Promise<AppConfigurationsSort>;
96
+ createListingConfiguration({ configType, body }?: CatalogPlatformApplicationValidator.CreateListingConfigurationParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.AppConfigurationsSort>;
96
97
  /**
97
- * @param {Object} arg - Arg object.
98
- * @param {string} arg.id - A `id` is a unique identifier for a particular
99
- * detail. Pass the `id` of the keywords which you want to delete.
100
- * @returns {Promise<DeleteResponse>} - Success response
98
+ * @param {CatalogPlatformApplicationValidator.DeleteAutocompleteKeywordParam} arg
99
+ * - Arg object
100
+ *
101
+ * @param {import("../PlatformAPIClient").Options} - Options
102
+ * @returns {Promise<CatalogPlatformModel.DeleteResponse>} - Success response
103
+ * @name deleteAutocompleteKeyword
101
104
  * @summary: Delete a Autocomplete Keywords
102
- * @description: Delete a keywords by it's id. Returns an object that tells whether the keywords was deleted successfully
105
+ * @description: Delete a keywords by it's id. Returns an object that tells whether the keywords was deleted successfully - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteAutocompleteKeyword/).
103
106
  */
104
- deleteAutocompleteKeyword({ id }?: {
105
- id: string;
106
- }): Promise<DeleteResponse>;
107
+ deleteAutocompleteKeyword({ id }?: CatalogPlatformApplicationValidator.DeleteAutocompleteKeywordParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.DeleteResponse>;
107
108
  /**
108
- * @param {Object} arg - Arg object.
109
- * @param {string} arg.id - A `id` is a unique identifier of a collection.
110
- * @returns {Promise<DeleteResponse>} - Success response
109
+ * @param {CatalogPlatformApplicationValidator.DeleteCollectionParam} arg - Arg object
110
+ * @param {import("../PlatformAPIClient").Options} - Options
111
+ * @returns {Promise<CatalogPlatformModel.DeleteResponse>} - Success response
112
+ * @name deleteCollection
111
113
  * @summary: Delete a Collection
112
- * @description: Delete a collection by it's id. Returns an object that tells whether the collection was deleted successfully
114
+ * @description: Delete a collection by it's id. Returns an object that tells whether the collection was deleted successfully - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteCollection/).
113
115
  */
114
- deleteCollection({ id }?: {
115
- id: string;
116
- }): Promise<DeleteResponse>;
116
+ deleteCollection({ id }?: CatalogPlatformApplicationValidator.DeleteCollectionParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.DeleteResponse>;
117
117
  /**
118
- * @param {Object} arg - Arg object.
119
- * @param {string} arg.configType - A `config_type` is a unique identifier
120
- * for a particular group configuration type.
121
- * @param {string} arg.groupSlug - A `group_slug` is a unique identifier of
122
- * a particular configuration.
123
- * @returns {Promise<ConfigSuccessResponse>} - Success response
118
+ * @param {CatalogPlatformApplicationValidator.DeleteGroupConfigurationParam} arg
119
+ * - Arg object
120
+ *
121
+ * @param {import("../PlatformAPIClient").Options} - Options
122
+ * @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
123
+ * @name deleteGroupConfiguration
124
124
  * @summary: Delete configuration of the product config type of the application.
125
- * @description: Delete configuration of the product config type of the application.
125
+ * @description: Delete configuration of the product config type of the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteGroupConfiguration/).
126
126
  */
127
- deleteGroupConfiguration({ configType, groupSlug }?: {
128
- configType: string;
129
- groupSlug: string;
130
- }): Promise<ConfigSuccessResponse>;
127
+ deleteGroupConfiguration({ configType, groupSlug }?: CatalogPlatformApplicationValidator.DeleteGroupConfigurationParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.ConfigSuccessResponse>;
131
128
  /**
132
- * @param {Object} arg - Arg object.
133
- * @param {string} arg.configType - A `config_type` is a unique identifier
134
- * for a particular listing configuration type.
135
- * @param {string} arg.configId - A `config_id` is a unique identifier of a
136
- * particular configuration.
137
- * @returns {Promise<ConfigSuccessResponse>} - Success response
129
+ * @param {CatalogPlatformApplicationValidator.DeleteListingConfigurationParam} arg
130
+ * - Arg object
131
+ *
132
+ * @param {import("../PlatformAPIClient").Options} - Options
133
+ * @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
134
+ * @name deleteListingConfiguration
138
135
  * @summary: Delete configuration for listings
139
- * @description: Delete configuration for listing.
136
+ * @description: Delete configuration for listing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteListingConfiguration/).
140
137
  */
141
- deleteListingConfiguration({ configType, configId }?: {
142
- configType: string;
143
- configId: string;
144
- }): Promise<ConfigSuccessResponse>;
138
+ deleteListingConfiguration({ configType, configId }?: CatalogPlatformApplicationValidator.DeleteListingConfigurationParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.ConfigSuccessResponse>;
145
139
  /**
146
- * @param {Object} arg - Arg object.
147
- * @param {string} arg.id - A `id` is a unique identifier for a particular
148
- * detail. Pass the `id` of the keywords which you want to delete.
149
- * @returns {Promise<DeleteResponse>} - Success response
140
+ * @param {CatalogPlatformApplicationValidator.DeleteSearchKeywordsParam} arg
141
+ * - Arg object
142
+ *
143
+ * @param {import("../PlatformAPIClient").Options} - Options
144
+ * @returns {Promise<CatalogPlatformModel.DeleteResponse>} - Success response
145
+ * @name deleteSearchKeywords
150
146
  * @summary: Delete a Search Keywords
151
- * @description: Delete a keywords by it's id. Returns an object that tells whether the keywords was deleted successfully
147
+ * @description: Delete a keywords by it's id. Returns an object that tells whether the keywords was deleted successfully - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteSearchKeywords/).
152
148
  */
153
- deleteSearchKeywords({ id }?: {
154
- id: string;
155
- }): Promise<DeleteResponse>;
149
+ deleteSearchKeywords({ id }?: CatalogPlatformApplicationValidator.DeleteSearchKeywordsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.DeleteResponse>;
156
150
  /**
157
- * @param {Object} arg - Arg object.
158
- * @param {string} [arg.q] - Get collection list filtered by q string,
159
- * @param {string} [arg.scheduleStatus] - Get collection list filtered by
160
- * scheduled status,
161
- * @param {string} [arg.type] - Type of the collections
162
- * @param {string[]} [arg.tags] - Each response will contain next_id param,
163
- * which should be sent back to make pagination work.
164
- * @param {boolean} [arg.isActive] - Get collections filtered by active status.
165
- * @param {number} [arg.pageNo] - The page number to navigate through the
166
- * given set of results.
167
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
168
- * page. Default is 12.
169
- * @returns {Promise<GetCollectionListingResponse>} - Success response
151
+ * @param {CatalogPlatformApplicationValidator.GetAllCollectionsParam} arg
152
+ * - Arg object
153
+ *
154
+ * @param {import("../PlatformAPIClient").Options} - Options
155
+ * @returns {Promise<CatalogPlatformModel.GetCollectionListingResponse>} -
156
+ * Success response
157
+ * @name getAllCollections
170
158
  * @summary: List all the collections
171
- * @description: A Collection allows you to organize your products into hierarchical groups. For example, a dress might be in the category _Clothing_, the individual product might also be in the collection _Summer_. On successful request, returns all the collections as specified in `CollectionListingSchema`
159
+ * @description: A Collection allows you to organize your products into hierarchical groups. For example, a dress might be in the category _Clothing_, the individual product might also be in the collection _Summer_. On successful request, returns all the collections as specified in `CollectionListingSchema` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllCollections/).
172
160
  */
173
- getAllCollections({ q, scheduleStatus, type, tags, isActive, pageNo, pageSize, }?: {
174
- q?: string;
175
- scheduleStatus?: string;
176
- type?: string;
177
- tags?: string[];
178
- isActive?: boolean;
179
- pageNo?: number;
180
- pageSize?: number;
181
- }): Promise<GetCollectionListingResponse>;
161
+ getAllCollections({ q, scheduleStatus, type, tags, isActive, pageNo, pageSize }?: CatalogPlatformApplicationValidator.GetAllCollectionsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.GetCollectionListingResponse>;
182
162
  /**
183
- * @param {Object} arg - Arg object.
184
- * @returns {Promise<GetSearchWordsResponse>} - Success response
163
+ * @param {import("../PlatformAPIClient").Options} - Options
164
+ * @returns {Promise<CatalogPlatformModel.GetSearchWordsResponse>} - Success response
165
+ * @name getAllSearchKeyword
185
166
  * @summary: List all Search Custom Keyword Listing
186
- * @description: Custom Search Keyword allows you to map conditions with keywords to give you the ultimate results
167
+ * @description: Custom Search Keyword allows you to map conditions with keywords to give you the ultimate results - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllSearchKeyword/).
187
168
  */
188
- getAllSearchKeyword({}?: any): Promise<GetSearchWordsResponse>;
169
+ getAllSearchKeyword({ headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.GetSearchWordsResponse>;
189
170
  /**
190
- * @param {Object} arg - Arg object.
191
- * @param {number[]} [arg.itemIds] - The Item Id of the product.
192
- * @param {number[]} [arg.storeIds] - The Store Id of products to fetch inventory.
193
- * @param {number[]} [arg.brandIds] - The Brand Id of products to fetch inventory.
194
- * @param {string[]} [arg.sellerIdentifiers] - Unique seller_identifier of
195
- * the product.
196
- * @param {string} [arg.timestamp] - Timestamp in UTC format (2020-07-23T10:27:50Z)
197
- * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
198
- * @param {string} [arg.pageId] - Page ID to retrieve next set of results.
199
- * @returns {Promise<InventoryStockResponse>} - Success response
171
+ * @param {CatalogPlatformApplicationValidator.GetAppInventoryParam} arg - Arg object
172
+ * @param {import("../PlatformAPIClient").Options} - Options
173
+ * @returns {Promise<CatalogPlatformModel.InventoryStockResponse>} - Success response
174
+ * @name getAppInventory
200
175
  * @summary: Get the stock of a product
201
- * @description: Retrieve the available Inventory of the products. Use this API to get the Inventory status of products with the filters of timestamp, store_ids, brand_ids, item_id - Items - Pagination
176
+ * @description: Retrieve the available Inventory of the products. Use this API to get the Inventory status of products with the filters of timestamp, store_ids, brand_ids, item_id - Items - Pagination - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppInventory/).
202
177
  */
203
- getAppInventory({ itemIds, storeIds, brandIds, sellerIdentifiers, timestamp, pageSize, pageId, }?: {
204
- itemIds?: number[];
205
- storeIds?: number[];
206
- brandIds?: number[];
207
- sellerIdentifiers?: string[];
208
- timestamp?: string;
209
- pageSize?: number;
210
- pageId?: string;
211
- }): Promise<InventoryStockResponse>;
178
+ getAppInventory({ itemIds, storeIds, brandIds, sellerIdentifiers, timestamp, pageSize, pageId, }?: CatalogPlatformApplicationValidator.GetAppInventoryParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.InventoryStockResponse>;
212
179
  /**
213
- * @param {Object} arg - Arg object.
214
- * @param {string} [arg.storeType] - Helps to sort the location list on the
215
- * basis of location type.
216
- * @param {number[]} [arg.uid] - Helps to sort the location list on the
217
- * basis of uid list.
218
- * @param {string} [arg.q] - Query that is to be searched.
219
- * @param {string} [arg.stage] - To filter companies on basis of verified or
220
- * unverified companies.
221
- * @param {number} [arg.pageNo] - The page number to navigate through the
222
- * given set of results
223
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
224
- * page. Default is 20.
225
- * @returns {Promise<LocationListSerializer>} - Success response
180
+ * @param {CatalogPlatformApplicationValidator.GetAppLocationsParam} arg - Arg object
181
+ * @param {import("../PlatformAPIClient").Options} - Options
182
+ * @returns {Promise<CatalogPlatformModel.LocationListSerializer>} - Success response
183
+ * @name getAppLocations
226
184
  * @summary: Get list of locations
227
- * @description: This API allows to view all the locations asscoiated to a application.
185
+ * @description: This API allows to view all the locations asscoiated to a application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppLocations/).
228
186
  */
229
- getAppLocations({ storeType, uid, q, stage, pageNo, pageSize }?: {
230
- storeType?: string;
231
- uid?: number[];
232
- q?: string;
233
- stage?: string;
234
- pageNo?: number;
235
- pageSize?: number;
236
- }): Promise<LocationListSerializer>;
187
+ getAppLocations({ storeType, uid, q, stage, pageNo, pageSize }?: CatalogPlatformApplicationValidator.GetAppLocationsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.LocationListSerializer>;
237
188
  /**
238
189
  * @param {Object} arg - Arg object.
239
190
  * @param {string} arg.companyId - Id of the company whose locations are to fetched
@@ -248,6 +199,7 @@ declare class Catalog {
248
199
  * unverified companies.
249
200
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
250
201
  * page. Default is 20.
202
+ * @returns {Paginator<CatalogPlatformModel.LocationListSerializer>}
251
203
  * @summary: Get list of locations
252
204
  * @description: This API allows to view all the locations asscoiated to a application.
253
205
  */
@@ -259,90 +211,38 @@ declare class Catalog {
259
211
  q?: string;
260
212
  stage?: string;
261
213
  pageSize?: number;
262
- }): Paginator;
214
+ }): Paginator<CatalogPlatformModel.LocationListSerializer>;
263
215
  /**
264
- * @param {Object} arg - Arg object.
265
- * @param {string} arg.itemId - Product id for a particular product.
266
- * @returns {Promise<OwnerAppItemResponse>} - Success response
216
+ * @param {CatalogPlatformApplicationValidator.GetAppProductParam} arg - Arg object
217
+ * @param {import("../PlatformAPIClient").Options} - Options
218
+ * @returns {Promise<CatalogPlatformModel.OwnerAppItemResponse>} - Success response
219
+ * @name getAppProduct
267
220
  * @summary: Get company application product data.
268
- * @description: Products are the core resource of an application. If successful, returns a Company Application Product resource in the response body depending upon filter sent.
221
+ * @description: Products are the core resource of an application. If successful, returns a Company Application Product resource in the response body depending upon filter sent. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppProduct/).
269
222
  */
270
- getAppProduct({ itemId }?: {
271
- itemId: string;
272
- }): Promise<OwnerAppItemResponse>;
223
+ getAppProduct({ itemId }?: CatalogPlatformApplicationValidator.GetAppProductParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.OwnerAppItemResponse>;
273
224
  /**
274
- * @param {Object} arg - Arg object.
275
- * @param {number[]} [arg.brandIds] - Get multiple products filtered by Brand Ids
276
- * @param {number[]} [arg.categoryIds] - Get multiple products filtered by
277
- * Category Ids
278
- * @param {number[]} [arg.departmentIds] - Get multiple products filtered by
279
- * Department Ids
280
- * @param {string[]} [arg.tags] - Get multiple products filtered by tags
281
- * @param {number[]} [arg.itemIds] - Get multiple products filtered by Item Ids
282
- * @param {number} [arg.pageNo] - The page number to navigate through the
283
- * given set of results
284
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
285
- * page. Default is 10.
286
- * @param {string} [arg.q] - Search with Item Code, Name, Slug or Identifier.
287
- * @returns {Promise<ProductListingResponse>} - Success response
225
+ * @param {CatalogPlatformApplicationValidator.GetAppProductsParam} arg - Arg object
226
+ * @param {import("../PlatformAPIClient").Options} - Options
227
+ * @returns {Promise<CatalogPlatformModel.ProductListingResponse>} - Success response
228
+ * @name getAppProducts
288
229
  * @summary: Get applicationwise products
289
- * @description: Products are the core resource of an application. Products can be associated by categories, collections, brands and more. If successful, returns a Product resource in the response body specified in `ApplicationProductListingResponseDatabasePowered`
290
- */
291
- getAppProducts({ brandIds, categoryIds, departmentIds, tags, itemIds, pageNo, pageSize, q, }?: {
292
- brandIds?: number[];
293
- categoryIds?: number[];
294
- departmentIds?: number[];
295
- tags?: string[];
296
- itemIds?: number[];
297
- pageNo?: number;
298
- pageSize?: number;
299
- q?: string;
300
- }): Promise<ProductListingResponse>;
301
- /**
302
- * @param {Object} arg - Arg object.
303
- * @param {string} [arg.q] - The search query. This can be a partial or
304
- * complete name of a either a product, brand or category
305
- * @param {string} [arg.f] - The search filter parameters. All the parameter
306
- * filtered from filter parameters will be passed in **f** parameter in
307
- * this format. **?f=brand:voi-jeans||and:::category:t-shirts||shirts**
308
- * @param {string} [arg.c] - The search filter parameters for collection
309
- * items. All the parameter filtered from filter parameters will be passed
310
- * in **c** parameter in this format.
311
- * **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
312
- * @param {boolean} [arg.filters] - Pass `filters` parameter to fetch the
313
- * filter details. This flag is used to fetch all filters
314
- * @param {boolean} [arg.isDependent] - This query parameter is used to get
315
- * the dependent products in the listing.
316
- * @param {string} [arg.sortOn] - The order to sort the list of products on.
317
- * The supported sort parameters are popularity, price, redemption and
318
- * discount in either ascending or descending order. See the supported
319
- * values below.
320
- * @param {string} [arg.pageId] - Each response will contain **page_id**
321
- * param, which should be sent back to make pagination work.
322
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
323
- * page. Default is 12.
324
- * @param {number} [arg.pageNo] - If page_type is number then pass it to
325
- * fetch page items. Default is 1.
326
- * @param {string} [arg.pageType] - For pagination type should be cursor or
327
- * number. Default is cursor.
328
- * @param {number[]} [arg.itemIds] - Item Ids of product
329
- * @returns {Promise<ApplicationProductListingResponse>} - Success response
230
+ * @description: Products are the core resource of an application. Products can be associated by categories, collections, brands and more. If successful, returns a Product resource in the response body specified in `ApplicationProductListingResponseDatabasePowered` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppProducts/).
231
+ */
232
+ getAppProducts({ brandIds, categoryIds, departmentIds, tags, itemIds, pageNo, pageSize, q, }?: CatalogPlatformApplicationValidator.GetAppProductsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.ProductListingResponse>;
233
+ /**
234
+ * @param {CatalogPlatformApplicationValidator.GetAppicationProductsParam} arg
235
+ * - Arg object
236
+ *
237
+ * @param {import("../PlatformAPIClient").Options} - Options
238
+ * @returns {Promise<CatalogPlatformModel.ApplicationProductListingResponse>}
239
+ * - Success response
240
+ *
241
+ * @name getAppicationProducts
330
242
  * @summary: List the products
331
- * @description: List all the products associated with a brand, collection or category in a requested sort order. The API additionally supports arbitrary search queries that may refer the name of any product, brand, category or collection. If successful, returns a paginated list of products specified in `ApplicationProductListingResponse`
243
+ * @description: List all the products associated with a brand, collection or category in a requested sort order. The API additionally supports arbitrary search queries that may refer the name of any product, brand, category or collection. If successful, returns a paginated list of products specified in `ApplicationProductListingResponse` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppicationProducts/).
332
244
  */
333
- getAppicationProducts({ q, f, c, filters, isDependent, sortOn, pageId, pageSize, pageNo, pageType, itemIds, }?: {
334
- q?: string;
335
- f?: string;
336
- c?: string;
337
- filters?: boolean;
338
- isDependent?: boolean;
339
- sortOn?: string;
340
- pageId?: string;
341
- pageSize?: number;
342
- pageNo?: number;
343
- pageType?: string;
344
- itemIds?: number[];
345
- }): Promise<ApplicationProductListingResponse>;
245
+ getAppicationProducts({ q, f, c, filters, isDependent, sortOn, pageId, pageSize, pageNo, pageType, itemIds, }?: CatalogPlatformApplicationValidator.GetAppicationProductsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.ApplicationProductListingResponse>;
346
246
  /**
347
247
  * @param {Object} arg - Arg object.
348
248
  * @param {string} arg.companyId - A `company_id` is a unique identifier for
@@ -369,6 +269,7 @@ declare class Catalog {
369
269
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
370
270
  * page. Default is 12.
371
271
  * @param {number[]} [arg.itemIds] - Item Ids of product
272
+ * @returns {Paginator<CatalogPlatformModel.ApplicationProductListingResponse>}
372
273
  * @summary: List the products
373
274
  * @description: List all the products associated with a brand, collection or category in a requested sort order. The API additionally supports arbitrary search queries that may refer the name of any product, brand, category or collection. If successful, returns a paginated list of products specified in `ApplicationProductListingResponse`
374
275
  */
@@ -383,24 +284,18 @@ declare class Catalog {
383
284
  sortOn?: string;
384
285
  pageSize?: number;
385
286
  itemIds?: number[];
386
- }): Paginator;
387
- /**
388
- * @param {Object} arg - Arg object.
389
- * @param {number} [arg.pageNo] - The page number to navigate through the
390
- * given set of results
391
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
392
- * page. Default is 12.
393
- * @param {string} [arg.q] - Search query with brand name.Use this parameter
394
- * to search brands by brand name.
395
- * @returns {Promise<BrandListingResponse>} - Success response
287
+ }): Paginator<CatalogPlatformModel.ApplicationProductListingResponse>;
288
+ /**
289
+ * @param {CatalogPlatformApplicationValidator.GetApplicationBrandListingParam} arg
290
+ * - Arg object
291
+ *
292
+ * @param {import("../PlatformAPIClient").Options} - Options
293
+ * @returns {Promise<CatalogPlatformModel.BrandListingResponse>} - Success response
294
+ * @name getApplicationBrandListing
396
295
  * @summary: List all the brands for the application
397
- * @description: A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse`
296
+ * @description: A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationBrandListing/).
398
297
  */
399
- getApplicationBrandListing({ pageNo, pageSize, q }?: {
400
- pageNo?: number;
401
- pageSize?: number;
402
- q?: string;
403
- }): Promise<BrandListingResponse>;
298
+ getApplicationBrandListing({ pageNo, pageSize, q }?: CatalogPlatformApplicationValidator.GetApplicationBrandListingParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.BrandListingResponse>;
404
299
  /**
405
300
  * @param {Object} arg - Arg object.
406
301
  * @param {string} arg.companyId - A `company_id` is a unique identifier for
@@ -411,6 +306,7 @@ declare class Catalog {
411
306
  * page. Default is 12.
412
307
  * @param {string} [arg.q] - Search query with brand name.Use this parameter
413
308
  * to search brands by brand name.
309
+ * @returns {Paginator<CatalogPlatformModel.BrandListingResponse>}
414
310
  * @summary: List all the brands for the application
415
311
  * @description: A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse`
416
312
  */
@@ -419,32 +315,18 @@ declare class Catalog {
419
315
  applicationId: string;
420
316
  pageSize?: number;
421
317
  q?: string;
422
- }): Paginator;
423
- /**
424
- * @param {Object} arg - Arg object.
425
- * @param {string} [arg.department] - The name of the department. Use this
426
- * parameter to filter products by a particular department. See below the
427
- * list of available departments. You can retrieve available departments
428
- * from the **v1.0/departments/** API
429
- * @param {number} [arg.pageNo] - The page number to navigate through the
430
- * given set of results
431
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
432
- * page. Default is 12.
433
- * @param {string} [arg.q] - Search query with brand name.Use this parameter
434
- * to search brands by brand name.
435
- * @param {number[]} [arg.brandId] - Helps to sort the brands list on the
436
- * basis of uid list.
437
- * @returns {Promise<BrandListingResponse>} - Success response
318
+ }): Paginator<CatalogPlatformModel.BrandListingResponse>;
319
+ /**
320
+ * @param {CatalogPlatformApplicationValidator.GetApplicationBrandsParam} arg
321
+ * - Arg object
322
+ *
323
+ * @param {import("../PlatformAPIClient").Options} - Options
324
+ * @returns {Promise<CatalogPlatformModel.BrandListingResponse>} - Success response
325
+ * @name getApplicationBrands
438
326
  * @summary: List all the brands
439
- * @description: A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse`
327
+ * @description: A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationBrands/).
440
328
  */
441
- getApplicationBrands({ department, pageNo, pageSize, q, brandId, }?: {
442
- department?: string;
443
- pageNo?: number;
444
- pageSize?: number;
445
- q?: string;
446
- brandId?: number[];
447
- }): Promise<BrandListingResponse>;
329
+ getApplicationBrands({ department, pageNo, pageSize, q, brandId }?: CatalogPlatformApplicationValidator.GetApplicationBrandsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.BrandListingResponse>;
448
330
  /**
449
331
  * @param {Object} arg - Arg object.
450
332
  * @param {string} arg.companyId - A `company_id` is a unique identifier for
@@ -461,6 +343,7 @@ declare class Catalog {
461
343
  * to search brands by brand name.
462
344
  * @param {number[]} [arg.brandId] - Helps to sort the brands list on the
463
345
  * basis of uid list.
346
+ * @returns {Paginator<CatalogPlatformModel.BrandListingResponse>}
464
347
  * @summary: List all the brands
465
348
  * @description: A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse`
466
349
  */
@@ -471,27 +354,18 @@ declare class Catalog {
471
354
  pageSize?: number;
472
355
  q?: string;
473
356
  brandId?: number[];
474
- }): Paginator;
475
- /**
476
- * @param {Object} arg - Arg object.
477
- * @param {number} [arg.departmentId] - A `department_id` is a unique
478
- * identifier for a particular department.
479
- * @param {number} [arg.pageNo] - The page number to navigate through the
480
- * given set of results
481
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
482
- * page. Default is 12.
483
- * @param {string} [arg.q] - Search query with brand name.Use this parameter
484
- * to search brands by brand name.
485
- * @returns {Promise<BrandListingResponse>} - Success response
357
+ }): Paginator<CatalogPlatformModel.BrandListingResponse>;
358
+ /**
359
+ * @param {CatalogPlatformApplicationValidator.GetApplicationCategoryListingParam} arg
360
+ * - Arg object
361
+ *
362
+ * @param {import("../PlatformAPIClient").Options} - Options
363
+ * @returns {Promise<CatalogPlatformModel.BrandListingResponse>} - Success response
364
+ * @name getApplicationCategoryListing
486
365
  * @summary: List all the brands for the application
487
- * @description: A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse`
366
+ * @description: A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationCategoryListing/).
488
367
  */
489
- getApplicationCategoryListing({ departmentId, pageNo, pageSize, q, }?: {
490
- departmentId?: number;
491
- pageNo?: number;
492
- pageSize?: number;
493
- q?: string;
494
- }): Promise<BrandListingResponse>;
368
+ getApplicationCategoryListing({ departmentId, pageNo, pageSize, q }?: CatalogPlatformApplicationValidator.GetApplicationCategoryListingParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.BrandListingResponse>;
495
369
  /**
496
370
  * @param {Object} arg - Arg object.
497
371
  * @param {string} arg.companyId - A `company_id` is a unique identifier for
@@ -504,6 +378,7 @@ declare class Catalog {
504
378
  * page. Default is 12.
505
379
  * @param {string} [arg.q] - Search query with brand name.Use this parameter
506
380
  * to search brands by brand name.
381
+ * @returns {Paginator<CatalogPlatformModel.BrandListingResponse>}
507
382
  * @summary: List all the brands for the application
508
383
  * @description: A brand is the name under which a product is being sold. Use this API to list all the brands. You can pass optionally filter the brands by the department. If successful, returns a paginated list of brands specified in `BrandListingResponse`
509
384
  */
@@ -513,24 +388,20 @@ declare class Catalog {
513
388
  departmentId?: number;
514
389
  pageSize?: number;
515
390
  q?: string;
516
- }): Paginator;
517
- /**
518
- * @param {Object} arg - Arg object.
519
- * @param {number} [arg.pageNo] - The page number to navigate through the
520
- * given set of results
521
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
522
- * page. Default is 12.
523
- * @param {string} [arg.q] - Search query with brand name.Use this parameter
524
- * to search department by name.
525
- * @returns {Promise<ApplicationDepartmentListingResponse>} - Success response
391
+ }): Paginator<CatalogPlatformModel.BrandListingResponse>;
392
+ /**
393
+ * @param {CatalogPlatformApplicationValidator.GetApplicationDepartmentListingParam} arg
394
+ * - Arg object
395
+ *
396
+ * @param {import("../PlatformAPIClient").Options} - Options
397
+ * @returns {Promise<CatalogPlatformModel.ApplicationDepartmentListingResponse>}
398
+ * - Success response
399
+ *
400
+ * @name getApplicationDepartmentListing
526
401
  * @summary: List all the departments for the application
527
- * @description: Departments are a way to categorise similar products. A product can lie in multiple departments. For example, a skirt can below to the 'Women's Fashion' Department while a handbag can lie in 'Women's Accessories' Department. Use this API to list all the application departments. If successful, returns the list of departments specified in `ApplicationDepartmentListingResponse`
402
+ * @description: Departments are a way to categorise similar products. A product can lie in multiple departments. For example, a skirt can below to the 'Women's Fashion' Department while a handbag can lie in 'Women's Accessories' Department. Use this API to list all the application departments. If successful, returns the list of departments specified in `ApplicationDepartmentListingResponse` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationDepartmentListing/).
528
403
  */
529
- getApplicationDepartmentListing({ pageNo, pageSize, q }?: {
530
- pageNo?: number;
531
- pageSize?: number;
532
- q?: string;
533
- }): Promise<ApplicationDepartmentListingResponse>;
404
+ getApplicationDepartmentListing({ pageNo, pageSize, q }?: CatalogPlatformApplicationValidator.GetApplicationDepartmentListingParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.ApplicationDepartmentListingResponse>;
534
405
  /**
535
406
  * @param {Object} arg - Arg object.
536
407
  * @param {string} arg.companyId - A `company_id` is a unique identifier for
@@ -541,6 +412,7 @@ declare class Catalog {
541
412
  * page. Default is 12.
542
413
  * @param {string} [arg.q] - Search query with brand name.Use this parameter
543
414
  * to search department by name.
415
+ * @returns {Paginator<CatalogPlatformModel.ApplicationDepartmentListingResponse>}
544
416
  * @summary: List all the departments for the application
545
417
  * @description: Departments are a way to categorise similar products. A product can lie in multiple departments. For example, a skirt can below to the 'Women's Fashion' Department while a handbag can lie in 'Women's Accessories' Department. Use this API to list all the application departments. If successful, returns the list of departments specified in `ApplicationDepartmentListingResponse`
546
418
  */
@@ -549,369 +421,320 @@ declare class Catalog {
549
421
  applicationId: string;
550
422
  pageSize?: number;
551
423
  q?: string;
552
- }): Paginator;
424
+ }): Paginator<CatalogPlatformModel.ApplicationDepartmentListingResponse>;
553
425
  /**
554
- * @param {Object} arg - Arg object.
555
- * @returns {Promise<GetAutocompleteWordsResponse>} - Success response
426
+ * @param {import("../PlatformAPIClient").Options} - Options
427
+ * @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>} -
428
+ * Success response
429
+ * @name getAutocompleteConfig
556
430
  * @summary: List all Autocomplete Keyword Listing
557
- * @description: Custom Autocomplete Keyword allows you to map conditions with keywords to give you the ultimate results
431
+ * @description: Custom Autocomplete Keyword allows you to map conditions with keywords to give you the ultimate results - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAutocompleteConfig/).
558
432
  */
559
- getAutocompleteConfig({}?: any): Promise<GetAutocompleteWordsResponse>;
433
+ getAutocompleteConfig({ headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>;
560
434
  /**
561
- * @param {Object} arg - Arg object.
562
- * @param {string} arg.id - A `id` is a unique identifier for a particular
563
- * detail. Pass the `id` of the keywords which you want to retrieve.
564
- * @returns {Promise<GetAutocompleteWordsResponse>} - Success response
435
+ * @param {CatalogPlatformApplicationValidator.GetAutocompleteKeywordDetailParam} arg
436
+ * - Arg object
437
+ *
438
+ * @param {import("../PlatformAPIClient").Options} - Options
439
+ * @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>} -
440
+ * Success response
441
+ * @name getAutocompleteKeywordDetail
565
442
  * @summary: Get a Autocomplete Keywords Details
566
- * @description: Get the details of a words by its `id`. If successful, returns a keywords resource in the response body specified in `GetAutocompleteWordsResponseSchema`
443
+ * @description: Get the details of a words by its `id`. If successful, returns a keywords resource in the response body specified in `GetAutocompleteWordsResponseSchema` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAutocompleteKeywordDetail/).
567
444
  */
568
- getAutocompleteKeywordDetail({ id }?: {
569
- id: string;
570
- }): Promise<GetAutocompleteWordsResponse>;
445
+ getAutocompleteKeywordDetail({ id }?: CatalogPlatformApplicationValidator.GetAutocompleteKeywordDetailParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>;
571
446
  /**
572
- * @param {Object} arg - Arg object.
573
- * @returns {Promise<GetCatalogConfigurationMetaData>} - Success response
447
+ * @param {import("../PlatformAPIClient").Options} - Options
448
+ * @returns {Promise<CatalogPlatformModel.GetCatalogConfigurationMetaData>}
449
+ * - Success response
450
+ *
451
+ * @name getCatalogConfiguration
574
452
  * @summary: Get configuration meta details for catalog for admin panel
575
- * @description: configuration meta details for catalog.
453
+ * @description: configuration meta details for catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCatalogConfiguration/).
576
454
  */
577
- getCatalogConfiguration({}?: any): Promise<GetCatalogConfigurationMetaData>;
455
+ getCatalogConfiguration({ headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.GetCatalogConfigurationMetaData>;
578
456
  /**
579
- * @param {Object} arg - Arg object.
580
- * @param {string} [arg.brand] - Brand slug
581
- * @returns {Promise<CatalogInsightResponse>} - Success response
457
+ * @param {CatalogPlatformApplicationValidator.GetCatalogInsightsParam} arg
458
+ * - Arg object
459
+ *
460
+ * @param {import("../PlatformAPIClient").Options} - Options
461
+ * @returns {Promise<CatalogPlatformModel.CatalogInsightResponse>} - Success response
462
+ * @name getCatalogInsights
582
463
  * @summary: Analytics data of catalog and inventory.
583
- * @description: Catalog Insights api returns the count of catalog related data like products, brands, departments and categories that have been made live as per configuration of the app.
464
+ * @description: Catalog Insights api returns the count of catalog related data like products, brands, departments and categories that have been made live as per configuration of the app. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCatalogInsights/).
584
465
  */
585
- getCatalogInsights({ brand }?: {
586
- brand?: string;
587
- }): Promise<CatalogInsightResponse>;
466
+ getCatalogInsights({ brand }?: CatalogPlatformApplicationValidator.GetCatalogInsightsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.CatalogInsightResponse>;
588
467
  /**
589
- * @param {Object} arg - Arg object.
590
- * @param {string} [arg.department] - The name of the department. Use this
591
- * parameter to filter products by a particular department. See below the
592
- * list of available departments. You can retrieve available departments
593
- * from the **v1.0/departments/** API
594
- * @returns {Promise<CategoryListingResponse>} - Success response
468
+ * @param {CatalogPlatformApplicationValidator.GetCategoriesParam} arg - Arg object
469
+ * @param {import("../PlatformAPIClient").Options} - Options
470
+ * @returns {Promise<CatalogPlatformModel.CategoryListingResponse>} - Success response
471
+ * @name getCategories
595
472
  * @summary: List all the categories
596
- * @description: List all the categories. You can optionally pass filter the brands by the department. If successful, returns a paginated list of brands specified in `CategoryListingResponse`
473
+ * @description: List all the categories. You can optionally pass filter the brands by the department. If successful, returns a paginated list of brands specified in `CategoryListingResponse` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCategories/).
597
474
  */
598
- getCategories({ department }?: {
599
- department?: string;
600
- }): Promise<CategoryListingResponse>;
475
+ getCategories({ department }?: CatalogPlatformApplicationValidator.GetCategoriesParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.CategoryListingResponse>;
601
476
  /**
602
- * @param {Object} arg - Arg object.
603
- * @param {string} arg.slug - A `slug` is a human readable, URL friendly
604
- * unique identifier of an object. Pass the `slug` of the collection which
605
- * you want to retrieve.
606
- * @returns {Promise<CollectionDetailResponse>} - Success response
477
+ * @param {CatalogPlatformApplicationValidator.GetCollectionDetailParam} arg
478
+ * - Arg object
479
+ *
480
+ * @param {import("../PlatformAPIClient").Options} - Options
481
+ * @returns {Promise<CatalogPlatformModel.CollectionDetailResponse>} -
482
+ * Success response
483
+ * @name getCollectionDetail
607
484
  * @summary: Get a particular collection
608
- * @description: Get the details of a collection by its `slug`. If successful, returns a Collection resource in the response body specified in `CollectionDetailResponse`
485
+ * @description: Get the details of a collection by its `slug`. If successful, returns a Collection resource in the response body specified in `CollectionDetailResponse` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCollectionDetail/).
609
486
  */
610
- getCollectionDetail({ slug }?: {
611
- slug: string;
612
- }): Promise<CollectionDetailResponse>;
487
+ getCollectionDetail({ slug }?: CatalogPlatformApplicationValidator.GetCollectionDetailParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.CollectionDetailResponse>;
613
488
  /**
614
- * @param {Object} arg - Arg object.
615
- * @param {string} arg.id - A `id` is a unique identifier of a collection.
616
- * @param {string} [arg.sortOn] - Each response will contain sort_on param,
617
- * which should be sent back to make pagination work.
618
- * @param {string} [arg.pageId] - Each response will contain next_id param,
619
- * which should be sent back to make pagination work.
620
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
621
- * page. Default is 12.
622
- * @returns {Promise<GetCollectionItemsResponse>} - Success response
489
+ * @param {CatalogPlatformApplicationValidator.GetCollectionItemsParam} arg
490
+ * - Arg object
491
+ *
492
+ * @param {import("../PlatformAPIClient").Options} - Options
493
+ * @returns {Promise<CatalogPlatformModel.GetCollectionItemsResponse>} -
494
+ * Success response
495
+ * @name getCollectionItems
623
496
  * @summary: Get the items for a collection
624
- * @description: Get items from a collection specified by its `id`.
625
- */
626
- getCollectionItems({ id, sortOn, pageId, pageSize }?: {
627
- id: string;
628
- sortOn?: string;
629
- pageId?: string;
630
- pageSize?: number;
631
- }): Promise<GetCollectionItemsResponse>;
632
- /**
633
- * @param {Object} arg - Arg object.
634
- * @param {string} arg.type - Type can be brands, categories etc.
635
- * @returns {Promise<GetAppCatalogEntityConfiguration>} - Success response
497
+ * @description: Get items from a collection specified by its `id`. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCollectionItems/).
498
+ */
499
+ getCollectionItems({ id, sortOn, pageId, pageSize }?: CatalogPlatformApplicationValidator.GetCollectionItemsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.GetCollectionItemsResponse>;
500
+ /**
501
+ * @param {CatalogPlatformApplicationValidator.GetConfigurationByTypeParam} arg
502
+ * - Arg object
503
+ *
504
+ * @param {import("../PlatformAPIClient").Options} - Options
505
+ * @returns {Promise<CatalogPlatformModel.GetAppCatalogEntityConfiguration>}
506
+ * - Success response
507
+ *
508
+ * @name getConfigurationByType
636
509
  * @summary: Get configured details for catalog
637
- * @description: configured details for catalog.
510
+ * @description: configured details for catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getConfigurationByType/).
638
511
  */
639
- getConfigurationByType({ type }?: {
640
- type: string;
641
- }): Promise<GetAppCatalogEntityConfiguration>;
512
+ getConfigurationByType({ type }?: CatalogPlatformApplicationValidator.GetConfigurationByTypeParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.GetAppCatalogEntityConfiguration>;
642
513
  /**
643
- * @param {Object} arg - Arg object.
644
- * @param {string} arg.configType - A `config_type` is an identifier that
645
- * defines a specific type of configuration.
646
- * @param {string} [arg.templateSlug] - Get configuration list filtered by
647
- * `template_slug` string. This is for the details and comparision groups.
648
- * @returns {Promise<GetConfigMetadataResponse>} - Success response
514
+ * @param {CatalogPlatformApplicationValidator.GetConfigurationMetadataParam} arg
515
+ * - Arg object
516
+ *
517
+ * @param {import("../PlatformAPIClient").Options} - Options
518
+ * @returns {Promise<CatalogPlatformModel.GetConfigMetadataResponse>} -
519
+ * Success response
520
+ * @name getConfigurationMetadata
649
521
  * @summary: Get configuration metadata details for catalog for admin panel
650
- * @description: Get the configuraion metadata details for catalog.
522
+ * @description: Get the configuraion metadata details for catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getConfigurationMetadata/).
651
523
  */
652
- getConfigurationMetadata({ configType, templateSlug }?: {
653
- configType: string;
654
- templateSlug?: string;
655
- }): Promise<GetConfigMetadataResponse>;
524
+ getConfigurationMetadata({ configType, templateSlug }?: CatalogPlatformApplicationValidator.GetConfigurationMetadataParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.GetConfigMetadataResponse>;
656
525
  /**
657
- * @param {Object} arg - Arg object.
658
- * @returns {Promise<GetAppCatalogConfiguration>} - Success response
526
+ * @param {import("../PlatformAPIClient").Options} - Options
527
+ * @returns {Promise<CatalogPlatformModel.GetAppCatalogConfiguration>} -
528
+ * Success response
529
+ * @name getConfigurations
659
530
  * @summary: Get configured details for catalog
660
- * @description: configured details for catalog.
531
+ * @description: configured details for catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getConfigurations/).
661
532
  */
662
- getConfigurations({}?: any): Promise<GetAppCatalogConfiguration>;
533
+ getConfigurations({ headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.GetAppCatalogConfiguration>;
663
534
  /**
664
- * @param {Object} arg - Arg object.
665
- * @returns {Promise<DepartmentResponse>} - Success response
535
+ * @param {import("../PlatformAPIClient").Options} - Options
536
+ * @returns {Promise<CatalogPlatformModel.DepartmentResponse>} - Success response
537
+ * @name getDepartments
666
538
  * @summary: List all the departments
667
- * @description: Departments are a way to categorise similar products. A product can lie in multiple departments. For example, a skirt can below to the 'Women's Fashion' Department while a handbag can lie in 'Women's Accessories' Department. Use this API to list all the departments. If successful, returns the list of departments specified in `DepartmentResponse`
668
- */
669
- getDepartments({}?: any): Promise<DepartmentResponse>;
670
- /**
671
- * @param {Object} arg - Arg object.
672
- * @param {number} arg.itemId - Item code of the product of which size is to be get.
673
- * @param {string} arg.sizeIdentifier - Size Identifier (Seller Identifier
674
- * or Primary Identifier) of which inventory is to get.
675
- * @param {number} [arg.pageNo] - The page number to navigate through the
676
- * given set of results
677
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
678
- * page. Default is 12.
679
- * @param {string} [arg.q] - Search with help of store code.
680
- * @param {number[]} [arg.locationIds] - Search by store ids.
681
- * @returns {Promise<InventorySellerIdentifierResponsePaginated>} - Success response
539
+ * @description: Departments are a way to categorise similar products. A product can lie in multiple departments. For example, a skirt can below to the 'Women's Fashion' Department while a handbag can lie in 'Women's Accessories' Department. Use this API to list all the departments. If successful, returns the list of departments specified in `DepartmentResponse` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getDepartments/).
540
+ */
541
+ getDepartments({ headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.DepartmentResponse>;
542
+ /**
543
+ * @param {CatalogPlatformApplicationValidator.GetDiscountedInventoryBySizeIdentifierParam} arg
544
+ * - Arg object
545
+ *
546
+ * @param {import("../PlatformAPIClient").Options} - Options
547
+ * @returns {Promise<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>}
548
+ * - Success response
549
+ *
550
+ * @name getDiscountedInventoryBySizeIdentifier
682
551
  * @summary: Get Inventory for company
683
- * @description: This API allows get Inventory data for particular company grouped by size and store.
552
+ * @description: This API allows get Inventory data for particular company grouped by size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getDiscountedInventoryBySizeIdentifier/).
684
553
  */
685
- getDiscountedInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize, q, locationIds, }?: {
686
- itemId: number;
687
- sizeIdentifier: string;
688
- pageNo?: number;
689
- pageSize?: number;
690
- q?: string;
691
- locationIds?: number[];
692
- }): Promise<InventorySellerIdentifierResponsePaginated>;
554
+ getDiscountedInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize, q, locationIds }?: CatalogPlatformApplicationValidator.GetDiscountedInventoryBySizeIdentifierParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>;
693
555
  /**
694
- * @param {Object} arg - Arg object.
695
- * @param {string} arg.configType - A `config_type` is an identifier that
696
- * defines a specific type of configuration.
697
- * @param {number} [arg.pageNo] - The page number to navigate through the
698
- * given set of results.
699
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
700
- * page. Default is 12.
701
- * @param {string} [arg.search] - Get configuration list filtered by `search` string.
702
- * @param {string} [arg.templateSlug] - Get configuration list filtered by
703
- * `template_slug` string. This is for the details and comparision groups.
704
- * @returns {Promise<GetConfigResponse>} - Success response
556
+ * @param {CatalogPlatformApplicationValidator.GetGroupConfigurationsParam} arg
557
+ * - Arg object
558
+ *
559
+ * @param {import("../PlatformAPIClient").Options} - Options
560
+ * @returns {Promise<CatalogPlatformModel.GetConfigResponse>} - Success response
561
+ * @name getGroupConfigurations
705
562
  * @summary: Get the details of the application configured configurations of group config types.
706
- * @description: Get the details of the application configured configurations of group config types.
563
+ * @description: Get the details of the application configured configurations of group config types. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getGroupConfigurations/).
707
564
  */
708
- getGroupConfigurations({ configType, pageNo, pageSize, search, templateSlug, }?: {
709
- configType: string;
710
- pageNo?: number;
711
- pageSize?: number;
712
- search?: string;
713
- templateSlug?: string;
714
- }): Promise<GetConfigResponse>;
565
+ getGroupConfigurations({ configType, pageNo, pageSize, search, templateSlug }?: CatalogPlatformApplicationValidator.GetGroupConfigurationsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.GetConfigResponse>;
715
566
  /**
716
- * @param {Object} arg - Arg object.
717
- * @param {string} arg.configType - A `config_type` is an identifier that
718
- * defines a specific type of configuration.
719
- * @param {number} [arg.pageNo] - The page number to navigate through the
720
- * given set of results.
721
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
722
- * page. Default is 12.
723
- * @param {string} [arg.search] - Get configuration list filtered by `search` string.
724
- * @returns {Promise<GetConfigResponse>} - Success response
567
+ * @param {CatalogPlatformApplicationValidator.GetListingConfigurationsParam} arg
568
+ * - Arg object
569
+ *
570
+ * @param {import("../PlatformAPIClient").Options} - Options
571
+ * @returns {Promise<CatalogPlatformModel.GetConfigResponse>} - Success response
572
+ * @name getListingConfigurations
725
573
  * @summary: Get the details of the application configured configurations of listing config types.
726
- * @description: Get the details of the application configured configurations of listing config types.
574
+ * @description: Get the details of the application configured configurations of listing config types. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getListingConfigurations/).
727
575
  */
728
- getListingConfigurations({ configType, pageNo, pageSize, search, }?: {
729
- configType: string;
730
- pageNo?: number;
731
- pageSize?: number;
732
- search?: string;
733
- }): Promise<GetConfigResponse>;
576
+ getListingConfigurations({ configType, pageNo, pageSize, search }?: CatalogPlatformApplicationValidator.GetListingConfigurationsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.GetConfigResponse>;
734
577
  /**
735
- * @param {Object} arg - Arg object.
736
- * @param {string} arg.slug - The unique identifier of a product. i.e;
737
- * `slug` of a product. You can retrieve these from the APIs that list
738
- * products like **v1.0/products/**
739
- * @returns {Promise<ProductDetail>} - Success response
578
+ * @param {CatalogPlatformApplicationValidator.GetProductDetailBySlugParam} arg
579
+ * - Arg object
580
+ *
581
+ * @param {import("../PlatformAPIClient").Options} - Options
582
+ * @returns {Promise<CatalogPlatformModel.ProductDetail>} - Success response
583
+ * @name getProductDetailBySlug
740
584
  * @summary: Get a product
741
- * @description: Products are the core resource of an application. Products can be associated by categories, collections, brands and more. This API retrieves the product specified by the given **slug**. If successful, returns a Product resource in the response body specified in `ProductDetail`
585
+ * @description: Products are the core resource of an application. Products can be associated by categories, collections, brands and more. This API retrieves the product specified by the given **slug**. If successful, returns a Product resource in the response body specified in `ProductDetail` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductDetailBySlug/).
742
586
  */
743
- getProductDetailBySlug({ slug }?: {
744
- slug: string;
745
- }): Promise<ProductDetail>;
587
+ getProductDetailBySlug({ slug }?: CatalogPlatformApplicationValidator.GetProductDetailBySlugParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.ProductDetail>;
746
588
  /**
747
- * @param {Object} arg - Arg object.
748
- * @returns {Promise<GetCollectionQueryOptionResponse>} - Success response
589
+ * @param {import("../PlatformAPIClient").Options} - Options
590
+ * @returns {Promise<CatalogPlatformModel.GetCollectionQueryOptionResponse>}
591
+ * - Success response
592
+ *
593
+ * @name getQueryFilters
749
594
  * @summary: Get query filters to configure a collection
750
- * @description: Get query filters to configure a collection
595
+ * @description: Get query filters to configure a collection - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getQueryFilters/).
751
596
  */
752
- getQueryFilters({}?: any): Promise<GetCollectionQueryOptionResponse>;
597
+ getQueryFilters({ headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.GetCollectionQueryOptionResponse>;
753
598
  /**
754
- * @param {Object} arg - Arg object.
755
- * @param {string} arg.id - A `id` is a unique identifier for a particular
756
- * detail. Pass the `id` of the keywords which you want to retrieve.
757
- * @returns {Promise<GetSearchWordsDetailResponse>} - Success response
599
+ * @param {CatalogPlatformApplicationValidator.GetSearchKeywordsParam} arg
600
+ * - Arg object
601
+ *
602
+ * @param {import("../PlatformAPIClient").Options} - Options
603
+ * @returns {Promise<CatalogPlatformModel.GetSearchWordsDetailResponse>} -
604
+ * Success response
605
+ * @name getSearchKeywords
758
606
  * @summary: Get a Search Keywords Details
759
- * @description: Get the details of a words by its `id`. If successful, returns a Collection resource in the response body specified in `GetSearchWordsDetailResponseSchema`
607
+ * @description: Get the details of a words by its `id`. If successful, returns a Collection resource in the response body specified in `GetSearchWordsDetailResponseSchema` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSearchKeywords/).
760
608
  */
761
- getSearchKeywords({ id }?: {
762
- id: string;
763
- }): Promise<GetSearchWordsDetailResponse>;
609
+ getSearchKeywords({ id }?: CatalogPlatformApplicationValidator.GetSearchKeywordsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.GetSearchWordsDetailResponse>;
764
610
  /**
765
- * @param {Object} arg - Arg object.
766
- * @param {AllowSingleRequest} arg.body
767
- * @returns {Promise<ConfigSuccessResponse>} - Success response
611
+ * @param {CatalogPlatformApplicationValidator.UpdateAllowSingleParam} arg
612
+ * - Arg object
613
+ *
614
+ * @param {import("../PlatformAPIClient").Options} - Options
615
+ * @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
616
+ * @name updateAllowSingle
768
617
  * @summary: Update allow single flag for filters of the application.
769
- * @description: Update allow single flag for filters of the application.
618
+ * @description: Update allow single flag for filters of the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAllowSingle/).
770
619
  */
771
- updateAllowSingle({ body }?: {
772
- body: AllowSingleRequest;
773
- }): Promise<ConfigSuccessResponse>;
620
+ updateAllowSingle({ body }?: CatalogPlatformApplicationValidator.UpdateAllowSingleParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.ConfigSuccessResponse>;
774
621
  /**
775
- * @param {Object} arg - Arg object.
776
- * @param {string} arg.brandUid - Brand id for which the custom_json is associated.
777
- * @param {ApplicationBrandJson} arg.body
778
- * @returns {Promise<SuccessResponse1>} - Success response
622
+ * @param {CatalogPlatformApplicationValidator.UpdateAppBrandParam} arg - Arg object
623
+ * @param {import("../PlatformAPIClient").Options} - Options
624
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
625
+ * @name updateAppBrand
779
626
  * @summary: Update a single custom json.
780
- * @description: This API helps to update data associated to a item custom meta.
627
+ * @description: This API helps to update data associated to a item custom meta. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppBrand/).
781
628
  */
782
- updateAppBrand({ brandUid, body }?: {
783
- brandUid: string;
784
- body: ApplicationBrandJson;
785
- }): Promise<SuccessResponse1>;
629
+ updateAppBrand({ brandUid, body }?: CatalogPlatformApplicationValidator.UpdateAppBrandParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.SuccessResponse1>;
786
630
  /**
787
- * @param {Object} arg - Arg object.
788
- * @param {string} arg.categoryUid - Category id for which the custom_json
789
- * is associated.
790
- * @param {ApplicationCategoryJson} arg.body
791
- * @returns {Promise<SuccessResponse1>} - Success response
631
+ * @param {CatalogPlatformApplicationValidator.UpdateAppCategoryParam} arg
632
+ * - Arg object
633
+ *
634
+ * @param {import("../PlatformAPIClient").Options} - Options
635
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
636
+ * @name updateAppCategory
792
637
  * @summary: Update a single custom json.
793
- * @description: This API helps to update data associated to a item custom meta.
638
+ * @description: This API helps to update data associated to a item custom meta. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppCategory/).
794
639
  */
795
- updateAppCategory({ categoryUid, body }?: {
796
- categoryUid: string;
797
- body: ApplicationCategoryJson;
798
- }): Promise<SuccessResponse1>;
640
+ updateAppCategory({ categoryUid, body }?: CatalogPlatformApplicationValidator.UpdateAppCategoryParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.SuccessResponse1>;
799
641
  /**
800
- * @param {Object} arg - Arg object.
801
- * @param {string} arg.departmentUid - Department id for which the
802
- * custom_json is associated.
803
- * @param {ApplicationDepartmentJson} arg.body
804
- * @returns {Promise<SuccessResponse1>} - Success response
642
+ * @param {CatalogPlatformApplicationValidator.UpdateAppDepartmentParam} arg
643
+ * - Arg object
644
+ *
645
+ * @param {import("../PlatformAPIClient").Options} - Options
646
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
647
+ * @name updateAppDepartment
805
648
  * @summary: Update a single custom json.
806
- * @description: This API helps to update data associated to a item custom meta.
649
+ * @description: This API helps to update data associated to a item custom meta. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppDepartment/).
807
650
  */
808
- updateAppDepartment({ departmentUid, body }?: {
809
- departmentUid: string;
810
- body: ApplicationDepartmentJson;
811
- }): Promise<SuccessResponse1>;
651
+ updateAppDepartment({ departmentUid, body }?: CatalogPlatformApplicationValidator.UpdateAppDepartmentParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.SuccessResponse1>;
812
652
  /**
813
- * @param {Object} arg - Arg object.
814
- * @param {string} arg.storeUid - Store id for which the custom_json is associated.
815
- * @param {ApplicationStoreJson} arg.body
816
- * @returns {Promise<SuccessResponse1>} - Success response
653
+ * @param {CatalogPlatformApplicationValidator.UpdateAppLocationParam} arg
654
+ * - Arg object
655
+ *
656
+ * @param {import("../PlatformAPIClient").Options} - Options
657
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
658
+ * @name updateAppLocation
817
659
  * @summary: Update a single custom json.
818
- * @description: This API helps to update data associated to a item custom meta.
660
+ * @description: This API helps to update data associated to a item custom meta. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppLocation/).
819
661
  */
820
- updateAppLocation({ storeUid, body }?: {
821
- storeUid: string;
822
- body: ApplicationStoreJson;
823
- }): Promise<SuccessResponse1>;
662
+ updateAppLocation({ storeUid, body }?: CatalogPlatformApplicationValidator.UpdateAppLocationParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.SuccessResponse1>;
824
663
  /**
825
- * @param {Object} arg - Arg object.
826
- * @param {string} arg.itemId - Product id for which the custom_meta is associated.
827
- * @param {ApplicationItemMeta} arg.body
828
- * @returns {Promise<SuccessResponse1>} - Success response
664
+ * @param {CatalogPlatformApplicationValidator.UpdateAppProductParam} arg - Arg object
665
+ * @param {import("../PlatformAPIClient").Options} - Options
666
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
667
+ * @name updateAppProduct
829
668
  * @summary: Update a single custom meta.
830
- * @description: This API helps to update data associated to a item custom meta.
669
+ * @description: This API helps to update data associated to a item custom meta. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppProduct/).
831
670
  */
832
- updateAppProduct({ itemId, body }?: {
833
- itemId: string;
834
- body: ApplicationItemMeta;
835
- }): Promise<SuccessResponse1>;
671
+ updateAppProduct({ itemId, body }?: CatalogPlatformApplicationValidator.UpdateAppProductParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.SuccessResponse1>;
836
672
  /**
837
- * @param {Object} arg - Arg object.
838
- * @param {string} arg.id - A `id` is a unique identifier for a particular
839
- * detail. Pass the `id` of the keywords which you want to delete.
840
- * @param {CreateAutocompleteKeyword} arg.body
841
- * @returns {Promise<GetAutocompleteWordsResponse>} - Success response
673
+ * @param {CatalogPlatformApplicationValidator.UpdateAutocompleteKeywordParam} arg
674
+ * - Arg object
675
+ *
676
+ * @param {import("../PlatformAPIClient").Options} - Options
677
+ * @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>} -
678
+ * Success response
679
+ * @name updateAutocompleteKeyword
842
680
  * @summary: Create & Update Autocomplete Keyword
843
- * @description: Update a mapping by it's id. On successful request, returns the updated Keyword mapping
681
+ * @description: Update a mapping by it's id. On successful request, returns the updated Keyword mapping - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAutocompleteKeyword/).
844
682
  */
845
- updateAutocompleteKeyword({ id, body }?: {
846
- id: string;
847
- body: CreateAutocompleteKeyword;
848
- }): Promise<GetAutocompleteWordsResponse>;
683
+ updateAutocompleteKeyword({ id, body }?: CatalogPlatformApplicationValidator.UpdateAutocompleteKeywordParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>;
849
684
  /**
850
- * @param {Object} arg - Arg object.
851
- * @param {string} arg.id - A `id` is a unique identifier of a collection.
852
- * @param {UpdateCollection} arg.body
853
- * @returns {Promise<UpdateCollection>} - Success response
685
+ * @param {CatalogPlatformApplicationValidator.UpdateCollectionParam} arg - Arg object
686
+ * @param {import("../PlatformAPIClient").Options} - Options
687
+ * @returns {Promise<CatalogPlatformModel.UpdateCollection>} - Success response
688
+ * @name updateCollection
854
689
  * @summary: Update a collection
855
- * @description: Update a collection by it's id. On successful request, returns the updated collection
690
+ * @description: Update a collection by it's id. On successful request, returns the updated collection - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateCollection/).
856
691
  */
857
- updateCollection({ id, body }?: {
858
- id: string;
859
- body: UpdateCollection;
860
- }): Promise<UpdateCollection>;
692
+ updateCollection({ id, body }?: CatalogPlatformApplicationValidator.UpdateCollectionParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.UpdateCollection>;
861
693
  /**
862
- * @param {Object} arg - Arg object.
863
- * @param {DefaultKeyRequest} arg.body
864
- * @returns {Promise<ConfigSuccessResponse>} - Success response
694
+ * @param {CatalogPlatformApplicationValidator.UpdateDefaultSortParam} arg
695
+ * - Arg object
696
+ *
697
+ * @param {import("../PlatformAPIClient").Options} - Options
698
+ * @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
699
+ * @name updateDefaultSort
865
700
  * @summary: Update the default sort key configuration for the application.
866
- * @description: Update the default sort key configuration for the application.
701
+ * @description: Update the default sort key configuration for the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateDefaultSort/).
867
702
  */
868
- updateDefaultSort({ body }?: {
869
- body: DefaultKeyRequest;
870
- }): Promise<ConfigSuccessResponse>;
703
+ updateDefaultSort({ body }?: CatalogPlatformApplicationValidator.UpdateDefaultSortParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.ConfigSuccessResponse>;
871
704
  /**
872
- * @param {Object} arg - Arg object.
873
- * @param {string} arg.configType - A `config_type` is a unique identifier
874
- * for a particular group configuration type.
875
- * @param {string} arg.groupSlug - A `group_slug` is a unique identifier of
876
- * a particular configuration.
877
- * @param {AppConfigurationDetail} arg.body
878
- * @returns {Promise<AppConfigurationDetail>} - Success response
705
+ * @param {CatalogPlatformApplicationValidator.UpdateGroupConfigurationParam} arg
706
+ * - Arg object
707
+ *
708
+ * @param {import("../PlatformAPIClient").Options} - Options
709
+ * @returns {Promise<CatalogPlatformModel.AppConfigurationDetail>} - Success response
710
+ * @name updateGroupConfiguration
879
711
  * @summary: Update the group configurations for the application.
880
- * @description: Update the group configurations for the application.
712
+ * @description: Update the group configurations for the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateGroupConfiguration/).
881
713
  */
882
- updateGroupConfiguration({ configType, groupSlug, body }?: {
883
- configType: string;
884
- groupSlug: string;
885
- body: AppConfigurationDetail;
886
- }): Promise<AppConfigurationDetail>;
714
+ updateGroupConfiguration({ configType, groupSlug, body }?: CatalogPlatformApplicationValidator.UpdateGroupConfigurationParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.AppConfigurationDetail>;
887
715
  /**
888
- * @param {Object} arg - Arg object.
889
- * @param {string} arg.configType - A `config_type` is a unique identifier
890
- * for a particular listing configuration type.
891
- * @param {string} arg.configId - A `config_id` is a unique identifier of a
892
- * particular configuration.
893
- * @param {AppConfigurationsSort} arg.body
894
- * @returns {Promise<AppConfigurationsSort>} - Success response
716
+ * @param {CatalogPlatformApplicationValidator.UpdateListingConfigurationParam} arg
717
+ * - Arg object
718
+ *
719
+ * @param {import("../PlatformAPIClient").Options} - Options
720
+ * @returns {Promise<CatalogPlatformModel.AppConfigurationsSort>} - Success response
721
+ * @name updateListingConfiguration
895
722
  * @summary: Update configuration for listings
896
- * @description: Update configuration for listing.
723
+ * @description: Update configuration for listing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateListingConfiguration/).
897
724
  */
898
- updateListingConfiguration({ configType, configId, body }?: {
899
- configType: string;
900
- configId: string;
901
- body: AppConfigurationsSort;
902
- }): Promise<AppConfigurationsSort>;
725
+ updateListingConfiguration({ configType, configId, body }?: CatalogPlatformApplicationValidator.UpdateListingConfigurationParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.AppConfigurationsSort>;
903
726
  /**
904
- * @param {Object} arg - Arg object.
905
- * @param {string} arg.id - A `id` is a unique identifier for a particular
906
- * detail. Pass the `id` of the keywords which you want to delete.
907
- * @param {CreateSearchKeyword} arg.body
908
- * @returns {Promise<GetSearchWordsData>} - Success response
727
+ * @param {CatalogPlatformApplicationValidator.UpdateSearchKeywordsParam} arg
728
+ * - Arg object
729
+ *
730
+ * @param {import("../PlatformAPIClient").Options} - Options
731
+ * @returns {Promise<CatalogPlatformModel.GetSearchWordsData>} - Success response
732
+ * @name updateSearchKeywords
909
733
  * @summary: Update Search Keyword
910
- * @description: Update Search Keyword by its id. On successful request, returns the updated collection
734
+ * @description: Update Search Keyword by its id. On successful request, returns the updated collection - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateSearchKeywords/).
911
735
  */
912
- updateSearchKeywords({ id, body }?: {
913
- id: string;
914
- body: CreateSearchKeyword;
915
- }): Promise<GetSearchWordsData>;
736
+ updateSearchKeywords({ id, body }?: CatalogPlatformApplicationValidator.UpdateSearchKeywordsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.GetSearchWordsData>;
916
737
  }
738
+ import CatalogPlatformApplicationValidator = require("./CatalogPlatformApplicationValidator");
739
+ import CatalogPlatformModel = require("./CatalogPlatformModel");
917
740
  import Paginator = require("../../common/Paginator");