@gofynd/fdk-client-javascript 1.0.1 → 1.0.3

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 (318) hide show
  1. package/documentation/application/CART.md +5934 -4502
  2. package/documentation/application/CATALOG.md +6338 -7245
  3. package/documentation/application/COMMON.md +95 -222
  4. package/documentation/application/COMMUNICATION.md +106 -186
  5. package/documentation/application/CONFIGURATION.md +903 -1597
  6. package/documentation/application/CONTENT.md +562 -1270
  7. package/documentation/application/FILESTORAGE.md +84 -220
  8. package/documentation/application/LEAD.md +314 -660
  9. package/documentation/application/LOGISTIC.md +229 -305
  10. package/documentation/application/ORDER.md +642 -1137
  11. package/documentation/application/PAYMENT.md +2285 -3031
  12. package/documentation/application/POSCART.md +6079 -4642
  13. package/documentation/application/REWARDS.md +94 -248
  14. package/documentation/application/SHARE.md +152 -250
  15. package/documentation/application/THEME.md +952 -1235
  16. package/documentation/application/USER.md +1228 -1765
  17. package/documentation/platform/ANALYTICS.md +207 -349
  18. package/documentation/platform/AUDITTRAIL.md +121 -204
  19. package/documentation/platform/BILLING.md +865 -1376
  20. package/documentation/platform/CART.md +2814 -3662
  21. package/documentation/platform/CATALOG.md +15266 -17619
  22. package/documentation/platform/COMMON.md +95 -222
  23. package/documentation/platform/COMMUNICATION.md +1632 -2380
  24. package/documentation/platform/COMPANYPROFILE.md +572 -957
  25. package/documentation/platform/CONFIGURATION.md +3050 -4073
  26. package/documentation/platform/CONTENT.md +3509 -4121
  27. package/documentation/platform/DISCOUNT.md +140 -236
  28. package/documentation/platform/FILESTORAGE.md +187 -323
  29. package/documentation/platform/INVENTORY.md +268 -911
  30. package/documentation/platform/LEAD.md +2195 -2541
  31. package/documentation/platform/ORDER.md +3750 -5636
  32. package/documentation/platform/PARTNER.md +9 -36
  33. package/documentation/platform/PAYMENT.md +903 -1213
  34. package/documentation/platform/REWARDS.md +183 -347
  35. package/documentation/platform/SHARE.md +120 -213
  36. package/documentation/platform/THEME.md +12956 -13239
  37. package/documentation/platform/USER.md +975 -1120
  38. package/documentation/platform/WEBHOOK.md +78 -184
  39. package/documentation/public/CONFIGURATION.md +95 -222
  40. package/documentation/public/INVENTORY.md +100 -282
  41. package/documentation/public/WEBHOOK.md +27 -133
  42. package/package.json +1 -1
  43. package/sdk/application/ApplicationConfig.js +1 -1
  44. package/sdk/application/Cart/CartApplicationClient.d.ts +243 -243
  45. package/sdk/application/Cart/CartApplicationClient.js +1058 -547
  46. package/sdk/application/Cart/CartApplicationModel.d.ts +64 -63
  47. package/sdk/application/Cart/CartApplicationModel.js +489 -886
  48. package/sdk/application/Cart/CartApplicationValidator.d.ts +17 -17
  49. package/sdk/application/Cart/CartApplicationValidator.js +98 -98
  50. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +358 -358
  51. package/sdk/application/Catalog/CatalogApplicationClient.js +1545 -949
  52. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +90 -90
  53. package/sdk/application/Catalog/CatalogApplicationModel.js +692 -1258
  54. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +19 -19
  55. package/sdk/application/Catalog/CatalogApplicationValidator.js +110 -110
  56. package/sdk/application/Common/CommonApplicationClient.d.ts +13 -13
  57. package/sdk/application/Common/CommonApplicationClient.js +76 -36
  58. package/sdk/application/Common/CommonApplicationModel.d.ts +12 -12
  59. package/sdk/application/Common/CommonApplicationModel.js +83 -160
  60. package/sdk/application/Common/CommonApplicationValidator.d.ts +1 -1
  61. package/sdk/application/Common/CommonApplicationValidator.js +6 -6
  62. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +11 -11
  63. package/sdk/application/Communication/CommunicationApplicationClient.js +92 -31
  64. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +6 -6
  65. package/sdk/application/Communication/CommunicationApplicationModel.js +38 -83
  66. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
  67. package/sdk/application/Communication/CommunicationApplicationValidator.js +4 -4
  68. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +116 -116
  69. package/sdk/application/Configuration/ConfigurationApplicationClient.js +638 -312
  70. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +85 -85
  71. package/sdk/application/Configuration/ConfigurationApplicationModel.js +480 -851
  72. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +8 -8
  73. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +33 -33
  74. package/sdk/application/Content/ContentApplicationClient.d.ts +67 -67
  75. package/sdk/application/Content/ContentApplicationClient.js +581 -213
  76. package/sdk/application/Content/ContentApplicationModel.d.ts +76 -75
  77. package/sdk/application/Content/ContentApplicationModel.js +468 -875
  78. package/sdk/application/Content/ContentApplicationValidator.d.ts +5 -5
  79. package/sdk/application/Content/ContentApplicationValidator.js +24 -24
  80. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +25 -25
  81. package/sdk/application/FileStorage/FileStorageApplicationClient.js +121 -59
  82. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +13 -13
  83. package/sdk/application/FileStorage/FileStorageApplicationModel.js +86 -169
  84. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +1 -1
  85. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +7 -7
  86. package/sdk/application/Lead/LeadApplicationClient.d.ts +24 -24
  87. package/sdk/application/Lead/LeadApplicationClient.js +230 -96
  88. package/sdk/application/Lead/LeadApplicationModel.d.ts +35 -35
  89. package/sdk/application/Lead/LeadApplicationModel.js +267 -474
  90. package/sdk/application/Lead/LeadApplicationValidator.d.ts +2 -2
  91. package/sdk/application/Lead/LeadApplicationValidator.js +11 -11
  92. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +30 -19
  93. package/sdk/application/Logistic/LogisticApplicationClient.js +196 -47
  94. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +17 -14
  95. package/sdk/application/Logistic/LogisticApplicationModel.js +133 -201
  96. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +3 -2
  97. package/sdk/application/Logistic/LogisticApplicationValidator.js +14 -8
  98. package/sdk/application/Order/OrderApplicationClient.d.ts +86 -86
  99. package/sdk/application/Order/OrderApplicationClient.js +448 -215
  100. package/sdk/application/Order/OrderApplicationModel.d.ts +50 -50
  101. package/sdk/application/Order/OrderApplicationModel.js +357 -661
  102. package/sdk/application/Order/OrderApplicationValidator.d.ts +7 -7
  103. package/sdk/application/Order/OrderApplicationValidator.js +28 -28
  104. package/sdk/application/Payment/PaymentApplicationClient.d.ts +318 -318
  105. package/sdk/application/Payment/PaymentApplicationClient.js +1525 -750
  106. package/sdk/application/Payment/PaymentApplicationModel.d.ts +72 -72
  107. package/sdk/application/Payment/PaymentApplicationModel.js +565 -1033
  108. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +28 -28
  109. package/sdk/application/Payment/PaymentApplicationValidator.js +107 -107
  110. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +254 -254
  111. package/sdk/application/PosCart/PosCartApplicationClient.js +1137 -606
  112. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +61 -60
  113. package/sdk/application/PosCart/PosCartApplicationModel.js +477 -873
  114. package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +18 -18
  115. package/sdk/application/PosCart/PosCartApplicationValidator.js +103 -103
  116. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +27 -27
  117. package/sdk/application/Rewards/RewardsApplicationClient.js +253 -113
  118. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +14 -14
  119. package/sdk/application/Rewards/RewardsApplicationModel.js +96 -191
  120. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +3 -3
  121. package/sdk/application/Rewards/RewardsApplicationValidator.js +12 -12
  122. package/sdk/application/Share/ShareApplicationClient.d.ts +37 -37
  123. package/sdk/application/Share/ShareApplicationClient.js +221 -96
  124. package/sdk/application/Share/ShareApplicationModel.d.ts +8 -8
  125. package/sdk/application/Share/ShareApplicationModel.js +63 -123
  126. package/sdk/application/Share/ShareApplicationValidator.d.ts +4 -4
  127. package/sdk/application/Share/ShareApplicationValidator.js +12 -12
  128. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
  129. package/sdk/application/Theme/ThemeApplicationClient.js +115 -37
  130. package/sdk/application/Theme/ThemeApplicationModel.d.ts +34 -34
  131. package/sdk/application/Theme/ThemeApplicationModel.js +190 -336
  132. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +1 -1
  133. package/sdk/application/Theme/ThemeApplicationValidator.js +4 -4
  134. package/sdk/application/User/UserApplicationClient.d.ts +280 -280
  135. package/sdk/application/User/UserApplicationClient.js +1201 -543
  136. package/sdk/application/User/UserApplicationModel.d.ts +79 -72
  137. package/sdk/application/User/UserApplicationModel.js +440 -689
  138. package/sdk/application/User/UserApplicationValidator.d.ts +24 -24
  139. package/sdk/application/User/UserApplicationValidator.js +89 -89
  140. package/sdk/common/AxiosHelper.js +1 -1
  141. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +55 -47
  142. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +308 -151
  143. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +6 -6
  144. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +20 -20
  145. package/sdk/platform/Analytics/AnalyticsPlatformClient.d.ts +8 -4
  146. package/sdk/platform/Analytics/AnalyticsPlatformClient.js +103 -16
  147. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +11 -11
  148. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +95 -178
  149. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +16 -12
  150. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +131 -44
  151. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +10 -10
  152. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +50 -89
  153. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -1
  154. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +6 -6
  155. package/sdk/platform/Billing/BillingPlatformClient.d.ts +68 -56
  156. package/sdk/platform/Billing/BillingPlatformClient.js +416 -171
  157. package/sdk/platform/Billing/BillingPlatformModel.d.ts +40 -40
  158. package/sdk/platform/Billing/BillingPlatformModel.js +342 -668
  159. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +8 -8
  160. package/sdk/platform/Billing/BillingPlatformValidator.js +25 -25
  161. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +176 -159
  162. package/sdk/platform/Cart/CartPlatformApplicationClient.js +837 -500
  163. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +11 -11
  164. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +63 -63
  165. package/sdk/platform/Cart/CartPlatformModel.d.ts +86 -85
  166. package/sdk/platform/Cart/CartPlatformModel.js +677 -1211
  167. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +582 -529
  168. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2642 -1533
  169. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +40 -40
  170. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +175 -175
  171. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +708 -590
  172. package/sdk/platform/Catalog/CatalogPlatformClient.js +3103 -1362
  173. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +293 -284
  174. package/sdk/platform/Catalog/CatalogPlatformModel.js +2149 -3660
  175. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +66 -64
  176. package/sdk/platform/Catalog/CatalogPlatformValidator.js +235 -216
  177. package/sdk/platform/Common/CommonPlatformClient.d.ts +14 -12
  178. package/sdk/platform/Common/CommonPlatformClient.js +80 -37
  179. package/sdk/platform/Common/CommonPlatformModel.d.ts +12 -12
  180. package/sdk/platform/Common/CommonPlatformModel.js +83 -160
  181. package/sdk/platform/Common/CommonPlatformValidator.d.ts +1 -1
  182. package/sdk/platform/Common/CommonPlatformValidator.js +6 -6
  183. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +333 -293
  184. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +1687 -855
  185. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +30 -30
  186. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +87 -87
  187. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -1
  188. package/sdk/platform/Communication/CommunicationPlatformClient.js +28 -4
  189. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +67 -67
  190. package/sdk/platform/Communication/CommunicationPlatformModel.js +522 -974
  191. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +70 -57
  192. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +463 -182
  193. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +28 -28
  194. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +294 -557
  195. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +7 -7
  196. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +24 -24
  197. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +175 -137
  198. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1168 -521
  199. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +22 -21
  200. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +69 -63
  201. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +137 -119
  202. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +691 -316
  203. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +148 -146
  204. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +854 -1508
  205. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -9
  206. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +38 -38
  207. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +542 -461
  208. package/sdk/platform/Content/ContentPlatformApplicationClient.js +2600 -1160
  209. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +50 -49
  210. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +159 -152
  211. package/sdk/platform/Content/ContentPlatformModel.d.ts +79 -75
  212. package/sdk/platform/Content/ContentPlatformModel.js +486 -867
  213. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +72 -61
  214. package/sdk/platform/Discount/DiscountPlatformClient.js +424 -198
  215. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +7 -7
  216. package/sdk/platform/Discount/DiscountPlatformModel.js +60 -121
  217. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +6 -6
  218. package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -29
  219. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +26 -22
  220. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +145 -59
  221. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
  222. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +8 -8
  223. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +58 -52
  224. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +240 -114
  225. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -13
  226. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +86 -169
  227. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +3 -3
  228. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +11 -11
  229. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +76 -63
  230. package/sdk/platform/Inventory/InventoryPlatformClient.js +461 -197
  231. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +30 -30
  232. package/sdk/platform/Inventory/InventoryPlatformModel.js +497 -964
  233. package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +7 -7
  234. package/sdk/platform/Inventory/InventoryPlatformValidator.js +28 -28
  235. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +84 -71
  236. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +441 -182
  237. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +7 -7
  238. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +28 -28
  239. package/sdk/platform/Lead/LeadPlatformClient.d.ts +86 -75
  240. package/sdk/platform/Lead/LeadPlatformClient.js +434 -212
  241. package/sdk/platform/Lead/LeadPlatformModel.d.ts +35 -35
  242. package/sdk/platform/Lead/LeadPlatformModel.js +267 -474
  243. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +6 -6
  244. package/sdk/platform/Lead/LeadPlatformValidator.js +24 -24
  245. package/sdk/platform/OAuthClient.js +8 -8
  246. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +14 -11
  247. package/sdk/platform/Order/OrderPlatformApplicationClient.js +113 -49
  248. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -1
  249. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +6 -6
  250. package/sdk/platform/Order/OrderPlatformClient.d.ts +367 -315
  251. package/sdk/platform/Order/OrderPlatformClient.js +1775 -893
  252. package/sdk/platform/Order/OrderPlatformModel.d.ts +198 -192
  253. package/sdk/platform/Order/OrderPlatformModel.js +1591 -2822
  254. package/sdk/platform/Order/OrderPlatformValidator.d.ts +32 -32
  255. package/sdk/platform/Order/OrderPlatformValidator.js +160 -155
  256. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -2
  257. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +52 -8
  258. package/sdk/platform/Partner/PartnerPlatformModel.js +6 -22
  259. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +65 -54
  260. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +395 -164
  261. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +6 -6
  262. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +23 -23
  263. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +55 -45
  264. package/sdk/platform/Payment/PaymentPlatformClient.js +362 -147
  265. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +27 -27
  266. package/sdk/platform/Payment/PaymentPlatformModel.js +220 -408
  267. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +4 -4
  268. package/sdk/platform/Payment/PaymentPlatformValidator.js +21 -21
  269. package/sdk/platform/PlatformApplicationClient.d.ts +1496 -10153
  270. package/sdk/platform/PlatformApplicationClient.js +1584 -13691
  271. package/sdk/platform/PlatformClient.d.ts +7918 -7666
  272. package/sdk/platform/PlatformClient.js +8701 -9926
  273. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +91 -78
  274. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +507 -253
  275. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +8 -8
  276. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +34 -34
  277. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +15 -15
  278. package/sdk/platform/Rewards/RewardsPlatformModel.js +92 -194
  279. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +16 -12
  280. package/sdk/platform/Share/SharePlatformApplicationClient.js +130 -52
  281. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
  282. package/sdk/platform/Share/SharePlatformApplicationValidator.js +6 -6
  283. package/sdk/platform/Share/SharePlatformModel.d.ts +8 -8
  284. package/sdk/platform/Share/SharePlatformModel.js +60 -118
  285. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +148 -124
  286. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +770 -295
  287. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +15 -15
  288. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +44 -44
  289. package/sdk/platform/Theme/ThemePlatformModel.d.ts +34 -34
  290. package/sdk/platform/Theme/ThemePlatformModel.js +190 -336
  291. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +146 -67
  292. package/sdk/platform/User/UserPlatformApplicationClient.js +742 -155
  293. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +12 -7
  294. package/sdk/platform/User/UserPlatformApplicationValidator.js +61 -23
  295. package/sdk/platform/User/UserPlatformModel.d.ts +79 -72
  296. package/sdk/platform/User/UserPlatformModel.js +440 -689
  297. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +35 -29
  298. package/sdk/platform/Webhook/WebhookPlatformClient.js +218 -91
  299. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +7 -7
  300. package/sdk/platform/Webhook/WebhookPlatformModel.js +68 -136
  301. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +3 -3
  302. package/sdk/platform/Webhook/WebhookPlatformValidator.js +14 -14
  303. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +13 -13
  304. package/sdk/public/Configuration/ConfigurationPublicClient.js +81 -38
  305. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +12 -12
  306. package/sdk/public/Configuration/ConfigurationPublicModel.js +85 -162
  307. package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +1 -1
  308. package/sdk/public/Configuration/ConfigurationPublicValidator.js +6 -6
  309. package/sdk/public/Inventory/InventoryPublicClient.d.ts +34 -34
  310. package/sdk/public/Inventory/InventoryPublicClient.js +228 -105
  311. package/sdk/public/Inventory/InventoryPublicModel.d.ts +10 -10
  312. package/sdk/public/Inventory/InventoryPublicModel.js +119 -245
  313. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +3 -3
  314. package/sdk/public/Inventory/InventoryPublicValidator.js +15 -15
  315. package/sdk/public/Webhook/WebhookPublicClient.js +51 -10
  316. package/sdk/public/Webhook/WebhookPublicModel.d.ts +7 -7
  317. package/sdk/public/Webhook/WebhookPublicModel.js +68 -136
  318. package/tests/application/catalog.spec.js +7 -0
