@gofynd/fdk-client-javascript 1.4.15-beta.2 → 1.4.15-beta.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 (314) hide show
  1. package/README.md +2 -2
  2. package/application.d.ts +1 -2
  3. package/application.js +2 -3
  4. package/index.d.ts +1 -2
  5. package/index.js +7 -1
  6. package/package.json +2 -3
  7. package/sdk/application/ApplicationClient.d.ts +2 -0
  8. package/sdk/application/ApplicationClient.js +2 -18
  9. package/sdk/application/Cart/CartApplicationClient.d.ts +75 -90
  10. package/sdk/application/Cart/CartApplicationClient.js +111 -1200
  11. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +81 -142
  12. package/sdk/application/Catalog/CatalogApplicationClient.js +41 -1344
  13. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -8
  14. package/sdk/application/Common/CommonApplicationClient.js +2 -92
  15. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -19
  16. package/sdk/application/Communication/CommunicationApplicationClient.js +3 -148
  17. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -73
  18. package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -727
  19. package/sdk/application/Content/ContentApplicationClient.d.ts +52 -95
  20. package/sdk/application/Content/ContentApplicationClient.js +46 -990
  21. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -13
  22. package/sdk/application/FileStorage/FileStorageApplicationClient.js +8 -138
  23. package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
  24. package/sdk/application/Finance/FinanceApplicationClient.js +105 -0
  25. package/sdk/application/Lead/LeadApplicationClient.d.ts +10 -18
  26. package/sdk/application/Lead/LeadApplicationClient.js +5 -217
  27. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +42 -39
  28. package/sdk/application/Logistic/LogisticApplicationClient.js +89 -493
  29. package/sdk/application/Order/OrderApplicationClient.d.ts +36 -46
  30. package/sdk/application/Order/OrderApplicationClient.js +52 -507
  31. package/sdk/application/Payment/PaymentApplicationClient.d.ts +93 -213
  32. package/sdk/application/Payment/PaymentApplicationClient.js +49 -2109
  33. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +15 -29
  34. package/sdk/application/Rewards/RewardsApplicationClient.js +8 -312
  35. package/sdk/application/Share/ShareApplicationClient.d.ts +14 -24
  36. package/sdk/application/Share/ShareApplicationClient.js +7 -309
  37. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -14
  38. package/sdk/application/Theme/ThemeApplicationClient.js +8 -176
  39. package/sdk/application/User/UserApplicationClient.d.ts +87 -138
  40. package/sdk/application/User/UserApplicationClient.js +44 -1820
  41. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -7
  42. package/sdk/application/Webhook/WebhookApplicationClient.js +3 -52
  43. package/sdk/application/index.d.ts +0 -18
  44. package/sdk/application/index.js +0 -33
  45. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +86 -12
  46. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
  47. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -19
  48. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -14
  49. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
  50. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
  51. package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
  52. package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
  53. package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
  54. package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
  55. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +126 -20
  56. package/sdk/partner/Logistics/LogisticsPartnerClient.js +970 -20
  57. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1200 -167
  58. package/sdk/partner/Logistics/LogisticsPartnerModel.js +571 -160
  59. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +10 -0
  60. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +121 -7
  61. package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
  62. package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
  63. package/sdk/partner/Theme/ThemePartnerModel.d.ts +96 -37
  64. package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
  65. package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
  66. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
  67. package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
  68. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
  69. package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
  70. package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
  71. package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
  72. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
  73. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
  74. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
  75. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
  76. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
  77. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
  78. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
  79. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
  80. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
  81. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
  82. package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
  83. package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
  84. package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
  85. package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
  86. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
  87. package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
  88. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +134 -103
  89. package/sdk/platform/Cart/CartPlatformApplicationClient.js +419 -115
  90. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +118 -65
  91. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +109 -44
  92. package/sdk/platform/Cart/CartPlatformModel.d.ts +5046 -1300
  93. package/sdk/platform/Cart/CartPlatformModel.js +1979 -1217
  94. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +209 -183
  95. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +452 -395
  96. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +185 -142
  97. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +96 -78
  98. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +154 -117
  99. package/sdk/platform/Catalog/CatalogPlatformClient.js +292 -172
  100. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6506 -1775
  101. package/sdk/platform/Catalog/CatalogPlatformModel.js +3224 -1690
  102. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +72 -31
  103. package/sdk/platform/Catalog/CatalogPlatformValidator.js +50 -24
  104. package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
  105. package/sdk/platform/Common/CommonPlatformClient.js +3 -2
  106. package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
  107. package/sdk/platform/Common/CommonPlatformModel.js +6 -6
  108. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
  109. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
  110. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
  111. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
  112. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
  113. package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
  114. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
  115. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
  116. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
  117. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
  118. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
  119. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
  120. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
  121. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
  122. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
  123. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
  124. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
  125. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
  126. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
  127. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
  128. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
  129. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
  130. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +124 -141
  131. package/sdk/platform/Content/ContentPlatformApplicationClient.js +449 -422
  132. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +179 -141
  133. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +168 -130
  134. package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
  135. package/sdk/platform/Content/ContentPlatformClient.js +523 -336
  136. package/sdk/platform/Content/ContentPlatformModel.d.ts +1241 -395
  137. package/sdk/platform/Content/ContentPlatformModel.js +521 -390
  138. package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
  139. package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
  140. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
  141. package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
  142. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
  143. package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
  144. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
  145. package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
  146. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +94 -36
  147. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -60
  148. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
  149. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
  150. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
  151. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
  152. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -101
  153. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -84
  154. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  155. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  156. package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
  157. package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
  158. package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
  159. package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
  160. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +17 -6
  161. package/sdk/platform/Order/OrderPlatformApplicationClient.js +85 -7
  162. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +95 -24
  163. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +39 -19
  164. package/sdk/platform/Order/OrderPlatformClient.d.ts +153 -96
  165. package/sdk/platform/Order/OrderPlatformClient.js +416 -198
  166. package/sdk/platform/Order/OrderPlatformModel.d.ts +7602 -1269
  167. package/sdk/platform/Order/OrderPlatformModel.js +3926 -1269
  168. package/sdk/platform/Order/OrderPlatformValidator.d.ts +270 -109
  169. package/sdk/platform/Order/OrderPlatformValidator.js +135 -77
  170. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
  171. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
  172. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
  173. package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
  174. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
  175. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
  176. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
  177. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
  178. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
  179. package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
  180. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +333 -319
  181. package/sdk/platform/Payment/PaymentPlatformModel.js +288 -278
  182. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
  183. package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
  184. package/sdk/platform/PlatformClient.d.ts +0 -2
  185. package/sdk/platform/PlatformClient.js +0 -4
  186. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
  187. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
  188. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
  189. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
  190. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
  191. package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
  192. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +46 -36
  193. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +132 -41
  194. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +46 -17
  195. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +34 -14
  196. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +40 -46
  197. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +58 -64
  198. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1842 -609
  199. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +886 -554
  200. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +42 -46
  201. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +26 -28
  202. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
  203. package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
  204. package/sdk/platform/Share/SharePlatformModel.d.ts +36 -5
  205. package/sdk/platform/Share/SharePlatformModel.js +27 -4
  206. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
  207. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
  208. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
  209. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
  210. package/sdk/platform/Theme/ThemePlatformModel.d.ts +37 -11
  211. package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
  212. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
  213. package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
  214. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
  215. package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
  216. package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
  217. package/sdk/platform/User/UserPlatformModel.js +23 -23
  218. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
  219. package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
  220. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
  221. package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
  222. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
  223. package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
  224. package/sdk/platform/index.d.ts +0 -1
  225. package/sdk/platform/index.js +0 -2
  226. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
  227. package/sdk/public/Configuration/ConfigurationPublicClient.js +10 -7
  228. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
  229. package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
  230. package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
  231. package/sdk/public/Content/ContentPublicClient.js +795 -7
  232. package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
  233. package/sdk/public/Content/ContentPublicModel.js +649 -3
  234. package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
  235. package/sdk/public/Content/ContentPublicValidator.js +88 -2
  236. package/sdk/public/Partner/PartnerPublicClient.js +4 -2
  237. package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
  238. package/sdk/public/Webhook/WebhookPublicClient.js +12 -10
  239. package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
  240. package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
  241. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  242. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  243. package/sdk/application/Cart/CartApplicationModel.d.ts +0 -3994
  244. package/sdk/application/Cart/CartApplicationModel.js +0 -2497
  245. package/sdk/application/Cart/CartApplicationValidator.d.ts +0 -769
  246. package/sdk/application/Cart/CartApplicationValidator.js +0 -530
  247. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +0 -3857
  248. package/sdk/application/Catalog/CatalogApplicationModel.js +0 -2629
  249. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +0 -791
  250. package/sdk/application/Catalog/CatalogApplicationValidator.js +0 -551
  251. package/sdk/application/Common/CommonApplicationModel.d.ts +0 -449
  252. package/sdk/application/Common/CommonApplicationModel.js +0 -308
  253. package/sdk/application/Common/CommonApplicationValidator.d.ts +0 -46
  254. package/sdk/application/Common/CommonApplicationValidator.js +0 -38
  255. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +0 -293
  256. package/sdk/application/Communication/CommunicationApplicationModel.js +0 -201
  257. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +0 -29
  258. package/sdk/application/Communication/CommunicationApplicationValidator.js +0 -38
  259. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +0 -2556
  260. package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -1887
  261. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +0 -179
  262. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +0 -176
  263. package/sdk/application/Content/ContentApplicationModel.d.ts +0 -2133
  264. package/sdk/application/Content/ContentApplicationModel.js +0 -1589
  265. package/sdk/application/Content/ContentApplicationValidator.d.ts +0 -284
  266. package/sdk/application/Content/ContentApplicationValidator.js +0 -264
  267. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +0 -272
  268. package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -190
  269. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +0 -56
  270. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +0 -53
  271. package/sdk/application/Lead/LeadApplicationModel.d.ts +0 -590
  272. package/sdk/application/Lead/LeadApplicationModel.js +0 -480
  273. package/sdk/application/Lead/LeadApplicationValidator.d.ts +0 -68
  274. package/sdk/application/Lead/LeadApplicationValidator.js +0 -71
  275. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +0 -1675
  276. package/sdk/application/Logistic/LogisticApplicationModel.js +0 -1121
  277. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +0 -254
  278. package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -190
  279. package/sdk/application/Order/OrderApplicationModel.d.ts +0 -2296
  280. package/sdk/application/Order/OrderApplicationModel.js +0 -1471
  281. package/sdk/application/Order/OrderApplicationValidator.d.ts +0 -265
  282. package/sdk/application/Order/OrderApplicationValidator.js +0 -197
  283. package/sdk/application/Payment/PaymentApplicationModel.d.ts +0 -4058
  284. package/sdk/application/Payment/PaymentApplicationModel.js +0 -2630
  285. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +0 -576
  286. package/sdk/application/Payment/PaymentApplicationValidator.js +0 -594
  287. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +0 -365
  288. package/sdk/application/Rewards/RewardsApplicationModel.js +0 -396
  289. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +0 -73
  290. package/sdk/application/Rewards/RewardsApplicationValidator.js +0 -84
  291. package/sdk/application/Share/ShareApplicationModel.d.ts +0 -339
  292. package/sdk/application/Share/ShareApplicationModel.js +0 -234
  293. package/sdk/application/Share/ShareApplicationValidator.d.ts +0 -90
  294. package/sdk/application/Share/ShareApplicationValidator.js +0 -91
  295. package/sdk/application/Theme/ThemeApplicationModel.d.ts +0 -1713
  296. package/sdk/application/Theme/ThemeApplicationModel.js +0 -1426
  297. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +0 -66
  298. package/sdk/application/Theme/ThemeApplicationValidator.js +0 -58
  299. package/sdk/application/User/UserApplicationModel.d.ts +0 -1943
  300. package/sdk/application/User/UserApplicationModel.js +0 -1382
  301. package/sdk/application/User/UserApplicationValidator.d.ts +0 -560
  302. package/sdk/application/User/UserApplicationValidator.js +0 -573
  303. package/sdk/application/Webhook/WebhookApplicationModel.d.ts +0 -52
  304. package/sdk/application/Webhook/WebhookApplicationModel.js +0 -46
  305. package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +0 -16
  306. package/sdk/application/Webhook/WebhookApplicationValidator.js +0 -19
  307. package/sdk/common/Clickstream.d.ts +0 -1
  308. package/sdk/common/Clickstream.js +0 -464
  309. package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
  310. package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
  311. package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
  312. package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
  313. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
  314. package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
