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