@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (321) hide show
  1. package/README.md +12 -0
  2. package/index.js +0 -3
  3. package/package.json +1 -1
  4. package/sdk/application/ApplicationAPIClient.d.ts +15 -1
  5. package/sdk/application/ApplicationAPIClient.js +8 -1
  6. package/sdk/application/ApplicationClient.d.ts +37 -6
  7. package/sdk/application/ApplicationClient.js +31 -0
  8. package/sdk/application/ApplicationConfig.d.ts +52 -12
  9. package/sdk/application/ApplicationConfig.js +37 -2
  10. package/sdk/application/ApplicationModels.d.ts +46 -1
  11. package/sdk/application/ApplicationModels.js +18 -0
  12. package/sdk/application/Cart/CartApplicationClient.d.ts +172 -357
  13. package/sdk/application/Cart/CartApplicationClient.js +620 -483
  14. package/sdk/application/Cart/CartApplicationModel.d.ts +2054 -96
  15. package/sdk/application/Cart/CartApplicationModel.js +1224 -93
  16. package/sdk/application/Cart/CartApplicationValidator.d.ts +508 -30
  17. package/sdk/application/Cart/CartApplicationValidator.js +270 -15
  18. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +234 -413
  19. package/sdk/application/Catalog/CatalogApplicationClient.js +777 -630
  20. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2218 -117
  21. package/sdk/application/Catalog/CatalogApplicationModel.js +1499 -170
  22. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +798 -31
  23. package/sdk/application/Catalog/CatalogApplicationValidator.js +318 -3
  24. package/sdk/application/Common/CommonApplicationClient.d.ts +14 -21
  25. package/sdk/application/Common/CommonApplicationClient.js +50 -33
  26. package/sdk/application/Common/CommonApplicationModel.d.ts +448 -19
  27. package/sdk/application/Common/CommonApplicationModel.js +224 -16
  28. package/sdk/application/Common/CommonApplicationValidator.d.ts +42 -4
  29. package/sdk/application/Common/CommonApplicationValidator.js +21 -3
  30. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +25 -18
  31. package/sdk/application/Communication/CommunicationApplicationClient.js +74 -47
  32. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +190 -14
  33. package/sdk/application/Communication/CommunicationApplicationModel.js +124 -7
  34. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +27 -4
  35. package/sdk/application/Communication/CommunicationApplicationValidator.js +21 -5
  36. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +113 -112
  37. package/sdk/application/Configuration/ConfigurationApplicationClient.js +381 -260
  38. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +2453 -110
  39. package/sdk/application/Configuration/ConfigurationApplicationModel.js +1254 -108
  40. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +160 -8
  41. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +88 -4
  42. package/sdk/application/Content/ContentApplicationClient.d.ts +120 -138
  43. package/sdk/application/Content/ContentApplicationClient.js +409 -277
  44. package/sdk/application/Content/ContentApplicationModel.d.ts +1627 -105
  45. package/sdk/application/Content/ContentApplicationModel.js +1202 -109
  46. package/sdk/application/Content/ContentApplicationValidator.d.ts +214 -12
  47. package/sdk/application/Content/ContentApplicationValidator.js +113 -3
  48. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +20 -29
  49. package/sdk/application/FileStorage/FileStorageApplicationClient.js +68 -47
  50. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +299 -20
  51. package/sdk/application/FileStorage/FileStorageApplicationModel.js +209 -16
  52. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +55 -5
  53. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +33 -6
  54. package/sdk/application/Lead/LeadApplicationClient.d.ts +50 -53
  55. package/sdk/application/Lead/LeadApplicationClient.js +169 -103
  56. package/sdk/application/Lead/LeadApplicationModel.d.ts +1405 -54
  57. package/sdk/application/Lead/LeadApplicationModel.js +619 -73
  58. package/sdk/application/Lead/LeadApplicationValidator.d.ts +91 -9
  59. package/sdk/application/Lead/LeadApplicationValidator.js +51 -6
  60. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +34 -33
  61. package/sdk/application/Logistic/LogisticApplicationClient.js +110 -73
  62. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +399 -28
  63. package/sdk/application/Logistic/LogisticApplicationModel.js +293 -24
  64. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +48 -6
  65. package/sdk/application/Logistic/LogisticApplicationValidator.js +34 -6
  66. package/sdk/application/Order/OrderApplicationClient.d.ts +81 -133
  67. package/sdk/application/Order/OrderApplicationClient.js +297 -217
  68. package/sdk/application/Order/OrderApplicationModel.d.ts +1101 -66
  69. package/sdk/application/Order/OrderApplicationModel.js +776 -57
  70. package/sdk/application/Order/OrderApplicationValidator.d.ts +249 -14
  71. package/sdk/application/Order/OrderApplicationValidator.js +114 -5
  72. package/sdk/application/Payment/PaymentApplicationClient.d.ts +341 -356
  73. package/sdk/application/Payment/PaymentApplicationClient.js +1077 -703
  74. package/sdk/application/Payment/PaymentApplicationModel.d.ts +3125 -99
  75. package/sdk/application/Payment/PaymentApplicationModel.js +1158 -62
  76. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +494 -41
  77. package/sdk/application/Payment/PaymentApplicationValidator.js +297 -25
  78. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +178 -350
  79. package/sdk/application/PosCart/PosCartApplicationClient.js +636 -491
  80. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1823 -89
  81. package/sdk/application/PosCart/PosCartApplicationModel.js +1117 -85
  82. package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +480 -29
  83. package/sdk/application/PosCart/PosCartApplicationValidator.js +262 -15
  84. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +49 -47
  85. package/sdk/application/Rewards/RewardsApplicationClient.js +160 -102
  86. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +343 -22
  87. package/sdk/application/Rewards/RewardsApplicationModel.js +230 -15
  88. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +70 -7
  89. package/sdk/application/Rewards/RewardsApplicationValidator.js +45 -6
  90. package/sdk/application/Share/ShareApplicationClient.d.ts +44 -50
  91. package/sdk/application/Share/ShareApplicationClient.js +165 -97
  92. package/sdk/application/Share/ShareApplicationModel.d.ts +230 -15
  93. package/sdk/application/Share/ShareApplicationModel.js +154 -16
  94. package/sdk/application/Share/ShareApplicationValidator.d.ts +86 -8
  95. package/sdk/application/Share/ShareApplicationValidator.js +48 -4
  96. package/sdk/application/Theme/ThemeApplicationClient.d.ts +25 -27
  97. package/sdk/application/Theme/ThemeApplicationClient.js +83 -54
  98. package/sdk/application/Theme/ThemeApplicationModel.d.ts +621 -48
  99. package/sdk/application/Theme/ThemeApplicationModel.js +464 -40
  100. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +49 -5
  101. package/sdk/application/Theme/ThemeApplicationValidator.js +26 -3
  102. package/sdk/application/User/UserApplicationClient.d.ts +219 -303
  103. package/sdk/application/User/UserApplicationClient.js +819 -522
  104. package/sdk/application/User/UserApplicationModel.d.ts +1390 -101
  105. package/sdk/application/User/UserApplicationModel.js +983 -44
  106. package/sdk/application/User/UserApplicationValidator.d.ts +457 -33
  107. package/sdk/application/User/UserApplicationValidator.js +265 -31
  108. package/sdk/common/AxiosHelper.js +8 -2
  109. package/sdk/common/Paginator.d.ts +27 -12
  110. package/sdk/common/Paginator.js +15 -0
  111. package/sdk/common/RequestSigner.js +0 -1
  112. package/sdk/partner/PartnerAPIClient.d.ts +15 -1
  113. package/sdk/partner/PartnerAPIClient.js +8 -1
  114. package/sdk/partner/PartnerClient.d.ts +20 -3
  115. package/sdk/partner/PartnerClient.js +17 -0
  116. package/sdk/partner/PartnerConfig.d.ts +40 -14
  117. package/sdk/partner/PartnerConfig.js +31 -6
  118. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +26 -25
  119. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +82 -53
  120. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +202 -17
  121. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +139 -10
  122. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +42 -5
  123. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +26 -4
  124. package/sdk/platform/Billing/BillingPlatformClient.d.ts +88 -97
  125. package/sdk/platform/Billing/BillingPlatformClient.js +310 -191
  126. package/sdk/platform/Billing/BillingPlatformModel.d.ts +1211 -68
  127. package/sdk/platform/Billing/BillingPlatformModel.js +824 -59
  128. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +153 -12
  129. package/sdk/platform/Billing/BillingPlatformValidator.js +87 -8
  130. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +392 -634
  131. package/sdk/platform/Cart/CartPlatformApplicationClient.js +1480 -957
  132. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +827 -57
  133. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +492 -34
  134. package/sdk/platform/Cart/CartPlatformModel.d.ts +3639 -175
  135. package/sdk/platform/Cart/CartPlatformModel.js +2368 -212
  136. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +438 -615
  137. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1449 -984
  138. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1081 -49
  139. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +482 -23
  140. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +573 -824
  141. package/sdk/platform/Catalog/CatalogPlatformClient.js +1773 -1264
  142. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6871 -326
  143. package/sdk/platform/Catalog/CatalogPlatformModel.js +4215 -349
  144. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1331 -71
  145. package/sdk/platform/Catalog/CatalogPlatformValidator.js +611 -30
  146. package/sdk/platform/Common/CommonPlatformClient.d.ts +14 -21
  147. package/sdk/platform/Common/CommonPlatformClient.js +48 -33
  148. package/sdk/platform/Common/CommonPlatformModel.d.ts +448 -19
  149. package/sdk/platform/Common/CommonPlatformModel.js +224 -16
  150. package/sdk/platform/Common/CommonPlatformValidator.d.ts +42 -4
  151. package/sdk/platform/Common/CommonPlatformValidator.js +21 -3
  152. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +457 -279
  153. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +1423 -553
  154. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +581 -42
  155. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +294 -22
  156. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +18 -5
  157. package/sdk/platform/Communication/CommunicationPlatformClient.js +58 -19
  158. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1630 -102
  159. package/sdk/platform/Communication/CommunicationPlatformModel.js +1150 -85
  160. package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +16 -3
  161. package/sdk/platform/Communication/CommunicationPlatformValidator.js +11 -3
  162. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +102 -111
  163. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +321 -225
  164. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +830 -43
  165. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +612 -78
  166. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +180 -13
  167. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +98 -10
  168. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +232 -212
  169. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +737 -438
  170. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +293 -22
  171. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +184 -17
  172. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +166 -178
  173. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +519 -310
  174. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +4504 -188
  175. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2242 -204
  176. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +332 -19
  177. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +153 -10
  178. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +495 -560
  179. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1777 -987
  180. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +872 -62
  181. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +487 -35
  182. package/sdk/platform/Content/ContentPlatformModel.d.ts +1661 -108
  183. package/sdk/platform/Content/ContentPlatformModel.js +1217 -113
  184. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +67 -101
  185. package/sdk/platform/Discount/DiscountPlatformClient.js +240 -176
  186. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +242 -15
  187. package/sdk/platform/Discount/DiscountPlatformModel.js +162 -10
  188. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +185 -13
  189. package/sdk/platform/Discount/DiscountPlatformValidator.js +88 -8
  190. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +32 -41
  191. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +106 -74
  192. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +77 -6
  193. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +41 -6
  194. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +39 -54
  195. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +124 -99
  196. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +299 -20
  197. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +207 -16
  198. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +98 -8
  199. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +54 -7
  200. package/sdk/platform/Finance/FinancePlatformClient.d.ts +85 -91
  201. package/sdk/platform/Finance/FinancePlatformClient.js +272 -180
  202. package/sdk/platform/Finance/FinancePlatformModel.d.ts +619 -50
  203. package/sdk/platform/Finance/FinancePlatformModel.js +458 -30
  204. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +123 -15
  205. package/sdk/platform/Finance/FinancePlatformValidator.js +95 -16
  206. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +99 -97
  207. package/sdk/platform/Inventory/InventoryPlatformClient.js +288 -199
  208. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +1354 -61
  209. package/sdk/platform/Inventory/InventoryPlatformModel.js +916 -83
  210. package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +168 -12
  211. package/sdk/platform/Inventory/InventoryPlatformValidator.js +82 -6
  212. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +86 -106
  213. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +326 -186
  214. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +180 -14
  215. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +94 -9
  216. package/sdk/platform/Lead/LeadPlatformClient.d.ts +75 -101
  217. package/sdk/platform/Lead/LeadPlatformClient.js +240 -174
  218. package/sdk/platform/Lead/LeadPlatformModel.d.ts +1403 -54
  219. package/sdk/platform/Lead/LeadPlatformModel.js +618 -73
  220. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +173 -12
  221. package/sdk/platform/Lead/LeadPlatformValidator.js +85 -8
  222. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +18 -14
  223. package/sdk/platform/Order/OrderPlatformApplicationClient.js +56 -29
  224. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +26 -4
  225. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +16 -3
  226. package/sdk/platform/Order/OrderPlatformClient.d.ts +343 -556
  227. package/sdk/platform/Order/OrderPlatformClient.js +969 -762
  228. package/sdk/platform/Order/OrderPlatformModel.d.ts +4967 -247
  229. package/sdk/platform/Order/OrderPlatformModel.js +3249 -259
  230. package/sdk/platform/Order/OrderPlatformValidator.d.ts +758 -37
  231. package/sdk/platform/Order/OrderPlatformValidator.js +351 -22
  232. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +28 -36
  233. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +103 -59
  234. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +66 -6
  235. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +32 -4
  236. package/sdk/platform/Partner/PartnerPlatformClient.d.ts +68 -107
  237. package/sdk/platform/Partner/PartnerPlatformClient.js +253 -174
  238. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +767 -45
  239. package/sdk/platform/Partner/PartnerPlatformModel.js +524 -41
  240. package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +207 -13
  241. package/sdk/platform/Partner/PartnerPlatformValidator.js +87 -5
  242. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +255 -260
  243. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +860 -504
  244. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +348 -30
  245. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +221 -19
  246. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +73 -73
  247. package/sdk/platform/Payment/PaymentPlatformClient.js +238 -154
  248. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2658 -93
  249. package/sdk/platform/Payment/PaymentPlatformModel.js +1035 -36
  250. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +111 -11
  251. package/sdk/platform/Payment/PaymentPlatformValidator.js +68 -7
  252. package/sdk/platform/PlatformAPIClient.d.ts +16 -1
  253. package/sdk/platform/PlatformAPIClient.js +9 -1
  254. package/sdk/platform/PlatformApplicationClient.d.ts +22 -1798
  255. package/sdk/platform/PlatformApplicationClient.js +17 -1899
  256. package/sdk/platform/PlatformClient.d.ts +29 -12579
  257. package/sdk/platform/PlatformClient.js +26 -15085
  258. package/sdk/platform/PlatformConfig.d.ts +37 -11
  259. package/sdk/platform/PlatformConfig.js +32 -6
  260. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +80 -92
  261. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +307 -177
  262. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +149 -12
  263. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +82 -8
  264. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +371 -23
  265. package/sdk/platform/Rewards/RewardsPlatformModel.js +246 -16
  266. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +120 -89
  267. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +349 -201
  268. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +128 -12
  269. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +85 -11
  270. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +148 -178
  271. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +454 -329
  272. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1399 -96
  273. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1022 -71
  274. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +280 -18
  275. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +134 -11
  276. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +38 -47
  277. package/sdk/platform/Share/SharePlatformApplicationClient.js +137 -73
  278. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +87 -7
  279. package/sdk/platform/Share/SharePlatformApplicationValidator.js +42 -5
  280. package/sdk/platform/Share/SharePlatformModel.d.ts +250 -16
  281. package/sdk/platform/Share/SharePlatformModel.js +165 -17
  282. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +149 -183
  283. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +579 -330
  284. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +308 -24
  285. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +162 -10
  286. package/sdk/platform/Theme/ThemePlatformModel.d.ts +621 -48
  287. package/sdk/platform/Theme/ThemePlatformModel.js +464 -40
  288. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +119 -151
  289. package/sdk/platform/User/UserPlatformApplicationClient.js +411 -244
  290. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +235 -18
  291. package/sdk/platform/User/UserPlatformApplicationValidator.js +126 -12
  292. package/sdk/platform/User/UserPlatformModel.d.ts +1390 -101
  293. package/sdk/platform/User/UserPlatformModel.js +983 -44
  294. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +38 -47
  295. package/sdk/platform/Webhook/WebhookPlatformClient.js +137 -87
  296. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +242 -16
  297. package/sdk/platform/Webhook/WebhookPlatformModel.js +167 -18
  298. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +83 -7
  299. package/sdk/platform/Webhook/WebhookPlatformValidator.js +43 -5
  300. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -21
  301. package/sdk/public/Configuration/ConfigurationPublicClient.js +46 -33
  302. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +473 -19
  303. package/sdk/public/Configuration/ConfigurationPublicModel.js +224 -16
  304. package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +42 -4
  305. package/sdk/public/Configuration/ConfigurationPublicValidator.js +21 -3
  306. package/sdk/public/Inventory/InventoryPublicClient.d.ts +48 -48
  307. package/sdk/public/Inventory/InventoryPublicClient.js +146 -98
  308. package/sdk/public/Inventory/InventoryPublicModel.d.ts +392 -21
  309. package/sdk/public/Inventory/InventoryPublicModel.js +267 -27
  310. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +90 -8
  311. package/sdk/public/Inventory/InventoryPublicValidator.js +44 -4
  312. package/sdk/public/PublicClient.d.ts +19 -3
  313. package/sdk/public/PublicClient.js +16 -0
  314. package/sdk/public/PublicConfig.d.ts +27 -6
  315. package/sdk/public/PublicConfig.js +17 -1
  316. package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -11
  317. package/sdk/public/Webhook/WebhookPublicClient.js +42 -27
  318. package/sdk/public/Webhook/WebhookPublicModel.d.ts +242 -16
  319. package/sdk/public/Webhook/WebhookPublicModel.js +167 -18
  320. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +18 -3
  321. package/sdk/public/Webhook/WebhookPublicValidator.js +14 -4
