@gofynd/fdk-client-javascript 1.4.14 → 1.4.15-beta.10

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