@gofynd/fdk-client-javascript 1.4.15-beta.1 → 1.4.15-beta.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (314) hide show
  1. package/README.md +2 -2
  2. package/application.d.ts +1 -2
  3. package/application.js +2 -3
  4. package/index.d.ts +1 -2
  5. package/index.js +7 -1
  6. package/package.json +2 -3
  7. package/sdk/application/ApplicationClient.d.ts +2 -0
  8. package/sdk/application/ApplicationClient.js +2 -18
  9. package/sdk/application/Cart/CartApplicationClient.d.ts +75 -90
  10. package/sdk/application/Cart/CartApplicationClient.js +111 -1200
  11. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +81 -142
  12. package/sdk/application/Catalog/CatalogApplicationClient.js +41 -1344
  13. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -8
  14. package/sdk/application/Common/CommonApplicationClient.js +2 -92
  15. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -19
  16. package/sdk/application/Communication/CommunicationApplicationClient.js +3 -148
  17. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -73
  18. package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -727
  19. package/sdk/application/Content/ContentApplicationClient.d.ts +52 -95
  20. package/sdk/application/Content/ContentApplicationClient.js +46 -990
  21. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -13
  22. package/sdk/application/FileStorage/FileStorageApplicationClient.js +8 -138
  23. package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
  24. package/sdk/application/Finance/FinanceApplicationClient.js +105 -0
  25. package/sdk/application/Lead/LeadApplicationClient.d.ts +10 -18
  26. package/sdk/application/Lead/LeadApplicationClient.js +5 -217
  27. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +42 -39
  28. package/sdk/application/Logistic/LogisticApplicationClient.js +89 -493
  29. package/sdk/application/Order/OrderApplicationClient.d.ts +36 -46
  30. package/sdk/application/Order/OrderApplicationClient.js +52 -507
  31. package/sdk/application/Payment/PaymentApplicationClient.d.ts +93 -213
  32. package/sdk/application/Payment/PaymentApplicationClient.js +49 -2109
  33. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +15 -29
  34. package/sdk/application/Rewards/RewardsApplicationClient.js +8 -312
  35. package/sdk/application/Share/ShareApplicationClient.d.ts +14 -24
  36. package/sdk/application/Share/ShareApplicationClient.js +7 -309
  37. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -14
  38. package/sdk/application/Theme/ThemeApplicationClient.js +8 -176
  39. package/sdk/application/User/UserApplicationClient.d.ts +87 -138
  40. package/sdk/application/User/UserApplicationClient.js +44 -1820
  41. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -7
  42. package/sdk/application/Webhook/WebhookApplicationClient.js +3 -52
  43. package/sdk/application/index.d.ts +0 -18
  44. package/sdk/application/index.js +0 -33
  45. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +86 -12
  46. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
  47. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -19
  48. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -14
  49. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
  50. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
  51. package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
  52. package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
  53. package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
  54. package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
  55. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +126 -20
  56. package/sdk/partner/Logistics/LogisticsPartnerClient.js +970 -20
  57. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1200 -167
  58. package/sdk/partner/Logistics/LogisticsPartnerModel.js +571 -160
  59. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +10 -0
  60. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +121 -7
  61. package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
  62. package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
  63. package/sdk/partner/Theme/ThemePartnerModel.d.ts +96 -37
  64. package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
  65. package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
  66. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
  67. package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
  68. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
  69. package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
  70. package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
  71. package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
  72. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
  73. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
  74. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
  75. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
  76. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
  77. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
  78. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
  79. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
  80. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
  81. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
  82. package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
  83. package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
  84. package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
  85. package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
  86. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
  87. package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
  88. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +134 -103
  89. package/sdk/platform/Cart/CartPlatformApplicationClient.js +419 -115
  90. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +118 -65
  91. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +109 -44
  92. package/sdk/platform/Cart/CartPlatformModel.d.ts +5067 -1300
  93. package/sdk/platform/Cart/CartPlatformModel.js +1988 -1217
  94. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +209 -183
  95. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +452 -395
  96. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +185 -142
  97. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +96 -78
  98. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +154 -117
  99. package/sdk/platform/Catalog/CatalogPlatformClient.js +292 -172
  100. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6506 -1775
  101. package/sdk/platform/Catalog/CatalogPlatformModel.js +3224 -1690
  102. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +72 -31
  103. package/sdk/platform/Catalog/CatalogPlatformValidator.js +50 -24
  104. package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
  105. package/sdk/platform/Common/CommonPlatformClient.js +3 -2
  106. package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
  107. package/sdk/platform/Common/CommonPlatformModel.js +6 -6
  108. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
  109. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
  110. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
  111. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
  112. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
  113. package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
  114. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
  115. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
  116. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
  117. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
  118. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
  119. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
  120. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
  121. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
  122. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
  123. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
  124. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
  125. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
  126. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
  127. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
  128. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
  129. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
  130. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +124 -141
  131. package/sdk/platform/Content/ContentPlatformApplicationClient.js +449 -422
  132. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +179 -141
  133. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +168 -130
  134. package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
  135. package/sdk/platform/Content/ContentPlatformClient.js +523 -336
  136. package/sdk/platform/Content/ContentPlatformModel.d.ts +1241 -395
  137. package/sdk/platform/Content/ContentPlatformModel.js +521 -390
  138. package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
  139. package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
  140. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
  141. package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
  142. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
  143. package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
  144. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
  145. package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
  146. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +94 -36
  147. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -60
  148. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
  149. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
  150. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
  151. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
  152. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -101
  153. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -84
  154. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  155. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  156. package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
  157. package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
  158. package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
  159. package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
  160. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +17 -6
  161. package/sdk/platform/Order/OrderPlatformApplicationClient.js +85 -7
  162. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +95 -24
  163. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +39 -19
  164. package/sdk/platform/Order/OrderPlatformClient.d.ts +153 -96
  165. package/sdk/platform/Order/OrderPlatformClient.js +416 -198
  166. package/sdk/platform/Order/OrderPlatformModel.d.ts +7602 -1269
  167. package/sdk/platform/Order/OrderPlatformModel.js +3926 -1269
  168. package/sdk/platform/Order/OrderPlatformValidator.d.ts +270 -109
  169. package/sdk/platform/Order/OrderPlatformValidator.js +135 -77
  170. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
  171. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
  172. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
  173. package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
  174. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
  175. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
  176. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
  177. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
  178. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
  179. package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
  180. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +333 -319
  181. package/sdk/platform/Payment/PaymentPlatformModel.js +288 -278
  182. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
  183. package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
  184. package/sdk/platform/PlatformClient.d.ts +0 -2
  185. package/sdk/platform/PlatformClient.js +0 -4
  186. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
  187. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
  188. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
  189. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
  190. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
  191. package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
  192. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +46 -36
  193. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +132 -41
  194. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +46 -17
  195. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +34 -14
  196. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +40 -46
  197. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +58 -64
  198. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1893 -623
  199. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +924 -568
  200. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +42 -46
  201. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +26 -28
  202. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
  203. package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
  204. package/sdk/platform/Share/SharePlatformModel.d.ts +36 -5
  205. package/sdk/platform/Share/SharePlatformModel.js +27 -4
  206. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
  207. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
  208. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
  209. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
  210. package/sdk/platform/Theme/ThemePlatformModel.d.ts +37 -11
  211. package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
  212. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
  213. package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
  214. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
  215. package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
  216. package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
  217. package/sdk/platform/User/UserPlatformModel.js +23 -23
  218. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
  219. package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
  220. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
  221. package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
  222. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
  223. package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
  224. package/sdk/platform/index.d.ts +0 -1
  225. package/sdk/platform/index.js +0 -2
  226. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
  227. package/sdk/public/Configuration/ConfigurationPublicClient.js +10 -7
  228. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
  229. package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
  230. package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
  231. package/sdk/public/Content/ContentPublicClient.js +795 -7
  232. package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
  233. package/sdk/public/Content/ContentPublicModel.js +649 -3
  234. package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
  235. package/sdk/public/Content/ContentPublicValidator.js +88 -2
  236. package/sdk/public/Partner/PartnerPublicClient.js +4 -2
  237. package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
  238. package/sdk/public/Webhook/WebhookPublicClient.js +12 -10
  239. package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
  240. package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
  241. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  242. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  243. package/sdk/application/Cart/CartApplicationModel.d.ts +0 -3994
  244. package/sdk/application/Cart/CartApplicationModel.js +0 -2497
  245. package/sdk/application/Cart/CartApplicationValidator.d.ts +0 -769
  246. package/sdk/application/Cart/CartApplicationValidator.js +0 -530
  247. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +0 -3857
  248. package/sdk/application/Catalog/CatalogApplicationModel.js +0 -2629
  249. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +0 -791
  250. package/sdk/application/Catalog/CatalogApplicationValidator.js +0 -551
  251. package/sdk/application/Common/CommonApplicationModel.d.ts +0 -449
  252. package/sdk/application/Common/CommonApplicationModel.js +0 -308
  253. package/sdk/application/Common/CommonApplicationValidator.d.ts +0 -46
  254. package/sdk/application/Common/CommonApplicationValidator.js +0 -38
  255. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +0 -293
  256. package/sdk/application/Communication/CommunicationApplicationModel.js +0 -201
  257. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +0 -29
  258. package/sdk/application/Communication/CommunicationApplicationValidator.js +0 -38
  259. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +0 -2556
  260. package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -1887
  261. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +0 -179
  262. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +0 -176
  263. package/sdk/application/Content/ContentApplicationModel.d.ts +0 -2133
  264. package/sdk/application/Content/ContentApplicationModel.js +0 -1589
  265. package/sdk/application/Content/ContentApplicationValidator.d.ts +0 -284
  266. package/sdk/application/Content/ContentApplicationValidator.js +0 -264
  267. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +0 -272
  268. package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -190
  269. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +0 -56
  270. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +0 -53
  271. package/sdk/application/Lead/LeadApplicationModel.d.ts +0 -590
  272. package/sdk/application/Lead/LeadApplicationModel.js +0 -480
  273. package/sdk/application/Lead/LeadApplicationValidator.d.ts +0 -68
  274. package/sdk/application/Lead/LeadApplicationValidator.js +0 -71
  275. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +0 -1675
  276. package/sdk/application/Logistic/LogisticApplicationModel.js +0 -1121
  277. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +0 -254
  278. package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -190
  279. package/sdk/application/Order/OrderApplicationModel.d.ts +0 -2296
  280. package/sdk/application/Order/OrderApplicationModel.js +0 -1471
  281. package/sdk/application/Order/OrderApplicationValidator.d.ts +0 -265
  282. package/sdk/application/Order/OrderApplicationValidator.js +0 -197
  283. package/sdk/application/Payment/PaymentApplicationModel.d.ts +0 -4058
  284. package/sdk/application/Payment/PaymentApplicationModel.js +0 -2630
  285. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +0 -576
  286. package/sdk/application/Payment/PaymentApplicationValidator.js +0 -594
  287. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +0 -365
  288. package/sdk/application/Rewards/RewardsApplicationModel.js +0 -396
  289. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +0 -73
  290. package/sdk/application/Rewards/RewardsApplicationValidator.js +0 -84
  291. package/sdk/application/Share/ShareApplicationModel.d.ts +0 -339
  292. package/sdk/application/Share/ShareApplicationModel.js +0 -234
  293. package/sdk/application/Share/ShareApplicationValidator.d.ts +0 -90
  294. package/sdk/application/Share/ShareApplicationValidator.js +0 -91
  295. package/sdk/application/Theme/ThemeApplicationModel.d.ts +0 -1713
  296. package/sdk/application/Theme/ThemeApplicationModel.js +0 -1426
  297. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +0 -66
  298. package/sdk/application/Theme/ThemeApplicationValidator.js +0 -58
  299. package/sdk/application/User/UserApplicationModel.d.ts +0 -1943
  300. package/sdk/application/User/UserApplicationModel.js +0 -1382
  301. package/sdk/application/User/UserApplicationValidator.d.ts +0 -560
  302. package/sdk/application/User/UserApplicationValidator.js +0 -573
  303. package/sdk/application/Webhook/WebhookApplicationModel.d.ts +0 -52
  304. package/sdk/application/Webhook/WebhookApplicationModel.js +0 -46
  305. package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +0 -16
  306. package/sdk/application/Webhook/WebhookApplicationValidator.js +0 -19
  307. package/sdk/common/Clickstream.d.ts +0 -1
  308. package/sdk/common/Clickstream.js +0 -464
  309. package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
  310. package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
  311. package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
  312. package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
  313. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
  314. package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