@@ -1,80 +1,1340 @@
1
- export = CatalogValidator;
2
- declare class CatalogValidator {
3
- static addInventory(): any;
4
- static allSizes(): any;
5
- static bulkHsnCode(): any;
6
- static createBulkInventory(): any;
7
- static createBulkInventoryJob(): any;
8
- static createBulkProductUploadJob(): any;
9
- static createCategories(): any;
10
- static createDepartments(): any;
11
- static createInventoryExport(): any;
12
- static createInventoryExportJob(): any;
13
- static createMarketplaceOptin(): any;
14
- static createProduct(): any;
15
- static createProductAssetsInBulk(): any;
16
- static createProductBundle(): any;
17
- static createProductExportJob(): any;
18
- static createProductsInBulk(): any;
19
- static createSizeGuide(): any;
20
- static deleteBulkInventoryJob(): any;
21
- static deleteInventory(): any;
22
- static deleteProduct(): any;
23
- static deleteProductBulkJob(): any;
24
- static deleteRealtimeInventory(): any;
25
- static deleteSize(): any;
26
- static downloadInventoryTemplateView(): any;
27
- static downloadProductTemplateViews(): any;
28
- static editProduct(): any;
29
- static exportInventoryConfig(): any;
30
- static getAllProductHsnCodes(): any;
31
- static getCategoryData(): any;
32
- static getCompanyBrandDetail(): any;
1
+ export = CatalogPlatformValidator;
2
+ /**
3
+ * @typedef AddInventoryParam
4
+ * @property {number} itemId - Item code of the product of which size is to be get.
5
+ * @property {string} size - Size in which inventory is to be added.
6
+ * @property {CatalogPlatformModel.InventoryRequest} body
7
+ */
8
+ /**
9
+ * @typedef AllSizesParam
10
+ * @property {number} itemId - Id of the product to be updated.
11
+ */
12
+ /**
13
+ * @typedef BulkHsnCodeParam
14
+ * @property {CatalogPlatformModel.BulkHsnUpsert} body
15
+ */
16
+ /**
17
+ * @typedef CreateBulkInventoryParam
18
+ * @property {string} batchId - Batch Id of the bulk create job.
19
+ * @property {CatalogPlatformModel.InventoryBulkRequest} body
20
+ */
21
+ /**
22
+ * @typedef CreateBulkInventoryJobParam
23
+ * @property {CatalogPlatformModel.BulkJob} body
24
+ */
25
+ /**
26
+ * @typedef CreateBulkProductUploadJobParam
27
+ * @property {CatalogPlatformModel.BulkJob} body
28
+ */
29
+ /**
30
+ * @typedef CreateCategoriesParam
31
+ * @property {CatalogPlatformModel.CategoryRequestBody} body
32
+ */
33
+ /**
34
+ * @typedef CreateDepartmentsParam
35
+ * @property {CatalogPlatformModel.DepartmentCreateUpdate} body
36
+ */
37
+ /**
38
+ * @typedef CreateInventoryExportParam
39
+ * @property {CatalogPlatformModel.InventoryCreateRequest} body
40
+ */
41
+ /**
42
+ * @typedef CreateInventoryExportJobParam
43
+ * @property {CatalogPlatformModel.InventoryExportRequest} body
44
+ */
45
+ /**
46
+ * @typedef CreateMarketplaceOptinParam
47
+ * @property {string} marketplace - The marketplace for which the detail needs
48
+ * to be retrieved.
49
+ * @property {CatalogPlatformModel.OptInPostRequest} body
50
+ */
51
+ /**
52
+ * @typedef CreateProductParam
53
+ * @property {CatalogPlatformModel.ProductCreateUpdateSchemaV2} body
54
+ */
55
+ /**
56
+ * @typedef CreateProductAssetsInBulkParam
57
+ * @property {CatalogPlatformModel.ProductBulkAssets} body
58
+ */
59
+ /**
60
+ * @typedef CreateProductBundleParam
61
+ * @property {CatalogPlatformModel.ProductBundleRequest} body
62
+ */
63
+ /**
64
+ * @typedef CreateProductExportJobParam
65
+ * @property {CatalogPlatformModel.ProductTemplateDownloadsExport} body
66
+ */
67
+ /**
68
+ * @typedef CreateProductsInBulkParam
69
+ * @property {string} batchId - Batch Id in which assets to be uploaded.
70
+ * @property {CatalogPlatformModel.BulkProductRequest} body
71
+ */
72
+ /**
73
+ * @typedef CreateSizeGuideParam
74
+ * @property {CatalogPlatformModel.ValidateSizeGuide} body
75
+ */
76
+ /**
77
+ * @typedef DeleteBulkInventoryJobParam
78
+ * @property {string} batchId - Batch Id of the bulk delete job.
79
+ */
80
+ /**
81
+ * @typedef DeleteInventoryParam
82
+ * @property {string} size - Size that is to be deleted.
83
+ * @property {number} itemId - Id of the product associated with Inventory to be deleted.
84
+ * @property {number} locationId - Location ID of store of which inventory is to
85
+ * be deleted.
86
+ */
87
+ /**
88
+ * @typedef DeleteProductParam
89
+ * @property {number} itemId - Id of the product to be updated.
90
+ */
91
+ /**
92
+ * @typedef DeleteProductBulkJobParam
93
+ * @property {number} batchId - Batch Id of the bulk product job to be deleted.
94
+ */
95
+ /**
96
+ * @typedef DeleteRealtimeInventoryParam
97
+ * @property {number} itemId - Item code of the product of which size is to be get.
98
+ * @property {string} sellerIdentifier - Size Identifier (Seller Identifier or
99
+ * Primary Identifier) of which inventory is to get.
100
+ * @property {CatalogPlatformModel.InventoryRequestSchemaV2} body
101
+ */
102
+ /**
103
+ * @typedef DeleteSizeParam
104
+ * @property {number} itemId - Item Id of the product associated with size to be deleted.
105
+ * @property {string} size - Size to be deleted.
106
+ */
107
+ /**
108
+ * @typedef DownloadInventoryTemplateViewParam
109
+ * @property {string} itemType - An `item_type` defines the type of item.
110
+ */
111
+ /**
112
+ * @typedef DownloadProductTemplateViewsParam
113
+ * @property {string} slug - A `slug` is a unique identifier for a particular template.
114
+ */
115
+ /**
116
+ * @typedef EditProductParam
117
+ * @property {number} itemId - Id of the product to be updated.
118
+ * @property {CatalogPlatformModel.ProductCreateUpdateSchemaV2} body
119
+ */
120
+ /**
121
+ * @typedef ExportInventoryConfigParam
122
+ * @property {string} [filterType] - Filter type from any one of ['brand',
123
+ * 'store', 'type']
124
+ */
125
+ /**
126
+ * @typedef GetAllProductHsnCodesParam
127
+ * @property {number} [pageNo] - Page no
128
+ * @property {number} [pageSize] - Page size
129
+ * @property {string} [q] - Search using hsn code, description, reporting_hsn
130
+ * @property {string} [type] - Search using type
131
+ */
132
+ /**
133
+ * @typedef GetCategoryDataParam
134
+ * @property {string} uid - Category unique id
135
+ */
136
+ /**
137
+ * @typedef GetCompanyBrandDetailParam
138
+ * @property {boolean} [isActive] - The is_active status for the optin id.
139
+ * @property {string} [q] - The search value to filter the list.
140
+ * @property {number} [pageNo] - The number of page for the company id.
141
+ * @property {number} [pageSize] - Number of records that can be seen on the
142
+ * page for the company id.
143
+ * @property {string} [marketplace] - The marketplace platform associated with
144
+ * the company id.
145
+ */
146
+ /** @typedef GetCompanyDetailParam */
147
+ /** @typedef GetCompanyMetricsParam */
148
+ /**
149
+ * @typedef GetDepartmentDataParam
150
+ * @property {string} uid - A `uid` is a unique identifier of a department.
151
+ */
152
+ /**
153
+ * @typedef GetGenderAttributeParam
154
+ * @property {string} attributeSlug - Slug of the attribute for which you want
155
+ * to view the genders
156
+ */
157
+ /**
158
+ * @typedef GetHsnCodeParam
159
+ * @property {string} id - Unique id
160
+ */
161
+ /**
162
+ * @typedef GetInventoriesParam
163
+ * @property {string} [itemId] - Item code of the product of which size is to be get.
164
+ * @property {string} [size] - Size of which inventory is to get.
165
+ * @property {number} [pageNo] - The page number to navigate through the given
166
+ * set of results
167
+ * @property {number} [pageSize] - Number of items to retrieve in each page.
168
+ * Default is 12.
169
+ * @property {string} [q] - Search with help of store code.
170
+ * @property {boolean} [sellable] - Filter on whether product is in stock or not.
171
+ * @property {number[]} [storeIds] - The Store Id of products to fetch inventory.
172
+ * @property {string} [sizeIdentifier] - Size Identifier (Seller Identifier or
173
+ * Primary Identifier) of which inventory is to get.
174
+ */
175
+ /**
176
+ * @typedef GetInventoryBulkUploadHistoryParam
177
+ * @property {number} [pageNo] - The page number to navigate through the given
178
+ * set of results
179
+ * @property {number} [pageSize] - Number of items to retrieve in each page.
180
+ * Default is 12.
181
+ */
182
+ /**
183
+ * @typedef GetInventoryBySizeParam
184
+ * @property {number} itemId - Item code of the product of which size is to be get.
185
+ * @property {string} size - Size of which inventory is to get.
186
+ * @property {number} [pageNo] - The page number to navigate through the given
187
+ * set of results
188
+ * @property {number} [pageSize] - Number of items to retrieve in each page.
189
+ * Default is 12.
190
+ * @property {string} [q] - Search with help of store code.
191
+ * @property {boolean} [sellable] - Filter on whether product is in stock or not.
192
+ */
193
+ /**
194
+ * @typedef GetInventoryBySizeIdentifierParam
195
+ * @property {number} itemId - Item code of the product of which size is to be get.
196
+ * @property {string} sizeIdentifier - Size Identifier (Seller Identifier or
197
+ * Primary Identifier) of which inventory is to get.
198
+ * @property {number} [pageNo] - The page number to navigate through the given
199
+ * set of results
200
+ * @property {number} [pageSize] - Number of items to retrieve in each page.
201
+ * Default is 12.
202
+ * @property {string} [q] - Search with help of store code.
203
+ * @property {number[]} [locationIds] - Search by store ids.
204
+ */
205
+ /** @typedef GetInventoryExportParam */
206
+ /** @typedef GetMarketplaceOptinDetailParam */
207
+ /**
208
+ * @typedef GetOptimalLocationsParam
209
+ * @property {CatalogPlatformModel.AssignStore} body
210
+ */
211
+ /**
212
+ * @typedef GetProductParam
213
+ * @property {number} itemId - Item Id of the product.
214
+ * @property {number} [brandUid] - Brand Id of the product.
215
+ * @property {string} [itemCode] - Item code of the product.
216
+ */
217
+ /**
218
+ * @typedef GetProductAssetsInBulkParam
219
+ * @property {number} [pageNo] - The page number to navigate through the given
220
+ * set of results
221
+ * @property {number} [pageSize] - Number of items to retrieve in each page.
222
+ * Default is 12.
223
+ */
224
+ /**
225
+ * @typedef GetProductAttributesParam
226
+ * @property {string} category - It is the name of the l3 cateogry
227
+ * @property {boolean} [filter] - If true, returns filtered values, else returns
228
+ * all the attributes
229
+ */
230
+ /**
231
+ * @typedef GetProductBulkUploadHistoryParam
232
+ * @property {string} [search] - Search string to filter the results by batch id
233
+ * @property {number} [pageNo] - The page number to navigate through the given
234
+ * set of results
235
+ * @property {number} [pageSize] - Number of items to retrieve in each page.
236
+ * Default is 12.
237
+ */
238
+ /**
239
+ * @typedef GetProductBundleParam
240
+ * @property {string} [q] - A search string that is searched with product bundle name.
241
+ * @property {string[]} [slug] - Slugs of bundles to be retrieved.
242
+ */
243
+ /**
244
+ * @typedef GetProductBundleDetailParam
245
+ * @property {string} id - A `id` is a unique identifier for a particular
246
+ * detail. Pass the `id` of the keywords which you want to retrieve.
247
+ */
248
+ /**
249
+ * @typedef GetProductExportJobsParam
250
+ * @property {string} [status] - This is a parameter used to find all the jobs
251
+ * with the specified status.
252
+ * @property {string} [fromDate] - This is a parameter used to find the job from
253
+ * the date specified to the current date.
254
+ * @property {string} [toDate] - This is a parameter used to find the job from
255
+ * the from_date specified to the to_date.
256
+ * @property {string} [q] - It is a query parameter to search the export job
257
+ * with the task ID.
258
+ */
259
+ /**
260
+ * @typedef GetProductSizeParam
261
+ * @property {string} [itemCode] - Item code of the product size.
262
+ * @property {number} itemId - Item Id of the product size.
263
+ * @property {number} [brandUid] - Brand Id of the product size.
264
+ * @property {number} [uid] - Id of the product size.
265
+ */
266
+ /** @typedef GetProductTagsParam */
267
+ /** @typedef GetProductValidationParam */
268
+ /**
269
+ * @typedef GetProductsParam
270
+ * @property {number[]} [brandIds] - Get multiple products filtered by Brand Ids
271
+ * @property {number[]} [categoryIds] - Get multiple products filtered by Category Ids
272
+ * @property {number[]} [itemIds] - Get multiple products filtered by Item Ids
273
+ * @property {number[]} [departmentIds] - Get multiple products filtered by Department Ids
274
+ * @property {string[]} [itemCode] - Get multiple products filtered by Item Code
275
+ * @property {string} [q] - Get multiple products filtered by q string
276
+ * @property {string[]} [tags] - Get multiple products filtered by tags
277
+ * @property {number} [pageNo] - The page number to navigate through the given
278
+ * set of results
279
+ * @property {number} [pageSize] - Number of items to retrieve in each page.
280
+ * Default is 10.
281
+ */
282
+ /**
283
+ * @typedef GetSellerInsightsParam
284
+ * @property {string} sellerAppId - Id of the seller application which is
285
+ * serving the invetory/catalog of the company
286
+ */
287
+ /**
288
+ * @typedef GetSingleProductHSNCodeParam
289
+ * @property {string} reportingHsn - Reporting_hsn
290
+ */
291
+ /**
292
+ * @typedef GetSizeGuideParam
293
+ * @property {string} id - Id of the size guide to be viewed.
294
+ */
295
+ /**
296
+ * @typedef GetSizeGuidesParam
297
+ * @property {boolean} [active] - Filter size guide on basis of active, in-active
298
+ * @property {string} [q] - Query that is to be searched.
299
+ * @property {string} [tag] - To filter size guide on basis of tag.
300
+ * @property {number} [pageNo] - The page number to navigate through the given
301
+ * set of results
302
+ * @property {number} [pageSize] - Number of items to retrieve in each page.
303
+ * Default is 10.
304
+ */
305
+ /**
306
+ * @typedef GetStoreDetailParam
307
+ * @property {string} [q] - The search related the store for the company id.
308
+ * @property {number} [pageNo] - The number of page for the company id.
309
+ * @property {number} [pageSize] - Number of records that can be seen on the
310
+ * page for the company id.
311
+ */
312
+ /**
313
+ * @typedef GetVariantsOfProductsParam
314
+ * @property {number} itemId - Get list of variants of item Id
315
+ * @property {string} variantType - Get multiple products filtered by variant type
316
+ * @property {number} [pageNo] - The page number to navigate through the given
317
+ * set of results
318
+ * @property {number} [pageSize] - Number of items to retrieve in each page.
319
+ * Default is 10.
320
+ */
321
+ /**
322
+ * @typedef ListCategoriesParam
323
+ * @property {string} [level] - Get category for multiple levels
324
+ * @property {string} [departments] - Get category for multiple departments filtered
325
+ * @property {string} [q] - Get multiple categories filtered by search string
326
+ * @property {number} [pageNo] - The page number to navigate through the given
327
+ * set of results
328
+ * @property {number} [pageSize] - Number of items to retrieve in each page.
329
+ * Default is 10.
330
+ */
331
+ /**
332
+ * @typedef ListDepartmentsDataParam
333
+ * @property {number} [pageNo] - The page number to navigate through the given
334
+ * set of results
335
+ * @property {string} [itemType] - A `item_type` is a type of product eg. set,
336
+ * standard, digital
337
+ * @property {number} [pageSize] - Number of items to retrieve in each page.
338
+ * Default is 10.
339
+ * @property {string} [name] - Can search departments by passing name.
340
+ * @property {string} [search] - Can search departments by passing name of the
341
+ * department in search parameter.
342
+ * @property {boolean} [isActive] - Can query for departments based on whether
343
+ * they are active or inactive.
344
+ */
345
+ /** @typedef ListHSNCodesParam */
346
+ /**
347
+ * @typedef ListInventoryExportParam
348
+ * @property {string} [status] - Status of the export job.
349
+ * @property {string} [fromDate] - Inventory export history filtered according
350
+ * to from_date.
351
+ * @property {string} [toDate] - Inventory export history filtered according to from_date.
352
+ * @property {string} [q] - Inventory export history filtered according to task ID.
353
+ */
354
+ /**
355
+ * @typedef ListProductTemplateParam
356
+ * @property {string} department - A `department` is the name of a particular department.
357
+ */
358
+ /**
359
+ * @typedef ListProductTemplateCategoriesParam
360
+ * @property {string} departments - A `department` is name of a departments
361
+ * whose category needs to be listed. Can specify multiple departments.
362
+ * @property {string} itemType - An `item_type` is the type of item, it can be
363
+ * `set`, `standard`, `digital`, etc.
364
+ */
365
+ /** @typedef ListProductTemplateExportDetailsParam */
366
+ /**
367
+ * @typedef ListTemplateBrandTypeValuesParam
368
+ * @property {string} filter - A `filter` is the unique identifier of the type
369
+ * of value required.
370
+ * @property {string} [templateTag] - A `template_tag` is the identifier of the
371
+ * type of template required.
372
+ * @property {string} [itemType] - A `item_type` is the identifier of the type
373
+ * of template required.
374
+ */
375
+ /**
376
+ * @typedef UpdateCategoryParam
377
+ * @property {string} uid - Category unique id
378
+ * @property {CatalogPlatformModel.CategoryRequestBody} body
379
+ */
380
+ /**
381
+ * @typedef UpdateDepartmentParam
382
+ * @property {string} uid - A `uid` is a unique identifier of a department.
383
+ * @property {CatalogPlatformModel.DepartmentCreateUpdate} body
384
+ */
385
+ /**
386
+ * @typedef UpdateHsnCodeParam
387
+ * @property {string} id - Unique id
388
+ * @property {CatalogPlatformModel.HsnUpsert} body
389
+ */
390
+ /**
391
+ * @typedef UpdateInventoriesParam
392
+ * @property {CatalogPlatformModel.InventoryRequestSchemaV2} body
393
+ */
394
+ /**
395
+ * @typedef UpdateProductBundleParam
396
+ * @property {string} id - A `id` is a unique identifier for a particular
397
+ * detail. Pass the `id` of the keywords which you want to delete.
398
+ * @property {CatalogPlatformModel.ProductBundleUpdateRequest} body
399
+ */
400
+ /**
401
+ * @typedef UpdateRealtimeInventoryParam
402
+ * @property {number} itemId - Item code of the product of which size is to be get.
403
+ * @property {string} sellerIdentifier - Size Identifier (Seller Identifier or
404
+ * Primary Identifier) of which inventory is to get.
405
+ * @property {CatalogPlatformModel.InventoryRequestSchemaV2} body
406
+ */
407
+ /**
408
+ * @typedef UpdateSizeGuideParam
409
+ * @property {string} id - Mongo id of the size guide to be edited
410
+ * @property {CatalogPlatformModel.ValidateSizeGuide} body
411
+ */
412
+ /**
413
+ * @typedef UploadBulkProductsParam
414
+ * @property {string} department - Department of the product to be uploaded.
415
+ * @property {string} productType - Product type of the product to be uploaded
416
+ * i.e. set, standard , digital.
417
+ * @property {CatalogPlatformModel.BulkJob} body
418
+ */
419
+ /**
420
+ * @typedef ValidateProductTemplateParam
421
+ * @property {string} slug - A `slug` is a unique identifier for a particular template.
422
+ */
423
+ /**
424
+ * @typedef ValidateProductTemplateSchemaParam
425
+ * @property {string} itemType - An `item_type` defines the type of item. The
426
+ * default value is standard.
427
+ */
428
+ declare class CatalogPlatformValidator {
429
+ /** @returns {AddInventoryParam} */
430
+ static addInventory(): AddInventoryParam;
431
+ /** @returns {AllSizesParam} */
432
+ static allSizes(): AllSizesParam;
433
+ /** @returns {BulkHsnCodeParam} */
434
+ static bulkHsnCode(): BulkHsnCodeParam;
435
+ /** @returns {CreateBulkInventoryParam} */
436
+ static createBulkInventory(): CreateBulkInventoryParam;
437
+ /** @returns {CreateBulkInventoryJobParam} */
438
+ static createBulkInventoryJob(): CreateBulkInventoryJobParam;
439
+ /** @returns {CreateBulkProductUploadJobParam} */
440
+ static createBulkProductUploadJob(): CreateBulkProductUploadJobParam;
441
+ /** @returns {CreateCategoriesParam} */
442
+ static createCategories(): CreateCategoriesParam;
443
+ /** @returns {CreateDepartmentsParam} */
444
+ static createDepartments(): CreateDepartmentsParam;
445
+ /** @returns {CreateInventoryExportParam} */
446
+ static createInventoryExport(): CreateInventoryExportParam;
447
+ /** @returns {CreateInventoryExportJobParam} */
448
+ static createInventoryExportJob(): CreateInventoryExportJobParam;
449
+ /** @returns {CreateMarketplaceOptinParam} */
450
+ static createMarketplaceOptin(): CreateMarketplaceOptinParam;
451
+ /** @returns {CreateProductParam} */
452
+ static createProduct(): CreateProductParam;
453
+ /** @returns {CreateProductAssetsInBulkParam} */
454
+ static createProductAssetsInBulk(): CreateProductAssetsInBulkParam;
455
+ /** @returns {CreateProductBundleParam} */
456
+ static createProductBundle(): CreateProductBundleParam;
457
+ /** @returns {CreateProductExportJobParam} */
458
+ static createProductExportJob(): CreateProductExportJobParam;
459
+ /** @returns {CreateProductsInBulkParam} */
460
+ static createProductsInBulk(): CreateProductsInBulkParam;
461
+ /** @returns {CreateSizeGuideParam} */
462
+ static createSizeGuide(): CreateSizeGuideParam;
463
+ /** @returns {DeleteBulkInventoryJobParam} */
464
+ static deleteBulkInventoryJob(): DeleteBulkInventoryJobParam;
465
+ /** @returns {DeleteInventoryParam} */
466
+ static deleteInventory(): DeleteInventoryParam;
467
+ /** @returns {DeleteProductParam} */
468
+ static deleteProduct(): DeleteProductParam;
469
+ /** @returns {DeleteProductBulkJobParam} */
470
+ static deleteProductBulkJob(): DeleteProductBulkJobParam;
471
+ /** @returns {DeleteRealtimeInventoryParam} */
472
+ static deleteRealtimeInventory(): DeleteRealtimeInventoryParam;
473
+ /** @returns {DeleteSizeParam} */
474
+ static deleteSize(): DeleteSizeParam;
475
+ /** @returns {DownloadInventoryTemplateViewParam} */
476
+ static downloadInventoryTemplateView(): DownloadInventoryTemplateViewParam;
477
+ /** @returns {DownloadProductTemplateViewsParam} */
478
+ static downloadProductTemplateViews(): DownloadProductTemplateViewsParam;
479
+ /** @returns {EditProductParam} */
480
+ static editProduct(): EditProductParam;
481
+ /** @returns {ExportInventoryConfigParam} */
482
+ static exportInventoryConfig(): ExportInventoryConfigParam;
483
+ /** @returns {GetAllProductHsnCodesParam} */
484
+ static getAllProductHsnCodes(): GetAllProductHsnCodesParam;
485
+ /** @returns {GetCategoryDataParam} */
486
+ static getCategoryData(): GetCategoryDataParam;
487
+ /** @returns {GetCompanyBrandDetailParam} */
488
+ static getCompanyBrandDetail(): GetCompanyBrandDetailParam;
489
+ /** @returns {GetCompanyDetailParam} */
33
490
  static getCompanyDetail(): any;
491
+ /** @returns {GetCompanyMetricsParam} */
34
492
  static getCompanyMetrics(): any;
35
- static getDepartmentData(): any;
36
- static getGenderAttribute(): any;
37
- static getHsnCode(): any;
38
- static getInventories(): any;
39
- static getInventoryBulkUploadHistory(): any;
40
- static getInventoryBySize(): any;
41
- static getInventoryBySizeIdentifier(): any;
493
+ /** @returns {GetDepartmentDataParam} */
494
+ static getDepartmentData(): GetDepartmentDataParam;
495
+ /** @returns {GetGenderAttributeParam} */
496
+ static getGenderAttribute(): GetGenderAttributeParam;
497
+ /** @returns {GetHsnCodeParam} */
498
+ static getHsnCode(): GetHsnCodeParam;
499
+ /** @returns {GetInventoriesParam} */
500
+ static getInventories(): GetInventoriesParam;
501
+ /** @returns {GetInventoryBulkUploadHistoryParam} */
502
+ static getInventoryBulkUploadHistory(): GetInventoryBulkUploadHistoryParam;
503
+ /** @returns {GetInventoryBySizeParam} */
504
+ static getInventoryBySize(): GetInventoryBySizeParam;
505
+ /** @returns {GetInventoryBySizeIdentifierParam} */
506
+ static getInventoryBySizeIdentifier(): GetInventoryBySizeIdentifierParam;
507
+ /** @returns {GetInventoryExportParam} */
42
508
  static getInventoryExport(): any;
509
+ /** @returns {GetMarketplaceOptinDetailParam} */
43
510
  static getMarketplaceOptinDetail(): any;
44
- static getOptimalLocations(): any;
45
- static getProduct(): any;
46
- static getProductAssetsInBulk(): any;
47
- static getProductAttributes(): any;
48
- static getProductBulkUploadHistory(): any;
49
- static getProductBundle(): any;
50
- static getProductBundleDetail(): any;
51
- static getProductExportJobs(): any;
52
- static getProductSize(): any;
511
+ /** @returns {GetOptimalLocationsParam} */
512
+ static getOptimalLocations(): GetOptimalLocationsParam;
513
+ /** @returns {GetProductParam} */
514
+ static getProduct(): GetProductParam;
515
+ /** @returns {GetProductAssetsInBulkParam} */
516
+ static getProductAssetsInBulk(): GetProductAssetsInBulkParam;
517
+ /** @returns {GetProductAttributesParam} */
518
+ static getProductAttributes(): GetProductAttributesParam;
519
+ /** @returns {GetProductBulkUploadHistoryParam} */
520
+ static getProductBulkUploadHistory(): GetProductBulkUploadHistoryParam;
521
+ /** @returns {GetProductBundleParam} */
522
+ static getProductBundle(): GetProductBundleParam;
523
+ /** @returns {GetProductBundleDetailParam} */
524
+ static getProductBundleDetail(): GetProductBundleDetailParam;
525
+ /** @returns {GetProductExportJobsParam} */
526
+ static getProductExportJobs(): GetProductExportJobsParam;
527
+ /** @returns {GetProductSizeParam} */
528
+ static getProductSize(): GetProductSizeParam;
529
+ /** @returns {GetProductTagsParam} */
53
530
  static getProductTags(): any;
531
+ /** @returns {GetProductValidationParam} */
54
532
  static getProductValidation(): any;
55
- static getProducts(): any;
56
- static getSellerInsights(): any;
57
- static getSingleProductHSNCode(): any;
58
- static getSizeGuide(): any;
59
- static getSizeGuides(): any;
60
- static getStoreDetail(): any;
61
- static getVariantsOfProducts(): any;
62
- static listCategories(): any;
63
- static listDepartmentsData(): any;
533
+ /** @returns {GetProductsParam} */
534
+ static getProducts(): GetProductsParam;
535
+ /** @returns {GetSellerInsightsParam} */
536
+ static getSellerInsights(): GetSellerInsightsParam;
537
+ /** @returns {GetSingleProductHSNCodeParam} */
538
+ static getSingleProductHSNCode(): GetSingleProductHSNCodeParam;
539
+ /** @returns {GetSizeGuideParam} */
540
+ static getSizeGuide(): GetSizeGuideParam;
541
+ /** @returns {GetSizeGuidesParam} */
542
+ static getSizeGuides(): GetSizeGuidesParam;
543
+ /** @returns {GetStoreDetailParam} */
544
+ static getStoreDetail(): GetStoreDetailParam;
545
+ /** @returns {GetVariantsOfProductsParam} */
546
+ static getVariantsOfProducts(): GetVariantsOfProductsParam;
547
+ /** @returns {ListCategoriesParam} */
548
+ static listCategories(): ListCategoriesParam;
549
+ /** @returns {ListDepartmentsDataParam} */
550
+ static listDepartmentsData(): ListDepartmentsDataParam;
551
+ /** @returns {ListHSNCodesParam} */
64
552
  static listHSNCodes(): any;
65
- static listInventoryExport(): any;
66
- static listProductTemplate(): any;
67
- static listProductTemplateCategories(): any;
553
+ /** @returns {ListInventoryExportParam} */
554
+ static listInventoryExport(): ListInventoryExportParam;
555
+ /** @returns {ListProductTemplateParam} */
556
+ static listProductTemplate(): ListProductTemplateParam;
557
+ /** @returns {ListProductTemplateCategoriesParam} */
558
+ static listProductTemplateCategories(): ListProductTemplateCategoriesParam;
559
+ /** @returns {ListProductTemplateExportDetailsParam} */
68
560
  static listProductTemplateExportDetails(): any;
69
- static listTemplateBrandTypeValues(): any;
70
- static updateCategory(): any;
71
- static updateDepartment(): any;
72
- static updateHsnCode(): any;
73
- static updateInventories(): any;
74
- static updateProductBundle(): any;
75
- static updateRealtimeInventory(): any;
76
- static updateSizeGuide(): any;
77
- static uploadBulkProducts(): any;
78
- static validateProductTemplate(): any;
79
- static validateProductTemplateSchema(): any;
561
+ /** @returns {ListTemplateBrandTypeValuesParam} */
562
+ static listTemplateBrandTypeValues(): ListTemplateBrandTypeValuesParam;
563
+ /** @returns {UpdateCategoryParam} */
564
+ static updateCategory(): UpdateCategoryParam;
565
+ /** @returns {UpdateDepartmentParam} */
566
+ static updateDepartment(): UpdateDepartmentParam;
567
+ /** @returns {UpdateHsnCodeParam} */
568
+ static updateHsnCode(): UpdateHsnCodeParam;
569
+ /** @returns {UpdateInventoriesParam} */
570
+ static updateInventories(): UpdateInventoriesParam;
571
+ /** @returns {UpdateProductBundleParam} */
572
+ static updateProductBundle(): UpdateProductBundleParam;
573
+ /** @returns {UpdateRealtimeInventoryParam} */
574
+ static updateRealtimeInventory(): UpdateRealtimeInventoryParam;
575
+ /** @returns {UpdateSizeGuideParam} */
576
+ static updateSizeGuide(): UpdateSizeGuideParam;
577
+ /** @returns {UploadBulkProductsParam} */
578
+ static uploadBulkProducts(): UploadBulkProductsParam;
579
+ /** @returns {ValidateProductTemplateParam} */
580
+ static validateProductTemplate(): ValidateProductTemplateParam;
581
+ /** @returns {ValidateProductTemplateSchemaParam} */
582
+ static validateProductTemplateSchema(): ValidateProductTemplateSchemaParam;
80
583
  }
584
+ declare namespace CatalogPlatformValidator {
585
+ export { AddInventoryParam, AllSizesParam, BulkHsnCodeParam, CreateBulkInventoryParam, CreateBulkInventoryJobParam, CreateBulkProductUploadJobParam, CreateCategoriesParam, CreateDepartmentsParam, CreateInventoryExportParam, CreateInventoryExportJobParam, CreateMarketplaceOptinParam, CreateProductParam, CreateProductAssetsInBulkParam, CreateProductBundleParam, CreateProductExportJobParam, CreateProductsInBulkParam, CreateSizeGuideParam, DeleteBulkInventoryJobParam, DeleteInventoryParam, DeleteProductParam, DeleteProductBulkJobParam, DeleteRealtimeInventoryParam, DeleteSizeParam, DownloadInventoryTemplateViewParam, DownloadProductTemplateViewsParam, EditProductParam, ExportInventoryConfigParam, GetAllProductHsnCodesParam, GetCategoryDataParam, GetCompanyBrandDetailParam, GetCompanyDetailParam, GetCompanyMetricsParam, GetDepartmentDataParam, GetGenderAttributeParam, GetHsnCodeParam, GetInventoriesParam, GetInventoryBulkUploadHistoryParam, GetInventoryBySizeParam, GetInventoryBySizeIdentifierParam, GetInventoryExportParam, GetMarketplaceOptinDetailParam, GetOptimalLocationsParam, GetProductParam, GetProductAssetsInBulkParam, GetProductAttributesParam, GetProductBulkUploadHistoryParam, GetProductBundleParam, GetProductBundleDetailParam, GetProductExportJobsParam, GetProductSizeParam, GetProductTagsParam, GetProductValidationParam, GetProductsParam, GetSellerInsightsParam, GetSingleProductHSNCodeParam, GetSizeGuideParam, GetSizeGuidesParam, GetStoreDetailParam, GetVariantsOfProductsParam, ListCategoriesParam, ListDepartmentsDataParam, ListHSNCodesParam, ListInventoryExportParam, ListProductTemplateParam, ListProductTemplateCategoriesParam, ListProductTemplateExportDetailsParam, ListTemplateBrandTypeValuesParam, UpdateCategoryParam, UpdateDepartmentParam, UpdateHsnCodeParam, UpdateInventoriesParam, UpdateProductBundleParam, UpdateRealtimeInventoryParam, UpdateSizeGuideParam, UploadBulkProductsParam, ValidateProductTemplateParam, ValidateProductTemplateSchemaParam };
586
+ }
587
+ type AddInventoryParam = {
588
+ /**
589
+ * - Item code of the product of which size is to be get.
590
+ */
591
+ itemId: number;
592
+ /**
593
+ * - Size in which inventory is to be added.
594
+ */
595
+ size: string;
596
+ body: CatalogPlatformModel.InventoryRequest;
597
+ };
598
+ type AllSizesParam = {
599
+ /**
600
+ * - Id of the product to be updated.
601
+ */
602
+ itemId: number;
603
+ };
604
+ type BulkHsnCodeParam = {
605
+ body: CatalogPlatformModel.BulkHsnUpsert;
606
+ };
607
+ type CreateBulkInventoryParam = {
608
+ /**
609
+ * - Batch Id of the bulk create job.
610
+ */
611
+ batchId: string;
612
+ body: CatalogPlatformModel.InventoryBulkRequest;
613
+ };
614
+ type CreateBulkInventoryJobParam = {
615
+ body: CatalogPlatformModel.BulkJob;
616
+ };
617
+ type CreateBulkProductUploadJobParam = {
618
+ body: CatalogPlatformModel.BulkJob;
619
+ };
620
+ type CreateCategoriesParam = {
621
+ body: CatalogPlatformModel.CategoryRequestBody;
622
+ };
623
+ type CreateDepartmentsParam = {
624
+ body: CatalogPlatformModel.DepartmentCreateUpdate;
625
+ };
626
+ type CreateInventoryExportParam = {
627
+ body: CatalogPlatformModel.InventoryCreateRequest;
628
+ };
629
+ type CreateInventoryExportJobParam = {
630
+ body: CatalogPlatformModel.InventoryExportRequest;
631
+ };
632
+ type CreateMarketplaceOptinParam = {
633
+ /**
634
+ * - The marketplace for which the detail needs
635
+ * to be retrieved.
636
+ */
637
+ marketplace: string;
638
+ body: CatalogPlatformModel.OptInPostRequest;
639
+ };
640
+ type CreateProductParam = {
641
+ body: CatalogPlatformModel.ProductCreateUpdateSchemaV2;
642
+ };
643
+ type CreateProductAssetsInBulkParam = {
644
+ body: CatalogPlatformModel.ProductBulkAssets;
645
+ };
646
+ type CreateProductBundleParam = {
647
+ body: CatalogPlatformModel.ProductBundleRequest;
648
+ };
649
+ type CreateProductExportJobParam = {
650
+ body: CatalogPlatformModel.ProductTemplateDownloadsExport;
651
+ };
652
+ type CreateProductsInBulkParam = {
653
+ /**
654
+ * - Batch Id in which assets to be uploaded.
655
+ */
656
+ batchId: string;
657
+ body: CatalogPlatformModel.BulkProductRequest;
658
+ };
659
+ type CreateSizeGuideParam = {
660
+ body: CatalogPlatformModel.ValidateSizeGuide;
661
+ };
662
+ type DeleteBulkInventoryJobParam = {
663
+ /**
664
+ * - Batch Id of the bulk delete job.
665
+ */
666
+ batchId: string;
667
+ };
668
+ type DeleteInventoryParam = {
669
+ /**
670
+ * - Size that is to be deleted.
671
+ */
672
+ size: string;
673
+ /**
674
+ * - Id of the product associated with Inventory to be deleted.
675
+ */
676
+ itemId: number;
677
+ /**
678
+ * - Location ID of store of which inventory is to
679
+ * be deleted.
680
+ */
681
+ locationId: number;
682
+ };
683
+ type DeleteProductParam = {
684
+ /**
685
+ * - Id of the product to be updated.
686
+ */
687
+ itemId: number;
688
+ };
689
+ type DeleteProductBulkJobParam = {
690
+ /**
691
+ * - Batch Id of the bulk product job to be deleted.
692
+ */
693
+ batchId: number;
694
+ };
695
+ type DeleteRealtimeInventoryParam = {
696
+ /**
697
+ * - Item code of the product of which size is to be get.
698
+ */
699
+ itemId: number;
700
+ /**
701
+ * - Size Identifier (Seller Identifier or
702
+ * Primary Identifier) of which inventory is to get.
703
+ */
704
+ sellerIdentifier: string;
705
+ body: CatalogPlatformModel.InventoryRequestSchemaV2;
706
+ };
707
+ type DeleteSizeParam = {
708
+ /**
709
+ * - Item Id of the product associated with size to be deleted.
710
+ */
711
+ itemId: number;
712
+ /**
713
+ * - Size to be deleted.
714
+ */
715
+ size: string;
716
+ };
717
+ type DownloadInventoryTemplateViewParam = {
718
+ /**
719
+ * - An `item_type` defines the type of item.
720
+ */
721
+ itemType: string;
722
+ };
723
+ type DownloadProductTemplateViewsParam = {
724
+ /**
725
+ * - A `slug` is a unique identifier for a particular template.
726
+ */
727
+ slug: string;
728
+ };
729
+ type EditProductParam = {
730
+ /**
731
+ * - Id of the product to be updated.
732
+ */
733
+ itemId: number;
734
+ body: CatalogPlatformModel.ProductCreateUpdateSchemaV2;
735
+ };
736
+ type ExportInventoryConfigParam = {
737
+ /**
738
+ * - Filter type from any one of ['brand',
739
+ * 'store', 'type']
740
+ */
741
+ filterType?: string;
742
+ };
743
+ type GetAllProductHsnCodesParam = {
744
+ /**
745
+ * - Page no
746
+ */
747
+ pageNo?: number;
748
+ /**
749
+ * - Page size
750
+ */
751
+ pageSize?: number;
752
+ /**
753
+ * - Search using hsn code, description, reporting_hsn
754
+ */
755
+ q?: string;
756
+ /**
757
+ * - Search using type
758
+ */
759
+ type?: string;
760
+ };
761
+ type GetCategoryDataParam = {
762
+ /**
763
+ * - Category unique id
764
+ */
765
+ uid: string;
766
+ };
767
+ type GetCompanyBrandDetailParam = {
768
+ /**
769
+ * - The is_active status for the optin id.
770
+ */
771
+ isActive?: boolean;
772
+ /**
773
+ * - The search value to filter the list.
774
+ */
775
+ q?: string;
776
+ /**
777
+ * - The number of page for the company id.
778
+ */
779
+ pageNo?: number;
780
+ /**
781
+ * - Number of records that can be seen on the
782
+ * page for the company id.
783
+ */
784
+ pageSize?: number;
785
+ /**
786
+ * - The marketplace platform associated with
787
+ * the company id.
788
+ */
789
+ marketplace?: string;
790
+ };
791
+ type GetDepartmentDataParam = {
792
+ /**
793
+ * - A `uid` is a unique identifier of a department.
794
+ */
795
+ uid: string;
796
+ };
797
+ type GetGenderAttributeParam = {
798
+ /**
799
+ * - Slug of the attribute for which you want
800
+ * to view the genders
801
+ */
802
+ attributeSlug: string;
803
+ };
804
+ type GetHsnCodeParam = {
805
+ /**
806
+ * - Unique id
807
+ */
808
+ id: string;
809
+ };
810
+ type GetInventoriesParam = {
811
+ /**
812
+ * - Item code of the product of which size is to be get.
813
+ */
814
+ itemId?: string;
815
+ /**
816
+ * - Size of which inventory is to get.
817
+ */
818
+ size?: string;
819
+ /**
820
+ * - The page number to navigate through the given
821
+ * set of results
822
+ */
823
+ pageNo?: number;
824
+ /**
825
+ * - Number of items to retrieve in each page.
826
+ * Default is 12.
827
+ */
828
+ pageSize?: number;
829
+ /**
830
+ * - Search with help of store code.
831
+ */
832
+ q?: string;
833
+ /**
834
+ * - Filter on whether product is in stock or not.
835
+ */
836
+ sellable?: boolean;
837
+ /**
838
+ * - The Store Id of products to fetch inventory.
839
+ */
840
+ storeIds?: number[];
841
+ /**
842
+ * - Size Identifier (Seller Identifier or
843
+ * Primary Identifier) of which inventory is to get.
844
+ */
845
+ sizeIdentifier?: string;
846
+ };
847
+ type GetInventoryBulkUploadHistoryParam = {
848
+ /**
849
+ * - The page number to navigate through the given
850
+ * set of results
851
+ */
852
+ pageNo?: number;
853
+ /**
854
+ * - Number of items to retrieve in each page.
855
+ * Default is 12.
856
+ */
857
+ pageSize?: number;
858
+ };
859
+ type GetInventoryBySizeParam = {
860
+ /**
861
+ * - Item code of the product of which size is to be get.
862
+ */
863
+ itemId: number;
864
+ /**
865
+ * - Size of which inventory is to get.
866
+ */
867
+ size: string;
868
+ /**
869
+ * - The page number to navigate through the given
870
+ * set of results
871
+ */
872
+ pageNo?: number;
873
+ /**
874
+ * - Number of items to retrieve in each page.
875
+ * Default is 12.
876
+ */
877
+ pageSize?: number;
878
+ /**
879
+ * - Search with help of store code.
880
+ */
881
+ q?: string;
882
+ /**
883
+ * - Filter on whether product is in stock or not.
884
+ */
885
+ sellable?: boolean;
886
+ };
887
+ type GetInventoryBySizeIdentifierParam = {
888
+ /**
889
+ * - Item code of the product of which size is to be get.
890
+ */
891
+ itemId: number;
892
+ /**
893
+ * - Size Identifier (Seller Identifier or
894
+ * Primary Identifier) of which inventory is to get.
895
+ */
896
+ sizeIdentifier: string;
897
+ /**
898
+ * - The page number to navigate through the given
899
+ * set of results
900
+ */
901
+ pageNo?: number;
902
+ /**
903
+ * - Number of items to retrieve in each page.
904
+ * Default is 12.
905
+ */
906
+ pageSize?: number;
907
+ /**
908
+ * - Search with help of store code.
909
+ */
910
+ q?: string;
911
+ /**
912
+ * - Search by store ids.
913
+ */
914
+ locationIds?: number[];
915
+ };
916
+ type GetOptimalLocationsParam = {
917
+ body: CatalogPlatformModel.AssignStore;
918
+ };
919
+ type GetProductParam = {
920
+ /**
921
+ * - Item Id of the product.
922
+ */
923
+ itemId: number;
924
+ /**
925
+ * - Brand Id of the product.
926
+ */
927
+ brandUid?: number;
928
+ /**
929
+ * - Item code of the product.
930
+ */
931
+ itemCode?: string;
932
+ };
933
+ type GetProductAssetsInBulkParam = {
934
+ /**
935
+ * - The page number to navigate through the given
936
+ * set of results
937
+ */
938
+ pageNo?: number;
939
+ /**
940
+ * - Number of items to retrieve in each page.
941
+ * Default is 12.
942
+ */
943
+ pageSize?: number;
944
+ };
945
+ type GetProductAttributesParam = {
946
+ /**
947
+ * - It is the name of the l3 cateogry
948
+ */
949
+ category: string;
950
+ /**
951
+ * - If true, returns filtered values, else returns
952
+ * all the attributes
953
+ */
954
+ filter?: boolean;
955
+ };
956
+ type GetProductBulkUploadHistoryParam = {
957
+ /**
958
+ * - Search string to filter the results by batch id
959
+ */
960
+ search?: string;
961
+ /**
962
+ * - The page number to navigate through the given
963
+ * set of results
964
+ */
965
+ pageNo?: number;
966
+ /**
967
+ * - Number of items to retrieve in each page.
968
+ * Default is 12.
969
+ */
970
+ pageSize?: number;
971
+ };
972
+ type GetProductBundleParam = {
973
+ /**
974
+ * - A search string that is searched with product bundle name.
975
+ */
976
+ q?: string;
977
+ /**
978
+ * - Slugs of bundles to be retrieved.
979
+ */
980
+ slug?: string[];
981
+ };
982
+ type GetProductBundleDetailParam = {
983
+ /**
984
+ * - A `id` is a unique identifier for a particular
985
+ * detail. Pass the `id` of the keywords which you want to retrieve.
986
+ */
987
+ id: string;
988
+ };
989
+ type GetProductExportJobsParam = {
990
+ /**
991
+ * - This is a parameter used to find all the jobs
992
+ * with the specified status.
993
+ */
994
+ status?: string;
995
+ /**
996
+ * - This is a parameter used to find the job from
997
+ * the date specified to the current date.
998
+ */
999
+ fromDate?: string;
1000
+ /**
1001
+ * - This is a parameter used to find the job from
1002
+ * the from_date specified to the to_date.
1003
+ */
1004
+ toDate?: string;
1005
+ /**
1006
+ * - It is a query parameter to search the export job
1007
+ * with the task ID.
1008
+ */
1009
+ q?: string;
1010
+ };
1011
+ type GetProductSizeParam = {
1012
+ /**
1013
+ * - Item code of the product size.
1014
+ */
1015
+ itemCode?: string;
1016
+ /**
1017
+ * - Item Id of the product size.
1018
+ */
1019
+ itemId: number;
1020
+ /**
1021
+ * - Brand Id of the product size.
1022
+ */
1023
+ brandUid?: number;
1024
+ /**
1025
+ * - Id of the product size.
1026
+ */
1027
+ uid?: number;
1028
+ };
1029
+ type GetProductsParam = {
1030
+ /**
1031
+ * - Get multiple products filtered by Brand Ids
1032
+ */
1033
+ brandIds?: number[];
1034
+ /**
1035
+ * - Get multiple products filtered by Category Ids
1036
+ */
1037
+ categoryIds?: number[];
1038
+ /**
1039
+ * - Get multiple products filtered by Item Ids
1040
+ */
1041
+ itemIds?: number[];
1042
+ /**
1043
+ * - Get multiple products filtered by Department Ids
1044
+ */
1045
+ departmentIds?: number[];
1046
+ /**
1047
+ * - Get multiple products filtered by Item Code
1048
+ */
1049
+ itemCode?: string[];
1050
+ /**
1051
+ * - Get multiple products filtered by q string
1052
+ */
1053
+ q?: string;
1054
+ /**
1055
+ * - Get multiple products filtered by tags
1056
+ */
1057
+ tags?: string[];
1058
+ /**
1059
+ * - The page number to navigate through the given
1060
+ * set of results
1061
+ */
1062
+ pageNo?: number;
1063
+ /**
1064
+ * - Number of items to retrieve in each page.
1065
+ * Default is 10.
1066
+ */
1067
+ pageSize?: number;
1068
+ };
1069
+ type GetSellerInsightsParam = {
1070
+ /**
1071
+ * - Id of the seller application which is
1072
+ * serving the invetory/catalog of the company
1073
+ */
1074
+ sellerAppId: string;
1075
+ };
1076
+ type GetSingleProductHSNCodeParam = {
1077
+ /**
1078
+ * - Reporting_hsn
1079
+ */
1080
+ reportingHsn: string;
1081
+ };
1082
+ type GetSizeGuideParam = {
1083
+ /**
1084
+ * - Id of the size guide to be viewed.
1085
+ */
1086
+ id: string;
1087
+ };
1088
+ type GetSizeGuidesParam = {
1089
+ /**
1090
+ * - Filter size guide on basis of active, in-active
1091
+ */
1092
+ active?: boolean;
1093
+ /**
1094
+ * - Query that is to be searched.
1095
+ */
1096
+ q?: string;
1097
+ /**
1098
+ * - To filter size guide on basis of tag.
1099
+ */
1100
+ tag?: string;
1101
+ /**
1102
+ * - The page number to navigate through the given
1103
+ * set of results
1104
+ */
1105
+ pageNo?: number;
1106
+ /**
1107
+ * - Number of items to retrieve in each page.
1108
+ * Default is 10.
1109
+ */
1110
+ pageSize?: number;
1111
+ };
1112
+ type GetStoreDetailParam = {
1113
+ /**
1114
+ * - The search related the store for the company id.
1115
+ */
1116
+ q?: string;
1117
+ /**
1118
+ * - The number of page for the company id.
1119
+ */
1120
+ pageNo?: number;
1121
+ /**
1122
+ * - Number of records that can be seen on the
1123
+ * page for the company id.
1124
+ */
1125
+ pageSize?: number;
1126
+ };
1127
+ type GetVariantsOfProductsParam = {
1128
+ /**
1129
+ * - Get list of variants of item Id
1130
+ */
1131
+ itemId: number;
1132
+ /**
1133
+ * - Get multiple products filtered by variant type
1134
+ */
1135
+ variantType: string;
1136
+ /**
1137
+ * - The page number to navigate through the given
1138
+ * set of results
1139
+ */
1140
+ pageNo?: number;
1141
+ /**
1142
+ * - Number of items to retrieve in each page.
1143
+ * Default is 10.
1144
+ */
1145
+ pageSize?: number;
1146
+ };
1147
+ type ListCategoriesParam = {
1148
+ /**
1149
+ * - Get category for multiple levels
1150
+ */
1151
+ level?: string;
1152
+ /**
1153
+ * - Get category for multiple departments filtered
1154
+ */
1155
+ departments?: string;
1156
+ /**
1157
+ * - Get multiple categories filtered by search string
1158
+ */
1159
+ q?: string;
1160
+ /**
1161
+ * - The page number to navigate through the given
1162
+ * set of results
1163
+ */
1164
+ pageNo?: number;
1165
+ /**
1166
+ * - Number of items to retrieve in each page.
1167
+ * Default is 10.
1168
+ */
1169
+ pageSize?: number;
1170
+ };
1171
+ type ListDepartmentsDataParam = {
1172
+ /**
1173
+ * - The page number to navigate through the given
1174
+ * set of results
1175
+ */
1176
+ pageNo?: number;
1177
+ /**
1178
+ * - A `item_type` is a type of product eg. set,
1179
+ * standard, digital
1180
+ */
1181
+ itemType?: string;
1182
+ /**
1183
+ * - Number of items to retrieve in each page.
1184
+ * Default is 10.
1185
+ */
1186
+ pageSize?: number;
1187
+ /**
1188
+ * - Can search departments by passing name.
1189
+ */
1190
+ name?: string;
1191
+ /**
1192
+ * - Can search departments by passing name of the
1193
+ * department in search parameter.
1194
+ */
1195
+ search?: string;
1196
+ /**
1197
+ * - Can query for departments based on whether
1198
+ * they are active or inactive.
1199
+ */
1200
+ isActive?: boolean;
1201
+ };
1202
+ type ListInventoryExportParam = {
1203
+ /**
1204
+ * - Status of the export job.
1205
+ */
1206
+ status?: string;
1207
+ /**
1208
+ * - Inventory export history filtered according
1209
+ * to from_date.
1210
+ */
1211
+ fromDate?: string;
1212
+ /**
1213
+ * - Inventory export history filtered according to from_date.
1214
+ */
1215
+ toDate?: string;
1216
+ /**
1217
+ * - Inventory export history filtered according to task ID.
1218
+ */
1219
+ q?: string;
1220
+ };
1221
+ type ListProductTemplateParam = {
1222
+ /**
1223
+ * - A `department` is the name of a particular department.
1224
+ */
1225
+ department: string;
1226
+ };
1227
+ type ListProductTemplateCategoriesParam = {
1228
+ /**
1229
+ * - A `department` is name of a departments
1230
+ * whose category needs to be listed. Can specify multiple departments.
1231
+ */
1232
+ departments: string;
1233
+ /**
1234
+ * - An `item_type` is the type of item, it can be
1235
+ * `set`, `standard`, `digital`, etc.
1236
+ */
1237
+ itemType: string;
1238
+ };
1239
+ type ListTemplateBrandTypeValuesParam = {
1240
+ /**
1241
+ * - A `filter` is the unique identifier of the type
1242
+ * of value required.
1243
+ */
1244
+ filter: string;
1245
+ /**
1246
+ * - A `template_tag` is the identifier of the
1247
+ * type of template required.
1248
+ */
1249
+ templateTag?: string;
1250
+ /**
1251
+ * - A `item_type` is the identifier of the type
1252
+ * of template required.
1253
+ */
1254
+ itemType?: string;
1255
+ };
1256
+ type UpdateCategoryParam = {
1257
+ /**
1258
+ * - Category unique id
1259
+ */
1260
+ uid: string;
1261
+ body: CatalogPlatformModel.CategoryRequestBody;
1262
+ };
1263
+ type UpdateDepartmentParam = {
1264
+ /**
1265
+ * - A `uid` is a unique identifier of a department.
1266
+ */
1267
+ uid: string;
1268
+ body: CatalogPlatformModel.DepartmentCreateUpdate;
1269
+ };
1270
+ type UpdateHsnCodeParam = {
1271
+ /**
1272
+ * - Unique id
1273
+ */
1274
+ id: string;
1275
+ body: CatalogPlatformModel.HsnUpsert;
1276
+ };
1277
+ type UpdateInventoriesParam = {
1278
+ body: CatalogPlatformModel.InventoryRequestSchemaV2;
1279
+ };
1280
+ type UpdateProductBundleParam = {
1281
+ /**
1282
+ * - A `id` is a unique identifier for a particular
1283
+ * detail. Pass the `id` of the keywords which you want to delete.
1284
+ */
1285
+ id: string;
1286
+ body: CatalogPlatformModel.ProductBundleUpdateRequest;
1287
+ };
1288
+ type UpdateRealtimeInventoryParam = {
1289
+ /**
1290
+ * - Item code of the product of which size is to be get.
1291
+ */
1292
+ itemId: number;
1293
+ /**
1294
+ * - Size Identifier (Seller Identifier or
1295
+ * Primary Identifier) of which inventory is to get.
1296
+ */
1297
+ sellerIdentifier: string;
1298
+ body: CatalogPlatformModel.InventoryRequestSchemaV2;
1299
+ };
1300
+ type UpdateSizeGuideParam = {
1301
+ /**
1302
+ * - Mongo id of the size guide to be edited
1303
+ */
1304
+ id: string;
1305
+ body: CatalogPlatformModel.ValidateSizeGuide;
1306
+ };
1307
+ type UploadBulkProductsParam = {
1308
+ /**
1309
+ * - Department of the product to be uploaded.
1310
+ */
1311
+ department: string;
1312
+ /**
1313
+ * - Product type of the product to be uploaded
1314
+ * i.e. set, standard , digital.
1315
+ */
1316
+ productType: string;
1317
+ body: CatalogPlatformModel.BulkJob;
1318
+ };
1319
+ type ValidateProductTemplateParam = {
1320
+ /**
1321
+ * - A `slug` is a unique identifier for a particular template.
1322
+ */
1323
+ slug: string;
1324
+ };
1325
+ type ValidateProductTemplateSchemaParam = {
1326
+ /**
1327
+ * - An `item_type` defines the type of item. The
1328
+ * default value is standard.
1329
+ */
1330
+ itemType: string;
1331
+ };
1332
+ type GetCompanyDetailParam = any;
1333
+ type GetCompanyMetricsParam = any;
1334
+ type GetInventoryExportParam = any;
1335
+ type GetMarketplaceOptinDetailParam = any;
1336
+ type GetProductTagsParam = any;
1337
+ type GetProductValidationParam = any;
1338
+ type ListHSNCodesParam = any;
1339
+ type ListProductTemplateExportDetailsParam = any;
1340
+ import CatalogPlatformModel = require("./CatalogPlatformModel");