@gofynd/fdk-client-javascript 1.0.2 → 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 (310) 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 +557 -1279
  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 +14453 -17192
  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 +3438 -4172
  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 +3400 -5361
  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/Cart/CartApplicationClient.d.ts +243 -243
  44. package/sdk/application/Cart/CartApplicationClient.js +567 -567
  45. package/sdk/application/Cart/CartApplicationModel.d.ts +64 -63
  46. package/sdk/application/Cart/CartApplicationModel.js +489 -886
  47. package/sdk/application/Cart/CartApplicationValidator.d.ts +17 -17
  48. package/sdk/application/Cart/CartApplicationValidator.js +98 -98
  49. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +358 -358
  50. package/sdk/application/Catalog/CatalogApplicationClient.js +1036 -1036
  51. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +90 -90
  52. package/sdk/application/Catalog/CatalogApplicationModel.js +677 -1243
  53. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +19 -19
  54. package/sdk/application/Catalog/CatalogApplicationValidator.js +110 -110
  55. package/sdk/application/Common/CommonApplicationClient.d.ts +13 -13
  56. package/sdk/application/Common/CommonApplicationClient.js +38 -38
  57. package/sdk/application/Common/CommonApplicationModel.d.ts +12 -12
  58. package/sdk/application/Common/CommonApplicationModel.js +83 -160
  59. package/sdk/application/Common/CommonApplicationValidator.d.ts +1 -1
  60. package/sdk/application/Common/CommonApplicationValidator.js +6 -6
  61. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +11 -11
  62. package/sdk/application/Communication/CommunicationApplicationClient.js +26 -26
  63. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +6 -6
  64. package/sdk/application/Communication/CommunicationApplicationModel.js +38 -83
  65. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
  66. package/sdk/application/Communication/CommunicationApplicationValidator.js +4 -4
  67. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +116 -116
  68. package/sdk/application/Configuration/ConfigurationApplicationClient.js +330 -330
  69. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +85 -85
  70. package/sdk/application/Configuration/ConfigurationApplicationModel.js +480 -851
  71. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +8 -8
  72. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +33 -33
  73. package/sdk/application/Content/ContentApplicationClient.d.ts +67 -67
  74. package/sdk/application/Content/ContentApplicationClient.js +191 -191
  75. package/sdk/application/Content/ContentApplicationModel.d.ts +76 -76
  76. package/sdk/application/Content/ContentApplicationModel.js +467 -884
  77. package/sdk/application/Content/ContentApplicationValidator.d.ts +5 -5
  78. package/sdk/application/Content/ContentApplicationValidator.js +24 -24
  79. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +25 -25
  80. package/sdk/application/FileStorage/FileStorageApplicationClient.js +59 -59
  81. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +13 -13
  82. package/sdk/application/FileStorage/FileStorageApplicationModel.js +86 -169
  83. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +1 -1
  84. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +7 -7
  85. package/sdk/application/Lead/LeadApplicationClient.d.ts +24 -24
  86. package/sdk/application/Lead/LeadApplicationClient.js +100 -100
  87. package/sdk/application/Lead/LeadApplicationModel.d.ts +35 -35
  88. package/sdk/application/Lead/LeadApplicationModel.js +267 -474
  89. package/sdk/application/Lead/LeadApplicationValidator.d.ts +2 -2
  90. package/sdk/application/Lead/LeadApplicationValidator.js +11 -11
  91. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +30 -19
  92. package/sdk/application/Logistic/LogisticApplicationClient.js +110 -43
  93. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +17 -14
  94. package/sdk/application/Logistic/LogisticApplicationModel.js +133 -201
  95. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +3 -2
  96. package/sdk/application/Logistic/LogisticApplicationValidator.js +14 -8
  97. package/sdk/application/Order/OrderApplicationClient.d.ts +85 -85
  98. package/sdk/application/Order/OrderApplicationClient.js +232 -232
  99. package/sdk/application/Order/OrderApplicationModel.d.ts +50 -50
  100. package/sdk/application/Order/OrderApplicationModel.js +352 -656
  101. package/sdk/application/Order/OrderApplicationValidator.d.ts +7 -7
  102. package/sdk/application/Order/OrderApplicationValidator.js +28 -28
  103. package/sdk/application/Payment/PaymentApplicationClient.d.ts +318 -318
  104. package/sdk/application/Payment/PaymentApplicationClient.js +739 -739
  105. package/sdk/application/Payment/PaymentApplicationModel.d.ts +72 -72
  106. package/sdk/application/Payment/PaymentApplicationModel.js +570 -1038
  107. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +28 -28
  108. package/sdk/application/Payment/PaymentApplicationValidator.js +107 -107
  109. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +254 -254
  110. package/sdk/application/PosCart/PosCartApplicationClient.js +617 -617
  111. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +64 -63
  112. package/sdk/application/PosCart/PosCartApplicationModel.js +475 -871
  113. package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +18 -18
  114. package/sdk/application/PosCart/PosCartApplicationValidator.js +103 -103
  115. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +27 -27
  116. package/sdk/application/Rewards/RewardsApplicationClient.js +112 -112
  117. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +14 -14
  118. package/sdk/application/Rewards/RewardsApplicationModel.js +96 -191
  119. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +3 -3
  120. package/sdk/application/Rewards/RewardsApplicationValidator.js +12 -12
  121. package/sdk/application/Share/ShareApplicationClient.d.ts +37 -37
  122. package/sdk/application/Share/ShareApplicationClient.js +84 -84
  123. package/sdk/application/Share/ShareApplicationModel.d.ts +8 -8
  124. package/sdk/application/Share/ShareApplicationModel.js +63 -123
  125. package/sdk/application/Share/ShareApplicationValidator.d.ts +4 -4
  126. package/sdk/application/Share/ShareApplicationValidator.js +12 -12
  127. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
  128. package/sdk/application/Theme/ThemeApplicationClient.js +31 -31
  129. package/sdk/application/Theme/ThemeApplicationModel.d.ts +34 -34
  130. package/sdk/application/Theme/ThemeApplicationModel.js +190 -336
  131. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +1 -1
  132. package/sdk/application/Theme/ThemeApplicationValidator.js +4 -4
  133. package/sdk/application/User/UserApplicationClient.d.ts +280 -280
  134. package/sdk/application/User/UserApplicationClient.js +581 -581
  135. package/sdk/application/User/UserApplicationModel.d.ts +79 -72
  136. package/sdk/application/User/UserApplicationModel.js +440 -689
  137. package/sdk/application/User/UserApplicationValidator.d.ts +24 -24
  138. package/sdk/application/User/UserApplicationValidator.js +89 -89
  139. package/sdk/common/AxiosHelper.js +1 -1
  140. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +51 -51
  141. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +179 -179
  142. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +6 -6
  143. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +20 -20
  144. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +11 -11
  145. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +95 -178
  146. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +10 -10
  147. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +41 -41
  148. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +10 -10
  149. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +50 -89
  150. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -1
  151. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +6 -6
  152. package/sdk/platform/Billing/BillingPlatformClient.d.ts +60 -60
  153. package/sdk/platform/Billing/BillingPlatformClient.js +181 -181
  154. package/sdk/platform/Billing/BillingPlatformModel.d.ts +40 -40
  155. package/sdk/platform/Billing/BillingPlatformModel.js +342 -668
  156. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +8 -8
  157. package/sdk/platform/Billing/BillingPlatformValidator.js +25 -25
  158. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +168 -168
  159. package/sdk/platform/Cart/CartPlatformApplicationClient.js +553 -553
  160. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +11 -11
  161. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +63 -63
  162. package/sdk/platform/Cart/CartPlatformModel.d.ts +84 -83
  163. package/sdk/platform/Cart/CartPlatformModel.js +671 -1205
  164. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +632 -632
  165. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1525 -1525
  166. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +40 -40
  167. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +174 -174
  168. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +682 -682
  169. package/sdk/platform/Catalog/CatalogPlatformClient.js +1557 -1557
  170. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +291 -291
  171. package/sdk/platform/Catalog/CatalogPlatformModel.js +2127 -3904
  172. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +66 -66
  173. package/sdk/platform/Catalog/CatalogPlatformValidator.js +229 -229
  174. package/sdk/platform/Common/CommonPlatformClient.d.ts +12 -12
  175. package/sdk/platform/Common/CommonPlatformClient.js +41 -41
  176. package/sdk/platform/Common/CommonPlatformModel.d.ts +12 -12
  177. package/sdk/platform/Common/CommonPlatformModel.js +83 -160
  178. package/sdk/platform/Common/CommonPlatformValidator.d.ts +1 -1
  179. package/sdk/platform/Common/CommonPlatformValidator.js +6 -6
  180. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +326 -326
  181. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +943 -943
  182. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +30 -30
  183. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +87 -87
  184. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +67 -67
  185. package/sdk/platform/Communication/CommunicationPlatformModel.js +522 -974
  186. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +55 -55
  187. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +212 -212
  188. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +27 -27
  189. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +279 -542
  190. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +7 -7
  191. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +24 -24
  192. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +163 -153
  193. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +615 -552
  194. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +22 -21
  195. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +69 -63
  196. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +125 -125
  197. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +342 -342
  198. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +148 -146
  199. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +854 -1508
  200. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -9
  201. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +38 -38
  202. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +534 -534
  203. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1324 -1324
  204. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +50 -50
  205. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +156 -156
  206. package/sdk/platform/Content/ContentPlatformModel.d.ts +78 -78
  207. package/sdk/platform/Content/ContentPlatformModel.js +484 -907
  208. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +65 -65
  209. package/sdk/platform/Discount/DiscountPlatformClient.js +216 -216
  210. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +7 -7
  211. package/sdk/platform/Discount/DiscountPlatformModel.js +60 -121
  212. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +6 -6
  213. package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -29
  214. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +24 -24
  215. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +58 -58
  216. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
  217. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +8 -8
  218. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +52 -52
  219. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +123 -123
  220. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -13
  221. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +86 -169
  222. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +3 -3
  223. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +11 -11
  224. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +63 -63
  225. package/sdk/platform/Inventory/InventoryPlatformClient.js +228 -228
  226. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +30 -30
  227. package/sdk/platform/Inventory/InventoryPlatformModel.js +497 -964
  228. package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +7 -7
  229. package/sdk/platform/Inventory/InventoryPlatformValidator.js +28 -28
  230. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +73 -73
  231. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +200 -200
  232. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +7 -7
  233. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +28 -28
  234. package/sdk/platform/Lead/LeadPlatformClient.d.ts +80 -80
  235. package/sdk/platform/Lead/LeadPlatformClient.js +212 -212
  236. package/sdk/platform/Lead/LeadPlatformModel.d.ts +35 -35
  237. package/sdk/platform/Lead/LeadPlatformModel.js +267 -474
  238. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +6 -6
  239. package/sdk/platform/Lead/LeadPlatformValidator.js +24 -24
  240. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +10 -10
  241. package/sdk/platform/Order/OrderPlatformApplicationClient.js +65 -65
  242. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -1
  243. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +6 -6
  244. package/sdk/platform/Order/OrderPlatformClient.d.ts +357 -357
  245. package/sdk/platform/Order/OrderPlatformClient.js +1035 -1035
  246. package/sdk/platform/Order/OrderPlatformModel.d.ts +198 -196
  247. package/sdk/platform/Order/OrderPlatformModel.js +1574 -2861
  248. package/sdk/platform/Order/OrderPlatformValidator.d.ts +32 -32
  249. package/sdk/platform/Order/OrderPlatformValidator.js +160 -160
  250. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +1 -1
  251. package/sdk/platform/Partner/PartnerPlatformModel.js +10 -26
  252. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +57 -57
  253. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +167 -167
  254. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +6 -6
  255. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +23 -23
  256. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +42 -42
  257. package/sdk/platform/Payment/PaymentPlatformClient.js +153 -153
  258. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +27 -27
  259. package/sdk/platform/Payment/PaymentPlatformModel.js +222 -410
  260. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +4 -4
  261. package/sdk/platform/Payment/PaymentPlatformValidator.js +21 -21
  262. package/sdk/platform/PlatformApplicationClient.d.ts +1496 -10325
  263. package/sdk/platform/PlatformApplicationClient.js +1584 -13899
  264. package/sdk/platform/PlatformClient.d.ts +7965 -7885
  265. package/sdk/platform/PlatformClient.js +8672 -10105
  266. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +83 -83
  267. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +275 -275
  268. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +8 -8
  269. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +34 -34
  270. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +15 -15
  271. package/sdk/platform/Rewards/RewardsPlatformModel.js +92 -194
  272. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -10
  273. package/sdk/platform/Share/SharePlatformApplicationClient.js +59 -59
  274. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
  275. package/sdk/platform/Share/SharePlatformApplicationValidator.js +6 -6
  276. package/sdk/platform/Share/SharePlatformModel.d.ts +8 -8
  277. package/sdk/platform/Share/SharePlatformModel.js +60 -118
  278. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +132 -132
  279. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +310 -310
  280. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +15 -15
  281. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +44 -44
  282. package/sdk/platform/Theme/ThemePlatformModel.d.ts +34 -34
  283. package/sdk/platform/Theme/ThemePlatformModel.js +190 -336
  284. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +136 -69
  285. package/sdk/platform/User/UserPlatformApplicationClient.js +505 -166
  286. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +12 -7
  287. package/sdk/platform/User/UserPlatformApplicationValidator.js +61 -23
  288. package/sdk/platform/User/UserPlatformModel.d.ts +79 -72
  289. package/sdk/platform/User/UserPlatformModel.js +440 -689
  290. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +31 -31
  291. package/sdk/platform/Webhook/WebhookPlatformClient.js +88 -88
  292. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +7 -7
  293. package/sdk/platform/Webhook/WebhookPlatformModel.js +68 -136
  294. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +3 -3
  295. package/sdk/platform/Webhook/WebhookPlatformValidator.js +14 -14
  296. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +13 -13
  297. package/sdk/public/Configuration/ConfigurationPublicClient.js +38 -38
  298. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +12 -12
  299. package/sdk/public/Configuration/ConfigurationPublicModel.js +85 -162
  300. package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +1 -1
  301. package/sdk/public/Configuration/ConfigurationPublicValidator.js +6 -6
  302. package/sdk/public/Inventory/InventoryPublicClient.d.ts +34 -34
  303. package/sdk/public/Inventory/InventoryPublicClient.js +113 -113
  304. package/sdk/public/Inventory/InventoryPublicModel.d.ts +10 -10
  305. package/sdk/public/Inventory/InventoryPublicModel.js +119 -245
  306. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +3 -3
  307. package/sdk/public/Inventory/InventoryPublicValidator.js +15 -15
  308. package/sdk/public/Webhook/WebhookPublicModel.d.ts +7 -7
  309. package/sdk/public/Webhook/WebhookPublicModel.js +68 -136
  310. package/tests/application/catalog.spec.js +7 -0