@@ -1,1943 +0,0 @@
1
- export = UserApplicationModel;
2
- /**
3
- * @typedef UpdateUserAttributesRequest
4
- * @property {Object} [attributes] - Describes the request structure to update
5
- * the user attribute.
6
- */
7
- /**
8
- * @typedef UserAttributes
9
- * @property {Object} [attributes] - Describes the structure of user attribute.
10
- */
11
- /**
12
- * @typedef DeleteApplicationUserRequestSchema
13
- * @property {string} [user_id] - User id for the application user.
14
- * @property {string} [reason] - Reason to delete the application user.
15
- * @property {string} [reason_id] - Reason id of request to delete the application user .
16
- * @property {string} [request_id] - ID of request to delete the application user .
17
- * @property {string} [otp] - OTP to verify the delete application user request.
18
- */
19
- /**
20
- * @typedef EditEmailRequestSchema
21
- * @property {string} [email] - Email of the user.
22
- */
23
- /**
24
- * @typedef SendVerificationLinkMobileRequestSchema
25
- * @property {boolean} [verified] - Boolean to specify if the phone number is
26
- * verified or not.
27
- * @property {boolean} [active] - Boolean to specify if the phone number is active or not.
28
- * @property {string} [country_code] - Country code for the phone number.
29
- * @property {string} [phone] - Phone number.
30
- * @property {boolean} [primary] - Boolean to specify if the phone number is
31
- * primary or not.
32
- */
33
- /**
34
- * @typedef EditMobileRequestSchema
35
- * @property {string} [country_code] - Country code for the phone number.
36
- * @property {string} [phone] - Phone number of user.
37
- */
38
- /**
39
- * @typedef EditProfileRequestSchema
40
- * @property {boolean} [encrypt_otp] - Set to true if you want to encrypt the OTP.
41
- * @property {string} [first_name] - First name of the application user.
42
- * @property {string} [last_name] - Last name of the application user.
43
- * @property {EditProfileMobileSchema} [mobile]
44
- * @property {string} [country_code] - Country code for the phone number.
45
- * @property {string} [email] - Email id of user.
46
- * @property {string} [gender] - Gender of user.
47
- * @property {string} [dob] - Date of birth of user.
48
- * @property {string} [profile_pic_url] - Profile picture of user.
49
- * @property {string} [android_hash] - Unique hash value.
50
- * @property {string} [sender] - Identity of the sender.
51
- * @property {string} [register_token] - Unique temporary registration of the user.
52
- */
53
- /**
54
- * @typedef EditProfileMobileSchema
55
- * @property {string} [phone] - Phone number of user.
56
- * @property {string} [country_code] - Country code for the phone number.
57
- */
58
- /**
59
- * @typedef SendEmailOtpRequestSchema
60
- * @property {string} [email] - Email of a user to send email OTP.
61
- * @property {string} [action] - Action to specify if to send or resent the OTP.
62
- * @property {string} [token] - Token to validate the request.
63
- * @property {string} [register_token] - Unique temporary registration of the user.
64
- */
65
- /**
66
- * @typedef SendEmailForgotOtpRequestSchema
67
- * @property {string} [email] - Email of a user to send email OTP.
68
- * @property {string} [action] - Action to specify if to send or resent the OTP.
69
- * @property {string} [token] - Token to validate the request.
70
- */
71
- /**
72
- * @typedef VerifyEmailOtpRequestSchema
73
- * @property {string} [email] - Email of a user to verify OTP.
74
- * @property {string} [action] - Action to verify the send or resent OTP.
75
- * @property {string} [register_token] - Unique temporary registration of the user.
76
- * @property {string} [otp] - OTP for verification.
77
- */
78
- /**
79
- * @typedef VerifyEmailForgotOtpRequestSchema
80
- * @property {string} [email] - Email id of user.
81
- * @property {string} [otp] - OTP for verification.
82
- */
83
- /**
84
- * @typedef VerifyOtpRequestSchema
85
- * @property {string} [request_id] - Unique request id for the OTP sent to mobile number.
86
- * @property {string} [register_token] - Unique temporary registration of the user.
87
- * @property {string} [otp] - OTP for verification.
88
- */
89
- /**
90
- * @typedef VerifyMobileForgotOtpRequestSchema
91
- * @property {string} [request_id] - Unique request id for the OTP.
92
- * @property {string} [otp] - OTP for verification.
93
- */
94
- /**
95
- * @typedef SendMobileOtpRequestSchema
96
- * @property {boolean} [encrypt_otp] - Set to true if you want to encrypt the OTP.
97
- * @property {string} [mobile] - Mobile number of user.
98
- * @property {string} [country_code] - Country code for the phone number.
99
- * @property {string} [action] - Action to specify if to send or resent the OTP.
100
- * @property {string} [token] - Token to validate the request.
101
- * @property {string} [android_hash] - Unique hash value.
102
- * @property {string} [force] - Force verify the OTP.
103
- */
104
- /**
105
- * @typedef SendMobileForgotOtpRequestSchema
106
- * @property {string} [mobile] - Phone number of user.
107
- * @property {string} [country_code] - Country code for the phone number.
108
- * @property {string} [action] - Action to specify if to send or resent the OTP.
109
- * @property {string} [token] - Token to validate the request.
110
- * @property {string} [android_hash] - Unique hash value.
111
- */
112
- /**
113
- * @typedef UpdatePasswordRequestSchema
114
- * @property {string} [old_password] - Old password.
115
- * @property {string} [new_password] - New password.
116
- */
117
- /**
118
- * @typedef FormRegisterRequestSchema
119
- * @property {string} [first_name] - First name of the application user.
120
- * @property {string} [last_name] - Last name of the application user.
121
- * @property {string} [gender] - Gender of user.
122
- * @property {string} [email] - Email of user.
123
- * @property {string} [password] - Password of user.
124
- * @property {FormRegisterRequestSchemaPhone} [phone]
125
- * @property {string} [register_token] - Unique registration token of user.
126
- */
127
- /**
128
- * @typedef TokenRequestBodySchema
129
- * @property {string} [token] - Unique token.
130
- */
131
- /**
132
- * @typedef ForgotPasswordRequestSchema
133
- * @property {string} [code] - Unique code to verify request.
134
- * @property {string} [password] - Password of user.
135
- */
136
- /**
137
- * @typedef CodeRequestBodySchema
138
- * @property {string} [code] - Unique code to verify request.
139
- */
140
- /**
141
- * @typedef SendResetPasswordEmailRequestSchema
142
- * @property {string} [email] - Email id of user.
143
- */
144
- /**
145
- * @typedef SendResetPasswordMobileRequestSchema
146
- * @property {string} [country_code] - Country code for the phone number.
147
- * @property {string} [mobile] - Phone number of user.
148
- */
149
- /**
150
- * @typedef PasswordLoginRequestSchema
151
- * @property {string} [password] - Password of user.
152
- * @property {string} [username] - Username of user.
153
- */
154
- /**
155
- * @typedef SendOtpRequestSchema
156
- * @property {boolean} [encrypt_otp] - Eet to true if you want to encrypt the OTP.
157
- * @property {string} [country_code] - Country code for the phone number.
158
- * @property {string} [mobile] - Phone number.
159
- * @property {string} [android_hash] - Unique hash value.
160
- */
161
- /**
162
- * @typedef OAuthRequestSchema
163
- * @property {boolean} [is_signed_in] - Boolean to specify if the user is signed in .
164
- * @property {OAuthRequestSchemaOauth2} [oauth2]
165
- * @property {OAuthRequestSchemaProfile} [profile]
166
- */
167
- /**
168
- * @typedef OAuthRequestAppleSchema
169
- * @property {string} [user_identifier] - Unique user identifier.
170
- * @property {OAuthRequestAppleSchemaOauth} [oauth]
171
- * @property {OAuthRequestAppleSchemaProfile} [profile]
172
- */
173
- /**
174
- * @typedef UserObjectSchema
175
- * @property {UserSchema} [user]
176
- */
177
- /**
178
- * @typedef AuthSuccess
179
- * @property {string} [register_token] - Unique registration token for user.
180
- * @property {boolean} [user_exists] - Boolean which specifies if user is registered.
181
- * @property {UserSchema} [user]
182
- */
183
- /**
184
- * @typedef UserExistsResponse
185
- * @property {boolean} [user_exists] - Boolean which specifies if user is
186
- * registered or not.
187
- */
188
- /**
189
- * @typedef SendOtpResponse
190
- * @property {number} [resend_timer] - Time after which opt can be resent.
191
- * @property {string} [resend_token] - Unique token to identify the OTP send
192
- * request and resend the token.
193
- * @property {boolean} [success] - Specify if the OTP is successfully sent.
194
- * @property {string} [request_id] - Unique request id for the OTP.
195
- * @property {string} [message] - Message to specify the OTP send status. Eg.
196
- * OTP sent, failed to send OTP etc.
197
- * @property {string} [mobile] - Phone number of user.
198
- * @property {string} [country_code] - Country code for the phone number.
199
- * @property {string} [email] - Email id of user.
200
- * @property {string} [resend_email_token] - Unique token to identify the OTP
201
- * send request and resend the token on email.
202
- * @property {string} [register_token] - Unique registration token for user.
203
- * @property {boolean} [verify_email_otp] - If email OTP verification is
204
- * mandatory for registration.
205
- * @property {boolean} [verify_mobile_otp] - If mobile OTP verification is
206
- * mandatory for registration.
207
- * @property {boolean} [user_exists] - If user is registered or not.
208
- */
209
- /**
210
- * @typedef ProfileEditSuccess
211
- * @property {UserSchema} [user]
212
- * @property {string} [register_token] - Unique registration token for user.
213
- * @property {string} [resend_email_token] - Unique token to identify the
214
- * request for OTP verification in case of unverified email.
215
- * @property {boolean} [user_exists] - If user is registered or not.
216
- * @property {boolean} [verify_email_link] - Whether to send a link to verify
217
- * the registered email id of the user.
218
- * @property {boolean} [verify_email_otp] - Whether to send a OTP to verify the
219
- * registered email id of the user.
220
- * @property {boolean} [verify_mobile_otp] - Whether to send a OTP to verify the
221
- * registered phone of the user.
222
- * @property {string} [email] - Email id of user.
223
- * @property {string} [request_id] - A random uuid string used to track the request.
224
- * @property {string} [country_code] - The country specific prefix for the phone number.
225
- * @property {string} [mobile] - The user's mobile number without the country code.
226
- * @property {boolean} [success] - Whether the operation was successful.
227
- * @property {string} [message] - Information about the operation's result.
228
- * @property {number} [resend_timer] - Time in seconds before an request can be resent.
229
- * @property {string} [resend_token] - A token used to authorize the resending of request.
230
- */
231
- /**
232
- * @typedef LoginSuccess
233
- * @property {UserSchema} [user]
234
- * @property {string} [request_id] - A random uuid string used to track the send
235
- * OTP response.
236
- * @property {string} [register_token] - A token used for registration purposes.
237
- */
238
- /**
239
- * @typedef ResetForgotPasswordSuccess
240
- * @property {boolean} [success] - Whether the password reset operation was successful.
241
- */
242
- /**
243
- * @typedef VerifyOtpSuccess
244
- * @property {UserSchema} [user]
245
- * @property {boolean} [user_exists] - Whether the user already exists.
246
- * @property {string} [register_token] - A token used for registration purposes.
247
- */
248
- /**
249
- * @typedef VerifyForgotOtpSuccess
250
- * @property {boolean} [success] - Whether the OTP verification was successful.
251
- * @property {string} [forgot_token] - A token used for resetting the forgotten password.
252
- */
253
- /**
254
- * @typedef ResetPasswordSuccess
255
- * @property {string} [status] - Status of the password reset operation.
256
- */
257
- /**
258
- * @typedef RegisterFormSuccess
259
- * @property {string} [email] - The email address provided during registration.
260
- * @property {number} [resend_timer] - The time in seconds before an OTP can be resent.
261
- * @property {string} [resend_token] - A token used to authorize the resending of an OTP.
262
- * @property {string} [resend_email_token] - A token used to authorize the
263
- * resending of an OTP via email.
264
- * @property {string} [register_token] - A token used for completing the
265
- * registration process.
266
- * @property {boolean} [success] - A boolean value indicating whether the
267
- * registration operation was successful.
268
- * @property {string} [request_id] - A random uuid string used to track the
269
- * registration response.
270
- * @property {string} [message] - A string containing additional information
271
- * about the operation's result.
272
- * @property {string} [mobile] - The user's phone mobile without the country code.
273
- * @property {string} [country_code] - The country specific prefix for the phone number.
274
- * @property {boolean} [verify_email_otp] - Whether email OTP verification is required.
275
- * @property {boolean} [verify_mobile_otp] - Whether mobile OTP verification is required.
276
- * @property {boolean} [user_exists] - Whether the user already exists.
277
- */
278
- /**
279
- * @typedef VerifyEmailSuccess
280
- * @property {string} [message] - Result of the email verification process.
281
- */
282
- /**
283
- * @typedef HasPasswordSuccess
284
- * @property {number} [result] - An integer value indicating whether the user
285
- * has set a password (1 for true, 0 for false).
286
- */
287
- /**
288
- * @typedef LogoutSuccess
289
- * @property {boolean} [logout] - Whether the logout operation was successful.
290
- */
291
- /**
292
- * @typedef DeleteUserSuccess
293
- * @property {boolean} [success] - Whether the user deletion operation was successful.
294
- */
295
- /**
296
- * @typedef OtpSuccess
297
- * @property {number} [resend_timer] - The time in seconds before an OTP can be resent.
298
- * @property {string} [resend_token] - A token used to authorize the resending of an OTP.
299
- * @property {string} [register_token] - A token used for completing the
300
- * registration process.
301
- * @property {boolean} [success] - Whether the OTP send operation was successful.
302
- * @property {string} [request_id] - A random uuid string used to track the OTP
303
- * send response.
304
- * @property {string} [message] - Additional information about the operation's result.
305
- * @property {string} [mobile] - The user's mobile number without the country code.
306
- * @property {string} [country_code] - The country specific prefix for the phone number.
307
- */
308
- /**
309
- * @typedef EmailOtpSuccess
310
- * @property {boolean} [success] - Whether the OTP send operation was successful.
311
- * @property {string} [resend_email_token] - A token used to authorize the
312
- * resending of an OTP via email.
313
- */
314
- /**
315
- * @typedef SessionListSuccess
316
- * @property {string[]} [sessions] - An array of active session identifiers.
317
- */
318
- /**
319
- * @typedef VerifyMobileOTPSuccess
320
- * @property {UserSchema} [user]
321
- * @property {boolean} [verify_mobile_link] - Whether the mobile number
322
- * verification link was successful.
323
- */
324
- /**
325
- * @typedef VerifyEmailOTPSuccess
326
- * @property {UserSchema} [user]
327
- * @property {boolean} [verify_email_link] - Whether the email verification link
328
- * was successful.
329
- */
330
- /**
331
- * @typedef SendMobileVerifyLinkSuccess
332
- * @property {boolean} [verify_mobile_link] - Whether the mobile verification
333
- * link was successfully sent.
334
- */
335
- /**
336
- * @typedef SendEmailVerifyLinkSuccess
337
- * @property {boolean} [verify_email_link] - Whether the email verification link
338
- * was successfully sent.
339
- */
340
- /**
341
- * @typedef APIError
342
- * @property {string} [code] - The error code representing the type of error.
343
- * @property {string} [message] - A descriptive message providing more details
344
- * about the error.
345
- * @property {string} [info] - A link to the error code description.
346
- * @property {string} [request_id] - A random uuid string used to track the api request.
347
- * @property {string} [error] - The error message or stack trace.
348
- * @property {Object} [meta] - Additional metadata associated with the error.
349
- * @property {boolean} [authenticated] - Whether the user is authenticated.
350
- */
351
- /**
352
- * @typedef FormRegisterRequestSchemaPhone
353
- * @property {string} [country_code] - Country code for mobile number.
354
- * @property {string} [mobile] - The user's mobile number without the country code.
355
- */
356
- /**
357
- * @typedef OAuthRequestSchemaOauth2
358
- * @property {string} [access_token] - The access token issued by the oauth2 provider.
359
- * @property {number} [expiry] - The expiry time of the access token in
360
- * milliseconds since epoch.
361
- * @property {string} [refresh_token] - The refresh token issued by the oauth2 provider.
362
- */
363
- /**
364
- * @typedef OAuthRequestSchemaProfile
365
- * @property {string} [last_name] - The last name of the user.
366
- * @property {string} [image] - The url of the user's profile picture.
367
- * @property {string} [id] - The unique identifier of the user.
368
- * @property {string} [email] - The email address of the user.
369
- * @property {string} [full_name] - The full name of the user.
370
- * @property {string} [first_name] - The first name of the user.
371
- */
372
- /**
373
- * @typedef OAuthRequestAppleSchemaOauth
374
- * @property {string} [identity_token] - The identity token issued by apple.
375
- */
376
- /**
377
- * @typedef OAuthRequestAppleSchemaProfile
378
- * @property {string} [last_name] - The last name of the user.
379
- * @property {string} [full_name] - The full name of the user.
380
- * @property {string} [first_name] - The first name of the user.
381
- */
382
- /**
383
- * @typedef PlatformSchema
384
- * @property {string} [display] - The display name of the platform.
385
- * @property {LookAndFeel} [look_and_feel]
386
- * @property {string} [updated_at] - The date and time when the configuration
387
- * was last updated.
388
- * @property {boolean} [active] - Is the application config active or not .
389
- * @property {boolean} [forgot_password] - Forgot password option to be given or
390
- * not to application user.
391
- * @property {Login} [login]
392
- * @property {boolean} [skip_captcha] - Skip the captcha or not .
393
- * @property {string} [name] - Name of the application.
394
- * @property {MetaSchema} [meta]
395
- * @property {string} [_id] - Unique document id of the platform config.
396
- * @property {Social} [social]
397
- * @property {RequiredFields} [required_fields]
398
- * @property {RegisterRequiredFields} [register_required_fields]
399
- * @property {boolean} [skip_login] - Whether to skip the login or not .
400
- * @property {FlashCard} [flash_card]
401
- * @property {string} [subtext] - Text to be shown at the top of the flash card
402
- * like login to fynd, login to tira.
403
- * @property {SocialTokens} [social_tokens]
404
- * @property {string} [created_at] - When was the application platform config
405
- * document was created.
406
- * @property {boolean} [register] - Whether to show the registration page on
407
- * landing page or not.
408
- * @property {string} [mobile_image] - Image to be shown on registration page
409
- * for mobile devices.
410
- * @property {string} [desktop_image] - Image to be shown on registration page
411
- * for desktop devices.
412
- * @property {number} [delete_account_day] - Number of days after which the user
413
- * account will be deleted.
414
- * @property {DeleteAccountReasons[]} [delete_account_reasons] - List of reasons
415
- * you can set to ask user when account is being deleted from application.
416
- * @property {DeleteAccountConsent} [delete_account_consent]
417
- * @property {SessionExpiry} [session_config]
418
- * @property {number} [__v] - Version of the document.
419
- */
420
- /**
421
- * @typedef LookAndFeel
422
- * @property {string} [card_position] - Position of the card eg right, left,
423
- * top-right etc.
424
- * @property {string} [background_color] - Background colour of the card.
425
- */
426
- /**
427
- * @typedef Login
428
- * @property {boolean} [password] - Application is providing login with password or not.
429
- * @property {boolean} [otp] - Application is providing login with OTP or not.
430
- */
431
- /**
432
- * @typedef MetaSchema
433
- * @property {boolean} [fynd_default] - One of the custom field that you are
434
- * storing in meta.
435
- */
436
- /**
437
- * @typedef Social
438
- * @property {boolean} [account_kit] - Is accountkit social login active for
439
- * application or not.
440
- * @property {boolean} [facebook] - Is facebook social login active for
441
- * application or not .
442
- * @property {boolean} [google] - Is google social login active for application or not .
443
- * @property {boolean} [apple] - Is apple social login active for application or not.
444
- */
445
- /**
446
- * @typedef RequiredFields
447
- * @property {PlatformEmail} [email]
448
- * @property {PlatformMobile} [mobile]
449
- */
450
- /**
451
- * @typedef PlatformEmail
452
- * @property {boolean} [is_required] - Is email mandatory for user to register
453
- * on a application or not.
454
- * @property {string} [level] - Level of email mandatory hard is mandatory and
455
- * soft is optional.
456
- */
457
- /**
458
- * @typedef PlatformMobile
459
- * @property {boolean} [is_required] - Is mobile mandatory for user to register
460
- * on a application or not.
461
- * @property {string} [level] - Level of mobile mandatory hard is mandatory and
462
- * soft is optional.
463
- */
464
- /**
465
- * @typedef RegisterRequiredFields
466
- * @property {RegisterRequiredFieldsEmail} [email]
467
- * @property {RegisterRequiredFieldsMobile} [mobile]
468
- */
469
- /**
470
- * @typedef RegisterRequiredFieldsEmail
471
- * @property {boolean} [is_required] - Is email mandatory for user to register
472
- * on a application or not.
473
- * @property {string} [level] - Level of email mandatory hard is mandatory and
474
- * soft is optional.
475
- */
476
- /**
477
- * @typedef RegisterRequiredFieldsMobile
478
- * @property {boolean} [is_required] - Is mobile mandatory for user to register
479
- * on a application or not.
480
- * @property {string} [level] - Level of mobile mandatory hard is mandatory and
481
- * soft is optional.
482
- */
483
- /**
484
- * @typedef FlashCard
485
- * @property {string} [text] - Text to be shown in the flash card.
486
- * @property {string} [text_color] - Text colour for the text in the flash card.
487
- * @property {string} [background_color] - Background colour of the text to be
488
- * shown on the flash card.
489
- */
490
- /**
491
- * @typedef SocialTokens
492
- * @property {Facebook} [facebook]
493
- * @property {Accountkit} [accountkit]
494
- * @property {Google} [google]
495
- */
496
- /**
497
- * @typedef DeleteAccountReasons
498
- * @property {string} [reason_text] - Text of the reason to be shown to user.
499
- * @property {string} [reason_id] - Unique id of the reason .
500
- * @property {boolean} [show_text_area] - A boolean whether to show text area or not.
501
- */
502
- /**
503
- * @typedef DeleteAccountConsent
504
- * @property {string} [consent_text] - Consent text to be shown to user.
505
- */
506
- /**
507
- * @typedef Facebook
508
- * @property {string} [app_id] - App id of the credentials facebook.
509
- */
510
- /**
511
- * @typedef Accountkit
512
- * @property {string} [app_id] - App id of the credentials account kit.
513
- */
514
- /**
515
- * @typedef Google
516
- * @property {string} [app_id] - App id of the credentials google.
517
- */
518
- /**
519
- * @typedef SessionExpiry
520
- * @property {number} [duration] - Number of days or hours based on type till
521
- * which the session can be rolled back.
522
- * @property {string} [type] - Days or hours the type of time for session rollback.
523
- * @property {boolean} [is_rolling] - Whether session needs to be rollback or not.
524
- */
525
- /**
526
- * @typedef UserSchema
527
- * @property {string} [application_id] - Application id of the user.
528
- * @property {string} [user_id] - Unique id of the user.
529
- * @property {string} [first_name] - First name of the user.
530
- * @property {Object} [meta] - Metadata of the user, used to store details about the user
531
- * @property {string} [last_name] - Last name of the user
532
- * @property {PhoneNumber[]} [phone_numbers] - List of phone numbers of the user.
533
- * @property {Email[]} [emails] - List of email addresses of the user.
534
- * @property {string} [gender] - Gender of the user.
535
- * @property {string} [dob] - Date of birth of the user.
536
- * @property {boolean} [active] - Is the user active.
537
- * @property {string} [profile_pic_url] - URL of the profile picture of the user.
538
- * @property {string} [username] - Unique username of the user.
539
- * @property {string} [account_type] - Type of user (user, programmatic (created
540
- * by system))
541
- * @property {string} [_id] - Unique id of the user.
542
- * @property {string} [created_at] - Date and time of user creation.
543
- * @property {string} [updated_at] - Date and time of user update.
544
- * @property {string} [external_id] - Unique id referencing any user external
545
- * documents (jio).
546
- * @property {string} [rr_id] - Unique id referencing any user external documents.
547
- */
548
- /**
549
- * @typedef PhoneNumber
550
- * @property {string} [phone] - Phone number of the user.
551
- * @property {number} [country_code] - Country code for mobile number.
552
- * @property {boolean} [active] - Is the phone number active.
553
- * @property {boolean} [primary] - Is it a primary phone number.
554
- * @property {boolean} [verified] - Is the phone number verified.
555
- */
556
- /**
557
- * @typedef Email
558
- * @property {string} [email] - Email address.
559
- * @property {boolean} [active] - Is the email active.
560
- * @property {boolean} [primary] - Is it a primary email.
561
- * @property {boolean} [verified] - Is the email verified.
562
- */
563
- declare class UserApplicationModel {
564
- }
565
- declare namespace UserApplicationModel {
566
- export { UpdateUserAttributesRequest, UserAttributes, DeleteApplicationUserRequestSchema, EditEmailRequestSchema, SendVerificationLinkMobileRequestSchema, EditMobileRequestSchema, EditProfileRequestSchema, EditProfileMobileSchema, SendEmailOtpRequestSchema, SendEmailForgotOtpRequestSchema, VerifyEmailOtpRequestSchema, VerifyEmailForgotOtpRequestSchema, VerifyOtpRequestSchema, VerifyMobileForgotOtpRequestSchema, SendMobileOtpRequestSchema, SendMobileForgotOtpRequestSchema, UpdatePasswordRequestSchema, FormRegisterRequestSchema, TokenRequestBodySchema, ForgotPasswordRequestSchema, CodeRequestBodySchema, SendResetPasswordEmailRequestSchema, SendResetPasswordMobileRequestSchema, PasswordLoginRequestSchema, SendOtpRequestSchema, OAuthRequestSchema, OAuthRequestAppleSchema, UserObjectSchema, AuthSuccess, UserExistsResponse, SendOtpResponse, ProfileEditSuccess, LoginSuccess, ResetForgotPasswordSuccess, VerifyOtpSuccess, VerifyForgotOtpSuccess, ResetPasswordSuccess, RegisterFormSuccess, VerifyEmailSuccess, HasPasswordSuccess, LogoutSuccess, DeleteUserSuccess, OtpSuccess, EmailOtpSuccess, SessionListSuccess, VerifyMobileOTPSuccess, VerifyEmailOTPSuccess, SendMobileVerifyLinkSuccess, SendEmailVerifyLinkSuccess, APIError, FormRegisterRequestSchemaPhone, OAuthRequestSchemaOauth2, OAuthRequestSchemaProfile, OAuthRequestAppleSchemaOauth, OAuthRequestAppleSchemaProfile, PlatformSchema, LookAndFeel, Login, MetaSchema, Social, RequiredFields, PlatformEmail, PlatformMobile, RegisterRequiredFields, RegisterRequiredFieldsEmail, RegisterRequiredFieldsMobile, FlashCard, SocialTokens, DeleteAccountReasons, DeleteAccountConsent, Facebook, Accountkit, Google, SessionExpiry, UserSchema, PhoneNumber, Email };
567
- }
568
- /** @returns {UpdateUserAttributesRequest} */
569
- declare function UpdateUserAttributesRequest(): UpdateUserAttributesRequest;
570
- type UpdateUserAttributesRequest = {
571
- /**
572
- * - Describes the request structure to update
573
- * the user attribute.
574
- */
575
- attributes?: any;
576
- };
577
- /** @returns {UserAttributes} */
578
- declare function UserAttributes(): UserAttributes;
579
- type UserAttributes = {
580
- /**
581
- * - Describes the structure of user attribute.
582
- */
583
- attributes?: any;
584
- };
585
- /** @returns {DeleteApplicationUserRequestSchema} */
586
- declare function DeleteApplicationUserRequestSchema(): DeleteApplicationUserRequestSchema;
587
- type DeleteApplicationUserRequestSchema = {
588
- /**
589
- * - User id for the application user.
590
- */
591
- user_id?: string;
592
- /**
593
- * - Reason to delete the application user.
594
- */
595
- reason?: string;
596
- /**
597
- * - Reason id of request to delete the application user .
598
- */
599
- reason_id?: string;
600
- /**
601
- * - ID of request to delete the application user .
602
- */
603
- request_id?: string;
604
- /**
605
- * - OTP to verify the delete application user request.
606
- */
607
- otp?: string;
608
- };
609
- /** @returns {EditEmailRequestSchema} */
610
- declare function EditEmailRequestSchema(): EditEmailRequestSchema;
611
- type EditEmailRequestSchema = {
612
- /**
613
- * - Email of the user.
614
- */
615
- email?: string;
616
- };
617
- /** @returns {SendVerificationLinkMobileRequestSchema} */
618
- declare function SendVerificationLinkMobileRequestSchema(): SendVerificationLinkMobileRequestSchema;
619
- type SendVerificationLinkMobileRequestSchema = {
620
- /**
621
- * - Boolean to specify if the phone number is
622
- * verified or not.
623
- */
624
- verified?: boolean;
625
- /**
626
- * - Boolean to specify if the phone number is active or not.
627
- */
628
- active?: boolean;
629
- /**
630
- * - Country code for the phone number.
631
- */
632
- country_code?: string;
633
- /**
634
- * - Phone number.
635
- */
636
- phone?: string;
637
- /**
638
- * - Boolean to specify if the phone number is
639
- * primary or not.
640
- */
641
- primary?: boolean;
642
- };
643
- /** @returns {EditMobileRequestSchema} */
644
- declare function EditMobileRequestSchema(): EditMobileRequestSchema;
645
- type EditMobileRequestSchema = {
646
- /**
647
- * - Country code for the phone number.
648
- */
649
- country_code?: string;
650
- /**
651
- * - Phone number of user.
652
- */
653
- phone?: string;
654
- };
655
- /** @returns {EditProfileRequestSchema} */
656
- declare function EditProfileRequestSchema(): EditProfileRequestSchema;
657
- type EditProfileRequestSchema = {
658
- /**
659
- * - Set to true if you want to encrypt the OTP.
660
- */
661
- encrypt_otp?: boolean;
662
- /**
663
- * - First name of the application user.
664
- */
665
- first_name?: string;
666
- /**
667
- * - Last name of the application user.
668
- */
669
- last_name?: string;
670
- mobile?: EditProfileMobileSchema;
671
- /**
672
- * - Country code for the phone number.
673
- */
674
- country_code?: string;
675
- /**
676
- * - Email id of user.
677
- */
678
- email?: string;
679
- /**
680
- * - Gender of user.
681
- */
682
- gender?: string;
683
- /**
684
- * - Date of birth of user.
685
- */
686
- dob?: string;
687
- /**
688
- * - Profile picture of user.
689
- */
690
- profile_pic_url?: string;
691
- /**
692
- * - Unique hash value.
693
- */
694
- android_hash?: string;
695
- /**
696
- * - Identity of the sender.
697
- */
698
- sender?: string;
699
- /**
700
- * - Unique temporary registration of the user.
701
- */
702
- register_token?: string;
703
- };
704
- /** @returns {EditProfileMobileSchema} */
705
- declare function EditProfileMobileSchema(): EditProfileMobileSchema;
706
- type EditProfileMobileSchema = {
707
- /**
708
- * - Phone number of user.
709
- */
710
- phone?: string;
711
- /**
712
- * - Country code for the phone number.
713
- */
714
- country_code?: string;
715
- };
716
- /** @returns {SendEmailOtpRequestSchema} */
717
- declare function SendEmailOtpRequestSchema(): SendEmailOtpRequestSchema;
718
- type SendEmailOtpRequestSchema = {
719
- /**
720
- * - Email of a user to send email OTP.
721
- */
722
- email?: string;
723
- /**
724
- * - Action to specify if to send or resent the OTP.
725
- */
726
- action?: string;
727
- /**
728
- * - Token to validate the request.
729
- */
730
- token?: string;
731
- /**
732
- * - Unique temporary registration of the user.
733
- */
734
- register_token?: string;
735
- };
736
- /** @returns {SendEmailForgotOtpRequestSchema} */
737
- declare function SendEmailForgotOtpRequestSchema(): SendEmailForgotOtpRequestSchema;
738
- type SendEmailForgotOtpRequestSchema = {
739
- /**
740
- * - Email of a user to send email OTP.
741
- */
742
- email?: string;
743
- /**
744
- * - Action to specify if to send or resent the OTP.
745
- */
746
- action?: string;
747
- /**
748
- * - Token to validate the request.
749
- */
750
- token?: string;
751
- };
752
- /** @returns {VerifyEmailOtpRequestSchema} */
753
- declare function VerifyEmailOtpRequestSchema(): VerifyEmailOtpRequestSchema;
754
- type VerifyEmailOtpRequestSchema = {
755
- /**
756
- * - Email of a user to verify OTP.
757
- */
758
- email?: string;
759
- /**
760
- * - Action to verify the send or resent OTP.
761
- */
762
- action?: string;
763
- /**
764
- * - Unique temporary registration of the user.
765
- */
766
- register_token?: string;
767
- /**
768
- * - OTP for verification.
769
- */
770
- otp?: string;
771
- };
772
- /** @returns {VerifyEmailForgotOtpRequestSchema} */
773
- declare function VerifyEmailForgotOtpRequestSchema(): VerifyEmailForgotOtpRequestSchema;
774
- type VerifyEmailForgotOtpRequestSchema = {
775
- /**
776
- * - Email id of user.
777
- */
778
- email?: string;
779
- /**
780
- * - OTP for verification.
781
- */
782
- otp?: string;
783
- };
784
- /** @returns {VerifyOtpRequestSchema} */
785
- declare function VerifyOtpRequestSchema(): VerifyOtpRequestSchema;
786
- type VerifyOtpRequestSchema = {
787
- /**
788
- * - Unique request id for the OTP sent to mobile number.
789
- */
790
- request_id?: string;
791
- /**
792
- * - Unique temporary registration of the user.
793
- */
794
- register_token?: string;
795
- /**
796
- * - OTP for verification.
797
- */
798
- otp?: string;
799
- };
800
- /** @returns {VerifyMobileForgotOtpRequestSchema} */
801
- declare function VerifyMobileForgotOtpRequestSchema(): VerifyMobileForgotOtpRequestSchema;
802
- type VerifyMobileForgotOtpRequestSchema = {
803
- /**
804
- * - Unique request id for the OTP.
805
- */
806
- request_id?: string;
807
- /**
808
- * - OTP for verification.
809
- */
810
- otp?: string;
811
- };
812
- /** @returns {SendMobileOtpRequestSchema} */
813
- declare function SendMobileOtpRequestSchema(): SendMobileOtpRequestSchema;
814
- type SendMobileOtpRequestSchema = {
815
- /**
816
- * - Set to true if you want to encrypt the OTP.
817
- */
818
- encrypt_otp?: boolean;
819
- /**
820
- * - Mobile number of user.
821
- */
822
- mobile?: string;
823
- /**
824
- * - Country code for the phone number.
825
- */
826
- country_code?: string;
827
- /**
828
- * - Action to specify if to send or resent the OTP.
829
- */
830
- action?: string;
831
- /**
832
- * - Token to validate the request.
833
- */
834
- token?: string;
835
- /**
836
- * - Unique hash value.
837
- */
838
- android_hash?: string;
839
- /**
840
- * - Force verify the OTP.
841
- */
842
- force?: string;
843
- };
844
- /** @returns {SendMobileForgotOtpRequestSchema} */
845
- declare function SendMobileForgotOtpRequestSchema(): SendMobileForgotOtpRequestSchema;
846
- type SendMobileForgotOtpRequestSchema = {
847
- /**
848
- * - Phone number of user.
849
- */
850
- mobile?: string;
851
- /**
852
- * - Country code for the phone number.
853
- */
854
- country_code?: string;
855
- /**
856
- * - Action to specify if to send or resent the OTP.
857
- */
858
- action?: string;
859
- /**
860
- * - Token to validate the request.
861
- */
862
- token?: string;
863
- /**
864
- * - Unique hash value.
865
- */
866
- android_hash?: string;
867
- };
868
- /** @returns {UpdatePasswordRequestSchema} */
869
- declare function UpdatePasswordRequestSchema(): UpdatePasswordRequestSchema;
870
- type UpdatePasswordRequestSchema = {
871
- /**
872
- * - Old password.
873
- */
874
- old_password?: string;
875
- /**
876
- * - New password.
877
- */
878
- new_password?: string;
879
- };
880
- /** @returns {FormRegisterRequestSchema} */
881
- declare function FormRegisterRequestSchema(): FormRegisterRequestSchema;
882
- type FormRegisterRequestSchema = {
883
- /**
884
- * - First name of the application user.
885
- */
886
- first_name?: string;
887
- /**
888
- * - Last name of the application user.
889
- */
890
- last_name?: string;
891
- /**
892
- * - Gender of user.
893
- */
894
- gender?: string;
895
- /**
896
- * - Email of user.
897
- */
898
- email?: string;
899
- /**
900
- * - Password of user.
901
- */
902
- password?: string;
903
- phone?: FormRegisterRequestSchemaPhone;
904
- /**
905
- * - Unique registration token of user.
906
- */
907
- register_token?: string;
908
- };
909
- /** @returns {TokenRequestBodySchema} */
910
- declare function TokenRequestBodySchema(): TokenRequestBodySchema;
911
- type TokenRequestBodySchema = {
912
- /**
913
- * - Unique token.
914
- */
915
- token?: string;
916
- };
917
- /** @returns {ForgotPasswordRequestSchema} */
918
- declare function ForgotPasswordRequestSchema(): ForgotPasswordRequestSchema;
919
- type ForgotPasswordRequestSchema = {
920
- /**
921
- * - Unique code to verify request.
922
- */
923
- code?: string;
924
- /**
925
- * - Password of user.
926
- */
927
- password?: string;
928
- };
929
- /** @returns {CodeRequestBodySchema} */
930
- declare function CodeRequestBodySchema(): CodeRequestBodySchema;
931
- type CodeRequestBodySchema = {
932
- /**
933
- * - Unique code to verify request.
934
- */
935
- code?: string;
936
- };
937
- /** @returns {SendResetPasswordEmailRequestSchema} */
938
- declare function SendResetPasswordEmailRequestSchema(): SendResetPasswordEmailRequestSchema;
939
- type SendResetPasswordEmailRequestSchema = {
940
- /**
941
- * - Email id of user.
942
- */
943
- email?: string;
944
- };
945
- /** @returns {SendResetPasswordMobileRequestSchema} */
946
- declare function SendResetPasswordMobileRequestSchema(): SendResetPasswordMobileRequestSchema;
947
- type SendResetPasswordMobileRequestSchema = {
948
- /**
949
- * - Country code for the phone number.
950
- */
951
- country_code?: string;
952
- /**
953
- * - Phone number of user.
954
- */
955
- mobile?: string;
956
- };
957
- /** @returns {PasswordLoginRequestSchema} */
958
- declare function PasswordLoginRequestSchema(): PasswordLoginRequestSchema;
959
- type PasswordLoginRequestSchema = {
960
- /**
961
- * - Password of user.
962
- */
963
- password?: string;
964
- /**
965
- * - Username of user.
966
- */
967
- username?: string;
968
- };
969
- /** @returns {SendOtpRequestSchema} */
970
- declare function SendOtpRequestSchema(): SendOtpRequestSchema;
971
- type SendOtpRequestSchema = {
972
- /**
973
- * - Eet to true if you want to encrypt the OTP.
974
- */
975
- encrypt_otp?: boolean;
976
- /**
977
- * - Country code for the phone number.
978
- */
979
- country_code?: string;
980
- /**
981
- * - Phone number.
982
- */
983
- mobile?: string;
984
- /**
985
- * - Unique hash value.
986
- */
987
- android_hash?: string;
988
- };
989
- /** @returns {OAuthRequestSchema} */
990
- declare function OAuthRequestSchema(): OAuthRequestSchema;
991
- type OAuthRequestSchema = {
992
- /**
993
- * - Boolean to specify if the user is signed in .
994
- */
995
- is_signed_in?: boolean;
996
- oauth2?: OAuthRequestSchemaOauth2;
997
- profile?: OAuthRequestSchemaProfile;
998
- };
999
- /** @returns {OAuthRequestAppleSchema} */
1000
- declare function OAuthRequestAppleSchema(): OAuthRequestAppleSchema;
1001
- type OAuthRequestAppleSchema = {
1002
- /**
1003
- * - Unique user identifier.
1004
- */
1005
- user_identifier?: string;
1006
- oauth?: OAuthRequestAppleSchemaOauth;
1007
- profile?: OAuthRequestAppleSchemaProfile;
1008
- };
1009
- /** @returns {UserObjectSchema} */
1010
- declare function UserObjectSchema(): UserObjectSchema;
1011
- type UserObjectSchema = {
1012
- user?: UserSchema;
1013
- };
1014
- /** @returns {AuthSuccess} */
1015
- declare function AuthSuccess(): AuthSuccess;
1016
- type AuthSuccess = {
1017
- /**
1018
- * - Unique registration token for user.
1019
- */
1020
- register_token?: string;
1021
- /**
1022
- * - Boolean which specifies if user is registered.
1023
- */
1024
- user_exists?: boolean;
1025
- user?: UserSchema;
1026
- };
1027
- /** @returns {UserExistsResponse} */
1028
- declare function UserExistsResponse(): UserExistsResponse;
1029
- type UserExistsResponse = {
1030
- /**
1031
- * - Boolean which specifies if user is
1032
- * registered or not.
1033
- */
1034
- user_exists?: boolean;
1035
- };
1036
- /** @returns {SendOtpResponse} */
1037
- declare function SendOtpResponse(): SendOtpResponse;
1038
- type SendOtpResponse = {
1039
- /**
1040
- * - Time after which opt can be resent.
1041
- */
1042
- resend_timer?: number;
1043
- /**
1044
- * - Unique token to identify the OTP send
1045
- * request and resend the token.
1046
- */
1047
- resend_token?: string;
1048
- /**
1049
- * - Specify if the OTP is successfully sent.
1050
- */
1051
- success?: boolean;
1052
- /**
1053
- * - Unique request id for the OTP.
1054
- */
1055
- request_id?: string;
1056
- /**
1057
- * - Message to specify the OTP send status. Eg.
1058
- * OTP sent, failed to send OTP etc.
1059
- */
1060
- message?: string;
1061
- /**
1062
- * - Phone number of user.
1063
- */
1064
- mobile?: string;
1065
- /**
1066
- * - Country code for the phone number.
1067
- */
1068
- country_code?: string;
1069
- /**
1070
- * - Email id of user.
1071
- */
1072
- email?: string;
1073
- /**
1074
- * - Unique token to identify the OTP
1075
- * send request and resend the token on email.
1076
- */
1077
- resend_email_token?: string;
1078
- /**
1079
- * - Unique registration token for user.
1080
- */
1081
- register_token?: string;
1082
- /**
1083
- * - If email OTP verification is
1084
- * mandatory for registration.
1085
- */
1086
- verify_email_otp?: boolean;
1087
- /**
1088
- * - If mobile OTP verification is
1089
- * mandatory for registration.
1090
- */
1091
- verify_mobile_otp?: boolean;
1092
- /**
1093
- * - If user is registered or not.
1094
- */
1095
- user_exists?: boolean;
1096
- };
1097
- /** @returns {ProfileEditSuccess} */
1098
- declare function ProfileEditSuccess(): ProfileEditSuccess;
1099
- type ProfileEditSuccess = {
1100
- user?: UserSchema;
1101
- /**
1102
- * - Unique registration token for user.
1103
- */
1104
- register_token?: string;
1105
- /**
1106
- * - Unique token to identify the
1107
- * request for OTP verification in case of unverified email.
1108
- */
1109
- resend_email_token?: string;
1110
- /**
1111
- * - If user is registered or not.
1112
- */
1113
- user_exists?: boolean;
1114
- /**
1115
- * - Whether to send a link to verify
1116
- * the registered email id of the user.
1117
- */
1118
- verify_email_link?: boolean;
1119
- /**
1120
- * - Whether to send a OTP to verify the
1121
- * registered email id of the user.
1122
- */
1123
- verify_email_otp?: boolean;
1124
- /**
1125
- * - Whether to send a OTP to verify the
1126
- * registered phone of the user.
1127
- */
1128
- verify_mobile_otp?: boolean;
1129
- /**
1130
- * - Email id of user.
1131
- */
1132
- email?: string;
1133
- /**
1134
- * - A random uuid string used to track the request.
1135
- */
1136
- request_id?: string;
1137
- /**
1138
- * - The country specific prefix for the phone number.
1139
- */
1140
- country_code?: string;
1141
- /**
1142
- * - The user's mobile number without the country code.
1143
- */
1144
- mobile?: string;
1145
- /**
1146
- * - Whether the operation was successful.
1147
- */
1148
- success?: boolean;
1149
- /**
1150
- * - Information about the operation's result.
1151
- */
1152
- message?: string;
1153
- /**
1154
- * - Time in seconds before an request can be resent.
1155
- */
1156
- resend_timer?: number;
1157
- /**
1158
- * - A token used to authorize the resending of request.
1159
- */
1160
- resend_token?: string;
1161
- };
1162
- /** @returns {LoginSuccess} */
1163
- declare function LoginSuccess(): LoginSuccess;
1164
- type LoginSuccess = {
1165
- user?: UserSchema;
1166
- /**
1167
- * - A random uuid string used to track the send
1168
- * OTP response.
1169
- */
1170
- request_id?: string;
1171
- /**
1172
- * - A token used for registration purposes.
1173
- */
1174
- register_token?: string;
1175
- };
1176
- /** @returns {ResetForgotPasswordSuccess} */
1177
- declare function ResetForgotPasswordSuccess(): ResetForgotPasswordSuccess;
1178
- type ResetForgotPasswordSuccess = {
1179
- /**
1180
- * - Whether the password reset operation was successful.
1181
- */
1182
- success?: boolean;
1183
- };
1184
- /** @returns {VerifyOtpSuccess} */
1185
- declare function VerifyOtpSuccess(): VerifyOtpSuccess;
1186
- type VerifyOtpSuccess = {
1187
- user?: UserSchema;
1188
- /**
1189
- * - Whether the user already exists.
1190
- */
1191
- user_exists?: boolean;
1192
- /**
1193
- * - A token used for registration purposes.
1194
- */
1195
- register_token?: string;
1196
- };
1197
- /** @returns {VerifyForgotOtpSuccess} */
1198
- declare function VerifyForgotOtpSuccess(): VerifyForgotOtpSuccess;
1199
- type VerifyForgotOtpSuccess = {
1200
- /**
1201
- * - Whether the OTP verification was successful.
1202
- */
1203
- success?: boolean;
1204
- /**
1205
- * - A token used for resetting the forgotten password.
1206
- */
1207
- forgot_token?: string;
1208
- };
1209
- /** @returns {ResetPasswordSuccess} */
1210
- declare function ResetPasswordSuccess(): ResetPasswordSuccess;
1211
- type ResetPasswordSuccess = {
1212
- /**
1213
- * - Status of the password reset operation.
1214
- */
1215
- status?: string;
1216
- };
1217
- /** @returns {RegisterFormSuccess} */
1218
- declare function RegisterFormSuccess(): RegisterFormSuccess;
1219
- type RegisterFormSuccess = {
1220
- /**
1221
- * - The email address provided during registration.
1222
- */
1223
- email?: string;
1224
- /**
1225
- * - The time in seconds before an OTP can be resent.
1226
- */
1227
- resend_timer?: number;
1228
- /**
1229
- * - A token used to authorize the resending of an OTP.
1230
- */
1231
- resend_token?: string;
1232
- /**
1233
- * - A token used to authorize the
1234
- * resending of an OTP via email.
1235
- */
1236
- resend_email_token?: string;
1237
- /**
1238
- * - A token used for completing the
1239
- * registration process.
1240
- */
1241
- register_token?: string;
1242
- /**
1243
- * - A boolean value indicating whether the
1244
- * registration operation was successful.
1245
- */
1246
- success?: boolean;
1247
- /**
1248
- * - A random uuid string used to track the
1249
- * registration response.
1250
- */
1251
- request_id?: string;
1252
- /**
1253
- * - A string containing additional information
1254
- * about the operation's result.
1255
- */
1256
- message?: string;
1257
- /**
1258
- * - The user's phone mobile without the country code.
1259
- */
1260
- mobile?: string;
1261
- /**
1262
- * - The country specific prefix for the phone number.
1263
- */
1264
- country_code?: string;
1265
- /**
1266
- * - Whether email OTP verification is required.
1267
- */
1268
- verify_email_otp?: boolean;
1269
- /**
1270
- * - Whether mobile OTP verification is required.
1271
- */
1272
- verify_mobile_otp?: boolean;
1273
- /**
1274
- * - Whether the user already exists.
1275
- */
1276
- user_exists?: boolean;
1277
- };
1278
- /** @returns {VerifyEmailSuccess} */
1279
- declare function VerifyEmailSuccess(): VerifyEmailSuccess;
1280
- type VerifyEmailSuccess = {
1281
- /**
1282
- * - Result of the email verification process.
1283
- */
1284
- message?: string;
1285
- };
1286
- /** @returns {HasPasswordSuccess} */
1287
- declare function HasPasswordSuccess(): HasPasswordSuccess;
1288
- type HasPasswordSuccess = {
1289
- /**
1290
- * - An integer value indicating whether the user
1291
- * has set a password (1 for true, 0 for false).
1292
- */
1293
- result?: number;
1294
- };
1295
- /** @returns {LogoutSuccess} */
1296
- declare function LogoutSuccess(): LogoutSuccess;
1297
- type LogoutSuccess = {
1298
- /**
1299
- * - Whether the logout operation was successful.
1300
- */
1301
- logout?: boolean;
1302
- };
1303
- /** @returns {DeleteUserSuccess} */
1304
- declare function DeleteUserSuccess(): DeleteUserSuccess;
1305
- type DeleteUserSuccess = {
1306
- /**
1307
- * - Whether the user deletion operation was successful.
1308
- */
1309
- success?: boolean;
1310
- };
1311
- /** @returns {OtpSuccess} */
1312
- declare function OtpSuccess(): OtpSuccess;
1313
- type OtpSuccess = {
1314
- /**
1315
- * - The time in seconds before an OTP can be resent.
1316
- */
1317
- resend_timer?: number;
1318
- /**
1319
- * - A token used to authorize the resending of an OTP.
1320
- */
1321
- resend_token?: string;
1322
- /**
1323
- * - A token used for completing the
1324
- * registration process.
1325
- */
1326
- register_token?: string;
1327
- /**
1328
- * - Whether the OTP send operation was successful.
1329
- */
1330
- success?: boolean;
1331
- /**
1332
- * - A random uuid string used to track the OTP
1333
- * send response.
1334
- */
1335
- request_id?: string;
1336
- /**
1337
- * - Additional information about the operation's result.
1338
- */
1339
- message?: string;
1340
- /**
1341
- * - The user's mobile number without the country code.
1342
- */
1343
- mobile?: string;
1344
- /**
1345
- * - The country specific prefix for the phone number.
1346
- */
1347
- country_code?: string;
1348
- };
1349
- /** @returns {EmailOtpSuccess} */
1350
- declare function EmailOtpSuccess(): EmailOtpSuccess;
1351
- type EmailOtpSuccess = {
1352
- /**
1353
- * - Whether the OTP send operation was successful.
1354
- */
1355
- success?: boolean;
1356
- /**
1357
- * - A token used to authorize the
1358
- * resending of an OTP via email.
1359
- */
1360
- resend_email_token?: string;
1361
- };
1362
- /** @returns {SessionListSuccess} */
1363
- declare function SessionListSuccess(): SessionListSuccess;
1364
- type SessionListSuccess = {
1365
- /**
1366
- * - An array of active session identifiers.
1367
- */
1368
- sessions?: string[];
1369
- };
1370
- /** @returns {VerifyMobileOTPSuccess} */
1371
- declare function VerifyMobileOTPSuccess(): VerifyMobileOTPSuccess;
1372
- type VerifyMobileOTPSuccess = {
1373
- user?: UserSchema;
1374
- /**
1375
- * - Whether the mobile number
1376
- * verification link was successful.
1377
- */
1378
- verify_mobile_link?: boolean;
1379
- };
1380
- /** @returns {VerifyEmailOTPSuccess} */
1381
- declare function VerifyEmailOTPSuccess(): VerifyEmailOTPSuccess;
1382
- type VerifyEmailOTPSuccess = {
1383
- user?: UserSchema;
1384
- /**
1385
- * - Whether the email verification link
1386
- * was successful.
1387
- */
1388
- verify_email_link?: boolean;
1389
- };
1390
- /** @returns {SendMobileVerifyLinkSuccess} */
1391
- declare function SendMobileVerifyLinkSuccess(): SendMobileVerifyLinkSuccess;
1392
- type SendMobileVerifyLinkSuccess = {
1393
- /**
1394
- * - Whether the mobile verification
1395
- * link was successfully sent.
1396
- */
1397
- verify_mobile_link?: boolean;
1398
- };
1399
- /** @returns {SendEmailVerifyLinkSuccess} */
1400
- declare function SendEmailVerifyLinkSuccess(): SendEmailVerifyLinkSuccess;
1401
- type SendEmailVerifyLinkSuccess = {
1402
- /**
1403
- * - Whether the email verification link
1404
- * was successfully sent.
1405
- */
1406
- verify_email_link?: boolean;
1407
- };
1408
- /** @returns {APIError} */
1409
- declare function APIError(): APIError;
1410
- type APIError = {
1411
- /**
1412
- * - The error code representing the type of error.
1413
- */
1414
- code?: string;
1415
- /**
1416
- * - A descriptive message providing more details
1417
- * about the error.
1418
- */
1419
- message?: string;
1420
- /**
1421
- * - A link to the error code description.
1422
- */
1423
- info?: string;
1424
- /**
1425
- * - A random uuid string used to track the api request.
1426
- */
1427
- request_id?: string;
1428
- /**
1429
- * - The error message or stack trace.
1430
- */
1431
- error?: string;
1432
- /**
1433
- * - Additional metadata associated with the error.
1434
- */
1435
- meta?: any;
1436
- /**
1437
- * - Whether the user is authenticated.
1438
- */
1439
- authenticated?: boolean;
1440
- };
1441
- /** @returns {FormRegisterRequestSchemaPhone} */
1442
- declare function FormRegisterRequestSchemaPhone(): FormRegisterRequestSchemaPhone;
1443
- type FormRegisterRequestSchemaPhone = {
1444
- /**
1445
- * - Country code for mobile number.
1446
- */
1447
- country_code?: string;
1448
- /**
1449
- * - The user's mobile number without the country code.
1450
- */
1451
- mobile?: string;
1452
- };
1453
- /** @returns {OAuthRequestSchemaOauth2} */
1454
- declare function OAuthRequestSchemaOauth2(): OAuthRequestSchemaOauth2;
1455
- type OAuthRequestSchemaOauth2 = {
1456
- /**
1457
- * - The access token issued by the oauth2 provider.
1458
- */
1459
- access_token?: string;
1460
- /**
1461
- * - The expiry time of the access token in
1462
- * milliseconds since epoch.
1463
- */
1464
- expiry?: number;
1465
- /**
1466
- * - The refresh token issued by the oauth2 provider.
1467
- */
1468
- refresh_token?: string;
1469
- };
1470
- /** @returns {OAuthRequestSchemaProfile} */
1471
- declare function OAuthRequestSchemaProfile(): OAuthRequestSchemaProfile;
1472
- type OAuthRequestSchemaProfile = {
1473
- /**
1474
- * - The last name of the user.
1475
- */
1476
- last_name?: string;
1477
- /**
1478
- * - The url of the user's profile picture.
1479
- */
1480
- image?: string;
1481
- /**
1482
- * - The unique identifier of the user.
1483
- */
1484
- id?: string;
1485
- /**
1486
- * - The email address of the user.
1487
- */
1488
- email?: string;
1489
- /**
1490
- * - The full name of the user.
1491
- */
1492
- full_name?: string;
1493
- /**
1494
- * - The first name of the user.
1495
- */
1496
- first_name?: string;
1497
- };
1498
- /** @returns {OAuthRequestAppleSchemaOauth} */
1499
- declare function OAuthRequestAppleSchemaOauth(): OAuthRequestAppleSchemaOauth;
1500
- type OAuthRequestAppleSchemaOauth = {
1501
- /**
1502
- * - The identity token issued by apple.
1503
- */
1504
- identity_token?: string;
1505
- };
1506
- /** @returns {OAuthRequestAppleSchemaProfile} */
1507
- declare function OAuthRequestAppleSchemaProfile(): OAuthRequestAppleSchemaProfile;
1508
- type OAuthRequestAppleSchemaProfile = {
1509
- /**
1510
- * - The last name of the user.
1511
- */
1512
- last_name?: string;
1513
- /**
1514
- * - The full name of the user.
1515
- */
1516
- full_name?: string;
1517
- /**
1518
- * - The first name of the user.
1519
- */
1520
- first_name?: string;
1521
- };
1522
- /** @returns {PlatformSchema} */
1523
- declare function PlatformSchema(): PlatformSchema;
1524
- type PlatformSchema = {
1525
- /**
1526
- * - The display name of the platform.
1527
- */
1528
- display?: string;
1529
- look_and_feel?: LookAndFeel;
1530
- /**
1531
- * - The date and time when the configuration
1532
- * was last updated.
1533
- */
1534
- updated_at?: string;
1535
- /**
1536
- * - Is the application config active or not .
1537
- */
1538
- active?: boolean;
1539
- /**
1540
- * - Forgot password option to be given or
1541
- * not to application user.
1542
- */
1543
- forgot_password?: boolean;
1544
- login?: Login;
1545
- /**
1546
- * - Skip the captcha or not .
1547
- */
1548
- skip_captcha?: boolean;
1549
- /**
1550
- * - Name of the application.
1551
- */
1552
- name?: string;
1553
- meta?: MetaSchema;
1554
- /**
1555
- * - Unique document id of the platform config.
1556
- */
1557
- _id?: string;
1558
- social?: Social;
1559
- required_fields?: RequiredFields;
1560
- register_required_fields?: RegisterRequiredFields;
1561
- /**
1562
- * - Whether to skip the login or not .
1563
- */
1564
- skip_login?: boolean;
1565
- flash_card?: FlashCard;
1566
- /**
1567
- * - Text to be shown at the top of the flash card
1568
- * like login to fynd, login to tira.
1569
- */
1570
- subtext?: string;
1571
- social_tokens?: SocialTokens;
1572
- /**
1573
- * - When was the application platform config
1574
- * document was created.
1575
- */
1576
- created_at?: string;
1577
- /**
1578
- * - Whether to show the registration page on
1579
- * landing page or not.
1580
- */
1581
- register?: boolean;
1582
- /**
1583
- * - Image to be shown on registration page
1584
- * for mobile devices.
1585
- */
1586
- mobile_image?: string;
1587
- /**
1588
- * - Image to be shown on registration page
1589
- * for desktop devices.
1590
- */
1591
- desktop_image?: string;
1592
- /**
1593
- * - Number of days after which the user
1594
- * account will be deleted.
1595
- */
1596
- delete_account_day?: number;
1597
- /**
1598
- * - List of reasons
1599
- * you can set to ask user when account is being deleted from application.
1600
- */
1601
- delete_account_reasons?: DeleteAccountReasons[];
1602
- delete_account_consent?: DeleteAccountConsent;
1603
- session_config?: SessionExpiry;
1604
- /**
1605
- * - Version of the document.
1606
- */
1607
- __v?: number;
1608
- };
1609
- /** @returns {LookAndFeel} */
1610
- declare function LookAndFeel(): LookAndFeel;
1611
- type LookAndFeel = {
1612
- /**
1613
- * - Position of the card eg right, left,
1614
- * top-right etc.
1615
- */
1616
- card_position?: string;
1617
- /**
1618
- * - Background colour of the card.
1619
- */
1620
- background_color?: string;
1621
- };
1622
- /** @returns {Login} */
1623
- declare function Login(): Login;
1624
- type Login = {
1625
- /**
1626
- * - Application is providing login with password or not.
1627
- */
1628
- password?: boolean;
1629
- /**
1630
- * - Application is providing login with OTP or not.
1631
- */
1632
- otp?: boolean;
1633
- };
1634
- /** @returns {MetaSchema} */
1635
- declare function MetaSchema(): MetaSchema;
1636
- type MetaSchema = {
1637
- /**
1638
- * - One of the custom field that you are
1639
- * storing in meta.
1640
- */
1641
- fynd_default?: boolean;
1642
- };
1643
- /** @returns {Social} */
1644
- declare function Social(): Social;
1645
- type Social = {
1646
- /**
1647
- * - Is accountkit social login active for
1648
- * application or not.
1649
- */
1650
- account_kit?: boolean;
1651
- /**
1652
- * - Is facebook social login active for
1653
- * application or not .
1654
- */
1655
- facebook?: boolean;
1656
- /**
1657
- * - Is google social login active for application or not .
1658
- */
1659
- google?: boolean;
1660
- /**
1661
- * - Is apple social login active for application or not.
1662
- */
1663
- apple?: boolean;
1664
- };
1665
- /** @returns {RequiredFields} */
1666
- declare function RequiredFields(): RequiredFields;
1667
- type RequiredFields = {
1668
- email?: PlatformEmail;
1669
- mobile?: PlatformMobile;
1670
- };
1671
- /** @returns {PlatformEmail} */
1672
- declare function PlatformEmail(): PlatformEmail;
1673
- type PlatformEmail = {
1674
- /**
1675
- * - Is email mandatory for user to register
1676
- * on a application or not.
1677
- */
1678
- is_required?: boolean;
1679
- /**
1680
- * - Level of email mandatory hard is mandatory and
1681
- * soft is optional.
1682
- */
1683
- level?: string;
1684
- };
1685
- /** @returns {PlatformMobile} */
1686
- declare function PlatformMobile(): PlatformMobile;
1687
- type PlatformMobile = {
1688
- /**
1689
- * - Is mobile mandatory for user to register
1690
- * on a application or not.
1691
- */
1692
- is_required?: boolean;
1693
- /**
1694
- * - Level of mobile mandatory hard is mandatory and
1695
- * soft is optional.
1696
- */
1697
- level?: string;
1698
- };
1699
- /** @returns {RegisterRequiredFields} */
1700
- declare function RegisterRequiredFields(): RegisterRequiredFields;
1701
- type RegisterRequiredFields = {
1702
- email?: RegisterRequiredFieldsEmail;
1703
- mobile?: RegisterRequiredFieldsMobile;
1704
- };
1705
- /** @returns {RegisterRequiredFieldsEmail} */
1706
- declare function RegisterRequiredFieldsEmail(): RegisterRequiredFieldsEmail;
1707
- type RegisterRequiredFieldsEmail = {
1708
- /**
1709
- * - Is email mandatory for user to register
1710
- * on a application or not.
1711
- */
1712
- is_required?: boolean;
1713
- /**
1714
- * - Level of email mandatory hard is mandatory and
1715
- * soft is optional.
1716
- */
1717
- level?: string;
1718
- };
1719
- /** @returns {RegisterRequiredFieldsMobile} */
1720
- declare function RegisterRequiredFieldsMobile(): RegisterRequiredFieldsMobile;
1721
- type RegisterRequiredFieldsMobile = {
1722
- /**
1723
- * - Is mobile mandatory for user to register
1724
- * on a application or not.
1725
- */
1726
- is_required?: boolean;
1727
- /**
1728
- * - Level of mobile mandatory hard is mandatory and
1729
- * soft is optional.
1730
- */
1731
- level?: string;
1732
- };
1733
- /** @returns {FlashCard} */
1734
- declare function FlashCard(): FlashCard;
1735
- type FlashCard = {
1736
- /**
1737
- * - Text to be shown in the flash card.
1738
- */
1739
- text?: string;
1740
- /**
1741
- * - Text colour for the text in the flash card.
1742
- */
1743
- text_color?: string;
1744
- /**
1745
- * - Background colour of the text to be
1746
- * shown on the flash card.
1747
- */
1748
- background_color?: string;
1749
- };
1750
- /** @returns {SocialTokens} */
1751
- declare function SocialTokens(): SocialTokens;
1752
- type SocialTokens = {
1753
- facebook?: Facebook;
1754
- accountkit?: Accountkit;
1755
- google?: Google;
1756
- };
1757
- /** @returns {DeleteAccountReasons} */
1758
- declare function DeleteAccountReasons(): DeleteAccountReasons;
1759
- type DeleteAccountReasons = {
1760
- /**
1761
- * - Text of the reason to be shown to user.
1762
- */
1763
- reason_text?: string;
1764
- /**
1765
- * - Unique id of the reason .
1766
- */
1767
- reason_id?: string;
1768
- /**
1769
- * - A boolean whether to show text area or not.
1770
- */
1771
- show_text_area?: boolean;
1772
- };
1773
- /** @returns {DeleteAccountConsent} */
1774
- declare function DeleteAccountConsent(): DeleteAccountConsent;
1775
- type DeleteAccountConsent = {
1776
- /**
1777
- * - Consent text to be shown to user.
1778
- */
1779
- consent_text?: string;
1780
- };
1781
- /** @returns {Facebook} */
1782
- declare function Facebook(): Facebook;
1783
- type Facebook = {
1784
- /**
1785
- * - App id of the credentials facebook.
1786
- */
1787
- app_id?: string;
1788
- };
1789
- /** @returns {Accountkit} */
1790
- declare function Accountkit(): Accountkit;
1791
- type Accountkit = {
1792
- /**
1793
- * - App id of the credentials account kit.
1794
- */
1795
- app_id?: string;
1796
- };
1797
- /** @returns {Google} */
1798
- declare function Google(): Google;
1799
- type Google = {
1800
- /**
1801
- * - App id of the credentials google.
1802
- */
1803
- app_id?: string;
1804
- };
1805
- /** @returns {SessionExpiry} */
1806
- declare function SessionExpiry(): SessionExpiry;
1807
- type SessionExpiry = {
1808
- /**
1809
- * - Number of days or hours based on type till
1810
- * which the session can be rolled back.
1811
- */
1812
- duration?: number;
1813
- /**
1814
- * - Days or hours the type of time for session rollback.
1815
- */
1816
- type?: string;
1817
- /**
1818
- * - Whether session needs to be rollback or not.
1819
- */
1820
- is_rolling?: boolean;
1821
- };
1822
- /** @returns {UserSchema} */
1823
- declare function UserSchema(): UserSchema;
1824
- type UserSchema = {
1825
- /**
1826
- * - Application id of the user.
1827
- */
1828
- application_id?: string;
1829
- /**
1830
- * - Unique id of the user.
1831
- */
1832
- user_id?: string;
1833
- /**
1834
- * - First name of the user.
1835
- */
1836
- first_name?: string;
1837
- /**
1838
- * - Metadata of the user, used to store details about the user
1839
- */
1840
- meta?: any;
1841
- /**
1842
- * - Last name of the user
1843
- */
1844
- last_name?: string;
1845
- /**
1846
- * - List of phone numbers of the user.
1847
- */
1848
- phone_numbers?: PhoneNumber[];
1849
- /**
1850
- * - List of email addresses of the user.
1851
- */
1852
- emails?: Email[];
1853
- /**
1854
- * - Gender of the user.
1855
- */
1856
- gender?: string;
1857
- /**
1858
- * - Date of birth of the user.
1859
- */
1860
- dob?: string;
1861
- /**
1862
- * - Is the user active.
1863
- */
1864
- active?: boolean;
1865
- /**
1866
- * - URL of the profile picture of the user.
1867
- */
1868
- profile_pic_url?: string;
1869
- /**
1870
- * - Unique username of the user.
1871
- */
1872
- username?: string;
1873
- /**
1874
- * - Type of user (user, programmatic (created
1875
- * by system))
1876
- */
1877
- account_type?: string;
1878
- /**
1879
- * - Unique id of the user.
1880
- */
1881
- _id?: string;
1882
- /**
1883
- * - Date and time of user creation.
1884
- */
1885
- created_at?: string;
1886
- /**
1887
- * - Date and time of user update.
1888
- */
1889
- updated_at?: string;
1890
- /**
1891
- * - Unique id referencing any user external
1892
- * documents (jio).
1893
- */
1894
- external_id?: string;
1895
- /**
1896
- * - Unique id referencing any user external documents.
1897
- */
1898
- rr_id?: string;
1899
- };
1900
- /** @returns {PhoneNumber} */
1901
- declare function PhoneNumber(): PhoneNumber;
1902
- type PhoneNumber = {
1903
- /**
1904
- * - Phone number of the user.
1905
- */
1906
- phone?: string;
1907
- /**
1908
- * - Country code for mobile number.
1909
- */
1910
- country_code?: number;
1911
- /**
1912
- * - Is the phone number active.
1913
- */
1914
- active?: boolean;
1915
- /**
1916
- * - Is it a primary phone number.
1917
- */
1918
- primary?: boolean;
1919
- /**
1920
- * - Is the phone number verified.
1921
- */
1922
- verified?: boolean;
1923
- };
1924
- /** @returns {Email} */
1925
- declare function Email(): Email;
1926
- type Email = {
1927
- /**
1928
- * - Email address.
1929
- */
1930
- email?: string;
1931
- /**
1932
- * - Is the email active.
1933
- */
1934
- active?: boolean;
1935
- /**
1936
- * - Is it a primary email.
1937
- */
1938
- primary?: boolean;
1939
- /**
1940
- * - Is the email verified.
1941
- */
1942
- verified?: boolean;
1943
- };