@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,65 +3,45 @@ declare class Cart {
3
3
  constructor(_conf: any);
4
4
  _conf: any;
5
5
  _relativeUrls: {
6
- getCart: string;
7
- getCartLastModified: string;
6
+ addAddress: string;
8
7
  addItems: string;
9
- updateCart: string;
10
- getItemCount: string;
11
- getCoupons: string;
12
8
  applyCoupon: string;
13
- removeCoupon: string;
14
- getBulkDiscountOffers: string;
15
9
  applyRewardPoints: string;
16
- getAddresses: string;
17
- addAddress: string;
10
+ checkoutCart: string;
18
11
  getAddressById: string;
19
- updateAddress: string;
12
+ getAddresses: string;
13
+ getBulkDiscountOffers: string;
14
+ getCart: string;
15
+ getCartLastModified: string;
16
+ getCartShareLink: string;
17
+ getCartSharedItems: string;
18
+ getCoupons: string;
19
+ getItemCount: string;
20
+ getLadderOffers: string;
21
+ getPromotionOffers: string;
22
+ getShipments: string;
20
23
  removeAddress: string;
24
+ removeCoupon: string;
21
25
  selectAddress: string;
22
26
  selectPaymentMode: string;
23
- validateCouponForPayment: string;
24
- getShipments: string;
25
- checkoutCart: string;
27
+ updateAddress: string;
28
+ updateCart: string;
26
29
  updateCartMeta: string;
27
- getCartShareLink: string;
28
- getCartSharedItems: string;
29
30
  updateCartWithSharedItems: string;
30
- getPromotionOffers: string;
31
- getLadderOffers: string;
31
+ validateCouponForPayment: string;
32
32
  };
33
33
  _urls: {};
34
34
  updateUrls(urls: any): void;
35
35
  /**
36
36
  * @param {Object} arg - Arg object.
37
- * @param {string} [arg.id] -
38
- * @param {boolean} [arg.i] -
39
- * @param {boolean} [arg.b] -
40
- * @param {number} [arg.assignCardId] -
41
- * @param {string} [arg.areaCode] -
42
- * @param {boolean} [arg.buyNow] -
43
- * @returns {Promise<CartDetailResponse>} - Success response
44
- * @summary: Fetch all items added to the cart
45
- * @description: Use this API to get details of all the items added to a cart.
46
- */
47
- getCart({ id, i, b, assignCardId, areaCode, buyNow }?: {
48
- id?: string;
49
- i?: boolean;
50
- b?: boolean;
51
- assignCardId?: number;
52
- areaCode?: string;
53
- buyNow?: boolean;
54
- }): Promise<CartDetailResponse>;
55
- /**
56
- * @param {Object} arg - Arg object.
57
- * @param {string} [arg.id] -
58
- * @returns {Promise<any>} - Success response
59
- * @summary: Fetch last-modified timestamp
60
- * @description: Use this API to fetch Last-Modified timestamp in header metadata.
37
+ * @param {Address} arg.body
38
+ * @returns {Promise<SaveAddressResponse>} - Success response
39
+ * @summary: Add address to an account
40
+ * @description: Use this API to add an address to an account.
61
41
  */
62
- getCartLastModified({ id }?: {
63
- id?: string;
64
- }): Promise<any>;
42
+ addAddress({ body }?: {
43
+ body: Address;
44
+ }): Promise<SaveAddressResponse>;
65
45
  /**
66
46
  * @param {Object} arg - Arg object.
67
47
  * @param {boolean} [arg.i] -
@@ -80,50 +60,6 @@ declare class Cart {
80
60
  buyNow?: boolean;
81
61
  body: AddCartRequest;
82
62
  }): Promise<AddCartDetailResponse>;
83
- /**
84
- * @param {Object} arg - Arg object.
85
- * @param {string} [arg.id] -
86
- * @param {boolean} [arg.i] -
87
- * @param {boolean} [arg.b] -
88
- * @param {string} [arg.areaCode] -
89
- * @param {boolean} [arg.buyNow] -
90
- * @param {UpdateCartRequest} arg.body
91
- * @returns {Promise<UpdateCartDetailResponse>} - Success response
92
- * @summary: Update items in the cart
93
- * @description: <p>Use this API to update items added to the cart with the help of a request object containing attributes like item_quantity and item_size. These attributes will be fetched from the following APIs</p> <ul> <li><font color="monochrome">operation</font> Operation for current api call. <b>update_item</b> for update items. <b>remove_item</b> for removing items.</li> <li> <font color="monochrome">item_id</font> "/platform/content/v1/products/"</li> <li> <font color="monochrome">item_size</font> "/platform/content/v1/products/:slug/sizes/"</li> <li> <font color="monochrome">quantity</font> item quantity (must be greater than or equal to 1)</li> <li> <font color="monochrome">article_id</font> "/content​/v1​/products​/:identifier​/sizes​/price​/"</li> <li> <font color="monochrome">item_index</font> item position in the cart (must be greater than or equal to 0)</li> </ul>
94
- */
95
- updateCart({ body, id, i, b, areaCode, buyNow }?: {
96
- id?: string;
97
- i?: boolean;
98
- b?: boolean;
99
- areaCode?: string;
100
- buyNow?: boolean;
101
- body: UpdateCartRequest;
102
- }): Promise<UpdateCartDetailResponse>;
103
- /**
104
- * @param {Object} arg - Arg object.
105
- * @param {string} [arg.id] - The unique identifier of the cart.
106
- * @param {boolean} [arg.buyNow] -
107
- * @returns {Promise<CartItemCountResponse>} - Success response
108
- * @summary: Count items in the cart
109
- * @description: Use this API to get the total number of items present in cart.
110
- */
111
- getItemCount({ id, buyNow }?: {
112
- id?: string;
113
- buyNow?: boolean;
114
- }): Promise<CartItemCountResponse>;
115
- /**
116
- * @param {Object} arg - Arg object.
117
- * @param {string} [arg.id] -
118
- * @param {boolean} [arg.buyNow] -
119
- * @returns {Promise<GetCouponResponse>} - Success response
120
- * @summary: Fetch Coupon
121
- * @description: Use this API to get a list of available coupons along with their details.
122
- */
123
- getCoupons({ id, buyNow }?: {
124
- id?: string;
125
- buyNow?: boolean;
126
- }): Promise<GetCouponResponse>;
127
63
  /**
128
64
  * @param {Object} arg - Arg object.
129
65
  * @param {boolean} [arg.i] -
@@ -147,15 +83,75 @@ declare class Cart {
147
83
  /**
148
84
  * @param {Object} arg - Arg object.
149
85
  * @param {string} [arg.id] -
86
+ * @param {boolean} [arg.i] -
87
+ * @param {boolean} [arg.b] -
150
88
  * @param {boolean} [arg.buyNow] -
89
+ * @param {RewardPointRequest} arg.body
151
90
  * @returns {Promise<CartDetailResponse>} - Success response
152
- * @summary: Remove Coupon Applied
153
- * @description: Remove Coupon applied on the cart by passing uid in request body.
91
+ * @summary: Apply reward points at cart
92
+ * @description: Use this API to redeem a fixed no. of reward points by applying it to the cart.
154
93
  */
155
- removeCoupon({ id, buyNow }?: {
94
+ applyRewardPoints({ body, id, i, b, buyNow }?: {
156
95
  id?: string;
96
+ i?: boolean;
97
+ b?: boolean;
157
98
  buyNow?: boolean;
99
+ body: RewardPointRequest;
158
100
  }): Promise<CartDetailResponse>;
101
+ /**
102
+ * @param {Object} arg - Arg object.
103
+ * @param {boolean} [arg.buyNow] - This indicates the type of cart to checkout
104
+ * @param {CartCheckoutDetailRequest} arg.body
105
+ * @returns {Promise<CartCheckoutResponse>} - Success response
106
+ * @summary: Checkout all items in the cart
107
+ * @description: Use this API to checkout all items in the cart for payment and order generation. For COD, order will be directly generated, whereas for other checkout modes, user will be redirected to a payment gateway.
108
+ */
109
+ checkoutCart({ body, buyNow }?: {
110
+ buyNow?: boolean;
111
+ body: CartCheckoutDetailRequest;
112
+ }): Promise<CartCheckoutResponse>;
113
+ /**
114
+ * @param {Object} arg - Arg object.
115
+ * @param {string} arg.id -
116
+ * @param {string} [arg.cartId] -
117
+ * @param {boolean} [arg.buyNow] -
118
+ * @param {string} [arg.mobileNo] -
119
+ * @param {string} [arg.checkoutMode] -
120
+ * @param {string} [arg.tags] -
121
+ * @param {boolean} [arg.isDefault] -
122
+ * @returns {Promise<Address>} - Success response
123
+ * @summary: Fetch a single address by its ID
124
+ * @description: Use this API to get an addresses using its ID. If successful, returns a Address resource in the response body specified in `Address`. Attibutes listed below are optional <ul> <li> <font color="monochrome">mobile_no</font></li> <li> <font color="monochrome">checkout_mode</font></li> <li> <font color="monochrome">tags</font></li> <li> <font color="monochrome">default</font></li> </ul>
125
+ */
126
+ getAddressById({ id, cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, }?: {
127
+ id: string;
128
+ cartId?: string;
129
+ buyNow?: boolean;
130
+ mobileNo?: string;
131
+ checkoutMode?: string;
132
+ tags?: string;
133
+ isDefault?: boolean;
134
+ }): Promise<Address>;
135
+ /**
136
+ * @param {Object} arg - Arg object.
137
+ * @param {string} [arg.cartId] -
138
+ * @param {boolean} [arg.buyNow] -
139
+ * @param {string} [arg.mobileNo] -
140
+ * @param {string} [arg.checkoutMode] -
141
+ * @param {string} [arg.tags] -
142
+ * @param {boolean} [arg.isDefault] -
143
+ * @returns {Promise<GetAddressesResponse>} - Success response
144
+ * @summary: Fetch address
145
+ * @description: Use this API to get all the addresses associated with an account. If successful, returns a Address resource in the response body specified in GetAddressesResponse.attibutes listed below are optional <ul> <li> <font color="monochrome">uid</font></li> <li> <font color="monochrome">address_id</font></li> <li> <font color="monochrome">mobile_no</font></li> <li> <font color="monochrome">checkout_mode</font></li> <li> <font color="monochrome">tags</font></li> <li> <font color="monochrome">default</font></li> </ul>
146
+ */
147
+ getAddresses({ cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, }?: {
148
+ cartId?: string;
149
+ buyNow?: boolean;
150
+ mobileNo?: string;
151
+ checkoutMode?: string;
152
+ tags?: string;
153
+ isDefault?: boolean;
154
+ }): Promise<GetAddressesResponse>;
159
155
  /**
160
156
  * @param {Object} arg - Arg object.
161
157
  * @param {number} [arg.itemId] - The Item ID of the product
@@ -179,83 +175,131 @@ declare class Cart {
179
175
  * @param {string} [arg.id] -
180
176
  * @param {boolean} [arg.i] -
181
177
  * @param {boolean} [arg.b] -
178
+ * @param {number} [arg.assignCardId] -
179
+ * @param {string} [arg.areaCode] -
182
180
  * @param {boolean} [arg.buyNow] -
183
- * @param {RewardPointRequest} arg.body
184
181
  * @returns {Promise<CartDetailResponse>} - Success response
185
- * @summary: Apply reward points at cart
186
- * @description: Use this API to redeem a fixed no. of reward points by applying it to the cart.
182
+ * @summary: Fetch all items added to the cart
183
+ * @description: Use this API to get details of all the items added to a cart.
187
184
  */
188
- applyRewardPoints({ body, id, i, b, buyNow }?: {
185
+ getCart({ id, i, b, assignCardId, areaCode, buyNow }?: {
189
186
  id?: string;
190
187
  i?: boolean;
191
188
  b?: boolean;
189
+ assignCardId?: number;
190
+ areaCode?: string;
192
191
  buyNow?: boolean;
193
- body: RewardPointRequest;
194
192
  }): Promise<CartDetailResponse>;
195
193
  /**
196
194
  * @param {Object} arg - Arg object.
197
- * @param {string} [arg.cartId] -
198
- * @param {boolean} [arg.buyNow] -
199
- * @param {string} [arg.mobileNo] -
200
- * @param {string} [arg.checkoutMode] -
201
- * @param {string} [arg.tags] -
202
- * @param {boolean} [arg.isDefault] -
203
- * @returns {Promise<GetAddressesResponse>} - Success response
204
- * @summary: Fetch address
205
- * @description: Use this API to get all the addresses associated with an account. If successful, returns a Address resource in the response body specified in GetAddressesResponse.attibutes listed below are optional <ul> <li> <font color="monochrome">uid</font></li> <li> <font color="monochrome">address_id</font></li> <li> <font color="monochrome">mobile_no</font></li> <li> <font color="monochrome">checkout_mode</font></li> <li> <font color="monochrome">tags</font></li> <li> <font color="monochrome">default</font></li> </ul>
195
+ * @param {string} [arg.id] -
196
+ * @returns {Promise<any>} - Success response
197
+ * @summary: Fetch last-modified timestamp
198
+ * @description: Use this API to fetch Last-Modified timestamp in header metadata.
206
199
  */
207
- getAddresses({ cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, }?: {
208
- cartId?: string;
209
- buyNow?: boolean;
210
- mobileNo?: string;
211
- checkoutMode?: string;
212
- tags?: string;
213
- isDefault?: boolean;
214
- }): Promise<GetAddressesResponse>;
200
+ getCartLastModified({ id }?: {
201
+ id?: string;
202
+ }): Promise<any>;
215
203
  /**
216
204
  * @param {Object} arg - Arg object.
217
- * @param {Address} arg.body
218
- * @returns {Promise<SaveAddressResponse>} - Success response
219
- * @summary: Add address to an account
220
- * @description: Use this API to add an address to an account.
205
+ * @param {GetShareCartLinkRequest} arg.body
206
+ * @returns {Promise<GetShareCartLinkResponse>} - Success response
207
+ * @summary: Generate token for sharing the cart
208
+ * @description: Use this API to generate a shared cart snapshot and return a shortlink token. The link can be shared with other users for getting the same items in their cart.
221
209
  */
222
- addAddress({ body }?: {
223
- body: Address;
224
- }): Promise<SaveAddressResponse>;
210
+ getCartShareLink({ body }?: {
211
+ body: GetShareCartLinkRequest;
212
+ }): Promise<GetShareCartLinkResponse>;
225
213
  /**
226
214
  * @param {Object} arg - Arg object.
227
- * @param {string} arg.id -
228
- * @param {string} [arg.cartId] -
215
+ * @param {string} arg.token - Token of the shared short link
216
+ * @returns {Promise<SharedCartResponse>} - Success response
217
+ * @summary: Get details of a shared cart
218
+ * @description: Use this API to get the shared cart details as per the token generated using the share-cart API.
219
+ */
220
+ getCartSharedItems({ token }?: {
221
+ token: string;
222
+ }): Promise<SharedCartResponse>;
223
+ /**
224
+ * @param {Object} arg - Arg object.
225
+ * @param {string} [arg.id] -
229
226
  * @param {boolean} [arg.buyNow] -
230
- * @param {string} [arg.mobileNo] -
231
- * @param {string} [arg.checkoutMode] -
232
- * @param {string} [arg.tags] -
233
- * @param {boolean} [arg.isDefault] -
234
- * @returns {Promise<Address>} - Success response
235
- * @summary: Fetch a single address by its ID
236
- * @description: Use this API to get an addresses using its ID. If successful, returns a Address resource in the response body specified in `Address`. Attibutes listed below are optional <ul> <li> <font color="monochrome">mobile_no</font></li> <li> <font color="monochrome">checkout_mode</font></li> <li> <font color="monochrome">tags</font></li> <li> <font color="monochrome">default</font></li> </ul>
227
+ * @returns {Promise<GetCouponResponse>} - Success response
228
+ * @summary: Fetch Coupon
229
+ * @description: Use this API to get a list of available coupons along with their details.
237
230
  */
238
- getAddressById({ id, cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, }?: {
239
- id: string;
240
- cartId?: string;
231
+ getCoupons({ id, buyNow }?: {
232
+ id?: string;
241
233
  buyNow?: boolean;
242
- mobileNo?: string;
243
- checkoutMode?: string;
244
- tags?: string;
245
- isDefault?: boolean;
246
- }): Promise<Address>;
234
+ }): Promise<GetCouponResponse>;
247
235
  /**
248
236
  * @param {Object} arg - Arg object.
249
- * @param {string} arg.id - ID allotted to the selected address
250
- * @param {Address} arg.body
251
- * @returns {Promise<UpdateAddressResponse>} - Success response
252
- * @summary: Update address added to an account
253
- * @description: <p>Use this API to update an existing address in the account. Request object should contain attributes mentioned in <font color="blue">Address </font> can be updated. These attributes are:</p> <ul> <li> <font color="monochrome">is_default_address</font></li> <li> <font color="monochrome">landmark</font></li> <li> <font color="monochrome">area</font></li> <li> <font color="monochrome">pincode</font></li> <li> <font color="monochrome">email</font></li> <li> <font color="monochrome">address_type</font></li> <li> <font color="monochrome">name</font></li> <li> <font color="monochrome">address_id</font></li> <li> <font color="monochrome">address</font></li> </ul>
237
+ * @param {string} [arg.id] - The unique identifier of the cart.
238
+ * @param {boolean} [arg.buyNow] -
239
+ * @returns {Promise<CartItemCountResponse>} - Success response
240
+ * @summary: Count items in the cart
241
+ * @description: Use this API to get the total number of items present in cart.
254
242
  */
255
- updateAddress({ id, body }?: {
256
- id: string;
257
- body: Address;
258
- }): Promise<UpdateAddressResponse>;
243
+ getItemCount({ id, buyNow }?: {
244
+ id?: string;
245
+ buyNow?: boolean;
246
+ }): Promise<CartItemCountResponse>;
247
+ /**
248
+ * @param {Object} arg - Arg object.
249
+ * @param {string} arg.slug - A short, human-readable, URL-friendly
250
+ * identifier of a product. You can get slug value from the endpoint
251
+ * /service/application/catalog/v1.0/products/
252
+ * @param {string} [arg.storeId] - Store uid of assigned store on PDP page.
253
+ * If not passed default first created ladder will be returned
254
+ * @param {string} [arg.promotionId] - Get ladder information of given
255
+ * promotion id explicitely
256
+ * @param {number} [arg.pageSize] - Number of offers to be fetched to show
257
+ * @returns {Promise<LadderPriceOffers>} - Success response
258
+ * @summary: Fetch ladder price promotion
259
+ * @description: Use this API to get applicable ladder price promotion for current product
260
+ */
261
+ getLadderOffers({ slug, storeId, promotionId, pageSize }?: {
262
+ slug: string;
263
+ storeId?: string;
264
+ promotionId?: string;
265
+ pageSize?: number;
266
+ }): Promise<LadderPriceOffers>;
267
+ /**
268
+ * @param {Object} arg - Arg object.
269
+ * @param {string} [arg.slug] - A short, human-readable, URL-friendly
270
+ * identifier of a product. You can get slug value from the endpoint
271
+ * /service/application/catalog/v1.0/products/
272
+ * @param {number} [arg.pageSize] - Number of offers to be fetched to show
273
+ * @param {string} [arg.promotionGroup] - Type of promotion groups
274
+ * @returns {Promise<PromotionOffersResponse>} - Success response
275
+ * @summary: Fetch available promotions
276
+ * @description: Use this API to get top 5 offers available for current product
277
+ */
278
+ getPromotionOffers({ slug, pageSize, promotionGroup }?: {
279
+ slug?: string;
280
+ pageSize?: number;
281
+ promotionGroup?: string;
282
+ }): Promise<PromotionOffersResponse>;
283
+ /**
284
+ * @param {Object} arg - Arg object.
285
+ * @param {boolean} [arg.p] - This is a boolean value. Select `true` for
286
+ * getting a payment option in response.
287
+ * @param {string} [arg.id] - The unique identifier of the cart
288
+ * @param {boolean} [arg.buyNow] -
289
+ * @param {string} [arg.addressId] - ID allotted to the selected address
290
+ * @param {string} [arg.areaCode] - The PIN Code of the destination address,
291
+ * e.g. 400059
292
+ * @returns {Promise<CartShipmentsResponse>} - Success response
293
+ * @summary: Get delivery date and options before checkout
294
+ * @description: Use this API to get shipment details, expected delivery date, items and price breakup of the shipment.
295
+ */
296
+ getShipments({ p, id, buyNow, addressId, areaCode }?: {
297
+ p?: boolean;
298
+ id?: string;
299
+ buyNow?: boolean;
300
+ addressId?: string;
301
+ areaCode?: string;
302
+ }): Promise<CartShipmentsResponse>;
259
303
  /**
260
304
  * @param {Object} arg - Arg object.
261
305
  * @param {string} arg.id - ID allotted to the selected address
@@ -266,6 +310,18 @@ declare class Cart {
266
310
  removeAddress({ id }?: {
267
311
  id: string;
268
312
  }): Promise<DeleteAddressResponse>;
313
+ /**
314
+ * @param {Object} arg - Arg object.
315
+ * @param {string} [arg.id] -
316
+ * @param {boolean} [arg.buyNow] -
317
+ * @returns {Promise<CartDetailResponse>} - Success response
318
+ * @summary: Remove Coupon Applied
319
+ * @description: Remove Coupon applied on the cart by passing uid in request body.
320
+ */
321
+ removeCoupon({ id, buyNow }?: {
322
+ id?: string;
323
+ buyNow?: boolean;
324
+ }): Promise<CartDetailResponse>;
269
325
  /**
270
326
  * @param {Object} arg - Arg object.
271
327
  * @param {string} [arg.cartId] -
@@ -300,58 +356,36 @@ declare class Cart {
300
356
  }): Promise<CartDetailResponse>;
301
357
  /**
302
358
  * @param {Object} arg - Arg object.
303
- * @param {string} [arg.id] -
304
- * @param {boolean} [arg.buyNow] -
305
- * @param {string} [arg.addressId] -
306
- * @param {string} [arg.paymentMode] -
307
- * @param {string} [arg.paymentIdentifier] -
308
- * @param {string} [arg.aggregatorName] -
309
- * @param {string} [arg.merchantCode] -
310
- * @returns {Promise<PaymentCouponValidate>} - Success response
311
- * @summary: Verify the coupon eligibility against the payment mode
312
- * @description: Use this API to validate a coupon against the payment mode such as NetBanking, Wallet, UPI etc.
359
+ * @param {string} arg.id - ID allotted to the selected address
360
+ * @param {Address} arg.body
361
+ * @returns {Promise<UpdateAddressResponse>} - Success response
362
+ * @summary: Update address added to an account
363
+ * @description: <p>Use this API to update an existing address in the account. Request object should contain attributes mentioned in <font color="blue">Address </font> can be updated. These attributes are:</p> <ul> <li> <font color="monochrome">is_default_address</font></li> <li> <font color="monochrome">landmark</font></li> <li> <font color="monochrome">area</font></li> <li> <font color="monochrome">pincode</font></li> <li> <font color="monochrome">email</font></li> <li> <font color="monochrome">address_type</font></li> <li> <font color="monochrome">name</font></li> <li> <font color="monochrome">address_id</font></li> <li> <font color="monochrome">address</font></li> </ul>
313
364
  */
314
- validateCouponForPayment({ id, buyNow, addressId, paymentMode, paymentIdentifier, aggregatorName, merchantCode, }?: {
315
- id?: string;
316
- buyNow?: boolean;
317
- addressId?: string;
318
- paymentMode?: string;
319
- paymentIdentifier?: string;
320
- aggregatorName?: string;
321
- merchantCode?: string;
322
- }): Promise<PaymentCouponValidate>;
365
+ updateAddress({ id, body }?: {
366
+ id: string;
367
+ body: Address;
368
+ }): Promise<UpdateAddressResponse>;
323
369
  /**
324
370
  * @param {Object} arg - Arg object.
325
- * @param {boolean} [arg.p] - This is a boolean value. Select `true` for
326
- * getting a payment option in response.
327
- * @param {string} [arg.id] - The unique identifier of the cart
371
+ * @param {string} [arg.id] -
372
+ * @param {boolean} [arg.i] -
373
+ * @param {boolean} [arg.b] -
374
+ * @param {string} [arg.areaCode] -
328
375
  * @param {boolean} [arg.buyNow] -
329
- * @param {string} [arg.addressId] - ID allotted to the selected address
330
- * @param {string} [arg.areaCode] - The PIN Code of the destination address,
331
- * e.g. 400059
332
- * @returns {Promise<CartShipmentsResponse>} - Success response
333
- * @summary: Get delivery date and options before checkout
334
- * @description: Use this API to get shipment details, expected delivery date, items and price breakup of the shipment.
376
+ * @param {UpdateCartRequest} arg.body
377
+ * @returns {Promise<UpdateCartDetailResponse>} - Success response
378
+ * @summary: Update items in the cart
379
+ * @description: <p>Use this API to update items added to the cart with the help of a request object containing attributes like item_quantity and item_size. These attributes will be fetched from the following APIs</p> <ul> <li><font color="monochrome">operation</font> Operation for current api call. <b>update_item</b> for update items. <b>remove_item</b> for removing items.</li> <li> <font color="monochrome">item_id</font> "/platform/content/v1/products/"</li> <li> <font color="monochrome">item_size</font> "/platform/content/v1/products/:slug/sizes/"</li> <li> <font color="monochrome">quantity</font> item quantity (must be greater than or equal to 1)</li> <li> <font color="monochrome">article_id</font> "/content​/v1​/products​/:identifier​/sizes​/price​/"</li> <li> <font color="monochrome">item_index</font> item position in the cart (must be greater than or equal to 0)</li> </ul>
335
380
  */
336
- getShipments({ p, id, buyNow, addressId, areaCode }?: {
337
- p?: boolean;
381
+ updateCart({ body, id, i, b, areaCode, buyNow }?: {
338
382
  id?: string;
339
- buyNow?: boolean;
340
- addressId?: string;
383
+ i?: boolean;
384
+ b?: boolean;
341
385
  areaCode?: string;
342
- }): Promise<CartShipmentsResponse>;
343
- /**
344
- * @param {Object} arg - Arg object.
345
- * @param {boolean} [arg.buyNow] - This indicates the type of cart to checkout
346
- * @param {CartCheckoutDetailRequest} arg.body
347
- * @returns {Promise<CartCheckoutResponse>} - Success response
348
- * @summary: Checkout all items in the cart
349
- * @description: Use this API to checkout all items in the cart for payment and order generation. For COD, order will be directly generated, whereas for other checkout modes, user will be redirected to a payment gateway.
350
- */
351
- checkoutCart({ body, buyNow }?: {
352
386
  buyNow?: boolean;
353
- body: CartCheckoutDetailRequest;
354
- }): Promise<CartCheckoutResponse>;
387
+ body: UpdateCartRequest;
388
+ }): Promise<UpdateCartDetailResponse>;
355
389
  /**
356
390
  * @param {Object} arg - Arg object.
357
391
  * @param {string} [arg.id] -
@@ -366,26 +400,6 @@ declare class Cart {
366
400
  buyNow?: boolean;
367
401
  body: CartMetaRequest;
368
402
  }): Promise<CartMetaResponse>;
369
- /**
370
- * @param {Object} arg - Arg object.
371
- * @param {GetShareCartLinkRequest} arg.body
372
- * @returns {Promise<GetShareCartLinkResponse>} - Success response
373
- * @summary: Generate token for sharing the cart
374
- * @description: Use this API to generate a shared cart snapshot and return a shortlink token. The link can be shared with other users for getting the same items in their cart.
375
- */
376
- getCartShareLink({ body }?: {
377
- body: GetShareCartLinkRequest;
378
- }): Promise<GetShareCartLinkResponse>;
379
- /**
380
- * @param {Object} arg - Arg object.
381
- * @param {string} arg.token - Token of the shared short link
382
- * @returns {Promise<SharedCartResponse>} - Success response
383
- * @summary: Get details of a shared cart
384
- * @description: Use this API to get the shared cart details as per the token generated using the share-cart API.
385
- */
386
- getCartSharedItems({ token }?: {
387
- token: string;
388
- }): Promise<SharedCartResponse>;
389
403
  /**
390
404
  * @param {Object} arg - Arg object.
391
405
  * @param {string} arg.token - Token of the shared short link
@@ -401,38 +415,24 @@ declare class Cart {
401
415
  }): Promise<SharedCartResponse>;
402
416
  /**
403
417
  * @param {Object} arg - Arg object.
404
- * @param {string} [arg.slug] - A short, human-readable, URL-friendly
405
- * identifier of a product. You can get slug value from the endpoint
406
- * /service/application/catalog/v1.0/products/
407
- * @param {number} [arg.pageSize] - Number of offers to be fetched to show
408
- * @param {string} [arg.promotionGroup] - Type of promotion groups
409
- * @returns {Promise<PromotionOffersResponse>} - Success response
410
- * @summary: Fetch available promotions
411
- * @description: Use this API to get top 5 offers available for current product
412
- */
413
- getPromotionOffers({ slug, pageSize, promotionGroup }?: {
414
- slug?: string;
415
- pageSize?: number;
416
- promotionGroup?: string;
417
- }): Promise<PromotionOffersResponse>;
418
- /**
419
- * @param {Object} arg - Arg object.
420
- * @param {string} arg.slug - A short, human-readable, URL-friendly
421
- * identifier of a product. You can get slug value from the endpoint
422
- * /service/application/catalog/v1.0/products/
423
- * @param {string} [arg.storeId] - Store uid of assigned store on PDP page.
424
- * If not passed default first created ladder will be returned
425
- * @param {string} [arg.promotionId] - Get ladder information of given
426
- * promotion id explicitely
427
- * @param {number} [arg.pageSize] - Number of offers to be fetched to show
428
- * @returns {Promise<LadderPriceOffers>} - Success response
429
- * @summary: Fetch ladder price promotion
430
- * @description: Use this API to get applicable ladder price promotion for current product
418
+ * @param {string} [arg.id] -
419
+ * @param {boolean} [arg.buyNow] -
420
+ * @param {string} [arg.addressId] -
421
+ * @param {string} [arg.paymentMode] -
422
+ * @param {string} [arg.paymentIdentifier] -
423
+ * @param {string} [arg.aggregatorName] -
424
+ * @param {string} [arg.merchantCode] -
425
+ * @returns {Promise<PaymentCouponValidate>} - Success response
426
+ * @summary: Verify the coupon eligibility against the payment mode
427
+ * @description: Use this API to validate a coupon against the payment mode such as NetBanking, Wallet, UPI etc.
431
428
  */
432
- getLadderOffers({ slug, storeId, promotionId, pageSize }?: {
433
- slug: string;
434
- storeId?: string;
435
- promotionId?: string;
436
- pageSize?: number;
437
- }): Promise<LadderPriceOffers>;
429
+ validateCouponForPayment({ id, buyNow, addressId, paymentMode, paymentIdentifier, aggregatorName, merchantCode, }?: {
430
+ id?: string;
431
+ buyNow?: boolean;
432
+ addressId?: string;
433
+ paymentMode?: string;
434
+ paymentIdentifier?: string;
435
+ aggregatorName?: string;
436
+ merchantCode?: string;
437
+ }): Promise<PaymentCouponValidate>;
438
438
  }