@gofynd/fdk-client-javascript 3.0.0-beta.1 → 3.0.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 (310) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/ApplicationClient.d.ts +2 -0
  4. package/sdk/application/ApplicationClient.js +2 -0
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +93 -113
  6. package/sdk/application/Cart/CartApplicationClient.js +157 -530
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +214 -447
  9. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
  10. package/sdk/application/Common/CommonApplicationClient.js +4 -19
  11. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -43
  12. package/sdk/application/Communication/CommunicationApplicationClient.js +4 -214
  13. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +41 -54
  14. package/sdk/application/Configuration/ConfigurationApplicationClient.js +39 -192
  15. package/sdk/application/Content/ContentApplicationClient.d.ts +65 -55
  16. package/sdk/application/Content/ContentApplicationClient.js +211 -341
  17. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -6
  18. package/sdk/application/FileStorage/FileStorageApplicationClient.js +14 -33
  19. package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
  20. package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
  21. package/sdk/application/Lead/LeadApplicationClient.d.ts +6 -6
  22. package/sdk/application/Lead/LeadApplicationClient.js +24 -55
  23. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +32 -87
  24. package/sdk/application/Logistic/LogisticApplicationClient.js +126 -383
  25. package/sdk/application/Order/OrderApplicationClient.d.ts +31 -51
  26. package/sdk/application/Order/OrderApplicationClient.js +89 -293
  27. package/sdk/application/Payment/PaymentApplicationClient.d.ts +108 -218
  28. package/sdk/application/Payment/PaymentApplicationClient.js +100 -1081
  29. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -14
  30. package/sdk/application/Rewards/RewardsApplicationClient.js +13 -66
  31. package/sdk/application/Share/ShareApplicationClient.d.ts +11 -11
  32. package/sdk/application/Share/ShareApplicationClient.js +35 -89
  33. package/sdk/application/Theme/ThemeApplicationClient.d.ts +5 -25
  34. package/sdk/application/Theme/ThemeApplicationClient.js +24 -150
  35. package/sdk/application/User/UserApplicationClient.d.ts +23 -13
  36. package/sdk/application/User/UserApplicationClient.js +49 -407
  37. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
  38. package/sdk/application/Webhook/WebhookApplicationClient.js +4 -11
  39. package/sdk/common/Utility.d.ts +1 -1
  40. package/sdk/common/Utility.js +10 -7
  41. package/sdk/common/Validator.d.ts +1 -0
  42. package/sdk/common/Validator.js +20 -0
  43. package/sdk/common/utils.d.ts +0 -1
  44. package/sdk/common/utils.js +0 -14
  45. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +18 -62
  46. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +40 -372
  47. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +99 -33
  48. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +84 -25
  49. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -5
  50. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +7 -38
  51. package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
  52. package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
  53. package/sdk/partner/Lead/LeadPartnerModel.d.ts +52 -98
  54. package/sdk/partner/Lead/LeadPartnerModel.js +76 -100
  55. package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
  56. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +172 -41
  57. package/sdk/partner/Logistics/LogisticsPartnerClient.js +1222 -85
  58. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1921 -297
  59. package/sdk/partner/Logistics/LogisticsPartnerModel.js +973 -258
  60. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +13 -1
  61. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +148 -16
  62. package/sdk/partner/PartnerClient.d.ts +0 -6
  63. package/sdk/partner/PartnerClient.js +0 -9
  64. package/sdk/partner/Theme/ThemePartnerClient.d.ts +21 -63
  65. package/sdk/partner/Theme/ThemePartnerClient.js +67 -392
  66. package/sdk/partner/Theme/ThemePartnerModel.d.ts +72 -104
  67. package/sdk/partner/Theme/ThemePartnerModel.js +75 -101
  68. package/sdk/partner/Theme/ThemePartnerValidator.d.ts +1 -5
  69. package/sdk/partner/Theme/ThemePartnerValidator.js +12 -42
  70. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
  71. package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
  72. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +673 -189
  73. package/sdk/partner/Webhook/WebhookPartnerModel.js +270 -159
  74. package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
  75. package/sdk/partner/index.d.ts +0 -3
  76. package/sdk/partner/index.js +0 -6
  77. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
  78. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
  79. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +3 -3
  80. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -3
  81. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
  82. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
  83. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +49 -145
  84. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +20 -171
  85. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
  86. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
  87. package/sdk/platform/Billing/BillingPlatformClient.d.ts +15 -406
  88. package/sdk/platform/Billing/BillingPlatformClient.js +76 -3214
  89. package/sdk/platform/Billing/BillingPlatformModel.d.ts +459 -3798
  90. package/sdk/platform/Billing/BillingPlatformModel.js +338 -2573
  91. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +24 -465
  92. package/sdk/platform/Billing/BillingPlatformValidator.js +14 -490
  93. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +205 -284
  94. package/sdk/platform/Cart/CartPlatformApplicationClient.js +554 -672
  95. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +165 -165
  96. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +132 -108
  97. package/sdk/platform/Cart/CartPlatformModel.d.ts +4865 -3148
  98. package/sdk/platform/Cart/CartPlatformModel.js +2071 -2854
  99. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +419 -1015
  100. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2004 -6444
  101. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +226 -1117
  102. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +127 -919
  103. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +574 -372
  104. package/sdk/platform/Catalog/CatalogPlatformClient.js +1315 -1238
  105. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9334 -7634
  106. package/sdk/platform/Catalog/CatalogPlatformModel.js +6980 -9652
  107. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +239 -294
  108. package/sdk/platform/Catalog/CatalogPlatformValidator.js +186 -246
  109. package/sdk/platform/Common/CommonPlatformClient.d.ts +6 -5
  110. package/sdk/platform/Common/CommonPlatformClient.js +6 -5
  111. package/sdk/platform/Common/CommonPlatformModel.d.ts +19 -25
  112. package/sdk/platform/Common/CommonPlatformModel.js +11 -14
  113. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +236 -376
  114. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +579 -868
  115. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +139 -170
  116. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +126 -145
  117. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +3 -56
  118. package/sdk/platform/Communication/CommunicationPlatformClient.js +4 -307
  119. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +314 -422
  120. package/sdk/platform/Communication/CommunicationPlatformModel.js +382 -538
  121. package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +3 -62
  122. package/sdk/platform/Communication/CommunicationPlatformValidator.js +2 -48
  123. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +72 -68
  124. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +88 -84
  125. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +270 -241
  126. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +248 -226
  127. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +20 -20
  128. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -20
  129. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +118 -333
  130. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +409 -1470
  131. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +55 -158
  132. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +41 -163
  133. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +65 -142
  134. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +103 -568
  135. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +565 -1282
  136. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +369 -1034
  137. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +34 -80
  138. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +24 -79
  139. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +302 -246
  140. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1297 -776
  141. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +330 -218
  142. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +325 -208
  143. package/sdk/platform/Content/ContentPlatformClient.d.ts +279 -118
  144. package/sdk/platform/Content/ContentPlatformClient.js +1617 -492
  145. package/sdk/platform/Content/ContentPlatformModel.d.ts +2374 -877
  146. package/sdk/platform/Content/ContentPlatformModel.js +1304 -930
  147. package/sdk/platform/Content/ContentPlatformValidator.d.ts +272 -134
  148. package/sdk/platform/Content/ContentPlatformValidator.js +295 -118
  149. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +53 -43
  150. package/sdk/platform/Discount/DiscountPlatformClient.js +53 -43
  151. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +383 -110
  152. package/sdk/platform/Discount/DiscountPlatformModel.js +117 -108
  153. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
  154. package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
  155. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -163
  156. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -1078
  157. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -141
  158. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -177
  159. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
  160. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
  161. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +30 -1123
  162. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +24 -1135
  163. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  164. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  165. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +17 -17
  166. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +33 -33
  167. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +19 -19
  168. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +14 -14
  169. package/sdk/platform/Lead/LeadPlatformClient.d.ts +24 -4
  170. package/sdk/platform/Lead/LeadPlatformClient.js +160 -4
  171. package/sdk/platform/Lead/LeadPlatformModel.d.ts +60 -140
  172. package/sdk/platform/Lead/LeadPlatformModel.js +81 -162
  173. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +29 -3
  174. package/sdk/platform/Lead/LeadPlatformValidator.js +28 -2
  175. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +19 -98
  176. package/sdk/platform/Order/OrderPlatformApplicationClient.js +27 -662
  177. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +91 -118
  178. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +32 -127
  179. package/sdk/platform/Order/OrderPlatformClient.d.ts +421 -418
  180. package/sdk/platform/Order/OrderPlatformClient.js +1194 -1350
  181. package/sdk/platform/Order/OrderPlatformModel.d.ts +9145 -4107
  182. package/sdk/platform/Order/OrderPlatformModel.js +4257 -3197
  183. package/sdk/platform/Order/OrderPlatformValidator.d.ts +641 -442
  184. package/sdk/platform/Order/OrderPlatformValidator.js +341 -311
  185. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
  186. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
  187. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +67 -19
  188. package/sdk/platform/Partner/PartnerPlatformModel.js +26 -17
  189. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +135 -382
  190. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +934 -2452
  191. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +93 -306
  192. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +70 -305
  193. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +56 -66
  194. package/sdk/platform/Payment/PaymentPlatformClient.js +124 -269
  195. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +1327 -3529
  196. package/sdk/platform/Payment/PaymentPlatformModel.js +1397 -3693
  197. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +35 -64
  198. package/sdk/platform/Payment/PaymentPlatformValidator.js +34 -60
  199. package/sdk/platform/PlatformClient.d.ts +0 -2
  200. package/sdk/platform/PlatformClient.js +0 -4
  201. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
  202. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
  203. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
  204. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
  205. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +12 -12
  206. package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -10
  207. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +64 -136
  208. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +111 -513
  209. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +75 -103
  210. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +50 -99
  211. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +162 -127
  212. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +775 -435
  213. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +6250 -3861
  214. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3178 -3798
  215. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +295 -199
  216. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +205 -133
  217. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +16 -4
  218. package/sdk/platform/Share/SharePlatformApplicationClient.js +86 -8
  219. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +23 -6
  220. package/sdk/platform/Share/SharePlatformApplicationValidator.js +16 -3
  221. package/sdk/platform/Share/SharePlatformModel.d.ts +53 -4
  222. package/sdk/platform/Share/SharePlatformModel.js +45 -3
  223. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +4 -26
  224. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +10 -157
  225. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +10 -21
  226. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +6 -23
  227. package/sdk/platform/Theme/ThemePlatformClient.d.ts +8 -18
  228. package/sdk/platform/Theme/ThemePlatformClient.js +8 -85
  229. package/sdk/platform/Theme/ThemePlatformModel.d.ts +17 -425
  230. package/sdk/platform/Theme/ThemePlatformModel.js +23 -329
  231. package/sdk/platform/Theme/ThemePlatformValidator.d.ts +3 -7
  232. package/sdk/platform/Theme/ThemePlatformValidator.js +2 -9
  233. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +81 -18
  234. package/sdk/platform/User/UserPlatformApplicationClient.js +491 -27
  235. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +126 -10
  236. package/sdk/platform/User/UserPlatformApplicationValidator.js +92 -7
  237. package/sdk/platform/User/UserPlatformModel.d.ts +317 -218
  238. package/sdk/platform/User/UserPlatformModel.js +253 -210
  239. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
  240. package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
  241. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +813 -426
  242. package/sdk/platform/Webhook/WebhookPlatformModel.js +446 -395
  243. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
  244. package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
  245. package/sdk/platform/index.d.ts +0 -1
  246. package/sdk/platform/index.js +0 -2
  247. package/sdk/public/Catalog/CatalogPublicClient.d.ts +22 -0
  248. package/sdk/public/Catalog/CatalogPublicClient.js +133 -0
  249. package/sdk/public/Catalog/CatalogPublicModel.d.ts +158 -0
  250. package/sdk/public/Catalog/CatalogPublicModel.js +116 -0
  251. package/sdk/public/Catalog/CatalogPublicValidator.d.ts +55 -0
  252. package/sdk/public/Catalog/CatalogPublicValidator.js +35 -0
  253. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +4 -14
  254. package/sdk/public/Configuration/ConfigurationPublicClient.js +10 -113
  255. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +46 -114
  256. package/sdk/public/Configuration/ConfigurationPublicModel.js +32 -117
  257. package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +1 -11
  258. package/sdk/public/Configuration/ConfigurationPublicValidator.js +0 -12
  259. package/sdk/public/Content/ContentPublicClient.d.ts +36 -25
  260. package/sdk/public/Content/ContentPublicClient.js +254 -280
  261. package/sdk/public/Content/ContentPublicModel.d.ts +151 -38
  262. package/sdk/public/Content/ContentPublicModel.js +98 -44
  263. package/sdk/public/Content/ContentPublicValidator.d.ts +18 -17
  264. package/sdk/public/Content/ContentPublicValidator.js +26 -19
  265. package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
  266. package/sdk/public/Partner/PartnerPublicClient.js +6 -11
  267. package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
  268. package/sdk/public/Partner/PartnerPublicModel.js +81 -71
  269. package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
  270. package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
  271. package/sdk/public/PublicClient.d.ts +2 -2
  272. package/sdk/public/PublicClient.js +2 -2
  273. package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
  274. package/sdk/public/Webhook/WebhookPublicClient.js +9 -48
  275. package/sdk/public/Webhook/WebhookPublicModel.d.ts +215 -67
  276. package/sdk/public/Webhook/WebhookPublicModel.js +66 -61
  277. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  278. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  279. package/sdk/public/index.d.ts +1 -1
  280. package/sdk/public/index.js +1 -1
  281. package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +0 -66
  282. package/sdk/partner/Authorization/AuthorizationPartnerClient.js +0 -431
  283. package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +0 -231
  284. package/sdk/partner/Authorization/AuthorizationPartnerModel.js +0 -152
  285. package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +0 -8
  286. package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +0 -39
  287. package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +0 -26
  288. package/sdk/partner/Catalog/CatalogPartnerClient.js +0 -173
  289. package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +0 -238
  290. package/sdk/partner/Catalog/CatalogPartnerModel.js +0 -248
  291. package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +0 -5
  292. package/sdk/partner/Catalog/CatalogPartnerValidator.js +0 -19
  293. package/sdk/partner/Payment/PaymentPartnerClient.d.ts +0 -116
  294. package/sdk/partner/Payment/PaymentPartnerClient.js +0 -857
  295. package/sdk/partner/Payment/PaymentPartnerModel.d.ts +0 -388
  296. package/sdk/partner/Payment/PaymentPartnerModel.js +0 -442
  297. package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +0 -14
  298. package/sdk/partner/Payment/PaymentPartnerValidator.js +0 -74
  299. package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
  300. package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
  301. package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2895
  302. package/sdk/platform/Finance/FinancePlatformModel.js +0 -2150
  303. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
  304. package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
  305. package/sdk/public/Billing/BillingPublicClient.d.ts +0 -56
  306. package/sdk/public/Billing/BillingPublicClient.js +0 -397
  307. package/sdk/public/Billing/BillingPublicModel.d.ts +0 -919
  308. package/sdk/public/Billing/BillingPublicModel.js +0 -560
  309. package/sdk/public/Billing/BillingPublicValidator.d.ts +0 -43
  310. package/sdk/public/Billing/BillingPublicValidator.js +0 -50