@@ -3,66 +3,46 @@ declare class PosCart {
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
+ getAvailableDeliveryModes: string;
14
+ getBulkDiscountOffers: string;
15
+ getCart: string;
16
+ getCartLastModified: string;
17
+ getCartShareLink: string;
18
+ getCartSharedItems: string;
19
+ getCoupons: string;
20
+ getItemCount: string;
21
+ getShipments: string;
22
+ getStoreAddressByUid: string;
20
23
  removeAddress: string;
24
+ removeCoupon: string;
21
25
  selectAddress: string;
22
26
  selectPaymentMode: string;
23
- validateCouponForPayment: string;
24
- getShipments: string;
25
- updateShipments: string;
26
- checkoutCart: string;
27
+ updateAddress: string;
28
+ updateCart: string;
27
29
  updateCartMeta: string;
28
- getAvailableDeliveryModes: string;
29
- getStoreAddressByUid: string;
30
- getCartShareLink: string;
31
- getCartSharedItems: string;
32
30
  updateCartWithSharedItems: string;
31
+ updateShipments: string;
32
+ validateCouponForPayment: string;
33
33
  };
34
34
  _urls: {};
35
35
  updateUrls(urls: any): void;
36
36
  /**
37
37
  * @param {Object} arg - Arg object.
38
- * @param {string} [arg.id] -
39
- * @param {boolean} [arg.i] -
40
- * @param {boolean} [arg.b] -
41
- * @param {number} [arg.assignCardId] -
42
- * @param {string} [arg.areaCode] -
43
- * @param {boolean} [arg.buyNow] -
44
- * @returns {Promise<CartDetailResponse>} - Success response
45
- * @summary: Fetch all items added to the cart
46
- * @description: Use this API to get details of all the items added to a cart.
47
- */
48
- getCart({ id, i, b, assignCardId, areaCode, buyNow }?: {
49
- id?: string;
50
- i?: boolean;
51
- b?: boolean;
52
- assignCardId?: number;
53
- areaCode?: string;
54
- buyNow?: boolean;
55
- }): Promise<CartDetailResponse>;
56
- /**
57
- * @param {Object} arg - Arg object.
58
- * @param {string} [arg.id] -
59
- * @returns {Promise<any>} - Success response
60
- * @summary: Fetch last-modified timestamp
61
- * @description: Use this API to fetch Last-Modified timestamp in header metadata.
38
+ * @param {Address} arg.body
39
+ * @returns {Promise<SaveAddressResponse>} - Success response
40
+ * @summary: Add address to an account
41
+ * @description: Use this API to add an address to an account.
62
42
  */
