@gofynd/fdk-client-javascript 1.1.6 → 1.3.0

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