@@ -3,217 +3,64 @@ declare class Catalog {
3
3
  constructor(_conf: any);
4
4
  _conf: any;
5
5
  _relativeUrls: {
6
- getProductDetailBySlug: string;
7
- getProductSizesBySlug: string;
8
- getProductComparisonBySlugs: string;
9
- getSimilarComparisonProductBySlug: string;
10
- getComparedFrequentlyProductBySlug: string;
11
- getProductVariantsBySlug: string;
12
- getProductStockByIds: string;
13
- getProductStockForTimeByIds: string;
14
- getProducts: string;
15
- getBrands: string;
6
+ followById: string;
16
7
  getBrandDetailBySlug: string;
8
+ getBrands: string;
17
9
  getCategories: string;
18
10
  getCategoryDetailBySlug: string;
19
- getHomeProducts: string;
20
- getDepartments: string;
21
- getSearchResults: string;
22
- getCollections: string;
23
- getCollectionItemsBySlug: string;
24
11
  getCollectionDetailBySlug: string;
12
+ getCollectionItemsBySlug: string;
13
+ getCollections: string;
14
+ getComparedFrequentlyProductBySlug: string;
15
+ getDepartments: string;
16
+ getFollowIds: string;
25
17
  getFollowedListing: string;
26
- followById: string;
27
- unfollowById: string;
28
18
  getFollowerCountById: string;
29
- getFollowIds: string;
30
- getStores: string;
19
+ getHomeProducts: string;
31
20
  getInStockLocations: string;
32
21
  getLocationDetailsById: string;
33
22
  getProductBundlesBySlug: string;
23
+ getProductComparisonBySlugs: string;
24
+ getProductDetailBySlug: string;
34
25
  getProductPriceBySlug: string;
35
26
  getProductSellersBySlug: string;
27
+ getProductSizesBySlug: string;
28
+ getProductStockByIds: string;
29
+ getProductStockForTimeByIds: string;
30
+ getProductVariantsBySlug: string;
31
+ getProducts: string;
32
+ getSearchResults: string;
33
+ getSimilarComparisonProductBySlug: string;
34
+ getStores: string;
35
+ unfollowById: string;
36
36
  };
37
37
  _urls: {};
38
38
  updateUrls(urls: any): void;
39
39
  /**
40
40
  * @param {Object} arg - Arg object.
41
- * @param {string} arg.slug - A short, human-readable, URL-friendly
42
- * identifier of a product. You can get slug value from the endpoint
43
- * /service/application/catalog/v1.0/products/
44
- * @returns {Promise<ProductDetail>} - Success response
45
- * @summary: Get a product
46
- * @description: Use this API to retrieve a product by its slug value.
47
- */
48
- getProductDetailBySlug({ slug }?: {
49
- slug: string;
50
- }): Promise<ProductDetail>;
51
- /**
52
- * @param {Object} arg - Arg object.
53
- * @param {string} arg.slug - A short, human-readable, URL-friendly
54
- * identifier of a product. You can get slug value from the endpoint
55
- * /service/application/catalog/v1.0/products/
56
- * @param {number} [arg.storeId] - The ID of the store that is selling the
57
- * product, e.g. 1,2,3.
58
- * @returns {Promise<ProductSizes>} - Success response
59
- * @summary: Get the sizes of a product
60
- * @description: A product can have multiple sizes. Use this API to fetch all the available sizes of a product.
61
- */
62
- getProductSizesBySlug({ slug, storeId }?: {
63
- slug: string;
64
- storeId?: number;
65
- }): Promise<ProductSizes>;
66
- /**
67
- * @param {Object} arg - Arg object.
68
- * @param {string[]} arg.slug - A short, human-readable, URL-friendly
69
- * identifier of a product. You can get slug value from the endpoint
70
- * /service/application/catalog/v1.0/products/.
71
- * @returns {Promise<ProductsComparisonResponse>} - Success response
72
- * @summary: Compare products
73
- * @description: Use this API to compare the features of products belonging to the same category. Note that at least one slug is mandatory in the request query.
74
- */
75
- getProductComparisonBySlugs({ slug }?: {
76
- slug: string[];
77
- }): Promise<ProductsComparisonResponse>;
78
- /**
79
- * @param {Object} arg - Arg object.
80
- * @param {string} arg.slug - A short, human-readable, URL-friendly
81
- * identifier of a product. You can get slug value from the endpoint
82
- * /service/application/catalog/v1.0/products/
83
- * @returns {Promise<ProductCompareResponse>} - Success response
84
- * @summary: Get comparison between similar products
85
- * @description: Use this API to compare a given product automatically with similar products. Only one slug is needed.
86
- */
87
- getSimilarComparisonProductBySlug({ slug }?: {
88
- slug: string;
89
- }): Promise<ProductCompareResponse>;
90
- /**
91
- * @param {Object} arg - Arg object.
92
- * @param {string} arg.slug - A short, human-readable, URL-friendly
93
- * identifier of a product. You can get slug value from the endpoint
94
- * /service/application/catalog/v1.0/products/
95
- * @returns {Promise<ProductFrequentlyComparedSimilarResponse>} - Success response
96
- * @summary: Get comparison between frequently compared products with the given product
97
- * @description: Use this API to compare a given product automatically with products that are frequently compared with it. Only one slug is needed.
41
+ * @param {string} arg.collectionType - Type of collection followed, i.e.
42
+ * products, brands, or collections.
43
+ * @param {string} arg.collectionId - The ID of the collection type.
44
+ * @returns {Promise<FollowPostResponse>} - Success response
45
+ * @summary: Follow an entity (product/brand/collection)
46
+ * @description: Follow a particular entity such as product, brand, collection specified by its ID.
98
47
  */
99
- getComparedFrequentlyProductBySlug({ slug }?: {
100
- slug: string;
101
- }): Promise<ProductFrequentlyComparedSimilarResponse>;
48
+ followById({ collectionType, collectionId }?: {
49
+ collectionType: string;
50
+ collectionId: string;
51
+ }): Promise<FollowPostResponse>;
102
52
  /**
103
53
  * @param {Object} arg - Arg object.
104
54
  * @param {string} arg.slug - A short, human-readable, URL-friendly
105
- * identifier of a product. You can get slug value from the endpoint
106
- * /service/application/catalog/v1.0/products/
107
- * @returns {Promise<ProductVariantsResponse>} - Success response
108
- * @summary: Get variant of a particular product
109
- * @description: A product can have a different type of variants such as colour, shade, memory. Use this API to fetch all the available variants of a product using its slug.
55
+ * identifier of a brand. You can get slug value from the endpoint
56
+ * /service/application/catalog/v1.0/brands/.
57
+ * @returns {Promise<BrandDetailResponse>} - Success response
58
+ * @summary: Get metadata of a brand
59
+ * @description: Fetch metadata of a brand such as name, information, logo, banner, etc.
110
60
  */
111
- getProductVariantsBySlug({ slug }?: {
61
+ getBrandDetailBySlug({ slug }?: {
112
62
  slug: string;
113
- }): Promise<ProductVariantsResponse>;
114
- /**
115
- * @param {Object} arg - Arg object.
116
- * @param {string} [arg.itemId] - The Item ID of the product (Max. 50 allowed)
117
- * @param {string} [arg.alu] - ALU of the product (limited upto 50 ALU
118
- * identifier in a single request)
119
- * @param {string} [arg.skuCode] - Stock-keeping Unit of the product
120
- * (limited upto 50 SKU Code in a single request)
121
- * @param {string} [arg.ean] - European Article Number of the product
122
- * (limited upto 50 EAN identifier in a single request)
123
- * @param {string} [arg.upc] - Universal Product Code of the product
124
- * (limited upto 50 UPC identifier in a single request)
125
- * @returns {Promise<ProductStockStatusResponse>} - Success response
126
- * @summary: Get the stock of a product
127
- * @description: Retrieve the available stock of the products. Use this API to retrieve stock of multiple products (up to 50) at a time.
128
- */
129
- getProductStockByIds({ itemId, alu, skuCode, ean, upc }?: {
130
- itemId?: string;
131
- alu?: string;
132
- skuCode?: string;
133
- ean?: string;
134
- upc?: string;
135
- }): Promise<ProductStockStatusResponse>;
136
- /**
137
- * @param {Object} arg - Arg object.
138
- * @param {string} arg.timestamp - Timestamp in UTC format (2020-07-23T10:27:50Z)
139
- * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
140
- * @param {string} [arg.pageId] - Page ID to retrieve next set of results.
141
- * @returns {Promise<ProductStockPolling>} - Success response
142
- * @summary: Get the stock of a product
143
- * @description: Retrieve the available stock of the products. Use this API to get the stock status of products whose inventory is updated at the specified time
144
- */
145
- getProductStockForTimeByIds({ timestamp, pageSize, pageId }?: {
146
- timestamp: string;
147
- pageSize?: number;
148
- pageId?: string;
149
- }): Promise<ProductStockPolling>;
150
- /**
151
- * @param {Object} arg - Arg object.
152
- * @param {string} arg.timestamp - Timestamp in UTC format (2020-07-23T10:27:50Z)
153
- * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
154
- * @summary: Get the stock of a product
155
- * @description: Retrieve the available stock of the products. Use this API to get the stock status of products whose inventory is updated at the specified time
156
- */
157
- getProductStockForTimeByIdsPaginator({ timestamp, pageSize }?: {
158
- timestamp: string;
159
- pageSize?: number;
160
- }): Paginator;
161
- /**
162
- * @param {Object} arg - Arg object.
163
- * @param {string} [arg.q] - The search query for entering partial or full
164
- * name of product, brand, category, or collection.
165
- * @param {string} [arg.f] - The search filter parameters. Filter parameters
166
- * will be passed in f parameter as shown in the example below. Double
167
- * Pipe (||) denotes the OR condition, whereas Triple-colon (:::)
168
- * indicates a new filter paramater applied as an AND condition.
169
- * @param {boolean} [arg.filters] - This is a boolean value, True for
170
- * fetching all filter parameters and False for disabling the filter parameters.
171
- * @param {string} [arg.sortOn] - The order in which the list of products
172
- * should be sorted, e.g. popularity, price, latest and discount, in
173
- * either ascending or descending order. See the supported values below.
174
- * @param {string} [arg.pageId] - Page ID to retrieve next set of results.
175
- * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
176
- * @param {number} [arg.pageNo] - The page number to navigate through the
177
- * given set of results.
178
- * @param {string} [arg.pageType] - Available pagination types are cursor or number.
179
- * @returns {Promise<ProductListingResponse>} - Success response
180
- * @summary: Get all the products
181
- * @description: Use this API to list all the products. You may choose a sort order or make arbitrary search queries by entering the product name, brand, category or collection.
182
- */
183
- getProducts({ q, f, filters, sortOn, pageId, pageSize, pageNo, pageType, }?: {
184
- q?: string;
185
- f?: string;
186
- filters?: boolean;
187
- sortOn?: string;
188
- pageId?: string;
189
- pageSize?: number;
190
- pageNo?: number;
191
- pageType?: string;
192
- }): Promise<ProductListingResponse>;
193
- /**
194
- * @param {Object} arg - Arg object.
195
- * @param {string} [arg.q] - The search query for entering partial or full
196
- * name of product, brand, category, or collection.
197
- * @param {string} [arg.f] - The search filter parameters. Filter parameters
198
- * will be passed in f parameter as shown in the example below. Double
199
- * Pipe (||) denotes the OR condition, whereas Triple-colon (:::)
200
- * indicates a new filter paramater applied as an AND condition.
201
- * @param {boolean} [arg.filters] - This is a boolean value, True for
202
- * fetching all filter parameters and False for disabling the filter parameters.
203
- * @param {string} [arg.sortOn] - The order in which the list of products
204
- * should be sorted, e.g. popularity, price, latest and discount, in
205
- * either ascending or descending order. See the supported values below.
206
- * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
207
- * @summary: Get all the products
208
- * @description: Use this API to list all the products. You may choose a sort order or make arbitrary search queries by entering the product name, brand, category or collection.
209
- */
210
- getProductsPaginator({ q, f, filters, sortOn, pageSize }?: {
211
- q?: string;
212
- f?: string;
213
- filters?: boolean;
214
- sortOn?: string;
215
- pageSize?: number;
216
- }): Paginator;
63
+ }): Promise<BrandDetailResponse>;
217
64
  /**
218
65
  * @param {Object} arg - Arg object.
219
66
  * @param {string} [arg.department] - The name of the department. Use this
@@ -246,18 +93,6 @@ declare class Catalog {
246
93
  department?: string;
247
94
  pageSize?: number;
248
95
  }): Paginator;
249
- /**
250
- * @param {Object} arg - Arg object.
251
- * @param {string} arg.slug - A short, human-readable, URL-friendly
252
- * identifier of a brand. You can get slug value from the endpoint
253
- * /service/application/catalog/v1.0/brands/.
254
- * @returns {Promise<BrandDetailResponse>} - Success response
255
- * @summary: Get metadata of a brand
256
- * @description: Fetch metadata of a brand such as name, information, logo, banner, etc.
257
- */
258
- getBrandDetailBySlug({ slug }?: {
259
- slug: string;
260
- }): Promise<BrandDetailResponse>;
261
96
  /**
262
97
  * @param {Object} arg - Arg object.
263
98
  * @param {string} [arg.department] - The name of the department. Use this
@@ -285,79 +120,16 @@ declare class Catalog {
285
120
  }): Promise<CategoryMetaResponse>;
286
121
  /**
287
122
  * @param {Object} arg - Arg object.
288
- * @param {string} [arg.sortOn] - The order in which the list of products
289
- * should be sorted, e.g. popularity, price, latest and discount, in
290
- * either ascending or descending order.
291
- * @param {string} [arg.pageId] - Page ID to retrieve next set of results.
292
- * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
293
- * @returns {Promise<HomeListingResponse>} - Success response
294
- * @summary: List the products
295
- * @description: List all the products associated with a brand, collection or category in a random order.
296
- */
297
- getHomeProducts({ sortOn, pageId, pageSize }?: {
298
- sortOn?: string;
299
- pageId?: string;
300
- pageSize?: number;
301
- }): Promise<HomeListingResponse>;
302
- /**
303
- * @param {Object} arg - Arg object.
304
- * @param {string} [arg.sortOn] - The order in which the list of products
305
- * should be sorted, e.g. popularity, price, latest and discount, in
306
- * either ascending or descending order.
307
- * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
308
- * @summary: List the products
309
- * @description: List all the products associated with a brand, collection or category in a random order.
310
- */
311
- getHomeProductsPaginator({ sortOn, pageSize }?: {
312
- sortOn?: string;
313
- pageSize?: number;
314
- }): Paginator;
315
- /**
316
- * @param {Object} arg - Arg object.
317
- * @returns {Promise<DepartmentResponse>} - Success response
318
- * @summary: List all the departments
319
- * @description: Departments are a way to categorise similar products. A product can lie in multiple departments. For example, a skirt can below to the 'Women's Fashion' Department while a handbag can lie in 'Women's Accessories' Department. Use this API to list all the departments. If successful, returns the list of departments specified in `DepartmentResponse`
320
- */
321
- getDepartments({}?: any): Promise<DepartmentResponse>;
322
- /**
323
- * @param {Object} arg - Arg object.
324
- * @param {string} arg.q - The search query for entering partial or full
325
- * name of a product, brand or category. For example, if the given search
326
- * query `q` is _ski_, the relevant search suggestions could be _skirt_,
327
- * _ski shoes_, __skin cream_ etc.
328
- * @returns {Promise<AutoCompleteResponse>} - Success response
329
- * @summary: Get relevant suggestions for a search query
330
- * @description: Retrieves a list of suggestions for a given search query. Each suggestion is a valid search term that's generated on the basis of query. This is particularly useful to enhance the user experience while using the search tool.
331
- */
332
- getSearchResults({ q }?: {
333
- q: string;
334
- }): Promise<AutoCompleteResponse>;
335
- /**
336
- * @param {Object} arg - Arg object.
337
- * @param {number} [arg.pageNo] - The page number to navigate through the
338
- * given set of results.
339
- * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
340
- * @param {string[]} [arg.tag] - List of tags to filter collections
341
- * @returns {Promise<GetCollectionListingResponse>} - Success response
342
- * @summary: List all the collections
343
- * @description: Collections are a great way to organize your products and can improve the ability for customers to find items quickly and efficiently.
344
- */
345
- getCollections({ pageNo, pageSize, tag }?: {
346
- pageNo?: number;
347
- pageSize?: number;
348
- tag?: string[];
349
- }): Promise<GetCollectionListingResponse>;
350
- /**
351
- * @param {Object} arg - Arg object.
352
- * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
353
- * @param {string[]} [arg.tag] - List of tags to filter collections
354
- * @summary: List all the collections
355
- * @description: Collections are a great way to organize your products and can improve the ability for customers to find items quickly and efficiently.
123
+ * @param {string} arg.slug - A short, human-readable, URL-friendly
124
+ * identifier of a collection. You can get slug value from the endpoint
125
+ * /service/application/catalog/v1.0/collections/.
126
+ * @returns {Promise<CollectionDetailResponse>} - Success response
127
+ * @summary: Get a particular collection
128
+ * @description: Get the details of a collection by its `slug`.
356
129
  */
357
- getCollectionsPaginator({ pageSize, tag }?: {
358
- pageSize?: number;
359
- tag?: string[];
360
- }): Paginator;
130
+ getCollectionDetailBySlug({ slug }?: {
131
+ slug: string;
132
+ }): Promise<CollectionDetailResponse>;
361
133
  /**
362
134
  * @param {Object} arg - Arg object.
363
135
  * @param {string} arg.slug - A short, human-readable, URL-friendly
@@ -411,18 +183,62 @@ declare class Catalog {
411
183
  sortOn?: string;
412
184
  pageSize?: number;
413
185
  }): Paginator;
186
+ /**
187
+ * @param {Object} arg - Arg object.
188
+ * @param {number} [arg.pageNo] - The page number to navigate through the
189
+ * given set of results.
190
+ * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
191
+ * @param {string[]} [arg.tag] - List of tags to filter collections
192
+ * @returns {Promise<GetCollectionListingResponse>} - Success response
193
+ * @summary: List all the collections
194
+ * @description: Collections are a great way to organize your products and can improve the ability for customers to find items quickly and efficiently.
195
+ */
196
+ getCollections({ pageNo, pageSize, tag }?: {
197
+ pageNo?: number;
198
+ pageSize?: number;
199
+ tag?: string[];
200
+ }): Promise<GetCollectionListingResponse>;
201
+ /**
202
+ * @param {Object} arg - Arg object.
203
+ * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
204
+ * @param {string[]} [arg.tag] - List of tags to filter collections
205
+ * @summary: List all the collections
206
+ * @description: Collections are a great way to organize your products and can improve the ability for customers to find items quickly and efficiently.
207
+ */
208
+ getCollectionsPaginator({ pageSize, tag }?: {
209
+ pageSize?: number;
210
+ tag?: string[];
211
+ }): Paginator;
414
212
  /**
415
213
  * @param {Object} arg - Arg object.
416
214
  * @param {string} arg.slug - A short, human-readable, URL-friendly
417
- * identifier of a collection. You can get slug value from the endpoint
418
- * /service/application/catalog/v1.0/collections/.
419
- * @returns {Promise<CollectionDetailResponse>} - Success response
420
- * @summary: Get a particular collection
421
- * @description: Get the details of a collection by its `slug`.
215
+ * identifier of a product. You can get slug value from the endpoint
216
+ * /service/application/catalog/v1.0/products/
217
+ * @returns {Promise<ProductFrequentlyComparedSimilarResponse>} - Success response
218
+ * @summary: Get comparison between frequently compared products with the given product
219
+ * @description: Use this API to compare a given product automatically with products that are frequently compared with it. Only one slug is needed.
422
220
  */
423
- getCollectionDetailBySlug({ slug }?: {
221
+ getComparedFrequentlyProductBySlug({ slug }?: {
424
222
  slug: string;
425
- }): Promise<CollectionDetailResponse>;
223
+ }): Promise<ProductFrequentlyComparedSimilarResponse>;
224
+ /**
225
+ * @param {Object} arg - Arg object.
226
+ * @returns {Promise<DepartmentResponse>} - Success response
227
+ * @summary: List all the departments
228
+ * @description: Departments are a way to categorise similar products. A product can lie in multiple departments. For example, a skirt can below to the 'Women's Fashion' Department while a handbag can lie in 'Women's Accessories' Department. Use this API to list all the departments. If successful, returns the list of departments specified in `DepartmentResponse`
229
+ */
230
+ getDepartments({}?: any): Promise<DepartmentResponse>;
231
+ /**
232
+ * @param {Object} arg - Arg object.
233
+ * @param {string} [arg.collectionType] - Type of collection, i.e. products,
234
+ * brands, collections.
235
+ * @returns {Promise<FollowIdsResponse>} - Success response
236
+ * @summary: Get the IDs of followed products, brands and collections.
237
+ * @description: You can get the IDs of all the followed Products, Brands and Collections. Pass collection_type as query parameter to fetch specific Ids
238
+ */
239
+ getFollowIds({ collectionType }?: {
240
+ collectionType?: string;
241
+ }): Promise<FollowIdsResponse>;
426
242
  /**
427
243
  * @param {Object} arg - Arg object.
428
244
  * @param {string} arg.collectionType - Type of collection followed, i.e.
@@ -450,32 +266,6 @@ declare class Catalog {
450
266
  collectionType: string;
451
267
  pageSize?: number;
452
268
  }): Paginator;
453
- /**
454
- * @param {Object} arg - Arg object.
455
- * @param {string} arg.collectionType - Type of collection followed, i.e.
456
- * products, brands, or collections.
457
- * @param {string} arg.collectionId - The ID of the collection type.
458
- * @returns {Promise<FollowPostResponse>} - Success response
459
- * @summary: Follow an entity (product/brand/collection)
460
- * @description: Follow a particular entity such as product, brand, collection specified by its ID.
461
- */
462
- followById({ collectionType, collectionId }?: {
463
- collectionType: string;
464
- collectionId: string;
465
- }): Promise<FollowPostResponse>;
466
- /**
467
- * @param {Object} arg - Arg object.
468
- * @param {string} arg.collectionType - Type of collection followed, i.e.
469
- * products, brands, or collections.
470
- * @param {string} arg.collectionId - The ID of the collection type.
471
- * @returns {Promise<FollowPostResponse>} - Success response
472
- * @summary: Unfollow an entity (product/brand/collection)
473
- * @description: You can undo a followed product, brand or collection by its ID. This action is referred as _unfollow_.
474
- */
475
- unfollowById({ collectionType, collectionId }?: {
476
- collectionType: string;
477
- collectionId: string;
478
- }): Promise<FollowPostResponse>;
479
269
  /**
480
270
  * @param {Object} arg - Arg object.
481
271
  * @param {string} arg.collectionType - Type of collection, i.e. products,
@@ -491,62 +281,32 @@ declare class Catalog {
491
281
  }): Promise<FollowerCountResponse>;
492
282
  /**
493
283
  * @param {Object} arg - Arg object.
494
- * @param {string} [arg.collectionType] - Type of collection, i.e. products,
495
- * brands, collections.
496
- * @returns {Promise<FollowIdsResponse>} - Success response
497
- * @summary: Get the IDs of followed products, brands and collections.
498
- * @description: You can get the IDs of all the followed Products, Brands and Collections. Pass collection_type as query parameter to fetch specific Ids
499
- */
500
- getFollowIds({ collectionType }?: {
501
- collectionType?: string;
502
- }): Promise<FollowIdsResponse>;
503
- /**
504
- * @param {Object} arg - Arg object.
505
- * @param {number} [arg.pageNo] - The page number to navigate through the
506
- * given set of results.
507
- * @param {number} [arg.pageSize] - Number of items to retrieve in each page.
508
- * @param {string} [arg.q] - Search a store by its name or store_code.
509
- * @param {string} [arg.city] - Search stores by the city in which they are situated.
510
- * @param {number} [arg.range] - Use this to retrieve stores within a
511
- * particular range in meters, e.g. 10000, to indicate a 10km range
512
- * @param {number} [arg.latitude] - Latitude of the location from where one
513
- * wants to retreive the nearest stores, e.g. 72.8691788
514
- * @param {number} [arg.longitude] - Longitude of the location from where
515
- * one wants to retreive the nearest stores, e.g. 19.1174114
516
- * @returns {Promise<StoreListingResponse>} - Success response
517
- * @summary: Get store meta information.
518
- * @description: Use this API to get a list of stores in a specific application.
284
+ * @param {string} [arg.sortOn] - The order in which the list of products
285
+ * should be sorted, e.g. popularity, price, latest and discount, in
286
+ * either ascending or descending order.
287
+ * @param {string} [arg.pageId] - Page ID to retrieve next set of results.
288
+ * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
289
+ * @returns {Promise<HomeListingResponse>} - Success response
290
+ * @summary: List the products
291
+ * @description: List all the products associated with a brand, collection or category in a random order.
519
292
  */
520
- getStores({ pageNo, pageSize, q, city, range, latitude, longitude }?: {
521
- pageNo?: number;
293
+ getHomeProducts({ sortOn, pageId, pageSize }?: {
294
+ sortOn?: string;
295
+ pageId?: string;
522
296
  pageSize?: number;
523
- q?: string;
524
- city?: string;
525
- range?: number;
526
- latitude?: number;
527
- longitude?: number;
528
- }): Promise<StoreListingResponse>;
529
- /**
530
- * @param {Object} arg - Arg object.
531
- * @param {number} [arg.pageSize] - Number of items to retrieve in each page.
532
- * @param {string} [arg.q] - Search a store by its name or store_code.
533
- * @param {string} [arg.city] - Search stores by the city in which they are situated.
534
- * @param {number} [arg.range] - Use this to retrieve stores within a
535
- * particular range in meters, e.g. 10000, to indicate a 10km range
536
- * @param {number} [arg.latitude] - Latitude of the location from where one
537
- * wants to retreive the nearest stores, e.g. 72.8691788
538
- * @param {number} [arg.longitude] - Longitude of the location from where
539
- * one wants to retreive the nearest stores, e.g. 19.1174114
540
- * @summary: Get store meta information.
541
- * @description: Use this API to get a list of stores in a specific application.
297
+ }): Promise<HomeListingResponse>;
298
+ /**
299
+ * @param {Object} arg - Arg object.
300
+ * @param {string} [arg.sortOn] - The order in which the list of products
301
+ * should be sorted, e.g. popularity, price, latest and discount, in
302
+ * either ascending or descending order.
303
+ * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
304
+ * @summary: List the products
305
+ * @description: List all the products associated with a brand, collection or category in a random order.
542
306
  */
543
- getStoresPaginator({ pageSize, q, city, range, latitude, longitude }?: {
307
+ getHomeProductsPaginator({ sortOn, pageSize }?: {
308
+ sortOn?: string;
544
309
  pageSize?: number;
545
- q?: string;
546
- city?: string;
547
- range?: number;
548
- latitude?: number;
549
- longitude?: number;
550
310
  }): Paginator;
551
311
  /**
552
312
  * @param {Object} arg - Arg object.
@@ -618,6 +378,30 @@ declare class Catalog {
618
378
  slug?: string;
619
379
  id?: string;
620
380
  }): Promise<ProductBundle>;
381
+ /**
382
+ * @param {Object} arg - Arg object.
383
+ * @param {string[]} arg.slug - A short, human-readable, URL-friendly
384
+ * identifier of a product. You can get slug value from the endpoint
385
+ * /service/application/catalog/v1.0/products/.
386
+ * @returns {Promise<ProductsComparisonResponse>} - Success response
387
+ * @summary: Compare products
388
+ * @description: Use this API to compare the features of products belonging to the same category. Note that at least one slug is mandatory in the request query.
389
+ */
390
+ getProductComparisonBySlugs({ slug }?: {
391
+ slug: string[];
392
+ }): Promise<ProductsComparisonResponse>;
393
+ /**
394
+ * @param {Object} arg - Arg object.
395
+ * @param {string} arg.slug - A short, human-readable, URL-friendly
396
+ * identifier of a product. You can get slug value from the endpoint
397
+ * /service/application/catalog/v1.0/products/
398
+ * @returns {Promise<ProductDetail>} - Success response
399
+ * @summary: Get a product
400
+ * @description: Use this API to retrieve a product by its slug value.
401
+ */
402
+ getProductDetailBySlug({ slug }?: {
403
+ slug: string;
404
+ }): Promise<ProductDetail>;
621
405
  /**
622
406
  * @param {Object} arg - Arg object.
623
407
  * @param {string} arg.slug - A short, human-readable, URL-friendly
@@ -693,5 +477,221 @@ declare class Catalog {
693
477
  strategy?: string;
694
478
  pageSize?: number;
695
479
  }): Paginator;
480
+ /**
481
+ * @param {Object} arg - Arg object.
482
+ * @param {string} arg.slug - A short, human-readable, URL-friendly
483
+ * identifier of a product. You can get slug value from the endpoint
484
+ * /service/application/catalog/v1.0/products/
485
+ * @param {number} [arg.storeId] - The ID of the store that is selling the
486
+ * product, e.g. 1,2,3.
487
+ * @returns {Promise<ProductSizes>} - Success response
488
+ * @summary: Get the sizes of a product
489
+ * @description: A product can have multiple sizes. Use this API to fetch all the available sizes of a product.
490
+ */
491
+ getProductSizesBySlug({ slug, storeId }?: {
492
+ slug: string;
493
+ storeId?: number;
494
+ }): Promise<ProductSizes>;
495
+ /**
496
+ * @param {Object} arg - Arg object.
497
+ * @param {string} [arg.itemId] - The Item ID of the product (Max. 50 allowed)
498
+ * @param {string} [arg.alu] - ALU of the product (limited upto 50 ALU
499
+ * identifier in a single request)
500
+ * @param {string} [arg.skuCode] - Stock-keeping Unit of the product
501
+ * (limited upto 50 SKU Code in a single request)
502
+ * @param {string} [arg.ean] - European Article Number of the product
503
+ * (limited upto 50 EAN identifier in a single request)
504
+ * @param {string} [arg.upc] - Universal Product Code of the product
505
+ * (limited upto 50 UPC identifier in a single request)
506
+ * @returns {Promise<ProductStockStatusResponse>} - Success response
507
+ * @summary: Get the stock of a product
508
+ * @description: Retrieve the available stock of the products. Use this API to retrieve stock of multiple products (up to 50) at a time.
509
+ */
510
+ getProductStockByIds({ itemId, alu, skuCode, ean, upc }?: {
511
+ itemId?: string;
512
+ alu?: string;
513
+ skuCode?: string;
514
+ ean?: string;
515
+ upc?: string;
516
+ }): Promise<ProductStockStatusResponse>;
517
+ /**
518
+ * @param {Object} arg - Arg object.
519
+ * @param {string} arg.timestamp - Timestamp in UTC format (2020-07-23T10:27:50Z)
520
+ * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
521
+ * @param {string} [arg.pageId] - Page ID to retrieve next set of results.
522
+ * @returns {Promise<ProductStockPolling>} - Success response
523
+ * @summary: Get the stock of a product
524
+ * @description: Retrieve the available stock of the products. Use this API to get the stock status of products whose inventory is updated at the specified time
525
+ */
526
+ getProductStockForTimeByIds({ timestamp, pageSize, pageId }?: {
527
+ timestamp: string;
528
+ pageSize?: number;
529
+ pageId?: string;
530
+ }): Promise<ProductStockPolling>;
531
+ /**
532
+ * @param {Object} arg - Arg object.
533
+ * @param {string} arg.timestamp - Timestamp in UTC format (2020-07-23T10:27:50Z)
534
+ * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
535
+ * @summary: Get the stock of a product
536
+ * @description: Retrieve the available stock of the products. Use this API to get the stock status of products whose inventory is updated at the specified time
537
+ */
538
+ getProductStockForTimeByIdsPaginator({ timestamp, pageSize }?: {
539
+ timestamp: string;
540
+ pageSize?: number;
541
+ }): Paginator;
542
+ /**
543
+ * @param {Object} arg - Arg object.
544
+ * @param {string} arg.slug - A short, human-readable, URL-friendly
545
+ * identifier of a product. You can get slug value from the endpoint
546
+ * /service/application/catalog/v1.0/products/
547
+ * @returns {Promise<ProductVariantsResponse>} - Success response
548
+ * @summary: Get variant of a particular product
549
+ * @description: A product can have a different type of variants such as colour, shade, memory. Use this API to fetch all the available variants of a product using its slug.
550
+ */
551
+ getProductVariantsBySlug({ slug }?: {
552
+ slug: string;
553
+ }): Promise<ProductVariantsResponse>;
554
+ /**
555
+ * @param {Object} arg - Arg object.
556
+ * @param {string} [arg.q] - The search query for entering partial or full
557
+ * name of product, brand, category, or collection.
558
+ * @param {string} [arg.f] - The search filter parameters. Filter parameters
559
+ * will be passed in f parameter as shown in the example below. Double
560
+ * Pipe (||) denotes the OR condition, whereas Triple-colon (:::)
561
+ * indicates a new filter paramater applied as an AND condition.
562
+ * @param {boolean} [arg.filters] - This is a boolean value, True for
563
+ * fetching all filter parameters and False for disabling the filter parameters.
564
+ * @param {string} [arg.sortOn] - The order in which the list of products
565
+ * should be sorted, e.g. popularity, price, latest and discount, in
566
+ * either ascending or descending order. See the supported values below.
567
+ * @param {string} [arg.pageId] - Page ID to retrieve next set of results.
568
+ * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
569
+ * @param {number} [arg.pageNo] - The page number to navigate through the
570
+ * given set of results.
571
+ * @param {string} [arg.pageType] - Available pagination types are cursor or number.
572
+ * @returns {Promise<ProductListingResponse>} - Success response
573
+ * @summary: Get all the products
574
+ * @description: Use this API to list all the products. You may choose a sort order or make arbitrary search queries by entering the product name, brand, category or collection.
575
+ */
576
+ getProducts({ q, f, filters, sortOn, pageId, pageSize, pageNo, pageType, }?: {
577
+ q?: string;
578
+ f?: string;
579
+ filters?: boolean;
580
+ sortOn?: string;
581
+ pageId?: string;
582
+ pageSize?: number;
583
+ pageNo?: number;
584
+ pageType?: string;
585
+ }): Promise<ProductListingResponse>;
586
+ /**
587
+ * @param {Object} arg - Arg object.
588
+ * @param {string} [arg.q] - The search query for entering partial or full
589
+ * name of product, brand, category, or collection.
590
+ * @param {string} [arg.f] - The search filter parameters. Filter parameters
591
+ * will be passed in f parameter as shown in the example below. Double
592
+ * Pipe (||) denotes the OR condition, whereas Triple-colon (:::)
593
+ * indicates a new filter paramater applied as an AND condition.
594
+ * @param {boolean} [arg.filters] - This is a boolean value, True for
595
+ * fetching all filter parameters and False for disabling the filter parameters.
596
+ * @param {string} [arg.sortOn] - The order in which the list of products
597
+ * should be sorted, e.g. popularity, price, latest and discount, in
598
+ * either ascending or descending order. See the supported values below.
599
+ * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
600
+ * @summary: Get all the products
601
+ * @description: Use this API to list all the products. You may choose a sort order or make arbitrary search queries by entering the product name, brand, category or collection.
602
+ */
603
+ getProductsPaginator({ q, f, filters, sortOn, pageSize }?: {
604
+ q?: string;
605
+ f?: string;
606
+ filters?: boolean;
607
+ sortOn?: string;
608
+ pageSize?: number;
609
+ }): Paginator;
610
+ /**
611
+ * @param {Object} arg - Arg object.
612
+ * @param {string} arg.q - The search query for entering partial or full
613
+ * name of a product, brand or category. For example, if the given search
614
+ * query `q` is _ski_, the relevant search suggestions could be _skirt_,
615
+ * _ski shoes_, __skin cream_ etc.
616
+ * @returns {Promise<AutoCompleteResponse>} - Success response
617
+ * @summary: Get relevant suggestions for a search query
618
+ * @description: Retrieves a list of suggestions for a given search query. Each suggestion is a valid search term that's generated on the basis of query. This is particularly useful to enhance the user experience while using the search tool.
619
+ */
620
+ getSearchResults({ q }?: {
621
+ q: string;
622
+ }): Promise<AutoCompleteResponse>;
623
+ /**
624
+ * @param {Object} arg - Arg object.
625
+ * @param {string} arg.slug - A short, human-readable, URL-friendly
626
+ * identifier of a product. You can get slug value from the endpoint
627
+ * /service/application/catalog/v1.0/products/
628
+ * @returns {Promise<ProductCompareResponse>} - Success response
629
+ * @summary: Get comparison between similar products
630
+ * @description: Use this API to compare a given product automatically with similar products. Only one slug is needed.
631
+ */
632
+ getSimilarComparisonProductBySlug({ slug }?: {
633
+ slug: string;
634
+ }): Promise<ProductCompareResponse>;
635
+ /**
636
+ * @param {Object} arg - Arg object.
637
+ * @param {number} [arg.pageNo] - The page number to navigate through the
638
+ * given set of results.
639
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each page.
640
+ * @param {string} [arg.q] - Search a store by its name or store_code.
641
+ * @param {string} [arg.city] - Search stores by the city in which they are situated.
642
+ * @param {number} [arg.range] - Use this to retrieve stores within a
643
+ * particular range in meters, e.g. 10000, to indicate a 10km range
644
+ * @param {number} [arg.latitude] - Latitude of the location from where one
645
+ * wants to retreive the nearest stores, e.g. 72.8691788
646
+ * @param {number} [arg.longitude] - Longitude of the location from where
647
+ * one wants to retreive the nearest stores, e.g. 19.1174114
648
+ * @returns {Promise<StoreListingResponse>} - Success response
649
+ * @summary: Get store meta information.
650
+ * @description: Use this API to get a list of stores in a specific application.
651
+ */
652
+ getStores({ pageNo, pageSize, q, city, range, latitude, longitude, }?: {
653
+ pageNo?: number;
654
+ pageSize?: number;
655
+ q?: string;
656
+ city?: string;
657
+ range?: number;
658
+ latitude?: number;
659
+ longitude?: number;
660
+ }): Promise<StoreListingResponse>;
661
+ /**
662
+ * @param {Object} arg - Arg object.
663
+ * @param {number} [arg.pageSize] - Number of items to retrieve in each page.
664
+ * @param {string} [arg.q] - Search a store by its name or store_code.
665
+ * @param {string} [arg.city] - Search stores by the city in which they are situated.
666
+ * @param {number} [arg.range] - Use this to retrieve stores within a
667
+ * particular range in meters, e.g. 10000, to indicate a 10km range
668
+ * @param {number} [arg.latitude] - Latitude of the location from where one
669
+ * wants to retreive the nearest stores, e.g. 72.8691788
670
+ * @param {number} [arg.longitude] - Longitude of the location from where
671
+ * one wants to retreive the nearest stores, e.g. 19.1174114
672
+ * @summary: Get store meta information.
673
+ * @description: Use this API to get a list of stores in a specific application.
674
+ */
675
+ getStoresPaginator({ pageSize, q, city, range, latitude, longitude }?: {
676
+ pageSize?: number;
677
+ q?: string;
678
+ city?: string;
679
+ range?: number;
680
+ latitude?: number;
681
+ longitude?: number;
682
+ }): Paginator;
683
+ /**
684
+ * @param {Object} arg - Arg object.
685
+ * @param {string} arg.collectionType - Type of collection followed, i.e.
686
+ * products, brands, or collections.
687
+ * @param {string} arg.collectionId - The ID of the collection type.
688
+ * @returns {Promise<FollowPostResponse>} - Success response
689
+ * @summary: Unfollow an entity (product/brand/collection)
690
+ * @description: You can undo a followed product, brand or collection by its ID. This action is referred as _unfollow_.
691
+ */
692
+ unfollowById({ collectionType, collectionId }?: {
693
+ collectionType: string;
694
+ collectionId: string;
695
+ }): Promise<FollowPostResponse>;
696
696
  }
697
697
  import Paginator = require("../../common/Paginator");