@gofynd/fdk-client-javascript 1.0.2 → 1.0.4

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 (346) hide show
  1. package/README.md +31 -2
  2. package/index.d.ts +4 -4
  3. package/index.js +9 -10
  4. package/package.json +14 -14
  5. package/sdk/APIClient.d.ts +11 -0
  6. package/sdk/APIClient.js +35 -0
  7. package/sdk/Client.d.ts +6 -0
  8. package/sdk/Client.js +17 -0
  9. package/sdk/Config.d.ts +9 -0
  10. package/sdk/Config.js +17 -0
  11. package/sdk/application/Cart/CartApplicationClient.d.ts +243 -243
  12. package/sdk/application/Cart/CartApplicationClient.js +595 -594
  13. package/sdk/application/Cart/CartApplicationModel.d.ts +64 -63
  14. package/sdk/application/Cart/CartApplicationModel.js +490 -885
  15. package/sdk/application/Cart/CartApplicationValidator.d.ts +17 -17
  16. package/sdk/application/Cart/CartApplicationValidator.js +98 -98
  17. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +358 -358
  18. package/sdk/application/Catalog/CatalogApplicationClient.js +1079 -1078
  19. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +90 -90
  20. package/sdk/application/Catalog/CatalogApplicationModel.js +683 -1249
  21. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +19 -19
  22. package/sdk/application/Catalog/CatalogApplicationValidator.js +110 -110
  23. package/sdk/application/Common/CommonApplicationClient.d.ts +13 -13
  24. package/sdk/application/Common/CommonApplicationClient.js +43 -42
  25. package/sdk/application/Common/CommonApplicationModel.d.ts +12 -12
  26. package/sdk/application/Common/CommonApplicationModel.js +83 -160
  27. package/sdk/application/Common/CommonApplicationValidator.d.ts +1 -1
  28. package/sdk/application/Common/CommonApplicationValidator.js +6 -6
  29. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +11 -11
  30. package/sdk/application/Communication/CommunicationApplicationClient.js +32 -31
  31. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +6 -6
  32. package/sdk/application/Communication/CommunicationApplicationModel.js +38 -83
  33. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
  34. package/sdk/application/Communication/CommunicationApplicationValidator.js +4 -4
  35. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +116 -116
  36. package/sdk/application/Configuration/ConfigurationApplicationClient.js +350 -349
  37. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +85 -85
  38. package/sdk/application/Configuration/ConfigurationApplicationModel.js +480 -851
  39. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +8 -8
  40. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +33 -33
  41. package/sdk/application/Content/ContentApplicationClient.d.ts +67 -67
  42. package/sdk/application/Content/ContentApplicationClient.js +216 -215
  43. package/sdk/application/Content/ContentApplicationModel.d.ts +76 -76
  44. package/sdk/application/Content/ContentApplicationModel.js +468 -884
  45. package/sdk/application/Content/ContentApplicationValidator.d.ts +5 -5
  46. package/sdk/application/Content/ContentApplicationValidator.js +24 -24
  47. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +25 -25
  48. package/sdk/application/FileStorage/FileStorageApplicationClient.js +65 -64
  49. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +13 -13
  50. package/sdk/application/FileStorage/FileStorageApplicationModel.js +86 -169
  51. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +1 -1
  52. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +7 -7
  53. package/sdk/application/Lead/LeadApplicationClient.d.ts +24 -24
  54. package/sdk/application/Lead/LeadApplicationClient.js +109 -108
  55. package/sdk/application/Lead/LeadApplicationModel.d.ts +35 -35
  56. package/sdk/application/Lead/LeadApplicationModel.js +267 -474
  57. package/sdk/application/Lead/LeadApplicationValidator.d.ts +2 -2
  58. package/sdk/application/Lead/LeadApplicationValidator.js +11 -11
  59. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +31 -22
  60. package/sdk/application/Logistic/LogisticApplicationClient.js +115 -49
  61. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +17 -14
  62. package/sdk/application/Logistic/LogisticApplicationModel.js +133 -201
  63. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +3 -2
  64. package/sdk/application/Logistic/LogisticApplicationValidator.js +14 -9
  65. package/sdk/application/Order/OrderApplicationClient.d.ts +85 -85
  66. package/sdk/application/Order/OrderApplicationClient.js +247 -246
  67. package/sdk/application/Order/OrderApplicationModel.d.ts +50 -50
  68. package/sdk/application/Order/OrderApplicationModel.js +361 -656
  69. package/sdk/application/Order/OrderApplicationValidator.d.ts +7 -7
  70. package/sdk/application/Order/OrderApplicationValidator.js +28 -28
  71. package/sdk/application/Payment/PaymentApplicationClient.d.ts +318 -318
  72. package/sdk/application/Payment/PaymentApplicationClient.js +781 -780
  73. package/sdk/application/Payment/PaymentApplicationModel.d.ts +72 -72
  74. package/sdk/application/Payment/PaymentApplicationModel.js +570 -1038
  75. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +28 -28
  76. package/sdk/application/Payment/PaymentApplicationValidator.js +107 -107
  77. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +254 -254
  78. package/sdk/application/PosCart/PosCartApplicationClient.js +646 -645
  79. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +64 -63
  80. package/sdk/application/PosCart/PosCartApplicationModel.js +476 -870
  81. package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +18 -18
  82. package/sdk/application/PosCart/PosCartApplicationValidator.js +103 -103
  83. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +27 -27
  84. package/sdk/application/Rewards/RewardsApplicationClient.js +122 -121
  85. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +14 -14
  86. package/sdk/application/Rewards/RewardsApplicationModel.js +96 -191
  87. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +3 -3
  88. package/sdk/application/Rewards/RewardsApplicationValidator.js +12 -12
  89. package/sdk/application/Share/ShareApplicationClient.d.ts +37 -37
  90. package/sdk/application/Share/ShareApplicationClient.js +94 -93
  91. package/sdk/application/Share/ShareApplicationModel.d.ts +8 -8
  92. package/sdk/application/Share/ShareApplicationModel.js +63 -123
  93. package/sdk/application/Share/ShareApplicationValidator.d.ts +4 -4
  94. package/sdk/application/Share/ShareApplicationValidator.js +12 -12
  95. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
  96. package/sdk/application/Theme/ThemeApplicationClient.js +38 -37
  97. package/sdk/application/Theme/ThemeApplicationModel.d.ts +34 -34
  98. package/sdk/application/Theme/ThemeApplicationModel.js +190 -336
  99. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +1 -1
  100. package/sdk/application/Theme/ThemeApplicationValidator.js +4 -4
  101. package/sdk/application/User/UserApplicationClient.d.ts +280 -280
  102. package/sdk/application/User/UserApplicationClient.js +619 -618
  103. package/sdk/application/User/UserApplicationModel.d.ts +79 -72
  104. package/sdk/application/User/UserApplicationModel.js +440 -689
  105. package/sdk/application/User/UserApplicationValidator.d.ts +24 -24
  106. package/sdk/application/User/UserApplicationValidator.js +89 -89
  107. package/sdk/common/AxiosHelper.js +18 -7
  108. package/sdk/constructUrl.d.ts +5 -0
  109. package/sdk/constructUrl.js +13 -0
  110. package/sdk/index.d.ts +3 -0
  111. package/sdk/index.js +5 -0
  112. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +51 -51
  113. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +182 -180
  114. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +6 -6
  115. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +21 -21
  116. package/sdk/platform/Analytics/AnalyticsPlatformClient.js +5 -4
  117. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +11 -11
  118. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +95 -178
  119. package/sdk/platform/Analytics/AnalyticsPlatformValidator.js +1 -0
  120. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +10 -10
  121. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +44 -43
  122. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +10 -10
  123. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +50 -89
  124. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -1
  125. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +7 -6
  126. package/sdk/platform/Billing/BillingPlatformClient.d.ts +60 -60
  127. package/sdk/platform/Billing/BillingPlatformClient.js +184 -183
  128. package/sdk/platform/Billing/BillingPlatformModel.d.ts +40 -40
  129. package/sdk/platform/Billing/BillingPlatformModel.js +342 -668
  130. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +8 -8
  131. package/sdk/platform/Billing/BillingPlatformValidator.js +26 -25
  132. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +192 -165
  133. package/sdk/platform/Cart/CartPlatformApplicationClient.js +686 -510
  134. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +14 -11
  135. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +77 -61
  136. package/sdk/platform/Cart/CartPlatformModel.d.ts +84 -83
  137. package/sdk/platform/Cart/CartPlatformModel.js +676 -1206
  138. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +632 -632
  139. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1558 -1556
  140. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +40 -40
  141. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +175 -175
  142. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +688 -688
  143. package/sdk/platform/Catalog/CatalogPlatformClient.js +1556 -1559
  144. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +291 -291
  145. package/sdk/platform/Catalog/CatalogPlatformModel.js +2133 -3910
  146. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +66 -66
  147. package/sdk/platform/Catalog/CatalogPlatformValidator.js +229 -228
  148. package/sdk/platform/Common/CommonPlatformClient.d.ts +12 -12
  149. package/sdk/platform/Common/CommonPlatformClient.js +40 -51
  150. package/sdk/platform/Common/CommonPlatformModel.d.ts +12 -12
  151. package/sdk/platform/Common/CommonPlatformModel.js +83 -160
  152. package/sdk/platform/Common/CommonPlatformValidator.d.ts +1 -1
  153. package/sdk/platform/Common/CommonPlatformValidator.js +7 -6
  154. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +326 -326
  155. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +945 -943
  156. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +30 -30
  157. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +88 -88
  158. package/sdk/platform/Communication/CommunicationPlatformClient.js +4 -3
  159. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +67 -67
  160. package/sdk/platform/Communication/CommunicationPlatformModel.js +522 -974
  161. package/sdk/platform/Communication/CommunicationPlatformValidator.js +1 -0
  162. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +55 -55
  163. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +217 -216
  164. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +27 -27
  165. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +279 -542
  166. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +7 -7
  167. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +25 -24
  168. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +163 -153
  169. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +617 -552
  170. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +22 -21
  171. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +70 -64
  172. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +125 -125
  173. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +348 -347
  174. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +148 -146
  175. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +854 -1508
  176. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -9
  177. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +39 -38
  178. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +524 -534
  179. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1287 -1346
  180. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +49 -50
  181. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +153 -159
  182. package/sdk/platform/Content/ContentPlatformModel.d.ts +78 -78
  183. package/sdk/platform/Content/ContentPlatformModel.js +485 -907
  184. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +65 -65
  185. package/sdk/platform/Discount/DiscountPlatformClient.js +219 -218
  186. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +7 -7
  187. package/sdk/platform/Discount/DiscountPlatformModel.js +60 -121
  188. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +6 -6
  189. package/sdk/platform/Discount/DiscountPlatformValidator.js +30 -29
  190. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +25 -25
  191. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +83 -61
  192. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
  193. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +9 -9
  194. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +53 -53
  195. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +147 -125
  196. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -13
  197. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +86 -169
  198. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +3 -3
  199. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +12 -11
  200. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +63 -63
  201. package/sdk/platform/Inventory/InventoryPlatformClient.js +231 -230
  202. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +30 -30
  203. package/sdk/platform/Inventory/InventoryPlatformModel.js +497 -964
  204. package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +7 -7
  205. package/sdk/platform/Inventory/InventoryPlatformValidator.js +29 -28
  206. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +73 -73
  207. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +203 -201
  208. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +7 -7
  209. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +29 -29
  210. package/sdk/platform/Lead/LeadPlatformClient.d.ts +80 -80
  211. package/sdk/platform/Lead/LeadPlatformClient.js +215 -214
  212. package/sdk/platform/Lead/LeadPlatformModel.d.ts +35 -35
  213. package/sdk/platform/Lead/LeadPlatformModel.js +267 -474
  214. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +6 -6
  215. package/sdk/platform/Lead/LeadPlatformValidator.js +25 -24
  216. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +10 -10
  217. package/sdk/platform/Order/OrderPlatformApplicationClient.js +68 -66
  218. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -1
  219. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +7 -7
  220. package/sdk/platform/Order/OrderPlatformClient.d.ts +357 -357
  221. package/sdk/platform/Order/OrderPlatformClient.js +1046 -1033
  222. package/sdk/platform/Order/OrderPlatformModel.d.ts +198 -196
  223. package/sdk/platform/Order/OrderPlatformModel.js +1575 -2861
  224. package/sdk/platform/Order/OrderPlatformValidator.d.ts +32 -32
  225. package/sdk/platform/Order/OrderPlatformValidator.js +161 -160
  226. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +3 -1
  227. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +1 -1
  228. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +1 -1
  229. package/sdk/platform/Partner/PartnerPlatformModel.js +10 -26
  230. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +58 -58
  231. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +178 -178
  232. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +6 -6
  233. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +24 -24
  234. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +42 -42
  235. package/sdk/platform/Payment/PaymentPlatformClient.js +156 -155
  236. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +27 -27
  237. package/sdk/platform/Payment/PaymentPlatformModel.js +222 -410
  238. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +4 -4
  239. package/sdk/platform/Payment/PaymentPlatformValidator.js +22 -21
  240. package/sdk/platform/PlatformApplicationClient.d.ts +1496 -10325
  241. package/sdk/platform/PlatformApplicationClient.js +1584 -13899
  242. package/sdk/platform/PlatformClient.d.ts +7972 -7888
  243. package/sdk/platform/PlatformClient.js +8678 -10107
  244. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +85 -85
  245. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +299 -280
  246. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +8 -8
  247. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +35 -35
  248. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +15 -15
  249. package/sdk/platform/Rewards/RewardsPlatformModel.js +92 -194
  250. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -10
  251. package/sdk/platform/Share/SharePlatformApplicationClient.js +62 -60
  252. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
  253. package/sdk/platform/Share/SharePlatformApplicationValidator.js +7 -7
  254. package/sdk/platform/Share/SharePlatformModel.d.ts +8 -8
  255. package/sdk/platform/Share/SharePlatformModel.js +60 -118
  256. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +132 -132
  257. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +314 -312
  258. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +15 -15
  259. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +45 -45
  260. package/sdk/platform/Theme/ThemePlatformModel.d.ts +34 -34
  261. package/sdk/platform/Theme/ThemePlatformModel.js +190 -336
  262. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +136 -69
  263. package/sdk/platform/User/UserPlatformApplicationClient.js +507 -166
  264. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +12 -7
  265. package/sdk/platform/User/UserPlatformApplicationValidator.js +62 -24
  266. package/sdk/platform/User/UserPlatformModel.d.ts +79 -72
  267. package/sdk/platform/User/UserPlatformModel.js +440 -689
  268. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +31 -31
  269. package/sdk/platform/Webhook/WebhookPlatformClient.js +91 -90
  270. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +7 -7
  271. package/sdk/platform/Webhook/WebhookPlatformModel.js +68 -136
  272. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +3 -3
  273. package/sdk/platform/Webhook/WebhookPlatformValidator.js +15 -14
  274. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +13 -13
  275. package/sdk/public/Configuration/ConfigurationPublicClient.js +40 -38
  276. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +12 -12
  277. package/sdk/public/Configuration/ConfigurationPublicModel.js +85 -162
  278. package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +1 -1
  279. package/sdk/public/Configuration/ConfigurationPublicValidator.js +6 -6
  280. package/sdk/public/Inventory/InventoryPublicClient.d.ts +34 -34
  281. package/sdk/public/Inventory/InventoryPublicClient.js +115 -113
  282. package/sdk/public/Inventory/InventoryPublicModel.d.ts +10 -10
  283. package/sdk/public/Inventory/InventoryPublicModel.js +119 -245
  284. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +3 -3
  285. package/sdk/public/Inventory/InventoryPublicValidator.js +15 -15
  286. package/sdk/public/Webhook/WebhookPublicClient.js +2 -0
  287. package/sdk/public/Webhook/WebhookPublicModel.d.ts +7 -7
  288. package/sdk/public/Webhook/WebhookPublicModel.js +68 -136
  289. package/.github/workflows/on_create_release.yml +0 -23
  290. package/.github/workflows/on_merge_main.yml +0 -38
  291. package/.github/workflows/on_pull_request.yml +0 -35
  292. package/.prettierrc +0 -5
  293. package/documentation/application/CART.md +0 -7339
  294. package/documentation/application/CATALOG.md +0 -9597
  295. package/documentation/application/COMMON.md +0 -452
  296. package/documentation/application/COMMUNICATION.md +0 -467
  297. package/documentation/application/CONFIGURATION.md +0 -2906
  298. package/documentation/application/CONTENT.md +0 -3351
  299. package/documentation/application/FILESTORAGE.md +0 -578
  300. package/documentation/application/LEAD.md +0 -1895
  301. package/documentation/application/LOGISTIC.md +0 -765
  302. package/documentation/application/ORDER.md +0 -3432
  303. package/documentation/application/PAYMENT.md +0 -5221
  304. package/documentation/application/POSCART.md +0 -7938
  305. package/documentation/application/README.md +0 -21
  306. package/documentation/application/REWARDS.md +0 -708
  307. package/documentation/application/SHARE.md +0 -733
  308. package/documentation/application/THEME.md +0 -5800
  309. package/documentation/application/USER.md +0 -4335
  310. package/documentation/platform/ANALYTICS.md +0 -1154
  311. package/documentation/platform/AUDITTRAIL.md +0 -576
  312. package/documentation/platform/BILLING.md +0 -2400
  313. package/documentation/platform/CART.md +0 -5559
  314. package/documentation/platform/CATALOG.md +0 -23261
  315. package/documentation/platform/COMMON.md +0 -452
  316. package/documentation/platform/COMMUNICATION.md +0 -5718
  317. package/documentation/platform/COMPANYPROFILE.md +0 -2031
  318. package/documentation/platform/CONFIGURATION.md +0 -7339
  319. package/documentation/platform/CONTENT.md +0 -9098
  320. package/documentation/platform/DISCOUNT.md +0 -863
  321. package/documentation/platform/FILESTORAGE.md +0 -1081
  322. package/documentation/platform/INVENTORY.md +0 -1779
  323. package/documentation/platform/LEAD.md +0 -4740
  324. package/documentation/platform/ORDER.md +0 -8486
  325. package/documentation/platform/PARTNER.md +0 -220
  326. package/documentation/platform/PAYMENT.md +0 -3448
  327. package/documentation/platform/README.md +0 -27
  328. package/documentation/platform/REWARDS.md +0 -1083
  329. package/documentation/platform/SHARE.md +0 -606
  330. package/documentation/platform/THEME.md +0 -35729
  331. package/documentation/platform/USER.md +0 -2319
  332. package/documentation/platform/WEBHOOK.md +0 -591
  333. package/documentation/public/CONFIGURATION.md +0 -452
  334. package/documentation/public/INVENTORY.md +0 -690
  335. package/documentation/public/WEBHOOK.md +0 -352
  336. package/jest.config.d.ts +0 -4
  337. package/jest.config.js +0 -6
  338. package/tests/application/catalog.spec.js +0 -47
  339. package/tests/common/action-url.spec.js +0 -35
  340. package/tests/common/schema/action-url.json +0 -178
  341. package/tests/common/schema/url-action.json +0 -683
  342. package/tests/common/url-action.spec.js +0 -48
  343. package/tests/helpers/cookie.helper.js +0 -31
  344. package/tests/helpers/oauth.helper.js +0 -43
  345. package/tests/platform/catalog.spec.js +0 -49
  346. package/tests/public/location.spec.js +0 -39