63
- getCartLastModified({ id }?: {
64
- id?: string;
65
- }): Promise<any>;
43
+ addAddress({ body }?: {
44
+ body: Address;
45
+ }): Promise<SaveAddressResponse>;
66
46
  /**
67
47
  * @param {Object} arg - Arg object.
68
48
  * @param {boolean} [arg.i] -
@@ -81,50 +61,6 @@ declare class PosCart {
81
61
  buyNow?: boolean;
82
62
  body: AddCartRequest;
83
63
  }): Promise<AddCartDetailResponse>;
84
- /**
85
- * @param {Object} arg - Arg object.
86
- * @param {string} [arg.id] -
87
- * @param {boolean} [arg.i] -
88
- * @param {boolean} [arg.b] -
89
- * @param {string} [arg.areaCode] -
90
- * @param {boolean} [arg.buyNow] -
91
- * @param {UpdateCartRequest} arg.body
92
- * @returns {Promise<UpdateCartDetailResponse>} - Success response
93
- * @summary: Update items in the cart
94
- * @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>
95
- */
96
- updateCart({ body, id, i, b, areaCode, buyNow }?: {
97
- id?: string;
98
- i?: boolean;
99
- b?: boolean;
100
- areaCode?: string;
101
- buyNow?: boolean;
102
- body: UpdateCartRequest;
103
- }): Promise<UpdateCartDetailResponse>;
104
- /**
105
- * @param {Object} arg - Arg object.
106
- * @param {string} [arg.id] - The unique identifier of the cart.
107
- * @param {boolean} [arg.buyNow] -
108
- * @returns {Promise<CartItemCountResponse>} - Success response
109
- * @summary: Count items in the cart
110
- * @description: Use this API to get the total number of items present in cart.
111
- */
112
- getItemCount({ id, buyNow }?: {
113
- id?: string;
114
- buyNow?: boolean;
115
- }): Promise<CartItemCountResponse>;
116
- /**
117
- * @param {Object} arg - Arg object.
118
- * @param {string} [arg.id] -
119
- * @param {boolean} [arg.buyNow] -
120
- * @returns {Promise<GetCouponResponse>} - Success response
121
- * @summary: Fetch Coupon
122
- * @description: Use this API to get a list of available coupons along with their details.
123
- */
124
- getCoupons({ id, buyNow }?: {
125
- id?: string;
126
- buyNow?: boolean;
127
- }): Promise<GetCouponResponse>;
128
64
  /**
129
65
  * @param {Object} arg - Arg object.
130
66
  * @param {boolean} [arg.i] -
@@ -145,36 +81,6 @@ declare class PosCart {
145
81
  buyNow?: boolean;
146
82
  body: ApplyCouponRequest;
147
83
  }): Promise<CartDetailResponse>;
148
- /**
149
- * @param {Object} arg - Arg object.
150
- * @param {string} [arg.id] -
151
- * @param {boolean} [arg.buyNow] -
152
- * @returns {Promise<CartDetailResponse>} - Success response
153
- * @summary: Remove Coupon Applied
154
- * @description: Remove Coupon applied on the cart by passing uid in request body.
155
- */
156
- removeCoupon({ id, buyNow }?: {
157
- id?: string;
158
- buyNow?: boolean;
159
- }): Promise<CartDetailResponse>;
160
- /**
161
- * @param {Object} arg - Arg object.
162
- * @param {number} [arg.itemId] - The Item ID of the product
163
- * @param {string} [arg.articleId] - Article Mongo ID
164
- * @param {number} [arg.uid] - UID of the product
165
- * @param {string} [arg.slug] - A short, human-readable, URL-friendly
166
- * identifier of a product. You can get slug value from the endpoint
167
- * /service/application/catalog/v1.0/products/
168
- * @returns {Promise<BulkPriceResponse>} - Success response
169
- * @summary: Get discount offers based on quantity
170
- * @description: Use this API to get a list of applicable offers along with current, next and best offer for given product. Either one of uid, item_id, slug should be present.
171
- */
172
- getBulkDiscountOffers({ itemId, articleId, uid, slug }?: {
173
- itemId?: number;
174
- articleId?: string;
175
- uid?: number;
176
- slug?: string;
177
- }): Promise<BulkPriceResponse>;
178
84
  /**
179
85
  * @param {Object} arg - Arg object.
180
86
  * @param {string} [arg.id] -
@@ -195,132 +101,162 @@ declare class PosCart {
195
101
  }): Promise<CartDetailResponse>;
196
102
  /**
197
103
  * @param {Object} arg - Arg object.
104
+ * @param {string} [arg.id] -
105
+ * @param {CartPosCheckoutDetailRequest} arg.body
106
+ * @returns {Promise<CartCheckoutResponse>} - Success response
107
+ * @summary: Checkout all items in the cart
108
+ * @description: Use this API to checkout all items in the cart for payment and order generation. For COD, order will be generated directly, whereas for other checkout modes, user will be redirected to a payment gateway.
109
+ */
110
+ checkoutCart({ body, id }?: {
111
+ id?: string;
112
+ body: CartPosCheckoutDetailRequest;
113
+ }): Promise<CartCheckoutResponse>;
114
+ /**
115
+ * @param {Object} arg - Arg object.
116
+ * @param {string} arg.id -
198
117
  * @param {string} [arg.cartId] -
199
118
  * @param {boolean} [arg.buyNow] -
200
119
  * @param {string} [arg.mobileNo] -
201
120
  * @param {string} [arg.checkoutMode] -
202
121
  * @param {string} [arg.tags] -
203
122
  * @param {boolean} [arg.isDefault] -
204
- * @returns {Promise<GetAddressesResponse>} - Success response
205
- * @summary: Fetch address
206
- * @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>
123
+ * @returns {Promise<Address>} - Success response
124
+ * @summary: Fetch a single address by its ID
125
+ * @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>
207
126
  */