@@ -1,2630 +0,0 @@
1
- const Joi = require("joi");
2
-
3
- /**
4
- * @typedef AggregatorConfigDetail
5
- * @property {boolean} [sdk] - SDK details.
6
- * @property {string} secret - Masked payment gateway api secret.
7
- * @property {string} [api] - Payment gateway api endpoint.
8
- * @property {string} [pin] - Masked pin.
9
- * @property {string} config_type - Fynd or self payment gateway.
10
- * @property {string} [merchant_key] - Unique merchant key.
11
- * @property {string} [verify_api] - Payment gateway verify payment api endpoint.
12
- * @property {string} key - Payment gateway api key.
13
- * @property {string} [user_id] - Registered User id.
14
- * @property {string} [merchant_id] - Unique merchant id.
15
- */
16
-
17
- /**
18
- * @typedef AggregatorsConfigDetailResponse
19
- * @property {boolean} success - Api response was successful or not.
20
- * @property {AggregatorConfigDetail} [razorpay]
21
- * @property {AggregatorConfigDetail} [juspay]
22
- * @property {AggregatorConfigDetail} [simpl]
23
- * @property {AggregatorConfigDetail} [payumoney]
24
- * @property {AggregatorConfigDetail} [rupifi]
25
- * @property {AggregatorConfigDetail} [mswipe]
26
- * @property {AggregatorConfigDetail} [stripe]
27
- * @property {AggregatorConfigDetail} [ccavenue]
28
- * @property {string} env - Environment i.e Live or Test.
29
- */
30
-
31
- /**
32
- * @typedef ErrorCodeAndDescription
33
- * @property {string} code - Error description code.
34
- * @property {string} description - Error human understandable description.
35
- */
36
-
37
- /**
38
- * @typedef HttpErrorCodeAndResponse
39
- * @property {ErrorCodeAndDescription} [error]
40
- * @property {boolean} success - Response is successful or not.
41
- */
42
-
43
- /**
44
- * @typedef AttachCardRequest
45
- * @property {string} [nickname] - Nickname of the card holder.
46
- * @property {boolean} [refresh] - Refresh cache flag.
47
- * @property {string} card_id - Card token of payment gateway.
48
- * @property {string} [name_on_card] - Name of the card holder.
49
- */
50
-
51
- /**
52
- * @typedef AttachCardsResponse
53
- * @property {Object} data - List of cards of customer.
54
- * @property {boolean} success - Response is successful or not.
55
- * @property {string} [message] - Human readable message.
56
- */
57
-
58
- /**
59
- * @typedef CardPaymentGateway
60
- * @property {string} [api] - Payment gateway CARD api endpoint.
61
- * @property {string} aggregator - Payment gateway name.
62
- * @property {string} [customer_id] - Payment gateway customer id.
63
- */
64
-
65
- /**
66
- * @typedef ActiveCardPaymentGatewayResponse
67
- * @property {CardPaymentGateway} cards
68
- * @property {boolean} success - Response is successful or not.
69
- * @property {string} message - Human readable message.
70
- */
71
-
72
- /**
73
- * @typedef Card
74
- * @property {string} [card_number] - Card number mentioned on the card.
75
- * @property {string} [card_name] - Name mentioned on the card.
76
- * @property {string} [card_type] - Type of the card.
77
- * @property {string} [card_brand_image] - Brand image on the card.
78
- * @property {string} [card_reference] - Card reference.
79
- * @property {string} [card_issuer] - Issuer of the card.
80
- * @property {string} [card_brand] - Brand of the card.
81
- * @property {boolean} [expired] - Card expiry.
82
- * @property {boolean} [compliant_with_tokenisation_guidelines] - Whether card
83
- * is tokenized or not.
84
- * @property {string} [card_isin] - International Securities Identification
85
- * Number for the card.
86
- * @property {number} [exp_year] - Card's expiration year.
87
- * @property {string} [nickname] - User-defined name for the card.
88
- * @property {string} aggregator_name - Name of the payment aggregator.
89
- * @property {string} [card_fingerprint] - Unique fingerprint of the card for
90
- * identification.
91
- * @property {string} [card_token] - Encrypted token representing the card.
92
- * @property {number} [exp_month] - Card's expiration month.
93
- * @property {string} [card_id] - Unique identifier for the card within the system.
94
- */
95
-
96
- /**
97
- * @typedef ListCardsResponse
98
- * @property {Card[]} [data] - List of cards of customer.
99
- * @property {boolean} success - Response is successful or not.
100
- * @property {string} message - Human readable message.
101
- */
102
-
103
- /**
104
- * @typedef DeletehCardRequest
105
- * @property {string} card_id - Card token of payment gateway.
106
- */
107
-
108
- /**
109
- * @typedef DeleteCardsResponse
110
- * @property {boolean} success - Response is successful or not.
111
- * @property {string} [message] - Human readable message.
112
- */
113
-
114
- /**
115
- * @typedef ValidateCustomerRequest
116
- * @property {string} aggregator - Payment gateway name in camelcase i.e Simple, Rupifi.
117
- * @property {number} transaction_amount_in_paise - Payable amount in paise.
118
- * @property {string} phone_number - User mobile number without country code.
119
- * @property {Object} [billing_address] - Extra meta fields.
120
- * @property {Object[]} [order_items] - Extra meta fields.
121
- * @property {string} [payload] - Hashed payload string.
122
- * @property {Object} [merchant_params] - Extra meta fields.
123
- * @property {Object} [delivery_address] - Extra meta fields.
124
- */
125
-
126
- /**
127
- * @typedef ValidateCustomerResponse
128
- * @property {Object} [data] - Payment gateway response data.
129
- * @property {boolean} success - Response is successful or not.
130
- * @property {string} message - Error or success message.
131
- */
132
-
133
- /**
134
- * @typedef ChargeCustomerRequest
135
- * @property {boolean} [verified] - Already Verified flag from payment gateway i.e Mswipe.
136
- * @property {string} aggregator - Payment gateway name i.e Simpl, Mswipe.
137
- * @property {string} order_id - Unique order id.
138
- * @property {string} [transaction_token] - Transaction token of payment gateway.
139
- * @property {number} amount - Chargeable amount of order.
140
- */
141
-
142
- /**
143
- * @typedef ChargeCustomerResponse
144
- * @property {string} status - Status of charged payment.
145
- * @property {string} [cart_id] - Cart id of customer.
146
- * @property {boolean} success - Response is successful or not.
147
- * @property {string} aggregator - Payment gateway name i.e Simpl, Mswipe.
148
- * @property {string} message - Human readable message.
149
- * @property {string} order_id - Unique order id.
150
- * @property {string} [delivery_address_id] - Delivery address id of customer.
151
- */
152
-
153
- /**
154
- * @typedef PaymentInitializationRequest
155
- * @property {string} [razorpay_payment_id] - Payment gateway payment id.
156
- * @property {string} method - Payment method.
157
- * @property {string} [device_id] - EDC machine Unique Identifier.
158
- * @property {string} aggregator - Payment gateway name.
159
- * @property {string} customer_id - Payment gateway customer id.
160
- * @property {string} contact - Customer valid mobile number.
161
- * @property {string} merchant_order_id - Unique fynd order id.
162
- * @property {string} [vpa] - Customer vpa address.
163
- * @property {string} order_id - Payment gateway order id.
164
- * @property {string} currency - Currency code.
165
- * @property {number} [timeout] - Payment polling timeout if not received response.
166
- * @property {number} amount - Payable amount.
167
- * @property {string} email - Customer valid email.
168
- */
169
-
170
- /**
171
- * @typedef PaymentInitializationResponse
172
- * @property {string} [status] - Status of payment.
173
- * @property {string} [razorpay_payment_id] - Payment id.
174
- * @property {string} [aggregator_order_id] - Payment order id.
175
- * @property {string} method - Payment method.
176
- * @property {boolean} success - Response is successful or not.
177
- * @property {string} [upi_poll_url] - UPI poll url.
178
- * @property {string} [virtual_id] - Payment virtual address.
179
- * @property {string} [device_id] - EDC machine Unique Identifier.
180
- * @property {string} polling_url - Polling url.
181
- * @property {string} aggregator - Payment gateway name.
182
- * @property {string} merchant_order_id - Order id.
183
- * @property {string} [customer_id] - Payment gateway customer id.
184
- * @property {string} [vpa] - Customer vpa address.
185
- * @property {string} [currency] - Currency code.
186
- * @property {number} [timeout] - Timeout.
187
- * @property {number} [amount] - Payable amount.
188
- * @property {string} [bqr_image] - Bharat qr image url.
189
- */
190
-
191
- /**
192
- * @typedef PaymentStatusUpdateRequest
193
- * @property {string} [status] - Status of payment.
194
- * @property {string} [merchant_transaction_id] - Unique fynd transaction id.
195
- * @property {string} method - Payment method.
196
- * @property {string} [device_id] - EDC machine Unique Identifier.
197
- * @property {string} aggregator - Payment gateway name.
198
- * @property {string} [customer_id] - Payment gateway customer id.
199
- * @property {string} [contact] - Customer valid mobile number.
200
- * @property {string} merchant_order_id - Unique fynd order id.
201
- * @property {string} [vpa] - Customer vpa address.
202
- * @property {string} [order_id] - Payment gateway order id.
203
- * @property {string} [currency] - Currency code.
204
- * @property {number} [amount] - Payable amount.
205
- * @property {string} [email] - Customer valid email.
206
- */
207
-
208
- /**
209
- * @typedef PaymentStatusUpdateResponse
210
- * @property {string} status - Payment status.
211
- * @property {boolean} [success] - Response is successful or not.
212
- * @property {boolean} retry - Response is successful or not.
213
- * @property {string} [redirect_url] - Redirect url.
214
- * @property {string} aggregator_name - Payment gateway name.
215
- */
216
-
217
- /**
218
- * @typedef IntentAppErrorList
219
- * @property {string} [code] - Code of the intent App.
220
- * @property {string} [package_name] - Package Name of the intent App.
221
- */
222
-
223
- /**
224
- * @typedef PaymentModeLogo
225
- * @property {string} large - Large Logo.
226
- * @property {string} small - Small Logo.
227
- */
228
-
229
- /**
230
- * @typedef IntentApp
231
- * @property {string} [code] - Code of the intent App.
232
- * @property {string} [package_name] - Package Name of the intent App.
233
- * @property {PaymentModeLogo} [logos]
234
- * @property {string} [display_name] - Display Name of the intent App.
235
- */
236
-
237
- /**
238
- * @typedef PaymentModeList
239
- * @property {string} [card_number] - Card number mentioned on the card.
240
- * @property {string} [merchant_code] - Unique code identifying the merchant.
241
- * @property {string} [card_reference] - Reference identifier for the card.
242
- * @property {string} [card_issuer] - Issuing bank or institution of the card.
243
- * @property {boolean} [compliant_with_tokenisation_guidelines] - Indicates
244
- * compliance with tokenization guidelines.
245
- * @property {string} [code] - General code for identifying a transaction or status.
246
- * @property {number} [cod_limit] - Limit for Cash on Delivery (COD) transactions.
247
- * @property {boolean} [intent_flow] - Flow or process intended for the transaction.
248
- * @property {string} [fynd_vpa] - Virtual Payment Address (VPA) used by Fynd.
249
- * @property {IntentAppErrorList[]} [intent_app_error_dict_list] - List of error
250
- * dictionaries related to intent app.
251
- * @property {string} aggregator_name - Name of the payment aggregator.
252
- * @property {string} [card_fingerprint] - Unique fingerprint of the card for
253
- * identification.
254
- * @property {string[]} [intent_app_error_list] - List of errors associated with
255
- * the intent app.
256
- * @property {IntentApp[]} [intent_app] - Application intended for handling the
257
- * transaction.
258
- * @property {boolean} [expired] - Indicates whether the card is expired.
259
- * @property {number} [retry_count] - Number of retry attempts.
260
- * @property {number} [exp_year] - Card's expiration year.
261
- * @property {number} [exp_month] - Card's expiration month.
262
- * @property {string} [card_id] - Unique identifier for the card within the system.
263
- * @property {number} [remaining_limit] - Remaining available limit on the card.
264
- * @property {number} [display_priority] - Priority of display in the user interface.
265
- * @property {string} [card_brand] - Brand of the card (e.g., Visa, MasterCard).
266
- * @property {number} [cod_limit_per_order] - Maximum limit per order for COD
267
- * transactions.
268
- * @property {PaymentModeLogo} [logo_url]
269
- * @property {string} [nickname] - User-defined name for the card.
270
- * @property {string} [card_name] - Name printed on the card.
271
- * @property {string} [card_type] - Type of the card (e.g., debit, credit).
272
- * @property {string} [card_brand_image] - Image representing the card brand.
273
- * @property {string} [display_name] - Display name for the card in the user interface.
274
- * @property {string} [card_isin] - International Securities Identification
275
- * Number for the card.
276
- * @property {number} [timeout] - Timeout duration for transactions.
277
- * @property {string} [card_token] - Encrypted token representing the card.
278
- * @property {string} [name] - User's name.
279
- * @property {Object} [meta] - Payment methods meta.
280
- */
281
-
282
- /**
283
- * @typedef RootPaymentMode
284
- * @property {boolean} [is_pay_by_card_pl] - This flag will be true in case of
285
- * Payment link payment through card.
286
- * @property {boolean} [add_card_enabled] - Anonymous card flag.
287
- * @property {number} display_priority - Display Priority.
288
- * @property {string} display_name - Payment mode display name.
289
- * @property {PaymentModeList[]} [list] - Payment mode.
290
- * @property {boolean} [save_card] - Card save or not.
291
- * @property {string} [aggregator_name] - Display Priority.
292
- * @property {string} name - Payment mode name.
293
- * @property {boolean} [anonymous_enable] - Anonymous card flag.
294
- */
295
-
296
- /**
297
- * @typedef AggregatorRoute
298
- * @property {Object} [data] - Details about aggregator route.
299
- * @property {Object} [payment_flow_data] - Payment_flow_data.
300
- * @property {string} [payment_flow] - Payment_flow.
301
- * @property {string} [api_link] - API link of the aggregator.
302
- */
303
-
304
- /**
305
- * @typedef PaymentDefaultSelection
306
- * @property {string} [mode] - Default Selection Payment Mode.
307
- * @property {string} [identifier] - Identifier for Payment Mode.
308
- * @property {boolean} [skip] - Decide if the default payment mode will skip the
309
- * payment options page altogether or just be preferred on the Frontend.
310
- */
311
-
312
- /**
313
- * @typedef PaymentFlow
314
- * @property {AggregatorRoute} [bqr_razorpay]
315
- * @property {AggregatorRoute} [fynd]
316
- * @property {AggregatorRoute} [epaylater]
317
- * @property {AggregatorRoute} [razorpay]
318
- * @property {AggregatorRoute} [juspay]
319
- * @property {AggregatorRoute} [ajiodhan]
320
- * @property {AggregatorRoute} [simpl]
321
- * @property {AggregatorRoute} [rupifi]
322
- * @property {AggregatorRoute} [mswipe]
323
- * @property {AggregatorRoute} [stripe]
324
- * @property {AggregatorRoute} [ccavenue]
325
- * @property {AggregatorRoute} [payubiz]
326
- * @property {AggregatorRoute} [jiopay]
327
- * @property {AggregatorRoute} [upi_razorpay]
328
- */
329
-
330
- /**
331
- * @typedef PaymentOptionAndFlow
332
- * @property {RootPaymentMode[]} payment_option - Payment options.
333
- * @property {PaymentFlow} payment_flows
334
- * @property {PaymentDefaultSelection} [payment_default_selection]
335
- */
336
-
337
- /**
338
- * @typedef AdvanceObject
339
- * @property {boolean} [is_active] - Is Advance Payment active.
340
- * @property {number} [amount] - Amount for Payment Breakdown.
341
- * @property {string} [time_unit] - Time unit for refunds.
342
- * @property {string} [description] - The description for Advance Payment (user
343
- * configured).
344
- * @property {string} [display_name] - The display name for Advance payment.
345
- * @property {string} [prepayment_type] - Type of prepayment value.
346
- * @property {number} [prepayment_value] - Value for prepayment in advance payment.
347
- * @property {string} [cancellation_type] - Type of cancellation.
348
- * @property {number} [refund_time_limit] - Time limit for processing refund.
349
- * @property {string[]} [all_prepayment_type] - All available types of prepayment.
350
- * @property {boolean} [allow_custom_advance_amount] - Is custom advance amount allowed?.
351
- */
352
-
353
- /**
354
- * @typedef SplitObject
355
- * @property {number} [total_number_of_splits] - Maximum amount of splits allowed.
356
- * @property {number} [splits_remaining] - Number of splits remaining.
357
- * @property {number} [amount_remaining] - Amount pending to be paid.
358
- */
359
-
360
- /**
361
- * @typedef AdvancePaymentObject
362
- * @property {string} [name] - Name of Advance Payment Mode.
363
- * @property {number} [display_priority] - Display Priority for Payment Option.
364
- * @property {number} [payment_mode_id] - Payment Mode ID for Advance Payment Option.
365
- * @property {string} [display_name] - Display name for Advance Payment Mode.
366
- * @property {PaymentModeList[]} [list] - Payment mode.
367
- * @property {SplitObject} [split]
368
- * @property {AdvanceObject} [advance]
369
- */
370
-
371
- /**
372
- * @typedef PaymentModeRouteResponse
373
- * @property {PaymentOptionAndFlow} payment_options
374
- * @property {boolean} success - Response is successful or not.
375
- * @property {Object} [payment_breakup] - Payment Breakup for advance payment.
376
- * @property {AdvancePaymentObject[]} [advance_payment] - Advance Payment Array.
377
- */
378
-
379
- /**
380
- * @typedef WalletLinkRequestSchema
381
- * @property {string} aggregator - Aggregator Name.
382
- * @property {string} mobile - Mobile Number for Wallet.
383
- * @property {string} wallet_code - Wallet Code.
384
- */
385
-
386
- /**
387
- * @typedef WalletVerifyRequestSchema
388
- * @property {string} aggregator - Aggregator Name.
389
- * @property {string} link_token - Token for wallet linking.
390
- * @property {number} otp - OTP received for wallet linking.
391
- */
392
-
393
- /**
394
- * @typedef WalletDelinkRequestSchema
395
- * @property {string} aggregator - Aggregator Name.
396
- * @property {string} wallet_code - Wallet Code.
397
- */
398
-
399
- /**
400
- * @typedef WalletResponseSchema
401
- * @property {Object} data - Response received from aggregator.
402
- * @property {boolean} success - Success/Failure of the API call.
403
- */
404
-
405
- /**
406
- * @typedef RupifiBannerData
407
- * @property {string} [status] - Rupifi KYC status.
408
- * @property {string} [kyc_url] - Rupifi KYC banner url.
409
- */
410
-
411
- /**
412
- * @typedef RupifiBannerResponse
413
- * @property {RupifiBannerData} data
414
- * @property {boolean} success - Successful or not.
415
- */
416
-
417
- /**
418
- * @typedef EpaylaterBannerData
419
- * @property {string} [status] - Epaylater KYC status.
420
- * @property {string} [message] - EPayLater message.
421
- * @property {boolean} display - Need to display banner or not.
422
- */
423
-
424
- /**
425
- * @typedef EpaylaterBannerResponse
426
- * @property {EpaylaterBannerData} data
427
- * @property {boolean} success - Successful or not.
428
- */
429
-
430
- /**
431
- * @typedef ResendOrCancelPaymentRequest
432
- * @property {string} order_id - Unique order id.
433
- * @property {string} [device_id] - EDC machine Unique Identifier.
434
- * @property {string} request_type - Either resend or cancel.
435
- */
436
-
437
- /**
438
- * @typedef LinkStatus
439
- * @property {string} status - Link action status.
440
- * @property {string} message - Message.
441
- * @property {boolean} [is_payment_done] - This key specifies payment done
442
- * status of payment link.
443
- */
444
-
445
- /**
446
- * @typedef ResendOrCancelPaymentResponse
447
- * @property {LinkStatus} data
448
- * @property {boolean} success - Response is successful or not.
449
- */
450
-
451
- /**
452
- * @typedef renderHTMLRequest
453
- * @property {string} [returntype] - Return Type of API.
454
- * @property {string} base64_html - Base64 encoded html string.
455
- */
456
-
457
- /**
458
- * @typedef renderHTMLResponse
459
- * @property {string} html - HTML string.
460
- */
461
-
462
- /**
463
- * @typedef ValidateVPARequest
464
- * @property {string} upi_vpa - UPI ID.
465
- * @property {string} [aggregator] - Aggregator slug.
466
- */
467
-
468
- /**
469
- * @typedef ValidateUPI
470
- * @property {string} status - VALID or INVALID.
471
- * @property {string} customer_name - Customer Bank.
472
- * @property {boolean} is_valid - Boolean is true or false.
473
- * @property {string} upi_vpa - UPI ID.
474
- */
475
-
476
- /**
477
- * @typedef ValidateVPAResponse
478
- * @property {ValidateUPI} data
479
- * @property {boolean} success - Response is successful or not.
480
- */
481
-
482
- /**
483
- * @typedef CardDetails
484
- * @property {boolean} status - Current status of the card.
485
- * @property {string} country - Country where the card was issued.
486
- * @property {string} bank_code - Code identifying the bank.
487
- * @property {string} id - Unique identifier for the record.
488
- * @property {string} [card_exp_year] - Card's expiration year.
489
- * @property {string} card_brand - Brand of the card (e.g., Visa, MasterCard).
490
- * @property {string} type - General type of the card (e.g., debit, credit).
491
- * @property {string} card_sub_type - Sub-type of the card (e.g., Platinum, Gold).
492
- * @property {boolean} is_domestic_card - Indicates whether the card is domestic.
493
- * @property {string} [name_on_card] - Name of the cardholder.
494
- * @property {string} [card_exp_month] - Card's expiration month.
495
- * @property {string} extended_card_type - Extended type of the card, providing
496
- * more specific classification.
497
- * @property {string} card_object - Object representation of the card.
498
- * @property {string} [card_token] - Encrypted token representing the card.
499
- * @property {string} [user] - User associated with the card.
500
- * @property {string} bank - Bank associated with the card.
501
- */
502
-
503
- /**
504
- * @typedef CardDetailsResponse
505
- * @property {CardDetails} data
506
- * @property {boolean} success - Response is successful or not.
507
- */
508
-
509
- /**
510
- * @typedef TransferItemsDetails
511
- * @property {number} id - Id of the transfer item.
512
- * @property {string} [display_name] - Beneficiary Display Name.
513
- * @property {string} logo_large - Beneficiary large Logo.
514
- * @property {string} logo_small - Beneficiary small Logo.
515
- * @property {string} name - Beneficiary Name.
516
- */
517
-
518
- /**
519
- * @typedef TransferModeDetails
520
- * @property {TransferItemsDetails[]} [items] - Beneficiary Mode Items.
521
- * @property {string} display_name - Beneficiary Mode Name.
522
- */
523
-
524
- /**
525
- * @typedef TransferModeResponse
526
- * @property {TransferModeDetails[]} data - Response Object.
527
- */
528
-
529
- /**
530
- * @typedef UpdateRefundTransferModeRequest
531
- * @property {boolean} enable - True for enabling the Transfer Mode.
532
- * @property {string} transfer_mode - Transfer Mode of the Beneficiary to be added.
533
- */
534
-
535
- /**
536
- * @typedef UpdateRefundTransferModeResponse
537
- * @property {boolean} [success] - Response is successful or not.
538
- */
539
-
540
- /**
541
- * @typedef OrderBeneficiaryDetails
542
- * @property {string} modified_on - MOdification Date of Beneficiary.
543
- * @property {string} account_no - Account Number.
544
- * @property {string} [mobile] - MObile no of User.
545
- * @property {string} bank_name - Bank Name Of Account.
546
- * @property {string} ifsc_code - Ifsc Code Of Account.
547
- * @property {boolean} is_active - Boolean Flag whether Beneficiary set or not.
548
- * @property {string} beneficiary_id - Beneficiary Id.
549
- * @property {string} account_holder - Account Holder Name.
550
- * @property {string} email - EMail of User.
551
- * @property {string} [delights_user_name] - User Id Who filled the Beneficiary.
552
- * @property {number} id - Id of the Order Beneficiary.
553
- * @property {string} transfer_mode - Transfer Mode Of Account.
554
- * @property {string} [branch_name] - Branch Name Of Account.
555
- * @property {string} created_on - Creation Date of Beneficiary.
556
- * @property {string} subtitle - SHort Title Of Account.
557
- * @property {string} [comment] - Remarks.
558
- * @property {string} address - Address of User.
559
- * @property {string} title - Title Of Account.
560
- * @property {string} display_name - Display Name Of Account.
561
- */
562
-
563
- /**
564
- * @typedef OrderBeneficiaryResponse
565
- * @property {boolean} [show_beneficiary_details] - Show beneficiary details or not.
566
- * @property {OrderBeneficiaryDetails[]} [beneficiaries] - All Beneficiaries Of An Order.
567
- */
568
-
569
- /**
570
- * @typedef NotFoundResourceError
571
- * @property {string} code - Bad Request Data.
572
- * @property {string} description - Not Found.
573
- * @property {boolean} success - Response is successful or not.
574
- */
575
-
576
- /**
577
- * @typedef IfscCodeResponse
578
- * @property {string} branch_name - Branch Name Of Account.
579
- * @property {boolean} [success] - Response is successful or not.
580
- * @property {string} bank_name - Bank Name Of Account.
581
- */
582
-
583
- /**
584
- * @typedef ErrorCodeDescription
585
- * @property {string} code - Error description code.
586
- * @property {string} description - Error human understandable description.
587
- * @property {boolean} success - Response is successful or not.
588
- */
589
-
590
- /**
591
- * @typedef AddBeneficiaryViaOtpVerificationRequest
592
- * @property {string} request_id - Request id.
593
- * @property {string} hash_key - Hash key of the beneficiary Id.
594
- * @property {string} otp - Otp sent to the given Mobile No.
595
- */
596
-
597
- /**
598
- * @typedef AddBeneficiaryViaOtpVerificationResponse
599
- * @property {boolean} [success] - Response is successful or not.
600
- * @property {string} message - Aggregator Response of beneficiary.
601
- */
602
-
603
- /**
604
- * @typedef WrongOtpError
605
- * @property {boolean} is_verified_flag - Verified flag.
606
- * @property {string} description - Wrong OTP Code.
607
- * @property {string} success - Response is successful or not.
608
- */
609
-
610
- /**
611
- * @typedef BeneficiaryModeDetails
612
- * @property {string} account_no - Account Number of the Account Holder.
613
- * @property {string} [address] - Address of the User.
614
- * @property {string} mobile - Mobile Number of the User.
615
- * @property {string} bank_name - Bank Name of the Account.
616
- * @property {string} [comment] - Remarks added by The user.
617
- * @property {string} ifsc_code - Ifsc Code of the Account.
618
- * @property {string} [vpa] - VPA of the Account.
619
- * @property {string} branch_name - Branch Name of the Account.
620
- * @property {string} account_holder - Name of the Account Holder.
621
- * @property {string} [wallet] - Wallet of the Account.
622
- * @property {string} email - Email of the Account Holder.
623
- */
624
-
625
- /**
626
- * @typedef AddBeneficiaryDetailsRequest
627
- * @property {boolean} delights - True if beneficiary to be added by delights or
628
- * False if by User.
629
- * @property {string} shipment_id - Shipment Id of the respective Merchant Order Id.
630
- * @property {BeneficiaryModeDetails} details
631
- * @property {string} [otp] - OTP received by customer.
632
- * @property {string} order_id - Merchant Order Id.
633
- * @property {string} transfer_mode - Transfer Mode of the Beneficiary to be added.
634
- * @property {string} [request_id] - Request Id for add benificiary request.
635
- */
636
-
637
- /**
638
- * @typedef RefundAccountResponse
639
- * @property {boolean} [is_verified_flag] - Flag for verification of refund.
640
- * @property {Object} [data] - Refund account data.
641
- * @property {boolean} success - Success or failure flag.
642
- * @property {string} message - Response message.
643
- */
644
-
645
- /**
646
- * @typedef BankDetailsForOTP
647
- * @property {string} account_no - Account number of the holder.
648
- * @property {string} bank_name - Name of the bank.
649
- * @property {string} ifsc_code - IFSC code of the bank.
650
- * @property {string} branch_name - Branch name of the bank.
651
- * @property {string} account_holder - Name of the account holder.
652
- */
653
-
654
- /**
655
- * @typedef AddBeneficiaryDetailsOTPRequest
656
- * @property {string} order_id - Unique identifier for an order.
657
- * @property {BankDetailsForOTP} details
658
- */
659
-
660
- /**
661
- * @typedef WalletOtpRequest
662
- * @property {string} country_code - Country Code of the Mobile Number.
663
- * @property {string} mobile - Wallet Mobile Number of the User.
664
- */
665
-
666
- /**
667
- * @typedef WalletOtpResponse
668
- * @property {string} request_id - Request Id for wallet otp request.
669
- * @property {string} is_verified_flag - Boolean Flag whether OTP Validation is
670
- * already done or not.
671
- * @property {boolean} [success] - Response is successful or not.
672
- */
673
-
674
- /**
675
- * @typedef SetDefaultBeneficiaryRequest
676
- * @property {string} order_id - Merchant Order Id.
677
- * @property {string} beneficiary_id - Beneficiary Hash Id of the beneficiary added.
678
- */
679
-
680
- /**
681
- * @typedef SetDefaultBeneficiaryResponse
682
- * @property {boolean} is_beneficiary_set - Boolean Flag whether Beneficiary set or not.
683
- * @property {boolean} [success] - Response is successful or not.
684
- */
685
-
686
- /**
687
- * @typedef GetPaymentLinkResponse
688
- * @property {number} status_code - HTTP status code.
689
- * @property {string} [payment_link_current_status] - Status of payment link.
690
- * @property {boolean} success - Successful or failure.
691
- * @property {number} [polling_timeout] - Polling request timeout.
692
- * @property {string} [payment_link_url] - Url of payment link.
693
- * @property {string} [external_order_id] - Merchant order id.
694
- * @property {string} message - Detailed message.
695
- * @property {string} [merchant_name] - Merchant name.
696
- * @property {number} [amount] - Total value of order.
697
- */
698
-
699
- /**
700
- * @typedef ErrorDescription
701
- * @property {string} [payment_transaction_id] - Payment transaction id.
702
- * @property {boolean} [expired] - Payment link expired or not.
703
- * @property {string} [merchant_order_id] - Merchant Order Id.
704
- * @property {string} [merchant_name] - Name of merchant that created payment link.
705
- * @property {string} [msg] - Detailed message.
706
- * @property {boolean} [cancelled] - Payment link is cancelled or not.
707
- * @property {number} [amount] - Amount paid.
708
- * @property {boolean} [invalid_id] - Payment link id is valid or not.
709
- */
710
-
711
- /**
712
- * @typedef ErrorResponse
713
- * @property {number} status_code - HTTP status code.
714
- * @property {ErrorDescription} [error]
715
- * @property {string} message - Detailed message.
716
- * @property {boolean} success - Successful or failure.
717
- */
718
-
719
- /**
720
- * @typedef CreatePaymentLinkMeta
721
- * @property {string} cart_id - Unique identifier for the shopping cart.
722
- * @property {string} checkout_mode - Mode of checkout process (e.g., guest,
723
- * registered user).
724
- * @property {string} [assign_card_id] - Identifier for the card assigned to the
725
- * transaction.
726
- * @property {string} amount - Total amount for the transaction.
727
- */
728
-
729
- /**
730
- * @typedef CreatePaymentLinkRequest
731
- * @property {string} [description] - Merchant order id.
732
- * @property {string} external_order_id - Merchant order id.
733
- * @property {string} mobile_number - Mobile number to which the payment link is
734
- * to be sent.
735
- * @property {number} amount - Total value of order.
736
- * @property {CreatePaymentLinkMeta} meta
737
- * @property {string} email - Email to which the payment link is to be sent.
738
- */
739
-
740
- /**
741
- * @typedef CreatePaymentLinkResponse
742
- * @property {number} status_code - HTTP status code.
743
- * @property {boolean} success - Successful or failure.
744
- * @property {number} [polling_timeout] - Polling request timeout.
745
- * @property {string} [payment_link_url] - Url of payment link.
746
- * @property {string} message - Detailed message.
747
- * @property {string} [payment_link_id] - Unique id of payment link.
748
- */
749
-
750
- /**
751
- * @typedef CancelOrResendPaymentLinkRequest
752
- * @property {string} payment_link_id - Unique id of payment link.
753
- */
754
-
755
- /**
756
- * @typedef ResendPaymentLinkResponse
757
- * @property {number} status_code - HTTP status code.
758
- * @property {number} [polling_timeout] - Polling request timeout.
759
- * @property {boolean} success - Successful or failure.
760
- * @property {string} message - Detailed message.
761
- */
762
-
763
- /**
764
- * @typedef CancelPaymentLinkResponse
765
- * @property {number} status_code - HTTP status code.
766
- * @property {boolean} success - Successful or failure.
767
- * @property {string} message - Detailed message.
768
- */
769
-
770
- /**
771
- * @typedef PollingPaymentLinkResponse
772
- * @property {string} [status] - Status of payment link.
773
- * @property {number} [status_code] - HTTP status code.
774
- * @property {boolean} [success] - Successful or failure.
775
- * @property {number} [http_status] - HTTP status code.
776
- * @property {string} [message] - Detailed message.
777
- * @property {string} [order_id] - Fynd order id.
778
- * @property {string} [redirect_url] - Url to redirect to.
779
- * @property {string} [payment_link_id] - Payment link id.
780
- * @property {string} [aggregator_name] - Aggregator name.
781
- * @property {number} [amount] - Total amount for the transaction.
782
- */
783
-
784
- /**
785
- * @typedef PaymentMethodsMeta
786
- * @property {string} merchant_code - Merchant code.
787
- * @property {string} payment_gateway - Payment gateway name.
788
- * @property {string} payment_identifier - Payment identifier.
789
- */
790
-
791
- /**
792
- * @typedef CreateOrderUserPaymentMethods
793
- * @property {string} name - Payment mode name.
794
- * @property {string} mode - Payment mode.
795
- * @property {PaymentMethodsMeta} meta
796
- */
797
-
798
- /**
799
- * @typedef CreateOrderUserRequest
800
- * @property {string} failure_callback_url - Failure page url.
801
- * @property {string} currency - Currency of the transaction.
802
- * @property {string} payment_link_id - Unique id of payment link.
803
- * @property {CreateOrderUserPaymentMethods} payment_methods
804
- * @property {string} success_callback_url - Success page url.
805
- * @property {Object} [meta] - Meta details.
806
- */
807
-
808
- /**
809
- * @typedef CreateOrderUserData
810
- * @property {string} [method] - Method details.
811
- * @property {string} [aggregator] - Aggregator name.
812
- * @property {string} [customer_id] - Aggregator customer id.
813
- * @property {string} [contact] - Mobile number.
814
- * @property {string} [merchant_order_id] - Merchant order id.
815
- * @property {string} [order_id] - Aggregator order id.
816
- * @property {string} [currency] - Currency of the transaction.
817
- * @property {string} [callback_url] - Callback url for aggregator.
818
- * @property {number} [amount] - Total amount for the transaction.
819
- * @property {string} [email] - Email.
820
- */
821
-
822
- /**
823
- * @typedef CreateOrderUserResponse
824
- * @property {number} status_code - HTTP status code.
825
- * @property {boolean} success - Successful or failure.
826
- * @property {CreateOrderUserData} [data]
827
- * @property {string} message - Detailed message.
828
- * @property {string} [order_id] - Merchant order id.
829
- * @property {string} [callback_url] - Callback url for aggregator.
830
- * @property {string} [payment_confirm_url] - Payment confirm url for aggregator.
831
- */
832
-
833
- /**
834
- * @typedef BalanceDetails
835
- * @property {string} [formatted_value] - Formatted Amount with currency symbol.
836
- * @property {string} [currency] - Currency Code.
837
- * @property {number} [value] - Payment amount.
838
- */
839
-
840
- /**
841
- * @typedef CreditSummary
842
- * @property {BalanceDetails} [total_due_amount]
843
- * @property {string} [status] - Customer Credit status.
844
- * @property {BalanceDetails} [limit]
845
- * @property {string} [credit_line_id] - ID at Credit aggregator end.
846
- * @property {BalanceDetails} [amount_available]
847
- * @property {BalanceDetails} [due_amount]
848
- * @property {string} [due_date] - Due date for repayment.
849
- * @property {BalanceDetails} [balance]
850
- * @property {string} [status_message] - Message to customer.
851
- * @property {string} [repayment_url] - Url for repayment.
852
- * @property {string} [soa_url] - Statement of accounts. Show payment history.
853
- * @property {boolean} [is_eligible_for_txn] - Eligibility flag to complete transaction.
854
- * @property {string} [merchant_customer_ref_id] - Unique aggregator customer id.
855
- * @property {string} [buyer_status] - Status from Credit aggregator end.
856
- * @property {string} [activation_url] - Url for activation.
857
- */
858
-
859
- /**
860
- * @typedef CustomerCreditSummaryResponse
861
- * @property {CreditSummary} [data]
862
- * @property {boolean} success - Payment confirmation updated or not.
863
- */
864
-
865
- /**
866
- * @typedef RedirectURL
867
- * @property {boolean} status - Aggregator Operation is successful or not.
868
- * @property {string} signup_url - URL to which the user may redirect.
869
- */
870
-
871
- /**
872
- * @typedef RedirectToAggregatorResponse
873
- * @property {RedirectURL} data
874
- * @property {boolean} success - Status updated or not.
875
- */
876
-
877
- /**
878
- * @typedef CreditDetail
879
- * @property {boolean} status - Operation is successful or not.
880
- * @property {boolean} is_registered - User is registered with aggregator or not.
881
- * @property {string} signup_url - URL to which the user may redirect.
882
- */
883
-
884
- /**
885
- * @typedef CheckCreditResponse
886
- * @property {CreditDetail} data
887
- * @property {boolean} success - Operation is successful or not.
888
- */
889
-
890
- /**
891
- * @typedef KYCAddress
892
- * @property {string} city - City of the KYC address.
893
- * @property {string} [addressline2] - Second line of the address.
894
- * @property {string} state - State of the KYC address.
895
- * @property {string} [ownership_type] - Type of ownership for the address
896
- * (e.g., rented, owned).
897
- * @property {string} pincode - Postal code of the address.
898
- * @property {string} [land_mark] - Landmark near the address.
899
- * @property {string} addressline1 - First line of the address.
900
- */
901
-
902
- /**
903
- * @typedef UserPersonalInfoInDetails
904
- * @property {string} first_name - First name of the individual.
905
- * @property {string} [voter_id] - Voter ID number.
906
- * @property {string} [gender] - Gender of the individual.
907
- * @property {string} dob - Date of birth of the individual.
908
- * @property {string} [passport] - Passport number.
909
- * @property {string} [fathers_name] - Father's name.
910
- * @property {string} [mothers_name] - Mother's name.
911
- * @property {string} [middle_name] - Middle name of the individual.
912
- * @property {string} [last_name] - Last name of the individual.
913
- * @property {string} [pan] - Permanent Account Number (PAN).
914
- * @property {string} [driving_license] - Driving license number.
915
- * @property {boolean} email_verified - Indicates whether the email is verified.
916
- * @property {KYCAddress} address_as_per_id
917
- * @property {boolean} mobile_verified - Indicates whether the mobile number is verified.
918
- * @property {string} phone - Phone number.
919
- * @property {string} [email] - Email address.
920
- */
921
-
922
- /**
923
- * @typedef MarketplaceInfo
924
- * @property {string} [date_of_joining] - Date of joining.
925
- * @property {string} name - Name of store.
926
- * @property {string} membership_id - Merchant id.
927
- */
928
-
929
- /**
930
- * @typedef BusinessDetails
931
- * @property {string} [business_ownership_type] - Type of business ownership
932
- * (e.g., sole proprietorship, partnership).
933
- * @property {string} [vintage] - Age or duration of the business.
934
- * @property {string} [gstin] - Goods and Services Tax Identification Number.
935
- * @property {string} [pan] - Permanent Account Number of the business.
936
- * @property {string} [entity_type] - Type of legal entity (e.g., corporation, LLC).
937
- * @property {Object} [shop_and_establishment] - Shop and Establishment
938
- * registration details.
939
- * @property {string} [fssai] - Food Safety and Standards Authority of India
940
- * registration number.
941
- * @property {string} [fda] - Food and Drug Administration registration number.
942
- * @property {string} [business_type] - Type of business (e.g., retail, wholesale).
943
- * @property {string} [name] - Name of the business.
944
- * @property {KYCAddress} [address]
945
- */
946
-
947
- /**
948
- * @typedef DeviceDetails
949
- * @property {string} [identification_number] - IP.
950
- * @property {string} [identifier_type] - Static value = ip.
951
- * @property {string} [device_model] - Device Model.
952
- * @property {string} [device_make] - Device maker.
953
- * @property {string} [device_type] - Device Type(E.g. Mobile).
954
- * @property {string} [os] - OS Name.
955
- * @property {string} [os_version] - OS Version.
956
- */
957
-
958
- /**
959
- * @typedef CustomerOnboardingRequest
960
- * @property {UserPersonalInfoInDetails} [personal_info]
961
- * @property {string} [mcc] - Merchant Category Code, indicating the type of business.
962
- * @property {string} aggregator - Payment aggregator handling the transaction.
963
- * @property {MarketplaceInfo} [marketplace_info]
964
- * @property {string} source - Callback url.
965
- * @property {BusinessDetails} [business_info]
966
- * @property {DeviceDetails} [device]
967
- */
968
-
969
- /**
970
- * @typedef OnboardSummary
971
- * @property {string} [redirect_url] - URL to which the user may redirect.
972
- * @property {Object} [session] - User Session.
973
- * @property {boolean} status - Transaction status.
974
- * @property {string} [status_remark] - Description of status.
975
- * @property {boolean} [is_eligible_for_txn] - Whether is eligible for transaction.
976
- * @property {string} [merchant_customer_ref_id] - Rupifi customer ID.
977
- * @property {string} [activation_url] - Url for activation.
978
- */
979
-
980
- /**
981
- * @typedef CustomerOnboardingResponse
982
- * @property {OnboardSummary} data
983
- * @property {boolean} success - Status updated or not.
984
- */
985
-
986
- /**
987
- * @typedef OutstandingOrderDetailsResponse
988
- * @property {number} status_code - HTTP Status code.
989
- * @property {Object[]} [data] - Dict containing the outstanding order details.
990
- * @property {boolean} success - Response is successful or not.
991
- * @property {string} [message] - Message.
992
- */
993
-
994
- /**
995
- * @typedef PaidOrderDetailsResponse
996
- * @property {number} status_code - HTTP Status code.
997
- * @property {Object[]} [data] - Dict containing the paid order details.
998
- * @property {boolean} success - Response is successful or not.
999
- * @property {string} [message] - Message.
1000
- */
1001
-
1002
- /**
1003
- * @typedef DeleteRefundAccountResponse
1004
- * @property {boolean} success - Success/Failure of the deleted beneficiary.
1005
- * @property {string} message - Message.
1006
- */
1007
-
1008
- /**
1009
- * @typedef RefundOptionsDetails
1010
- * @property {string} display_name - Refund option display name.
1011
- * @property {number} id - Refund ID. It will be unique identifier.
1012
- * @property {boolean} [is_active] - Refund option is active or not.
1013
- * @property {string} name - Refund option name.
1014
- */
1015
-
1016
- /**
1017
- * @typedef RefundOptions
1018
- * @property {RefundOptionsDetails} items - List of all refund options.
1019
- */
1020
-
1021
- /**
1022
- * @typedef OfflineRefundOptions
1023
- * @property {RefundOptionsDetails} items - List of all refund options.
1024
- * @property {string[]} payment_modes - List of all offline payment options. MOP
1025
- * Code value.
1026
- */
1027
-
1028
- /**
1029
- * @typedef RefundOptionResponse
1030
- * @property {OfflineRefundOptions} offline_refund_options - Available offline
1031
- * refund options data.
1032
- * @property {boolean} success - Success/Failure Of response.
1033
- * @property {RefundOptions} refund_options - Available refund options data.
1034
- */
1035
-
1036
- /**
1037
- * @typedef SelectedRefundOptionResponse
1038
- * @property {Object} transfer_mode - Selected transfer mode for given shipment.
1039
- * @property {string} shipment_id - ID of the shipment.
1040
- * @property {string} message - Detailed message.
1041
- * @property {boolean} success - Whether refund is successful or not.
1042
- */
1043
-
1044
- /**
1045
- * @typedef WalletBeneficiaryDetails
1046
- * @property {string} beneficiary_id - Beneficiary Id.
1047
- * @property {string} modified_on - MOdification Date of Beneficiary.
1048
- * @property {string} display_name - Display Name Of Account.
1049
- * @property {number} id - Id of the wallet beneficiary.
1050
- * @property {string} subtitle - SHort Title Of Account.
1051
- * @property {string} transfer_mode - Transfer Mode Of Account.
1052
- * @property {string} [mobile] - MObile no of User.
1053
- * @property {boolean} is_active - Boolean Flag whether Beneficiary set or not.
1054
- * @property {string} created_on - Creation Date of Beneficiary.
1055
- * @property {string} address - Address of User.
1056
- * @property {string} title - Title Of Account.
1057
- * @property {string} wallet_address - Bank Name Of Account.
1058
- * @property {string} [comment] - Remarks.
1059
- * @property {string} [wallet] - Branch Name Of Account.
1060
- * @property {string} email - EMail of User.
1061
- * @property {string} [delights_user_name] - User Id Who filled the Beneficiary.
1062
- */
1063
-
1064
- /**
1065
- * @typedef UpiBeneficiaryDetails
1066
- * @property {string} beneficiary_id - Beneficiary Id.
1067
- * @property {string} modified_on - MOdification Date of Beneficiary.
1068
- * @property {string} display_name - Display Name Of Account.
1069
- * @property {number} id - Id of the upi beneficiary.
1070
- * @property {string} subtitle - SHort Title Of Account.
1071
- * @property {string} transfer_mode - Transfer Mode Of Account.
1072
- * @property {string} [vpa] - Branch Name Of Account.
1073
- * @property {string} [mobile] - Mobile no of User.
1074
- * @property {string} vpa_address - Bank Name Of Account.
1075
- * @property {string} created_on - Creation Date of Beneficiary.
1076
- * @property {string} address - Address of User.
1077
- * @property {string} title - Title Of Account.
1078
- * @property {string} [comment] - Remarks.
1079
- * @property {boolean} is_active - Boolean Flag whether Beneficiary set or not.
1080
- * @property {string} email - EMail of User.
1081
- * @property {string} [delights_user_name] - User Id Who filled the Beneficiary.
1082
- */
1083
-
1084
- /**
1085
- * @typedef BeneficiaryRefundOptions
1086
- * @property {OrderBeneficiaryDetails} [bank] - List of all add bank beneficiary details.
1087
- * @property {WalletBeneficiaryDetails} [wallet] - List of all add Wallet
1088
- * beneficiary details.
1089
- * @property {UpiBeneficiaryDetails} [upi] - List of all add UPI beneficiary details.
1090
- */
1091
-
1092
- /**
1093
- * @typedef OrderBeneficiaryResponseSchemaV2
1094
- * @property {boolean} show_beneficiary_details - Show Beneficiary details on UI or not.
1095
- * @property {BeneficiaryRefundOptions} data - Beneficiary Data for Bank
1096
- * account, UPI and Wallets.
1097
- * @property {Object} limit - Max Limit for adding bank account, UPI and wallet.
1098
- */
1099
-
1100
- /**
1101
- * @typedef ValidateValidateAddressRequest
1102
- * @property {string} [ifsc_code] - IFSC Code.
1103
- * @property {string} [upi_vpa] - VPA Address.
1104
- * @property {string} [aggregator] - Aggregator Name.
1105
- */
1106
-
1107
- /**
1108
- * @typedef VPADetails
1109
- * @property {boolean} is_valid - Is VPA valid or not.
1110
- * @property {string} upi_vpa - VPA address.
1111
- * @property {string} status - VPA validation message.
1112
- * @property {string} customer_name - VPA Customer Name.
1113
- */
1114
-
1115
- /**
1116
- * @typedef ValidateValidateAddressResponse
1117
- * @property {VPADetails} [upi] - UPI validation details.
1118
- * @property {boolean} success - Whether address validation is successful or not.
1119
- * @property {Object} [ifsc] - IFSC details response data.
1120
- */
1121
-
1122
- /**
1123
- * @typedef PaymentMethodsMetaOrder
1124
- * @property {string} merchant_code - Merchant code.
1125
- * @property {string} payment_gateway - Payment gateway name.
1126
- * @property {string} payment_identifier - Payment identifier.
1127
- */
1128
-
1129
- /**
1130
- * @typedef PaymentOrderMethods
1131
- * @property {number} amount - Amount to be collected.
1132
- * @property {string} [payment] - Payment type i.e. Required / Blocked.
1133
- * @property {string} mode - Payment mode.
1134
- * @property {PaymentMethodsMetaOrder} meta
1135
- * @property {string} name - Payment mode name.
1136
- */
1137
-
1138
- /**
1139
- * @typedef PaymentOrderRequest
1140
- * @property {PaymentOrderMethods[]} [payment_methods] - All payment methods for order.
1141
- * @property {string} order_id - Order id.
1142
- * @property {string} [shipment_id] - Shipment_id.
1143
- */
1144
-
1145
- /**
1146
- * @typedef PaymentOrderData
1147
- * @property {number} [amount] - Amount.
1148
- * @property {string} [aggregator] - Aggregator name.
1149
- * @property {string} [callback_url] - Callback url for aggregator.
1150
- * @property {string} [order_id] - Aggregator order id.
1151
- * @property {string} [customer_id] - Aggregator customer id.
1152
- * @property {string} [merchant_order_id] - Merchant order id.
1153
- * @property {string} [currency] - Currency used for the order.
1154
- * @property {string} [email] - Email address of the customer.
1155
- * @property {string} [contact] - Contact number of the customer.
1156
- * @property {string} [method] - Method of payment or delivery for the order.
1157
- */
1158
-
1159
- /**
1160
- * @typedef PaymentOrderResponse
1161
- * @property {string} [payment_confirm_url] - Payment confirm url for aggregator.
1162
- * @property {string} [callback_url] - Callback url for aggregator.
1163
- * @property {string} [order_id] - Merchant order id.
1164
- * @property {boolean} [success] - Successful or failure.
1165
- * @property {number} status_code - HTTP status code.
1166
- * @property {PaymentOrderData} [data]
1167
- * @property {string} message - Detailed message.
1168
- */
1169
-
1170
- /**
1171
- * @typedef ShipmentRefundRequest
1172
- * @property {string} shipment_id - Shipment Id of the respective Merchant Order Id.
1173
- * @property {string} order_id - Merchant Order Id.
1174
- * @property {string} transfer_mode - Transfer Mode of the Beneficiary to be added.
1175
- * @property {string} [beneficiary_id] - Beneficiary Hash Id of the beneficiary added.
1176
- */
1177
-
1178
- /**
1179
- * @typedef ShipmentRefundDetail
1180
- * @property {string} shipment_id - ID of the shipment.
1181
- * @property {string} order_id - ID of an order.
1182
- * @property {string} transfer_mode - Mode of transfer for the shipment refund
1183
- * (e.g., bank transfer, digital wallet).
1184
- * @property {string} beneficiary_id - Unique identifier for the beneficiary
1185
- * receiving the refund.
1186
- */
1187
-
1188
- /**
1189
- * @typedef ShipmentRefundResponse
1190
- * @property {ShipmentRefundDetail} data - Selected Shipment refund option details.
1191
- * @property {boolean} success - Successful or not.
1192
- * @property {string} message - Detailed message.
1193
- */
1194
-
1195
- class PaymentApplicationModel {
1196
- /** @returns {AggregatorConfigDetail} */
1197
- static AggregatorConfigDetail() {
1198
- return Joi.object({
1199
- sdk: Joi.boolean().allow(null),
1200
- secret: Joi.string().allow("").required(),
1201
- api: Joi.string().allow("").allow(null),
1202
- pin: Joi.string().allow("").allow(null),
1203
- config_type: Joi.string().allow("").required(),
1204
- merchant_key: Joi.string().allow("").allow(null),
1205
- verify_api: Joi.string().allow("").allow(null),
1206
- key: Joi.string().allow("").required(),
1207
- user_id: Joi.string().allow("").allow(null),
1208
- merchant_id: Joi.string().allow("").allow(null),
1209
- });
1210
- }
1211
-
1212
- /** @returns {AggregatorsConfigDetailResponse} */
1213
- static AggregatorsConfigDetailResponse() {
1214
- return Joi.object({
1215
- success: Joi.boolean().required(),
1216
- razorpay: PaymentApplicationModel.AggregatorConfigDetail(),
1217
- juspay: PaymentApplicationModel.AggregatorConfigDetail(),
1218
- simpl: PaymentApplicationModel.AggregatorConfigDetail(),
1219
- payumoney: PaymentApplicationModel.AggregatorConfigDetail(),
1220
- rupifi: PaymentApplicationModel.AggregatorConfigDetail(),
1221
- mswipe: PaymentApplicationModel.AggregatorConfigDetail(),
1222
- stripe: PaymentApplicationModel.AggregatorConfigDetail(),
1223
- ccavenue: PaymentApplicationModel.AggregatorConfigDetail(),
1224
- env: Joi.string().allow("").required(),
1225
- });
1226
- }
1227
-
1228
- /** @returns {ErrorCodeAndDescription} */
1229
- static ErrorCodeAndDescription() {
1230
- return Joi.object({
1231
- code: Joi.string().allow("").required(),
1232
- description: Joi.string().allow("").required(),
1233
- });
1234
- }
1235
-
1236
- /** @returns {HttpErrorCodeAndResponse} */
1237
- static HttpErrorCodeAndResponse() {
1238
- return Joi.object({
1239
- error: PaymentApplicationModel.ErrorCodeAndDescription(),
1240
- success: Joi.boolean().required(),
1241
- });
1242
- }
1243
-
1244
- /** @returns {AttachCardRequest} */
1245
- static AttachCardRequest() {
1246
- return Joi.object({
1247
- nickname: Joi.string().allow(""),
1248
- refresh: Joi.boolean().allow(null),
1249
- card_id: Joi.string().allow("").allow(null).required(),
1250
- name_on_card: Joi.string().allow(""),
1251
- });
1252
- }
1253
-
1254
- /** @returns {AttachCardsResponse} */
1255
- static AttachCardsResponse() {
1256
- return Joi.object({
1257
- data: Joi.any().required(),
1258
- success: Joi.boolean().required(),
1259
- message: Joi.string().allow(""),
1260
- });
1261
- }
1262
-
1263
- /** @returns {CardPaymentGateway} */
1264
- static CardPaymentGateway() {
1265
- return Joi.object({
1266
- api: Joi.string().allow("").allow(null),
1267
- aggregator: Joi.string().allow("").required(),
1268
- customer_id: Joi.string().allow("").allow(null),
1269
- });
1270
- }
1271
-
1272
- /** @returns {ActiveCardPaymentGatewayResponse} */
1273
- static ActiveCardPaymentGatewayResponse() {
1274
- return Joi.object({
1275
- cards: PaymentApplicationModel.CardPaymentGateway().required(),
1276
- success: Joi.boolean().required(),
1277
- message: Joi.string().allow("").required(),
1278
- });
1279
- }
1280
-
1281
- /** @returns {Card} */
1282
- static Card() {
1283
- return Joi.object({
1284
- card_number: Joi.string().allow("").allow(null),
1285
- card_name: Joi.string().allow("").allow(null),
1286
- card_type: Joi.string().allow("").allow(null),
1287
- card_brand_image: Joi.string().allow("").allow(null),
1288
- card_reference: Joi.string().allow("").allow(null),
1289
- card_issuer: Joi.string().allow("").allow(null),
1290
- card_brand: Joi.string().allow("").allow(null),
1291
- expired: Joi.boolean().allow(null),
1292
- compliant_with_tokenisation_guidelines: Joi.boolean().allow(null),
1293
- card_isin: Joi.string().allow("").allow(null),
1294
- exp_year: Joi.number().allow(null),
1295
- nickname: Joi.string().allow("").allow(null),
1296
- aggregator_name: Joi.string().allow("").required(),
1297
- card_fingerprint: Joi.string().allow("").allow(null),
1298
- card_token: Joi.string().allow("").allow(null),
1299
- exp_month: Joi.number().allow(null),
1300
- card_id: Joi.string().allow("").allow(null),
1301
- });
1302
- }
1303
-
1304
- /** @returns {ListCardsResponse} */
1305
- static ListCardsResponse() {
1306
- return Joi.object({
1307
- data: Joi.array().items(PaymentApplicationModel.Card()),
1308
- success: Joi.boolean().required(),
1309
- message: Joi.string().allow("").required(),
1310
- });
1311
- }
1312
-
1313
- /** @returns {DeletehCardRequest} */
1314
- static DeletehCardRequest() {
1315
- return Joi.object({
1316
- card_id: Joi.string().allow("").allow(null).required(),
1317
- });
1318
- }
1319
-
1320
- /** @returns {DeleteCardsResponse} */
1321
- static DeleteCardsResponse() {
1322
- return Joi.object({
1323
- success: Joi.boolean().required(),
1324
- message: Joi.string().allow("").allow(null),
1325
- });
1326
- }
1327
-
1328
- /** @returns {ValidateCustomerRequest} */
1329
- static ValidateCustomerRequest() {
1330
- return Joi.object({
1331
- aggregator: Joi.string().allow("").required(),
1332
- transaction_amount_in_paise: Joi.number().required(),
1333
- phone_number: Joi.string().allow("").required(),
1334
- billing_address: Joi.any(),
1335
- order_items: Joi.array().items(Joi.any()),
1336
- payload: Joi.string().allow("").allow(null),
1337
- merchant_params: Joi.any(),
1338
- delivery_address: Joi.any(),
1339
- });
1340
- }
1341
-
1342
- /** @returns {ValidateCustomerResponse} */
1343
- static ValidateCustomerResponse() {
1344
- return Joi.object({
1345
- data: Joi.any(),
1346
- success: Joi.boolean().required(),
1347
- message: Joi.string().allow("").required(),
1348
- });
1349
- }
1350
-
1351
- /** @returns {ChargeCustomerRequest} */
1352
- static ChargeCustomerRequest() {
1353
- return Joi.object({
1354
- verified: Joi.boolean().allow(null),
1355
- aggregator: Joi.string().allow("").required(),
1356
- order_id: Joi.string().allow("").required(),
1357
- transaction_token: Joi.string().allow("").allow(null),
1358
- amount: Joi.number().allow(null).required(),
1359
- });
1360
- }
1361
-
1362
- /** @returns {ChargeCustomerResponse} */
1363
- static ChargeCustomerResponse() {
1364
- return Joi.object({
1365
- status: Joi.string().allow("").required(),
1366
- cart_id: Joi.string().allow("").allow(null),
1367
- success: Joi.boolean().required(),
1368
- aggregator: Joi.string().allow("").required(),
1369
- message: Joi.string().allow("").required(),
1370
- order_id: Joi.string().allow("").required(),
1371
- delivery_address_id: Joi.string().allow("").allow(null),
1372
- });
1373
- }
1374
-
1375
- /** @returns {PaymentInitializationRequest} */
1376
- static PaymentInitializationRequest() {
1377
- return Joi.object({
1378
- razorpay_payment_id: Joi.string().allow("").allow(null),
1379
- method: Joi.string().allow("").required(),
1380
- device_id: Joi.string().allow("").allow(null),
1381
- aggregator: Joi.string().allow("").required(),
1382
- customer_id: Joi.string().allow("").required(),
1383
- contact: Joi.string().allow("").required(),
1384
- merchant_order_id: Joi.string().allow("").required(),
1385
- vpa: Joi.string().allow("").allow(null),
1386
- order_id: Joi.string().allow("").required(),
1387
- currency: Joi.string().allow("").required(),
1388
- timeout: Joi.number().allow(null),
1389
- amount: Joi.number().allow(null).required(),
1390
- email: Joi.string().allow("").required(),
1391
- });
1392
- }
1393
-
1394
- /** @returns {PaymentInitializationResponse} */
1395
- static PaymentInitializationResponse() {
1396
- return Joi.object({
1397
- status: Joi.string().allow(""),
1398
- razorpay_payment_id: Joi.string().allow("").allow(null),
1399
- aggregator_order_id: Joi.string().allow(""),
1400
- method: Joi.string().allow("").required(),
1401
- success: Joi.boolean().required(),
1402
- upi_poll_url: Joi.string().allow("").allow(null),
1403
- virtual_id: Joi.string().allow("").allow(null),
1404
- device_id: Joi.string().allow("").allow(null),
1405
- polling_url: Joi.string().allow("").required(),
1406
- aggregator: Joi.string().allow("").required(),
1407
- merchant_order_id: Joi.string().allow("").required(),
1408
- customer_id: Joi.string().allow("").allow(null),
1409
- vpa: Joi.string().allow("").allow(null),
1410
- currency: Joi.string().allow("").allow(null),
1411
- timeout: Joi.number().allow(null),
1412
- amount: Joi.number().allow(null),
1413
- bqr_image: Joi.string().allow("").allow(null),
1414
- });
1415
- }
1416
-
1417
- /** @returns {PaymentStatusUpdateRequest} */
1418
- static PaymentStatusUpdateRequest() {
1419
- return Joi.object({
1420
- status: Joi.string().allow(""),
1421
- merchant_transaction_id: Joi.string().allow(""),
1422
- method: Joi.string().allow("").required(),
1423
- device_id: Joi.string().allow("").allow(null),
1424
- aggregator: Joi.string().allow("").required(),
1425
- customer_id: Joi.string().allow(""),
1426
- contact: Joi.string().allow(""),
1427
- merchant_order_id: Joi.string().allow("").required(),
1428
- vpa: Joi.string().allow(""),
1429
- order_id: Joi.string().allow(""),
1430
- currency: Joi.string().allow(""),
1431
- amount: Joi.number().allow(null),
1432
- email: Joi.string().allow(""),
1433
- });
1434
- }
1435
-
1436
- /** @returns {PaymentStatusUpdateResponse} */
1437
- static PaymentStatusUpdateResponse() {
1438
- return Joi.object({
1439
- status: Joi.string().allow("").required(),
1440
- success: Joi.boolean().allow(null),
1441
- retry: Joi.boolean().required(),
1442
- redirect_url: Joi.string().allow("").allow(null),
1443
- aggregator_name: Joi.string().allow("").required(),
1444
- });
1445
- }
1446
-
1447
- /** @returns {IntentAppErrorList} */
1448
- static IntentAppErrorList() {
1449
- return Joi.object({
1450
- code: Joi.string().allow("").allow(null),
1451
- package_name: Joi.string().allow("").allow(null),
1452
- });
1453
- }
1454
-
1455
- /** @returns {PaymentModeLogo} */
1456
- static PaymentModeLogo() {
1457
- return Joi.object({
1458
- large: Joi.string().allow("").required(),
1459
- small: Joi.string().allow("").required(),
1460
- });
1461
- }
1462
-
1463
- /** @returns {IntentApp} */
1464
- static IntentApp() {
1465
- return Joi.object({
1466
- code: Joi.string().allow("").allow(null),
1467
- package_name: Joi.string().allow("").allow(null),
1468
- logos: PaymentApplicationModel.PaymentModeLogo(),
1469
- display_name: Joi.string().allow("").allow(null),
1470
- });
1471
- }
1472
-
1473
- /** @returns {PaymentModeList} */
1474
- static PaymentModeList() {
1475
- return Joi.object({
1476
- card_number: Joi.string().allow("").allow(null),
1477
- merchant_code: Joi.string().allow("").allow(null),
1478
- card_reference: Joi.string().allow("").allow(null),
1479
- card_issuer: Joi.string().allow("").allow(null),
1480
- compliant_with_tokenisation_guidelines: Joi.boolean().allow(null),
1481
- code: Joi.string().allow("").allow(null),
1482
- cod_limit: Joi.number().allow(null),
1483
- intent_flow: Joi.boolean().allow(null),
1484
- fynd_vpa: Joi.string().allow("").allow(null),
1485
- intent_app_error_dict_list: Joi.array()
1486
- .items(PaymentApplicationModel.IntentAppErrorList())
1487
- .allow(null, ""),
1488
- aggregator_name: Joi.string().allow("").required(),
1489
- card_fingerprint: Joi.string().allow("").allow(null),
1490
- intent_app_error_list: Joi.array()
1491
- .items(Joi.string().allow(""))
1492
- .allow(null, ""),
1493
- intent_app: Joi.array()
1494
- .items(PaymentApplicationModel.IntentApp())
1495
- .allow(null, ""),
1496
- expired: Joi.boolean().allow(null),
1497
- retry_count: Joi.number().allow(null),
1498
- exp_year: Joi.number().allow(null),
1499
- exp_month: Joi.number().allow(null),
1500
- card_id: Joi.string().allow("").allow(null),
1501
- remaining_limit: Joi.number().allow(null),
1502
- display_priority: Joi.number().allow(null),
1503
- card_brand: Joi.string().allow("").allow(null),
1504
- cod_limit_per_order: Joi.number().allow(null),
1505
- logo_url: PaymentApplicationModel.PaymentModeLogo(),
1506
- nickname: Joi.string().allow("").allow(null),
1507
- card_name: Joi.string().allow("").allow(null),
1508
- card_type: Joi.string().allow("").allow(null),
1509
- card_brand_image: Joi.string().allow("").allow(null),
1510
- display_name: Joi.string().allow("").allow(null),
1511
- card_isin: Joi.string().allow("").allow(null),
1512
- timeout: Joi.number().allow(null),
1513
- card_token: Joi.string().allow("").allow(null),
1514
- name: Joi.string().allow("").allow(null),
1515
- meta: Joi.any().allow(null),
1516
- });
1517
- }
1518
-
1519
- /** @returns {RootPaymentMode} */
1520
- static RootPaymentMode() {
1521
- return Joi.object({
1522
- is_pay_by_card_pl: Joi.boolean().allow(null),
1523
- add_card_enabled: Joi.boolean().allow(null),
1524
- display_priority: Joi.number().required(),
1525
- display_name: Joi.string().allow("").required(),
1526
- list: Joi.array().items(PaymentApplicationModel.PaymentModeList()),
1527
- save_card: Joi.boolean().allow(null),
1528
- aggregator_name: Joi.string().allow("").allow(null),
1529
- name: Joi.string().allow("").required(),
1530
- anonymous_enable: Joi.boolean().allow(null),
1531
- });
1532
- }
1533
-
1534
- /** @returns {AggregatorRoute} */
1535
- static AggregatorRoute() {
1536
- return Joi.object({
1537
- data: Joi.any().allow(null),
1538
- payment_flow_data: Joi.any().allow(null),
1539
- payment_flow: Joi.string().allow("").allow(null),
1540
- api_link: Joi.string().allow("").allow(null),
1541
- });
1542
- }
1543
-
1544
- /** @returns {PaymentDefaultSelection} */
1545
- static PaymentDefaultSelection() {
1546
- return Joi.object({
1547
- mode: Joi.string().allow("").allow(null),
1548
- identifier: Joi.string().allow("").allow(null),
1549
- skip: Joi.boolean().allow(null),
1550
- });
1551
- }
1552
-
1553
- /** @returns {PaymentFlow} */
1554
- static PaymentFlow() {
1555
- return Joi.object({
1556
- bqr_razorpay: PaymentApplicationModel.AggregatorRoute(),
1557
- fynd: PaymentApplicationModel.AggregatorRoute(),
1558
- epaylater: PaymentApplicationModel.AggregatorRoute(),
1559
- razorpay: PaymentApplicationModel.AggregatorRoute(),
1560
- juspay: PaymentApplicationModel.AggregatorRoute(),
1561
- ajiodhan: PaymentApplicationModel.AggregatorRoute(),
1562
- simpl: PaymentApplicationModel.AggregatorRoute(),
1563
- rupifi: PaymentApplicationModel.AggregatorRoute(),
1564
- mswipe: PaymentApplicationModel.AggregatorRoute(),
1565
- stripe: PaymentApplicationModel.AggregatorRoute(),
1566
- ccavenue: PaymentApplicationModel.AggregatorRoute(),
1567
- payubiz: PaymentApplicationModel.AggregatorRoute(),
1568
- jiopay: PaymentApplicationModel.AggregatorRoute(),
1569
- upi_razorpay: PaymentApplicationModel.AggregatorRoute(),
1570
- });
1571
- }
1572
-
1573
- /** @returns {PaymentOptionAndFlow} */
1574
- static PaymentOptionAndFlow() {
1575
- return Joi.object({
1576
- payment_option: Joi.array()
1577
- .items(PaymentApplicationModel.RootPaymentMode())
1578
- .required(),
1579
- payment_flows: PaymentApplicationModel.PaymentFlow().required(),
1580
- payment_default_selection: PaymentApplicationModel.PaymentDefaultSelection(),
1581
- });
1582
- }
1583
-
1584
- /** @returns {AdvanceObject} */
1585
- static AdvanceObject() {
1586
- return Joi.object({
1587
- is_active: Joi.boolean().allow(null),
1588
- amount: Joi.number(),
1589
- time_unit: Joi.string().allow("").allow(null),
1590
- description: Joi.string().allow("").allow(null),
1591
- display_name: Joi.string().allow("").allow(null),
1592
- prepayment_type: Joi.string().allow("").allow(null),
1593
- prepayment_value: Joi.number().allow(null),
1594
- cancellation_type: Joi.string().allow("").allow(null),
1595
- refund_time_limit: Joi.number().allow(null),
1596
- all_prepayment_type: Joi.array()
1597
- .items(Joi.string().allow("").allow(null))
1598
- .allow(null, ""),
1599
- allow_custom_advance_amount: Joi.boolean().allow(null),
1600
- }).allow(null);
1601
- }
1602
-
1603
- /** @returns {SplitObject} */
1604
- static SplitObject() {
1605
- return Joi.object({
1606
- total_number_of_splits: Joi.number().allow(null),
1607
- splits_remaining: Joi.number().allow(null),
1608
- amount_remaining: Joi.number().allow(null),
1609
- }).allow(null);
1610
- }
1611
-
1612
- /** @returns {AdvancePaymentObject} */
1613
- static AdvancePaymentObject() {
1614
- return Joi.object({
1615
- name: Joi.string().allow("").allow(null),
1616
- display_priority: Joi.number().allow(null),
1617
- payment_mode_id: Joi.number().allow(null),
1618
- display_name: Joi.string().allow("").allow(null),
1619
- list: Joi.array()
1620
- .items(PaymentApplicationModel.PaymentModeList())
1621
- .allow(null, ""),
1622
- split: PaymentApplicationModel.SplitObject(),
1623
- advance: PaymentApplicationModel.AdvanceObject(),
1624
- });
1625
- }
1626
-
1627
- /** @returns {PaymentModeRouteResponse} */
1628
- static PaymentModeRouteResponse() {
1629
- return Joi.object({
1630
- payment_options: PaymentApplicationModel.PaymentOptionAndFlow().required(),
1631
- success: Joi.boolean().required(),
1632
- payment_breakup: Joi.any(),
1633
- advance_payment: Joi.array()
1634
- .items(PaymentApplicationModel.AdvancePaymentObject())
1635
- .allow(null, ""),
1636
- });
1637
- }
1638
-
1639
- /** @returns {WalletLinkRequestSchema} */
1640
- static WalletLinkRequestSchema() {
1641
- return Joi.object({
1642
- aggregator: Joi.string().allow("").required(),
1643
- mobile: Joi.string().allow("").required(),
1644
- wallet_code: Joi.string().allow("").required(),
1645
- });
1646
- }
1647
-
1648
- /** @returns {WalletVerifyRequestSchema} */
1649
- static WalletVerifyRequestSchema() {
1650
- return Joi.object({
1651
- aggregator: Joi.string().allow("").required(),
1652
- link_token: Joi.string().allow("").required(),
1653
- otp: Joi.number().required(),
1654
- });
1655
- }
1656
-
1657
- /** @returns {WalletDelinkRequestSchema} */
1658
- static WalletDelinkRequestSchema() {
1659
- return Joi.object({
1660
- aggregator: Joi.string().allow("").required(),
1661
- wallet_code: Joi.string().allow("").required(),
1662
- });
1663
- }
1664
-
1665
- /** @returns {WalletResponseSchema} */
1666
- static WalletResponseSchema() {
1667
- return Joi.object({
1668
- data: Joi.any().required(),
1669
- success: Joi.boolean().required(),
1670
- });
1671
- }
1672
-
1673
- /** @returns {RupifiBannerData} */
1674
- static RupifiBannerData() {
1675
- return Joi.object({
1676
- status: Joi.string().allow(""),
1677
- kyc_url: Joi.string().allow(""),
1678
- });
1679
- }
1680
-
1681
- /** @returns {RupifiBannerResponse} */
1682
- static RupifiBannerResponse() {
1683
- return Joi.object({
1684
- data: PaymentApplicationModel.RupifiBannerData().required(),
1685
- success: Joi.boolean().required(),
1686
- });
1687
- }
1688
-
1689
- /** @returns {EpaylaterBannerData} */
1690
- static EpaylaterBannerData() {
1691
- return Joi.object({
1692
- status: Joi.string().allow(""),
1693
- message: Joi.string().allow(""),
1694
- display: Joi.boolean().required(),
1695
- });
1696
- }
1697
-
1698
- /** @returns {EpaylaterBannerResponse} */
1699
- static EpaylaterBannerResponse() {
1700
- return Joi.object({
1701
- data: PaymentApplicationModel.EpaylaterBannerData().required(),
1702
- success: Joi.boolean().required(),
1703
- });
1704
- }
1705
-
1706
- /** @returns {ResendOrCancelPaymentRequest} */
1707
- static ResendOrCancelPaymentRequest() {
1708
- return Joi.object({
1709
- order_id: Joi.string().allow("").required(),
1710
- device_id: Joi.string().allow("").allow(null),
1711
- request_type: Joi.string().allow("").required(),
1712
- });
1713
- }
1714
-
1715
- /** @returns {LinkStatus} */
1716
- static LinkStatus() {
1717
- return Joi.object({
1718
- status: Joi.string().allow("").required(),
1719
- message: Joi.string().allow("").required(),
1720
- is_payment_done: Joi.boolean(),
1721
- });
1722
- }
1723
-
1724
- /** @returns {ResendOrCancelPaymentResponse} */
1725
- static ResendOrCancelPaymentResponse() {
1726
- return Joi.object({
1727
- data: PaymentApplicationModel.LinkStatus().required(),
1728
- success: Joi.boolean().required(),
1729
- });
1730
- }
1731
-
1732
- /** @returns {renderHTMLRequest} */
1733
- static renderHTMLRequest() {
1734
- return Joi.object({
1735
- returntype: Joi.string().allow("").allow(null),
1736
- base64_html: Joi.string().allow("").required(),
1737
- });
1738
- }
1739
-
1740
- /** @returns {renderHTMLResponse} */
1741
- static renderHTMLResponse() {
1742
- return Joi.object({
1743
- html: Joi.string().allow("").required(),
1744
- });
1745
- }
1746
-
1747
- /** @returns {ValidateVPARequest} */
1748
- static ValidateVPARequest() {
1749
- return Joi.object({
1750
- upi_vpa: Joi.string().allow("").required(),
1751
- aggregator: Joi.string().allow(""),
1752
- });
1753
- }
1754
-
1755
- /** @returns {ValidateUPI} */
1756
- static ValidateUPI() {
1757
- return Joi.object({
1758
- status: Joi.string().allow("").required(),
1759
- customer_name: Joi.string().allow("").required(),
1760
- is_valid: Joi.boolean().required(),
1761
- upi_vpa: Joi.string().allow("").required(),
1762
- });
1763
- }
1764
-
1765
- /** @returns {ValidateVPAResponse} */
1766
- static ValidateVPAResponse() {
1767
- return Joi.object({
1768
- data: PaymentApplicationModel.ValidateUPI().required(),
1769
- success: Joi.boolean().required(),
1770
- });
1771
- }
1772
-
1773
- /** @returns {CardDetails} */
1774
- static CardDetails() {
1775
- return Joi.object({
1776
- status: Joi.boolean().required(),
1777
- country: Joi.string().allow("").required(),
1778
- bank_code: Joi.string().allow("").allow(null).required(),
1779
- id: Joi.string().allow("").required(),
1780
- card_exp_year: Joi.string().allow(""),
1781
- card_brand: Joi.string().allow("").required(),
1782
- type: Joi.string().allow("").required(),
1783
- card_sub_type: Joi.string().allow("").allow(null).required(),
1784
- is_domestic_card: Joi.boolean().required(),
1785
- name_on_card: Joi.string().allow(""),
1786
- card_exp_month: Joi.string().allow(""),
1787
- extended_card_type: Joi.string().allow("").required(),
1788
- card_object: Joi.string().allow("").required(),
1789
- card_token: Joi.string().allow(""),
1790
- user: Joi.string().allow(""),
1791
- bank: Joi.string().allow("").required(),
1792
- });
1793
- }
1794
-
1795
- /** @returns {CardDetailsResponse} */
1796
- static CardDetailsResponse() {
1797
- return Joi.object({
1798
- data: PaymentApplicationModel.CardDetails().required(),
1799
- success: Joi.boolean().required(),
1800
- });
1801
- }
1802
-
1803
- /** @returns {TransferItemsDetails} */
1804
- static TransferItemsDetails() {
1805
- return Joi.object({
1806
- id: Joi.number().required(),
1807
- display_name: Joi.string().allow(""),
1808
- logo_large: Joi.string().allow("").required(),
1809
- logo_small: Joi.string().allow("").required(),
1810
- name: Joi.string().allow("").required(),
1811
- });
1812
- }
1813
-
1814
- /** @returns {TransferModeDetails} */
1815
- static TransferModeDetails() {
1816
- return Joi.object({
1817
- items: Joi.array().items(PaymentApplicationModel.TransferItemsDetails()),
1818
- display_name: Joi.string().allow("").required(),
1819
- });
1820
- }
1821
-
1822
- /** @returns {TransferModeResponse} */
1823
- static TransferModeResponse() {
1824
- return Joi.object({
1825
- data: Joi.array()
1826
- .items(PaymentApplicationModel.TransferModeDetails())
1827
- .required(),
1828
- });
1829
- }
1830
-
1831
- /** @returns {UpdateRefundTransferModeRequest} */
1832
- static UpdateRefundTransferModeRequest() {
1833
- return Joi.object({
1834
- enable: Joi.boolean().required(),
1835
- transfer_mode: Joi.string().allow("").required(),
1836
- });
1837
- }
1838
-
1839
- /** @returns {UpdateRefundTransferModeResponse} */
1840
- static UpdateRefundTransferModeResponse() {
1841
- return Joi.object({
1842
- success: Joi.boolean(),
1843
- });
1844
- }
1845
-
1846
- /** @returns {OrderBeneficiaryDetails} */
1847
- static OrderBeneficiaryDetails() {
1848
- return Joi.object({
1849
- modified_on: Joi.string().allow("").required(),
1850
- account_no: Joi.string().allow("").required(),
1851
- mobile: Joi.string().allow(""),
1852
- bank_name: Joi.string().allow("").required(),
1853
- ifsc_code: Joi.string().allow("").required(),
1854
- is_active: Joi.boolean().required(),
1855
- beneficiary_id: Joi.string().allow("").required(),
1856
- account_holder: Joi.string().allow("").required(),
1857
- email: Joi.string().allow("").required(),
1858
- delights_user_name: Joi.string().allow("").allow(null),
1859
- id: Joi.number().required(),
1860
- transfer_mode: Joi.string().allow("").required(),
1861
- branch_name: Joi.string().allow(""),
1862
- created_on: Joi.string().allow("").required(),
1863
- subtitle: Joi.string().allow("").required(),
1864
- comment: Joi.string().allow(""),
1865
- address: Joi.string().allow("").required(),
1866
- title: Joi.string().allow("").required(),
1867
- display_name: Joi.string().allow("").required(),
1868
- });
1869
- }
1870
-
1871
- /** @returns {OrderBeneficiaryResponse} */
1872
- static OrderBeneficiaryResponse() {
1873
- return Joi.object({
1874
- show_beneficiary_details: Joi.boolean(),
1875
- beneficiaries: Joi.array()
1876
- .items(PaymentApplicationModel.OrderBeneficiaryDetails())
1877
- .allow(null, ""),
1878
- });
1879
- }
1880
-
1881
- /** @returns {NotFoundResourceError} */
1882
- static NotFoundResourceError() {
1883
- return Joi.object({
1884
- code: Joi.string().allow("").required(),
1885
- description: Joi.string().allow("").required(),
1886
- success: Joi.boolean().required(),
1887
- });
1888
- }
1889
-
1890
- /** @returns {IfscCodeResponse} */
1891
- static IfscCodeResponse() {
1892
- return Joi.object({
1893
- branch_name: Joi.string().allow("").required(),
1894
- success: Joi.boolean(),
1895
- bank_name: Joi.string().allow("").required(),
1896
- });
1897
- }
1898
-
1899
- /** @returns {ErrorCodeDescription} */
1900
- static ErrorCodeDescription() {
1901
- return Joi.object({
1902
- code: Joi.string().allow("").required(),
1903
- description: Joi.string().allow("").required(),
1904
- success: Joi.boolean().required(),
1905
- });
1906
- }
1907
-
1908
- /** @returns {AddBeneficiaryViaOtpVerificationRequest} */
1909
- static AddBeneficiaryViaOtpVerificationRequest() {
1910
- return Joi.object({
1911
- request_id: Joi.string().allow("").required(),
1912
- hash_key: Joi.string().allow("").required(),
1913
- otp: Joi.string().allow("").required(),
1914
- });
1915
- }
1916
-
1917
- /** @returns {AddBeneficiaryViaOtpVerificationResponse} */
1918
- static AddBeneficiaryViaOtpVerificationResponse() {
1919
- return Joi.object({
1920
- success: Joi.boolean(),
1921
- message: Joi.string().allow("").required(),
1922
- });
1923
- }
1924
-
1925
- /** @returns {WrongOtpError} */
1926
- static WrongOtpError() {
1927
- return Joi.object({
1928
- is_verified_flag: Joi.boolean().required(),
1929
- description: Joi.string().allow("").required(),
1930
- success: Joi.string().allow("").required(),
1931
- });
1932
- }
1933
-
1934
- /** @returns {BeneficiaryModeDetails} */
1935
- static BeneficiaryModeDetails() {
1936
- return Joi.object({
1937
- account_no: Joi.string().allow("").required(),
1938
- address: Joi.string().allow(""),
1939
- mobile: Joi.string().allow("").required(),
1940
- bank_name: Joi.string().allow("").required(),
1941
- comment: Joi.string().allow(""),
1942
- ifsc_code: Joi.string().allow("").required(),
1943
- vpa: Joi.string().allow("").allow(null),
1944
- branch_name: Joi.string().allow("").required(),
1945
- account_holder: Joi.string().allow("").required(),
1946
- wallet: Joi.string().allow("").allow(null),
1947
- email: Joi.string().allow("").required(),
1948
- });
1949
- }
1950
-
1951
- /** @returns {AddBeneficiaryDetailsRequest} */
1952
- static AddBeneficiaryDetailsRequest() {
1953
- return Joi.object({
1954
- delights: Joi.boolean().required(),
1955
- shipment_id: Joi.string().allow("").required(),
1956
- details: PaymentApplicationModel.BeneficiaryModeDetails().required(),
1957
- otp: Joi.string().allow(""),
1958
- order_id: Joi.string().allow("").required(),
1959
- transfer_mode: Joi.string().allow("").required(),
1960
- request_id: Joi.string().allow(""),
1961
- });
1962
- }
1963
-
1964
- /** @returns {RefundAccountResponse} */
1965
- static RefundAccountResponse() {
1966
- return Joi.object({
1967
- is_verified_flag: Joi.boolean(),
1968
- data: Joi.any(),
1969
- success: Joi.boolean().required(),
1970
- message: Joi.string().allow("").required(),
1971
- });
1972
- }
1973
-
1974
- /** @returns {BankDetailsForOTP} */
1975
- static BankDetailsForOTP() {
1976
- return Joi.object({
1977
- account_no: Joi.string().allow("").required(),
1978
- bank_name: Joi.string().allow("").required(),
1979
- ifsc_code: Joi.string().allow("").required(),
1980
- branch_name: Joi.string().allow("").required(),
1981
- account_holder: Joi.string().allow("").required(),
1982
- });
1983
- }
1984
-
1985
- /** @returns {AddBeneficiaryDetailsOTPRequest} */
1986
- static AddBeneficiaryDetailsOTPRequest() {
1987
- return Joi.object({
1988
- order_id: Joi.string().allow("").required(),
1989
- details: PaymentApplicationModel.BankDetailsForOTP().required(),
1990
- });
1991
- }
1992
-
1993
- /** @returns {WalletOtpRequest} */
1994
- static WalletOtpRequest() {
1995
- return Joi.object({
1996
- country_code: Joi.string().allow("").required(),
1997
- mobile: Joi.string().allow("").required(),
1998
- });
1999
- }
2000
-
2001
- /** @returns {WalletOtpResponse} */
2002
- static WalletOtpResponse() {
2003
- return Joi.object({
2004
- request_id: Joi.string().allow("").required(),
2005
- is_verified_flag: Joi.string().allow("").required(),
2006
- success: Joi.boolean(),
2007
- });
2008
- }
2009
-
2010
- /** @returns {SetDefaultBeneficiaryRequest} */
2011
- static SetDefaultBeneficiaryRequest() {
2012
- return Joi.object({
2013
- order_id: Joi.string().allow("").required(),
2014
- beneficiary_id: Joi.string().allow("").required(),
2015
- });
2016
- }
2017
-
2018
- /** @returns {SetDefaultBeneficiaryResponse} */
2019
- static SetDefaultBeneficiaryResponse() {
2020
- return Joi.object({
2021
- is_beneficiary_set: Joi.boolean().required(),
2022
- success: Joi.boolean(),
2023
- });
2024
- }
2025
-
2026
- /** @returns {GetPaymentLinkResponse} */
2027
- static GetPaymentLinkResponse() {
2028
- return Joi.object({
2029
- status_code: Joi.number().required(),
2030
- payment_link_current_status: Joi.string().allow("").allow(null),
2031
- success: Joi.boolean().required(),
2032
- polling_timeout: Joi.number().allow(null),
2033
- payment_link_url: Joi.string().allow("").allow(null),
2034
- external_order_id: Joi.string().allow("").allow(null),
2035
- message: Joi.string().allow("").required(),
2036
- merchant_name: Joi.string().allow("").allow(null),
2037
- amount: Joi.number().allow(null),
2038
- });
2039
- }
2040
-
2041
- /** @returns {ErrorDescription} */
2042
- static ErrorDescription() {
2043
- return Joi.object({
2044
- payment_transaction_id: Joi.string().allow("").allow(null),
2045
- expired: Joi.boolean().allow(null),
2046
- merchant_order_id: Joi.string().allow("").allow(null),
2047
- merchant_name: Joi.string().allow("").allow(null),
2048
- msg: Joi.string().allow("").allow(null),
2049
- cancelled: Joi.boolean().allow(null),
2050
- amount: Joi.number().allow(null),
2051
- invalid_id: Joi.boolean().allow(null),
2052
- });
2053
- }
2054
-
2055
- /** @returns {ErrorResponse} */
2056
- static ErrorResponse() {
2057
- return Joi.object({
2058
- status_code: Joi.number().required(),
2059
- error: PaymentApplicationModel.ErrorDescription(),
2060
- message: Joi.string().allow("").required(),
2061
- success: Joi.boolean().required(),
2062
- });
2063
- }
2064
-
2065
- /** @returns {CreatePaymentLinkMeta} */
2066
- static CreatePaymentLinkMeta() {
2067
- return Joi.object({
2068
- cart_id: Joi.string().allow("").required(),
2069
- checkout_mode: Joi.string().allow("").required(),
2070
- assign_card_id: Joi.string().allow("").allow(null),
2071
- amount: Joi.string().allow("").required(),
2072
- });
2073
- }
2074
-
2075
- /** @returns {CreatePaymentLinkRequest} */
2076
- static CreatePaymentLinkRequest() {
2077
- return Joi.object({
2078
- description: Joi.string().allow("").allow(null),
2079
- external_order_id: Joi.string().allow("").required(),
2080
- mobile_number: Joi.string().allow("").required(),
2081
- amount: Joi.number().required(),
2082
- meta: PaymentApplicationModel.CreatePaymentLinkMeta().required(),
2083
- email: Joi.string().allow("").required(),
2084
- });
2085
- }
2086
-
2087
- /** @returns {CreatePaymentLinkResponse} */
2088
- static CreatePaymentLinkResponse() {
2089
- return Joi.object({
2090
- status_code: Joi.number().required(),
2091
- success: Joi.boolean().required(),
2092
- polling_timeout: Joi.number().allow(null),
2093
- payment_link_url: Joi.string().allow("").allow(null),
2094
- message: Joi.string().allow("").required(),
2095
- payment_link_id: Joi.string().allow("").allow(null),
2096
- });
2097
- }
2098
-
2099
- /** @returns {CancelOrResendPaymentLinkRequest} */
2100
- static CancelOrResendPaymentLinkRequest() {
2101
- return Joi.object({
2102
- payment_link_id: Joi.string().allow("").required(),
2103
- });
2104
- }
2105
-
2106
- /** @returns {ResendPaymentLinkResponse} */
2107
- static ResendPaymentLinkResponse() {
2108
- return Joi.object({
2109
- status_code: Joi.number().required(),
2110
- polling_timeout: Joi.number().allow(null),
2111
- success: Joi.boolean().required(),
2112
- message: Joi.string().allow("").required(),
2113
- });
2114
- }
2115
-
2116
- /** @returns {CancelPaymentLinkResponse} */
2117
- static CancelPaymentLinkResponse() {
2118
- return Joi.object({
2119
- status_code: Joi.number().required(),
2120
- success: Joi.boolean().required(),
2121
- message: Joi.string().allow("").required(),
2122
- });
2123
- }
2124
-
2125
- /** @returns {PollingPaymentLinkResponse} */
2126
- static PollingPaymentLinkResponse() {
2127
- return Joi.object({
2128
- status: Joi.string().allow("").allow(null),
2129
- status_code: Joi.number().allow(null),
2130
- success: Joi.boolean().allow(null),
2131
- http_status: Joi.number().allow(null),
2132
- message: Joi.string().allow("").allow(null),
2133
- order_id: Joi.string().allow("").allow(null),
2134
- redirect_url: Joi.string().allow("").allow(null),
2135
- payment_link_id: Joi.string().allow("").allow(null),
2136
- aggregator_name: Joi.string().allow("").allow(null),
2137
- amount: Joi.number().allow(null),
2138
- });
2139
- }
2140
-
2141
- /** @returns {PaymentMethodsMeta} */
2142
- static PaymentMethodsMeta() {
2143
- return Joi.object({
2144
- merchant_code: Joi.string().allow("").required(),
2145
- payment_gateway: Joi.string().allow("").required(),
2146
- payment_identifier: Joi.string().allow("").required(),
2147
- });
2148
- }
2149
-
2150
- /** @returns {CreateOrderUserPaymentMethods} */
2151
- static CreateOrderUserPaymentMethods() {
2152
- return Joi.object({
2153
- name: Joi.string().allow("").required(),
2154
- mode: Joi.string().allow("").required(),
2155
- meta: PaymentApplicationModel.PaymentMethodsMeta().required(),
2156
- });
2157
- }
2158
-
2159
- /** @returns {CreateOrderUserRequest} */
2160
- static CreateOrderUserRequest() {
2161
- return Joi.object({
2162
- failure_callback_url: Joi.string().allow("").required(),
2163
- currency: Joi.string().allow("").required(),
2164
- payment_link_id: Joi.string().allow("").required(),
2165
- payment_methods: PaymentApplicationModel.CreateOrderUserPaymentMethods().required(),
2166
- success_callback_url: Joi.string().allow("").required(),
2167
- meta: Joi.any().allow(null),
2168
- });
2169
- }
2170
-
2171
- /** @returns {CreateOrderUserData} */
2172
- static CreateOrderUserData() {
2173
- return Joi.object({
2174
- method: Joi.string().allow("").allow(null),
2175
- aggregator: Joi.string().allow("").allow(null),
2176
- customer_id: Joi.string().allow("").allow(null),
2177
- contact: Joi.string().allow("").allow(null),
2178
- merchant_order_id: Joi.string().allow("").allow(null),
2179
- order_id: Joi.string().allow("").allow(null),
2180
- currency: Joi.string().allow("").allow(null),
2181
- callback_url: Joi.string().allow("").allow(null),
2182
- amount: Joi.number().allow(null),
2183
- email: Joi.string().allow("").allow(null),
2184
- });
2185
- }
2186
-
2187
- /** @returns {CreateOrderUserResponse} */
2188
- static CreateOrderUserResponse() {
2189
- return Joi.object({
2190
- status_code: Joi.number().required(),
2191
- success: Joi.boolean().required(),
2192
- data: PaymentApplicationModel.CreateOrderUserData(),
2193
- message: Joi.string().allow("").required(),
2194
- order_id: Joi.string().allow("").allow(null),
2195
- callback_url: Joi.string().allow("").allow(null),
2196
- payment_confirm_url: Joi.string().allow("").allow(null),
2197
- });
2198
- }
2199
-
2200
- /** @returns {BalanceDetails} */
2201
- static BalanceDetails() {
2202
- return Joi.object({
2203
- formatted_value: Joi.string().allow("").allow(null),
2204
- currency: Joi.string().allow("").allow(null),
2205
- value: Joi.number().allow(null),
2206
- });
2207
- }
2208
-
2209
- /** @returns {CreditSummary} */
2210
- static CreditSummary() {
2211
- return Joi.object({
2212
- total_due_amount: PaymentApplicationModel.BalanceDetails(),
2213
- status: Joi.string().allow("").allow(null),
2214
- limit: PaymentApplicationModel.BalanceDetails(),
2215
- credit_line_id: Joi.string().allow("").allow(null),
2216
- amount_available: PaymentApplicationModel.BalanceDetails(),
2217
- due_amount: PaymentApplicationModel.BalanceDetails(),
2218
- due_date: Joi.string().allow("").allow(null),
2219
- balance: PaymentApplicationModel.BalanceDetails(),
2220
- status_message: Joi.string().allow("").allow(null),
2221
- repayment_url: Joi.string().allow("").allow(null),
2222
- soa_url: Joi.string().allow("").allow(null),
2223
- is_eligible_for_txn: Joi.boolean().allow(null),
2224
- merchant_customer_ref_id: Joi.string().allow("").allow(null),
2225
- buyer_status: Joi.string().allow("").allow(null),
2226
- activation_url: Joi.string().allow("").allow(null),
2227
- });
2228
- }
2229
-
2230
- /** @returns {CustomerCreditSummaryResponse} */
2231
- static CustomerCreditSummaryResponse() {
2232
- return Joi.object({
2233
- data: PaymentApplicationModel.CreditSummary(),
2234
- success: Joi.boolean().required(),
2235
- });
2236
- }
2237
-
2238
- /** @returns {RedirectURL} */
2239
- static RedirectURL() {
2240
- return Joi.object({
2241
- status: Joi.boolean().required(),
2242
- signup_url: Joi.string().allow("").required(),
2243
- });
2244
- }
2245
-
2246
- /** @returns {RedirectToAggregatorResponse} */
2247
- static RedirectToAggregatorResponse() {
2248
- return Joi.object({
2249
- data: PaymentApplicationModel.RedirectURL().required(),
2250
- success: Joi.boolean().required(),
2251
- });
2252
- }
2253
-
2254
- /** @returns {CreditDetail} */
2255
- static CreditDetail() {
2256
- return Joi.object({
2257
- status: Joi.boolean().required(),
2258
- is_registered: Joi.boolean().required(),
2259
- signup_url: Joi.string().allow("").required(),
2260
- });
2261
- }
2262
-
2263
- /** @returns {CheckCreditResponse} */
2264
- static CheckCreditResponse() {
2265
- return Joi.object({
2266
- data: PaymentApplicationModel.CreditDetail().required(),
2267
- success: Joi.boolean().required(),
2268
- });
2269
- }
2270
-
2271
- /** @returns {KYCAddress} */
2272
- static KYCAddress() {
2273
- return Joi.object({
2274
- city: Joi.string().allow("").required(),
2275
- addressline2: Joi.string().allow("").allow(null),
2276
- state: Joi.string().allow("").required(),
2277
- ownership_type: Joi.string().allow("").allow(null),
2278
- pincode: Joi.string().allow("").required(),
2279
- land_mark: Joi.string().allow("").allow(null),
2280
- addressline1: Joi.string().allow("").required(),
2281
- });
2282
- }
2283
-
2284
- /** @returns {UserPersonalInfoInDetails} */
2285
- static UserPersonalInfoInDetails() {
2286
- return Joi.object({
2287
- first_name: Joi.string().allow("").required(),
2288
- voter_id: Joi.string().allow("").allow(null),
2289
- gender: Joi.string().allow("").allow(null),
2290
- dob: Joi.string().allow("").allow(null).required(),
2291
- passport: Joi.string().allow("").allow(null),
2292
- fathers_name: Joi.string().allow("").allow(null),
2293
- mothers_name: Joi.string().allow("").allow(null),
2294
- middle_name: Joi.string().allow("").allow(null),
2295
- last_name: Joi.string().allow("").allow(null),
2296
- pan: Joi.string().allow("").allow(null),
2297
- driving_license: Joi.string().allow("").allow(null),
2298
- email_verified: Joi.boolean().required(),
2299
- address_as_per_id: PaymentApplicationModel.KYCAddress().required(),
2300
- mobile_verified: Joi.boolean().required(),
2301
- phone: Joi.string().allow("").required(),
2302
- email: Joi.string().allow("").allow(null),
2303
- });
2304
- }
2305
-
2306
- /** @returns {MarketplaceInfo} */
2307
- static MarketplaceInfo() {
2308
- return Joi.object({
2309
- date_of_joining: Joi.string().allow("").allow(null),
2310
- name: Joi.string().allow("").required(),
2311
- membership_id: Joi.string().allow("").required(),
2312
- });
2313
- }
2314
-
2315
- /** @returns {BusinessDetails} */
2316
- static BusinessDetails() {
2317
- return Joi.object({
2318
- business_ownership_type: Joi.string().allow("").allow(null),
2319
- vintage: Joi.string().allow("").allow(null),
2320
- gstin: Joi.string().allow("").allow(null),
2321
- pan: Joi.string().allow("").allow(null),
2322
- entity_type: Joi.string().allow("").allow(null),
2323
- shop_and_establishment: Joi.any(),
2324
- fssai: Joi.string().allow("").allow(null),
2325
- fda: Joi.string().allow("").allow(null),
2326
- business_type: Joi.string().allow("").allow(null),
2327
- name: Joi.string().allow("").allow(null),
2328
- address: PaymentApplicationModel.KYCAddress(),
2329
- });
2330
- }
2331
-
2332
- /** @returns {DeviceDetails} */
2333
- static DeviceDetails() {
2334
- return Joi.object({
2335
- identification_number: Joi.string().allow("").allow(null),
2336
- identifier_type: Joi.string().allow("").allow(null),
2337
- device_model: Joi.string().allow("").allow(null),
2338
- device_make: Joi.string().allow("").allow(null),
2339
- device_type: Joi.string().allow("").allow(null),
2340
- os: Joi.string().allow("").allow(null),
2341
- os_version: Joi.string().allow("").allow(null),
2342
- });
2343
- }
2344
-
2345
- /** @returns {CustomerOnboardingRequest} */
2346
- static CustomerOnboardingRequest() {
2347
- return Joi.object({
2348
- personal_info: PaymentApplicationModel.UserPersonalInfoInDetails(),
2349
- mcc: Joi.string().allow("").allow(null),
2350
- aggregator: Joi.string().allow("").required(),
2351
- marketplace_info: PaymentApplicationModel.MarketplaceInfo(),
2352
- source: Joi.string().allow("").required(),
2353
- business_info: PaymentApplicationModel.BusinessDetails(),
2354
- device: PaymentApplicationModel.DeviceDetails(),
2355
- });
2356
- }
2357
-
2358
- /** @returns {OnboardSummary} */
2359
- static OnboardSummary() {
2360
- return Joi.object({
2361
- redirect_url: Joi.string().allow(""),
2362
- session: Joi.any(),
2363
- status: Joi.boolean().required(),
2364
- status_remark: Joi.string().allow(""),
2365
- is_eligible_for_txn: Joi.boolean(),
2366
- merchant_customer_ref_id: Joi.string().allow(""),
2367
- activation_url: Joi.string().allow(""),
2368
- });
2369
- }
2370
-
2371
- /** @returns {CustomerOnboardingResponse} */
2372
- static CustomerOnboardingResponse() {
2373
- return Joi.object({
2374
- data: PaymentApplicationModel.OnboardSummary().required(),
2375
- success: Joi.boolean().required(),
2376
- });
2377
- }
2378
-
2379
- /** @returns {OutstandingOrderDetailsResponse} */
2380
- static OutstandingOrderDetailsResponse() {
2381
- return Joi.object({
2382
- status_code: Joi.number().required(),
2383
- data: Joi.array().items(Joi.any()).allow(null, ""),
2384
- success: Joi.boolean().required(),
2385
- message: Joi.string().allow("").allow(null),
2386
- });
2387
- }
2388
-
2389
- /** @returns {PaidOrderDetailsResponse} */
2390
- static PaidOrderDetailsResponse() {
2391
- return Joi.object({
2392
- status_code: Joi.number().required(),
2393
- data: Joi.array().items(Joi.any()).allow(null, ""),
2394
- success: Joi.boolean().required(),
2395
- message: Joi.string().allow("").allow(null),
2396
- });
2397
- }
2398
-
2399
- /** @returns {DeleteRefundAccountResponse} */
2400
- static DeleteRefundAccountResponse() {
2401
- return Joi.object({
2402
- success: Joi.boolean().required(),
2403
- message: Joi.string().allow("").allow(null).required(),
2404
- });
2405
- }
2406
-
2407
- /** @returns {RefundOptionsDetails} */
2408
- static RefundOptionsDetails() {
2409
- return Joi.object({
2410
- display_name: Joi.string().allow("").required(),
2411
- id: Joi.number().required(),
2412
- is_active: Joi.boolean().allow(null),
2413
- name: Joi.string().allow("").required(),
2414
- });
2415
- }
2416
-
2417
- /** @returns {RefundOptions} */
2418
- static RefundOptions() {
2419
- return Joi.object({
2420
- items: PaymentApplicationModel.RefundOptionsDetails().required(),
2421
- });
2422
- }
2423
-
2424
- /** @returns {OfflineRefundOptions} */
2425
- static OfflineRefundOptions() {
2426
- return Joi.object({
2427
- items: PaymentApplicationModel.RefundOptionsDetails().required(),
2428
- payment_modes: Joi.array().items(Joi.string().allow("")).required(),
2429
- });
2430
- }
2431
-
2432
- /** @returns {RefundOptionResponse} */
2433
- static RefundOptionResponse() {
2434
- return Joi.object({
2435
- offline_refund_options: PaymentApplicationModel.OfflineRefundOptions().required(),
2436
- success: Joi.boolean().required(),
2437
- refund_options: PaymentApplicationModel.RefundOptions().required(),
2438
- });
2439
- }
2440
-
2441
- /** @returns {SelectedRefundOptionResponse} */
2442
- static SelectedRefundOptionResponse() {
2443
- return Joi.object({
2444
- transfer_mode: Joi.any().required(),
2445
- shipment_id: Joi.string().allow("").allow(null).required(),
2446
- message: Joi.string().allow("").allow(null).required(),
2447
- success: Joi.boolean().required(),
2448
- });
2449
- }
2450
-
2451
- /** @returns {WalletBeneficiaryDetails} */
2452
- static WalletBeneficiaryDetails() {
2453
- return Joi.object({
2454
- beneficiary_id: Joi.string().allow("").required(),
2455
- modified_on: Joi.string().allow("").required(),
2456
- display_name: Joi.string().allow("").required(),
2457
- id: Joi.number().required(),
2458
- subtitle: Joi.string().allow("").required(),
2459
- transfer_mode: Joi.string().allow("").required(),
2460
- mobile: Joi.string().allow(""),
2461
- is_active: Joi.boolean().required(),
2462
- created_on: Joi.string().allow("").required(),
2463
- address: Joi.string().allow("").required(),
2464
- title: Joi.string().allow("").required(),
2465
- wallet_address: Joi.string().allow("").required(),
2466
- comment: Joi.string().allow(""),
2467
- wallet: Joi.string().allow(""),
2468
- email: Joi.string().allow("").required(),
2469
- delights_user_name: Joi.string().allow("").allow(null),
2470
- });
2471
- }
2472
-
2473
- /** @returns {UpiBeneficiaryDetails} */
2474
- static UpiBeneficiaryDetails() {
2475
- return Joi.object({
2476
- beneficiary_id: Joi.string().allow("").required(),
2477
- modified_on: Joi.string().allow("").required(),
2478
- display_name: Joi.string().allow("").required(),
2479
- id: Joi.number().required(),
2480
- subtitle: Joi.string().allow("").required(),
2481
- transfer_mode: Joi.string().allow("").required(),
2482
- vpa: Joi.string().allow(""),
2483
- mobile: Joi.string().allow(""),
2484
- vpa_address: Joi.string().allow("").required(),
2485
- created_on: Joi.string().allow("").required(),
2486
- address: Joi.string().allow("").required(),
2487
- title: Joi.string().allow("").required(),
2488
- comment: Joi.string().allow(""),
2489
- is_active: Joi.boolean().required(),
2490
- email: Joi.string().allow("").required(),
2491
- delights_user_name: Joi.string().allow("").allow(null),
2492
- });
2493
- }
2494
-
2495
- /** @returns {BeneficiaryRefundOptions} */
2496
- static BeneficiaryRefundOptions() {
2497
- return Joi.object({
2498
- bank: PaymentApplicationModel.OrderBeneficiaryDetails(),
2499
- wallet: PaymentApplicationModel.WalletBeneficiaryDetails(),
2500
- upi: PaymentApplicationModel.UpiBeneficiaryDetails(),
2501
- });
2502
- }
2503
-
2504
- /** @returns {OrderBeneficiaryResponseSchemaV2} */
2505
- static OrderBeneficiaryResponseSchemaV2() {
2506
- return Joi.object({
2507
- show_beneficiary_details: Joi.boolean().required(),
2508
- data: PaymentApplicationModel.BeneficiaryRefundOptions().required(),
2509
- limit: Joi.any().required(),
2510
- });
2511
- }
2512
-
2513
- /** @returns {ValidateValidateAddressRequest} */
2514
- static ValidateValidateAddressRequest() {
2515
- return Joi.object({
2516
- ifsc_code: Joi.string().allow("").allow(null),
2517
- upi_vpa: Joi.string().allow("").allow(null),
2518
- aggregator: Joi.string().allow("").allow(null),
2519
- });
2520
- }
2521
-
2522
- /** @returns {VPADetails} */
2523
- static VPADetails() {
2524
- return Joi.object({
2525
- is_valid: Joi.boolean().required(),
2526
- upi_vpa: Joi.string().allow("").required(),
2527
- status: Joi.string().allow("").required(),
2528
- customer_name: Joi.string().allow("").required(),
2529
- });
2530
- }
2531
-
2532
- /** @returns {ValidateValidateAddressResponse} */
2533
- static ValidateValidateAddressResponse() {
2534
- return Joi.object({
2535
- upi: PaymentApplicationModel.VPADetails(),
2536
- success: Joi.boolean().required(),
2537
- ifsc: Joi.any(),
2538
- });
2539
- }
2540
-
2541
- /** @returns {PaymentMethodsMetaOrder} */
2542
- static PaymentMethodsMetaOrder() {
2543
- return Joi.object({
2544
- merchant_code: Joi.string().allow("").required(),
2545
- payment_gateway: Joi.string().allow("").required(),
2546
- payment_identifier: Joi.string().allow("").required(),
2547
- });
2548
- }
2549
-
2550
- /** @returns {PaymentOrderMethods} */
2551
- static PaymentOrderMethods() {
2552
- return Joi.object({
2553
- amount: Joi.number().required(),
2554
- payment: Joi.string().allow(""),
2555
- mode: Joi.string().allow("").required(),
2556
- meta: PaymentApplicationModel.PaymentMethodsMetaOrder().required(),
2557
- name: Joi.string().allow("").required(),
2558
- });
2559
- }
2560
-
2561
- /** @returns {PaymentOrderRequest} */
2562
- static PaymentOrderRequest() {
2563
- return Joi.object({
2564
- payment_methods: Joi.array().items(
2565
- PaymentApplicationModel.PaymentOrderMethods()
2566
- ),
2567
- order_id: Joi.string().allow("").required(),
2568
- shipment_id: Joi.string().allow(""),
2569
- });
2570
- }
2571
-
2572
- /** @returns {PaymentOrderData} */
2573
- static PaymentOrderData() {
2574
- return Joi.object({
2575
- amount: Joi.number().allow(null),
2576
- aggregator: Joi.string().allow("").allow(null),
2577
- callback_url: Joi.string().allow("").allow(null),
2578
- order_id: Joi.string().allow("").allow(null),
2579
- customer_id: Joi.string().allow("").allow(null),
2580
- merchant_order_id: Joi.string().allow("").allow(null),
2581
- currency: Joi.string().allow("").allow(null),
2582
- email: Joi.string().allow("").allow(null),
2583
- contact: Joi.string().allow("").allow(null),
2584
- method: Joi.string().allow("").allow(null),
2585
- });
2586
- }
2587
-
2588
- /** @returns {PaymentOrderResponse} */
2589
- static PaymentOrderResponse() {
2590
- return Joi.object({
2591
- payment_confirm_url: Joi.string().allow("").allow(null),
2592
- callback_url: Joi.string().allow("").allow(null),
2593
- order_id: Joi.string().allow("").allow(null),
2594
- success: Joi.boolean(),
2595
- status_code: Joi.number().required(),
2596
- data: PaymentApplicationModel.PaymentOrderData(),
2597
- message: Joi.string().allow("").required(),
2598
- });
2599
- }
2600
-
2601
- /** @returns {ShipmentRefundRequest} */
2602
- static ShipmentRefundRequest() {
2603
- return Joi.object({
2604
- shipment_id: Joi.string().allow("").required(),
2605
- order_id: Joi.string().allow("").required(),
2606
- transfer_mode: Joi.string().allow("").required(),
2607
- beneficiary_id: Joi.string().allow("").allow(null),
2608
- });
2609
- }
2610
-
2611
- /** @returns {ShipmentRefundDetail} */
2612
- static ShipmentRefundDetail() {
2613
- return Joi.object({
2614
- shipment_id: Joi.string().allow("").required(),
2615
- order_id: Joi.string().allow("").required(),
2616
- transfer_mode: Joi.string().allow("").required(),
2617
- beneficiary_id: Joi.string().allow("").required(),
2618
- });
2619
- }
2620
-
2621
- /** @returns {ShipmentRefundResponse} */
2622
- static ShipmentRefundResponse() {
2623
- return Joi.object({
2624
- data: PaymentApplicationModel.ShipmentRefundDetail().required(),
2625
- success: Joi.boolean().required(),
2626
- message: Joi.string().allow("").allow(null).required(),
2627
- });
2628
- }
2629
- }
2630
- module.exports = PaymentApplicationModel;