@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (321) hide show
  1. package/README.md +12 -0
  2. package/index.js +0 -3
  3. package/package.json +1 -1
  4. package/sdk/application/ApplicationAPIClient.d.ts +15 -1
  5. package/sdk/application/ApplicationAPIClient.js +8 -1
  6. package/sdk/application/ApplicationClient.d.ts +37 -6
  7. package/sdk/application/ApplicationClient.js +31 -0
  8. package/sdk/application/ApplicationConfig.d.ts +52 -12
  9. package/sdk/application/ApplicationConfig.js +37 -2
  10. package/sdk/application/ApplicationModels.d.ts +46 -1
  11. package/sdk/application/ApplicationModels.js +18 -0
  12. package/sdk/application/Cart/CartApplicationClient.d.ts +172 -357
  13. package/sdk/application/Cart/CartApplicationClient.js +620 -483
  14. package/sdk/application/Cart/CartApplicationModel.d.ts +2054 -96
  15. package/sdk/application/Cart/CartApplicationModel.js +1224 -93
  16. package/sdk/application/Cart/CartApplicationValidator.d.ts +508 -30
  17. package/sdk/application/Cart/CartApplicationValidator.js +270 -15
  18. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +234 -413
  19. package/sdk/application/Catalog/CatalogApplicationClient.js +777 -630
  20. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2218 -117
  21. package/sdk/application/Catalog/CatalogApplicationModel.js +1499 -170
  22. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +798 -31
  23. package/sdk/application/Catalog/CatalogApplicationValidator.js +318 -3
  24. package/sdk/application/Common/CommonApplicationClient.d.ts +14 -21
  25. package/sdk/application/Common/CommonApplicationClient.js +50 -33
  26. package/sdk/application/Common/CommonApplicationModel.d.ts +448 -19
  27. package/sdk/application/Common/CommonApplicationModel.js +224 -16
  28. package/sdk/application/Common/CommonApplicationValidator.d.ts +42 -4
  29. package/sdk/application/Common/CommonApplicationValidator.js +21 -3
  30. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +25 -18
  31. package/sdk/application/Communication/CommunicationApplicationClient.js +74 -47
  32. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +190 -14
  33. package/sdk/application/Communication/CommunicationApplicationModel.js +124 -7
  34. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +27 -4
  35. package/sdk/application/Communication/CommunicationApplicationValidator.js +21 -5
  36. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +113 -112
  37. package/sdk/application/Configuration/ConfigurationApplicationClient.js +381 -260
  38. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +2453 -110
  39. package/sdk/application/Configuration/ConfigurationApplicationModel.js +1254 -108
  40. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +160 -8
  41. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +88 -4
  42. package/sdk/application/Content/ContentApplicationClient.d.ts +120 -138
  43. package/sdk/application/Content/ContentApplicationClient.js +409 -277
  44. package/sdk/application/Content/ContentApplicationModel.d.ts +1627 -105
  45. package/sdk/application/Content/ContentApplicationModel.js +1202 -109
  46. package/sdk/application/Content/ContentApplicationValidator.d.ts +214 -12
  47. package/sdk/application/Content/ContentApplicationValidator.js +113 -3
  48. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +20 -29
  49. package/sdk/application/FileStorage/FileStorageApplicationClient.js +68 -47
  50. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +299 -20
  51. package/sdk/application/FileStorage/FileStorageApplicationModel.js +209 -16
  52. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +55 -5
  53. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +33 -6
  54. package/sdk/application/Lead/LeadApplicationClient.d.ts +50 -53
  55. package/sdk/application/Lead/LeadApplicationClient.js +169 -103
  56. package/sdk/application/Lead/LeadApplicationModel.d.ts +1405 -54
  57. package/sdk/application/Lead/LeadApplicationModel.js +619 -73
  58. package/sdk/application/Lead/LeadApplicationValidator.d.ts +91 -9
  59. package/sdk/application/Lead/LeadApplicationValidator.js +51 -6
  60. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +34 -33
  61. package/sdk/application/Logistic/LogisticApplicationClient.js +110 -73
  62. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +399 -28
  63. package/sdk/application/Logistic/LogisticApplicationModel.js +293 -24
  64. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +48 -6
  65. package/sdk/application/Logistic/LogisticApplicationValidator.js +34 -6
  66. package/sdk/application/Order/OrderApplicationClient.d.ts +81 -133
  67. package/sdk/application/Order/OrderApplicationClient.js +297 -217
  68. package/sdk/application/Order/OrderApplicationModel.d.ts +1101 -66
  69. package/sdk/application/Order/OrderApplicationModel.js +776 -57
  70. package/sdk/application/Order/OrderApplicationValidator.d.ts +249 -14
  71. package/sdk/application/Order/OrderApplicationValidator.js +114 -5
  72. package/sdk/application/Payment/PaymentApplicationClient.d.ts +341 -356
  73. package/sdk/application/Payment/PaymentApplicationClient.js +1077 -703
  74. package/sdk/application/Payment/PaymentApplicationModel.d.ts +3125 -99
  75. package/sdk/application/Payment/PaymentApplicationModel.js +1158 -62
  76. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +494 -41
  77. package/sdk/application/Payment/PaymentApplicationValidator.js +297 -25
  78. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +178 -350
  79. package/sdk/application/PosCart/PosCartApplicationClient.js +636 -491
  80. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1823 -89
  81. package/sdk/application/PosCart/PosCartApplicationModel.js +1117 -85
  82. package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +480 -29
  83. package/sdk/application/PosCart/PosCartApplicationValidator.js +262 -15
  84. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +49 -47
  85. package/sdk/application/Rewards/RewardsApplicationClient.js +160 -102
  86. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +343 -22
  87. package/sdk/application/Rewards/RewardsApplicationModel.js +230 -15
  88. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +70 -7
  89. package/sdk/application/Rewards/RewardsApplicationValidator.js +45 -6
  90. package/sdk/application/Share/ShareApplicationClient.d.ts +44 -50
  91. package/sdk/application/Share/ShareApplicationClient.js +165 -97
  92. package/sdk/application/Share/ShareApplicationModel.d.ts +230 -15
  93. package/sdk/application/Share/ShareApplicationModel.js +154 -16
  94. package/sdk/application/Share/ShareApplicationValidator.d.ts +86 -8
  95. package/sdk/application/Share/ShareApplicationValidator.js +48 -4
  96. package/sdk/application/Theme/ThemeApplicationClient.d.ts +25 -27
  97. package/sdk/application/Theme/ThemeApplicationClient.js +83 -54
  98. package/sdk/application/Theme/ThemeApplicationModel.d.ts +621 -48
  99. package/sdk/application/Theme/ThemeApplicationModel.js +464 -40
  100. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +49 -5
  101. package/sdk/application/Theme/ThemeApplicationValidator.js +26 -3
  102. package/sdk/application/User/UserApplicationClient.d.ts +219 -303
  103. package/sdk/application/User/UserApplicationClient.js +819 -522
  104. package/sdk/application/User/UserApplicationModel.d.ts +1390 -101
  105. package/sdk/application/User/UserApplicationModel.js +983 -44
  106. package/sdk/application/User/UserApplicationValidator.d.ts +457 -33
  107. package/sdk/application/User/UserApplicationValidator.js +265 -31
  108. package/sdk/common/AxiosHelper.js +8 -2
  109. package/sdk/common/Paginator.d.ts +27 -12
  110. package/sdk/common/Paginator.js +15 -0
  111. package/sdk/common/RequestSigner.js +0 -1
  112. package/sdk/partner/PartnerAPIClient.d.ts +15 -1
  113. package/sdk/partner/PartnerAPIClient.js +8 -1
  114. package/sdk/partner/PartnerClient.d.ts +20 -3
  115. package/sdk/partner/PartnerClient.js +17 -0
  116. package/sdk/partner/PartnerConfig.d.ts +40 -14
  117. package/sdk/partner/PartnerConfig.js +31 -6
  118. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +26 -25
  119. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +82 -53
  120. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +202 -17
  121. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +139 -10
  122. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +42 -5
  123. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +26 -4
  124. package/sdk/platform/Billing/BillingPlatformClient.d.ts +88 -97
  125. package/sdk/platform/Billing/BillingPlatformClient.js +310 -191
  126. package/sdk/platform/Billing/BillingPlatformModel.d.ts +1211 -68
  127. package/sdk/platform/Billing/BillingPlatformModel.js +824 -59
  128. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +153 -12
  129. package/sdk/platform/Billing/BillingPlatformValidator.js +87 -8
  130. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +392 -634
  131. package/sdk/platform/Cart/CartPlatformApplicationClient.js +1480 -957
  132. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +827 -57
  133. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +492 -34
  134. package/sdk/platform/Cart/CartPlatformModel.d.ts +3639 -175
  135. package/sdk/platform/Cart/CartPlatformModel.js +2368 -212
  136. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +438 -615
  137. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1449 -984
  138. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1081 -49
  139. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +482 -23
  140. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +573 -824
  141. package/sdk/platform/Catalog/CatalogPlatformClient.js +1773 -1264
  142. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6871 -326
  143. package/sdk/platform/Catalog/CatalogPlatformModel.js +4215 -349
  144. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1331 -71
  145. package/sdk/platform/Catalog/CatalogPlatformValidator.js +611 -30
  146. package/sdk/platform/Common/CommonPlatformClient.d.ts +14 -21
  147. package/sdk/platform/Common/CommonPlatformClient.js +48 -33
  148. package/sdk/platform/Common/CommonPlatformModel.d.ts +448 -19
  149. package/sdk/platform/Common/CommonPlatformModel.js +224 -16
  150. package/sdk/platform/Common/CommonPlatformValidator.d.ts +42 -4
  151. package/sdk/platform/Common/CommonPlatformValidator.js +21 -3
  152. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +457 -279
  153. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +1423 -553
  154. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +581 -42
  155. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +294 -22
  156. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +18 -5
  157. package/sdk/platform/Communication/CommunicationPlatformClient.js +58 -19
  158. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1630 -102
  159. package/sdk/platform/Communication/CommunicationPlatformModel.js +1150 -85
  160. package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +16 -3
  161. package/sdk/platform/Communication/CommunicationPlatformValidator.js +11 -3
  162. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +102 -111
  163. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +321 -225
  164. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +830 -43
  165. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +612 -78
  166. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +180 -13
  167. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +98 -10
  168. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +232 -212
  169. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +737 -438
  170. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +293 -22
  171. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +184 -17
  172. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +166 -178
  173. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +519 -310
  174. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +4504 -188
  175. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2242 -204
  176. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +332 -19
  177. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +153 -10
  178. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +495 -560
  179. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1777 -987
  180. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +872 -62
  181. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +487 -35
  182. package/sdk/platform/Content/ContentPlatformModel.d.ts +1661 -108
  183. package/sdk/platform/Content/ContentPlatformModel.js +1217 -113
  184. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +67 -101
  185. package/sdk/platform/Discount/DiscountPlatformClient.js +240 -176
  186. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +242 -15
  187. package/sdk/platform/Discount/DiscountPlatformModel.js +162 -10
  188. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +185 -13
  189. package/sdk/platform/Discount/DiscountPlatformValidator.js +88 -8
  190. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +32 -41
  191. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +106 -74
  192. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +77 -6
  193. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +41 -6
  194. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +39 -54
  195. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +124 -99
  196. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +299 -20
  197. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +207 -16
  198. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +98 -8
  199. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +54 -7
  200. package/sdk/platform/Finance/FinancePlatformClient.d.ts +85 -91
  201. package/sdk/platform/Finance/FinancePlatformClient.js +272 -180
  202. package/sdk/platform/Finance/FinancePlatformModel.d.ts +619 -50
  203. package/sdk/platform/Finance/FinancePlatformModel.js +458 -30
  204. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +123 -15
  205. package/sdk/platform/Finance/FinancePlatformValidator.js +95 -16
  206. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +99 -97
  207. package/sdk/platform/Inventory/InventoryPlatformClient.js +288 -199
  208. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +1354 -61
  209. package/sdk/platform/Inventory/InventoryPlatformModel.js +916 -83
  210. package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +168 -12
  211. package/sdk/platform/Inventory/InventoryPlatformValidator.js +82 -6
  212. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +86 -106
  213. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +326 -186
  214. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +180 -14
  215. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +94 -9
  216. package/sdk/platform/Lead/LeadPlatformClient.d.ts +75 -101
  217. package/sdk/platform/Lead/LeadPlatformClient.js +240 -174
  218. package/sdk/platform/Lead/LeadPlatformModel.d.ts +1403 -54
  219. package/sdk/platform/Lead/LeadPlatformModel.js +618 -73
  220. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +173 -12
  221. package/sdk/platform/Lead/LeadPlatformValidator.js +85 -8
  222. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +18 -14
  223. package/sdk/platform/Order/OrderPlatformApplicationClient.js +56 -29
  224. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +26 -4
  225. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +16 -3
  226. package/sdk/platform/Order/OrderPlatformClient.d.ts +343 -556
  227. package/sdk/platform/Order/OrderPlatformClient.js +969 -762
  228. package/sdk/platform/Order/OrderPlatformModel.d.ts +4967 -247
  229. package/sdk/platform/Order/OrderPlatformModel.js +3249 -259
  230. package/sdk/platform/Order/OrderPlatformValidator.d.ts +758 -37
  231. package/sdk/platform/Order/OrderPlatformValidator.js +351 -22
  232. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +28 -36
  233. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +103 -59
  234. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +66 -6
  235. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +32 -4
  236. package/sdk/platform/Partner/PartnerPlatformClient.d.ts +68 -107
  237. package/sdk/platform/Partner/PartnerPlatformClient.js +253 -174
  238. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +767 -45
  239. package/sdk/platform/Partner/PartnerPlatformModel.js +524 -41
  240. package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +207 -13
  241. package/sdk/platform/Partner/PartnerPlatformValidator.js +87 -5
  242. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +255 -260
  243. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +860 -504
  244. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +348 -30
  245. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +221 -19
  246. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +73 -73
  247. package/sdk/platform/Payment/PaymentPlatformClient.js +238 -154
  248. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2658 -93
  249. package/sdk/platform/Payment/PaymentPlatformModel.js +1035 -36
  250. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +111 -11
  251. package/sdk/platform/Payment/PaymentPlatformValidator.js +68 -7
  252. package/sdk/platform/PlatformAPIClient.d.ts +16 -1
  253. package/sdk/platform/PlatformAPIClient.js +9 -1
  254. package/sdk/platform/PlatformApplicationClient.d.ts +22 -1798
  255. package/sdk/platform/PlatformApplicationClient.js +17 -1899
  256. package/sdk/platform/PlatformClient.d.ts +29 -12579
  257. package/sdk/platform/PlatformClient.js +26 -15085
  258. package/sdk/platform/PlatformConfig.d.ts +37 -11
  259. package/sdk/platform/PlatformConfig.js +32 -6
  260. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +80 -92
  261. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +307 -177
  262. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +149 -12
  263. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +82 -8
  264. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +371 -23
  265. package/sdk/platform/Rewards/RewardsPlatformModel.js +246 -16
  266. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +120 -89
  267. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +349 -201
  268. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +128 -12
  269. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +85 -11
  270. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +148 -178
  271. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +454 -329
  272. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1399 -96
  273. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1022 -71
  274. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +280 -18
  275. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +134 -11
  276. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +38 -47
  277. package/sdk/platform/Share/SharePlatformApplicationClient.js +137 -73
  278. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +87 -7
  279. package/sdk/platform/Share/SharePlatformApplicationValidator.js +42 -5
  280. package/sdk/platform/Share/SharePlatformModel.d.ts +250 -16
  281. package/sdk/platform/Share/SharePlatformModel.js +165 -17
  282. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +149 -183
  283. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +579 -330
  284. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +308 -24
  285. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +162 -10
  286. package/sdk/platform/Theme/ThemePlatformModel.d.ts +621 -48
  287. package/sdk/platform/Theme/ThemePlatformModel.js +464 -40
  288. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +119 -151
  289. package/sdk/platform/User/UserPlatformApplicationClient.js +411 -244
  290. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +235 -18
  291. package/sdk/platform/User/UserPlatformApplicationValidator.js +126 -12
  292. package/sdk/platform/User/UserPlatformModel.d.ts +1390 -101
  293. package/sdk/platform/User/UserPlatformModel.js +983 -44
  294. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +38 -47
  295. package/sdk/platform/Webhook/WebhookPlatformClient.js +137 -87
  296. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +242 -16
  297. package/sdk/platform/Webhook/WebhookPlatformModel.js +167 -18
  298. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +83 -7
  299. package/sdk/platform/Webhook/WebhookPlatformValidator.js +43 -5
  300. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -21
  301. package/sdk/public/Configuration/ConfigurationPublicClient.js +46 -33
  302. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +473 -19
  303. package/sdk/public/Configuration/ConfigurationPublicModel.js +224 -16
  304. package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +42 -4
  305. package/sdk/public/Configuration/ConfigurationPublicValidator.js +21 -3
  306. package/sdk/public/Inventory/InventoryPublicClient.d.ts +48 -48
  307. package/sdk/public/Inventory/InventoryPublicClient.js +146 -98
  308. package/sdk/public/Inventory/InventoryPublicModel.d.ts +392 -21
  309. package/sdk/public/Inventory/InventoryPublicModel.js +267 -27
  310. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +90 -8
  311. package/sdk/public/Inventory/InventoryPublicValidator.js +44 -4
  312. package/sdk/public/PublicClient.d.ts +19 -3
  313. package/sdk/public/PublicClient.js +16 -0
  314. package/sdk/public/PublicConfig.d.ts +27 -6
  315. package/sdk/public/PublicConfig.js +17 -1
  316. package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -11
  317. package/sdk/public/Webhook/WebhookPublicClient.js +42 -27
  318. package/sdk/public/Webhook/WebhookPublicModel.d.ts +242 -16
  319. package/sdk/public/Webhook/WebhookPublicModel.js +167 -18
  320. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +18 -3
  321. package/sdk/public/Webhook/WebhookPublicValidator.js +14 -4