208
- getAddresses({ cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, }?: {
127
+ getAddressById({ id, cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, }?: {
128
+ id: string;
209
129
  cartId?: string;
210
130
  buyNow?: boolean;
211
131
  mobileNo?: string;
212
132
  checkoutMode?: string;
213
133
  tags?: string;
214
134
  isDefault?: boolean;
215
- }): Promise<GetAddressesResponse>;
216
- /**
217
- * @param {Object} arg - Arg object.
218
- * @param {Address} arg.body
219
- * @returns {Promise<SaveAddressResponse>} - Success response
220
- * @summary: Add address to an account
221
- * @description: Use this API to add an address to an account.
222
- */
223
- addAddress({ body }?: {
224
- body: Address;
225
- }): Promise<SaveAddressResponse>;
135
+ }): Promise<Address>;
226
136
  /**
227
137
  * @param {Object} arg - Arg object.
228
- * @param {string} arg.id -
229
138
  * @param {string} [arg.cartId] -
230
139
  * @param {boolean} [arg.buyNow] -
231
140
  * @param {string} [arg.mobileNo] -
232
141
  * @param {string} [arg.checkoutMode] -
233
142
  * @param {string} [arg.tags] -
234
143
  * @param {boolean} [arg.isDefault] -
235
- * @returns {Promise<Address>} - Success response
236
- * @summary: Fetch a single address by its ID
237
- * @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>
144
+ * @returns {Promise<GetAddressesResponse>} - Success response
145
+ * @summary: Fetch address
146
+ * @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>
238
147
  */