@@ -2,214 +2,217 @@ export = Catalog;
2
2
  declare class Catalog {
3
3
  constructor(config: any);
4
4
  config: any;
5
+ /**
6
+ * @param {CatalogPlatformValidator.AddInventoryParam} arg - Arg object
7
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
8
+ * @param {import("../PlatformAPIClient").Options} - Options
9
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
10
+ * @name addInventory
11
+ * @summary: Create Inventory
12
+ * @description: Allows add Inventory for particular size and selling location. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/addInventory/).
13
+ */
14
+ addInventory({ itemId, size, body, requestHeaders }?: CatalogPlatformValidator.AddInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
5
15
  /**
6
16
  * @param {CatalogPlatformValidator.AllSizesParam} arg - Arg object
7
17
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
8
18
  * @param {import("../PlatformAPIClient").Options} - Options
9
19
  * @returns {Promise<CatalogPlatformModel.GetAllSizes>} - Success response
10
20
  * @name allSizes
11
- * @summary: Get all product sizes.
21
+ * @summary: Get product sizes
12
22
  * @description: Retrieve all available sizes for a product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/allSizes/).
13
23
  */
14
24
  allSizes({ itemId, requestHeaders }?: CatalogPlatformValidator.AllSizesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAllSizes>;
25
+ /**
26
+ * @param {CatalogPlatformValidator.BulkHsnCodeParam} arg - Arg object
27
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
28
+ * @param {import("../PlatformAPIClient").Options} - Options
29
+ * @returns {Promise<CatalogPlatformModel.BulkHsnResponseSchema>} - Success response
30
+ * @name bulkHsnCode
31
+ * @summary: Create Bulk update HSN
32
+ * @description: Execute bulk updates for HSN codes across multiple products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/bulkHsnCode/).
33
+ */
34
+ bulkHsnCode({ body, requestHeaders }?: CatalogPlatformValidator.BulkHsnCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkHsnResponseSchema>;
15
35
  /**
16
36
  * @param {CatalogPlatformValidator.CreateBulkInventoryParam} arg - Arg object
17
37
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
18
38
  * @param {import("../PlatformAPIClient").Options} - Options
19
- * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
39
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
20
40
  * @name createBulkInventory
21
- * @summary: Create bulk inventory.
41
+ * @summary: Create bulk inventory
22
42
  * @description: 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/).
23
43
  */
24
- createBulkInventory({ batchId, body, requestHeaders }?: CatalogPlatformValidator.CreateBulkInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
44
+ createBulkInventory({ batchId, body, requestHeaders }?: CatalogPlatformValidator.CreateBulkInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
25
45
  /**
26
46
  * @param {CatalogPlatformValidator.CreateBulkInventoryJobParam} arg - Arg object
27
47
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
28
48
  * @param {import("../PlatformAPIClient").Options} - Options
29
- * @returns {Promise<CatalogPlatformModel.InventoryBulkResponse>} - Success response
49
+ * @returns {Promise<CatalogPlatformModel.BulkResponseSchema>} - Success response
30
50
  * @name createBulkInventoryJob
31
- * @summary: Create bulk inventory upload job.
51
+ * @summary: Create bulk inventory upload job
32
52
  * @description: Helps to create a bulk Inventory upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createBulkInventoryJob/).
33
53
  */
34
- createBulkInventoryJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkInventoryJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryBulkResponse>;
54
+ createBulkInventoryJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkInventoryJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponseSchema>;
35
55
  /**
36
56
  * @param {CatalogPlatformValidator.CreateBulkProductUploadJobParam} arg - Arg object
37
57
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
38
58
  * @param {import("../PlatformAPIClient").Options} - Options
39
- * @returns {Promise<CatalogPlatformModel.ProductBulkResponse>} - Success response
59
+ * @returns {Promise<CatalogPlatformModel.BulkResponseSchema>} - Success response
40
60
  * @name createBulkProductUploadJob
41
- * @summary: Create a Bulk product to upload job.
61
+ * @summary: Create products bulk upload
42
62
  * @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/).
43
63
  */
44
- createBulkProductUploadJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkProductUploadJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductBulkResponse>;
45
- /**
46
- * @param {CatalogPlatformValidator.CreateCategoriesParam} arg - Arg object
47
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
48
- * @param {import("../PlatformAPIClient").Options} - Options
49
- * @returns {Promise<CatalogPlatformModel.CategoryCreateResponse>} - Success response
50
- * @name createCategories
51
- * @summary: Create categories.
52
- * @description: Lets user create product categories on for the seller on the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCategories/).
53
- */
54
- createCategories({ body, requestHeaders }?: CatalogPlatformValidator.CreateCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryCreateResponse>;
55
- /**
56
- * @param {CatalogPlatformValidator.CreateDepartmentsParam} arg - Arg object
57
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
58
- * @param {import("../PlatformAPIClient").Options} - Options
59
- * @returns {Promise<CatalogPlatformModel.DepartmentCreateResponse>} -
60
- * Success response
61
- * @name createDepartments
62
- * @summary: Create departments.
63
- * @description: Create departments with this resource. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createDepartments/).
64
- */
65
- createDepartments({ body, requestHeaders }?: CatalogPlatformValidator.CreateDepartmentsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentCreateResponse>;
64
+ createBulkProductUploadJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateBulkProductUploadJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponseSchema>;
66
65
  /**
67
66
  * @param {CatalogPlatformValidator.CreateInventoryExportParam} arg - Arg object
68
67
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
69
68
  * @param {import("../PlatformAPIClient").Options} - Options
70
- * @returns {Promise<CatalogPlatformModel.InventoryExportResponse>} - Success response
69
+ * @returns {Promise<CatalogPlatformModel.InventoryExportResponseSchema>} -
70
+ * Success response
71
71
  * @name createInventoryExport
72
- * @summary: Create inventory export.
73
- * @description: Helps to create a Inventory export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createInventoryExport/).
72
+ * @summary: Create inventory export
73
+ * @description: creates export job for inventory data associated with a company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createInventoryExport/).
74
74
  */
75
- createInventoryExport({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportResponse>;
75
+ createInventoryExport({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportResponseSchema>;
76
76
  /**
77
77
  * @param {CatalogPlatformValidator.CreateInventoryExportJobParam} arg - Arg object
78
78
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
79
79
  * @param {import("../PlatformAPIClient").Options} - Options
80
- * @returns {Promise<CatalogPlatformModel.InventoryExportResponse>} - Success response
80
+ * @returns {Promise<CatalogPlatformModel.InventoryExportResponseSchema>} -
81
+ * Success response
81
82
  * @name createInventoryExportJob
82
- * @summary: Create inventory export job.
83
+ * @summary: Create inventory export job
83
84
  * @description: Helps to create a Inventory export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createInventoryExportJob/).
84
85
  */
85
- createInventoryExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportResponse>;
86
+ createInventoryExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateInventoryExportJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportResponseSchema>;
86
87
  /**
87
88
  * @param {CatalogPlatformValidator.CreateMarketplaceOptinParam} arg - Arg object
88
89
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
89
90
  * @param {import("../PlatformAPIClient").Options} - Options
90
- * @returns {Promise<CatalogPlatformModel.CreateMarketplaceOptinResponse>}
91
+ * @returns {Promise<CatalogPlatformModel.CreateMarketplaceOptinResponseSchema>}
91
92
  * - Success response
92
93
  *
93
94
  * @name createMarketplaceOptin
94
- * @summary: Update marketplace optin
95
- * @description: This API allows to create marketplace optin for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createMarketplaceOptin/).
95
+ * @summary: Create or Update opt-in infomation
96
+ * @description: Allows to create opt-in information for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createMarketplaceOptin/).
96
97
  */
97
- createMarketplaceOptin({ marketplace, body, requestHeaders }?: CatalogPlatformValidator.CreateMarketplaceOptinParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateMarketplaceOptinResponse>;
98
+ createMarketplaceOptin({ marketplaceSlug, body, requestHeaders }?: CatalogPlatformValidator.CreateMarketplaceOptinParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateMarketplaceOptinResponseSchema>;
98
99
  /**
99
100
  * @param {CatalogPlatformValidator.CreateProductParam} arg - Arg object
100
101
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
101
102
  * @param {import("../PlatformAPIClient").Options} - Options
102
- * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
103
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseObject>} - Success response
103
104
  * @name createProduct
104
- * @summary: Create a product.
105
- * @description: Allows to create product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProduct/).
105
+ * @summary: Create product
106
+ * @description: Users can create a product using this API, associating it with the provided company ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProduct/).
106
107
  */
107
- createProduct({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
108
+ createProduct({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseObject>;
108
109
  /**
109
110
  * @param {CatalogPlatformValidator.CreateProductAssetsInBulkParam} arg - Arg object
110
111
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
111
112
  * @param {import("../PlatformAPIClient").Options} - Options
112
- * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
113
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
113
114
  * @name createProductAssetsInBulk
114
- * @summary: Create product assets in bulk.
115
+ * @summary: Create product assets in bulk
115
116
  * @description: Helps to create a bulk asset upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductAssetsInBulk/).
116
117
  */
117
- createProductAssetsInBulk({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
118
+ createProductAssetsInBulk({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
118
119
  /**
119
120
  * @param {CatalogPlatformValidator.CreateProductBundleParam} arg - Arg object
120
121
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
121
122
  * @param {import("../PlatformAPIClient").Options} - Options
122
- * @returns {Promise<CatalogPlatformModel.GetProductBundleCreateResponse>}
123
+ * @returns {Promise<CatalogPlatformModel.GetProductBundleCreateResponseSchema>}
123
124
  * - Success response
124
125
  *
125
126
  * @name createProductBundle
126
- * @summary: Create a product bundle.
127
- * @description: Create product bundle in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductBundle/).
127
+ * @summary: Create product bundle
128
+ * @description: Create product bundle in the catalog associated to a specific company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductBundle/).
128
129
  */
129
- createProductBundle({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleCreateResponse>;
130
+ createProductBundle({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleCreateResponseSchema>;
130
131
  /**
131
132
  * @param {CatalogPlatformValidator.CreateProductExportJobParam} arg - Arg object
132
133
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
133
134
  * @param {import("../PlatformAPIClient").Options} - Options
134
- * @returns {Promise<CatalogPlatformModel.CreateProductDownloadsResponse>}
135
+ * @returns {Promise<CatalogPlatformModel.ProductDownloadsResponseSchema>}
135
136
  * - Success response
136
137
  *
137
138
  * @name createProductExportJob
138
- * @summary: Create product export job.
139
- * @description: Helps to create a Inventory export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductExportJob/).
139
+ * @summary: Create product export job
140
+ * @description: Allows to create a product export job for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProductExportJob/).
140
141
  */
141
- createProductExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductExportJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateProductDownloadsResponse>;
142
+ createProductExportJob({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductExportJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponseSchema>;
142
143
  /**
143
144
  * @param {CatalogPlatformValidator.CreateProductsInBulkParam} arg - Arg object
144
145
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
145
146
  * @param {import("../PlatformAPIClient").Options} - Options
146
- * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
147
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
147
148
  * @name createProductsInBulk
148
- * @summary: Create products in bulk.
149
+ * @summary: Create products in bulk
149
150
  * @description: 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/).
150
151
  */
151
- createProductsInBulk({ batchId, body, requestHeaders }?: CatalogPlatformValidator.CreateProductsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
152
+ createProductsInBulk({ batchId, body, requestHeaders }?: CatalogPlatformValidator.CreateProductsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
152
153
  /**
153
154
  * @param {CatalogPlatformValidator.CreateSizeGuideParam} arg - Arg object
154
155
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
155
156
  * @param {import("../PlatformAPIClient").Options} - Options
156
- * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
157
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
157
158
  * @name createSizeGuide
158
- * @summary: Create a size guide.
159
- * @description: Allows to create a size guide associated to a brand. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createSizeGuide/).
159
+ * @summary: Create size guide
160
+ * @description: Allows to create a size guide associated to a seller - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createSizeGuide/).
160
161
  */
161
- createSizeGuide({ body, requestHeaders }?: CatalogPlatformValidator.CreateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
162
+ createSizeGuide({ body, requestHeaders }?: CatalogPlatformValidator.CreateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
162
163
  /**
163
164
  * @param {CatalogPlatformValidator.DeleteBulkInventoryJobParam} arg - Arg object
164
165
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
165
166
  * @param {import("../PlatformAPIClient").Options} - Options
166
- * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
167
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
167
168
  * @name deleteBulkInventoryJob
168
- * @summary: Delete inventory bulk upload job.
169
+ * @summary: Delete inventory bulk upload job
169
170
  * @description: Allows to delete bulk Inventory job associated with company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteBulkInventoryJob/).
170
171
  */
171
- deleteBulkInventoryJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteBulkInventoryJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
172
+ deleteBulkInventoryJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteBulkInventoryJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
172
173
  /**
173
174
  * @param {CatalogPlatformValidator.DeleteProductParam} arg - Arg object
174
175
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
175
176
  * @param {import("../PlatformAPIClient").Options} - Options
176
- * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
177
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
177
178
  * @name deleteProduct
178
- * @summary: Delete a product.
179
- * @description: Remove a specific product in the catalog - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteProduct/).
179
+ * @summary: Delete product
180
+ * @description: Users can delete a product by providing the item_id and company_id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteProduct/).
180
181
  */
181
- deleteProduct({ itemId, requestHeaders }?: CatalogPlatformValidator.DeleteProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
182
+ deleteProduct({ itemId, requestHeaders }?: CatalogPlatformValidator.DeleteProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
182
183
  /**
183
184
  * @param {CatalogPlatformValidator.DeleteProductBulkJobParam} arg - Arg object
184
185
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
185
186
  * @param {import("../PlatformAPIClient").Options} - Options
186
- * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
187
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
187
188
  * @name deleteProductBulkJob
188
- * @summary: Delete product bulk upload job.
189
+ * @summary: Delete product bulk-upload job
189
190
  * @description: Allows to delete bulk product job associated with company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteProductBulkJob/).
190
191
  */
191
- deleteProductBulkJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteProductBulkJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
192
+ deleteProductBulkJob({ batchId, requestHeaders }?: CatalogPlatformValidator.DeleteProductBulkJobParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
192
193
  /**
193
194
  * @param {CatalogPlatformValidator.DeleteRealtimeInventoryParam} arg - Arg object
194
195
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
195
196
  * @param {import("../PlatformAPIClient").Options} - Options
196
- * @returns {Promise<CatalogPlatformModel.InventoryUpdateResponse>} - Success response
197
+ * @returns {Promise<CatalogPlatformModel.InventoryUpdateResponseSchema>} -
198
+ * Success response
197
199
  * @name deleteRealtimeInventory
198
- * @summary: Delete realtime inventory.
199
- * @description: Remove specific realtime inventory data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteRealtimeInventory/).
200
+ * @summary: Delete an inventory
201
+ * @description: You can use this API to delete inventory linked to a particular product size. When you make the API call, the inventory associated with that size will be removed as part of api process. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteRealtimeInventory/).
200
202
  */
201
- deleteRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.DeleteRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponse>;
203
+ deleteRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.DeleteRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponseSchema>;
202
204
  /**
203
205
  * @param {CatalogPlatformValidator.DeleteSizeParam} arg - Arg object
204
206
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
205
207
  * @param {import("../PlatformAPIClient").Options} - Options
206
- * @returns {Promise<CatalogPlatformModel.ProductSizeDeleteResponse>} -
207
- * Success response
208
+ * @returns {Promise<CatalogPlatformModel.ProductSizeDeleteResponseSchema>}
209
+ * - Success response
210
+ *
208
211
  * @name deleteSize
209
- * @summary: Delete product size.
212
+ * @summary: Delete product size
210
213
  * @description: Allows to delete size associated with product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteSize/).
211
214
  */
212
- deleteSize({ itemId, size, requestHeaders }?: CatalogPlatformValidator.DeleteSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductSizeDeleteResponse>;
215
+ deleteSize({ itemId, size, requestHeaders }?: CatalogPlatformValidator.DeleteSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductSizeDeleteResponseSchema>;
213
216
  /**
214
217
  * @param {CatalogPlatformValidator.DownloadInventoryTemplateViewParam} arg
215
218
  * - Arg object
@@ -218,10 +221,10 @@ declare class Catalog {
218
221
  * @param {import("../PlatformAPIClient").Options} - Options
219
222
  * @returns {Promise<string>} - Success response
220
223
  * @name downloadInventoryTemplateView
221
- * @summary: Download inventory template view.
222
- * @description: Allows you to download product template data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/downloadInventoryTemplateView/).
224
+ * @summary: Download inventory template data
225
+ * @description: Allows you to download inventory product template data for a specific company in formats like csv and excel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/downloadInventoryTemplateView/).
223
226
  */
224
- downloadInventoryTemplateView({ type, requestHeaders }?: CatalogPlatformValidator.DownloadInventoryTemplateViewParam, { responseHeaders }?: object): Promise<string>;
227
+ downloadInventoryTemplateView({ itemType, requestHeaders }?: CatalogPlatformValidator.DownloadInventoryTemplateViewParam, { responseHeaders }?: object): Promise<string>;
225
228
  /**
226
229
  * @param {CatalogPlatformValidator.DownloadProductTemplateViewsParam} arg
227
230
  * - Arg object
@@ -230,30 +233,30 @@ declare class Catalog {
230
233
  * @param {import("../PlatformAPIClient").Options} - Options
231
234
  * @returns {Promise<string>} - Success response
232
235
  * @name downloadProductTemplateViews
233
- * @summary: Download product template views.
234
- * @description: Allows you to download product template data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/downloadProductTemplateViews/).
236
+ * @summary: Download product template view
237
+ * @description: Allows you to download product template data by its slug for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/downloadProductTemplateViews/).
235
238
  */
236
239
  downloadProductTemplateViews({ slug, itemType, type, requestHeaders }?: CatalogPlatformValidator.DownloadProductTemplateViewsParam, { responseHeaders }?: object): Promise<string>;
237
240
  /**
238
241
  * @param {CatalogPlatformValidator.EditProductParam} arg - Arg object
239
242
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
240
243
  * @param {import("../PlatformAPIClient").Options} - Options
241
- * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
244
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
242
245
  * @name editProduct
243
- * @summary: Edit a product.
246
+ * @summary: Update a product
244
247
  * @description: Modify the details and settings of an existing product in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/editProduct/).
245
248
  */
246
- editProduct({ itemId, body, requestHeaders }?: CatalogPlatformValidator.EditProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
249
+ editProduct({ itemId, body, requestHeaders }?: CatalogPlatformValidator.EditProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
247
250
  /**
248
251
  * @param {CatalogPlatformValidator.ExportInventoryConfigParam} arg - Arg object
249
252
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
250
253
  * @param {import("../PlatformAPIClient").Options} - Options
251
254
  * @returns {Promise<CatalogPlatformModel.InventoryConfig>} - Success response
252
255
  * @name exportInventoryConfig
253
- * @summary: Export inventory configuration.
256
+ * @summary: Get export inventory configuration
254
257
  * @description: Retrieve 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
258
  */
256
- exportInventoryConfig({ filter, requestHeaders }?: CatalogPlatformValidator.ExportInventoryConfigParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryConfig>;
259
+ exportInventoryConfig({ filterType, requestHeaders }?: CatalogPlatformValidator.ExportInventoryConfigParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryConfig>;
257
260
  /**
258
261
  * @param {CatalogPlatformValidator.GetAllProductHsnCodesParam} arg - Arg object
259
262
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -262,20 +265,31 @@ declare class Catalog {
262
265
  * - Success response
263
266
  *
264
267
  * @name getAllProductHsnCodes
265
- * @summary: Get all product HSN codes.
266
- * @description: Retrieve all HSN codes associated with products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllProductHsnCodes/).
268
+ * @summary: List product HSN codes
269
+ * @description: Retrieve all HSN codes associated with company products and provide search capabilities based on HSN code, reporting HSN, etc - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllProductHsnCodes/).
267
270
  */
268
271
  getAllProductHsnCodes({ pageNo, pageSize, q, type, requestHeaders }?: CatalogPlatformValidator.GetAllProductHsnCodesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCodesListingResponseSchemaV2>;
272
+ /**
273
+ * @param {CatalogPlatformValidator.GetAttributeParam} arg - Arg object
274
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
275
+ * @param {import("../PlatformAPIClient").Options} - Options
276
+ * @returns {Promise<CatalogPlatformModel.AttributeDetail>} - Success response
277
+ * @name getAttribute
278
+ * @summary: Get attribute detail by slug
279
+ * @description: Retrieve the attribute detail for catalog listings by attribute slug passed for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAttribute/).
280
+ */
281
+ getAttribute({ attributeSlug, requestHeaders }?: CatalogPlatformValidator.GetAttributeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AttributeDetail>;
269
282
  /**
270
283
  * @param {CatalogPlatformValidator.GetCategoryDataParam} arg - Arg object
271
284
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
272
285
  * @param {import("../PlatformAPIClient").Options} - Options
273
- * @returns {Promise<CatalogPlatformModel.SingleCategoryResponse>} - Success response
286
+ * @returns {Promise<CatalogPlatformModel.SingleCategoryResponseSchema>} -
287
+ * Success response
274
288
  * @name getCategoryData
275
- * @summary: Get category data.
276
- * @description: Retrieve detailed information about a specific category with the associated meta. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCategoryData/).
289
+ * @summary: Get category by uid
290
+ * @description: Retrieve detailed information about a specific category by its uid for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCategoryData/).
277
291
  */
278
- getCategoryData({ uid, requestHeaders }?: CatalogPlatformValidator.GetCategoryDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SingleCategoryResponse>;
292
+ getCategoryData({ uid, requestHeaders }?: CatalogPlatformValidator.GetCategoryDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SingleCategoryResponseSchema>;
279
293
  /**
280
294
  * @param {CatalogPlatformValidator.GetCompanyBrandDetailParam} arg - Arg object
281
295
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -283,29 +297,18 @@ declare class Catalog {
283
297
  * @returns {Promise<CatalogPlatformModel.OptinCompanyBrandDetailsView>} -
284
298
  * Success response
285
299
  * @name getCompanyBrandDetail
286
- * @summary: Get the Company Brand details of Optin.
287
- * @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/).
300
+ * @summary: list Company Brand of Optin
301
+ * @description: Get the details of the Brands associated with the given company_id passed which has opt-in. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyBrandDetail/).
288
302
  */
289
303
  getCompanyBrandDetail({ isActive, q, pageNo, pageSize, marketplace, requestHeaders }?: CatalogPlatformValidator.GetCompanyBrandDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinCompanyBrandDetailsView>;
290
- /**
291
- * @param {CatalogPlatformValidator.GetCompanyBrandsDRIParam} arg - Arg object
292
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
293
- * @param {import("../PlatformAPIClient").Options} - Options
294
- * @returns {Promise<CatalogPlatformModel.CompanyDRIListResponseSchema>} -
295
- * Success response
296
- * @name getCompanyBrandsDRI
297
- * @summary: Get support representative's associated to a company
298
- * @description: This API helps to view support representative's associated to a particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyBrandsDRI/).
299
- */
300
- getCompanyBrandsDRI({ pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetCompanyBrandsDRIParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CompanyDRIListResponseSchema>;
301
304
  /**
302
305
  * @param {CatalogPlatformValidator.GetCompanyDetailParam} arg - Arg object
303
306
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
304
307
  * @param {import("../PlatformAPIClient").Options} - Options
305
308
  * @returns {Promise<CatalogPlatformModel.OptinCompanyDetail>} - Success response
306
309
  * @name getCompanyDetail
307
- * @summary: Get the Company details.
308
- * @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/).
310
+ * @summary: Get Company
311
+ * @description: Get the details of the company associated with the given company_id passed which has opt-in. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyDetail/).
309
312
  */
310
313
  getCompanyDetail({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinCompanyDetail>;
311
314
  /**
@@ -314,48 +317,28 @@ declare class Catalog {
314
317
  * @param {import("../PlatformAPIClient").Options} - Options
315
318
  * @returns {Promise<CatalogPlatformModel.OptinCompanyMetrics>} - Success response
316
319
  * @name getCompanyMetrics
317
- * @summary: Get company metrics.
318
- * @description: Allows to view the company metrics, i.e. the status of its brand and stores. Also its allows to view the number of products, company documents & store documents which are verified and unverified. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyMetrics/).
320
+ * @summary: Get company metrics
321
+ * @description: Allows viewing company metrics, including brand and store status, as well as the number of verified and unverified products, company documents, and store documents. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyMetrics/).
319
322
  */
320
323
  getCompanyMetrics({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinCompanyMetrics>;
321
- /**
322
- * @param {CatalogPlatformValidator.GetCompanyVerificationParam} arg - Arg object
323
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
324
- * @param {import("../PlatformAPIClient").Options} - Options
325
- * @returns {Promise<CatalogPlatformModel.CompanyVerificationResponse>} -
326
- * Success response
327
- * @name getCompanyVerification
328
- * @summary: Get company verification status
329
- * @description: This API gets company verification details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCompanyVerification/).
330
- */
331
- getCompanyVerification({ q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetCompanyVerificationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CompanyVerificationResponse>;
332
324
  /**
333
325
  * @param {CatalogPlatformValidator.GetDepartmentDataParam} arg - Arg object
334
326
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
335
327
  * @param {import("../PlatformAPIClient").Options} - Options
336
- * @returns {Promise<CatalogPlatformModel.DepartmentsResponse>} - Success response
328
+ * @returns {Promise<CatalogPlatformModel.DepartmentsResponseSchema>} -
329
+ * Success response
337
330
  * @name getDepartmentData
338
- * @summary: Get department data.
339
- * @description: Retrieve detailed information about a specific department by UID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getDepartmentData/).
331
+ * @summary: Get department by uid
332
+ * @description: Retrieve detailed information about a specific department for a specific company by uid. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getDepartmentData/).
340
333
  */
341
- getDepartmentData({ uid, requestHeaders }?: CatalogPlatformValidator.GetDepartmentDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentsResponse>;
342
- /**
343
- * @param {CatalogPlatformValidator.GetGenderAttributeParam} arg - Arg object
344
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
345
- * @param {import("../PlatformAPIClient").Options} - Options
346
- * @returns {Promise<CatalogPlatformModel.GenderDetail>} - Success response
347
- * @name getGenderAttribute
348
- * @summary: Get gender attribute.
349
- * @description: Retrieve the gender attribute for catalog listings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getGenderAttribute/).
350
- */
351
- getGenderAttribute({ attributeSlug, requestHeaders }?: CatalogPlatformValidator.GetGenderAttributeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GenderDetail>;
334
+ getDepartmentData({ uid, requestHeaders }?: CatalogPlatformValidator.GetDepartmentDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentsResponseSchema>;
352
335
  /**
353
336
  * @param {CatalogPlatformValidator.GetHsnCodeParam} arg - Arg object
354
337
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
355
338
  * @param {import("../PlatformAPIClient").Options} - Options
356
339
  * @returns {Promise<CatalogPlatformModel.HsnCode>} - Success response
357
340
  * @name getHsnCode
358
- * @summary: Get HSN code.
341
+ * @summary: List HSN code
359
342
  * @description: Retrieve the HSN code for a product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getHsnCode/).
360
343
  */
361
344
  getHsnCode({ id, requestHeaders }?: CatalogPlatformValidator.GetHsnCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCode>;
@@ -363,12 +346,60 @@ declare class Catalog {
363
346
  * @param {CatalogPlatformValidator.GetInventoriesParam} arg - Arg object
364
347
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
365
348
  * @param {import("../PlatformAPIClient").Options} - Options
366
- * @returns {Promise<CatalogPlatformModel.GetInventoriesResponse>} - Success response
349
+ * @returns {Promise<CatalogPlatformModel.GetInventoriesResponseSchema>} -
350
+ * Success response
367
351
  * @name getInventories
368
- * @summary: Retrieve inventories.
369
- * @description: Allows to get Inventories data for particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventories/).
370
- */
371
- getInventories({ itemId, size, pageNo, pageSize, pageId, pageType, q, sellable, storeIds, brandIds, sellerIdentifiers, minSellable, maxSellable, fromDate, toDate, sizeIdentifier, requestHeaders, }?: CatalogPlatformValidator.GetInventoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetInventoriesResponse>;
352
+ * @summary: List Inventory
353
+ * @description: Allows to get Inventories data for particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventories/).
354
+ */
355
+ getInventories({ itemId, size, pageNo, pageSize, pageId, pageType, q, sellable, storeIds, brandIds, sellerIdentifiers, qtyGt, qtyLt, qtyType, fromDate, toDate, sizeIdentifier, requestHeaders, }?: CatalogPlatformValidator.GetInventoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetInventoriesResponseSchema>;
356
+ /**
357
+ * @param {Object} arg - Arg object.
358
+ * @param {string} [arg.itemId] - Item code of the product of which size is to be get.
359
+ * @param {string} [arg.size] - Size of which inventory is to get.
360
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each
361
+ * page. Default is 12.
362
+ * @param {string} [arg.q] - Search with help of store code.
363
+ * @param {boolean} [arg.sellable] - Filter on whether product is in stock or not.
364
+ * @param {number[]} [arg.storeIds] - The Store Id of products to fetch inventory.
365
+ * @param {number[]} [arg.brandIds] - The Brand Id of products to fetch inventory.
366
+ * @param {string[]} [arg.sellerIdentifiers] - The Seller Identifier or
367
+ * Primary Identifier of the inventory.
368
+ * @param {number} [arg.qtyGt] - This field allows you to filter for
369
+ * inventories that have quantity greater than to the specified value
370
+ * based on qty_type filter.
371
+ * @param {number} [arg.qtyLt] - This field allows you to filter for
372
+ * inventories that have a quantity less than to the specified value based
373
+ * on qty_type filter.
374
+ * @param {string} [arg.qtyType] - This field provides flexibility in
375
+ * selecting filter for inventory quantity counts and date queries. For
376
+ * example, you might use this field to specify "total" or "sellable" quantity.
377
+ * @param {string} [arg.fromDate] - Inventory updated on filter to get
378
+ * inventories greater then or equal to provided date based on qty_type value.
379
+ * @param {string} [arg.toDate] - Inventory updated on filter to get
380
+ * inventories less then or equal to provided date based on qty_type value.
381
+ * @param {string} [arg.sizeIdentifier] - Size Identifier (Seller Identifier
382
+ * or Primary Identifier) of which inventory is to get.
383
+ * @returns {Paginator<CatalogPlatformModel.GetInventoriesResponseSchema>}
384
+ * @summary: List Inventory
385
+ * @description: Allows to get Inventories data for particular company.
386
+ */
387
+ getInventoriesPaginator({ itemId, size, pageSize, q, sellable, storeIds, brandIds, sellerIdentifiers, qtyGt, qtyLt, qtyType, fromDate, toDate, sizeIdentifier, }?: {
388
+ itemId?: string;
389
+ size?: string;
390
+ pageSize?: number;
391
+ q?: string;
392
+ sellable?: boolean;
393
+ storeIds?: number[];
394
+ brandIds?: number[];
395
+ sellerIdentifiers?: string[];
396
+ qtyGt?: number;
397
+ qtyLt?: number;
398
+ qtyType?: string;
399
+ fromDate?: string;
400
+ toDate?: string;
401
+ sizeIdentifier?: string;
402
+ }): Paginator<CatalogPlatformModel.GetInventoriesResponseSchema>;
372
403
  /**
373
404
  * @param {CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam} arg
374
405
  * - Arg object
@@ -377,10 +408,23 @@ declare class Catalog {
377
408
  * @param {import("../PlatformAPIClient").Options} - Options
378
409
  * @returns {Promise<CatalogPlatformModel.BulkInventoryGet>} - Success response
379
410
  * @name getInventoryBulkUploadHistory
380
- * @summary: Retrieve inventory bulk upload history.
381
- * @description: Helps to get bulk Inventory upload jobs data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBulkUploadHistory/).
411
+ * @summary: List bulk inventory upload history
412
+ * @description: Helps to get bulk Inventory upload jobs status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBulkUploadHistory/).
382
413
  */
383
- getInventoryBulkUploadHistory({ pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkInventoryGet>;
414
+ getInventoryBulkUploadHistory({ pageNo, pageSize, search, requestHeaders }?: CatalogPlatformValidator.GetInventoryBulkUploadHistoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkInventoryGet>;
415
+ /**
416
+ * @param {Object} arg - Arg object.
417
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each
418
+ * page. Default is 12.
419
+ * @param {string} [arg.search] - Search string to filter the results by batch id
420
+ * @returns {Paginator<CatalogPlatformModel.BulkInventoryGet>}
421
+ * @summary: List bulk inventory upload history
422
+ * @description: Helps to get bulk Inventory upload jobs status.
423
+ */
424
+ getInventoryBulkUploadHistoryPaginator({ pageSize, search }?: {
425
+ pageSize?: number;
426
+ search?: string;
427
+ }): Paginator<CatalogPlatformModel.BulkInventoryGet>;
384
428
  /**
385
429
  * @param {CatalogPlatformValidator.GetInventoryBySizeParam} arg - Arg object
386
430
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -388,10 +432,29 @@ declare class Catalog {
388
432
  * @returns {Promise<CatalogPlatformModel.InventoryResponsePaginated>} -
389
433
  * Success response
390
434
  * @name getInventoryBySize
391
- * @summary: Get inventory by size.
392
- * @description: Allows to retrieve Inventory data for particular company grouped by size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBySize/).
435
+ * @summary: List inventory by size
436
+ * @description: Retrieve inventory data for a specific company, item ID, and size. The API supports search capabilities based on selling location (store) code and product availability (in stock or not)." - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBySize/).
393
437
  */
394
438
  getInventoryBySize({ itemId, size, pageNo, pageSize, q, sellable, requestHeaders }?: CatalogPlatformValidator.GetInventoryBySizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryResponsePaginated>;
439
+ /**
440
+ * @param {Object} arg - Arg object.
441
+ * @param {number} arg.itemId - Item code of the product of which size is to be get.
442
+ * @param {string} arg.size - Size of which inventory is to get.
443
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each
444
+ * page. Default is 12.
445
+ * @param {string} [arg.q] - Search with help of store code.
446
+ * @param {boolean} [arg.sellable] - Filter on whether product is in stock or not.
447
+ * @returns {Paginator<CatalogPlatformModel.InventoryResponsePaginated>}
448
+ * @summary: List inventory by size
449
+ * @description: Retrieve inventory data for a specific company, item ID, and size. The API supports search capabilities based on selling location (store) code and product availability (in stock or not)."
450
+ */
451
+ getInventoryBySizePaginator({ itemId, size, pageSize, q, sellable }?: {
452
+ itemId: number;
453
+ size: string;
454
+ pageSize?: number;
455
+ q?: string;
456
+ sellable?: boolean;
457
+ }): Paginator<CatalogPlatformModel.InventoryResponsePaginated>;
395
458
  /**
396
459
  * @param {CatalogPlatformValidator.GetInventoryBySizeIdentifierParam} arg
397
460
  * - Arg object
@@ -402,194 +465,206 @@ declare class Catalog {
402
465
  * - Success response
403
466
  *
404
467
  * @name getInventoryBySizeIdentifier
405
- * @summary: Get inventory by size identifier.
406
- * @description: Allows to retrieve Inventory data for particular company grouped by size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBySizeIdentifier/).
468
+ * @summary: List inventory by size
469
+ * @description: Retrieve inventory data for a specific company, item ID, and seller identifier. The API supports search capabilities using store codes and location IDs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryBySizeIdentifier/).
407
470
  */
408
471
  getInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize, q, locationIds, requestHeaders, }?: CatalogPlatformValidator.GetInventoryBySizeIdentifierParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>;
472
+ /**
473
+ * @param {Object} arg - Arg object.
474
+ * @param {number} arg.itemId - Item code of the product of which size is to be get.
475
+ * @param {string} arg.sizeIdentifier - Size Identifier (Seller Identifier
476
+ * or Primary Identifier) of which inventory is to get.
477
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each
478
+ * page. Default is 12.
479
+ * @param {string} [arg.q] - Search with help of store code.
480
+ * @param {number[]} [arg.locationIds] - Search by store ids.
481
+ * @returns {Paginator<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>}
482
+ * @summary: List inventory by size
483
+ * @description: Retrieve inventory data for a specific company, item ID, and seller identifier. The API supports search capabilities using store codes and location IDs.
484
+ */
485
+ getInventoryBySizeIdentifierPaginator({ itemId, sizeIdentifier, pageSize, q, locationIds, }?: {
486
+ itemId: number;
487
+ sizeIdentifier: string;
488
+ pageSize?: number;
489
+ q?: string;
490
+ locationIds?: number[];
491
+ }): Paginator<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>;
409
492
  /**
410
493
  * @param {CatalogPlatformValidator.GetInventoryExportParam} arg - Arg object
411
494
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
412
495
  * @param {import("../PlatformAPIClient").Options} - Options
413
- * @returns {Promise<CatalogPlatformModel.InventoryExportJobResponse>} -
414
- * Success response
496
+ * @returns {Promise<CatalogPlatformModel.InventoryExportJob>} - Success response
415
497
  * @name getInventoryExport
416
- * @summary: Retrieve inventory export data.
417
- * @description: Helps to retrieve Inventory export history. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryExport/).
418
- */
419
- getInventoryExport({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportJobResponse>;
420
- /**
421
- * @param {CatalogPlatformValidator.GetInventoryExportDetailParam} arg - Arg object
422
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
423
- * @param {import("../PlatformAPIClient").Options} - Options
424
- * @returns {Promise<CatalogPlatformModel.EditInventoryDownloadsResponse>}
425
- * - Success response
426
- *
427
- * @name getInventoryExportDetail
428
- * @summary: Get Detail Product export detail.
429
- * @description: This API helps to get detail of Product export. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryExportDetail/).
498
+ * @summary: list product inventory
499
+ * @description: Retrieves inventory for all products for that particular company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getInventoryExport/).
430
500
  */
431
- getInventoryExportDetail({ jobId, requestHeaders }?: CatalogPlatformValidator.GetInventoryExportDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.EditInventoryDownloadsResponse>;
501
+ getInventoryExport({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportJob>;
432
502
  /**
433
- * @param {CatalogPlatformValidator.GetLocationTagsParam} arg - Arg object
503
+ * @param {CatalogPlatformValidator.GetMarketplaceOptinDetailParam} arg - Arg object
434
504
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
435
505
  * @param {import("../PlatformAPIClient").Options} - Options
436
- * @returns {Promise<CatalogPlatformModel.StoreTagsResponseSchema>} - Success response
437
- * @name getLocationTags
438
- * @summary: Get tags associated with locations for a company.
439
- * @description: This API fetches all the tags associated to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getLocationTags/).
506
+ * @returns {Promise<CatalogPlatformModel.GetOptInPlatform>} - Success response
507
+ * @name getMarketplaceOptinDetail
508
+ * @summary: Get opt-in
509
+ * @description: Allows to fetch opt-in information for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getMarketplaceOptinDetail/).
440
510
  */
441
- getLocationTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.StoreTagsResponseSchema>;
511
+ getMarketplaceOptinDetail({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetOptInPlatform>;
442
512
  /**
443
513
  * @param {CatalogPlatformValidator.GetMarketplacesParam} arg - Arg object
444
514
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
445
515
  * @param {import("../PlatformAPIClient").Options} - Options
446
516
  * @returns {Promise<CatalogPlatformModel.GetAllMarketplaces>} - Success response
447
517
  * @name getMarketplaces
448
- * @summary: List all marketplaces
449
- * @description: This API allows to get marketplace information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getMarketplaces/).
518
+ * @summary: List marketplaces
519
+ * @description: Allows to get all marketplaces information for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getMarketplaces/).
450
520
  */
451
521
  getMarketplaces({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAllMarketplaces>;
522
+ /**
523
+ * @param {CatalogPlatformValidator.GetOptimalLocationsParam} arg - Arg object
524
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
525
+ * @param {import("../PlatformAPIClient").Options} - Options
526
+ * @returns {Promise<CatalogPlatformModel.StoreAssignResponseSchema>} -
527
+ * Success response
528
+ * @name getOptimalLocations
529
+ * @summary: Get optimal locations
530
+ * @description: This API returns the optimal locations where inventory is available for the given articles. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getOptimalLocations/).
531
+ */
532
+ getOptimalLocations({ body, requestHeaders }?: CatalogPlatformValidator.GetOptimalLocationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.StoreAssignResponseSchema>;
452
533
  /**
453
534
  * @param {CatalogPlatformValidator.GetProductParam} arg - Arg object
454
535
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
455
536
  * @param {import("../PlatformAPIClient").Options} - Options
456
- * @returns {Promise<CatalogPlatformModel.SingleProductResponse>} - Success response
537
+ * @returns {Promise<CatalogPlatformModel.SingleProductResponseSchema>} -
538
+ * Success response
457
539
  * @name getProduct
458
- * @summary: Get product details.
540
+ * @summary: Get a product
459
541
  * @description: Retrieve data associated to a particular product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProduct/).
460
542
  */
461
- getProduct({ itemId, brandUid, itemCode, requestHeaders }?: CatalogPlatformValidator.GetProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SingleProductResponse>;
543
+ getProduct({ itemId, brandUid, itemCode, requestHeaders }?: CatalogPlatformValidator.GetProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SingleProductResponseSchema>;
462
544
  /**
463
545
  * @param {CatalogPlatformValidator.GetProductAssetsInBulkParam} arg - Arg object
464
546
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
465
547
  * @param {import("../PlatformAPIClient").Options} - Options
466
- * @returns {Promise<CatalogPlatformModel.BulkAssetResponse>} - Success response
548
+ * @returns {Promise<CatalogPlatformModel.BulkAssetResponseSchema>} - Success response
467
549
  * @name getProductAssetsInBulk
468
- * @summary: Retrieve product assets in bulk.
550
+ * @summary: Get product assets
469
551
  * @description: Helps to retrieve bulk asset jobs data associated to a particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductAssetsInBulk/).
470
552
  */
471
- getProductAssetsInBulk({ pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkAssetResponse>;
553
+ getProductAssetsInBulk({ pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductAssetsInBulkParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkAssetResponseSchema>;
554
+ /**
555
+ * @param {Object} arg - Arg object.
556
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each
557
+ * page. Default is 12.
558
+ * @returns {Paginator<CatalogPlatformModel.BulkAssetResponseSchema>}
559
+ * @summary: Get product assets
560
+ * @description: Helps to retrieve bulk asset jobs data associated to a particular company.
561
+ */
562
+ getProductAssetsInBulkPaginator({ pageSize }?: {
563
+ pageSize?: number;
564
+ }): Paginator<CatalogPlatformModel.BulkAssetResponseSchema>;
472
565
  /**
473
566
  * @param {CatalogPlatformValidator.GetProductAttributesParam} arg - Arg object
474
567
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
475
568
  * @param {import("../PlatformAPIClient").Options} - Options
476
- * @returns {Promise<CatalogPlatformModel.ProductAttributesResponse>} -
477
- * Success response
569
+ * @returns {Promise<CatalogPlatformModel.ProductAttributesResponseSchema>}
570
+ * - Success response
571
+ *
478
572
  * @name getProductAttributes
479
- * @summary: Get product attributes.
480
- * @description: List all the attributes by their L3 categories. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductAttributes/).
573
+ * @summary: List product attributes
574
+ * @description: Retrieve attributes attached to products based on their L3 category. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductAttributes/).
481
575
  */
482
- getProductAttributes({ category, filter, requestHeaders }?: CatalogPlatformValidator.GetProductAttributesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductAttributesResponse>;
576
+ getProductAttributes({ category, filter, requestHeaders }?: CatalogPlatformValidator.GetProductAttributesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductAttributesResponseSchema>;
483
577
  /**
484
578
  * @param {CatalogPlatformValidator.GetProductBulkUploadHistoryParam} arg - Arg object
485
579
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
486
580
  * @param {import("../PlatformAPIClient").Options} - Options
487
581
  * @returns {Promise<CatalogPlatformModel.ProductBulkRequestList>} - Success response
488
582
  * @name getProductBulkUploadHistory
489
- * @summary: Retrieve product bulk upload history.
583
+ * @summary: List product bulk upload history
490
584
  * @description: Helps to get bulk product upload jobs data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBulkUploadHistory/).
491
585
  */
492
586
  getProductBulkUploadHistory({ search, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductBulkUploadHistoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductBulkRequestList>;
587
+ /**
588
+ * @param {Object} arg - Arg object.
589
+ * @param {string} [arg.search] - Search string to filter the results by batch id
590
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each
591
+ * page. Default is 12.
592
+ * @returns {Paginator<CatalogPlatformModel.ProductBulkRequestList>}
593
+ * @summary: List product bulk upload history
594
+ * @description: Helps to get bulk product upload jobs data.
595
+ */
596
+ getProductBulkUploadHistoryPaginator({ search, pageSize }?: {
597
+ search?: string;
598
+ pageSize?: number;
599
+ }): Paginator<CatalogPlatformModel.ProductBulkRequestList>;
493
600
  /**
494
601
  * @param {CatalogPlatformValidator.GetProductBundleParam} arg - Arg object
495
602
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
496
603
  * @param {import("../PlatformAPIClient").Options} - Options
497
- * @returns {Promise<CatalogPlatformModel.GetProductBundleListingResponse>}
604
+ * @returns {Promise<CatalogPlatformModel.GetProductBundleListingResponseSchema>}
498
605
  * - Success response
499
606
  *
500
607
  * @name getProductBundle
501
- * @summary: Retrieve product bundles.
502
- * @description: Retrieve a list of product bundles available in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBundle/).
608
+ * @summary: List product bundles
609
+ * @description: Retrieve a list of product bundles available in the catalog associated to a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBundle/).
503
610
  */
504
- getProductBundle({ q, slug, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleListingResponse>;
611
+ getProductBundle({ q, slug, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleListingResponseSchema>;
505
612
  /**
506
613
  * @param {CatalogPlatformValidator.GetProductBundleDetailParam} arg - Arg object
507
614
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
508
615
  * @param {import("../PlatformAPIClient").Options} - Options
509
- * @returns {Promise<CatalogPlatformModel.GetProductBundleResponse>} -
510
- * Success response
616
+ * @returns {Promise<CatalogPlatformModel.GetProductBundleResponseSchema>}
617
+ * - Success response
618
+ *
511
619
  * @name getProductBundleDetail
512
- * @summary: Get product bundle details.
513
- * @description: Retrieve detailed information about a specific product bundle. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBundleDetail/).
620
+ * @summary: Get product bundle
621
+ * @description: Retrieve detailed information about a specific product bundle associated to a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductBundleDetail/).
514
622
  */
515
- getProductBundleDetail({ id, requestHeaders }?: CatalogPlatformValidator.GetProductBundleDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleResponse>;
516
- /**
517
- * @param {CatalogPlatformValidator.GetProductExportDetailParam} arg - Arg object
518
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
519
- * @param {import("../PlatformAPIClient").Options} - Options
520
- * @returns {Promise<CatalogPlatformModel.GetProductDownloadsResponse>} -
521
- * Success response
522
- * @name getProductExportDetail
523
- * @summary: Get Detail Product export detail.
524
- * @description: This API helps to get detail of Product export. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductExportDetail/).
525
- */
526
- getProductExportDetail({ jobId, requestHeaders }?: CatalogPlatformValidator.GetProductExportDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductDownloadsResponse>;
623
+ getProductBundleDetail({ id, requestHeaders }?: CatalogPlatformValidator.GetProductBundleDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleResponseSchema>;
527
624
  /**
528
625
  * @param {CatalogPlatformValidator.GetProductExportJobsParam} arg - Arg object
529
626
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
530
627
  * @param {import("../PlatformAPIClient").Options} - Options
531
- * @returns {Promise<CatalogPlatformModel.ProductDownloadsResponse>} -
532
- * Success response
628
+ * @returns {Promise<CatalogPlatformModel.ProductDownloadsResponseSchema>}
629
+ * - Success response
630
+ *
533
631
  * @name getProductExportJobs
534
- * @summary: Retrieve product export jobs.
535
- * @description: View details including trigger data, task id , etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductExportJobs/).
632
+ * @summary: Get product export jobs
633
+ * @description: Get product export jobs specific to a company based on queries like query param, date range and status. View details including trigger data, task id , etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductExportJobs/).
536
634
  */
537
- getProductExportJobs({ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductExportJobsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponse>;
635
+ getProductExportJobs({ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductExportJobsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponseSchema>;
538
636
  /**
539
637
  * @param {CatalogPlatformValidator.GetProductSizeParam} arg - Arg object
540
638
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
541
639
  * @param {import("../PlatformAPIClient").Options} - Options
542
- * @returns {Promise<CatalogPlatformModel.Product>} - Success response
640
+ * @returns {Promise<CatalogPlatformModel.ProductListingResponseSchema>} -
641
+ * Success response
543
642
  * @name getProductSize
544
- * @summary: Get product size details.
643
+ * @summary: List product size
545
644
  * @description: Retrieve data associated to a particular product size. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductSize/).
546
645
  */
547
- getProductSize({ itemId, requestHeaders }?: CatalogPlatformValidator.GetProductSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.Product>;
646
+ getProductSize({ itemId, itemCode, brandUid, uid, requestHeaders }?: CatalogPlatformValidator.GetProductSizeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductListingResponseSchema>;
548
647
  /**
549
648
  * @param {CatalogPlatformValidator.GetProductTagsParam} arg - Arg object
550
649
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
551
650
  * @param {import("../PlatformAPIClient").Options} - Options
552
- * @returns {Promise<CatalogPlatformModel.ProductTagsViewResponse>} - Success response
651
+ * @returns {Promise<CatalogPlatformModel.ProductTagsViewResponseSchema>} -
652
+ * Success response
553
653
  * @name getProductTags
554
- * @summary: Get product tags.
654
+ * @summary: List product tags
555
655
  * @description: Retrieve tags data associated to a particular company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductTags/).
556
656
  */
557
- getProductTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductTagsViewResponse>;
558
- /**
559
- * @param {CatalogPlatformValidator.GetProductTemplateBySlugParam} arg - Arg object
560
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
561
- * @param {import("../PlatformAPIClient").Options} - Options
562
- * @returns {Promise<CatalogPlatformModel.GetProductTemplateSlugResponse>}
563
- * - Success response
564
- *
565
- * @name getProductTemplateBySlug
566
- * @summary: Update marketplace optin
567
- * @description: This API retrieves template for a given slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductTemplateBySlug/).
568
- */
569
- getProductTemplateBySlug({ slug, requestHeaders }?: CatalogPlatformValidator.GetProductTemplateBySlugParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductTemplateSlugResponse>;
657
+ getProductTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductTagsViewResponseSchema>;
570
658
  /**
571
659
  * @param {CatalogPlatformValidator.GetProductValidationParam} arg - Arg object
572
660
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
573
661
  * @param {import("../PlatformAPIClient").Options} - Options
574
662
  * @returns {Promise<CatalogPlatformModel.ValidateProduct>} - Success response
575
663
  * @name getProductValidation
576
- * @summary: Get product validation.
577
- * @description: Retrieve validation data for a specific product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductValidation/).
578
- */
579
- getProductValidation({ type, slug, requestHeaders }?: CatalogPlatformValidator.GetProductValidationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ValidateProduct>;
580
- /**
581
- * @param {CatalogPlatformValidator.GetProductVerificationDetailsParam} arg
582
- * - Arg object
583
- *
584
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
585
- * @param {import("../PlatformAPIClient").Options} - Options
586
- * @returns {Promise<CatalogPlatformModel.ProductVerificationModel>} -
587
- * Success response
588
- * @name getProductVerificationDetails
589
- * @summary: Get the verification detail of a product
590
- * @description: Get the verification detail of a product - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductVerificationDetails/).
664
+ * @summary: Get valid products
665
+ * @description: Retrieve validation data for products at company level. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductValidation/).
591
666
  */
592
- getProductVerificationDetails({ itemId, requestHeaders }?: CatalogPlatformValidator.GetProductVerificationDetailsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductVerificationModel>;
667
+ getProductValidation({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ValidateProduct>;
593
668
  /**
594
669
  * @param {CatalogPlatformValidator.GetProductsParam} arg - Arg object
595
670
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -597,146 +672,263 @@ declare class Catalog {
597
672
  * @returns {Promise<CatalogPlatformModel.ProductListingResponseV2>} -
598
673
  * Success response
599
674
  * @name getProducts
600
- * @summary: Retrieve products.
601
- * @description: Retrieve a list of products available - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProducts/).
602
- */
603
- getProducts({ brandIds, multiSize, categoryIds, itemIds, departmentIds, itemCode, name, slug, allIdentifiers, q, tags, pageNo, pageSize, pageType, sortOn, pageId, requestHeaders, }?: CatalogPlatformValidator.GetProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductListingResponseV2>;
675
+ * @summary: List products
676
+ * @description: Retrieve a list of available products - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProducts/).
677
+ */
678
+ getProducts({ brandIds, categoryIds, itemIds, departmentIds, itemCode, name, slug, allIdentifiers, q, tags, pageNo, pageSize, pageType, sortOn, pageId, requestHeaders, }?: CatalogPlatformValidator.GetProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductListingResponseV2>;
679
+ /**
680
+ * @param {Object} arg - Arg object.
681
+ * @param {number[]} [arg.brandIds] - Get multiple products filtered by Brand Ids
682
+ * @param {number[]} [arg.categoryIds] - Get multiple products filtered by
683
+ * Category Ids
684
+ * @param {number[]} [arg.itemIds] - Get multiple products filtered by Item Ids
685
+ * @param {number[]} [arg.departmentIds] - Get multiple products filtered by
686
+ * Department Ids
687
+ * @param {string[]} [arg.itemCode] - Get multiple products filtered by Item Code
688
+ * @param {string} [arg.name] - Get multiple products filtered by Name (Pattern Match)
689
+ * @param {string} [arg.slug] - Get multiple products filtered by Slug
690
+ * @param {string[]} [arg.allIdentifiers] - Get multiple products filtered
691
+ * by All Identifiers
692
+ * @param {string} [arg.q] - Get multiple products filtered by q string
693
+ * @param {string[]} [arg.tags] - Get multiple products filtered by tags
694
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each
695
+ * page. Default is 10.
696
+ * @param {string} [arg.sortOn] - Field which is to be used for sorting,
697
+ * default is latest. Value can be latest (modified_on) or created (record id)
698
+ * @returns {Paginator<CatalogPlatformModel.ProductListingResponseV2>}
699
+ * @summary: List products
700
+ * @description: Retrieve a list of available products
701
+ */
702
+ getProductsPaginator({ brandIds, categoryIds, itemIds, departmentIds, itemCode, name, slug, allIdentifiers, q, tags, pageSize, sortOn, }?: {
703
+ brandIds?: number[];
704
+ categoryIds?: number[];
705
+ itemIds?: number[];
706
+ departmentIds?: number[];
707
+ itemCode?: string[];
708
+ name?: string;
709
+ slug?: string;
710
+ allIdentifiers?: string[];
711
+ q?: string;
712
+ tags?: string[];
713
+ pageSize?: number;
714
+ sortOn?: string;
715
+ }): Paginator<CatalogPlatformModel.ProductListingResponseV2>;
604
716
  /**
605
717
  * @param {CatalogPlatformValidator.GetSellerInsightsParam} arg - Arg object
606
718
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
607
719
  * @param {import("../PlatformAPIClient").Options} - Options
608
- * @returns {Promise<CatalogPlatformModel.CrossSellingResponse>} - Success response
720
+ * @returns {Promise<CatalogPlatformModel.CrossSellingResponseSchema>} -
721
+ * Success response
609
722
  * @name getSellerInsights
610
- * @summary: Get seller insights.
611
- * @description: Retrieve insights and analytics related to sellers within the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSellerInsights/).
723
+ * @summary: Get seller catalog counts
724
+ * @description: Retrieve the count of catalog related data for sellers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSellerInsights/).
612
725
  */
613
- getSellerInsights({ sellerAppId, requestHeaders }?: CatalogPlatformValidator.GetSellerInsightsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CrossSellingResponse>;
726
+ getSellerInsights({ sellerAppId, requestHeaders }?: CatalogPlatformValidator.GetSellerInsightsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CrossSellingResponseSchema>;
614
727
  /**
615
728
  * @param {CatalogPlatformValidator.GetSingleProductHSNCodeParam} arg - Arg object
616
729
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
617
730
  * @param {import("../PlatformAPIClient").Options} - Options
618
731
  * @returns {Promise<CatalogPlatformModel.HSNDataInsertV2>} - Success response
619
732
  * @name getSingleProductHSNCode
620
- * @summary: Get single product HSN code.
621
- * @description: Retrieve the HSN code for a single product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSingleProductHSNCode/).
733
+ * @summary: Get product HSN code
734
+ * @description: Retrieve HSN details associated with company ID and reporting HSN - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSingleProductHSNCode/).
622
735
  */
623
736
  getSingleProductHSNCode({ reportingHsn, requestHeaders }?: CatalogPlatformValidator.GetSingleProductHSNCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HSNDataInsertV2>;
624
737
  /**
625
738
  * @param {CatalogPlatformValidator.GetSizeGuideParam} arg - Arg object
626
739
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
627
740
  * @param {import("../PlatformAPIClient").Options} - Options
628
- * @returns {Promise<CatalogPlatformModel.SizeGuideResponse>} - Success response
741
+ * @returns {Promise<CatalogPlatformModel.SizeGuideResponseSchema>} - Success response
629
742
  * @name getSizeGuide
630
- * @summary: Get size guide details.
631
- * @description: Retrieve data associated about a specific size guide. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSizeGuide/).
743
+ * @summary: Get size guide
744
+ * @description: Retrieve data associated about a specific size guide. It contains meta deta like header values like for shoulder, head, etc. and measurement unit like cm and values contains sizes for the same. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSizeGuide/).
632
745
  */
633
- getSizeGuide({ id, requestHeaders }?: CatalogPlatformValidator.GetSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SizeGuideResponse>;
746
+ getSizeGuide({ id, requestHeaders }?: CatalogPlatformValidator.GetSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SizeGuideResponseSchema>;
634
747
  /**
635
748
  * @param {CatalogPlatformValidator.GetSizeGuidesParam} arg - Arg object
636
749
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
637
750
  * @param {import("../PlatformAPIClient").Options} - Options
638
751
  * @returns {Promise<CatalogPlatformModel.ListSizeGuide>} - Success response
639
752
  * @name getSizeGuides
640
- * @summary: Retrieve size guides.
641
- * @description: 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/).
753
+ * @summary: List size guides
754
+ * @description: Allows to view all the size guides associated to the seller. Each size guide contains meta deta like header values like for shoulder, head, etc. and measurement unit like cm and values contains sizes for the same. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSizeGuides/).
642
755
  */
643
- getSizeGuides({ active, q, brandId, tag, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetSizeGuidesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ListSizeGuide>;
756
+ getSizeGuides({ active, q, tag, pageNo, pageSize, brandId, requestHeaders }?: CatalogPlatformValidator.GetSizeGuidesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ListSizeGuide>;
644
757
  /**
645
758
  * @param {CatalogPlatformValidator.GetStoreDetailParam} arg - Arg object
646
759
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
647
760
  * @param {import("../PlatformAPIClient").Options} - Options
648
761
  * @returns {Promise<CatalogPlatformModel.OptinStoreDetails>} - Success response
649
762
  * @name getStoreDetail
650
- * @summary: Get the Store details.
651
- * @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/).
763
+ * @summary: Get selling location
764
+ * @description: Retrieve the details of the selling location (store) associated with a specific company passed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getStoreDetail/).
652
765
  */
653
766
  getStoreDetail({ q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetStoreDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.OptinStoreDetails>;
654
767
  /**
655
- * @param {CatalogPlatformValidator.GetVariantTypesParam} arg - Arg object
656
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
657
- * @param {import("../PlatformAPIClient").Options} - Options
658
- * @returns {Promise<CatalogPlatformModel.VariantTypesResponse>} - Success response
659
- * @name getVariantTypes
660
- * @summary: Get variant type list
661
- * @description: This API gets meta associated to products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getVariantTypes/).
768
+ * @param {Object} arg - Arg object.
769
+ * @param {string} [arg.q] - The search related the store for the company id.
770
+ * @param {number} [arg.pageSize] - Number of records that can be seen on
771
+ * the page for the company id.
772
+ * @returns {Paginator<CatalogPlatformModel.OptinStoreDetails>}
773
+ * @summary: Get selling location
774
+ * @description: Retrieve the details of the selling location (store) associated with a specific company passed.
662
775
  */
663
- getVariantTypes({ templateTag, requestHeaders }?: CatalogPlatformValidator.GetVariantTypesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.VariantTypesResponse>;
776
+ getStoreDetailPaginator({ q, pageSize }?: {
777
+ q?: string;
778
+ pageSize?: number;
779
+ }): Paginator<CatalogPlatformModel.OptinStoreDetails>;
664
780
  /**
665
781
  * @param {CatalogPlatformValidator.GetVariantsOfProductsParam} arg - Arg object
666
782
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
667
783
  * @param {import("../PlatformAPIClient").Options} - Options
668
- * @returns {Promise<CatalogPlatformModel.ProductVariantsResponse>} - Success response
784
+ * @returns {Promise<CatalogPlatformModel.ProductVariantsResponseSchema>} -
785
+ * Success response
669
786
  * @name getVariantsOfProducts
670
- * @summary: Get variants of products.
787
+ * @summary: Get variants
671
788
  * @description: Retrieve variants of a specific product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getVariantsOfProducts/).
672
789
  */
673
- getVariantsOfProducts({ itemId, variantType, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetVariantsOfProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductVariantsResponse>;
790
+ getVariantsOfProducts({ itemId, variantType, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetVariantsOfProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductVariantsResponseSchema>;
791
+ /**
792
+ * @param {Object} arg - Arg object.
793
+ * @param {number} arg.itemId - Get list of variants of item Id
794
+ * @param {string} arg.variantType - Get multiple products filtered by variant type
795
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each
796
+ * page. Default is 10.
797
+ * @returns {Paginator<CatalogPlatformModel.ProductVariantsResponseSchema>}
798
+ * @summary: Get variants
799
+ * @description: Retrieve variants of a specific product.
800
+ */
801
+ getVariantsOfProductsPaginator({ itemId, variantType, pageSize }?: {
802
+ itemId: number;
803
+ variantType: string;
804
+ pageSize?: number;
805
+ }): Paginator<CatalogPlatformModel.ProductVariantsResponseSchema>;
674
806
  /**
675
807
  * @param {CatalogPlatformValidator.ListCategoriesParam} arg - Arg object
676
808
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
677
809
  * @param {import("../PlatformAPIClient").Options} - Options
678
- * @returns {Promise<CatalogPlatformModel.CategoryResponse>} - Success response
810
+ * @returns {Promise<CatalogPlatformModel.CategoryResponseSchema>} - Success response
679
811
  * @name listCategories
680
- * @summary: List categories.
681
- * @description: Retrieve a list of meta associated available product categories in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listCategories/).
682
- */
683
- listCategories({ level, department, q, pageNo, pageSize, uids, requestHeaders }?: CatalogPlatformValidator.ListCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryResponse>;
812
+ * @summary: List categories
813
+ * @description: Retrieve a list of categories data associated to a specific company and queries passed in the request. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listCategories/).
814
+ */
815
+ listCategories({ level, department, q, pageNo, pageSize, uids, slug, requestHeaders }?: CatalogPlatformValidator.ListCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryResponseSchema>;
816
+ /**
817
+ * @param {Object} arg - Arg object.
818
+ * @param {string} [arg.level] - Get category for multiple levels
819
+ * @param {number} [arg.department] - Get category for multiple departments filtered
820
+ * @param {string} [arg.q] - Get multiple categories filtered by search string
821
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each
822
+ * page. Default is 10.
823
+ * @param {number[]} [arg.uids] - Get multiple categories filtered by category uids.
824
+ * @param {string} [arg.slug] - Get category by slug
825
+ * @returns {Paginator<CatalogPlatformModel.CategoryResponseSchema>}
826
+ * @summary: List categories
827
+ * @description: Retrieve a list of categories data associated to a specific company and queries passed in the request.
828
+ */
829
+ listCategoriesPaginator({ level, department, q, pageSize, uids, slug }?: {
830
+ level?: string;
831
+ department?: number;
832
+ q?: string;
833
+ pageSize?: number;
834
+ uids?: number[];
835
+ slug?: string;
836
+ }): Paginator<CatalogPlatformModel.CategoryResponseSchema>;
684
837
  /**
685
838
  * @param {CatalogPlatformValidator.ListDepartmentsDataParam} arg - Arg object
686
839
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
687
840
  * @param {import("../PlatformAPIClient").Options} - Options
688
- * @returns {Promise<CatalogPlatformModel.DepartmentsResponse>} - Success response
841
+ * @returns {Promise<CatalogPlatformModel.DepartmentsResponseSchema>} -
842
+ * Success response
689
843
  * @name listDepartmentsData
690
- * @summary: List department data.
691
- * @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/).
692
- */
693
- listDepartmentsData({ pageNo, itemType, pageSize, name, search, isActive, uids, requestHeaders, }?: CatalogPlatformValidator.ListDepartmentsDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentsResponse>;
844
+ * @summary: List company department
845
+ * @description: Allows you to list all departments data for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listDepartmentsData/).
846
+ */
847
+ listDepartmentsData({ pageNo, itemType, pageSize, name, search, isActive, slug, requestHeaders, }?: CatalogPlatformValidator.ListDepartmentsDataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentsResponseSchema>;
848
+ /**
849
+ * @param {Object} arg - Arg object.
850
+ * @param {string} [arg.itemType] - A `item_type` is a type of product eg.
851
+ * set, standard, digital
852
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each
853
+ * page. Default is 10.
854
+ * @param {string} [arg.name] - Can search departments by passing name.
855
+ * @param {string} [arg.search] - Can search departments by passing name of
856
+ * the department in search parameter.
857
+ * @param {boolean} [arg.isActive] - Can query for departments based on
858
+ * whether they are active or inactive.
859
+ * @param {string} [arg.slug] - Can filter by slug
860
+ * @returns {Paginator<CatalogPlatformModel.DepartmentsResponseSchema>}
861
+ * @summary: List company department
862
+ * @description: Allows you to list all departments data for a specific company.
863
+ */
864
+ listDepartmentsDataPaginator({ itemType, pageSize, name, search, isActive, slug, }?: {
865
+ itemType?: string;
866
+ pageSize?: number;
867
+ name?: string;
868
+ search?: string;
869
+ isActive?: boolean;
870
+ slug?: string;
871
+ }): Paginator<CatalogPlatformModel.DepartmentsResponseSchema>;
694
872
  /**
695
873
  * @param {CatalogPlatformValidator.ListHSNCodesParam} arg - Arg object
696
874
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
697
875
  * @param {import("../PlatformAPIClient").Options} - Options
698
- * @returns {Promise<CatalogPlatformModel.HSNCodesResponse>} - Success response
876
+ * @returns {Promise<CatalogPlatformModel.HSNCodesResponseSchema>} - Success response
699
877
  * @name listHSNCodes
700
- * @summary: List HSN codes.
701
- * @description: Retrieve a list of Harmonized System Nomenclature (HSN) codes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listHSNCodes/).
878
+ * @summary: List HSN codes
879
+ * @description: Retrieve a list of Harmonized System Nomenclature (HSN) codes for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listHSNCodes/).
702
880
  */
703
- listHSNCodes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.HSNCodesResponse>;
881
+ listHSNCodes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.HSNCodesResponseSchema>;
704
882
  /**
705
883
  * @param {CatalogPlatformValidator.ListInventoryExportParam} arg - Arg object
706
884
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
707
885
  * @param {import("../PlatformAPIClient").Options} - Options
708
- * @returns {Promise<CatalogPlatformModel.InventoryExportJobListResponse>}
886
+ * @returns {Promise<CatalogPlatformModel.InventoryExportJobListResponseSchema>}
709
887
  * - Success response
710
888
  *
711
889
  * @name listInventoryExport
712
- * @summary: List inventory exports.
713
- * @description: Helps you the retrieve the history of inventory jobs depending on the filtered criteria. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listInventoryExport/).
890
+ * @summary: List inventory export jobs
891
+ * @description: Retrieve the history of inventory export jobs associated with the company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listInventoryExport/).
714
892
  */
715
- listInventoryExport({ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.ListInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportJobListResponse>;
893
+ listInventoryExport({ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.ListInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportJobListResponseSchema>;
716
894
  /**
717
895
  * @param {CatalogPlatformValidator.ListProductTemplateParam} arg - Arg object
718
896
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
719
897
  * @param {import("../PlatformAPIClient").Options} - Options
720
- * @returns {Promise<CatalogPlatformModel.TemplatesResponse>} - Success response
898
+ * @returns {Promise<CatalogPlatformModel.TemplatesResponseSchema>} - Success response
721
899
  * @name listProductTemplate
722
- * @summary: List product templates.
723
- * @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/).
900
+ * @summary: List product templates
901
+ * @description: Allows you to list all product templates for a specific company. also can filter by department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listProductTemplate/).
724
902
  */
725
- listProductTemplate({ department, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesResponse>;
903
+ listProductTemplate({ department, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesResponseSchema>;
726
904
  /**
727
905
  * @param {CatalogPlatformValidator.ListProductTemplateCategoriesParam} arg
728
906
  * - Arg object
729
907
  *
730
908
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
731
909
  * @param {import("../PlatformAPIClient").Options} - Options
732
- * @returns {Promise<CatalogPlatformModel.ProdcutTemplateCategoriesResponse>}
910
+ * @returns {Promise<CatalogPlatformModel.ProdcutTemplateCategoriesResponseSchema>}
733
911
  * - Success response
734
912
  *
735
913
  * @name listProductTemplateCategories
736
- * @summary: List product template categories.
737
- * @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/).
914
+ * @summary: List product template categories
915
+ * @description: Allows you to list all product template categories values for the departments specified for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listProductTemplateCategories/).
916
+ */
917
+ listProductTemplateCategories({ departments, itemType, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProdcutTemplateCategoriesResponseSchema>;
918
+ /**
919
+ * @param {CatalogPlatformValidator.ListProductTemplateExportDetailsParam} arg
920
+ * - Arg object
921
+ *
922
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
923
+ * @param {import("../PlatformAPIClient").Options} - Options
924
+ * @returns {Promise<CatalogPlatformModel.ProductDownloadsResponseSchema>}
925
+ * - Success response
926
+ *
927
+ * @name listProductTemplateExportDetails
928
+ * @summary: List export product templates
929
+ * @description: Retrieve export details related to product templates for a specific company. Can view details including trigger data, task id , etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listProductTemplateExportDetails/).
738
930
  */
739
- listProductTemplateCategories({ departments, itemType, pageSize, pageNo, q, requestHeaders }?: CatalogPlatformValidator.ListProductTemplateCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProdcutTemplateCategoriesResponse>;
931
+ listProductTemplateExportDetails({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponseSchema>;
740
932
  /**
741
933
  * @param {CatalogPlatformValidator.ListTemplateBrandTypeValuesParam} arg - Arg object
742
934
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -744,141 +936,151 @@ declare class Catalog {
744
936
  * @returns {Promise<CatalogPlatformModel.ProductConfigurationDownloads>} -
745
937
  * Success response
746
938
  * @name listTemplateBrandTypeValues
747
- * @summary: List template brand type values.
748
- * @description: Retrieve values related to template brand types. 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/).
939
+ * @summary: List template brand
940
+ * @description: Retrieve values related to template brand types for a specific company. The filter type query parameter defines what type of data to return. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listTemplateBrandTypeValues/).
749
941
  */
750
942
  listTemplateBrandTypeValues({ filter, templateTag, itemType, requestHeaders }?: CatalogPlatformValidator.ListTemplateBrandTypeValuesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductConfigurationDownloads>;
751
943
  /**
752
- * @param {CatalogPlatformValidator.PatchInventoryExportDetailParam} arg - Arg object
944
+ * @param {CatalogPlatformValidator.UpdateHsnCodeParam} arg - Arg object
753
945
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
754
946
  * @param {import("../PlatformAPIClient").Options} - Options
755
- * @returns {Promise<CatalogPlatformModel.EditInventoryDownloadsResponse>}
756
- * - Success response
757
- *
758
- * @name patchInventoryExportDetail
759
- * @summary: Edit notification_emails and status of export job.
760
- * @description: This API helps to edit notification_emails and status of export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/patchInventoryExportDetail/).
947
+ * @returns {Promise<CatalogPlatformModel.HsnCode>} - Success response
948
+ * @name updateHsnCode
949
+ * @summary: Update HSN code
950
+ * @description: Modify the HSN code associated with a product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateHsnCode/).
761
951
  */
762
- patchInventoryExportDetail({ jobId, body, requestHeaders }?: CatalogPlatformValidator.PatchInventoryExportDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.EditInventoryDownloadsResponse>;
952
+ updateHsnCode({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateHsnCodeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.HsnCode>;
763
953
  /**
764
- * @param {CatalogPlatformValidator.PatchProductExportDetailParam} arg - Arg object
954
+ * @param {CatalogPlatformValidator.UpdateInventoriesParam} arg - Arg object
765
955
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
766
956
  * @param {import("../PlatformAPIClient").Options} - Options
767
- * @returns {Promise<CatalogPlatformModel.PatchProductDownloadsResponse>} -
957
+ * @returns {Promise<CatalogPlatformModel.InventoryUpdateResponseSchema>} -
768
958
  * Success response
769
- * @name patchProductExportDetail
770
- * @summary: Edit notification_emails and status of export job.
771
- * @description: This API helps to edit notification_emails and status of export job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/patchProductExportDetail/).
772
- */
773
- patchProductExportDetail({ jobId, body, requestHeaders }?: CatalogPlatformValidator.PatchProductExportDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.PatchProductDownloadsResponse>;
774
- /**
775
- * @param {CatalogPlatformValidator.UpdateCategoryParam} arg - Arg object
776
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
777
- * @param {import("../PlatformAPIClient").Options} - Options
778
- * @returns {Promise<CatalogPlatformModel.CategoryUpdateResponse>} - Success response
779
- * @name updateCategory
780
- * @summary: Update category data.
781
- * @description: Modify data for an existing category in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateCategory/).
959
+ * @name updateInventories
960
+ * @summary: Update inventories
961
+ * @description: Allows to add Inventory for particular size and selling location. for associated companies - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateInventories/).
782
962
  */
783
- updateCategory({ uid, body, requestHeaders }?: CatalogPlatformValidator.UpdateCategoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryUpdateResponse>;
963
+ updateInventories({ body, requestHeaders }?: CatalogPlatformValidator.UpdateInventoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponseSchema>;
784
964
  /**
785
- * @param {CatalogPlatformValidator.UpdateDepartmentParam} arg - Arg object
965
+ * @param {CatalogPlatformValidator.UpdateLocationPriceParam} arg - Arg object
786
966
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
787
967
  * @param {import("../PlatformAPIClient").Options} - Options
788
- * @returns {Promise<CatalogPlatformModel.DepartmentModel>} - Success response
789
- * @name updateDepartment
790
- * @summary: Update department data.
791
- * @description: Modify the department by their uid using this API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateDepartment/).
968
+ * @returns {Promise<CatalogPlatformModel.LocationPriceQuantitySuccessResponseSchema>}
969
+ * - Success response
970
+ *
971
+ * @name updateLocationPrice
972
+ * @summary: Update an Article Price
973
+ * @description: enables you to update article price for a specific size and selling location (store). The price updates will be reflected instantly after the API call. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateLocationPrice/).
792
974
  */
793
- updateDepartment({ uid, body, requestHeaders }?: CatalogPlatformValidator.UpdateDepartmentParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentModel>;
975
+ updateLocationPrice({ storeId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.UpdateLocationPriceParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.LocationPriceQuantitySuccessResponseSchema>;
794
976
  /**
795
- * @param {CatalogPlatformValidator.UpdateInventoriesParam} arg - Arg object
977
+ * @param {CatalogPlatformValidator.UpdateLocationQuantityParam} arg - Arg object
796
978
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
797
979
  * @param {import("../PlatformAPIClient").Options} - Options
798
- * @returns {Promise<CatalogPlatformModel.InventoryUpdateResponse>} - Success response
799
- * @name updateInventories
800
- * @summary: Update inventories.
801
- * @description: Allows to add Inventory for particular size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateInventories/).
980
+ * @returns {Promise<CatalogPlatformModel.LocationPriceQuantitySuccessResponseSchema>}
981
+ * - Success response
982
+ *
983
+ * @name updateLocationQuantity
984
+ * @summary: Update an Article Quantity
985
+ * @description: enables you to update article quantity for a specific size and selling location (store). The quantity updates will be reflected instantly after the API call. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateLocationQuantity/).
802
986
  */
803
- updateInventories({ body, requestHeaders }?: CatalogPlatformValidator.UpdateInventoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponse>;
987
+ updateLocationQuantity({ storeId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.UpdateLocationQuantityParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.LocationPriceQuantitySuccessResponseSchema>;
804
988
  /**
805
989
  * @param {CatalogPlatformValidator.UpdateMarketplaceOptinParam} arg - Arg object
806
990
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
807
991
  * @param {import("../PlatformAPIClient").Options} - Options
808
- * @returns {Promise<CatalogPlatformModel.UpdateMarketplaceOptinResponse>}
992
+ * @returns {Promise<CatalogPlatformModel.UpdateMarketplaceOptinResponseSchema>}
809
993
  * - Success response
810
994
  *
811
995
  * @name updateMarketplaceOptin
812
996
  * @summary: Update marketplace optin
813
- * @description: This API allows to update marketplace optin for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateMarketplaceOptin/).
997
+ * @description: Allows to update marketplace optin for a company by marketplace_slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateMarketplaceOptin/).
814
998
  */
815
- updateMarketplaceOptin({ marketplace, body, requestHeaders }?: CatalogPlatformValidator.UpdateMarketplaceOptinParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.UpdateMarketplaceOptinResponse>;
999
+ updateMarketplaceOptin({ marketplaceSlug, body, requestHeaders }?: CatalogPlatformValidator.UpdateMarketplaceOptinParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.UpdateMarketplaceOptinResponseSchema>;
816
1000
  /**
817
1001
  * @param {CatalogPlatformValidator.UpdateProductBundleParam} arg - Arg object
818
1002
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
819
1003
  * @param {import("../PlatformAPIClient").Options} - Options
820
- * @returns {Promise<CatalogPlatformModel.GetProductBundleCreateResponse>}
1004
+ * @returns {Promise<CatalogPlatformModel.GetProductBundleCreateResponseSchema>}
821
1005
  * - Success response
822
1006
  *
823
1007
  * @name updateProductBundle
824
- * @summary: Update a product bundle.
825
- * @description: Modify the details of an existing product bundle. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateProductBundle/).
1008
+ * @summary: Update product bundle
1009
+ * @description: Modify the details of an existing product bundle in the catalog associated to a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateProductBundle/).
826
1010
  */
827
- updateProductBundle({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleCreateResponse>;
1011
+ updateProductBundle({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateProductBundleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetProductBundleCreateResponseSchema>;
828
1012
  /**
829
1013
  * @param {CatalogPlatformValidator.UpdateRealtimeInventoryParam} arg - Arg object
830
1014
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
831
1015
  * @param {import("../PlatformAPIClient").Options} - Options
832
- * @returns {Promise<CatalogPlatformModel.InventoryUpdateResponse>} - Success response
1016
+ * @returns {Promise<CatalogPlatformModel.InventoryUpdateResponseSchema>} -
1017
+ * Success response
833
1018
  * @name updateRealtimeInventory
834
- * @summary: Update realtime inventory.
835
- * @description: Allows to add Inventory for particular size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateRealtimeInventory/).
1019
+ * @summary: Update an inventory
1020
+ * @description: enables you to add inventory for a specific size and selling location (store). The inventory updates will be reflected instantly after the API call. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateRealtimeInventory/).
836
1021
  */
837
- updateRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.UpdateRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponse>;
1022
+ updateRealtimeInventory({ itemId, sellerIdentifier, body, requestHeaders }?: CatalogPlatformValidator.UpdateRealtimeInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponseSchema>;
838
1023
  /**
839
1024
  * @param {CatalogPlatformValidator.UpdateSizeGuideParam} arg - Arg object
840
1025
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
841
1026
  * @param {import("../PlatformAPIClient").Options} - Options
842
- * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
1027
+ * @returns {Promise<CatalogPlatformModel.SuccessResponseSchema>} - Success response
843
1028
  * @name updateSizeGuide
844
- * @summary: Update a size guide.
845
- * @description: Allows to edit a size guide. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateSizeGuide/).
1029
+ * @summary: Update size guide
1030
+ * @description: Allows to edit a specific size guide. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateSizeGuide/).
846
1031
  */
847
- updateSizeGuide({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
1032
+ updateSizeGuide({ id, body, requestHeaders }?: CatalogPlatformValidator.UpdateSizeGuideParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponseSchema>;
848
1033
  /**
849
1034
  * @param {CatalogPlatformValidator.UploadBulkProductsParam} arg - Arg object
850
1035
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
851
1036
  * @param {import("../PlatformAPIClient").Options} - Options
852
- * @returns {Promise<CatalogPlatformModel.ProductBulkResponse>} - Success response
1037
+ * @returns {Promise<CatalogPlatformModel.BulkResponseSchema>} - Success response
853
1038
  * @name uploadBulkProducts
854
- * @summary: Upload bulk products.
855
- * @description: Helps to create a bulk products upload job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/uploadBulkProducts/).
1039
+ * @summary: Upload bulk products
1040
+ * @description: Users can create multiple products by providing the required information needed for product creation in a CSV or Excel file format. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/uploadBulkProducts/).
1041
+ */
1042
+ uploadBulkProducts({ department, productType, body, requestHeaders }?: CatalogPlatformValidator.UploadBulkProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BulkResponseSchema>;
1043
+ /**
1044
+ * @param {CatalogPlatformValidator.ValidateProductGlobalTemplateParam} arg
1045
+ * - Arg object
1046
+ *
1047
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1048
+ * @param {import("../PlatformAPIClient").Options} - Options
1049
+ * @returns {Promise<CatalogPlatformModel.TemplatesGlobalValidationResponseSchema>}
1050
+ * - Success response
1051
+ *
1052
+ * @name validateProductGlobalTemplate
1053
+ * @summary: Validate product template
1054
+ * @description: Allows you to list all product templates global validation values for all the fields present in the database for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/validateProductGlobalTemplate/).
856
1055
  */
857
- uploadBulkProducts({ department, productType, body, requestHeaders }?: CatalogPlatformValidator.UploadBulkProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductBulkResponse>;
1056
+ validateProductGlobalTemplate({ itemType, bulk, requestHeaders }?: CatalogPlatformValidator.ValidateProductGlobalTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesGlobalValidationResponseSchema>;
858
1057
  /**
859
1058
  * @param {CatalogPlatformValidator.ValidateProductTemplateParam} arg - Arg object
860
1059
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
861
1060
  * @param {import("../PlatformAPIClient").Options} - Options
862
- * @returns {Promise<CatalogPlatformModel.TemplatesValidationResponse>} -
863
- * Success response
1061
+ * @returns {Promise<CatalogPlatformModel.TemplatesValidationResponseSchema>}
1062
+ * - Success response
1063
+ *
864
1064
  * @name validateProductTemplate
865
- * @summary: Validate product template.
866
- * @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/).
1065
+ * @summary: Validate product template
1066
+ * @description: Allows you to list all product templates validation values by its slug for all the fields present in the database for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/validateProductTemplate/).
867
1067
  */
868
- validateProductTemplate({ slug, itemType, bulk, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesValidationResponse>;
1068
+ validateProductTemplate({ slug, itemType, bulk, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.TemplatesValidationResponseSchema>;
869
1069
  /**
870
1070
  * @param {CatalogPlatformValidator.ValidateProductTemplateSchemaParam} arg
871
1071
  * - Arg object
872
1072
  *
873
1073
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
874
1074
  * @param {import("../PlatformAPIClient").Options} - Options
875
- * @returns {Promise<CatalogPlatformModel.InventoryValidationResponse>} -
876
- * Success response
1075
+ * @returns {Promise<CatalogPlatformModel.InventoryValidationResponseSchema>}
1076
+ * - Success response
1077
+ *
877
1078
  * @name validateProductTemplateSchema
878
- * @summary: Validate product template schema.
879
- * @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/).
1079
+ * @summary: Validate product template schema
1080
+ * @description: Allows you to list all product templates validation values for all the fields present in the database for a specific company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/validateProductTemplateSchema/).
880
1081
  */
881
- validateProductTemplateSchema({ itemType, bulk, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateSchemaParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryValidationResponse>;
1082
+ validateProductTemplateSchema({ itemType, requestHeaders }?: CatalogPlatformValidator.ValidateProductTemplateSchemaParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryValidationResponseSchema>;
882
1083
  }
883
1084
  import CatalogPlatformValidator = require("./CatalogPlatformValidator");
884
1085
  import CatalogPlatformModel = require("./CatalogPlatformModel");
1086
+ import Paginator = require("../../common/Paginator");