@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,33 +1,800 @@
1
- export = CatalogValidator;
2
- declare class CatalogValidator {
3
- static followById(): any;
4
- static getBrandDetailBySlug(): any;
5
- static getBrands(): any;
6
- static getCategories(): any;
7
- static getCategoryDetailBySlug(): any;
8
- static getCollectionDetailBySlug(): any;
9
- static getCollectionItemsBySlug(): any;
10
- static getCollections(): any;
11
- static getComparedFrequentlyProductBySlug(): any;
1
+ export = CatalogApplicationValidator;
2
+ /**
3
+ * @typedef FollowByIdParam
4
+ * @property {string} collectionType - Type of collection followed, i.e.
5
+ * products, brands, or collections.
6
+ * @property {string} collectionId - The ID of the collection type.
7
+ */
8
+ /**
9
+ * @typedef GetBrandDetailBySlugParam
10
+ * @property {string} slug - A short, human-readable, URL-friendly identifier of
11
+ * a brand. You can get slug value from the endpoint
12
+ * /service/application/catalog/v1.0/brands/.
13
+ */
14
+ /**
15
+ * @typedef GetBrandsParam
16
+ * @property {string} [department] - The name of the department. Use this
17
+ * parameter to filter products by a particular department. See the list of
18
+ * available departments below. Also, you can get available departments from
19
+ * the endpoint /service/application/catalog/v1.0/departments/
20
+ * @property {number} [pageNo] - The page number to navigate through the given
21
+ * set of results.
22
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
23
+ */
24
+ /**
25
+ * @typedef GetCategoriesParam
26
+ * @property {string} [department] - The name of the department. Use this
27
+ * parameter to filter products by a particular department. See the list of
28
+ * available departments below. Also, you can get available departments from
29
+ * the endpoint /service/application/catalog/v1.0/departments/
30
+ */
31
+ /**
32
+ * @typedef GetCategoryDetailBySlugParam
33
+ * @property {string} slug - A short, human-readable, URL-friendly identifier of
34
+ * a brand. You can get slug value from the endpoint
35
+ * /service/application/catalog/v1.0/brands/.
36
+ */
37
+ /**
38
+ * @typedef GetCollectionDetailBySlugParam
39
+ * @property {string} slug - A short, human-readable, URL-friendly identifier of
40
+ * a collection. You can get slug value from the endpoint
41
+ * /service/application/catalog/v1.0/collections/.
42
+ */
43
+ /**
44
+ * @typedef GetCollectionItemsBySlugParam
45
+ * @property {string} slug - A short, human-readable, URL-friendly identifier of
46
+ * a collection. You can get slug value from the endpoint
47
+ * /service/application/catalog/v1.0/collections/.
48
+ * @property {string} [f] - The search filter parameters. Filter parameters will
49
+ * be passed in f parameter as shown in the example below. Double Pipe (||)
50
+ * denotes the OR condition, whereas Triple-colon (:::) indicates a new filter
51
+ * paramater applied as an AND condition.
52
+ * @property {string} [q] - The search query for entering partial or full name
53
+ * of product, brand, category, or collection.
54
+ * @property {boolean} [filters] - This is a boolean value, True for fetching
55
+ * all filter parameters and False for disabling the filter parameters.
56
+ * @property {string} [sortOn] - The order in which the list of products should
57
+ * be sorted, e.g. popularity, price, latest and discount, in either ascending
58
+ * or descending order. See the supported values below.
59
+ * @property {string} [pageId] - Page ID to retrieve next set of results.
60
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
61
+ * @property {number} [pageNo] - Page Number to retrieve next set of results.
62
+ * @property {string} [pageType] - Page Type to retrieve set of results can be
63
+ * cursor or number.
64
+ */
65
+ /**
66
+ * @typedef GetCollectionsParam
67
+ * @property {number} [pageNo] - The page number to navigate through the given
68
+ * set of results.
69
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
70
+ * @property {string[]} [tag] - List of tags to filter collections
71
+ * @property {string} [q] - Name of the collection to filter collection
72
+ */
73
+ /**
74
+ * @typedef GetComparedFrequentlyProductBySlugParam
75
+ * @property {string} slug - A short, human-readable, URL-friendly identifier of
76
+ * a product. You can get slug value from the endpoint
77
+ * /service/application/catalog/v1.0/products/
78
+ */
79
+ /** @typedef GetDepartmentsParam */
80
+ /**
81
+ * @typedef GetFollowIdsParam
82
+ * @property {string} [collectionType] - Type of collection, i.e. products,
83
+ * brands, collections.
84
+ */
85
+ /**
86
+ * @typedef GetFollowedListingParam
87
+ * @property {string} collectionType - Type of collection followed, i.e.
88
+ * products, brands, or collections.
89
+ * @property {string} [pageId] - Page ID to retrieve next set of results.
90
+ * @property {number} [pageSize] - Page ID to retrieve next set of results.
91
+ */
92
+ /**
93
+ * @typedef GetFollowerCountByIdParam
94
+ * @property {string} collectionType - Type of collection, i.e. products,
95
+ * brands, or collections.
96
+ * @property {string} collectionId - The ID of the collection type.
97
+ */
98
+ /**
99
+ * @typedef GetHomeProductsParam
100
+ * @property {string} [sortOn] - The order in which the list of products should
101
+ * be sorted, e.g. popularity, price, latest and discount, in either ascending
102
+ * or descending order.
103
+ * @property {string} [pageId] - Page ID to retrieve next set of results.
104
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
105
+ */
106
+ /**
107
+ * @typedef GetInStockLocationsParam
108
+ * @property {number} [pageNo] - The page number to navigate through the given
109
+ * set of results.
110
+ * @property {number} [pageSize] - Number of items to retrieve in each page.
111
+ * @property {string} [q] - Search a store by its name or store_code.
112
+ * @property {string} [city] - Search stores by the city in which they are situated.
113
+ * @property {number} [range] - Use this to retrieve stores within a particular
114
+ * range in meters, e.g. 10000, to indicate a 10km range
115
+ * @property {number} [latitude] - Latitude of the location from where one wants
116
+ * to retreive the nearest stores, e.g. 72.8691788
117
+ * @property {number} [longitude] - Longitude of the location from where one
118
+ * wants to retreive the nearest stores, e.g. 19.1174114
119
+ */
120
+ /**
121
+ * @typedef GetLocationDetailsByIdParam
122
+ * @property {number} locationId - Unique Location ID.
123
+ */
124
+ /**
125
+ * @typedef GetProductBundlesBySlugParam
126
+ * @property {string} [slug] - Product slug for which bundles need to be fetched.
127
+ * @property {string} [id] - Product uid
128
+ */
129
+ /**
130
+ * @typedef GetProductComparisonBySlugsParam
131
+ * @property {string[]} slug - A short, human-readable, URL-friendly identifier
132
+ * of a product. You can get slug value from the endpoint
133
+ * /service/application/catalog/v1.0/products/.
134
+ */
135
+ /**
136
+ * @typedef GetProductDetailBySlugParam
137
+ * @property {string} slug - A short, human-readable, URL-friendly identifier of
138
+ * a product. You can get slug value from the endpoint
139
+ * /service/application/catalog/v1.0/products/
140
+ */
141
+ /**
142
+ * @typedef GetProductPriceBySlugParam
143
+ * @property {string} slug - A short, human-readable, URL-friendly identifier of
144
+ * a product. You can get slug value from the endpoint
145
+ * /service/application/catalog/v1.0/products/
146
+ * @property {string} size - A string indicating the size of the product, e.g.
147
+ * S, M, XL. You can get slug value from the endpoint
148
+ * /service/application/catalog/v1.0/products/sizes
149
+ * @property {number} [storeId] - The ID of the store that is selling the
150
+ * product, e.g. 1,2,3.
151
+ * @property {string} [pincode] - The PIN Code of the area near which the
152
+ * selling locations should be searched, e.g. 400059.
153
+ * @property {number} [moq] - An Integer indication the Minimum Order Quantity
154
+ * of a product, e.g. 100.
155
+ */
156
+ /**
157
+ * @typedef GetProductSellersBySlugParam
158
+ * @property {string} slug - A short, human-readable, URL-friendly identifier of
159
+ * a product. You can get slug value from the endpoint
160
+ * /service/application/catalog/v1.0/products/
161
+ * @property {string} size - A string indicating the size of the product, e.g.
162
+ * S, M, XL. You can get slug value from the endpoint
163
+ * /service/application/catalog/v1.0/products/sizes
164
+ * @property {string} [pincode] - The 6-digit PIN Code of the area near which
165
+ * the selling locations should be searched, e.g. 400059
166
+ * @property {string} [strategy] - Sort stores on the basis of strategy. eg,
167
+ * fast-delivery, low-price, optimal.
168
+ * @property {number} [pageNo] - The page number to navigate through the given
169
+ * set of results.
170
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
171
+ */
172
+ /**
173
+ * @typedef GetProductSizesBySlugParam
174
+ * @property {string} slug - A short, human-readable, URL-friendly identifier of
175
+ * a product. You can get slug value from the endpoint
176
+ * /service/application/catalog/v1.0/products/
177
+ * @property {number} [storeId] - The ID of the store that is selling the
178
+ * product, e.g. 1,2,3.
179
+ */
180
+ /**
181
+ * @typedef GetProductStockByIdsParam
182
+ * @property {string} [itemId] - The Item ID of the product (Max. 50 allowed)
183
+ * @property {string} [alu] - ALU of the product (limited upto 50 ALU identifier
184
+ * in a single request)
185
+ * @property {string} [skuCode] - Stock-keeping Unit of the product (limited
186
+ * upto 50 SKU Code in a single request)
187
+ * @property {string} [ean] - European Article Number of the product (limited
188
+ * upto 50 EAN identifier in a single request)
189
+ * @property {string} [upc] - Universal Product Code of the product (limited
190
+ * upto 50 UPC identifier in a single request)
191
+ */
192
+ /**
193
+ * @typedef GetProductStockForTimeByIdsParam
194
+ * @property {string} timestamp - Timestamp in UTC format (2020-07-23T10:27:50Z)
195
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
196
+ * @property {string} [pageId] - Page ID to retrieve next set of results.
197
+ */
198
+ /**
199
+ * @typedef GetProductVariantsBySlugParam
200
+ * @property {string} slug - A short, human-readable, URL-friendly identifier of
201
+ * a product. You can get slug value from the endpoint
202
+ * /service/application/catalog/v1.0/products/
203
+ */
204
+ /**
205
+ * @typedef GetProductsParam
206
+ * @property {string} [q] - The search query for entering partial or full name
207
+ * of product, brand, category, or collection.
208
+ * @property {string} [f] - The search filter parameters. Filter parameters will
209
+ * be passed in f parameter as shown in the example below. Double Pipe (||)
210
+ * denotes the OR condition, whereas Triple-colon (:::) indicates a new filter
211
+ * paramater applied as an AND condition.
212
+ * @property {boolean} [filters] - This is a boolean value, True for fetching
213
+ * all filter parameters and False for disabling the filter parameters.
214
+ * @property {string} [sortOn] - The order in which the list of products should
215
+ * be sorted, e.g. popularity, price, latest and discount, in either ascending
216
+ * or descending order. See the supported values below.
217
+ * @property {string} [pageId] - Page ID to retrieve next set of results.
218
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
219
+ * @property {number} [pageNo] - The page number to navigate through the given
220
+ * set of results.
221
+ * @property {string} [pageType] - Available pagination types are cursor or number.
222
+ */
223
+ /**
224
+ * @typedef GetSearchResultsParam
225
+ * @property {string} q - The search query for entering partial or full name of
226
+ * a product, brand or category. For example, if the given search query `q` is
227
+ * _ski_, the relevant search suggestions could be _skirt_, _ski shoes_,
228
+ * __skin cream_ etc.
229
+ */
230
+ /**
231
+ * @typedef GetSimilarComparisonProductBySlugParam
232
+ * @property {string} slug - A short, human-readable, URL-friendly identifier of
233
+ * a product. You can get slug value from the endpoint
234
+ * /service/application/catalog/v1.0/products/
235
+ */
236
+ /**
237
+ * @typedef GetStoresParam
238
+ * @property {number} [pageNo] - The page number to navigate through the given
239
+ * set of results.
240
+ * @property {number} [pageSize] - Number of items to retrieve in each page.
241
+ * @property {string} [q] - Search a store by its name or store_code.
242
+ * @property {string} [city] - Search stores by the city in which they are situated.
243
+ * @property {number} [range] - Use this to retrieve stores within a particular
244
+ * range in meters, e.g. 10000, to indicate a 10km range
245
+ * @property {number} [latitude] - Latitude of the location from where one wants
246
+ * to retreive the nearest stores, e.g. 72.8691788
247
+ * @property {number} [longitude] - Longitude of the location from where one
248
+ * wants to retreive the nearest stores, e.g. 19.1174114
249
+ */
250
+ /**
251
+ * @typedef UnfollowByIdParam
252
+ * @property {string} collectionType - Type of collection followed, i.e.
253
+ * products, brands, or collections.
254
+ * @property {string} collectionId - The ID of the collection type.
255
+ */
256
+ declare class CatalogApplicationValidator {
257
+ /** @returns {FollowByIdParam} */
258
+ static followById(): FollowByIdParam;
259
+ /** @returns {GetBrandDetailBySlugParam} */
260
+ static getBrandDetailBySlug(): GetBrandDetailBySlugParam;
261
+ /** @returns {GetBrandsParam} */
262
+ static getBrands(): GetBrandsParam;
263
+ /** @returns {GetCategoriesParam} */
264
+ static getCategories(): GetCategoriesParam;
265
+ /** @returns {GetCategoryDetailBySlugParam} */
266
+ static getCategoryDetailBySlug(): GetCategoryDetailBySlugParam;
267
+ /** @returns {GetCollectionDetailBySlugParam} */
268
+ static getCollectionDetailBySlug(): GetCollectionDetailBySlugParam;
269
+ /** @returns {GetCollectionItemsBySlugParam} */
270
+ static getCollectionItemsBySlug(): GetCollectionItemsBySlugParam;
271
+ /** @returns {GetCollectionsParam} */
272
+ static getCollections(): GetCollectionsParam;
273
+ /** @returns {GetComparedFrequentlyProductBySlugParam} */
274
+ static getComparedFrequentlyProductBySlug(): GetComparedFrequentlyProductBySlugParam;
275
+ /** @returns {GetDepartmentsParam} */
12
276
  static getDepartments(): any;
13
- static getFollowIds(): any;
14
- static getFollowedListing(): any;
15
- static getFollowerCountById(): any;
16
- static getHomeProducts(): any;
17
- static getInStockLocations(): any;
18
- static getLocationDetailsById(): any;
19
- static getProductBundlesBySlug(): any;
20
- static getProductComparisonBySlugs(): any;
21
- static getProductDetailBySlug(): any;
22
- static getProductPriceBySlug(): any;
23
- static getProductSellersBySlug(): any;
24
- static getProductSizesBySlug(): any;
25
- static getProductStockByIds(): any;
26
- static getProductStockForTimeByIds(): any;
27
- static getProductVariantsBySlug(): any;
28
- static getProducts(): any;
29
- static getSearchResults(): any;
30
- static getSimilarComparisonProductBySlug(): any;
31
- static getStores(): any;
32
- static unfollowById(): any;
277
+ /** @returns {GetFollowIdsParam} */
278
+ static getFollowIds(): GetFollowIdsParam;
279
+ /** @returns {GetFollowedListingParam} */
280
+ static getFollowedListing(): GetFollowedListingParam;
281
+ /** @returns {GetFollowerCountByIdParam} */
282
+ static getFollowerCountById(): GetFollowerCountByIdParam;
283
+ /** @returns {GetHomeProductsParam} */
284
+ static getHomeProducts(): GetHomeProductsParam;
285
+ /** @returns {GetInStockLocationsParam} */
286
+ static getInStockLocations(): GetInStockLocationsParam;
287
+ /** @returns {GetLocationDetailsByIdParam} */
288
+ static getLocationDetailsById(): GetLocationDetailsByIdParam;
289
+ /** @returns {GetProductBundlesBySlugParam} */
290
+ static getProductBundlesBySlug(): GetProductBundlesBySlugParam;
291
+ /** @returns {GetProductComparisonBySlugsParam} */
292
+ static getProductComparisonBySlugs(): GetProductComparisonBySlugsParam;
293
+ /** @returns {GetProductDetailBySlugParam} */
294
+ static getProductDetailBySlug(): GetProductDetailBySlugParam;
295
+ /** @returns {GetProductPriceBySlugParam} */
296
+ static getProductPriceBySlug(): GetProductPriceBySlugParam;
297
+ /** @returns {GetProductSellersBySlugParam} */
298
+ static getProductSellersBySlug(): GetProductSellersBySlugParam;
299
+ /** @returns {GetProductSizesBySlugParam} */
300
+ static getProductSizesBySlug(): GetProductSizesBySlugParam;
301
+ /** @returns {GetProductStockByIdsParam} */
302
+ static getProductStockByIds(): GetProductStockByIdsParam;
303
+ /** @returns {GetProductStockForTimeByIdsParam} */
304
+ static getProductStockForTimeByIds(): GetProductStockForTimeByIdsParam;
305
+ /** @returns {GetProductVariantsBySlugParam} */
306
+ static getProductVariantsBySlug(): GetProductVariantsBySlugParam;
307
+ /** @returns {GetProductsParam} */
308
+ static getProducts(): GetProductsParam;
309
+ /** @returns {GetSearchResultsParam} */
310
+ static getSearchResults(): GetSearchResultsParam;
311
+ /** @returns {GetSimilarComparisonProductBySlugParam} */
312
+ static getSimilarComparisonProductBySlug(): GetSimilarComparisonProductBySlugParam;
313
+ /** @returns {GetStoresParam} */
314
+ static getStores(): GetStoresParam;
315
+ /** @returns {UnfollowByIdParam} */
316
+ static unfollowById(): UnfollowByIdParam;
33
317
  }
318
+ declare namespace CatalogApplicationValidator {
319
+ export { FollowByIdParam, GetBrandDetailBySlugParam, GetBrandsParam, GetCategoriesParam, GetCategoryDetailBySlugParam, GetCollectionDetailBySlugParam, GetCollectionItemsBySlugParam, GetCollectionsParam, GetComparedFrequentlyProductBySlugParam, GetDepartmentsParam, GetFollowIdsParam, GetFollowedListingParam, GetFollowerCountByIdParam, GetHomeProductsParam, GetInStockLocationsParam, GetLocationDetailsByIdParam, GetProductBundlesBySlugParam, GetProductComparisonBySlugsParam, GetProductDetailBySlugParam, GetProductPriceBySlugParam, GetProductSellersBySlugParam, GetProductSizesBySlugParam, GetProductStockByIdsParam, GetProductStockForTimeByIdsParam, GetProductVariantsBySlugParam, GetProductsParam, GetSearchResultsParam, GetSimilarComparisonProductBySlugParam, GetStoresParam, UnfollowByIdParam };
320
+ }
321
+ type FollowByIdParam = {
322
+ /**
323
+ * - Type of collection followed, i.e.
324
+ * products, brands, or collections.
325
+ */
326
+ collectionType: string;
327
+ /**
328
+ * - The ID of the collection type.
329
+ */
330
+ collectionId: string;
331
+ };
332
+ type GetBrandDetailBySlugParam = {
333
+ /**
334
+ * - A short, human-readable, URL-friendly identifier of
335
+ * a brand. You can get slug value from the endpoint
336
+ * /service/application/catalog/v1.0/brands/.
337
+ */
338
+ slug: string;
339
+ };
340
+ type GetBrandsParam = {
341
+ /**
342
+ * - The name of the department. Use this
343
+ * parameter to filter products by a particular department. See the list of
344
+ * available departments below. Also, you can get available departments from
345
+ * the endpoint /service/application/catalog/v1.0/departments/
346
+ */
347
+ department?: string;
348
+ /**
349
+ * - The page number to navigate through the given
350
+ * set of results.
351
+ */
352
+ pageNo?: number;
353
+ /**
354
+ * - The number of items to retrieve in each page.
355
+ */
356
+ pageSize?: number;
357
+ };
358
+ type GetCategoriesParam = {
359
+ /**
360
+ * - The name of the department. Use this
361
+ * parameter to filter products by a particular department. See the list of
362
+ * available departments below. Also, you can get available departments from
363
+ * the endpoint /service/application/catalog/v1.0/departments/
364
+ */
365
+ department?: string;
366
+ };
367
+ type GetCategoryDetailBySlugParam = {
368
+ /**
369
+ * - A short, human-readable, URL-friendly identifier of
370
+ * a brand. You can get slug value from the endpoint
371
+ * /service/application/catalog/v1.0/brands/.
372
+ */
373
+ slug: string;
374
+ };
375
+ type GetCollectionDetailBySlugParam = {
376
+ /**
377
+ * - A short, human-readable, URL-friendly identifier of
378
+ * a collection. You can get slug value from the endpoint
379
+ * /service/application/catalog/v1.0/collections/.
380
+ */
381
+ slug: string;
382
+ };
383
+ type GetCollectionItemsBySlugParam = {
384
+ /**
385
+ * - A short, human-readable, URL-friendly identifier of
386
+ * a collection. You can get slug value from the endpoint
387
+ * /service/application/catalog/v1.0/collections/.
388
+ */
389
+ slug: string;
390
+ /**
391
+ * - The search filter parameters. Filter parameters will
392
+ * be passed in f parameter as shown in the example below. Double Pipe (||)
393
+ * denotes the OR condition, whereas Triple-colon (:::) indicates a new filter
394
+ * paramater applied as an AND condition.
395
+ */
396
+ f?: string;
397
+ /**
398
+ * - The search query for entering partial or full name
399
+ * of product, brand, category, or collection.
400
+ */
401
+ q?: string;
402
+ /**
403
+ * - This is a boolean value, True for fetching
404
+ * all filter parameters and False for disabling the filter parameters.
405
+ */
406
+ filters?: boolean;
407
+ /**
408
+ * - The order in which the list of products should
409
+ * be sorted, e.g. popularity, price, latest and discount, in either ascending
410
+ * or descending order. See the supported values below.
411
+ */
412
+ sortOn?: string;
413
+ /**
414
+ * - Page ID to retrieve next set of results.
415
+ */
416
+ pageId?: string;
417
+ /**
418
+ * - The number of items to retrieve in each page.
419
+ */
420
+ pageSize?: number;
421
+ /**
422
+ * - Page Number to retrieve next set of results.
423
+ */
424
+ pageNo?: number;
425
+ /**
426
+ * - Page Type to retrieve set of results can be
427
+ * cursor or number.
428
+ */
429
+ pageType?: string;
430
+ };
431
+ type GetCollectionsParam = {
432
+ /**
433
+ * - The page number to navigate through the given
434
+ * set of results.
435
+ */
436
+ pageNo?: number;
437
+ /**
438
+ * - The number of items to retrieve in each page.
439
+ */
440
+ pageSize?: number;
441
+ /**
442
+ * - List of tags to filter collections
443
+ */
444
+ tag?: string[];
445
+ /**
446
+ * - Name of the collection to filter collection
447
+ */
448
+ q?: string;
449
+ };
450
+ type GetComparedFrequentlyProductBySlugParam = {
451
+ /**
452
+ * - A short, human-readable, URL-friendly identifier of
453
+ * a product. You can get slug value from the endpoint
454
+ * /service/application/catalog/v1.0/products/
455
+ */
456
+ slug: string;
457
+ };
458
+ type GetFollowIdsParam = {
459
+ /**
460
+ * - Type of collection, i.e. products,
461
+ * brands, collections.
462
+ */
463
+ collectionType?: string;
464
+ };
465
+ type GetFollowedListingParam = {
466
+ /**
467
+ * - Type of collection followed, i.e.
468
+ * products, brands, or collections.
469
+ */
470
+ collectionType: string;
471
+ /**
472
+ * - Page ID to retrieve next set of results.
473
+ */
474
+ pageId?: string;
475
+ /**
476
+ * - Page ID to retrieve next set of results.
477
+ */
478
+ pageSize?: number;
479
+ };
480
+ type GetFollowerCountByIdParam = {
481
+ /**
482
+ * - Type of collection, i.e. products,
483
+ * brands, or collections.
484
+ */
485
+ collectionType: string;
486
+ /**
487
+ * - The ID of the collection type.
488
+ */
489
+ collectionId: string;
490
+ };
491
+ type GetHomeProductsParam = {
492
+ /**
493
+ * - The order in which the list of products should
494
+ * be sorted, e.g. popularity, price, latest and discount, in either ascending
495
+ * or descending order.
496
+ */
497
+ sortOn?: string;
498
+ /**
499
+ * - Page ID to retrieve next set of results.
500
+ */
501
+ pageId?: string;
502
+ /**
503
+ * - The number of items to retrieve in each page.
504
+ */
505
+ pageSize?: number;
506
+ };
507
+ type GetInStockLocationsParam = {
508
+ /**
509
+ * - The page number to navigate through the given
510
+ * set of results.
511
+ */
512
+ pageNo?: number;
513
+ /**
514
+ * - Number of items to retrieve in each page.
515
+ */
516
+ pageSize?: number;
517
+ /**
518
+ * - Search a store by its name or store_code.
519
+ */
520
+ q?: string;
521
+ /**
522
+ * - Search stores by the city in which they are situated.
523
+ */
524
+ city?: string;
525
+ /**
526
+ * - Use this to retrieve stores within a particular
527
+ * range in meters, e.g. 10000, to indicate a 10km range
528
+ */
529
+ range?: number;
530
+ /**
531
+ * - Latitude of the location from where one wants
532
+ * to retreive the nearest stores, e.g. 72.8691788
533
+ */
534
+ latitude?: number;
535
+ /**
536
+ * - Longitude of the location from where one
537
+ * wants to retreive the nearest stores, e.g. 19.1174114
538
+ */
539
+ longitude?: number;
540
+ };
541
+ type GetLocationDetailsByIdParam = {
542
+ /**
543
+ * - Unique Location ID.
544
+ */
545
+ locationId: number;
546
+ };
547
+ type GetProductBundlesBySlugParam = {
548
+ /**
549
+ * - Product slug for which bundles need to be fetched.
550
+ */
551
+ slug?: string;
552
+ /**
553
+ * - Product uid
554
+ */
555
+ id?: string;
556
+ };
557
+ type GetProductComparisonBySlugsParam = {
558
+ /**
559
+ * - A short, human-readable, URL-friendly identifier
560
+ * of a product. You can get slug value from the endpoint
561
+ * /service/application/catalog/v1.0/products/.
562
+ */
563
+ slug: string[];
564
+ };
565
+ type GetProductDetailBySlugParam = {
566
+ /**
567
+ * - A short, human-readable, URL-friendly identifier of
568
+ * a product. You can get slug value from the endpoint
569
+ * /service/application/catalog/v1.0/products/
570
+ */
571
+ slug: string;
572
+ };
573
+ type GetProductPriceBySlugParam = {
574
+ /**
575
+ * - A short, human-readable, URL-friendly identifier of
576
+ * a product. You can get slug value from the endpoint
577
+ * /service/application/catalog/v1.0/products/
578
+ */
579
+ slug: string;
580
+ /**
581
+ * - A string indicating the size of the product, e.g.
582
+ * S, M, XL. You can get slug value from the endpoint
583
+ * /service/application/catalog/v1.0/products/sizes
584
+ */
585
+ size: string;
586
+ /**
587
+ * - The ID of the store that is selling the
588
+ * product, e.g. 1,2,3.
589
+ */
590
+ storeId?: number;
591
+ /**
592
+ * - The PIN Code of the area near which the
593
+ * selling locations should be searched, e.g. 400059.
594
+ */
595
+ pincode?: string;
596
+ /**
597
+ * - An Integer indication the Minimum Order Quantity
598
+ * of a product, e.g. 100.
599
+ */
600
+ moq?: number;
601
+ };
602
+ type GetProductSellersBySlugParam = {
603
+ /**
604
+ * - A short, human-readable, URL-friendly identifier of
605
+ * a product. You can get slug value from the endpoint
606
+ * /service/application/catalog/v1.0/products/
607
+ */
608
+ slug: string;
609
+ /**
610
+ * - A string indicating the size of the product, e.g.
611
+ * S, M, XL. You can get slug value from the endpoint
612
+ * /service/application/catalog/v1.0/products/sizes
613
+ */
614
+ size: string;
615
+ /**
616
+ * - The 6-digit PIN Code of the area near which
617
+ * the selling locations should be searched, e.g. 400059
618
+ */
619
+ pincode?: string;
620
+ /**
621
+ * - Sort stores on the basis of strategy. eg,
622
+ * fast-delivery, low-price, optimal.
623
+ */
624
+ strategy?: string;
625
+ /**
626
+ * - The page number to navigate through the given
627
+ * set of results.
628
+ */
629
+ pageNo?: number;
630
+ /**
631
+ * - The number of items to retrieve in each page.
632
+ */
633
+ pageSize?: number;
634
+ };
635
+ type GetProductSizesBySlugParam = {
636
+ /**
637
+ * - A short, human-readable, URL-friendly identifier of
638
+ * a product. You can get slug value from the endpoint
639
+ * /service/application/catalog/v1.0/products/
640
+ */
641
+ slug: string;
642
+ /**
643
+ * - The ID of the store that is selling the
644
+ * product, e.g. 1,2,3.
645
+ */
646
+ storeId?: number;
647
+ };
648
+ type GetProductStockByIdsParam = {
649
+ /**
650
+ * - The Item ID of the product (Max. 50 allowed)
651
+ */
652
+ itemId?: string;
653
+ /**
654
+ * - ALU of the product (limited upto 50 ALU identifier
655
+ * in a single request)
656
+ */
657
+ alu?: string;
658
+ /**
659
+ * - Stock-keeping Unit of the product (limited
660
+ * upto 50 SKU Code in a single request)
661
+ */
662
+ skuCode?: string;
663
+ /**
664
+ * - European Article Number of the product (limited
665
+ * upto 50 EAN identifier in a single request)
666
+ */
667
+ ean?: string;
668
+ /**
669
+ * - Universal Product Code of the product (limited
670
+ * upto 50 UPC identifier in a single request)
671
+ */
672
+ upc?: string;
673
+ };
674
+ type GetProductStockForTimeByIdsParam = {
675
+ /**
676
+ * - Timestamp in UTC format (2020-07-23T10:27:50Z)
677
+ */
678
+ timestamp: string;
679
+ /**
680
+ * - The number of items to retrieve in each page.
681
+ */
682
+ pageSize?: number;
683
+ /**
684
+ * - Page ID to retrieve next set of results.
685
+ */
686
+ pageId?: string;
687
+ };
688
+ type GetProductVariantsBySlugParam = {
689
+ /**
690
+ * - A short, human-readable, URL-friendly identifier of
691
+ * a product. You can get slug value from the endpoint
692
+ * /service/application/catalog/v1.0/products/
693
+ */
694
+ slug: string;
695
+ };
696
+ type GetProductsParam = {
697
+ /**
698
+ * - The search query for entering partial or full name
699
+ * of product, brand, category, or collection.
700
+ */
701
+ q?: string;
702
+ /**
703
+ * - The search filter parameters. Filter parameters will
704
+ * be passed in f parameter as shown in the example below. Double Pipe (||)
705
+ * denotes the OR condition, whereas Triple-colon (:::) indicates a new filter
706
+ * paramater applied as an AND condition.
707
+ */
708
+ f?: string;
709
+ /**
710
+ * - This is a boolean value, True for fetching
711
+ * all filter parameters and False for disabling the filter parameters.
712
+ */
713
+ filters?: boolean;
714
+ /**
715
+ * - The order in which the list of products should
716
+ * be sorted, e.g. popularity, price, latest and discount, in either ascending
717
+ * or descending order. See the supported values below.
718
+ */
719
+ sortOn?: string;
720
+ /**
721
+ * - Page ID to retrieve next set of results.
722
+ */
723
+ pageId?: string;
724
+ /**
725
+ * - The number of items to retrieve in each page.
726
+ */
727
+ pageSize?: number;
728
+ /**
729
+ * - The page number to navigate through the given
730
+ * set of results.
731
+ */
732
+ pageNo?: number;
733
+ /**
734
+ * - Available pagination types are cursor or number.
735
+ */
736
+ pageType?: string;
737
+ };
738
+ type GetSearchResultsParam = {
739
+ /**
740
+ * - The search query for entering partial or full name of
741
+ * a product, brand or category. For example, if the given search query `q` is
742
+ * _ski_, the relevant search suggestions could be _skirt_, _ski shoes_,
743
+ * __skin cream_ etc.
744
+ */
745
+ q: string;
746
+ };
747
+ type GetSimilarComparisonProductBySlugParam = {
748
+ /**
749
+ * - A short, human-readable, URL-friendly identifier of
750
+ * a product. You can get slug value from the endpoint
751
+ * /service/application/catalog/v1.0/products/
752
+ */
753
+ slug: string;
754
+ };
755
+ type GetStoresParam = {
756
+ /**
757
+ * - The page number to navigate through the given
758
+ * set of results.
759
+ */
760
+ pageNo?: number;
761
+ /**
762
+ * - Number of items to retrieve in each page.
763
+ */
764
+ pageSize?: number;
765
+ /**
766
+ * - Search a store by its name or store_code.
767
+ */
768
+ q?: string;
769
+ /**
770
+ * - Search stores by the city in which they are situated.
771
+ */
772
+ city?: string;
773
+ /**
774
+ * - Use this to retrieve stores within a particular
775
+ * range in meters, e.g. 10000, to indicate a 10km range
776
+ */
777
+ range?: number;
778
+ /**
779
+ * - Latitude of the location from where one wants
780
+ * to retreive the nearest stores, e.g. 72.8691788
781
+ */
782
+ latitude?: number;
783
+ /**
784
+ * - Longitude of the location from where one
785
+ * wants to retreive the nearest stores, e.g. 19.1174114
786
+ */
787
+ longitude?: number;
788
+ };
789
+ type UnfollowByIdParam = {
790
+ /**
791
+ * - Type of collection followed, i.e.
792
+ * products, brands, or collections.
793
+ */
794
+ collectionType: string;
795
+ /**
796
+ * - The ID of the collection type.
797
+ */
798
+ collectionId: string;
799
+ };
800
+ type GetDepartmentsParam = any;