239
- getAddressById({ id, cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, }?: {
240
- id: string;
148
+ getAddresses({ cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, }?: {
241
149
  cartId?: string;
242
150
  buyNow?: boolean;
243
151
  mobileNo?: string;
244
152
  checkoutMode?: string;
245
153
  tags?: string;
246
154
  isDefault?: boolean;
247
- }): Promise<Address>;
155
+ }): Promise<GetAddressesResponse>;
248
156
  /**
249
157
  * @param {Object} arg - Arg object.
250
- * @param {string} arg.id - ID allotted to the selected address
251
- * @param {Address} arg.body
252
- * @returns {Promise<UpdateAddressResponse>} - Success response
253
- * @summary: Update address added to an account
254
- * @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>
158
+ * @param {string} arg.areaCode -
159
+ * @param {string} [arg.id] -
160
+ * @returns {Promise<CartDeliveryModesResponse>} - Success response
161
+ * @summary: Get available delivery modes for cart
162
+ * @description: Use this API to get the delivery modes (home-delivery/store-pickup) along with a list of pickup stores available for a given cart at a given PIN Code. User can then view the address of a pickup store with the help of store-address API.
255
163
  */
256
- updateAddress({ id, body }?: {
257
- id: string;
258
- body: Address;
259
- }): Promise<UpdateAddressResponse>;
164
+ getAvailableDeliveryModes({ areaCode, id }?: {
165
+ areaCode: string;
166
+ id?: string;
167
+ }): Promise<CartDeliveryModesResponse>;
260
168
  /**
261
169
  * @param {Object} arg - Arg object.
262
- * @param {string} arg.id - ID allotted to the selected address
263
- * @returns {Promise<DeleteAddressResponse>} - Success response
264
- * @summary: Remove address associated with an account
265
- * @description: Use this API to delete an address by its ID. This will returns an object that will indicate whether the address was deleted successfully or not.
170
+ * @param {number} [arg.itemId] - The Item ID of the product
171
+ * @param {string} [arg.articleId] - Article Mongo ID
172
+ * @param {number} [arg.uid] - UID of the product
173
+ * @param {string} [arg.slug] - A short, human-readable, URL-friendly
174
+ * identifier of a product. You can get slug value from the endpoint
175
+ * /service/application/catalog/v1.0/products/
176
+ * @returns {Promise<BulkPriceResponse>} - Success response
177
+ * @summary: Get discount offers based on quantity
178
+ * @description: Use this API to get a list of applicable offers along with current, next and best offer for given product. Either one of uid, item_id, slug should be present.
266
179
  */
267
- removeAddress({ id }?: {
268
- id: string;
269
- }): Promise<DeleteAddressResponse>;
180
+ getBulkDiscountOffers({ itemId, articleId, uid, slug }?: {
181
+ itemId?: number;
182
+ articleId?: string;
183
+ uid?: number;
184
+ slug?: string;
185
+ }): Promise<BulkPriceResponse>;
270
186
  /**
271
187
  * @param {Object} arg - Arg object.
272
- * @param {string} [arg.cartId] -
273
- * @param {boolean} [arg.buyNow] -
188
+ * @param {string} [arg.id] -
274
189
  * @param {boolean} [arg.i] -
275
190
  * @param {boolean} [arg.b] -
276
- * @param {SelectCartAddressRequest} arg.body
191
+ * @param {number} [arg.assignCardId] -
192
+ * @param {string} [arg.areaCode] -
193
+ * @param {boolean} [arg.buyNow] -
277
194
  * @returns {Promise<CartDetailResponse>} - Success response
278
- * @summary: Select an address from available addresses
279
- * @description: <p>Select Address from all addresses associated with the account in order to ship the cart items to that address, otherwise default address will be selected implicitly. See `SelectCartAddressRequest` in schema of request body for the list of attributes needed to select Address from account. On successful request, this API returns a Cart object. Below address attributes are required. <ul> <li> <font color="monochrome">address_id</font></li> <li> <font color="monochrome">billing_address_id</font></li> <li> <font color="monochrome">uid</font></li> </ul></p>
195
+ * @summary: Fetch all items added to the cart
196
+ * @description: Use this API to get details of all the items added to a cart.
280
197
  */