@@ -3,62 +3,68 @@ declare class Payment {
3
3
  constructor(_conf: any);
4
4
  _conf: any;
5
5
  _relativeUrls: {
6
- getAggregatorsConfig: string;
6
+ addBeneficiaryDetails: string;
7
+ addRefundBankAccountUsingOTP: string;
7
8
  attachCardToCustomer: string;
9
+ cancelPaymentLink: string;
10
+ checkAndUpdatePaymentStatus: string;
11
+ checkAndUpdatePaymentStatusPaymentLink: string;
12
+ checkCredit: string;
13
+ createOrderHandlerPaymentLink: string;
14
+ createPaymentLink: string;
15
+ customerCreditSummary: string;
16
+ customerOnboard: string;
17
+ deleteUserCard: string;
18
+ enableOrDisableRefundTransferMode: string;
8
19
  getActiveCardAggregator: string;
20
+ getActiveRefundTransferModes: string;
9
21
  getActiveUserCards: string;
10
- deleteUserCard: string;
11
- verifyCustomerForPayment: string;
12
- verifyAndChargePayment: string;
13
- initialisePayment: string;
14
- checkAndUpdatePaymentStatus: string;
22
+ getAggregatorsConfig: string;
23
+ getEpaylaterBannerDetails: string;
24
+ getOrderBeneficiariesDetail: string;
25
+ getPaymentLink: string;
15
26
  getPaymentModeRoutes: string;
27
+ getPaymentModeRoutesPaymentLink: string;
16
28
  getPosPaymentModeRoutes: string;
17
29
  getRupifiBannerDetails: string;
18
- getEpaylaterBannerDetails: string;
19
- resendOrCancelPayment: string;
30
+ getUserBeneficiariesDetail: string;
31
+ initialisePayment: string;
32
+ initialisePaymentPaymentLink: string;
33
+ pollingPaymentLink: string;
34
+ redirectToAggregator: string;
20
35
  renderHTML: string;
36
+ resendOrCancelPayment: string;
37
+ resendPaymentLink: string;
38
+ updateDefaultBeneficiary: string;
21
39
  validateVPA: string;
22
- getActiveRefundTransferModes: string;
23
- enableOrDisableRefundTransferMode: string;
24
- getUserBeneficiariesDetail: string;
40
+ verifyAndChargePayment: string;
41
+ verifyCustomerForPayment: string;
25
42
  verifyIfscCode: string;
26
- getOrderBeneficiariesDetail: string;
27
43
  verifyOtpAndAddBeneficiaryForBank: string;
28
- addBeneficiaryDetails: string;
29
- addRefundBankAccountUsingOTP: string;
30
44
  verifyOtpAndAddBeneficiaryForWallet: string;
31
- updateDefaultBeneficiary: string;
32
- getPaymentLink: string;
33
- createPaymentLink: string;
34
- resendPaymentLink: string;
35
- cancelPaymentLink: string;
36
- getPaymentModeRoutesPaymentLink: string;
37
- pollingPaymentLink: string;
38
- createOrderHandlerPaymentLink: string;
39
- initialisePaymentPaymentLink: string;
40
- checkAndUpdatePaymentStatusPaymentLink: string;
41
- customerCreditSummary: string;
42
- redirectToAggregator: string;
43
- checkCredit: string;
44
- customerOnboard: string;
45
45
  };
46
46
  _urls: {};
47
47
  updateUrls(urls: any): void;
48
48
  /**
49
49
  * @param {Object} arg - Arg object.
50
- * @param {string} [arg.xApiToken] - Used for basic authentication.
51
- * @param {boolean} [arg.refresh] - This is a boolean value. Select `true`
52
- * to remove temporary cache files on payment gateway and replace with the
53
- * latest one.
54
- * @returns {Promise<AggregatorsConfigDetailResponse>} - Success response
55
- * @summary: Get payment gateway keys
56
- * @description: Use this API to retrieve the payment gateway key, secrets, merchant, SDK/API details to complete a payment at front-end.
50
+ * @param {AddBeneficiaryDetailsRequest} arg.body
51
+ * @returns {Promise<RefundAccountResponse>} - Success response
52
+ * @summary: Save bank details for cancelled/returned order
53
+ * @description: Use this API to save the bank details for a returned or cancelled order to refund the amount.
57
54
  */
58
- getAggregatorsConfig({ xApiToken, refresh }?: {
59
- xApiToken?: string;
60
- refresh?: boolean;
61
- }): Promise<AggregatorsConfigDetailResponse>;
55
+ addBeneficiaryDetails({ body }?: {
56
+ body: AddBeneficiaryDetailsRequest;
57
+ }): Promise<RefundAccountResponse>;
58
+ /**
59
+ * @param {Object} arg - Arg object.
60
+ * @param {AddBeneficiaryDetailsOTPRequest} arg.body
61
+ * @returns {Promise<RefundAccountResponse>} - Success response
62
+ * @summary: Save bank details for cancelled/returned order
63
+ * @description: Use this API to save bank details for returned/cancelled order to refund amount in his account.
64
+ */
65
+ addRefundBankAccountUsingOTP({ body }?: {
66
+ body: AddBeneficiaryDetailsOTPRequest;
67
+ }): Promise<RefundAccountResponse>;
62
68
  /**
63
69
  * @param {Object} arg - Arg object.
64
70
  * @param {AttachCardRequest} arg.body
@@ -71,64 +77,14 @@ declare class Payment {
71
77
  }): Promise<AttachCardsResponse>;
72
78
  /**
73
79
  * @param {Object} arg - Arg object.
74
- * @param {boolean} [arg.refresh] -
75
- * @returns {Promise<ActiveCardPaymentGatewayResponse>} - Success response
76
- * @summary: Fetch active payment gateway for card payments
77
- * @description: Use this API to retrieve an active payment aggregator along with the Customer ID. This is applicable for cards payments only.
78
- */
79
- getActiveCardAggregator({ refresh }?: {
80
- refresh?: boolean;
81
- }): Promise<ActiveCardPaymentGatewayResponse>;
82
- /**
83
- * @param {Object} arg - Arg object.
84
- * @param {boolean} [arg.forceRefresh] -
85
- * @returns {Promise<ListCardsResponse>} - Success response
86
- * @summary: Fetch the list of cards saved by the user
87
- * @description: Use this API to retrieve a list of cards stored by user from an active payment gateway.
88
- */
89
- getActiveUserCards({ forceRefresh }?: {
90
- forceRefresh?: boolean;
91
- }): Promise<ListCardsResponse>;
92
- /**
93
- * @param {Object} arg - Arg object.
94
- * @param {DeletehCardRequest} arg.body
95
- * @returns {Promise<DeleteCardsResponse>} - Success response
96
- * @summary: Delete a card
97
- * @description: Use this API to delete a card added by a user on the payment gateway and clear the cache.
98
- */
99
- deleteUserCard({ body }?: {
100
- body: DeletehCardRequest;
101
- }): Promise<DeleteCardsResponse>;
102
- /**
103
- * @param {Object} arg - Arg object.
104
- * @param {ValidateCustomerRequest} arg.body
105
- * @returns {Promise<ValidateCustomerResponse>} - Success response
106
- * @summary: Validate customer for payment
107
- * @description: Use this API to check if the customer is eligible to use credit-line facilities such as Simpl Pay Later and Rupifi.
108
- */
109
- verifyCustomerForPayment({ body }?: {
110
- body: ValidateCustomerRequest;
111
- }): Promise<ValidateCustomerResponse>;
112
- /**
113
- * @param {Object} arg - Arg object.
114
- * @param {ChargeCustomerRequest} arg.body
115
- * @returns {Promise<ChargeCustomerResponse>} - Success response
116
- * @summary: Verify and charge payment
117
- * @description: Use this API to verify and check the status of a payment transaction (server-to-server) made through aggregators like Simpl and Mswipe.
118
- */
119
- verifyAndChargePayment({ body }?: {
120
- body: ChargeCustomerRequest;
121
- }): Promise<ChargeCustomerResponse>;
122
- /**
123
- * @param {Object} arg - Arg object.
124
- * @param {PaymentInitializationRequest} arg.body
125
- * @returns {Promise<PaymentInitializationResponse>} - Success response
126
- * @summary: Initialize a payment (server-to-server) for UPI and BharatQR
127
- * @description: PUse this API to inititate payment using UPI, BharatQR, wherein the UPI requests are send to the app and QR code is displayed on the screen.
80
+ * @param {CancelOrResendPaymentLinkRequest} arg.body
81
+ * @returns {Promise<CancelPaymentLinkResponse>} - Success response
82
+ * @summary: Cancel payment link
83
+ * @description: Use this API to cancel a payment link for the customer
128
84
  */
129
- initialisePayment({ body }?: {
130
- body: PaymentInitializationRequest;
131
- }): Promise<PaymentInitializationResponse>;
85
+ cancelPaymentLink({ body }?: {
86
+ body: CancelOrResendPaymentLinkRequest;
87
+ }): Promise<CancelPaymentLinkResponse>;
132
88
  /**
133
89
  * @param {Object} arg - Arg object.
134
90
  * @param {PaymentStatusUpdateRequest} arg.body
@@ -141,111 +97,74 @@ declare class Payment {
141
97
  }): Promise<PaymentStatusUpdateResponse>;
142
98
  /**
143
99
  * @param {Object} arg - Arg object.
144
- * @param {number} arg.amount - Payable amount.
145
- * @param {string} arg.cartId - Identifier of the cart.
146
- * @param {string} arg.pincode - The PIN Code of the destination address, e.g. 400059
147
- * @param {string} arg.checkoutMode - Option to checkout for self or for others.
148
- * @param {boolean} [arg.refresh] - This is a boolean value. Select `true`
149
- * to remove temporary cache files on payment gateway and replace with the
150
- * latest one.
151
- * @param {string} [arg.cardReference] - Card reference id of user's debit
152
- * or credit card.
153
- * @param {string} [arg.userDetails] - URIencoded JSON containing details of
154
- * an anonymous user.
155
- * @returns {Promise<PaymentModeRouteResponse>} - Success response
156
- * @summary: Get applicable payment options
157
- * @description: Use this API to get all valid payment options for doing a payment.
158
- */
159
- getPaymentModeRoutes({ amount, cartId, pincode, checkoutMode, refresh, cardReference, userDetails, }?: {
160
- amount: number;
161
- cartId: string;
162
- pincode: string;
163
- checkoutMode: string;
164
- refresh?: boolean;
165
- cardReference?: string;
166
- userDetails?: string;
167
- }): Promise<PaymentModeRouteResponse>;
168
- /**
169
- * @param {Object} arg - Arg object.
170
- * @param {number} arg.amount - Payable amount.
171
- * @param {string} arg.cartId - Identifier of the cart.
172
- * @param {string} arg.pincode - The PIN Code of the destination address, e.g. 400059
173
- * @param {string} arg.checkoutMode - Option to checkout for self or for others.
174
- * @param {boolean} [arg.refresh] - This is a boolean value. Select `true`
175
- * to remove temporary cache files on payment gateway and replace with the
176
- * latest one.
177
- * @param {string} [arg.cardReference] - Card reference id of user's debit
178
- * or credit card.
179
- * @param {string} arg.orderType - The order type of shipment * HomeDelivery
180
- * - If the customer wants the order home-delivered * PickAtStore - If the
181
- * customer wants the handover of an order at the store itself.
182
- * @param {string} [arg.userDetails] - URIencoded JSON containing details of
183
- * an anonymous user.
184
- * @returns {Promise<PaymentModeRouteResponse>} - Success response
185
- * @summary: Get applicable payment options for Point-of-Sale (POS)
186
- * @description: Use this API to get all valid payment options for doing a payment in POS.
100
+ * @param {PaymentStatusUpdateRequest} arg.body
101
+ * @returns {Promise<PaymentStatusUpdateResponse>} - Success response
102
+ * @summary: Performs continuous polling to check status of payment on the server
103
+ * @description: Use this API to perform continuous polling at intervals to check the status of payment until timeout.
187
104
  */
188
- getPosPaymentModeRoutes({ amount, cartId, pincode, checkoutMode, orderType, refresh, cardReference, userDetails, }?: {
189
- amount: number;
190
- cartId: string;
191
- pincode: string;
192
- checkoutMode: string;
193
- refresh?: boolean;
194
- cardReference?: string;
195
- orderType: string;
196
- userDetails?: string;
197
- }): Promise<PaymentModeRouteResponse>;
105
+ checkAndUpdatePaymentStatusPaymentLink({ body }?: {
106
+ body: PaymentStatusUpdateRequest;
107
+ }): Promise<PaymentStatusUpdateResponse>;
198
108
  /**
199
109
  * @param {Object} arg - Arg object.
200
- * @returns {Promise<RupifiBannerResponse>} - Success response
201
- * @summary: Get CreditLine Offer
202
- * @description: Get CreditLine Offer if user is tentatively approved by rupifi
110
+ * @param {string} [arg.aggregator] -
111
+ * @returns {Promise<CheckCreditResponse>} - Success response
112
+ * @summary: API to fetch the customer credit summary
113
+ * @description: Use this API to fetch the customer credit summary.
203
114
  */
204
- getRupifiBannerDetails({}?: any): Promise<RupifiBannerResponse>;
115
+ checkCredit({ aggregator }?: {
116
+ aggregator?: string;
117
+ }): Promise<CheckCreditResponse>;
205
118
  /**
206
119
  * @param {Object} arg - Arg object.
207
- * @returns {Promise<EpaylaterBannerResponse>} - Success response
208
- * @summary: Get Epaylater Enabled
209
- * @description: Get Epaylater Enabled if user is tentatively approved by epaylater
120
+ * @param {CreateOrderUserRequest} arg.body
121
+ * @returns {Promise<CreateOrderUserResponse>} - Success response
122
+ * @summary: Create Order user
123
+ * @description: Use this API to create a order and payment on aggregator side
210
124
  */
211
- getEpaylaterBannerDetails({}?: any): Promise<EpaylaterBannerResponse>;
125
+ createOrderHandlerPaymentLink({ body }?: {
126
+ body: CreateOrderUserRequest;
127
+ }): Promise<CreateOrderUserResponse>;
212
128
  /**
213
129
  * @param {Object} arg - Arg object.
214
- * @param {ResendOrCancelPaymentRequest} arg.body
215
- * @returns {Promise<ResendOrCancelPaymentResponse>} - Success response
216
- * @summary: API to resend and cancel a payment link which was already generated.
217
- * @description: Use this API to perform resend or cancel a payment link based on request payload.
130
+ * @param {CreatePaymentLinkRequest} arg.body
131
+ * @returns {Promise<CreatePaymentLinkResponse>} - Success response
132
+ * @summary: Create payment link
133
+ * @description: Use this API to create a payment link for the customer
218
134
  */
219
- resendOrCancelPayment({ body }?: {
220
- body: ResendOrCancelPaymentRequest;
221
- }): Promise<ResendOrCancelPaymentResponse>;
135
+ createPaymentLink({ body }?: {
136
+ body: CreatePaymentLinkRequest;
137
+ }): Promise<CreatePaymentLinkResponse>;
222
138
  /**
223
139
  * @param {Object} arg - Arg object.
224
- * @param {renderHTMLRequest} arg.body
225
- * @returns {Promise<renderHTMLResponse>} - Success response
226
- * @summary: Convert base64 string to HTML form
227
- * @description: Use this API to decode base64 html form to plain HTML string.
140
+ * @param {string} [arg.aggregator] -
141
+ * @returns {Promise<CustomerCreditSummaryResponse>} - Success response
142
+ * @summary: API to fetch the customer credit summary
143
+ * @description: Use this API to fetch the customer credit summary.
228
144
  */
229
- renderHTML({ body }?: {
230
- body: renderHTMLRequest;
231
- }): Promise<renderHTMLResponse>;
145
+ customerCreditSummary({ aggregator }?: {
146
+ aggregator?: string;
147
+ }): Promise<CustomerCreditSummaryResponse>;
232
148
  /**
233
149
  * @param {Object} arg - Arg object.
234
- * @param {ValidateVPARequest} arg.body
235
- * @returns {Promise<ValidateVPAResponse>} - Success response
236
- * @summary: API to Validate UPI ID
237
- * @description: API to Validate UPI ID
150
+ * @param {CustomerOnboardingRequest} arg.body
151
+ * @returns {Promise<CustomerOnboardingResponse>} - Success response
152
+ * @summary: API to fetch the customer credit summary
153
+ * @description: Use this API to fetch the customer credit summary.
238
154
  */
239
- validateVPA({ body }?: {
240
- body: ValidateVPARequest;
241
- }): Promise<ValidateVPAResponse>;
155
+ customerOnboard({ body }?: {
156
+ body: CustomerOnboardingRequest;
157
+ }): Promise<CustomerOnboardingResponse>;
242
158
  /**
243
159
  * @param {Object} arg - Arg object.
244
- * @returns {Promise<TransferModeResponse>} - Success response
245
- * @summary: Lists the mode of refund
246
- * @description: Use this API to retrieve eligible refund modes (such as Netbanking) and add the beneficiary details.
160
+ * @param {DeletehCardRequest} arg.body
161
+ * @returns {Promise<DeleteCardsResponse>} - Success response
162
+ * @summary: Delete a card
163
+ * @description: Use this API to delete a card added by a user on the payment gateway and clear the cache.
247
164
  */
248
- getActiveRefundTransferModes({}?: any): Promise<TransferModeResponse>;
165
+ deleteUserCard({ body }?: {
166
+ body: DeletehCardRequest;
167
+ }): Promise<DeleteCardsResponse>;
249
168
  /**
250
169
  * @param {Object} arg - Arg object.
251
170
  * @param {UpdateRefundTransferModeRequest} arg.body
@@ -258,87 +177,63 @@ declare class Payment {
258
177
  }): Promise<UpdateRefundTransferModeResponse>;
259
178
  /**
260
179
  * @param {Object} arg - Arg object.
261
- * @param {string} arg.orderId - A unique number used for identifying and
262
- * tracking your orders.
263
- * @returns {Promise<OrderBeneficiaryResponse>} - Success response
264
- * @summary: Lists the beneficiary of a refund
265
- * @description: Use this API to get the details of all active beneficiary added by a user for refund.
266
- */
267
- getUserBeneficiariesDetail({ orderId }?: {
268
- orderId: string;
269
- }): Promise<OrderBeneficiaryResponse>;
270
- /**
271
- * @param {Object} arg - Arg object.
272
- * @param {string} [arg.ifscCode] - A 11-digit alphanumeric code that
273
- * uniquely identifies a bank branch.
274
- * @returns {Promise<IfscCodeResponse>} - Success response
275
- * @summary: Verify IFSC Code
276
- * @description: Use this API to check whether the 11-digit IFSC code is valid and to fetch the bank details for refund.
277
- */
278
- verifyIfscCode({ ifscCode }?: {
279
- ifscCode?: string;
280
- }): Promise<IfscCodeResponse>;
281
- /**
282
- * @param {Object} arg - Arg object.
283
- * @param {string} arg.orderId - A unique number used for identifying and
284
- * tracking your orders.
285
- * @returns {Promise<OrderBeneficiaryResponse>} - Success response
286
- * @summary: Lists the beneficiary of a refund
287
- * @description: Use this API to get the details of all active beneficiary added by a user for refund.
180
+ * @param {boolean} [arg.refresh] -
181
+ * @returns {Promise<ActiveCardPaymentGatewayResponse>} - Success response
182
+ * @summary: Fetch active payment gateway for card payments
183
+ * @description: Use this API to retrieve an active payment aggregator along with the Customer ID. This is applicable for cards payments only.
288
184
  */
289
- getOrderBeneficiariesDetail({ orderId }?: {
290
- orderId: string;
291
- }): Promise<OrderBeneficiaryResponse>;
185
+ getActiveCardAggregator({ refresh }?: {
186
+ refresh?: boolean;
187
+ }): Promise<ActiveCardPaymentGatewayResponse>;
292
188
  /**
293
189
  * @param {Object} arg - Arg object.
294
- * @param {AddBeneficiaryViaOtpVerificationRequest} arg.body
295
- * @returns {Promise<AddBeneficiaryViaOtpVerificationResponse>} - Success response
296
- * @summary: Verify the beneficiary details using OTP
297
- * @description: Use this API to perform an OTP validation before saving the beneficiary details added for a refund.
190
+ * @returns {Promise<TransferModeResponse>} - Success response
191
+ * @summary: Lists the mode of refund
192
+ * @description: Use this API to retrieve eligible refund modes (such as Netbanking) and add the beneficiary details.
298
193
  */
299
- verifyOtpAndAddBeneficiaryForBank({ body }?: {
300
- body: AddBeneficiaryViaOtpVerificationRequest;
301
- }): Promise<AddBeneficiaryViaOtpVerificationResponse>;
194
+ getActiveRefundTransferModes({}?: any): Promise<TransferModeResponse>;
302
195
  /**
303
196
  * @param {Object} arg - Arg object.
304
- * @param {AddBeneficiaryDetailsRequest} arg.body
305
- * @returns {Promise<RefundAccountResponse>} - Success response
306
- * @summary: Save bank details for cancelled/returned order
307
- * @description: Use this API to save the bank details for a returned or cancelled order to refund the amount.
197
+ * @param {boolean} [arg.forceRefresh] -
198
+ * @returns {Promise<ListCardsResponse>} - Success response
199
+ * @summary: Fetch the list of cards saved by the user
200
+ * @description: Use this API to retrieve a list of cards stored by user from an active payment gateway.
308
201
  */
309
- addBeneficiaryDetails({ body }?: {
310
- body: AddBeneficiaryDetailsRequest;
311
- }): Promise<RefundAccountResponse>;
202
+ getActiveUserCards({ forceRefresh }?: {
203
+ forceRefresh?: boolean;
204
+ }): Promise<ListCardsResponse>;
312
205
  /**
313
206
  * @param {Object} arg - Arg object.
314
- * @param {AddBeneficiaryDetailsOTPRequest} arg.body
315
- * @returns {Promise<RefundAccountResponse>} - Success response
316
- * @summary: Save bank details for cancelled/returned order
317
- * @description: Use this API to save bank details for returned/cancelled order to refund amount in his account.
207
+ * @param {string} [arg.xApiToken] - Used for basic authentication.
208
+ * @param {boolean} [arg.refresh] - This is a boolean value. Select `true`
209
+ * to remove temporary cache files on payment gateway and replace with the
210
+ * latest one.
211
+ * @returns {Promise<AggregatorsConfigDetailResponse>} - Success response
212
+ * @summary: Get payment gateway keys
213
+ * @description: Use this API to retrieve the payment gateway key, secrets, merchant, SDK/API details to complete a payment at front-end.
318
214
  */
319
- addRefundBankAccountUsingOTP({ body }?: {
320
- body: AddBeneficiaryDetailsOTPRequest;
321
- }): Promise<RefundAccountResponse>;
215
+ getAggregatorsConfig({ xApiToken, refresh }?: {
216
+ xApiToken?: string;
217
+ refresh?: boolean;
218
+ }): Promise<AggregatorsConfigDetailResponse>;
322
219
  /**
323
220
  * @param {Object} arg - Arg object.
324
- * @param {WalletOtpRequest} arg.body
325
- * @returns {Promise<WalletOtpResponse>} - Success response
326
- * @summary: Send OTP on adding a wallet beneficiary
327
- * @description: Use this API to send an OTP while adding a wallet beneficiary by mobile no. verification.
221
+ * @returns {Promise<EpaylaterBannerResponse>} - Success response
222
+ * @summary: Get Epaylater Enabled
223
+ * @description: Get Epaylater Enabled if user is tentatively approved by epaylater
328
224
  */
329
- verifyOtpAndAddBeneficiaryForWallet({ body }?: {
330
- body: WalletOtpRequest;
331
- }): Promise<WalletOtpResponse>;
225
+ getEpaylaterBannerDetails({}?: any): Promise<EpaylaterBannerResponse>;
332
226
  /**
333
227
  * @param {Object} arg - Arg object.
334
- * @param {SetDefaultBeneficiaryRequest} arg.body
335
- * @returns {Promise<SetDefaultBeneficiaryResponse>} - Success response
336
- * @summary: Set a default beneficiary for a refund
337
- * @description: Use this API to set a default beneficiary for getting a refund.
228
+ * @param {string} arg.orderId - A unique number used for identifying and
229
+ * tracking your orders.
230
+ * @returns {Promise<OrderBeneficiaryResponse>} - Success response
231
+ * @summary: Lists the beneficiary of a refund
232
+ * @description: Use this API to get the details of all active beneficiary added by a user for refund.
338
233
  */
339
- updateDefaultBeneficiary({ body }?: {
340
- body: SetDefaultBeneficiaryRequest;
341
- }): Promise<SetDefaultBeneficiaryResponse>;
234
+ getOrderBeneficiariesDetail({ orderId }?: {
235
+ orderId: string;
236
+ }): Promise<OrderBeneficiaryResponse>;
342
237
  /**
343
238
  * @param {Object} arg - Arg object.
344
239
  * @param {string} [arg.paymentLinkId] -
@@ -351,34 +246,30 @@ declare class Payment {
351
246
  }): Promise<GetPaymentLinkResponse>;
352
247
  /**
353
248
  * @param {Object} arg - Arg object.
354
- * @param {CreatePaymentLinkRequest} arg.body
355
- * @returns {Promise<CreatePaymentLinkResponse>} - Success response
356
- * @summary: Create payment link
357
- * @description: Use this API to create a payment link for the customer
358
- */
359
- createPaymentLink({ body }?: {
360
- body: CreatePaymentLinkRequest;
361
- }): Promise<CreatePaymentLinkResponse>;
362
- /**
363
- * @param {Object} arg - Arg object.
364
- * @param {CancelOrResendPaymentLinkRequest} arg.body
365
- * @returns {Promise<ResendPaymentLinkResponse>} - Success response
366
- * @summary: Resend payment link
367
- * @description: Use this API to resend a payment link for the customer
368
- */
369
- resendPaymentLink({ body }?: {
370
- body: CancelOrResendPaymentLinkRequest;
371
- }): Promise<ResendPaymentLinkResponse>;
372
- /**
373
- * @param {Object} arg - Arg object.
374
- * @param {CancelOrResendPaymentLinkRequest} arg.body
375
- * @returns {Promise<CancelPaymentLinkResponse>} - Success response
376
- * @summary: Cancel payment link
377
- * @description: Use this API to cancel a payment link for the customer
249
+ * @param {number} arg.amount - Payable amount.
250
+ * @param {string} arg.cartId - Identifier of the cart.
251
+ * @param {string} arg.pincode - The PIN Code of the destination address, e.g. 400059
252
+ * @param {string} arg.checkoutMode - Option to checkout for self or for others.
253
+ * @param {boolean} [arg.refresh] - This is a boolean value. Select `true`
254
+ * to remove temporary cache files on payment gateway and replace with the
255
+ * latest one.
256
+ * @param {string} [arg.cardReference] - Card reference id of user's debit
257
+ * or credit card.
258
+ * @param {string} [arg.userDetails] - URIencoded JSON containing details of
259
+ * an anonymous user.
260
+ * @returns {Promise<PaymentModeRouteResponse>} - Success response
261
+ * @summary: Get applicable payment options
262
+ * @description: Use this API to get all valid payment options for doing a payment.
378
263
  */
379
- cancelPaymentLink({ body }?: {
380
- body: CancelOrResendPaymentLinkRequest;
381
- }): Promise<CancelPaymentLinkResponse>;
264
+ getPaymentModeRoutes({ amount, cartId, pincode, checkoutMode, refresh, cardReference, userDetails, }?: {
265
+ amount: number;
266
+ cartId: string;
267
+ pincode: string;
268
+ checkoutMode: string;
269
+ refresh?: boolean;
270
+ cardReference?: string;
271
+ userDetails?: string;
272
+ }): Promise<PaymentModeRouteResponse>;
382
273
  /**
383
274
  * @param {Object} arg - Arg object.
384
275
  * @param {string} arg.paymentLinkId - Payment link id
@@ -391,54 +282,82 @@ declare class Payment {
391
282
  }): Promise<PaymentModeRouteResponse>;
392
283
  /**
393
284
  * @param {Object} arg - Arg object.
394
- * @param {string} [arg.paymentLinkId] -
395
- * @returns {Promise<PollingPaymentLinkResponse>} - Success response
396
- * @summary: Used for polling if payment successful or not
397
- * @description: Use this API to poll if payment through payment was successful or not
285
+ * @param {number} arg.amount - Payable amount.
286
+ * @param {string} arg.cartId - Identifier of the cart.
287
+ * @param {string} arg.pincode - The PIN Code of the destination address, e.g. 400059
288
+ * @param {string} arg.checkoutMode - Option to checkout for self or for others.
289
+ * @param {boolean} [arg.refresh] - This is a boolean value. Select `true`
290
+ * to remove temporary cache files on payment gateway and replace with the
291
+ * latest one.
292
+ * @param {string} [arg.cardReference] - Card reference id of user's debit
293
+ * or credit card.
294
+ * @param {string} arg.orderType - The order type of shipment * HomeDelivery
295
+ * - If the customer wants the order home-delivered * PickAtStore - If the
296
+ * customer wants the handover of an order at the store itself.
297
+ * @param {string} [arg.userDetails] - URIencoded JSON containing details of
298
+ * an anonymous user.
299
+ * @returns {Promise<PaymentModeRouteResponse>} - Success response
300
+ * @summary: Get applicable payment options for Point-of-Sale (POS)
301
+ * @description: Use this API to get all valid payment options for doing a payment in POS.
398
302
  */
399
- pollingPaymentLink({ paymentLinkId }?: {
400
- paymentLinkId?: string;
401
- }): Promise<PollingPaymentLinkResponse>;
303
+ getPosPaymentModeRoutes({ amount, cartId, pincode, checkoutMode, orderType, refresh, cardReference, userDetails, }?: {
304
+ amount: number;
305
+ cartId: string;
306
+ pincode: string;
307
+ checkoutMode: string;
308
+ refresh?: boolean;
309
+ cardReference?: string;
310
+ orderType: string;
311
+ userDetails?: string;
312
+ }): Promise<PaymentModeRouteResponse>;
402
313
  /**
403
314
  * @param {Object} arg - Arg object.
404
- * @param {CreateOrderUserRequest} arg.body
405
- * @returns {Promise<CreateOrderUserResponse>} - Success response
406
- * @summary: Create Order user
407
- * @description: Use this API to create a order and payment on aggregator side
315
+ * @returns {Promise<RupifiBannerResponse>} - Success response
316
+ * @summary: Get CreditLine Offer
317
+ * @description: Get CreditLine Offer if user is tentatively approved by rupifi
408
318
  */
409
- createOrderHandlerPaymentLink({ body }?: {
410
- body: CreateOrderUserRequest;
411
- }): Promise<CreateOrderUserResponse>;
319
+ getRupifiBannerDetails({}?: any): Promise<RupifiBannerResponse>;
320
+ /**
321
+ * @param {Object} arg - Arg object.
322
+ * @param {string} arg.orderId - A unique number used for identifying and
323
+ * tracking your orders.
324
+ * @returns {Promise<OrderBeneficiaryResponse>} - Success response
325
+ * @summary: Lists the beneficiary of a refund
326
+ * @description: Use this API to get the details of all active beneficiary added by a user for refund.
327
+ */
328
+ getUserBeneficiariesDetail({ orderId }?: {
329
+ orderId: string;
330
+ }): Promise<OrderBeneficiaryResponse>;
412
331
  /**
413
332
  * @param {Object} arg - Arg object.
414
333
  * @param {PaymentInitializationRequest} arg.body
415
334
  * @returns {Promise<PaymentInitializationResponse>} - Success response
416
335
  * @summary: Initialize a payment (server-to-server) for UPI and BharatQR
417
- * @description: Use this API to inititate payment using UPI, BharatQR, wherein the UPI requests are send to the app and QR code is displayed on the screen.
336
+ * @description: PUse this API to inititate payment using UPI, BharatQR, wherein the UPI requests are send to the app and QR code is displayed on the screen.
418
337
  */
419
- initialisePaymentPaymentLink({ body }?: {
338
+ initialisePayment({ body }?: {
420
339
  body: PaymentInitializationRequest;
421
340
  }): Promise<PaymentInitializationResponse>;
422
341
  /**
423
342
  * @param {Object} arg - Arg object.
424
- * @param {PaymentStatusUpdateRequest} arg.body
425
- * @returns {Promise<PaymentStatusUpdateResponse>} - Success response
426
- * @summary: Performs continuous polling to check status of payment on the server
427
- * @description: Use this API to perform continuous polling at intervals to check the status of payment until timeout.
343
+ * @param {PaymentInitializationRequest} arg.body
344
+ * @returns {Promise<PaymentInitializationResponse>} - Success response
345
+ * @summary: Initialize a payment (server-to-server) for UPI and BharatQR
346
+ * @description: Use this API to inititate payment using UPI, BharatQR, wherein the UPI requests are send to the app and QR code is displayed on the screen.
428
347
  */
429
- checkAndUpdatePaymentStatusPaymentLink({ body }?: {
430
- body: PaymentStatusUpdateRequest;
431
- }): Promise<PaymentStatusUpdateResponse>;
348
+ initialisePaymentPaymentLink({ body }?: {
349
+ body: PaymentInitializationRequest;
350
+ }): Promise<PaymentInitializationResponse>;
432
351
  /**
433
352
  * @param {Object} arg - Arg object.
434
- * @param {string} [arg.aggregator] -
435
- * @returns {Promise<CustomerCreditSummaryResponse>} - Success response
436
- * @summary: API to fetch the customer credit summary
437
- * @description: Use this API to fetch the customer credit summary.
353
+ * @param {string} [arg.paymentLinkId] -
354
+ * @returns {Promise<PollingPaymentLinkResponse>} - Success response
355
+ * @summary: Used for polling if payment successful or not
356
+ * @description: Use this API to poll if payment through payment was successful or not
438
357
  */
439
- customerCreditSummary({ aggregator }?: {
440
- aggregator?: string;
441
- }): Promise<CustomerCreditSummaryResponse>;
358
+ pollingPaymentLink({ paymentLinkId }?: {
359
+ paymentLinkId?: string;
360
+ }): Promise<PollingPaymentLinkResponse>;
442
361
  /**
443
362
  * @param {Object} arg - Arg object.
444
363
  * @param {string} [arg.source] - This is a String value that contains
@@ -455,22 +374,103 @@ declare class Payment {
455
374
  }): Promise<RedirectToAggregatorResponse>;
456
375
  /**
457
376
  * @param {Object} arg - Arg object.
458
- * @param {string} [arg.aggregator] -
459
- * @returns {Promise<CheckCreditResponse>} - Success response
460
- * @summary: API to fetch the customer credit summary
461
- * @description: Use this API to fetch the customer credit summary.
377
+ * @param {renderHTMLRequest} arg.body
378
+ * @returns {Promise<renderHTMLResponse>} - Success response
379
+ * @summary: Convert base64 string to HTML form
380
+ * @description: Use this API to decode base64 html form to plain HTML string.
462
381
  */
463
- checkCredit({ aggregator }?: {
464
- aggregator?: string;
465
- }): Promise<CheckCreditResponse>;
382
+ renderHTML({ body }?: {
383
+ body: renderHTMLRequest;
384
+ }): Promise<renderHTMLResponse>;
466
385
  /**
467
386
  * @param {Object} arg - Arg object.
468
- * @param {CustomerOnboardingRequest} arg.body
469
- * @returns {Promise<CustomerOnboardingResponse>} - Success response
470
- * @summary: API to fetch the customer credit summary
471
- * @description: Use this API to fetch the customer credit summary.
387
+ * @param {ResendOrCancelPaymentRequest} arg.body
388
+ * @returns {Promise<ResendOrCancelPaymentResponse>} - Success response
389
+ * @summary: API to resend and cancel a payment link which was already generated.
390
+ * @description: Use this API to perform resend or cancel a payment link based on request payload.
472
391
  */
473
- customerOnboard({ body }?: {
474
- body: CustomerOnboardingRequest;
475
- }): Promise<CustomerOnboardingResponse>;
392
+ resendOrCancelPayment({ body }?: {
393
+ body: ResendOrCancelPaymentRequest;
394
+ }): Promise<ResendOrCancelPaymentResponse>;
395
+ /**
396
+ * @param {Object} arg - Arg object.
397
+ * @param {CancelOrResendPaymentLinkRequest} arg.body
398
+ * @returns {Promise<ResendPaymentLinkResponse>} - Success response
399
+ * @summary: Resend payment link
400
+ * @description: Use this API to resend a payment link for the customer
401
+ */
402
+ resendPaymentLink({ body }?: {
403
+ body: CancelOrResendPaymentLinkRequest;
404
+ }): Promise<ResendPaymentLinkResponse>;
405
+ /**
406
+ * @param {Object} arg - Arg object.
407
+ * @param {SetDefaultBeneficiaryRequest} arg.body
408
+ * @returns {Promise<SetDefaultBeneficiaryResponse>} - Success response
409
+ * @summary: Set a default beneficiary for a refund
410
+ * @description: Use this API to set a default beneficiary for getting a refund.
411
+ */
412
+ updateDefaultBeneficiary({ body }?: {
413
+ body: SetDefaultBeneficiaryRequest;
414
+ }): Promise<SetDefaultBeneficiaryResponse>;
415
+ /**
416
+ * @param {Object} arg - Arg object.
417
+ * @param {ValidateVPARequest} arg.body
418
+ * @returns {Promise<ValidateVPAResponse>} - Success response
419
+ * @summary: API to Validate UPI ID
420
+ * @description: API to Validate UPI ID
421
+ */
422
+ validateVPA({ body }?: {
423
+ body: ValidateVPARequest;
424
+ }): Promise<ValidateVPAResponse>;
425
+ /**
426
+ * @param {Object} arg - Arg object.
427
+ * @param {ChargeCustomerRequest} arg.body
428
+ * @returns {Promise<ChargeCustomerResponse>} - Success response
429
+ * @summary: Verify and charge payment
430
+ * @description: Use this API to verify and check the status of a payment transaction (server-to-server) made through aggregators like Simpl and Mswipe.
431
+ */
432
+ verifyAndChargePayment({ body }?: {
433
+ body: ChargeCustomerRequest;
434
+ }): Promise<ChargeCustomerResponse>;
435
+ /**
436
+ * @param {Object} arg - Arg object.
437
+ * @param {ValidateCustomerRequest} arg.body
438
+ * @returns {Promise<ValidateCustomerResponse>} - Success response
439
+ * @summary: Validate customer for payment
440
+ * @description: Use this API to check if the customer is eligible to use credit-line facilities such as Simpl Pay Later and Rupifi.
441
+ */
442
+ verifyCustomerForPayment({ body }?: {
443
+ body: ValidateCustomerRequest;
444
+ }): Promise<ValidateCustomerResponse>;
445
+ /**
446
+ * @param {Object} arg - Arg object.
447
+ * @param {string} [arg.ifscCode] - A 11-digit alphanumeric code that
448
+ * uniquely identifies a bank branch.
449
+ * @returns {Promise<IfscCodeResponse>} - Success response
450
+ * @summary: Verify IFSC Code
451
+ * @description: Use this API to check whether the 11-digit IFSC code is valid and to fetch the bank details for refund.
452
+ */
453
+ verifyIfscCode({ ifscCode }?: {
454
+ ifscCode?: string;
455
+ }): Promise<IfscCodeResponse>;
456
+ /**
457
+ * @param {Object} arg - Arg object.
458
+ * @param {AddBeneficiaryViaOtpVerificationRequest} arg.body
459
+ * @returns {Promise<AddBeneficiaryViaOtpVerificationResponse>} - Success response
460
+ * @summary: Verify the beneficiary details using OTP
461
+ * @description: Use this API to perform an OTP validation before saving the beneficiary details added for a refund.
462
+ */
463
+ verifyOtpAndAddBeneficiaryForBank({ body }?: {
464
+ body: AddBeneficiaryViaOtpVerificationRequest;
465
+ }): Promise<AddBeneficiaryViaOtpVerificationResponse>;
466
+ /**
467
+ * @param {Object} arg - Arg object.
468
+ * @param {WalletOtpRequest} arg.body
469
+ * @returns {Promise<WalletOtpResponse>} - Success response
470
+ * @summary: Send OTP on adding a wallet beneficiary
471
+ * @description: Use this API to send an OTP while adding a wallet beneficiary by mobile no. verification.
472
+ */
473
+ verifyOtpAndAddBeneficiaryForWallet({ body }?: {
474
+ body: WalletOtpRequest;
475
+ }): Promise<WalletOtpResponse>;
476
476
  }