@@ -3,990 +3,739 @@ declare class Catalog {
3
3
  constructor(config: any);
4
4
  config: any;
5
5
  /**
6
- * @param {Object} arg - Arg object.
7
- * @param {number} arg.itemId - Item code of the product of which size is to be get.
8
- * @param {string} arg.size - Size in which inventory is to be added.
9
- * @param {InventoryRequest} arg.body
10
- * @returns {Promise<SuccessResponse>} - Success response
6
+ * @param {CatalogPlatformValidator.AddInventoryParam} arg - Arg object
7
+ * @param {import("../PlatformAPIClient").Options} - Options
8
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
9
+ * @name addInventory
11
10
  * @summary: Add Inventory for particular size and store.
12
- * @description: This API allows add Inventory for particular size and store.
11
+ * @description: This API allows add Inventory for particular size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/addInventory/).
13
12
  */
14
- addInventory({ itemId, size, body }?: {
15
- itemId: number;
16
- size: string;
17
- body: InventoryRequest;
18
- }): Promise<SuccessResponse>;
13
+ addInventory({ itemId, size, body }?: CatalogPlatformValidator.AddInventoryParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.SuccessResponse>;
19
14
  /**
20
- * @param {Object} arg - Arg object.
21
- * @param {number} arg.itemId - Id of the product to be updated.
22
- * @returns {Promise<GetAllSizes>} - Success response
15
+ * @param {CatalogPlatformValidator.AllSizesParam} arg - Arg object
16
+ * @param {import("../PlatformAPIClient").Options} - Options
17
+ * @returns {Promise<CatalogPlatformModel.GetAllSizes>} - Success response
18
+ * @name allSizes
23
19
  * @summary: All Sizes for a given Product
24
- * @description: This API allows to get All Sizes for a given Product.
20
+ * @description: This API allows to get All Sizes for a given Product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/allSizes/).
25
21
  */
26
- allSizes({ itemId }?: {
27
- itemId: number;
28
- }): Promise<GetAllSizes>;
22
+ allSizes({ itemId }?: CatalogPlatformValidator.AllSizesParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.GetAllSizes>;
29
23
  /**
30
- * @param {Object} arg - Arg object.
31
- * @param {BulkHsnUpsert} arg.body
32
- * @returns {Promise<BulkHsnResponse>} - Success response
24
+ * @param {CatalogPlatformValidator.BulkHsnCodeParam} arg - Arg object
25
+ * @param {import("../PlatformAPIClient").Options} - Options
26
+ * @returns {Promise<CatalogPlatformModel.BulkHsnResponse>} - Success response
27
+ * @name bulkHsnCode
33
28
  * @summary: Bulk Create or Update Hsn Code.
34
- * @description: Bulk Create or Update Hsn Code.
29
+ * @description: Bulk Create or Update Hsn Code. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/bulkHsnCode/).
35
30
  */
36
- bulkHsnCode({ body }?: {
37
- body: BulkHsnUpsert;
38
- }): Promise<BulkHsnResponse>;
31
+ bulkHsnCode({ body }?: CatalogPlatformValidator.BulkHsnCodeParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.BulkHsnResponse>;
39
32
  /**
40
- * @param {Object} arg - Arg object.
41
- * @param {string} arg.batchId - Batch Id of the bulk create job.
42
- * @param {InventoryBulkRequest} arg.body
43
- * @returns {Promise<SuccessResponse>} - Success response
33
+ * @param {CatalogPlatformValidator.CreateBulkInventoryParam} arg - Arg object
34
+ * @param {import("../PlatformAPIClient").Options} - Options
35
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
36
+ * @name createBulkInventory
44
37
  * @summary: Create products in bulk associated with given batch Id.
45
- * @description: This API helps to create products in bulk push to kafka for approval/creation.
38
+ * @description: This API helps to create products in bulk push to kafka for approval/creation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createBulkInventory/).
46
39
  */
47
- createBulkInventory({ batchId, body }?: {
48
- batchId: string;
49
- body: InventoryBulkRequest;
50
- }): Promise<SuccessResponse>;
40
+ createBulkInventory({ batchId, body }?: CatalogPlatformValidator.CreateBulkInventoryParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.SuccessResponse>;
51
41
  /**
52
- * @param {Object} arg - Arg object.
53
- * @param {BulkJob} arg.body
54
- * @returns {Promise<BulkResponse>} - Success response
42
+ * @param {CatalogPlatformValidator.CreateBulkInventoryJobParam} arg - Arg object
43
+ * @param {import("../PlatformAPIClient").Options} - Options
44
+ * @returns {Promise<CatalogPlatformModel.BulkResponse>} - Success response
45
+ * @name createBulkInventoryJob
55
46
  * @summary: Create a Bulk Inventory upload Job.
56
- * @description: This API helps to create a bulk Inventory upload job.
47
+ * @description: This API helps to create a bulk Inventory upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createBulkInventoryJob/).
57
48
  */
58
- createBulkInventoryJob({ body }?: {
59
- body: BulkJob;
60
- }): Promise<BulkResponse>;
49
+ createBulkInventoryJob({ body }?: CatalogPlatformValidator.CreateBulkInventoryJobParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.BulkResponse>;
61
50
  /**
62
- * @param {Object} arg - Arg object.
63
- * @param {BulkJob} arg.body
64
- * @returns {Promise<BulkResponse>} - Success response
51
+ * @param {CatalogPlatformValidator.CreateBulkProductUploadJobParam} arg - Arg object
52
+ * @param {import("../PlatformAPIClient").Options} - Options
53
+ * @returns {Promise<CatalogPlatformModel.BulkResponse>} - Success response
54
+ * @name createBulkProductUploadJob
65
55
  * @summary: Create a Bulk product to upload job.
66
- * @description: This API helps to create a bulk products upload job.
56
+ * @description: This API helps to create a bulk products upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createBulkProductUploadJob/).
67
57
  */
68
- createBulkProductUploadJob({ body }?: {
69
- body: BulkJob;
70
- }): Promise<BulkResponse>;
58
+ createBulkProductUploadJob({ body }?: CatalogPlatformValidator.CreateBulkProductUploadJobParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.BulkResponse>;
71
59
  /**
72
- * @param {Object} arg - Arg object.
73
- * @param {CategoryRequestBody} arg.body
74
- * @returns {Promise<CategoryCreateResponse>} - Success response
60
+ * @param {CatalogPlatformValidator.CreateCategoriesParam} arg - Arg object
61
+ * @param {import("../PlatformAPIClient").Options} - Options
62
+ * @returns {Promise<CatalogPlatformModel.CategoryCreateResponse>} - Success response
63
+ * @name createCategories
75
64
  * @summary: Create product categories
76
- * @description: This API lets user create product categories
65
+ * @description: This API lets user create product categories - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCategories/).
77
66
  */
78
- createCategories({ body }?: {
79
- body: CategoryRequestBody;
80
- }): Promise<CategoryCreateResponse>;
67
+ createCategories({ body }?: CatalogPlatformValidator.CreateCategoriesParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.CategoryCreateResponse>;
81
68
  /**
82
- * @param {Object} arg - Arg object.
83
- * @param {DepartmentCreateUpdate} arg.body
84
- * @returns {Promise<DepartmentCreateResponse>} - Success response
69
+ * @param {CatalogPlatformValidator.CreateDepartmentsParam} arg - Arg object
70
+ * @param {import("../PlatformAPIClient").Options} - Options
71
+ * @returns {Promise<CatalogPlatformModel.DepartmentCreateResponse>} -
72
+ * Success response
73
+ * @name createDepartments
85
74
  * @summary: Create the department.
86
- * @description: Create departments using the API.
75
+ * @description: Create departments using the API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createDepartments/).
87
76
  */
88
- createDepartments({ body }?: {
89
- body: DepartmentCreateUpdate;
90
- }): Promise<DepartmentCreateResponse>;
77
+ createDepartments({ body }?: CatalogPlatformValidator.CreateDepartmentsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.DepartmentCreateResponse>;
91
78
  /**
92
- * @param {Object} arg - Arg object.
93
- * @param {InventoryCreateRequest} arg.body
94
- * @returns {Promise<InventoryExportResponse>} - Success response
79
+ * @param {CatalogPlatformValidator.CreateInventoryExportParam} arg - Arg object
80
+ * @param {import("../PlatformAPIClient").Options} - Options
81
+ * @returns {Promise<CatalogPlatformModel.InventoryExportResponse>} - Success response
82
+ * @name createInventoryExport
95
83
  * @summary: Create an inventory export job.
96
- * @description: This API helps to create a Inventory export job.
84
+ * @description: This API helps to create a Inventory export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createInventoryExport/).
97
85
  */
98
- createInventoryExport({ body }?: {
99
- body: InventoryCreateRequest;
100
- }): Promise<InventoryExportResponse>;
86
+ createInventoryExport({ body }?: CatalogPlatformValidator.CreateInventoryExportParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.InventoryExportResponse>;
101
87
  /**
102
- * @param {Object} arg - Arg object.
103
- * @param {InventoryExportRequest} arg.body
104
- * @returns {Promise<InventoryExportResponse>} - Success response
88
+ * @param {CatalogPlatformValidator.CreateInventoryExportJobParam} arg - Arg object
89
+ * @param {import("../PlatformAPIClient").Options} - Options
90
+ * @returns {Promise<CatalogPlatformModel.InventoryExportResponse>} - Success response
91
+ * @name createInventoryExportJob
105
92
  * @summary: Create a Inventory export Job.
106
- * @description: This API helps to create a Inventory export job.
93
+ * @description: This API helps to create a Inventory export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createInventoryExportJob/).
107
94
  */
108
- createInventoryExportJob({ body }?: {
109
- body: InventoryExportRequest;
110
- }): Promise<InventoryExportResponse>;
95
+ createInventoryExportJob({ body }?: CatalogPlatformValidator.CreateInventoryExportJobParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.InventoryExportResponse>;
111
96
  /**
112
- * @param {Object} arg - Arg object.
113
- * @param {string} arg.marketplace - The marketplace for which the detail
114
- * needs to be retrieved.
115
- * @param {OptInPostRequest} arg.body
116
- * @returns {Promise<UpdatedResponse>} - Success response
97
+ * @param {CatalogPlatformValidator.CreateMarketplaceOptinParam} arg - Arg object
98
+ * @param {import("../PlatformAPIClient").Options} - Options
99
+ * @returns {Promise<CatalogPlatformModel.UpdatedResponse>} - Success response
100
+ * @name createMarketplaceOptin
117
101
  * @summary: Create/Update opt-in infomation.
118
- * @description: Use this API to create/update opt-in information for given platform. If successful, returns data in the response body as specified in `OptInPostResponseSchema`
102
+ * @description: Use this API to create/update opt-in information for given platform. If successful, returns data in the response body as specified in `OptInPostResponseSchema` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createMarketplaceOptin/).
119
103
  */
120
- createMarketplaceOptin({ marketplace, body }?: {
121
- marketplace: string;
122
- body: OptInPostRequest;
123
- }): Promise<UpdatedResponse>;
104
+ createMarketplaceOptin({ marketplace, body }?: CatalogPlatformValidator.CreateMarketplaceOptinParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.UpdatedResponse>;
124
105
  /**
125
- * @param {Object} arg - Arg object.
126
- * @param {ProductCreateUpdateSchemaV2} arg.body
127
- * @returns {Promise<SuccessResponse>} - Success response
106
+ * @param {CatalogPlatformValidator.CreateProductParam} arg - Arg object
107
+ * @param {import("../PlatformAPIClient").Options} - Options
108
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
109
+ * @name createProduct
128
110
  * @summary: Create a product.
129
- * @description: This API allows to create product.
111
+ * @description: This API allows to create product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProduct/).
130
112
  */
131
- createProduct({ body }?: {
132
- body: ProductCreateUpdateSchemaV2;
133
- }): Promise<SuccessResponse>;
113
+ createProduct({ body }?: CatalogPlatformValidator.CreateProductParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.SuccessResponse>;
134
114
  /**
135
- * @param {Object} arg - Arg object.
136
- * @param {ProductBulkAssets} arg.body
137
- * @returns {Promise<SuccessResponse>} - Success response
115
+ * @param {CatalogPlatformValidator.CreateProductAssetsInBulkParam} arg - Arg object
116
+ * @param {import("../PlatformAPIClient").Options} - Options
117
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
118
+ * @name createProductAssetsInBulk
138
119
  * @summary: Create a Bulk asset upload Job.
139
- * @description: This API helps to create a bulk asset upload job.
120
+ * @description: This API helps to create a bulk asset upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductAssetsInBulk/).
140
121
  */
141
- createProductAssetsInBulk({ body }?: {
142
- body: ProductBulkAssets;
143
- }): Promise<SuccessResponse>;
122
+ createProductAssetsInBulk({ body }?: CatalogPlatformValidator.CreateProductAssetsInBulkParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.SuccessResponse>;
144
123
  /**
145
- * @param {Object} arg - Arg object.
146
- * @param {ProductBundleRequest} arg.body
147
- * @returns {Promise<GetProductBundleCreateResponse>} - Success response
124
+ * @param {CatalogPlatformValidator.CreateProductBundleParam} arg - Arg object
125
+ * @param {import("../PlatformAPIClient").Options} - Options
126
+ * @returns {Promise<CatalogPlatformModel.GetProductBundleCreateResponse>}
127
+ * - Success response
128
+ *
129
+ * @name createProductBundle
148
130
  * @summary: Create Product Bundle
149
- * @description: Create Product Bundle. See `ProductBundleRequest` for the request body parameter need to create a product bundle. On successful request, returns in `ProductBundleRequest` with id
131
+ * @description: Create Product Bundle. See `ProductBundleRequest` for the request body parameter need to create a product bundle. On successful request, returns in `ProductBundleRequest` with id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductBundle/).
150
132
  */
151
- createProductBundle({ body }?: {
152
- body: ProductBundleRequest;
153
- }): Promise<GetProductBundleCreateResponse>;
133
+ createProductBundle({ body }?: CatalogPlatformValidator.CreateProductBundleParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.GetProductBundleCreateResponse>;
154
134
  /**
155
- * @param {Object} arg - Arg object.
156
- * @param {ProductTemplateDownloadsExport} arg.body
157
- * @returns {Promise<ProductDownloadsResponse>} - Success response
135
+ * @param {CatalogPlatformValidator.CreateProductExportJobParam} arg - Arg object
136
+ * @param {import("../PlatformAPIClient").Options} - Options
137
+ * @returns {Promise<CatalogPlatformModel.ProductDownloadsResponse>} -
138
+ * Success response
139
+ * @name createProductExportJob
158
140
  * @summary: Create a product export job.
159
- * @description: This API helps to create a Inventory export job.
141
+ * @description: This API helps to create a Inventory export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductExportJob/).
160
142
  */
161
- createProductExportJob({ body }?: {
162
- body: ProductTemplateDownloadsExport;
163
- }): Promise<ProductDownloadsResponse>;
143
+ createProductExportJob({ body }?: CatalogPlatformValidator.CreateProductExportJobParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.ProductDownloadsResponse>;
164
144
  /**
165
- * @param {Object} arg - Arg object.
166
- * @param {string} arg.batchId - Batch Id in which assets to be uploaded.
167
- * @param {BulkProductRequest} arg.body
168
- * @returns {Promise<SuccessResponse>} - Success response
145
+ * @param {CatalogPlatformValidator.CreateProductsInBulkParam} arg - Arg object
146
+ * @param {import("../PlatformAPIClient").Options} - Options
147
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
148
+ * @name createProductsInBulk
169
149
  * @summary: Create products in bulk associated with given batch Id.
170
- * @description: This API helps to create products in bulk push to kafka for approval/creation.
150
+ * @description: This API helps to create products in bulk push to kafka for approval/creation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductsInBulk/).
171
151
  */
172
- createProductsInBulk({ batchId, body }?: {
173
- batchId: string;
174
- body: BulkProductRequest;
175
- }): Promise<SuccessResponse>;
152
+ createProductsInBulk({ batchId, body }?: CatalogPlatformValidator.CreateProductsInBulkParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.SuccessResponse>;
176
153
  /**
177
- * @param {Object} arg - Arg object.
178
- * @param {ValidateSizeGuide} arg.body
179
- * @returns {Promise<SuccessResponse>} - Success response
154
+ * @param {CatalogPlatformValidator.CreateSizeGuideParam} arg - Arg object
155
+ * @param {import("../PlatformAPIClient").Options} - Options
156
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
157
+ * @name createSizeGuide
180
158
  * @summary: Create a size guide.
181
- * @description: This API allows to create a size guide associated to a brand.
159
+ * @description: This API allows to create a size guide associated to a brand. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createSizeGuide/).
182
160
  */
183
- createSizeGuide({ body }?: {
184
- body: ValidateSizeGuide;
185
- }): Promise<SuccessResponse>;
161
+ createSizeGuide({ body }?: CatalogPlatformValidator.CreateSizeGuideParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.SuccessResponse>;
186
162
  /**
187
- * @param {Object} arg - Arg object.
188
- * @param {string} arg.batchId - Batch Id of the bulk delete job.
189
- * @returns {Promise<SuccessResponse>} - Success response
163
+ * @param {CatalogPlatformValidator.DeleteBulkInventoryJobParam} arg - Arg object
164
+ * @param {import("../PlatformAPIClient").Options} - Options
165
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
166
+ * @name deleteBulkInventoryJob
190
167
  * @summary: Delete Bulk Inventory job.
191
- * @description: This API allows to delete bulk Inventory job associated with company.
192
- */
193
- deleteBulkInventoryJob({ batchId }?: {
194
- batchId: string;
195
- }): Promise<SuccessResponse>;
196
- /**
197
- * @param {Object} arg - Arg object.
198
- * @param {string} arg.size - Size that is to be deleted.
199
- * @param {number} arg.itemId - Id of the product associated with Inventory
200
- * to be deleted.
201
- * @param {number} arg.locationId - Location ID of store of which inventory
202
- * is to be deleted.
203
- * @returns {Promise<SuccessResponse>} - Success response
168
+ * @description: This API allows to delete bulk Inventory job associated with company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteBulkInventoryJob/).
169
+ */
170
+ deleteBulkInventoryJob({ batchId }?: CatalogPlatformValidator.DeleteBulkInventoryJobParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.SuccessResponse>;
171
+ /**
172
+ * @param {CatalogPlatformValidator.DeleteInventoryParam} arg - Arg object
173
+ * @param {import("../PlatformAPIClient").Options} - Options
174
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
175
+ * @name deleteInventory
204
176
  * @summary: Delete a Inventory.
205
- * @description: This API allows to delete inventory of a particular product for particular company.
177
+ * @description: This API allows to delete inventory of a particular product for particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteInventory/).
206
178
  */
207
- deleteInventory({ size, itemId, locationId }?: {
208
- size: string;
209
- itemId: number;
210
- locationId: number;
211
- }): Promise<SuccessResponse>;
179
+ deleteInventory({ size, itemId, locationId }?: CatalogPlatformValidator.DeleteInventoryParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.SuccessResponse>;
212
180
  /**
213
- * @param {Object} arg - Arg object.
214
- * @param {number} arg.itemId - Id of the product to be updated.
215
- * @returns {Promise<SuccessResponse>} - Success response
181
+ * @param {CatalogPlatformValidator.DeleteProductParam} arg - Arg object
182
+ * @param {import("../PlatformAPIClient").Options} - Options
183
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
184
+ * @name deleteProduct
216
185
  * @summary: Delete a product.
217
- * @description: This API allows to delete product.
186
+ * @description: This API allows to delete product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteProduct/).
218
187
  */
219
- deleteProduct({ itemId }?: {
220
- itemId: number;
221
- }): Promise<SuccessResponse>;
188
+ deleteProduct({ itemId }?: CatalogPlatformValidator.DeleteProductParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.SuccessResponse>;
222
189
  /**
223
- * @param {Object} arg - Arg object.
224
- * @param {number} arg.batchId - Batch Id of the bulk product job to be deleted.
225
- * @returns {Promise<SuccessResponse>} - Success response
190
+ * @param {CatalogPlatformValidator.DeleteProductBulkJobParam} arg - Arg object
191
+ * @param {import("../PlatformAPIClient").Options} - Options
192
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
193
+ * @name deleteProductBulkJob
226
194
  * @summary: Delete Bulk product job.
227
- * @description: This API allows to delete bulk product job associated with company.
228
- */
229
- deleteProductBulkJob({ batchId }?: {
230
- batchId: number;
231
- }): Promise<SuccessResponse>;
232
- /**
233
- * @param {Object} arg - Arg object.
234
- * @param {number} arg.itemId - Item code of the product of which size is to be get.
235
- * @param {string} arg.sellerIdentifier - Size Identifier (Seller Identifier
236
- * or Primary Identifier) of which inventory is to get.
237
- * @param {InventoryRequestSchemaV2} arg.body
238
- * @returns {Promise<InventoryUpdateResponse>} - Success response
195
+ * @description: This API allows to delete bulk product job associated with company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteProductBulkJob/).
196
+ */
197
+ deleteProductBulkJob({ batchId }?: CatalogPlatformValidator.DeleteProductBulkJobParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.SuccessResponse>;
198
+ /**
199
+ * @param {CatalogPlatformValidator.DeleteRealtimeInventoryParam} arg - Arg object
200
+ * @param {import("../PlatformAPIClient").Options} - Options
201
+ * @returns {Promise<CatalogPlatformModel.InventoryUpdateResponse>} - Success response
202
+ * @name deleteRealtimeInventory
239
203
  * @summary: Add Inventory for particular size and store.
240
- * @description: This API allows add Inventory for particular size and store.
241
- */
242
- deleteRealtimeInventory({ itemId, sellerIdentifier, body }?: {
243
- itemId: number;
244
- sellerIdentifier: string;
245
- body: InventoryRequestSchemaV2;
246
- }): Promise<InventoryUpdateResponse>;
247
- /**
248
- * @param {Object} arg - Arg object.
249
- * @param {number} arg.itemId - Item Id of the product associated with size
250
- * to be deleted.
251
- * @param {string} arg.size - Size to be deleted.
252
- * @returns {Promise<ProductSizeDeleteResponse>} - Success response
204
+ * @description: This API allows add Inventory for particular size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteRealtimeInventory/).
205
+ */
206
+ deleteRealtimeInventory({ itemId, sellerIdentifier, body }?: CatalogPlatformValidator.DeleteRealtimeInventoryParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.InventoryUpdateResponse>;
207
+ /**
208
+ * @param {CatalogPlatformValidator.DeleteSizeParam} arg - Arg object
209
+ * @param {import("../PlatformAPIClient").Options} - Options
210
+ * @returns {Promise<CatalogPlatformModel.ProductSizeDeleteResponse>} -
211
+ * Success response
212
+ * @name deleteSize
253
213
  * @summary: Delete a Size associated with product.
254
- * @description: This API allows to delete size associated with product.
214
+ * @description: This API allows to delete size associated with product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteSize/).
255
215
  */
256
- deleteSize({ itemId, size }?: {
257
- itemId: number;
258
- size: string;
259
- }): Promise<ProductSizeDeleteResponse>;
216
+ deleteSize({ itemId, size }?: CatalogPlatformValidator.DeleteSizeParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.ProductSizeDeleteResponse>;
260
217
  /**
261
- * @param {Object} arg - Arg object.
262
- * @param {string} arg.itemType - An `item_type` defines the type of item.
218
+ * @param {CatalogPlatformValidator.DownloadInventoryTemplateViewParam} arg
219
+ * - Arg object
220
+ *
221
+ * @param {import("../PlatformAPIClient").Options} - Options
263
222
  * @returns {Promise<string>} - Success response
223
+ * @name downloadInventoryTemplateView
264
224
  * @summary: Download Product Template View
265
- * @description: Allows you to download product template data
225
+ * @description: Allows you to download product template data - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/downloadInventoryTemplateView/).
266
226
  */
267
- downloadInventoryTemplateView({ itemType }?: {
268
- itemType: string;
269
- }): Promise<string>;
227
+ downloadInventoryTemplateView({ itemType }?: CatalogPlatformValidator.DownloadInventoryTemplateViewParam, { headers }?: import("../PlatformAPIClient").Options): Promise<string>;
270
228
  /**
271
- * @param {Object} arg - Arg object.
272
- * @param {string} arg.slug - A `slug` is a unique identifier for a
273
- * particular template.
229
+ * @param {CatalogPlatformValidator.DownloadProductTemplateViewsParam} arg
230
+ * - Arg object
231
+ *
232
+ * @param {import("../PlatformAPIClient").Options} - Options
274
233
  * @returns {Promise<string>} - Success response
234
+ * @name downloadProductTemplateViews
275
235
  * @summary: Download Product Template View
276
- * @description: Allows you to download product template data
236
+ * @description: Allows you to download product template data - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/downloadProductTemplateViews/).
277
237
  */
278
- downloadProductTemplateViews({ slug }?: {
279
- slug: string;
280
- }): Promise<string>;
238
+ downloadProductTemplateViews({ slug }?: CatalogPlatformValidator.DownloadProductTemplateViewsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<string>;
281
239
  /**
282
- * @param {Object} arg - Arg object.
283
- * @param {number} arg.itemId - Id of the product to be updated.
284
- * @param {ProductCreateUpdateSchemaV2} arg.body
285
- * @returns {Promise<SuccessResponse>} - Success response
240
+ * @param {CatalogPlatformValidator.EditProductParam} arg - Arg object
241
+ * @param {import("../PlatformAPIClient").Options} - Options
242
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
243
+ * @name editProduct
286
244
  * @summary: Edit a product.
287
- * @description: This API allows to edit product.
245
+ * @description: This API allows to edit product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/editProduct/).
288
246
  */
289
- editProduct({ itemId, body }?: {
290
- itemId: number;
291
- body: ProductCreateUpdateSchemaV2;
292
- }): Promise<SuccessResponse>;
247
+ editProduct({ itemId, body }?: CatalogPlatformValidator.EditProductParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.SuccessResponse>;
293
248
  /**
294
- * @param {Object} arg - Arg object.
295
- * @param {string} [arg.filterType] - Filter type from any one of ['brand',
296
- * 'store', 'type']
297
- * @returns {Promise<InventoryConfig>} - Success response
249
+ * @param {CatalogPlatformValidator.ExportInventoryConfigParam} arg - Arg object
250
+ * @param {import("../PlatformAPIClient").Options} - Options
251
+ * @returns {Promise<CatalogPlatformModel.InventoryConfig>} - Success response
252
+ * @name exportInventoryConfig
298
253
  * @summary: Get List of different filters for inventory export
299
- * @description: This API allows get List of different filters like brand, store, and type for inventory export.
300
- */
301
- exportInventoryConfig({ filterType }?: {
302
- filterType?: string;
303
- }): Promise<InventoryConfig>;
304
- /**
305
- * @param {Object} arg - Arg object.
306
- * @param {number} [arg.pageNo] - Page no
307
- * @param {number} [arg.pageSize] - Page size
308
- * @param {string} [arg.q] - Search using hsn code, description, reporting_hsn
309
- * @param {string} [arg.type] - Search using type
310
- * @returns {Promise<HsnCodesListingResponseSchemaV2>} - Success response
254
+ * @description: This API allows get List of different filters like brand, store, and type for inventory export. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/exportInventoryConfig/).
255
+ */
256
+ exportInventoryConfig({ filterType }?: CatalogPlatformValidator.ExportInventoryConfigParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.InventoryConfig>;
257
+ /**
258
+ * @param {CatalogPlatformValidator.GetAllProductHsnCodesParam} arg - Arg object
259
+ * @param {import("../PlatformAPIClient").Options} - Options
260
+ * @returns {Promise<CatalogPlatformModel.HsnCodesListingResponseSchemaV2>}
261
+ * - Success response
262
+ *
263
+ * @name getAllProductHsnCodes
311
264
  * @summary: Hsn Code List.
312
- * @description: Hsn Code List.
313
- */
314
- getAllProductHsnCodes({ pageNo, pageSize, q, type }?: {
315
- pageNo?: number;
316
- pageSize?: number;
317
- q?: string;
318
- type?: string;
319
- }): Promise<HsnCodesListingResponseSchemaV2>;
320
- /**
321
- * @param {Object} arg - Arg object.
322
- * @param {string} arg.uid - Category unique id
323
- * @returns {Promise<SingleCategoryResponse>} - Success response
265
+ * @description: Hsn Code List. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllProductHsnCodes/).
266
+ */
267
+ getAllProductHsnCodes({ pageNo, pageSize, q, type }?: CatalogPlatformValidator.GetAllProductHsnCodesParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.HsnCodesListingResponseSchemaV2>;
268
+ /**
269
+ * @param {CatalogPlatformValidator.GetCategoryDataParam} arg - Arg object
270
+ * @param {import("../PlatformAPIClient").Options} - Options
271
+ * @returns {Promise<CatalogPlatformModel.SingleCategoryResponse>} - Success response
272
+ * @name getCategoryData
324
273
  * @summary: Get product category by uid
325
- * @description: This API gets meta associated to product categories.
326
- */
327
- getCategoryData({ uid }?: {
328
- uid: string;
329
- }): Promise<SingleCategoryResponse>;
330
- /**
331
- * @param {Object} arg - Arg object.
332
- * @param {boolean} [arg.isActive] - The is_active status for the optin id.
333
- * @param {string} [arg.q] - The search value to filter the list.
334
- * @param {number} [arg.pageNo] - The number of page for the company id.
335
- * @param {number} [arg.pageSize] - Number of records that can be seen on
336
- * the page for the company id.
337
- * @param {string} [arg.marketplace] - The marketplace platform associated
338
- * with the company id.
339
- * @returns {Promise<OptinCompanyBrandDetailsView>} - Success response
274
+ * @description: This API gets meta associated to product categories. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCategoryData/).
275
+ */
276
+ getCategoryData({ uid }?: CatalogPlatformValidator.GetCategoryDataParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.SingleCategoryResponse>;
277
+ /**
278
+ * @param {CatalogPlatformValidator.GetCompanyBrandDetailParam} arg - Arg object
279
+ * @param {import("../PlatformAPIClient").Options} - Options
280
+ * @returns {Promise<CatalogPlatformModel.OptinCompanyBrandDetailsView>} -
281
+ * Success response
282
+ * @name getCompanyBrandDetail
340
283
  * @summary: Get the Company Brand details of Optin.
341
- * @description: Get the details of the Brands associated with the given company_id passed.
342
- */
343
- getCompanyBrandDetail({ isActive, q, pageNo, pageSize, marketplace, }?: {
344
- isActive?: boolean;
345
- q?: string;
346
- pageNo?: number;
347
- pageSize?: number;
348
- marketplace?: string;
349
- }): Promise<OptinCompanyBrandDetailsView>;
350
- /**
351
- * @param {Object} arg - Arg object.
352
- * @returns {Promise<OptinCompanyDetail>} - Success response
284
+ * @description: Get the details of the Brands associated with the given company_id passed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyBrandDetail/).
285
+ */
286
+ getCompanyBrandDetail({ isActive, q, pageNo, pageSize, marketplace }?: CatalogPlatformValidator.GetCompanyBrandDetailParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.OptinCompanyBrandDetailsView>;
287
+ /**
288
+ * @param {CatalogPlatformValidator.GetCompanyDetailParam} arg - Arg object
289
+ * @param {import("../PlatformAPIClient").Options} - Options
290
+ * @returns {Promise<CatalogPlatformModel.OptinCompanyDetail>} - Success response
291
+ * @name getCompanyDetail
353
292
  * @summary: Get the Company details.
354
- * @description: Get the details of the company associated with the given company_id passed.
293
+ * @description: Get the details of the company associated with the given company_id passed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyDetail/).
355
294
  */
356
- getCompanyDetail({}?: any): Promise<OptinCompanyDetail>;
295
+ getCompanyDetail({ headers }?: any): Promise<CatalogPlatformModel.OptinCompanyDetail>;
357
296
  /**
358
- * @param {Object} arg - Arg object.
359
- * @returns {Promise<OptinCompanyMetrics>} - Success response
297
+ * @param {CatalogPlatformValidator.GetCompanyMetricsParam} arg - Arg object
298
+ * @param {import("../PlatformAPIClient").Options} - Options
299
+ * @returns {Promise<CatalogPlatformModel.OptinCompanyMetrics>} - Success response
300
+ * @name getCompanyMetrics
360
301
  * @summary: Get the Company metrics
361
- * @description: Get the Company metrics associated with the company ID passed.
302
+ * @description: Get the Company metrics associated with the company ID passed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyMetrics/).
362
303
  */
363
- getCompanyMetrics({}?: any): Promise<OptinCompanyMetrics>;
304
+ getCompanyMetrics({ headers }?: any): Promise<CatalogPlatformModel.OptinCompanyMetrics>;
364
305
  /**
365
- * @param {Object} arg - Arg object.
366
- * @param {string} arg.uid - A `uid` is a unique identifier of a department.
367
- * @returns {Promise<DepartmentsResponse>} - Success response
306
+ * @param {CatalogPlatformValidator.GetDepartmentDataParam} arg - Arg object
307
+ * @param {import("../PlatformAPIClient").Options} - Options
308
+ * @returns {Promise<CatalogPlatformModel.DepartmentsResponse>} - Success response
309
+ * @name getDepartmentData
368
310
  * @summary: Get specific departments details by passing in unique id of the department.
369
- * @description: Allows you to get department data, by uid.
311
+ * @description: Allows you to get department data, by uid. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getDepartmentData/).
370
312
  */
371
- getDepartmentData({ uid }?: {
372
- uid: string;
373
- }): Promise<DepartmentsResponse>;
313
+ getDepartmentData({ uid }?: CatalogPlatformValidator.GetDepartmentDataParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.DepartmentsResponse>;
374
314
  /**
375
- * @param {Object} arg - Arg object.
376
- * @param {string} arg.attributeSlug - Slug of the attribute for which you
377
- * want to view the genders
378
- * @returns {Promise<GenderDetail>} - Success response
315
+ * @param {CatalogPlatformValidator.GetGenderAttributeParam} arg - Arg object
316
+ * @param {import("../PlatformAPIClient").Options} - Options
317
+ * @returns {Promise<CatalogPlatformModel.GenderDetail>} - Success response
318
+ * @name getGenderAttribute
379
319
  * @summary: Get gender attribute details
380
- * @description: This API allows to view the gender attribute details.
320
+ * @description: This API allows to view the gender attribute details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getGenderAttribute/).
381
321
  */
382
- getGenderAttribute({ attributeSlug }?: {
383
- attributeSlug: string;
384
- }): Promise<GenderDetail>;
322
+ getGenderAttribute({ attributeSlug }?: CatalogPlatformValidator.GetGenderAttributeParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.GenderDetail>;
385
323
  /**
386
- * @param {Object} arg - Arg object.
387
- * @param {string} arg.id - Unique id
388
- * @returns {Promise<HsnCode>} - Success response
324
+ * @param {CatalogPlatformValidator.GetHsnCodeParam} arg - Arg object
325
+ * @param {import("../PlatformAPIClient").Options} - Options
326
+ * @returns {Promise<CatalogPlatformModel.HsnCode>} - Success response
327
+ * @name getHsnCode
389
328
  * @summary: Fetch Hsn Code.
390
- * @description: Fetch Hsn Code.
391
- */
392
- getHsnCode({ id }?: {
393
- id: string;
394
- }): Promise<HsnCode>;
395
- /**
396
- * @param {Object} arg - Arg object.
397
- * @param {string} [arg.itemId] - Item code of the product of which size is to be get.
398
- * @param {string} [arg.size] - Size of which inventory is to get.
399
- * @param {number} [arg.pageNo] - The page number to navigate through the
400
- * given set of results
401
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
402
- * page. Default is 12.
403
- * @param {string} [arg.q] - Search with help of store code.
404
- * @param {boolean} [arg.sellable] - Filter on whether product is in stock or not.
405
- * @param {number[]} [arg.storeIds] - The Store Id of products to fetch inventory.
406
- * @param {string} [arg.sizeIdentifier] - Size Identifier (Seller Identifier
407
- * or Primary Identifier) of which inventory is to get.
408
- * @returns {Promise<GetInventoriesResponse>} - Success response
329
+ * @description: Fetch Hsn Code. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getHsnCode/).
330
+ */
331
+ getHsnCode({ id }?: CatalogPlatformValidator.GetHsnCodeParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.HsnCode>;
332
+ /**
333
+ * @param {CatalogPlatformValidator.GetInventoriesParam} arg - Arg object
334
+ * @param {import("../PlatformAPIClient").Options} - Options
335
+ * @returns {Promise<CatalogPlatformModel.GetInventoriesResponse>} - Success response
336
+ * @name getInventories
409
337
  * @summary: Get Inventory for company
410
- * @description: This API allows get Inventories data for particular company.
411
- */
412
- getInventories({ itemId, size, pageNo, pageSize, q, sellable, storeIds, sizeIdentifier, }?: {
413
- itemId?: string;
414
- size?: string;
415
- pageNo?: number;
416
- pageSize?: number;
417
- q?: string;
418
- sellable?: boolean;
419
- storeIds?: number[];
420
- sizeIdentifier?: string;
421
- }): Promise<GetInventoriesResponse>;
422
- /**
423
- * @param {Object} arg - Arg object.
424
- * @param {number} [arg.pageNo] - The page number to navigate through the
425
- * given set of results
426
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
427
- * page. Default is 12.
428
- * @returns {Promise<BulkInventoryGet>} - Success response
338
+ * @description: This API allows get Inventories data for particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventories/).
339
+ */
340
+ getInventories({ itemId, size, pageNo, pageSize, q, sellable, storeIds, sizeIdentifier, }?: CatalogPlatformValidator.GetInventoriesParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.GetInventoriesResponse>;
341
+ /**
342
+ * @param {CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam} arg
343
+ * - Arg object
344
+ *
345
+ * @param {import("../PlatformAPIClient").Options} - Options
346
+ * @returns {Promise<CatalogPlatformModel.BulkInventoryGet>} - Success response
347
+ * @name getInventoryBulkUploadHistory
429
348
  * @summary: Get a list of all bulk Inventory upload jobs.
430
- * @description: This API helps to get bulk Inventory upload jobs data.
431
- */
432
- getInventoryBulkUploadHistory({ pageNo, pageSize }?: {
433
- pageNo?: number;
434
- pageSize?: number;
435
- }): Promise<BulkInventoryGet>;
436
- /**
437
- * @param {Object} arg - Arg object.
438
- * @param {number} arg.itemId - Item code of the product of which size is to be get.
439
- * @param {string} arg.size - Size of which inventory is to get.
440
- * @param {number} [arg.pageNo] - The page number to navigate through the
441
- * given set of results
442
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
443
- * page. Default is 12.
444
- * @param {string} [arg.q] - Search with help of store code.
445
- * @param {boolean} [arg.sellable] - Filter on whether product is in stock or not.
446
- * @returns {Promise<InventoryResponsePaginated>} - Success response
349
+ * @description: This API helps to get bulk Inventory upload jobs data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBulkUploadHistory/).
350
+ */
351
+ getInventoryBulkUploadHistory({ pageNo, pageSize }?: CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.BulkInventoryGet>;
352
+ /**
353
+ * @param {CatalogPlatformValidator.GetInventoryBySizeParam} arg - Arg object
354
+ * @param {import("../PlatformAPIClient").Options} - Options
355
+ * @returns {Promise<CatalogPlatformModel.InventoryResponsePaginated>} -
356
+ * Success response
357
+ * @name getInventoryBySize
447
358
  * @summary: Get Inventory for company
448
- * @description: This API allows get Inventory data for particular company grouped by size and store.
449
- */
450
- getInventoryBySize({ itemId, size, pageNo, pageSize, q, sellable, }?: {
451
- itemId: number;
452
- size: string;
453
- pageNo?: number;
454
- pageSize?: number;
455
- q?: string;
456
- sellable?: boolean;
457
- }): Promise<InventoryResponsePaginated>;
458
- /**
459
- * @param {Object} arg - Arg object.
460
- * @param {number} arg.itemId - Item code of the product of which size is to be get.
461
- * @param {string} arg.sizeIdentifier - Size Identifier (Seller Identifier
462
- * or Primary Identifier) of which inventory is to get.
463
- * @param {number} [arg.pageNo] - The page number to navigate through the
464
- * given set of results
465
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
466
- * page. Default is 12.
467
- * @param {string} [arg.q] - Search with help of store code.
468
- * @param {number[]} [arg.locationIds] - Search by store ids.
469
- * @returns {Promise<InventorySellerIdentifierResponsePaginated>} - Success response
359
+ * @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/getInventoryBySize/).
360
+ */
361
+ getInventoryBySize({ itemId, size, pageNo, pageSize, q, sellable }?: CatalogPlatformValidator.GetInventoryBySizeParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.InventoryResponsePaginated>;
362
+ /**
363
+ * @param {CatalogPlatformValidator.GetInventoryBySizeIdentifierParam} arg
364
+ * - Arg object
365
+ *
366
+ * @param {import("../PlatformAPIClient").Options} - Options
367
+ * @returns {Promise<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>}
368
+ * - Success response
369
+ *
370
+ * @name getInventoryBySizeIdentifier
470
371
  * @summary: Get Inventory for company
471
- * @description: This API allows get Inventory data for particular company grouped by size and store.
472
- */
473
- getInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize, q, locationIds, }?: {
474
- itemId: number;
475
- sizeIdentifier: string;
476
- pageNo?: number;
477
- pageSize?: number;
478
- q?: string;
479
- locationIds?: number[];
480
- }): Promise<InventorySellerIdentifierResponsePaginated>;
481
- /**
482
- * @param {Object} arg - Arg object.
483
- * @returns {Promise<InventoryExportJob>} - Success response
372
+ * @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/getInventoryBySizeIdentifier/).
373
+ */
374
+ getInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize, q, locationIds }?: CatalogPlatformValidator.GetInventoryBySizeIdentifierParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>;
375
+ /**
376
+ * @param {CatalogPlatformValidator.GetInventoryExportParam} arg - Arg object
377
+ * @param {import("../PlatformAPIClient").Options} - Options
378
+ * @returns {Promise<CatalogPlatformModel.InventoryExportJob>} - Success response
379
+ * @name getInventoryExport
484
380
  * @summary: Get Inventory export history.
485
- * @description: This API helps to get Inventory export history.
381
+ * @description: This API helps to get Inventory export history. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryExport/).
486
382
  */
487
- getInventoryExport({}?: any): Promise<InventoryExportJob>;
383
+ getInventoryExport({ headers }?: any): Promise<CatalogPlatformModel.InventoryExportJob>;
488
384
  /**
489
- * @param {Object} arg - Arg object.
490
- * @returns {Promise<GetOptInPlatform>} - Success response
385
+ * @param {CatalogPlatformValidator.GetMarketplaceOptinDetailParam} arg - Arg object
386
+ * @param {import("../PlatformAPIClient").Options} - Options
387
+ * @returns {Promise<CatalogPlatformModel.GetOptInPlatform>} - Success response
388
+ * @name getMarketplaceOptinDetail
491
389
  * @summary: Get opt-in infomation.
492
- * @description: Use this API to fetch opt-in information for all the platforms. If successful, returns a logs in the response body as specified in `GetOptInPlatformSchema`
390
+ * @description: Use this API to fetch opt-in information for all the platforms. If successful, returns a logs in the response body as specified in `GetOptInPlatformSchema` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getMarketplaceOptinDetail/).
493
391
  */
494
- getMarketplaceOptinDetail({}?: any): Promise<GetOptInPlatform>;
392
+ getMarketplaceOptinDetail({ headers }?: any): Promise<CatalogPlatformModel.GetOptInPlatform>;
495
393
  /**
496
- * @param {Object} arg - Arg object.
497
- * @param {AssignStore} arg.body
498
- * @returns {Promise<StoreAssignResponse>} - Success response
394
+ * @param {CatalogPlatformValidator.GetOptimalLocationsParam} arg - Arg object
395
+ * @param {import("../PlatformAPIClient").Options} - Options
396
+ * @returns {Promise<CatalogPlatformModel.StoreAssignResponse>} - Success response
397
+ * @name getOptimalLocations
499
398
  * @summary: Location Reassignment
500
- * @description:
399
+ * @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getOptimalLocations/).
501
400
  */
502
- getOptimalLocations({ body }?: {
503
- body: AssignStore;
504
- }): Promise<StoreAssignResponse>;
401
+ getOptimalLocations({ body }?: CatalogPlatformValidator.GetOptimalLocationsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.StoreAssignResponse>;
505
402
  /**
506
- * @param {Object} arg - Arg object.
507
- * @param {number} arg.itemId - Item Id of the product.
508
- * @param {number} [arg.brandUid] - Brand Id of the product.
509
- * @param {string} [arg.itemCode] - Item code of the product.
510
- * @returns {Promise<SingleProductResponse>} - Success response
403
+ * @param {CatalogPlatformValidator.GetProductParam} arg - Arg object
404
+ * @param {import("../PlatformAPIClient").Options} - Options
405
+ * @returns {Promise<CatalogPlatformModel.SingleProductResponse>} - Success response
406
+ * @name getProduct
511
407
  * @summary: Get a single product.
512
- * @description: This API helps to get data associated to a particular product.
513
- */
514
- getProduct({ itemId, brandUid, itemCode }?: {
515
- itemId: number;
516
- brandUid?: number;
517
- itemCode?: string;
518
- }): Promise<SingleProductResponse>;
519
- /**
520
- * @param {Object} arg - Arg object.
521
- * @param {number} [arg.pageNo] - The page number to navigate through the
522
- * given set of results
523
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
524
- * page. Default is 12.
525
- * @returns {Promise<BulkAssetResponse>} - Success response
408
+ * @description: This API helps to get data associated to a particular product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProduct/).
409
+ */
410
+ getProduct({ itemId, brandUid, itemCode }?: CatalogPlatformValidator.GetProductParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.SingleProductResponse>;
411
+ /**
412
+ * @param {CatalogPlatformValidator.GetProductAssetsInBulkParam} arg - Arg object
413
+ * @param {import("../PlatformAPIClient").Options} - Options
414
+ * @returns {Promise<CatalogPlatformModel.BulkAssetResponse>} - Success response
415
+ * @name getProductAssetsInBulk
526
416
  * @summary: Get a list of all bulk asset jobs.
527
- * @description: This API helps to get bulk asset jobs data associated to a particular company.
528
- */
529
- getProductAssetsInBulk({ pageNo, pageSize }?: {
530
- pageNo?: number;
531
- pageSize?: number;
532
- }): Promise<BulkAssetResponse>;
533
- /**
534
- * @param {Object} arg - Arg object.
535
- * @param {string} arg.category - It is the name of the l3 cateogry
536
- * @param {boolean} [arg.filter] - If true, returns filtered values, else
537
- * returns all the attributes
538
- * @returns {Promise<ProductAttributesResponse>} - Success response
417
+ * @description: This API helps to get bulk asset jobs data associated to a particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductAssetsInBulk/).
418
+ */
419
+ getProductAssetsInBulk({ pageNo, pageSize }?: CatalogPlatformValidator.GetProductAssetsInBulkParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.BulkAssetResponse>;
420
+ /**
421
+ * @param {CatalogPlatformValidator.GetProductAttributesParam} arg - Arg object
422
+ * @param {import("../PlatformAPIClient").Options} - Options
423
+ * @returns {Promise<CatalogPlatformModel.ProductAttributesResponse>} -
424
+ * Success response
425
+ * @name getProductAttributes
539
426
  * @summary: Get list of all the attributes by their l3_categories
540
- * @description: This API allows to list all the attributes by their l3_categories.
541
- */
542
- getProductAttributes({ category, filter }?: {
543
- category: string;
544
- filter?: boolean;
545
- }): Promise<ProductAttributesResponse>;
546
- /**
547
- * @param {Object} arg - Arg object.
548
- * @param {string} [arg.search] - Search string to filter the results by batch id
549
- * @param {number} [arg.pageNo] - The page number to navigate through the
550
- * given set of results
551
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
552
- * page. Default is 12.
553
- * @returns {Promise<ProductBulkRequestList>} - Success response
427
+ * @description: This API allows to list all the attributes by their l3_categories. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductAttributes/).
428
+ */
429
+ getProductAttributes({ category, filter }?: CatalogPlatformValidator.GetProductAttributesParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.ProductAttributesResponse>;
430
+ /**
431
+ * @param {CatalogPlatformValidator.GetProductBulkUploadHistoryParam} arg - Arg object
432
+ * @param {import("../PlatformAPIClient").Options} - Options
433
+ * @returns {Promise<CatalogPlatformModel.ProductBulkRequestList>} - Success response
434
+ * @name getProductBulkUploadHistory
554
435
  * @summary: Get a list of all bulk product upload jobs.
555
- * @description: This API helps to get bulk product upload jobs data.
556
- */
557
- getProductBulkUploadHistory({ search, pageNo, pageSize }?: {
558
- search?: string;
559
- pageNo?: number;
560
- pageSize?: number;
561
- }): Promise<ProductBulkRequestList>;
562
- /**
563
- * @param {Object} arg - Arg object.
564
- * @param {string} [arg.q] - A search string that is searched with product
565
- * bundle name.
566
- * @param {string[]} [arg.slug] - Slugs of bundles to be retrieved.
567
- * @returns {Promise<GetProductBundleListingResponse>} - Success response
436
+ * @description: This API helps to get bulk product upload jobs data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBulkUploadHistory/).
437
+ */
438
+ getProductBulkUploadHistory({ search, pageNo, pageSize }?: CatalogPlatformValidator.GetProductBulkUploadHistoryParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.ProductBulkRequestList>;
439
+ /**
440
+ * @param {CatalogPlatformValidator.GetProductBundleParam} arg - Arg object
441
+ * @param {import("../PlatformAPIClient").Options} - Options
442
+ * @returns {Promise<CatalogPlatformModel.GetProductBundleListingResponse>}
443
+ * - Success response
444
+ *
445
+ * @name getProductBundle
568
446
  * @summary: List all Product Bundles
569
- * @description: Get all product bundles for a particular company
447
+ * @description: Get all product bundles for a particular company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBundle/).
570
448
  */
571
- getProductBundle({ q, slug }?: {
572
- q?: string;
573
- slug?: string[];
574
- }): Promise<GetProductBundleListingResponse>;
449
+ getProductBundle({ q, slug }?: CatalogPlatformValidator.GetProductBundleParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.GetProductBundleListingResponse>;
575
450
  /**
576
- * @param {Object} arg - Arg object.
577
- * @param {string} arg.id - A `id` is a unique identifier for a particular
578
- * detail. Pass the `id` of the keywords which you want to retrieve.
579
- * @returns {Promise<GetProductBundleResponse>} - Success response
451
+ * @param {CatalogPlatformValidator.GetProductBundleDetailParam} arg - Arg object
452
+ * @param {import("../PlatformAPIClient").Options} - Options
453
+ * @returns {Promise<CatalogPlatformModel.GetProductBundleResponse>} -
454
+ * Success response
455
+ * @name getProductBundleDetail
580
456
  * @summary: Get a particular Product Bundle details
581
- * @description: Get a particular Bundle details by its `id`. If successful, returns a Product bundle resource in the response body specified in `GetProductBundleResponse`
582
- */
583
- getProductBundleDetail({ id }?: {
584
- id: string;
585
- }): Promise<GetProductBundleResponse>;
586
- /**
587
- * @param {Object} arg - Arg object.
588
- * @param {string} [arg.status] - This is a parameter used to find all the
589
- * jobs with the specified status.
590
- * @param {string} [arg.fromDate] - This is a parameter used to find the job
591
- * from the date specified to the current date.
592
- * @param {string} [arg.toDate] - This is a parameter used to find the job
593
- * from the from_date specified to the to_date.
594
- * @param {string} [arg.q] - It is a query parameter to search the export
595
- * job with the task ID.
596
- * @returns {Promise<ProductDownloadsResponse>} - Success response
457
+ * @description: Get a particular Bundle details by its `id`. If successful, returns a Product bundle resource in the response body specified in `GetProductBundleResponse` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBundleDetail/).
458
+ */
459
+ getProductBundleDetail({ id }?: CatalogPlatformValidator.GetProductBundleDetailParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.GetProductBundleResponse>;
460
+ /**
461
+ * @param {CatalogPlatformValidator.GetProductExportJobsParam} arg - Arg object
462
+ * @param {import("../PlatformAPIClient").Options} - Options
463
+ * @returns {Promise<CatalogPlatformModel.ProductDownloadsResponse>} -
464
+ * Success response
465
+ * @name getProductExportJobs
597
466
  * @summary: Allows you to list all product templates export list details
598
- * @description: Can view details including trigger data, task id , etc.
599
- */
600
- getProductExportJobs({ status, fromDate, toDate, q }?: {
601
- status?: string;
602
- fromDate?: string;
603
- toDate?: string;
604
- q?: string;
605
- }): Promise<ProductDownloadsResponse>;
606
- /**
607
- * @param {Object} arg - Arg object.
608
- * @param {string} [arg.itemCode] - Item code of the product size.
609
- * @param {number} arg.itemId - Item Id of the product size.
610
- * @param {number} [arg.brandUid] - Brand Id of the product size.
611
- * @param {number} [arg.uid] - Id of the product size.
612
- * @returns {Promise<ProductListingResponse>} - Success response
467
+ * @description: Can view details including trigger data, task id , etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductExportJobs/).
468
+ */
469
+ getProductExportJobs({ status, fromDate, toDate, q }?: CatalogPlatformValidator.GetProductExportJobsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.ProductDownloadsResponse>;
470
+ /**
471
+ * @param {CatalogPlatformValidator.GetProductSizeParam} arg - Arg object
472
+ * @param {import("../PlatformAPIClient").Options} - Options
473
+ * @returns {Promise<CatalogPlatformModel.ProductListingResponse>} - Success response
474
+ * @name getProductSize
613
475
  * @summary: Get a single product size.
614
- * @description: This API helps to get data associated to a particular product size.
476
+ * @description: This API helps to get data associated to a particular product size. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductSize/).
615
477
  */
616
- getProductSize({ itemId, itemCode, brandUid, uid }?: {
617
- itemCode?: string;
618
- itemId: number;
619
- brandUid?: number;
620
- uid?: number;
621
- }): Promise<ProductListingResponse>;
478
+ getProductSize({ itemId, itemCode, brandUid, uid }?: CatalogPlatformValidator.GetProductSizeParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.ProductListingResponse>;
622
479
  /**
623
- * @param {Object} arg - Arg object.
624
- * @returns {Promise<ProductTagsViewResponse>} - Success response
480
+ * @param {CatalogPlatformValidator.GetProductTagsParam} arg - Arg object
481
+ * @param {import("../PlatformAPIClient").Options} - Options
482
+ * @returns {Promise<CatalogPlatformModel.ProductTagsViewResponse>} - Success response
483
+ * @name getProductTags
625
484
  * @summary: Get a list of all tags associated with company.
626
- * @description: This API helps to get tags data associated to a particular company.
485
+ * @description: This API helps to get tags data associated to a particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductTags/).
627
486
  */
628
- getProductTags({}?: any): Promise<ProductTagsViewResponse>;
487
+ getProductTags({ headers }?: any): Promise<CatalogPlatformModel.ProductTagsViewResponse>;
629
488
  /**
630
- * @param {Object} arg - Arg object.
631
- * @returns {Promise<ValidateProduct>} - Success response
489
+ * @param {CatalogPlatformValidator.GetProductValidationParam} arg - Arg object
490
+ * @param {import("../PlatformAPIClient").Options} - Options
491
+ * @returns {Promise<CatalogPlatformModel.ValidateProduct>} - Success response
492
+ * @name getProductValidation
632
493
  * @summary: Validate product/size data
633
- * @description: This API validates product data.
634
- */
635
- getProductValidation({}?: any): Promise<ValidateProduct>;
636
- /**
637
- * @param {Object} arg - Arg object.
638
- * @param {number[]} [arg.brandIds] - Get multiple products filtered by Brand Ids
639
- * @param {number[]} [arg.categoryIds] - Get multiple products filtered by
640
- * Category Ids
641
- * @param {number[]} [arg.itemIds] - Get multiple products filtered by Item Ids
642
- * @param {number[]} [arg.departmentIds] - Get multiple products filtered by
643
- * Department Ids
644
- * @param {string[]} [arg.itemCode] - Get multiple products filtered by Item Code
645
- * @param {string} [arg.q] - Get multiple products filtered by q string
646
- * @param {string[]} [arg.tags] - Get multiple products filtered by tags
647
- * @param {number} [arg.pageNo] - The page number to navigate through the
648
- * given set of results
649
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
650
- * page. Default is 10.
651
- * @returns {Promise<ProductListingResponseV2>} - Success response
494
+ * @description: This API validates product data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductValidation/).
495
+ */
496
+ getProductValidation({ headers }?: any): Promise<CatalogPlatformModel.ValidateProduct>;
497
+ /**
498
+ * @param {CatalogPlatformValidator.GetProductsParam} arg - Arg object
499
+ * @param {import("../PlatformAPIClient").Options} - Options
500
+ * @returns {Promise<CatalogPlatformModel.ProductListingResponseV2>} -
501
+ * Success response
502
+ * @name getProducts
652
503
  * @summary: Get product list
653
- * @description: This API gets meta associated to products.
654
- */
655
- getProducts({ brandIds, categoryIds, itemIds, departmentIds, itemCode, q, tags, pageNo, pageSize, }?: {
656
- brandIds?: number[];
657
- categoryIds?: number[];
658
- itemIds?: number[];
659
- departmentIds?: number[];
660
- itemCode?: string[];
661
- q?: string;
662
- tags?: string[];
663
- pageNo?: number;
664
- pageSize?: number;
665
- }): Promise<ProductListingResponseV2>;
666
- /**
667
- * @param {Object} arg - Arg object.
668
- * @param {string} arg.sellerAppId - Id of the seller application which is
669
- * serving the invetory/catalog of the company
670
- * @returns {Promise<CrossSellingResponse>} - Success response
504
+ * @description: This API gets meta associated to products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProducts/).
505
+ */
506
+ getProducts({ brandIds, categoryIds, itemIds, departmentIds, itemCode, q, tags, pageNo, pageSize, }?: CatalogPlatformValidator.GetProductsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.ProductListingResponseV2>;
507
+ /**
508
+ * @param {CatalogPlatformValidator.GetSellerInsightsParam} arg - Arg object
509
+ * @param {import("../PlatformAPIClient").Options} - Options
510
+ * @returns {Promise<CatalogPlatformModel.CrossSellingResponse>} - Success response
511
+ * @name getSellerInsights
671
512
  * @summary: Analytics data of catalog and inventory that are being cross-selled.
672
- * @description: Analytics data of catalog and inventory that are being cross-selled.
513
+ * @description: Analytics data of catalog and inventory that are being cross-selled. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSellerInsights/).
673
514
  */
674
- getSellerInsights({ sellerAppId }?: {
675
- sellerAppId: string;
676
- }): Promise<CrossSellingResponse>;
515
+ getSellerInsights({ sellerAppId }?: CatalogPlatformValidator.GetSellerInsightsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.CrossSellingResponse>;
677
516
  /**
678
- * @param {Object} arg - Arg object.
679
- * @param {string} arg.reportingHsn - Reporting_hsn
680
- * @returns {Promise<HSNDataInsertV2>} - Success response
517
+ * @param {CatalogPlatformValidator.GetSingleProductHSNCodeParam} arg - Arg object
518
+ * @param {import("../PlatformAPIClient").Options} - Options
519
+ * @returns {Promise<CatalogPlatformModel.HSNDataInsertV2>} - Success response
520
+ * @name getSingleProductHSNCode
681
521
  * @summary: Hsn Code List.
682
- * @description: Hsn Code List.
522
+ * @description: Hsn Code List. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSingleProductHSNCode/).
683
523
  */
684
- getSingleProductHSNCode({ reportingHsn }?: {
685
- reportingHsn: string;
686
- }): Promise<HSNDataInsertV2>;
524
+ getSingleProductHSNCode({ reportingHsn }?: CatalogPlatformValidator.GetSingleProductHSNCodeParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.HSNDataInsertV2>;
687
525
  /**
688
- * @param {Object} arg - Arg object.
689
- * @param {string} arg.id - Id of the size guide to be viewed.
690
- * @returns {Promise<SizeGuideResponse>} - Success response
526
+ * @param {CatalogPlatformValidator.GetSizeGuideParam} arg - Arg object
527
+ * @param {import("../PlatformAPIClient").Options} - Options
528
+ * @returns {Promise<CatalogPlatformModel.SizeGuideResponse>} - Success response
529
+ * @name getSizeGuide
691
530
  * @summary: Get a single size guide.
692
- * @description: This API helps to get data associated to a size guide.
693
- */
694
- getSizeGuide({ id }?: {
695
- id: string;
696
- }): Promise<SizeGuideResponse>;
697
- /**
698
- * @param {Object} arg - Arg object.
699
- * @param {boolean} [arg.active] - Filter size guide on basis of active, in-active
700
- * @param {string} [arg.q] - Query that is to be searched.
701
- * @param {string} [arg.tag] - To filter size guide on basis of tag.
702
- * @param {number} [arg.pageNo] - The page number to navigate through the
703
- * given set of results
704
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
705
- * page. Default is 10.
706
- * @returns {Promise<ListSizeGuide>} - Success response
531
+ * @description: This API helps to get data associated to a size guide. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSizeGuide/).
532
+ */
533
+ getSizeGuide({ id }?: CatalogPlatformValidator.GetSizeGuideParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.SizeGuideResponse>;
534
+ /**
535
+ * @param {CatalogPlatformValidator.GetSizeGuidesParam} arg - Arg object
536
+ * @param {import("../PlatformAPIClient").Options} - Options
537
+ * @returns {Promise<CatalogPlatformModel.ListSizeGuide>} - Success response
538
+ * @name getSizeGuides
707
539
  * @summary: Get list of size guides
708
- * @description: This API allows to view all the size guides associated to the seller.
709
- */
710
- getSizeGuides({ active, q, tag, pageNo, pageSize }?: {
711
- active?: boolean;
712
- q?: string;
713
- tag?: string;
714
- pageNo?: number;
715
- pageSize?: number;
716
- }): Promise<ListSizeGuide>;
717
- /**
718
- * @param {Object} arg - Arg object.
719
- * @param {string} [arg.q] - The search related the store for the company id.
720
- * @param {number} [arg.pageNo] - The number of page for the company id.
721
- * @param {number} [arg.pageSize] - Number of records that can be seen on
722
- * the page for the company id.
723
- * @returns {Promise<OptinStoreDetails>} - Success response
540
+ * @description: This API allows to view all the size guides associated to the seller. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSizeGuides/).
541
+ */
542
+ getSizeGuides({ active, q, tag, pageNo, pageSize }?: CatalogPlatformValidator.GetSizeGuidesParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.ListSizeGuide>;
543
+ /**
544
+ * @param {CatalogPlatformValidator.GetStoreDetailParam} arg - Arg object
545
+ * @param {import("../PlatformAPIClient").Options} - Options
546
+ * @returns {Promise<CatalogPlatformModel.OptinStoreDetails>} - Success response
547
+ * @name getStoreDetail
724
548
  * @summary: Get the Store details.
725
- * @description: Get the details of the store associated with the company ID passed.
726
- */
727
- getStoreDetail({ q, pageNo, pageSize }?: {
728
- q?: string;
729
- pageNo?: number;
730
- pageSize?: number;
731
- }): Promise<OptinStoreDetails>;
732
- /**
733
- * @param {Object} arg - Arg object.
734
- * @param {number} arg.itemId - Get list of variants of item Id
735
- * @param {string} arg.variantType - Get multiple products filtered by variant type
736
- * @param {number} [arg.pageNo] - The page number to navigate through the
737
- * given set of results
738
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
739
- * page. Default is 10.
740
- * @returns {Promise<ProductVariantsResponse>} - Success response
549
+ * @description: Get the details of the store associated with the company ID passed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getStoreDetail/).
550
+ */
551
+ getStoreDetail({ q, pageNo, pageSize }?: CatalogPlatformValidator.GetStoreDetailParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.OptinStoreDetails>;
552
+ /**
553
+ * @param {CatalogPlatformValidator.GetVariantsOfProductsParam} arg - Arg object
554
+ * @param {import("../PlatformAPIClient").Options} - Options
555
+ * @returns {Promise<CatalogPlatformModel.ProductVariantsResponse>} - Success response
556
+ * @name getVariantsOfProducts
741
557
  * @summary: Get product list
742
- * @description: This API gets meta associated to products.
743
- */
744
- getVariantsOfProducts({ itemId, variantType, pageNo, pageSize }?: {
745
- itemId: number;
746
- variantType: string;
747
- pageNo?: number;
748
- pageSize?: number;
749
- }): Promise<ProductVariantsResponse>;
750
- /**
751
- * @param {Object} arg - Arg object.
752
- * @param {string} [arg.level] - Get category for multiple levels
753
- * @param {string} [arg.departments] - Get category for multiple departments filtered
754
- * @param {string} [arg.q] - Get multiple categories filtered by search string
755
- * @param {number} [arg.pageNo] - The page number to navigate through the
756
- * given set of results
757
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
758
- * page. Default is 10.
759
- * @returns {Promise<CategoryResponse>} - Success response
558
+ * @description: This API gets meta associated to products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getVariantsOfProducts/).
559
+ */
560
+ getVariantsOfProducts({ itemId, variantType, pageNo, pageSize }?: CatalogPlatformValidator.GetVariantsOfProductsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.ProductVariantsResponse>;
561
+ /**
562
+ * @param {CatalogPlatformValidator.ListCategoriesParam} arg - Arg object
563
+ * @param {import("../PlatformAPIClient").Options} - Options
564
+ * @returns {Promise<CatalogPlatformModel.CategoryResponse>} - Success response
565
+ * @name listCategories
760
566
  * @summary: Get product categories list
761
- * @description: This API gets meta associated to product categories.
762
- */
763
- listCategories({ level, departments, q, pageNo, pageSize }?: {
764
- level?: string;
765
- departments?: string;
766
- q?: string;
767
- pageNo?: number;
768
- pageSize?: number;
769
- }): Promise<CategoryResponse>;
770
- /**
771
- * @param {Object} arg - Arg object.
772
- * @param {number} [arg.pageNo] - The page number to navigate through the
773
- * given set of results
774
- * @param {string} [arg.itemType] - A `item_type` is a type of product eg.
775
- * set, standard, digital
776
- * @param {number} [arg.pageSize] - Number of items to retrieve in each
777
- * page. Default is 10.
778
- * @param {string} [arg.name] - Can search departments by passing name.
779
- * @param {string} [arg.search] - Can search departments by passing name of
780
- * the department in search parameter.
781
- * @param {boolean} [arg.isActive] - Can query for departments based on
782
- * whether they are active or inactive.
783
- * @returns {Promise<DepartmentsResponse>} - Success response
567
+ * @description: This API gets meta associated to product categories. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listCategories/).
568
+ */
569
+ listCategories({ level, departments, q, pageNo, pageSize }?: CatalogPlatformValidator.ListCategoriesParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.CategoryResponse>;
570
+ /**
571
+ * @param {CatalogPlatformValidator.ListDepartmentsDataParam} arg - Arg object
572
+ * @param {import("../PlatformAPIClient").Options} - Options
573
+ * @returns {Promise<CatalogPlatformModel.DepartmentsResponse>} - Success response
574
+ * @name listDepartmentsData
784
575
  * @summary: List all Departments.
785
- * @description: Allows you to list all departments, also can search using name and filter active and incative departments, and item type.
786
- */
787
- listDepartmentsData({ pageNo, itemType, pageSize, name, search, isActive, }?: {
788
- pageNo?: number;
789
- itemType?: string;
790
- pageSize?: number;
791
- name?: string;
792
- search?: string;
793
- isActive?: boolean;
794
- }): Promise<DepartmentsResponse>;
795
- /**
796
- * @param {Object} arg - Arg object.
797
- * @returns {Promise<HSNCodesResponse>} - Success response
576
+ * @description: Allows you to list all departments, also can search using name and filter active and incative departments, and item type. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listDepartmentsData/).
577
+ */
578
+ listDepartmentsData({ pageNo, itemType, pageSize, name, search, isActive }?: CatalogPlatformValidator.ListDepartmentsDataParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.DepartmentsResponse>;
579
+ /**
580
+ * @param {CatalogPlatformValidator.ListHSNCodesParam} arg - Arg object
581
+ * @param {import("../PlatformAPIClient").Options} - Options
582
+ * @returns {Promise<CatalogPlatformModel.HSNCodesResponse>} - Success response
583
+ * @name listHSNCodes
798
584
  * @summary: List HSN Codes
799
- * @description: Allows you to list all hsn Codes
800
- */
801
- listHSNCodes({}?: any): Promise<HSNCodesResponse>;
802
- /**
803
- * @param {Object} arg - Arg object.
804
- * @param {string} [arg.status] - Status of the export job.
805
- * @param {string} [arg.fromDate] - Inventory export history filtered
806
- * according to from_date.
807
- * @param {string} [arg.toDate] - Inventory export history filtered
808
- * according to from_date.
809
- * @param {string} [arg.q] - Inventory export history filtered according to task ID.
810
- * @returns {Promise<InventoryExportJobListResponse>} - Success response
585
+ * @description: Allows you to list all hsn Codes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listHSNCodes/).
586
+ */
587
+ listHSNCodes({ headers }?: any): Promise<CatalogPlatformModel.HSNCodesResponse>;
588
+ /**
589
+ * @param {CatalogPlatformValidator.ListInventoryExportParam} arg - Arg object
590
+ * @param {import("../PlatformAPIClient").Options} - Options
591
+ * @returns {Promise<CatalogPlatformModel.InventoryExportJobListResponse>}
592
+ * - Success response
593
+ *
594
+ * @name listInventoryExport
811
595
  * @summary: Get the history of the inventory export.
812
- * @description: This API helps you the get the history of inventory jobs depending on the filtered criteria.
813
- */
814
- listInventoryExport({ status, fromDate, toDate, q }?: {
815
- status?: string;
816
- fromDate?: string;
817
- toDate?: string;
818
- q?: string;
819
- }): Promise<InventoryExportJobListResponse>;
820
- /**
821
- * @param {Object} arg - Arg object.
822
- * @param {string} arg.department - A `department` is the name of a
823
- * particular department.
824
- * @returns {Promise<TemplatesResponse>} - Success response
596
+ * @description: This API helps you the get the history of inventory jobs depending on the filtered criteria. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listInventoryExport/).
597
+ */
598
+ listInventoryExport({ status, fromDate, toDate, q }?: CatalogPlatformValidator.ListInventoryExportParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.InventoryExportJobListResponse>;
599
+ /**
600
+ * @param {CatalogPlatformValidator.ListProductTemplateParam} arg - Arg object
601
+ * @param {import("../PlatformAPIClient").Options} - Options
602
+ * @returns {Promise<CatalogPlatformModel.TemplatesResponse>} - Success response
603
+ * @name listProductTemplate
825
604
  * @summary: List all Templates
826
- * @description: Allows you to list all product templates, also can filter by department
827
- */
828
- listProductTemplate({ department }?: {
829
- department: string;
830
- }): Promise<TemplatesResponse>;
831
- /**
832
- * @param {Object} arg - Arg object.
833
- * @param {string} arg.departments - A `department` is name of a departments
834
- * whose category needs to be listed. Can specify multiple departments.
835
- * @param {string} arg.itemType - An `item_type` is the type of item, it can
836
- * be `set`, `standard`, `digital`, etc.
837
- * @returns {Promise<ProdcutTemplateCategoriesResponse>} - Success response
605
+ * @description: Allows you to list all product templates, also can filter by department - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listProductTemplate/).
606
+ */
607
+ listProductTemplate({ department }?: CatalogPlatformValidator.ListProductTemplateParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.TemplatesResponse>;
608
+ /**
609
+ * @param {CatalogPlatformValidator.ListProductTemplateCategoriesParam} arg
610
+ * - Arg object
611
+ *
612
+ * @param {import("../PlatformAPIClient").Options} - Options
613
+ * @returns {Promise<CatalogPlatformModel.ProdcutTemplateCategoriesResponse>}
614
+ * - Success response
615
+ *
616
+ * @name listProductTemplateCategories
838
617
  * @summary: List Department specifiec product categories
839
- * @description: Allows you to list all product categories values for the departments specified
618
+ * @description: Allows you to list all product categories values for the departments specified - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listProductTemplateCategories/).
840
619
  */
841
- listProductTemplateCategories({ departments, itemType }?: {
842
- departments: string;
843
- itemType: string;
844
- }): Promise<ProdcutTemplateCategoriesResponse>;
620
+ listProductTemplateCategories({ departments, itemType }?: CatalogPlatformValidator.ListProductTemplateCategoriesParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.ProdcutTemplateCategoriesResponse>;
845
621
  /**
846
- * @param {Object} arg - Arg object.
847
- * @returns {Promise<ProductDownloadsResponse>} - Success response
622
+ * @param {CatalogPlatformValidator.ListProductTemplateExportDetailsParam} arg
623
+ * - Arg object
624
+ *
625
+ * @param {import("../PlatformAPIClient").Options} - Options
626
+ * @returns {Promise<CatalogPlatformModel.ProductDownloadsResponse>} -
627
+ * Success response
628
+ * @name listProductTemplateExportDetails
848
629
  * @summary: Allows you to list all product templates export list details
849
- * @description: Can view details including trigger data, task id , etc.
850
- */
851
- listProductTemplateExportDetails({}?: any): Promise<ProductDownloadsResponse>;
852
- /**
853
- * @param {Object} arg - Arg object.
854
- * @param {string} arg.filter - A `filter` is the unique identifier of the
855
- * type of value required.
856
- * @param {string} [arg.templateTag] - A `template_tag` is the identifier of
857
- * the type of template required.
858
- * @param {string} [arg.itemType] - A `item_type` is the identifier of the
859
- * type of template required.
860
- * @returns {Promise<ProductConfigurationDownloads>} - Success response
630
+ * @description: Can view details including trigger data, task id , etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listProductTemplateExportDetails/).
631
+ */
632
+ listProductTemplateExportDetails({ headers }?: any): Promise<CatalogPlatformModel.ProductDownloadsResponse>;
633
+ /**
634
+ * @param {CatalogPlatformValidator.ListTemplateBrandTypeValuesParam} arg - Arg object
635
+ * @param {import("../PlatformAPIClient").Options} - Options
636
+ * @returns {Promise<CatalogPlatformModel.ProductConfigurationDownloads>} -
637
+ * Success response
638
+ * @name listTemplateBrandTypeValues
861
639
  * @summary: Allows you to list all values for Templates, Brands or Type
862
- * @description: The filter type query parameter defines what type of data to return. The type of query returns the valid values for the same
863
- */
864
- listTemplateBrandTypeValues({ filter, templateTag, itemType }?: {
865
- filter: string;
866
- templateTag?: string;
867
- itemType?: string;
868
- }): Promise<ProductConfigurationDownloads>;
869
- /**
870
- * @param {Object} arg - Arg object.
871
- * @param {string} arg.uid - Category unique id
872
- * @param {CategoryRequestBody} arg.body
873
- * @returns {Promise<CategoryUpdateResponse>} - Success response
640
+ * @description: The filter type query parameter defines what type of data to return. The type of query returns the valid values for the same - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listTemplateBrandTypeValues/).
641
+ */
642
+ listTemplateBrandTypeValues({ filter, templateTag, itemType }?: CatalogPlatformValidator.ListTemplateBrandTypeValuesParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.ProductConfigurationDownloads>;
643
+ /**
644
+ * @param {CatalogPlatformValidator.UpdateCategoryParam} arg - Arg object
645
+ * @param {import("../PlatformAPIClient").Options} - Options
646
+ * @returns {Promise<CatalogPlatformModel.CategoryUpdateResponse>} - Success response
647
+ * @name updateCategory
874
648
  * @summary: Update product categories
875
- * @description: Update a product category using this api
649
+ * @description: Update a product category using this api - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateCategory/).
876
650
  */
877
- updateCategory({ uid, body }?: {
878
- uid: string;
879
- body: CategoryRequestBody;
880
- }): Promise<CategoryUpdateResponse>;
651
+ updateCategory({ uid, body }?: CatalogPlatformValidator.UpdateCategoryParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.CategoryUpdateResponse>;
881
652
  /**
882
- * @param {Object} arg - Arg object.
883
- * @param {string} arg.uid - A `uid` is a unique identifier of a department.
884
- * @param {DepartmentCreateUpdate} arg.body
885
- * @returns {Promise<DepartmentModel>} - Success response
653
+ * @param {CatalogPlatformValidator.UpdateDepartmentParam} arg - Arg object
654
+ * @param {import("../PlatformAPIClient").Options} - Options
655
+ * @returns {Promise<CatalogPlatformModel.DepartmentModel>} - Success response
656
+ * @name updateDepartment
886
657
  * @summary: Update the department by their uid.
887
- * @description: Update the department by their uid using this API.
658
+ * @description: Update the department by their uid using this API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateDepartment/).
888
659
  */
889
- updateDepartment({ uid, body }?: {
890
- uid: string;
891
- body: DepartmentCreateUpdate;
892
- }): Promise<DepartmentModel>;
660
+ updateDepartment({ uid, body }?: CatalogPlatformValidator.UpdateDepartmentParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.DepartmentModel>;
893
661
  /**
894
- * @param {Object} arg - Arg object.
895
- * @param {string} arg.id - Unique id
896
- * @param {HsnUpsert} arg.body
897
- * @returns {Promise<HsnCode>} - Success response
662
+ * @param {CatalogPlatformValidator.UpdateHsnCodeParam} arg - Arg object
663
+ * @param {import("../PlatformAPIClient").Options} - Options
664
+ * @returns {Promise<CatalogPlatformModel.HsnCode>} - Success response
665
+ * @name updateHsnCode
898
666
  * @summary: Update Hsn Code.
899
- * @description: Update Hsn Code.
667
+ * @description: Update Hsn Code. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateHsnCode/).
900
668
  */
901
- updateHsnCode({ id, body }?: {
902
- id: string;
903
- body: HsnUpsert;
904
- }): Promise<HsnCode>;
669
+ updateHsnCode({ id, body }?: CatalogPlatformValidator.UpdateHsnCodeParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.HsnCode>;
905
670
  /**
906
- * @param {Object} arg - Arg object.
907
- * @param {InventoryRequestSchemaV2} arg.body
908
- * @returns {Promise<InventoryUpdateResponse>} - Success response
671
+ * @param {CatalogPlatformValidator.UpdateInventoriesParam} arg - Arg object
672
+ * @param {import("../PlatformAPIClient").Options} - Options
673
+ * @returns {Promise<CatalogPlatformModel.InventoryUpdateResponse>} - Success response
674
+ * @name updateInventories
909
675
  * @summary: Add Inventory for particular size and store.
910
- * @description: This API allows add Inventory for particular size and store.
676
+ * @description: This API allows add Inventory for particular size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateInventories/).
911
677
  */
912
- updateInventories({ body }?: {
913
- body: InventoryRequestSchemaV2;
914
- }): Promise<InventoryUpdateResponse>;
678
+ updateInventories({ body }?: CatalogPlatformValidator.UpdateInventoriesParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.InventoryUpdateResponse>;
915
679
  /**
916
- * @param {Object} arg - Arg object.
917
- * @param {string} arg.id - A `id` is a unique identifier for a particular
918
- * detail. Pass the `id` of the keywords which you want to delete.
919
- * @param {ProductBundleUpdateRequest} arg.body
920
- * @returns {Promise<GetProductBundleCreateResponse>} - Success response
680
+ * @param {CatalogPlatformValidator.UpdateProductBundleParam} arg - Arg object
681
+ * @param {import("../PlatformAPIClient").Options} - Options
682
+ * @returns {Promise<CatalogPlatformModel.GetProductBundleCreateResponse>}
683
+ * - Success response
684
+ *
685
+ * @name updateProductBundle
921
686
  * @summary: Update a Product Bundle
922
- * @description: Update a Product Bundle by its id. On successful request, returns the updated product bundle
923
- */
924
- updateProductBundle({ id, body }?: {
925
- id: string;
926
- body: ProductBundleUpdateRequest;
927
- }): Promise<GetProductBundleCreateResponse>;
928
- /**
929
- * @param {Object} arg - Arg object.
930
- * @param {number} arg.itemId - Item code of the product of which size is to be get.
931
- * @param {string} arg.sellerIdentifier - Size Identifier (Seller Identifier
932
- * or Primary Identifier) of which inventory is to get.
933
- * @param {InventoryRequestSchemaV2} arg.body
934
- * @returns {Promise<InventoryUpdateResponse>} - Success response
687
+ * @description: Update a Product Bundle by its id. On successful request, returns the updated product bundle - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateProductBundle/).
688
+ */
689
+ updateProductBundle({ id, body }?: CatalogPlatformValidator.UpdateProductBundleParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.GetProductBundleCreateResponse>;
690
+ /**
691
+ * @param {CatalogPlatformValidator.UpdateRealtimeInventoryParam} arg - Arg object
692
+ * @param {import("../PlatformAPIClient").Options} - Options
693
+ * @returns {Promise<CatalogPlatformModel.InventoryUpdateResponse>} - Success response
694
+ * @name updateRealtimeInventory
935
695
  * @summary: Add Inventory for particular size and store.
936
- * @description: This API allows add Inventory for particular size and store.
937
- */
938
- updateRealtimeInventory({ itemId, sellerIdentifier, body }?: {
939
- itemId: number;
940
- sellerIdentifier: string;
941
- body: InventoryRequestSchemaV2;
942
- }): Promise<InventoryUpdateResponse>;
943
- /**
944
- * @param {Object} arg - Arg object.
945
- * @param {string} arg.id - Mongo id of the size guide to be edited
946
- * @param {ValidateSizeGuide} arg.body
947
- * @returns {Promise<SuccessResponse>} - Success response
696
+ * @description: This API allows add Inventory for particular size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateRealtimeInventory/).
697
+ */
698
+ updateRealtimeInventory({ itemId, sellerIdentifier, body }?: CatalogPlatformValidator.UpdateRealtimeInventoryParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.InventoryUpdateResponse>;
699
+ /**
700
+ * @param {CatalogPlatformValidator.UpdateSizeGuideParam} arg - Arg object
701
+ * @param {import("../PlatformAPIClient").Options} - Options
702
+ * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
703
+ * @name updateSizeGuide
948
704
  * @summary: Edit a size guide.
949
- * @description: This API allows to edit a size guide.
950
- */
951
- updateSizeGuide({ id, body }?: {
952
- id: string;
953
- body: ValidateSizeGuide;
954
- }): Promise<SuccessResponse>;
955
- /**
956
- * @param {Object} arg - Arg object.
957
- * @param {string} arg.department - Department of the product to be uploaded.
958
- * @param {string} arg.productType - Product type of the product to be
959
- * uploaded i.e. set, standard , digital.
960
- * @param {BulkJob} arg.body
961
- * @returns {Promise<BulkResponse>} - Success response
705
+ * @description: This API allows to edit a size guide. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateSizeGuide/).
706
+ */
707
+ updateSizeGuide({ id, body }?: CatalogPlatformValidator.UpdateSizeGuideParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.SuccessResponse>;
708
+ /**
709
+ * @param {CatalogPlatformValidator.UploadBulkProductsParam} arg - Arg object
710
+ * @param {import("../PlatformAPIClient").Options} - Options
711
+ * @returns {Promise<CatalogPlatformModel.BulkResponse>} - Success response
712
+ * @name uploadBulkProducts
962
713
  * @summary: Create a Bulk product to upload job.
963
- * @description: This API helps to create a bulk products upload job.
964
- */
965
- uploadBulkProducts({ department, productType, body }?: {
966
- department: string;
967
- productType: string;
968
- body: BulkJob;
969
- }): Promise<BulkResponse>;
970
- /**
971
- * @param {Object} arg - Arg object.
972
- * @param {string} arg.slug - A `slug` is a unique identifier for a
973
- * particular template.
974
- * @returns {Promise<TemplatesValidationResponse>} - Success response
714
+ * @description: This API helps to create a bulk products upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/uploadBulkProducts/).
715
+ */
716
+ uploadBulkProducts({ department, productType, body }?: CatalogPlatformValidator.UploadBulkProductsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.BulkResponse>;
717
+ /**
718
+ * @param {CatalogPlatformValidator.ValidateProductTemplateParam} arg - Arg object
719
+ * @param {import("../PlatformAPIClient").Options} - Options
720
+ * @returns {Promise<CatalogPlatformModel.TemplatesValidationResponse>} -
721
+ * Success response
722
+ * @name validateProductTemplate
975
723
  * @summary: Validate Product Template Schema
976
- * @description: Allows you to list all product templates validation values for all the fields present in the database
724
+ * @description: Allows you to list all product templates validation values for all the fields present in the database - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/validateProductTemplate/).
977
725
  */
978
- validateProductTemplate({ slug }?: {
979
- slug: string;
980
- }): Promise<TemplatesValidationResponse>;
726
+ validateProductTemplate({ slug }?: CatalogPlatformValidator.ValidateProductTemplateParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.TemplatesValidationResponse>;
981
727
  /**
982
- * @param {Object} arg - Arg object.
983
- * @param {string} arg.itemType - An `item_type` defines the type of item.
984
- * The default value is standard.
985
- * @returns {Promise<InventoryValidationResponse>} - Success response
728
+ * @param {CatalogPlatformValidator.ValidateProductTemplateSchemaParam} arg
729
+ * - Arg object
730
+ *
731
+ * @param {import("../PlatformAPIClient").Options} - Options
732
+ * @returns {Promise<CatalogPlatformModel.InventoryValidationResponse>} -
733
+ * Success response
734
+ * @name validateProductTemplateSchema
986
735
  * @summary: Validate Product Template Schema
987
- * @description: Allows you to list all product templates validation values for all the fields present in the database
736
+ * @description: Allows you to list all product templates validation values for all the fields present in the database - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/validateProductTemplateSchema/).
988
737
  */
989
- validateProductTemplateSchema({ itemType }?: {
990
- itemType: string;
991
- }): Promise<InventoryValidationResponse>;
738
+ validateProductTemplateSchema({ itemType }?: CatalogPlatformValidator.ValidateProductTemplateSchemaParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CatalogPlatformModel.InventoryValidationResponse>;
992
739
  }
740
+ import CatalogPlatformValidator = require("./CatalogPlatformValidator");
741
+ import CatalogPlatformModel = require("./CatalogPlatformModel");