281
- selectAddress({ body, cartId, buyNow, i, b }?: {
282
- cartId?: string;
283
- buyNow?: boolean;
198
+ getCart({ id, i, b, assignCardId, areaCode, buyNow }?: {
199
+ id?: string;
284
200
  i?: boolean;
285
201
  b?: boolean;
286
- body: SelectCartAddressRequest;
202
+ assignCardId?: number;
203
+ areaCode?: string;
204
+ buyNow?: boolean;
287
205
  }): Promise<CartDetailResponse>;
206
+ /**
207
+ * @param {Object} arg - Arg object.
208
+ * @param {string} [arg.id] -
209
+ * @returns {Promise<any>} - Success response
210
+ * @summary: Fetch last-modified timestamp
211
+ * @description: Use this API to fetch Last-Modified timestamp in header metadata.
212
+ */
213
+ getCartLastModified({ id }?: {
214
+ id?: string;
215
+ }): Promise<any>;
216
+ /**
217
+ * @param {Object} arg - Arg object.
218
+ * @param {GetShareCartLinkRequest} arg.body
219
+ * @returns {Promise<GetShareCartLinkResponse>} - Success response
220
+ * @summary: Generate token for sharing the cart
221
+ * @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.
222
+ */
223
+ getCartShareLink({ body }?: {
224
+ body: GetShareCartLinkRequest;
225
+ }): Promise<GetShareCartLinkResponse>;
226
+ /**
227
+ * @param {Object} arg - Arg object.
228
+ * @param {string} arg.token - Token of the shared short link
229
+ * @returns {Promise<SharedCartResponse>} - Success response
230
+ * @summary: Get details of a shared cart
231
+ * @description: Use this API to get the shared cart details as per the token generated using the share-cart API.
232
+ */
233
+ getCartSharedItems({ token }?: {
234
+ token: string;
235
+ }): Promise<SharedCartResponse>;
288
236
  /**
289
237
  * @param {Object} arg - Arg object.
290
238
  * @param {string} [arg.id] -
291
239
  * @param {boolean} [arg.buyNow] -
292
- * @param {UpdateCartPaymentRequest} arg.body
293
- * @returns {Promise<CartDetailResponse>} - Success response
294
- * @summary: Update cart payment
295
- * @description: Use this API to update cart payment.
240
+ * @returns {Promise<GetCouponResponse>} - Success response
241
+ * @summary: Fetch Coupon
242
+ * @description: Use this API to get a list of available coupons along with their details.
296
243
  */
297
- selectPaymentMode({ body, id, buyNow }?: {
244
+ getCoupons({ id, buyNow }?: {
298
245
  id?: string;
299
246
  buyNow?: boolean;
300
- body: UpdateCartPaymentRequest;
301
- }): Promise<CartDetailResponse>;
247
+ }): Promise<GetCouponResponse>;
302
248
  /**
303
249
  * @param {Object} arg - Arg object.
304
- * @param {string} [arg.id] -
250
+ * @param {string} [arg.id] - The unique identifier of the cart.
305
251
  * @param {boolean} [arg.buyNow] -
306
- * @param {string} [arg.addressId] -
307
- * @param {string} [arg.paymentMode] -
308
- * @param {string} [arg.paymentIdentifier] -
309
- * @param {string} [arg.aggregatorName] -
310
- * @param {string} [arg.merchantCode] -
311
- * @returns {Promise<PaymentCouponValidate>} - Success response
312
- * @summary: Verify the coupon eligibility against the payment mode
313
- * @description: Use this API to validate a coupon against the payment mode such as NetBanking, Wallet, UPI etc.
252
+ * @returns {Promise<CartItemCountResponse>} - Success response
253
+ * @summary: Count items in the cart
254
+ * @description: Use this API to get the total number of items present in cart.
314
255
  */
315
- validateCouponForPayment({ id, buyNow, addressId, paymentMode, paymentIdentifier, aggregatorName, merchantCode, }?: {
256
+ getItemCount({ id, buyNow }?: {
316
257
  id?: string;
317
258
  buyNow?: boolean;
318
- addressId?: string;
319
- paymentMode?: string;
320
- paymentIdentifier?: string;
321
- aggregatorName?: string;
322
- merchantCode?: string;
323
- }): Promise<PaymentCouponValidate>;
259
+ }): Promise<CartItemCountResponse>;
324
260
  /**
325
261
  * @param {Object} arg - Arg object.
326
262
  * @param {number} [arg.pickAtStoreUid] -
@@ -349,96 +285,114 @@ declare class PosCart {
349
285
  }): Promise<CartShipmentsResponse>;
350
286
  /**
351
287
  * @param {Object} arg - Arg object.
352
- * @param {boolean} [arg.i] - This is a boolean value. Select `true` to
353
- * retrieve all the items added in the cart.
354
- * @param {boolean} [arg.p] - This is a boolean value. Select `true` for
355
- * getting a payment option in response.
356
- * @param {string} [arg.id] - The unique identifier of the cart
357
- * @param {string} [arg.addressId] - ID allotted to an address
358
- * @param {string} [arg.orderType] - The order type of shipment HomeDelivery
359
- * - If the customer wants the order home-delivered PickAtStore - If the
360
- * customer wants the handover of an order at the store itself.
361
- * @param {UpdateCartShipmentRequest} arg.body
362
- * @returns {Promise<CartShipmentsResponse>} - Success response
363
- * @summary: Update shipment delivery type and quantity before checkout
364
- * @description: Use this API to update the delivery type and quantity as per customer's preference for either store pick-up or home-delivery.
288
+ * @param {number} arg.storeUid -
289
+ * @returns {Promise<StoreDetailsResponse>} - Success response
290
+ * @summary: Get list of stores for give uids
291
+ * @description: Use this API to get the store details by entering the unique identifier of the pickup stores shown in the response of available-delivery-mode API.
365
292
  */
366
- updateShipments({ body, i, p, id, addressId, orderType }?: {
367
- i?: boolean;
368
- p?: boolean;
369
- id?: string;
370
- addressId?: string;
371
- orderType?: string;
372
- body: UpdateCartShipmentRequest;
373
- }): Promise<CartShipmentsResponse>;
293
+ getStoreAddressByUid({ storeUid }?: {
294
+ storeUid: number;
295
+ }): Promise<StoreDetailsResponse>;
374
296
  /**
375
297
  * @param {Object} arg - Arg object.
376
- * @param {string} [arg.id] -
377
- * @param {CartPosCheckoutDetailRequest} arg.body
378
- * @returns {Promise<CartCheckoutResponse>} - Success response
379
- * @summary: Checkout all items in the cart
380
- * @description: Use this API to checkout all items in the cart for payment and order generation. For COD, order will be generated directly, whereas for other checkout modes, user will be redirected to a payment gateway.
298
+ * @param {string} arg.id - ID allotted to the selected address
299
+ * @returns {Promise<DeleteAddressResponse>} - Success response
300
+ * @summary: Remove address associated with an account
301
+ * @description: Use this API to delete an address by its ID. This will returns an object that will indicate whether the address was deleted successfully or not.
381
302
  */
382
- checkoutCart({ body, id }?: {
383
- id?: string;
384
- body: CartPosCheckoutDetailRequest;
385
- }): Promise<CartCheckoutResponse>;
303
+ removeAddress({ id }?: {
304
+ id: string;
305
+ }): Promise<DeleteAddressResponse>;
386
306
  /**
387
307
  * @param {Object} arg - Arg object.
388
308
  * @param {string} [arg.id] -
389
309
  * @param {boolean} [arg.buyNow] -
390
- * @param {CartMetaRequest} arg.body
391
- * @returns {Promise<CartMetaResponse>} - Success response
392
- * @summary: Update the cart meta
393
- * @description: Use this API to update cart meta like checkout_mode and gstin.
310
+ * @returns {Promise<CartDetailResponse>} - Success response
311
+ * @summary: Remove Coupon Applied
312
+ * @description: Remove Coupon applied on the cart by passing uid in request body.
394
313
  */
395
- updateCartMeta({ body, id, buyNow }?: {
314
+ removeCoupon({ id, buyNow }?: {
396
315
  id?: string;
397
316
  buyNow?: boolean;
398
- body: CartMetaRequest;
399
- }): Promise<CartMetaResponse>;
317
+ }): Promise<CartDetailResponse>;
318
+ /**
319
+ * @param {Object} arg - Arg object.
320
+ * @param {string} [arg.cartId] -
321
+ * @param {boolean} [arg.buyNow] -
322
+ * @param {boolean} [arg.i] -
323
+ * @param {boolean} [arg.b] -
324
+ * @param {SelectCartAddressRequest} arg.body
325
+ * @returns {Promise<CartDetailResponse>} - Success response
326
+ * @summary: Select an address from available addresses
327
+ * @description: <p>Select Address from all addresses associated with the account in order to ship the cart items to that address, otherwise default address will be selected implicitly. See `SelectCartAddressRequest` in schema of request body for the list of attributes needed to select Address from account. On successful request, this API returns a Cart object. Below address attributes are required. <ul> <li> <font color="monochrome">address_id</font></li> <li> <font color="monochrome">billing_address_id</font></li> <li> <font color="monochrome">uid</font></li> </ul></p>
328
+ */
329
+ selectAddress({ body, cartId, buyNow, i, b }?: {
330
+ cartId?: string;
331
+ buyNow?: boolean;
332
+ i?: boolean;
333
+ b?: boolean;
334
+ body: SelectCartAddressRequest;
335
+ }): Promise<CartDetailResponse>;
400
336
  /**
401
337
  * @param {Object} arg - Arg object.
402
- * @param {string} arg.areaCode -
403
338
  * @param {string} [arg.id] -
404
- * @returns {Promise<CartDeliveryModesResponse>} - Success response
405
- * @summary: Get available delivery modes for cart
406
- * @description: Use this API to get the delivery modes (home-delivery/store-pickup) along with a list of pickup stores available for a given cart at a given PIN Code. User can then view the address of a pickup store with the help of store-address API.
339
+ * @param {boolean} [arg.buyNow] -
340
+ * @param {UpdateCartPaymentRequest} arg.body
341
+ * @returns {Promise<CartDetailResponse>} - Success response
342
+ * @summary: Update cart payment
343
+ * @description: Use this API to update cart payment.
407
344
  */
408
- getAvailableDeliveryModes({ areaCode, id }?: {
409
- areaCode: string;
345
+ selectPaymentMode({ body, id, buyNow }?: {
410
346
  id?: string;
411
- }): Promise<CartDeliveryModesResponse>;
347
+ buyNow?: boolean;
348
+ body: UpdateCartPaymentRequest;
349
+ }): Promise<CartDetailResponse>;
412
350
  /**
413
351
  * @param {Object} arg - Arg object.
414
- * @param {number} arg.storeUid -
415
- * @returns {Promise<StoreDetailsResponse>} - Success response
416
- * @summary: Get list of stores for give uids
417
- * @description: Use this API to get the store details by entering the unique identifier of the pickup stores shown in the response of available-delivery-mode API.
352
+ * @param {string} arg.id - ID allotted to the selected address
353
+ * @param {Address} arg.body
354
+ * @returns {Promise<UpdateAddressResponse>} - Success response
355
+ * @summary: Update address added to an account
356
+ * @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>
418
357
  */
419
- getStoreAddressByUid({ storeUid }?: {
420
- storeUid: number;
421
- }): Promise<StoreDetailsResponse>;
358
+ updateAddress({ id, body }?: {
359
+ id: string;
360
+ body: Address;
361
+ }): Promise<UpdateAddressResponse>;
422
362
  /**
423
363
  * @param {Object} arg - Arg object.
424
- * @param {GetShareCartLinkRequest} arg.body
425
- * @returns {Promise<GetShareCartLinkResponse>} - Success response
426
- * @summary: Generate token for sharing the cart
427
- * @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.
364
+ * @param {string} [arg.id] -
365
+ * @param {boolean} [arg.i] -
366
+ * @param {boolean} [arg.b] -
367
+ * @param {string} [arg.areaCode] -
368
+ * @param {boolean} [arg.buyNow] -
369
+ * @param {UpdateCartRequest} arg.body
370
+ * @returns {Promise<UpdateCartDetailResponse>} - Success response
371
+ * @summary: Update items in the cart
372
+ * @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>
428
373
  */
429
- getCartShareLink({ body }?: {
430
- body: GetShareCartLinkRequest;
431
- }): Promise<GetShareCartLinkResponse>;
374
+ updateCart({ body, id, i, b, areaCode, buyNow }?: {
375
+ id?: string;
376
+ i?: boolean;
377
+ b?: boolean;
378
+ areaCode?: string;
379
+ buyNow?: boolean;
380
+ body: UpdateCartRequest;
381
+ }): Promise<UpdateCartDetailResponse>;
432
382
  /**
433
383
  * @param {Object} arg - Arg object.
434
- * @param {string} arg.token - Token of the shared short link
435
- * @returns {Promise<SharedCartResponse>} - Success response
436
- * @summary: Get details of a shared cart
437
- * @description: Use this API to get the shared cart details as per the token generated using the share-cart API.
384
+ * @param {string} [arg.id] -
385
+ * @param {boolean} [arg.buyNow] -
386
+ * @param {CartMetaRequest} arg.body
387
+ * @returns {Promise<CartMetaResponse>} - Success response
388
+ * @summary: Update the cart meta
389
+ * @description: Use this API to update cart meta like checkout_mode and gstin.
438
390
  */
439
- getCartSharedItems({ token }?: {
440
- token: string;
441
- }): Promise<SharedCartResponse>;
391
+ updateCartMeta({ body, id, buyNow }?: {
392
+ id?: string;
393
+ buyNow?: boolean;
394
+ body: CartMetaRequest;
395
+ }): Promise<CartMetaResponse>;
442
396
  /**
443
397
  * @param {Object} arg - Arg object.
444
398
  * @param {string} arg.token - Token of the shared short link
@@ -452,4 +406,50 @@ declare class PosCart {
452
406
  token: string;
453
407
  action: string;
454
408
  }): Promise<SharedCartResponse>;
409
+ /**
410
+ * @param {Object} arg - Arg object.
411
+ * @param {boolean} [arg.i] - This is a boolean value. Select `true` to
412
+ * retrieve all the items added in the cart.
413
+ * @param {boolean} [arg.p] - This is a boolean value. Select `true` for
414
+ * getting a payment option in response.
415
+ * @param {string} [arg.id] - The unique identifier of the cart
416
+ * @param {string} [arg.addressId] - ID allotted to an address
417
+ * @param {string} [arg.orderType] - The order type of shipment HomeDelivery
418
+ * - If the customer wants the order home-delivered PickAtStore - If the
419
+ * customer wants the handover of an order at the store itself.
420
+ * @param {UpdateCartShipmentRequest} arg.body
421
+ * @returns {Promise<CartShipmentsResponse>} - Success response
422
+ * @summary: Update shipment delivery type and quantity before checkout
423
+ * @description: Use this API to update the delivery type and quantity as per customer's preference for either store pick-up or home-delivery.
424
+ */
425
+ updateShipments({ body, i, p, id, addressId, orderType }?: {
426
+ i?: boolean;
427
+ p?: boolean;
428
+ id?: string;
429
+ addressId?: string;
430
+ orderType?: string;
431
+ body: UpdateCartShipmentRequest;
432
+ }): Promise<CartShipmentsResponse>;
433
+ /**
434
+ * @param {Object} arg - Arg object.
435
+ * @param {string} [arg.id] -
436
+ * @param {boolean} [arg.buyNow] -
437
+ * @param {string} [arg.addressId] -
438
+ * @param {string} [arg.paymentMode] -
439
+ * @param {string} [arg.paymentIdentifier] -
440
+ * @param {string} [arg.aggregatorName] -
441
+ * @param {string} [arg.merchantCode] -
442
+ * @returns {Promise<PaymentCouponValidate>} - Success response
443
+ * @summary: Verify the coupon eligibility against the payment mode
444
+ * @description: Use this API to validate a coupon against the payment mode such as NetBanking, Wallet, UPI etc.
445
+ */
446
+ validateCouponForPayment({ id, buyNow, addressId, paymentMode, paymentIdentifier, aggregatorName, merchantCode, }?: {
447
+ id?: string;
448
+ buyNow?: boolean;
449
+ addressId?: string;
450
+ paymentMode?: string;
451
+ paymentIdentifier?: string;
452
+ aggregatorName?: string;
453
+ merchantCode?: string;
454
+ }): Promise<PaymentCouponValidate>;
455
455
  }