@gofynd/fdk-client-javascript 1.0.2 → 1.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (346) hide show
  1. package/README.md +31 -2
  2. package/index.d.ts +4 -4
  3. package/index.js +9 -10
  4. package/package.json +14 -14
  5. package/sdk/APIClient.d.ts +11 -0
  6. package/sdk/APIClient.js +35 -0
  7. package/sdk/Client.d.ts +6 -0
  8. package/sdk/Client.js +17 -0
  9. package/sdk/Config.d.ts +9 -0
  10. package/sdk/Config.js +17 -0
  11. package/sdk/application/Cart/CartApplicationClient.d.ts +243 -243
  12. package/sdk/application/Cart/CartApplicationClient.js +595 -594
  13. package/sdk/application/Cart/CartApplicationModel.d.ts +64 -63
  14. package/sdk/application/Cart/CartApplicationModel.js +490 -885
  15. package/sdk/application/Cart/CartApplicationValidator.d.ts +17 -17
  16. package/sdk/application/Cart/CartApplicationValidator.js +98 -98
  17. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +358 -358
  18. package/sdk/application/Catalog/CatalogApplicationClient.js +1079 -1078
  19. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +90 -90
  20. package/sdk/application/Catalog/CatalogApplicationModel.js +683 -1249
  21. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +19 -19
  22. package/sdk/application/Catalog/CatalogApplicationValidator.js +110 -110
  23. package/sdk/application/Common/CommonApplicationClient.d.ts +13 -13
  24. package/sdk/application/Common/CommonApplicationClient.js +43 -42
  25. package/sdk/application/Common/CommonApplicationModel.d.ts +12 -12
  26. package/sdk/application/Common/CommonApplicationModel.js +83 -160
  27. package/sdk/application/Common/CommonApplicationValidator.d.ts +1 -1
  28. package/sdk/application/Common/CommonApplicationValidator.js +6 -6
  29. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +11 -11
  30. package/sdk/application/Communication/CommunicationApplicationClient.js +32 -31
  31. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +6 -6
  32. package/sdk/application/Communication/CommunicationApplicationModel.js +38 -83
  33. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
  34. package/sdk/application/Communication/CommunicationApplicationValidator.js +4 -4
  35. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +116 -116
  36. package/sdk/application/Configuration/ConfigurationApplicationClient.js +350 -349
  37. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +85 -85
  38. package/sdk/application/Configuration/ConfigurationApplicationModel.js +480 -851
  39. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +8 -8
  40. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +33 -33
  41. package/sdk/application/Content/ContentApplicationClient.d.ts +67 -67
  42. package/sdk/application/Content/ContentApplicationClient.js +216 -215
  43. package/sdk/application/Content/ContentApplicationModel.d.ts +76 -76
  44. package/sdk/application/Content/ContentApplicationModel.js +468 -884
  45. package/sdk/application/Content/ContentApplicationValidator.d.ts +5 -5
  46. package/sdk/application/Content/ContentApplicationValidator.js +24 -24
  47. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +25 -25
  48. package/sdk/application/FileStorage/FileStorageApplicationClient.js +65 -64
  49. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +13 -13
  50. package/sdk/application/FileStorage/FileStorageApplicationModel.js +86 -169
  51. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +1 -1
  52. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +7 -7
  53. package/sdk/application/Lead/LeadApplicationClient.d.ts +24 -24
  54. package/sdk/application/Lead/LeadApplicationClient.js +109 -108
  55. package/sdk/application/Lead/LeadApplicationModel.d.ts +35 -35
  56. package/sdk/application/Lead/LeadApplicationModel.js +267 -474
  57. package/sdk/application/Lead/LeadApplicationValidator.d.ts +2 -2
  58. package/sdk/application/Lead/LeadApplicationValidator.js +11 -11
  59. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +31 -22
  60. package/sdk/application/Logistic/LogisticApplicationClient.js +115 -49
  61. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +17 -14
  62. package/sdk/application/Logistic/LogisticApplicationModel.js +133 -201
  63. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +3 -2
  64. package/sdk/application/Logistic/LogisticApplicationValidator.js +14 -9
  65. package/sdk/application/Order/OrderApplicationClient.d.ts +85 -85
  66. package/sdk/application/Order/OrderApplicationClient.js +247 -246
  67. package/sdk/application/Order/OrderApplicationModel.d.ts +50 -50
  68. package/sdk/application/Order/OrderApplicationModel.js +361 -656
  69. package/sdk/application/Order/OrderApplicationValidator.d.ts +7 -7
  70. package/sdk/application/Order/OrderApplicationValidator.js +28 -28
  71. package/sdk/application/Payment/PaymentApplicationClient.d.ts +318 -318
  72. package/sdk/application/Payment/PaymentApplicationClient.js +781 -780
  73. package/sdk/application/Payment/PaymentApplicationModel.d.ts +72 -72
  74. package/sdk/application/Payment/PaymentApplicationModel.js +570 -1038
  75. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +28 -28
  76. package/sdk/application/Payment/PaymentApplicationValidator.js +107 -107
  77. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +254 -254
  78. package/sdk/application/PosCart/PosCartApplicationClient.js +646 -645
  79. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +64 -63
  80. package/sdk/application/PosCart/PosCartApplicationModel.js +476 -870
  81. package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +18 -18
  82. package/sdk/application/PosCart/PosCartApplicationValidator.js +103 -103
  83. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +27 -27
  84. package/sdk/application/Rewards/RewardsApplicationClient.js +122 -121
  85. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +14 -14
  86. package/sdk/application/Rewards/RewardsApplicationModel.js +96 -191
  87. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +3 -3
  88. package/sdk/application/Rewards/RewardsApplicationValidator.js +12 -12
  89. package/sdk/application/Share/ShareApplicationClient.d.ts +37 -37
  90. package/sdk/application/Share/ShareApplicationClient.js +94 -93
  91. package/sdk/application/Share/ShareApplicationModel.d.ts +8 -8
  92. package/sdk/application/Share/ShareApplicationModel.js +63 -123
  93. package/sdk/application/Share/ShareApplicationValidator.d.ts +4 -4
  94. package/sdk/application/Share/ShareApplicationValidator.js +12 -12
  95. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
  96. package/sdk/application/Theme/ThemeApplicationClient.js +38 -37
  97. package/sdk/application/Theme/ThemeApplicationModel.d.ts +34 -34
  98. package/sdk/application/Theme/ThemeApplicationModel.js +190 -336
  99. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +1 -1
  100. package/sdk/application/Theme/ThemeApplicationValidator.js +4 -4
  101. package/sdk/application/User/UserApplicationClient.d.ts +280 -280
  102. package/sdk/application/User/UserApplicationClient.js +619 -618
  103. package/sdk/application/User/UserApplicationModel.d.ts +79 -72
  104. package/sdk/application/User/UserApplicationModel.js +440 -689
  105. package/sdk/application/User/UserApplicationValidator.d.ts +24 -24
  106. package/sdk/application/User/UserApplicationValidator.js +89 -89
  107. package/sdk/common/AxiosHelper.js +18 -7
  108. package/sdk/constructUrl.d.ts +5 -0
  109. package/sdk/constructUrl.js +13 -0
  110. package/sdk/index.d.ts +3 -0
  111. package/sdk/index.js +5 -0
  112. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +51 -51
  113. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +182 -180
  114. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +6 -6
  115. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +21 -21
  116. package/sdk/platform/Analytics/AnalyticsPlatformClient.js +5 -4
  117. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +11 -11
  118. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +95 -178
  119. package/sdk/platform/Analytics/AnalyticsPlatformValidator.js +1 -0
  120. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +10 -10
  121. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +44 -43
  122. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +10 -10
  123. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +50 -89
  124. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -1
  125. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +7 -6
  126. package/sdk/platform/Billing/BillingPlatformClient.d.ts +60 -60
  127. package/sdk/platform/Billing/BillingPlatformClient.js +184 -183
  128. package/sdk/platform/Billing/BillingPlatformModel.d.ts +40 -40
  129. package/sdk/platform/Billing/BillingPlatformModel.js +342 -668
  130. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +8 -8
  131. package/sdk/platform/Billing/BillingPlatformValidator.js +26 -25
  132. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +192 -165
  133. package/sdk/platform/Cart/CartPlatformApplicationClient.js +686 -510
  134. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +14 -11
  135. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +77 -61
  136. package/sdk/platform/Cart/CartPlatformModel.d.ts +84 -83
  137. package/sdk/platform/Cart/CartPlatformModel.js +676 -1206
  138. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +632 -632
  139. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1558 -1556
  140. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +40 -40
  141. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +175 -175
  142. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +688 -688
  143. package/sdk/platform/Catalog/CatalogPlatformClient.js +1556 -1559
  144. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +291 -291
  145. package/sdk/platform/Catalog/CatalogPlatformModel.js +2133 -3910
  146. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +66 -66
  147. package/sdk/platform/Catalog/CatalogPlatformValidator.js +229 -228
  148. package/sdk/platform/Common/CommonPlatformClient.d.ts +12 -12
  149. package/sdk/platform/Common/CommonPlatformClient.js +40 -51
  150. package/sdk/platform/Common/CommonPlatformModel.d.ts +12 -12
  151. package/sdk/platform/Common/CommonPlatformModel.js +83 -160
  152. package/sdk/platform/Common/CommonPlatformValidator.d.ts +1 -1
  153. package/sdk/platform/Common/CommonPlatformValidator.js +7 -6
  154. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +326 -326
  155. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +945 -943
  156. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +30 -30
  157. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +88 -88
  158. package/sdk/platform/Communication/CommunicationPlatformClient.js +4 -3
  159. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +67 -67
  160. package/sdk/platform/Communication/CommunicationPlatformModel.js +522 -974
  161. package/sdk/platform/Communication/CommunicationPlatformValidator.js +1 -0
  162. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +55 -55
  163. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +217 -216
  164. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +27 -27
  165. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +279 -542
  166. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +7 -7
  167. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +25 -24
  168. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +163 -153
  169. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +617 -552
  170. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +22 -21
  171. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +70 -64
  172. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +125 -125
  173. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +348 -347
  174. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +148 -146
  175. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +854 -1508
  176. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -9
  177. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +39 -38
  178. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +524 -534
  179. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1287 -1346
  180. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +49 -50
  181. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +153 -159
  182. package/sdk/platform/Content/ContentPlatformModel.d.ts +78 -78
  183. package/sdk/platform/Content/ContentPlatformModel.js +485 -907
  184. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +65 -65
  185. package/sdk/platform/Discount/DiscountPlatformClient.js +219 -218
  186. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +7 -7
  187. package/sdk/platform/Discount/DiscountPlatformModel.js +60 -121
  188. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +6 -6
  189. package/sdk/platform/Discount/DiscountPlatformValidator.js +30 -29
  190. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +25 -25
  191. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +83 -61
  192. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
  193. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +9 -9
  194. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +53 -53
  195. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +147 -125
  196. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -13
  197. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +86 -169
  198. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +3 -3
  199. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +12 -11
  200. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +63 -63
  201. package/sdk/platform/Inventory/InventoryPlatformClient.js +231 -230
  202. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +30 -30
  203. package/sdk/platform/Inventory/InventoryPlatformModel.js +497 -964
  204. package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +7 -7
  205. package/sdk/platform/Inventory/InventoryPlatformValidator.js +29 -28
  206. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +73 -73
  207. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +203 -201
  208. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +7 -7
  209. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +29 -29
  210. package/sdk/platform/Lead/LeadPlatformClient.d.ts +80 -80
  211. package/sdk/platform/Lead/LeadPlatformClient.js +215 -214
  212. package/sdk/platform/Lead/LeadPlatformModel.d.ts +35 -35
  213. package/sdk/platform/Lead/LeadPlatformModel.js +267 -474
  214. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +6 -6
  215. package/sdk/platform/Lead/LeadPlatformValidator.js +25 -24
  216. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +10 -10
  217. package/sdk/platform/Order/OrderPlatformApplicationClient.js +68 -66
  218. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -1
  219. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +7 -7
  220. package/sdk/platform/Order/OrderPlatformClient.d.ts +357 -357
  221. package/sdk/platform/Order/OrderPlatformClient.js +1046 -1033
  222. package/sdk/platform/Order/OrderPlatformModel.d.ts +198 -196
  223. package/sdk/platform/Order/OrderPlatformModel.js +1575 -2861
  224. package/sdk/platform/Order/OrderPlatformValidator.d.ts +32 -32
  225. package/sdk/platform/Order/OrderPlatformValidator.js +161 -160
  226. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +3 -1
  227. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +1 -1
  228. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +1 -1
  229. package/sdk/platform/Partner/PartnerPlatformModel.js +10 -26
  230. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +58 -58
  231. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +178 -178
  232. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +6 -6
  233. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +24 -24
  234. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +42 -42
  235. package/sdk/platform/Payment/PaymentPlatformClient.js +156 -155
  236. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +27 -27
  237. package/sdk/platform/Payment/PaymentPlatformModel.js +222 -410
  238. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +4 -4
  239. package/sdk/platform/Payment/PaymentPlatformValidator.js +22 -21
  240. package/sdk/platform/PlatformApplicationClient.d.ts +1496 -10325
  241. package/sdk/platform/PlatformApplicationClient.js +1584 -13899
  242. package/sdk/platform/PlatformClient.d.ts +7972 -7888
  243. package/sdk/platform/PlatformClient.js +8678 -10107
  244. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +85 -85
  245. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +299 -280
  246. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +8 -8
  247. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +35 -35
  248. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +15 -15
  249. package/sdk/platform/Rewards/RewardsPlatformModel.js +92 -194
  250. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -10
  251. package/sdk/platform/Share/SharePlatformApplicationClient.js +62 -60
  252. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
  253. package/sdk/platform/Share/SharePlatformApplicationValidator.js +7 -7
  254. package/sdk/platform/Share/SharePlatformModel.d.ts +8 -8
  255. package/sdk/platform/Share/SharePlatformModel.js +60 -118
  256. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +132 -132
  257. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +314 -312
  258. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +15 -15
  259. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +45 -45
  260. package/sdk/platform/Theme/ThemePlatformModel.d.ts +34 -34
  261. package/sdk/platform/Theme/ThemePlatformModel.js +190 -336
  262. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +136 -69
  263. package/sdk/platform/User/UserPlatformApplicationClient.js +507 -166
  264. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +12 -7
  265. package/sdk/platform/User/UserPlatformApplicationValidator.js +62 -24
  266. package/sdk/platform/User/UserPlatformModel.d.ts +79 -72
  267. package/sdk/platform/User/UserPlatformModel.js +440 -689
  268. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +31 -31
  269. package/sdk/platform/Webhook/WebhookPlatformClient.js +91 -90
  270. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +7 -7
  271. package/sdk/platform/Webhook/WebhookPlatformModel.js +68 -136
  272. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +3 -3
  273. package/sdk/platform/Webhook/WebhookPlatformValidator.js +15 -14
  274. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +13 -13
  275. package/sdk/public/Configuration/ConfigurationPublicClient.js +40 -38
  276. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +12 -12
  277. package/sdk/public/Configuration/ConfigurationPublicModel.js +85 -162
  278. package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +1 -1
  279. package/sdk/public/Configuration/ConfigurationPublicValidator.js +6 -6
  280. package/sdk/public/Inventory/InventoryPublicClient.d.ts +34 -34
  281. package/sdk/public/Inventory/InventoryPublicClient.js +115 -113
  282. package/sdk/public/Inventory/InventoryPublicModel.d.ts +10 -10
  283. package/sdk/public/Inventory/InventoryPublicModel.js +119 -245
  284. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +3 -3
  285. package/sdk/public/Inventory/InventoryPublicValidator.js +15 -15
  286. package/sdk/public/Webhook/WebhookPublicClient.js +2 -0
  287. package/sdk/public/Webhook/WebhookPublicModel.d.ts +7 -7
  288. package/sdk/public/Webhook/WebhookPublicModel.js +68 -136
  289. package/.github/workflows/on_create_release.yml +0 -23
  290. package/.github/workflows/on_merge_main.yml +0 -38
  291. package/.github/workflows/on_pull_request.yml +0 -35
  292. package/.prettierrc +0 -5
  293. package/documentation/application/CART.md +0 -7339
  294. package/documentation/application/CATALOG.md +0 -9597
  295. package/documentation/application/COMMON.md +0 -452
  296. package/documentation/application/COMMUNICATION.md +0 -467
  297. package/documentation/application/CONFIGURATION.md +0 -2906
  298. package/documentation/application/CONTENT.md +0 -3351
  299. package/documentation/application/FILESTORAGE.md +0 -578
  300. package/documentation/application/LEAD.md +0 -1895
  301. package/documentation/application/LOGISTIC.md +0 -765
  302. package/documentation/application/ORDER.md +0 -3432
  303. package/documentation/application/PAYMENT.md +0 -5221
  304. package/documentation/application/POSCART.md +0 -7938
  305. package/documentation/application/README.md +0 -21
  306. package/documentation/application/REWARDS.md +0 -708
  307. package/documentation/application/SHARE.md +0 -733
  308. package/documentation/application/THEME.md +0 -5800
  309. package/documentation/application/USER.md +0 -4335
  310. package/documentation/platform/ANALYTICS.md +0 -1154
  311. package/documentation/platform/AUDITTRAIL.md +0 -576
  312. package/documentation/platform/BILLING.md +0 -2400
  313. package/documentation/platform/CART.md +0 -5559
  314. package/documentation/platform/CATALOG.md +0 -23261
  315. package/documentation/platform/COMMON.md +0 -452
  316. package/documentation/platform/COMMUNICATION.md +0 -5718
  317. package/documentation/platform/COMPANYPROFILE.md +0 -2031
  318. package/documentation/platform/CONFIGURATION.md +0 -7339
  319. package/documentation/platform/CONTENT.md +0 -9098
  320. package/documentation/platform/DISCOUNT.md +0 -863
  321. package/documentation/platform/FILESTORAGE.md +0 -1081
  322. package/documentation/platform/INVENTORY.md +0 -1779
  323. package/documentation/platform/LEAD.md +0 -4740
  324. package/documentation/platform/ORDER.md +0 -8486
  325. package/documentation/platform/PARTNER.md +0 -220
  326. package/documentation/platform/PAYMENT.md +0 -3448
  327. package/documentation/platform/README.md +0 -27
  328. package/documentation/platform/REWARDS.md +0 -1083
  329. package/documentation/platform/SHARE.md +0 -606
  330. package/documentation/platform/THEME.md +0 -35729
  331. package/documentation/platform/USER.md +0 -2319
  332. package/documentation/platform/WEBHOOK.md +0 -591
  333. package/documentation/public/CONFIGURATION.md +0 -452
  334. package/documentation/public/INVENTORY.md +0 -690
  335. package/documentation/public/WEBHOOK.md +0 -352
  336. package/jest.config.d.ts +0 -4
  337. package/jest.config.js +0 -6
  338. package/tests/application/catalog.spec.js +0 -47
  339. package/tests/common/action-url.spec.js +0 -35
  340. package/tests/common/schema/action-url.json +0 -178
  341. package/tests/common/schema/url-action.json +0 -683
  342. package/tests/common/url-action.spec.js +0 -48
  343. package/tests/helpers/cookie.helper.js +0 -31
  344. package/tests/helpers/oauth.helper.js +0 -43
  345. package/tests/platform/catalog.spec.js +0 -49
  346. package/tests/public/location.spec.js +0 -39
package/documentation/application/USER.md DELETED
@@ -1,4335 +0,0 @@
1
-
2
-
3
-
4
-
5
-
6
- ##### [Back to Application docs](./README.md)
7
-
8
- ## User Methods
9
- Authentication Service
10
-
11
- * [loginWithFacebook](#loginwithfacebook)
12
- * [loginWithGoogle](#loginwithgoogle)
13
- * [loginWithGoogleAndroid](#loginwithgoogleandroid)
14
- * [loginWithGoogleIOS](#loginwithgoogleios)
15
- * [loginWithAppleIOS](#loginwithappleios)
16
- * [loginWithOTP](#loginwithotp)
17
- * [loginWithEmailAndPassword](#loginwithemailandpassword)
18
- * [sendResetPasswordEmail](#sendresetpasswordemail)
19
- * [sendResetPasswordMobile](#sendresetpasswordmobile)
20
- * [forgotPassword](#forgotpassword)
21
- * [sendResetToken](#sendresettoken)
22
- * [loginWithToken](#loginwithtoken)
23
- * [registerWithForm](#registerwithform)
24
- * [verifyEmail](#verifyemail)
25
- * [verifyMobile](#verifymobile)
26
- * [hasPassword](#haspassword)
27
- * [updatePassword](#updatepassword)
28
- * [deleteUser](#deleteuser)
29
- * [logout](#logout)
30
- * [sendOTPOnMobile](#sendotponmobile)
31
- * [verifyMobileOTP](#verifymobileotp)
32
- * [sendOTPOnEmail](#sendotponemail)
33
- * [verifyEmailOTP](#verifyemailotp)
34
- * [getLoggedInUser](#getloggedinuser)
35
- * [getListOfActiveSessions](#getlistofactivesessions)
36
- * [getPlatformConfig](#getplatformconfig)
37
- * [updateProfile](#updateprofile)
38
- * [addMobileNumber](#addmobilenumber)
39
- * [deleteMobileNumber](#deletemobilenumber)
40
- * [setMobileNumberAsPrimary](#setmobilenumberasprimary)
41
- * [sendVerificationLinkToMobile](#sendverificationlinktomobile)
42
- * [addEmail](#addemail)
43
- * [deleteEmail](#deleteemail)
44
- * [setEmailAsPrimary](#setemailasprimary)
45
- * [sendVerificationLinkToEmail](#sendverificationlinktoemail)
46
-
47
-
48
-
49
- ## Methods with example and description
50
-
51
-
52
-
53
-
54
- ### loginWithFacebook
55
- Login or Register using Facebook
56
-
57
-
58
-
59
- ```javascript
60
- // Promise
61
- const promise = user.loginWithFacebook({ body : value,
62
- platform : value });
63
-
64
- // Async/Await
65
- const data = await user.loginWithFacebook({ body : value,
66
- platform : value });
67
- ```
68
-
69
-
70
-
71
-
72
-
73
- | Argument | Type | Required | Description |
74
- | --------- | ----- | -------- | ----------- |
75
- | platform | string | no | ID of the application |
76
- | body | [OAuthRequestSchema](#OAuthRequestSchema) | yes | Request body |
77
-
78
-
79
- Use this API to login or register using Facebook credentials.
80
-
81
- *Returned Response:*
82
-
83
-
84
-
85
-
86
- [AuthSuccess](#AuthSuccess)
87
-
88
- Success. Returns a JSON object with the user details. Check the example shown below or refer `AuthSuccess` for more details.
89
-
90
-
91
-
92
-
93
- <details>
94
- <summary><i>&nbsp; Examples:</i></summary>
95
-
96
-
97
- <details>
98
- <summary><i>&nbsp; Success</i></summary>
99
-
100
- ```json
101
- {
102
- "value": {
103
- "user_exists": false,
104
- "user": {
105
- "emails": [
106
- {
107
- "email": "www.akash24@gmail.com",
108
- "verified": true,
109
- "primary": true,
110
- "active": true
111
- }
112
- ],
113
- "phone_numbers": [],
114
- "first_name": "Akash",
115
- "last_name": "Mane",
116
- "debug": {
117
- "platform": "Fynd"
118
- },
119
- "active": true
120
- },
121
- "register_token": "d960c388-e286-43d9-b688-f6d1decc632d"
122
- }
123
- }
124
- ```
125
- </details>
126
-
127
- </details>
128
-
129
-
130
-
131
-
132
-
133
-
134
-
135
-
136
-
137
- ---
138
-
139
-
140
- ### loginWithGoogle
141
- Login or Register using Google
142
-
143
-
144
-
145
- ```javascript
146
- // Promise
147
- const promise = user.loginWithGoogle({ body : value,
148
- platform : value });
149
-
150
- // Async/Await
151
- const data = await user.loginWithGoogle({ body : value,
152
- platform : value });
153
- ```
154
-
155
-
156
-
157
-
158
-
159
- | Argument | Type | Required | Description |
160
- | --------- | ----- | -------- | ----------- |
161
- | platform | string | no | ID of the application |
162
- | body | [OAuthRequestSchema](#OAuthRequestSchema) | yes | Request body |
163
-
164
-
165
- Use this API to login or register using Google Account credentials.
166
-
167
- *Returned Response:*
168
-
169
-
170
-
171
-
172
- [AuthSuccess](#AuthSuccess)
173
-
174
- Success. Returns a JSON object with the user details. Check the example shown below or refer `AuthSuccess` for more details.
175
-
176
-
177
-
178
-
179
- <details>
180
- <summary><i>&nbsp; Examples:</i></summary>
181
-
182
-
183
- <details>
184
- <summary><i>&nbsp; Success</i></summary>
185
-
186
- ```json
187
- {
188
- "value": {
189
- "user_exists": false,
190
- "user": {
191
- "emails": [
192
- {
193
- "email": "www.akash24@gmail.com",
194
- "verified": true,
195
- "primary": true,
196
- "active": true
197
- }
198
- ],
199
- "phone_numbers": [],
200
- "first_name": "Akash",
201
- "last_name": "Mane",
202
- "debug": {
203
- "platform": "Fynd"
204
- },
205
- "active": true
206
- },
207
- "register_token": "d960c388-e286-43d9-b688-f6d1decc632d"
208
- }
209
- }
210
- ```
211
- </details>
212
-
213
- </details>
214
-
215
-
216
-
217
-
218
-
219
-
220
-
221
-
222
-
223
- ---
224
-
225
-
226
- ### loginWithGoogleAndroid
227
- Login or Register using Google on Android
228
-
229
-
230
-
231
- ```javascript
232
- // Promise
233
- const promise = user.loginWithGoogleAndroid({ body : value,
234
- platform : value });
235
-
236
- // Async/Await
237
- const data = await user.loginWithGoogleAndroid({ body : value,
238
- platform : value });
239
- ```
240
-
241
-
242
-
243
-
244
-
245
- | Argument | Type | Required | Description |
246
- | --------- | ----- | -------- | ----------- |
247
- | platform | string | no | ID of the application |
248
- | body | [OAuthRequestSchema](#OAuthRequestSchema) | yes | Request body |
249
-
250
-
251
- Use this API to login or register in Android app using Google Account credentials.
252
-
253
- *Returned Response:*
254
-
255
-
256
-
257
-
258
- [AuthSuccess](#AuthSuccess)
259
-
260
- Success. Returns a JSON object with the user details. Check the example shown below or refer `AuthSuccess` for more details.
261
-
262
-
263
-
264
-
265
- <details>
266
- <summary><i>&nbsp; Examples:</i></summary>
267
-
268
-
269
- <details>
270
- <summary><i>&nbsp; Success</i></summary>
271
-
272
- ```json
273
- {
274
- "value": {
275
- "user_exists": false,
276
- "user": {
277
- "emails": [
278
- {
279
- "email": "www.akash24@gmail.com",
280
- "verified": true,
281
- "primary": true,
282
- "active": true
283
- }
284
- ],
285
- "phone_numbers": [],
286
- "first_name": "Akash",
287
- "last_name": "Mane",
288
- "debug": {
289
- "platform": "Fynd"
290
- },
291
- "active": true
292
- },
293
- "register_token": "d960c388-e286-43d9-b688-f6d1decc632d"
294
- }
295
- }
296
- ```
297
- </details>
298
-
299
- </details>
300
-
301
-
302
-
303
-
304
-
305
-
306
-
307
-
308
-
309
- ---
310
-
311
-
312
- ### loginWithGoogleIOS
313
- Login or Register using Google on iOS
314
-
315
-
316
-
317
- ```javascript
318
- // Promise
319
- const promise = user.loginWithGoogleIOS({ body : value,
320
- platform : value });
321
-
322
- // Async/Await
323
- const data = await user.loginWithGoogleIOS({ body : value,
324
- platform : value });
325
- ```
326
-
327
-
328
-
329
-
330
-
331
- | Argument | Type | Required | Description |
332
- | --------- | ----- | -------- | ----------- |
333
- | platform | string | no | ID of the application |
334
- | body | [OAuthRequestSchema](#OAuthRequestSchema) | yes | Request body |
335
-
336
-
337
- Use this API to login or register in iOS app using Google Account credentials.
338
-
339
- *Returned Response:*
340
-
341
-
342
-
343
-
344
- [AuthSuccess](#AuthSuccess)
345
-
346
- Success. Returns a JSON object with the user details. Check the example shown below or refer `AuthSuccess` for more details.
347
-
348
-
349
-
350
-
351
- <details>
352
- <summary><i>&nbsp; Examples:</i></summary>
353
-
354
-
355
- <details>
356
- <summary><i>&nbsp; Success</i></summary>
357
-
358
- ```json
359
- {
360
- "value": {
361
- "user_exists": false,
362
- "user": {
363
- "emails": [
364
- {
365
- "email": "www.akash24@gmail.com",
366
- "verified": true,
367
- "primary": true,
368
- "active": true
369
- }
370
- ],
371
- "phone_numbers": [],
372
- "first_name": "Akash",
373
- "last_name": "Mane",
374
- "debug": {
375
- "platform": "Fynd"
376
- },
377
- "active": true
378
- },
379
- "register_token": "d960c388-e286-43d9-b688-f6d1decc632d"
380
- }
381
- }
382
- ```
383
- </details>
384
-
385
- </details>
386
-
387
-
388
-
389
-
390
-
391
-
392
-
393
-
394
-
395
- ---
396
-
397
-
398
- ### loginWithAppleIOS
399
- Login or Register using Apple on iOS
400
-
401
-
402
-
403
- ```javascript
404
- // Promise
405
- const promise = user.loginWithAppleIOS({ body : value,
406
- platform : value });
407
-
408
- // Async/Await
409
- const data = await user.loginWithAppleIOS({ body : value,
410
- platform : value });
411
- ```
412
-
413
-
414
-
415
-
416
-
417
- | Argument | Type | Required | Description |
418
- | --------- | ----- | -------- | ----------- |
419
- | platform | string | no | ID of the application |
420
- | body | [OAuthRequestAppleSchema](#OAuthRequestAppleSchema) | yes | Request body |
421
-
422
-
423
- Use this API to login or register in iOS app using Apple Account credentials.
424
-
425
- *Returned Response:*
426
-
427
-
428
-
429
-
430
- [AuthSuccess](#AuthSuccess)
431
-
432
- Success. Returns a JSON object with the user details. Check the example shown below or refer `AuthSuccess` for more details.
433
-
434
-
435
-
436
-
437
- <details>
438
- <summary><i>&nbsp; Examples:</i></summary>
439
-
440
-
441
- <details>
442
- <summary><i>&nbsp; Success</i></summary>
443
-
444
- ```json
445
- {
446
- "value": {
447
- "user_exists": false,
448
- "user": {
449
- "emails": [
450
- {
451
- "email": "www.akash24@gmail.com",
452
- "verified": true,
453
- "primary": true,
454
- "active": true
455
- }
456
- ],
457
- "phone_numbers": [],
458
- "first_name": "Akash",
459
- "last_name": "Mane",
460
- "debug": {
461
- "platform": "Fynd"
462
- },
463
- "active": true
464
- },
465
- "register_token": "d960c388-e286-43d9-b688-f6d1decc632d"
466
- }
467
- }
468
- ```
469
- </details>
470
-
471
- </details>
472
-
473
-
474
-
475
-
476
-
477
-
478
-
479
-
480
-
481
- ---
482
-
483
-
484
- ### loginWithOTP
485
- Login or Register with OTP
486
-
487
-
488
-
489
- ```javascript
490
- // Promise
491
- const promise = user.loginWithOTP({ body : value,
492
- platform : value });
493
-
494
- // Async/Await
495
- const data = await user.loginWithOTP({ body : value,
496
- platform : value });
497
- ```
498
-
499
-
500
-
501
-
502
-
503
- | Argument | Type | Required | Description |
504
- | --------- | ----- | -------- | ----------- |
505
- | platform | string | no | ID of the application |
506
- | body | [SendOtpRequestSchema](#SendOtpRequestSchema) | yes | Request body |
507
-
508
-
509
- Use this API to login or register with a One-time Password (OTP) sent via Email or SMS.
510
-
511
- *Returned Response:*
512
-
513
-
514
-
515
-
516
- [SendOtpResponse](#SendOtpResponse)
517
-
518
- Success. Check the example shown below or refer `SendOtpResponse` for more details.
519
-
520
-
521
-
522
-
523
- <details>
524
- <summary><i>&nbsp; Examples:</i></summary>
525
-
526
-
527
- <details>
528
- <summary><i>&nbsp; Success</i></summary>
529
-
530
- ```json
531
- {
532
- "value": {
533
- "success": true,
534
- "request_id": "01503005aeab87cbed93d40f46cc2749",
535
- "message": "OTP sent",
536
- "mobile": "8652523958",
537
- "country_code": "91",
538
- "resend_timer": 30,
539
- "resendToken": "58e72ca0-66ae-11eb-98b1-77d61363826e"
540
- }
541
- }
542
- ```
543
- </details>
544
-
545
- </details>
546
-
547
-
548
-
549
-
550
-
551
-
552
-
553
-
554
-
555
- ---
556
-
557
-
558
- ### loginWithEmailAndPassword
559
- Login or Register with password
560
-
561
-
562
-
563
- ```javascript
564
- // Promise
565
- const promise = user.loginWithEmailAndPassword({ body : value });
566
-
567
- // Async/Await
568
- const data = await user.loginWithEmailAndPassword({ body : value });
569
- ```
570
-
571
-
572
-
573
-
574
-
575
- | Argument | Type | Required | Description |
576
- | --------- | ----- | -------- | ----------- |
577
- | body | [PasswordLoginRequestSchema](#PasswordLoginRequestSchema) | yes | Request body |
578
-
579
-
580
- Use this API to login or register using an email address and password.
581
-
582
- *Returned Response:*
583
-
584
-
585
-
586
-
587
- [LoginSuccess](#LoginSuccess)
588
-
589
- Success. Check the example shown below or refer `LoginSuccess` for more details.
590
-
591
-
592
-
593
-
594
- <details>
595
- <summary><i>&nbsp; Examples:</i></summary>
596
-
597
-
598
- <details>
599
- <summary><i>&nbsp; Success</i></summary>
600
-
601
- ```json
602
- {
603
- "value": {
604
- "user": {
605
- "debug": {
606
- "source": "deadlock",
607
- "platform": "000000000000000000000001"
608
- },
609
- "gender": "male",
610
- "account_type": "user",
611
- "active": true,
612
- "profile_pic_url": "https://d2co8r51m5ca2d.cloudfront.net/inapp_banners/default_profile_img.png",
613
- "has_old_password_hash": false,
614
- "_id": "5e68af49cfa09bf7233022f1",
615
- "first_name": "Akash",
616
- "last_name": "Mane",
617
- "username": "akashmane_gofynd_com_10039",
618
- "phone_numbers": [
619
- {
620
- "active": true,
621
- "primary": true,
622
- "verified": true,
623
- "phone": "8652523958",
624
- "country_code": 91
625
- }
626
- ],
627
- "emails": [
628
- {
629
- "active": true,
630
- "primary": true,
631
- "verified": true,
632
- "email": "akashmane@gofynd.com"
633
- },
634
- {
635
- "active": true,
636
- "primary": false,
637
- "verified": true,
638
- "email": "akashmane@fynd.com"
639
- },
640
- {
641
- "active": true,
642
- "primary": false,
643
- "verified": true,
644
- "email": "akashmane@uniket.store"
645
- }
646
- ],
647
- "created_at": "2020-03-11T09:28:41.982Z",
648
- "updated_at": "2021-02-04T10:10:44.981Z"
649
- }
650
- }
651
- }
652
- ```
653
- </details>
654
-
655
- </details>
656
-
657
-
658
-
659
-
660
-
661
-
662
-
663
-
664
-
665
- ---
666
-
667
-
668
- ### sendResetPasswordEmail
669
- Reset Password
670
-
671
-
672
-
673
- ```javascript
674
- // Promise
675
- const promise = user.sendResetPasswordEmail({ body : value,
676
- platform : value });
677
-
678
- // Async/Await
679
- const data = await user.sendResetPasswordEmail({ body : value,
680
- platform : value });
681
- ```
682
-
683
-
684
-
685
-
686
-
687
- | Argument | Type | Required | Description |
688
- | --------- | ----- | -------- | ----------- |
689
- | platform | string | no | ID of the application |
690
- | body | [SendResetPasswordEmailRequestSchema](#SendResetPasswordEmailRequestSchema) | yes | Request body |
691
-
692
-
693
- Use this API to reset a password using the link sent on email.
694
-
695
- *Returned Response:*
696
-
697
-
698
-
699
-
700
- [ResetPasswordSuccess](#ResetPasswordSuccess)
701
-
702
- Success. Check the example shown below or refer `ResetPasswordSuccess` for more details.
703
-
704
-
705
-
706
-
707
- <details>
708
- <summary><i>&nbsp; Example:</i></summary>
709
-
710
- ```json
711
- {
712
- "status": "sent"
713
- }
714
- ```
715
- </details>
716
-
717
-
718
-
719
-
720
-
721
-
722
-
723
-
724
-
725
- ---
726
-
727
-
728
- ### sendResetPasswordMobile
729
- Reset Password
730
-
731
-
732
-
733
- ```javascript
734
- // Promise
735
- const promise = user.sendResetPasswordMobile({ body : value,
736
- platform : value });
737
-
738
- // Async/Await
739
- const data = await user.sendResetPasswordMobile({ body : value,
740
- platform : value });
741
- ```
742
-
743
-
744
-
745
-
746
-
747
- | Argument | Type | Required | Description |
748
- | --------- | ----- | -------- | ----------- |
749
- | platform | string | no | ID of the application |
750
- | body | [SendResetPasswordMobileRequestSchema](#SendResetPasswordMobileRequestSchema) | yes | Request body |
751
-
752
-
753
- Use this API to reset a password using the link sent on mobile.
754
-
755
- *Returned Response:*
756
-
757
-
758
-
759
-
760
- [ResetPasswordSuccess](#ResetPasswordSuccess)
761
-
762
- Success. Check the example shown below or refer `ResetPasswordSuccess` for more details.
763
-
764
-
765
-
766
-
767
- <details>
768
- <summary><i>&nbsp; Example:</i></summary>
769
-
770
- ```json
771
- {
772
- "status": "sent"
773
- }
774
- ```
775
- </details>
776
-
777
-
778
-
779
-
780
-
781
-
782
-
783
-
784
-
785
- ---
786
-
787
-
788
- ### forgotPassword
789
- Forgot Password
790
-
791
-
792
-
793
- ```javascript
794
- // Promise
795
- const promise = user.forgotPassword({ body : value });
796
-
797
- // Async/Await
798
- const data = await user.forgotPassword({ body : value });
799
- ```
800
-
801
-
802
-
803
-
804
-
805
- | Argument | Type | Required | Description |
806
- | --------- | ----- | -------- | ----------- |
807
- | body | [ForgotPasswordRequestSchema](#ForgotPasswordRequestSchema) | yes | Request body |
808
-
809
-
810
- Use this API to reset a password using the code sent on email or SMS.
811
-
812
- *Returned Response:*
813
-
814
-
815
-
816
-
817
- [LoginSuccess](#LoginSuccess)
818
-
819
- Success. Check the example shown below or refer `LoginSuccess` for more details.
820
-
821
-
822
-
823
-
824
- <details>
825
- <summary><i>&nbsp; Examples:</i></summary>
826
-
827
-
828
- <details>
829
- <summary><i>&nbsp; Success</i></summary>
830
-
831
- ```json
832
- {
833
- "value": {
834
- "user": {
835
- "debug": {
836
- "source": "deadlock",
837
- "platform": "000000000000000000000001"
838
- },
839
- "gender": "male",
840
- "account_type": "user",
841
- "active": true,
842
- "profile_pic_url": "https://d2co8r51m5ca2d.cloudfront.net/inapp_banners/default_profile_img.png",
843
- "has_old_password_hash": false,
844
- "_id": "5e68af49cfa09bf7233022f1",
845
- "first_name": "Akash",
846
- "last_name": "Mane",
847
- "username": "akashmane_gofynd_com_10039",
848
- "phone_numbers": [
849
- {
850
- "active": true,
851
- "primary": true,
852
- "verified": true,
853
- "phone": "8652523958",
854
- "country_code": 91
855
- }
856
- ],
857
- "emails": [
858
- {
859
- "active": true,
860
- "primary": true,
861
- "verified": true,
862
- "email": "akashmane@gofynd.com"
863
- },
864
- {
865
- "active": true,
866
- "primary": false,
867
- "verified": true,
868
- "email": "akashmane@fynd.com"
869
- },
870
- {
871
- "active": true,
872
- "primary": false,
873
- "verified": true,
874
- "email": "akashmane@uniket.store"
875
- }
876
- ],
877
- "created_at": "2020-03-11T09:28:41.982Z",
878
- "updated_at": "2021-02-04T10:10:44.981Z"
879
- }
880
- }
881
- }
882
- ```
883
- </details>
884
-
885
- </details>
886
-
887
-
888
-
889
-
890
-
891
-
892
-
893
-
894
-
895
- ---
896
-
897
-
898
- ### sendResetToken
899
- Reset Password using token
900
-
901
-
902
-
903
- ```javascript
904
- // Promise
905
- const promise = user.sendResetToken({ body : value });
906
-
907
- // Async/Await
908
- const data = await user.sendResetToken({ body : value });
909
- ```
910
-
911
-
912
-
913
-
914
-
915
- | Argument | Type | Required | Description |
916
- | --------- | ----- | -------- | ----------- |
917
- | body | [CodeRequestBodySchema](#CodeRequestBodySchema) | yes | Request body |
918
-
919
-
920
- Use this API to send code to reset password.
921
-
922
- *Returned Response:*
923
-
924
-
925
-
926
-
927
- [ResetPasswordSuccess](#ResetPasswordSuccess)
928
-
929
- Success. Check the example shown below or refer `ResetPasswordSuccess` for more details.
930
-
931
-
932
-
933
-
934
- <details>
935
- <summary><i>&nbsp; Example:</i></summary>
936
-
937
- ```json
938
- {
939
- "status": "success"
940
- }
941
- ```
942
- </details>
943
-
944
-
945
-
946
-
947
-
948
-
949
-
950
-
951
-
952
- ---
953
-
954
-
955
- ### loginWithToken
956
- Login or Register with token
957
-
958
-
959
-
960
- ```javascript
961
- // Promise
962
- const promise = user.loginWithToken({ body : value });
963
-
964
- // Async/Await
965
- const data = await user.loginWithToken({ body : value });
966
- ```
967
-
968
-
969
-
970
-
971
-
972
- | Argument | Type | Required | Description |
973
- | --------- | ----- | -------- | ----------- |
974
- | body | [TokenRequestBodySchema](#TokenRequestBodySchema) | yes | Request body |
975
-
976
-
977
- Use this API to login or register using a token for authentication.
978
-
979
- *Returned Response:*
980
-
981
-
982
-
983
-
984
- [LoginSuccess](#LoginSuccess)
985
-
986
- Success. Check the example shown below or refer `LoginSuccess` for more details.
987
-
988
-
989
-
990
-
991
- <details>
992
- <summary><i>&nbsp; Examples:</i></summary>
993
-
994
-
995
- <details>
996
- <summary><i>&nbsp; Success</i></summary>
997
-
998
- ```json
999
- {
1000
- "value": {
1001
- "user": {
1002
- "debug": {
1003
- "source": "deadlock",
1004
- "platform": "000000000000000000000001"
1005
- },
1006
- "gender": "male",
1007
- "account_type": "user",
1008
- "active": true,
1009
- "profile_pic_url": "https://d2co8r51m5ca2d.cloudfront.net/inapp_banners/default_profile_img.png",
1010
- "has_old_password_hash": false,
1011
- "_id": "5e68af49cfa09bf7233022f1",
1012
- "first_name": "Akash",
1013
- "last_name": "Mane",
1014
- "username": "akashmane_gofynd_com_10039",
1015
- "phone_numbers": [
1016
- {
1017
- "active": true,
1018
- "primary": true,
1019
- "verified": true,
1020
- "phone": "8652523958",
1021
- "country_code": 91
1022
- }
1023
- ],
1024
- "emails": [
1025
- {
1026
- "active": true,
1027
- "primary": true,
1028
- "verified": true,
1029
- "email": "akashmane@gofynd.com"
1030
- },
1031
- {
1032
- "active": true,
1033
- "primary": false,
1034
- "verified": true,
1035
- "email": "akashmane@fynd.com"
1036
- },
1037
- {
1038
- "active": true,
1039
- "primary": false,
1040
- "verified": true,
1041
- "email": "akashmane@uniket.store"
1042
- }
1043
- ],
1044
- "created_at": "2020-03-11T09:28:41.982Z",
1045
- "updated_at": "2021-02-04T10:10:44.981Z"
1046
- }
1047
- }
1048
- }
1049
- ```
1050
- </details>
1051
-
1052
- </details>
1053
-
1054
-
1055
-
1056
-
1057
-
1058
-
1059
-
1060
-
1061
-
1062
- ---
1063
-
1064
-
1065
- ### registerWithForm
1066
- Registration using a form
1067
-
1068
-
1069
-
1070
- ```javascript
1071
- // Promise
1072
- const promise = user.registerWithForm({ body : value,
1073
- platform : value });
1074
-
1075
- // Async/Await
1076
- const data = await user.registerWithForm({ body : value,
1077
- platform : value });
1078
- ```
1079
-
1080
-
1081
-
1082
-
1083
-
1084
- | Argument | Type | Required | Description |
1085
- | --------- | ----- | -------- | ----------- |
1086
- | platform | string | no | ID of the application |
1087
- | body | [FormRegisterRequestSchema](#FormRegisterRequestSchema) | yes | Request body |
1088
-
1089
-
1090
- Use this API to perform user registration by sending form data in the request body.
1091
-
1092
- *Returned Response:*
1093
-
1094
-
1095
-
1096
-
1097
- [RegisterFormSuccess](#RegisterFormSuccess)
1098
-
1099
- Success. Check the example shown below or refer `RegisterFormSuccess` for more details.
1100
-
1101
-
1102
-
1103
-
1104
- <details>
1105
- <summary><i>&nbsp; Example:</i></summary>
1106
-
1107
- ```json
1108
- {
1109
- "success": true,
1110
- "request_id": "ebc059191393681cdfb805b5424bddad",
1111
- "message": "OTP sent",
1112
- "mobile": "7400448798",
1113
- "country_code": "91",
1114
- "resend_timer": 30,
1115
- "resend_token": "5197ff90-66e2-11eb-9399-0312fbf2c2a6",
1116
- "verify_mobile_otp": true,
1117
- "register_token": "276e718a-d406-4a4b-83f7-cb6cb72b99ff",
1118
- "userExists": false
1119
- }
1120
- ```
1121
- </details>
1122
-
1123
-
1124
-
1125
-
1126
-
1127
-
1128
-
1129
-
1130
-
1131
- ---
1132
-
1133
-
1134
- ### verifyEmail
1135
- Verify email
1136
-
1137
-
1138
-
1139
- ```javascript
1140
- // Promise
1141
- const promise = user.verifyEmail({ body : value });
1142
-
1143
- // Async/Await
1144
- const data = await user.verifyEmail({ body : value });
1145
- ```
1146
-
1147
-
1148
-
1149
-
1150
-
1151
- | Argument | Type | Required | Description |
1152
- | --------- | ----- | -------- | ----------- |
1153
- | body | [CodeRequestBodySchema](#CodeRequestBodySchema) | yes | Request body |
1154
-
1155
-
1156
- Use this API to send a verification code to verify an email.
1157
-
1158
- *Returned Response:*
1159
-
1160
-
1161
-
1162
-
1163
- [VerifyEmailSuccess](#VerifyEmailSuccess)
1164
-
1165
- Success. Check the example shown below or refer `VerifyEmailSuccess` for more details.
1166
-
1167
-
1168
-
1169
-
1170
- <details>
1171
- <summary><i>&nbsp; Example:</i></summary>
1172
-
1173
- ```json
1174
- {
1175
- "message": "verified"
1176
- }
1177
- ```
1178
- </details>
1179
-
1180
-
1181
-
1182
-
1183
-
1184
-
1185
-
1186
-
1187
-
1188
- ---
1189
-
1190
-
1191
- ### verifyMobile
1192
- Verify mobile
1193
-
1194
-
1195
-
1196
- ```javascript
1197
- // Promise
1198
- const promise = user.verifyMobile({ body : value });
1199
-
1200
- // Async/Await
1201
- const data = await user.verifyMobile({ body : value });
1202
- ```
1203
-
1204
-
1205
-
1206
-
1207
-
1208
- | Argument | Type | Required | Description |
1209
- | --------- | ----- | -------- | ----------- |
1210
- | body | [CodeRequestBodySchema](#CodeRequestBodySchema) | yes | Request body |
1211
-
1212
-
1213
- Use this API to send a verification code to verify a mobile number.
1214
-
1215
- *Returned Response:*
1216
-
1217
-
1218
-
1219
-
1220
- [VerifyEmailSuccess](#VerifyEmailSuccess)
1221
-
1222
- Success. Check the example shown below or refer `VerifyEmailSuccess` for more details.
1223
-
1224
-
1225
-
1226
-
1227
- <details>
1228
- <summary><i>&nbsp; Example:</i></summary>
1229
-
1230
- ```json
1231
- {
1232
- "message": "verified"
1233
- }
1234
- ```
1235
- </details>
1236
-
1237
-
1238
-
1239
-
1240
-
1241
-
1242
-
1243
-
1244
-
1245
- ---
1246
-
1247
-
1248
- ### hasPassword
1249
- Check password
1250
-
1251
-
1252
-
1253
- ```javascript
1254
- // Promise
1255
- const promise = user.hasPassword();
1256
-
1257
- // Async/Await
1258
- const data = await user.hasPassword();
1259
- ```
1260
-
1261
-
1262
-
1263
-
1264
-
1265
-
1266
- Use this API to check if user has created a password for login.
1267
-
1268
- *Returned Response:*
1269
-
1270
-
1271
-
1272
-
1273
- [HasPasswordSuccess](#HasPasswordSuccess)
1274
-
1275
- Success. Returns a boolean value. Check the example shown below or refer `HasPasswordSuccess` for more details.
1276
-
1277
-
1278
-
1279
-
1280
- <details>
1281
- <summary><i>&nbsp; Example:</i></summary>
1282
-
1283
- ```json
1284
-
1285
- ```
1286
- </details>
1287
-
1288
-
1289
-
1290
-
1291
-
1292
-
1293
-
1294
-
1295
-
1296
- ---
1297
-
1298
-
1299
- ### updatePassword
1300
- Update user password
1301
-
1302
-
1303
-
1304
- ```javascript
1305
- // Promise
1306
- const promise = user.updatePassword({ body : value });
1307
-
1308
- // Async/Await
1309
- const data = await user.updatePassword({ body : value });
1310
- ```
1311
-
1312
-
1313
-
1314
-
1315
-
1316
- | Argument | Type | Required | Description |
1317
- | --------- | ----- | -------- | ----------- |
1318
- | body | [UpdatePasswordRequestSchema](#UpdatePasswordRequestSchema) | yes | Request body |
1319
-
1320
-
1321
- Use this API to update the password.
1322
-
1323
- *Returned Response:*
1324
-
1325
-
1326
-
1327
-
1328
- [VerifyEmailSuccess](#VerifyEmailSuccess)
1329
-
1330
- Success. Returns a success message. Refer `VerifyEmailSuccess` for more details.
1331
-
1332
-
1333
-
1334
-
1335
- <details>
1336
- <summary><i>&nbsp; Example:</i></summary>
1337
-
1338
- ```json
1339
- {
1340
- "message": "success"
1341
- }
1342
- ```
1343
- </details>
1344
-
1345
-
1346
-
1347
-
1348
-
1349
-
1350
-
1351
-
1352
-
1353
- ---
1354
-
1355
-
1356
- ### deleteUser
1357
- verify otp and delete user
1358
-
1359
-
1360
-
1361
- ```javascript
1362
- // Promise
1363
- const promise = user.deleteUser({ body : value });
1364
-
1365
- // Async/Await
1366
- const data = await user.deleteUser({ body : value });
1367
- ```
1368
-
1369
-
1370
-
1371
-
1372
-
1373
- | Argument | Type | Required | Description |
1374
- | --------- | ----- | -------- | ----------- |
1375
- | body | [DeleteApplicationUserRequestSchema](#DeleteApplicationUserRequestSchema) | yes | Request body |
1376
-
1377
-
1378
- verify otp and delete user
1379
-
1380
- *Returned Response:*
1381
-
1382
-
1383
-
1384
-
1385
- [DeleteUserSuccess](#DeleteUserSuccess)
1386
-
1387
- Success. Returns a success message. Refer `DeleteUserSuccess` for more details.
1388
-
1389
-
1390
-
1391
-
1392
- <details>
1393
- <summary><i>&nbsp; Example:</i></summary>
1394
-
1395
- ```json
1396
- {
1397
- "success": true
1398
- }
1399
- ```
1400
- </details>
1401
-
1402
-
1403
-
1404
-
1405
-
1406
-
1407
-
1408
-
1409
-
1410
- ---
1411
-
1412
-
1413
- ### logout
1414
- Logs out currently logged in user
1415
-
1416
-
1417
-
1418
- ```javascript
1419
- // Promise
1420
- const promise = user.logout();
1421
-
1422
- // Async/Await
1423
- const data = await user.logout();
1424
- ```
1425
-
1426
-
1427
-
1428
-
1429
-
1430
-
1431
- Use this API to check to logout a user from the app.
1432
-
1433
- *Returned Response:*
1434
-
1435
-
1436
-
1437
-
1438
- [LogoutSuccess](#LogoutSuccess)
1439
-
1440
- Success. Returns a success message as shown below. Refer `LogoutSuccess` for more details.
1441
-
1442
-
1443
-
1444
-
1445
- <details>
1446
- <summary><i>&nbsp; Example:</i></summary>
1447
-
1448
- ```json
1449
-
1450
- ```
1451
- </details>
1452
-
1453
-
1454
-
1455
-
1456
-
1457
-
1458
-
1459
-
1460
-
1461
- ---
1462
-
1463
-
1464
- ### sendOTPOnMobile
1465
- Send OTP on mobile
1466
-
1467
-
1468
-
1469
- ```javascript
1470
- // Promise
1471
- const promise = user.sendOTPOnMobile({ body : value,
1472
- platform : value });
1473
-
1474
- // Async/Await
1475
- const data = await user.sendOTPOnMobile({ body : value,
1476
- platform : value });
1477
- ```
1478
-
1479
-
1480
-
1481
-
1482
-
1483
- | Argument | Type | Required | Description |
1484
- | --------- | ----- | -------- | ----------- |
1485
- | platform | string | no | ID of the application |
1486
- | body | [SendMobileOtpRequestSchema](#SendMobileOtpRequestSchema) | yes | Request body |
1487
-
1488
-
1489
- Use this API to send an OTP to a mobile number.
1490
-
1491
- *Returned Response:*
1492
-
1493
-
1494
-
1495
-
1496
- [OtpSuccess](#OtpSuccess)
1497
-
1498
- Success. Returns a JSON object as shown below. Refer `OtpSuccess` for more details.
1499
-
1500
-
1501
-
1502
-
1503
- <details>
1504
- <summary><i>&nbsp; Example:</i></summary>
1505
-
1506
- ```json
1507
- {
1508
- "success": true,
1509
- "request_id": "01503005aeab87cbed93d40f46cc2749",
1510
- "message": "OTP sent",
1511
- "mobile": "8652523958",
1512
- "country_code": "91",
1513
- "resend_timer": 30,
1514
- "resend_token": "18fc3d60-66e5-11eb-9399-0312fbf2c2a6"
1515
- }
1516
- ```
1517
- </details>
1518
-
1519
-
1520
-
1521
-
1522
-
1523
-
1524
-
1525
-
1526
-
1527
- ---
1528
-
1529
-
1530
- ### verifyMobileOTP
1531
- Verify OTP on mobile
1532
-
1533
-
1534
-
1535
- ```javascript
1536
- // Promise
1537
- const promise = user.verifyMobileOTP({ body : value,
1538
- platform : value });
1539
-
1540
- // Async/Await
1541
- const data = await user.verifyMobileOTP({ body : value,
1542
- platform : value });
1543
- ```
1544
-
1545
-
1546
-
1547
-
1548
-
1549
- | Argument | Type | Required | Description |
1550
- | --------- | ----- | -------- | ----------- |
1551
- | platform | string | no | ID of the application |
1552
- | body | [VerifyOtpRequestSchema](#VerifyOtpRequestSchema) | yes | Request body |
1553
-
1554
-
1555
- Use this API to verify the OTP received on a mobile number.
1556
-
1557
- *Returned Response:*
1558
-
1559
-
1560
-
1561
-
1562
- [VerifyOtpSuccess](#VerifyOtpSuccess)
1563
-
1564
- Success. Returns a JSON object as shown below. Refer `VerifyOtpSuccess` for more details.
1565
-
1566
-
1567
-
1568
-
1569
- <details>
1570
- <summary><i>&nbsp; Examples:</i></summary>
1571
-
1572
-
1573
- <details>
1574
- <summary><i>&nbsp; default</i></summary>
1575
-
1576
- ```json
1577
- {
1578
- "value": {
1579
- "verify_mobile_link": true,
1580
- "user": {
1581
- "debug": {
1582
- "source": "deadlock",
1583
- "platform": "000000000000000000000001"
1584
- },
1585
- "gender": "male",
1586
- "account_type": "user",
1587
- "active": true,
1588
- "profile_pic_url": "https://d2co8r51m5ca2d.cloudfront.net/inapp_banners/default_profile_img.png",
1589
- "has_old_password_hash": false,
1590
- "_id": "5e68af49cfa09bf7233022f1",
1591
- "first_name": "Akash",
1592
- "last_name": "Mane",
1593
- "username": "akashmane_gofynd_com_10039",
1594
- "phone_numbers": [
1595
- {
1596
- "active": true,
1597
- "primary": true,
1598
- "verified": true,
1599
- "phone": "8652523958",
1600
- "country_code": 91
1601
- }
1602
- ],
1603
- "emails": [
1604
- {
1605
- "active": true,
1606
- "primary": true,
1607
- "verified": true,
1608
- "email": "akashmane@gofynd.com"
1609
- },
1610
- {
1611
- "active": true,
1612
- "primary": false,
1613
- "verified": true,
1614
- "email": "akashmane@fynd.com"
1615
- },
1616
- {
1617
- "active": true,
1618
- "primary": false,
1619
- "verified": true,
1620
- "email": "akashmane@uniket.store"
1621
- }
1622
- ],
1623
- "created_at": "2020-03-11T09:28:41.982Z",
1624
- "updated_at": "2021-02-04T10:10:44.981Z"
1625
- }
1626
- }
1627
- }
1628
- ```
1629
- </details>
1630
-
1631
- </details>
1632
-
1633
-
1634
-
1635
-
1636
-
1637
-
1638
-
1639
-
1640
-
1641
- ---
1642
-
1643
-
1644
- ### sendOTPOnEmail
1645
- Send OTP on email
1646
-
1647
-
1648
-
1649
- ```javascript
1650
- // Promise
1651
- const promise = user.sendOTPOnEmail({ body : value,
1652
- platform : value });
1653
-
1654
- // Async/Await
1655
- const data = await user.sendOTPOnEmail({ body : value,
1656
- platform : value });
1657
- ```
1658
-
1659
-
1660
-
1661
-
1662
-
1663
- | Argument | Type | Required | Description |
1664
- | --------- | ----- | -------- | ----------- |
1665
- | platform | string | no | ID of the application |
1666
- | body | [SendEmailOtpRequestSchema](#SendEmailOtpRequestSchema) | yes | Request body |
1667
-
1668
-
1669
- Use this API to send an OTP to an email ID.
1670
-
1671
- *Returned Response:*
1672
-
1673
-
1674
-
1675
-
1676
- [EmailOtpSuccess](#EmailOtpSuccess)
1677
-
1678
- Success. Returns a JSON object as shown below. Refer `EmailOtpSuccess` for more details.
1679
-
1680
-
1681
-
1682
-
1683
- <details>
1684
- <summary><i>&nbsp; Example:</i></summary>
1685
-
1686
- ```json
1687
- {
1688
- "success": true
1689
- }
1690
- ```
1691
- </details>
1692
-
1693
-
1694
-
1695
-
1696
-
1697
-
1698
-
1699
-
1700
-
1701
- ---
1702
-
1703
-
1704
- ### verifyEmailOTP
1705
- Verify OTP on email
1706
-
1707
-
1708
-
1709
- ```javascript
1710
- // Promise
1711
- const promise = user.verifyEmailOTP({ body : value,
1712
- platform : value });
1713
-
1714
- // Async/Await
1715
- const data = await user.verifyEmailOTP({ body : value,
1716
- platform : value });
1717
- ```
1718
-
1719
-
1720
-
1721
-
1722
-
1723
- | Argument | Type | Required | Description |
1724
- | --------- | ----- | -------- | ----------- |
1725
- | platform | string | no | ID of the application |
1726
- | body | [VerifyEmailOtpRequestSchema](#VerifyEmailOtpRequestSchema) | yes | Request body |
1727
-
1728
-
1729
- Use this API to verify the OTP received on an email ID.
1730
-
1731
- *Returned Response:*
1732
-
1733
-
1734
-
1735
-
1736
- [VerifyOtpSuccess](#VerifyOtpSuccess)
1737
-
1738
- Success. Returns a JSON object as shown below. Refer `VerifyOtpSuccess` for more details.
1739
-
1740
-
1741
-
1742
-
1743
- <details>
1744
- <summary><i>&nbsp; Examples:</i></summary>
1745
-
1746
-
1747
- <details>
1748
- <summary><i>&nbsp; default</i></summary>
1749
-
1750
- ```json
1751
- {
1752
- "value": {
1753
- "verify_mobile_link": true,
1754
- "user": {
1755
- "debug": {
1756
- "source": "deadlock",
1757
- "platform": "000000000000000000000001"
1758
- },
1759
- "gender": "male",
1760
- "account_type": "user",
1761
- "active": true,
1762
- "profile_pic_url": "https://d2co8r51m5ca2d.cloudfront.net/inapp_banners/default_profile_img.png",
1763
- "has_old_password_hash": false,
1764
- "_id": "5e68af49cfa09bf7233022f1",
1765
- "first_name": "Akash",
1766
- "last_name": "Mane",
1767
- "username": "akashmane_gofynd_com_10039",
1768
- "phone_numbers": [
1769
- {
1770
- "active": true,
1771
- "primary": true,
1772
- "verified": true,
1773
- "phone": "8652523958",
1774
- "country_code": 91
1775
- }
1776
- ],
1777
- "emails": [
1778
- {
1779
- "active": true,
1780
- "primary": true,
1781
- "verified": true,
1782
- "email": "akashmane@gofynd.com"
1783
- },
1784
- {
1785
- "active": true,
1786
- "primary": false,
1787
- "verified": true,
1788
- "email": "akashmane@fynd.com"
1789
- },
1790
- {
1791
- "active": true,
1792
- "primary": false,
1793
- "verified": true,
1794
- "email": "akashmane@uniket.store"
1795
- }
1796
- ],
1797
- "created_at": "2020-03-11T09:28:41.982Z",
1798
- "updated_at": "2021-02-04T10:10:44.981Z"
1799
- }
1800
- }
1801
- }
1802
- ```
1803
- </details>
1804
-
1805
- </details>
1806
-
1807
-
1808
-
1809
-
1810
-
1811
-
1812
-
1813
-
1814
-
1815
- ---
1816
-
1817
-
1818
- ### getLoggedInUser
1819
- Get logged in user
1820
-
1821
-
1822
-
1823
- ```javascript
1824
- // Promise
1825
- const promise = user.getLoggedInUser();
1826
-
1827
- // Async/Await
1828
- const data = await user.getLoggedInUser();
1829
- ```
1830
-
1831
-
1832
-
1833
-
1834
-
1835
-
1836
- Use this API to get the details of a logged in user.
1837
-
1838
- *Returned Response:*
1839
-
1840
-
1841
-
1842
-
1843
- [UserObjectSchema](#UserObjectSchema)
1844
-
1845
- Success. Returns a JSON object with user details. Refer `UserObjectSchema` for more details.
1846
-
1847
-
1848
-
1849
-
1850
- <details>
1851
- <summary><i>&nbsp; Examples:</i></summary>
1852
-
1853
-
1854
- <details>
1855
- <summary><i>&nbsp; default</i></summary>
1856
-
1857
- ```json
1858
- {
1859
- "value": {
1860
- "user": {
1861
- "debug": {
1862
- "source": "deadlock",
1863
- "platform": "000000000000000000000001"
1864
- },
1865
- "gender": "male",
1866
- "account_type": "user",
1867
- "active": true,
1868
- "profile_pic_url": "https://d2co8r51m5ca2d.cloudfront.net/inapp_banners/default_profile_img.png",
1869
- "has_old_password_hash": false,
1870
- "_id": "5e68af49cfa09bf7233022f1",
1871
- "first_name": "Akash",
1872
- "last_name": "Mane",
1873
- "username": "akashmane_gofynd_com_10039",
1874
- "phone_numbers": [
1875
- {
1876
- "active": true,
1877
- "primary": true,
1878
- "verified": true,
1879
- "phone": "8652523958",
1880
- "country_code": 91
1881
- }
1882
- ],
1883
- "emails": [
1884
- {
1885
- "active": true,
1886
- "primary": true,
1887
- "verified": true,
1888
- "email": "akashmane@gofynd.com"
1889
- },
1890
- {
1891
- "active": true,
1892
- "primary": false,
1893
- "verified": true,
1894
- "email": "akashmane@fynd.com"
1895
- },
1896
- {
1897
- "active": true,
1898
- "primary": false,
1899
- "verified": true,
1900
- "email": "akashmane@uniket.store"
1901
- }
1902
- ],
1903
- "created_at": "2020-03-11T09:28:41.982Z",
1904
- "updated_at": "2021-02-04T10:10:44.981Z"
1905
- }
1906
- }
1907
- }
1908
- ```
1909
- </details>
1910
-
1911
- </details>
1912
-
1913
-
1914
-
1915
-
1916
-
1917
-
1918
-
1919
-
1920
-
1921
- ---
1922
-
1923
-
1924
- ### getListOfActiveSessions
1925
- Get list of sessions
1926
-
1927
-
1928
-
1929
- ```javascript
1930
- // Promise
1931
- const promise = user.getListOfActiveSessions();
1932
-
1933
- // Async/Await
1934
- const data = await user.getListOfActiveSessions();
1935
- ```
1936
-
1937
-
1938
-
1939
-
1940
-
1941
-
1942
- Use this API to retrieve all active sessions of a user.
1943
-
1944
- *Returned Response:*
1945
-
1946
-
1947
-
1948
-
1949
- [SessionListSuccess](#SessionListSuccess)
1950
-
1951
- Success. Returns a JSON object containing an array of sessions. Refer `SessionListSuccess` for more details.
1952
-
1953
-
1954
-
1955
-
1956
- <details>
1957
- <summary><i>&nbsp; Example:</i></summary>
1958
-
1959
- ```json
1960
- {
1961
- "sessions": [
1962
- "session_1",
1963
- "session_2"
1964
- ]
1965
- }
1966
- ```
1967
- </details>
1968
-
1969
-
1970
-
1971
-
1972
-
1973
-
1974
-
1975
-
1976
-
1977
- ---
1978
-
1979
-
1980
- ### getPlatformConfig
1981
- Get platform configurations
1982
-
1983
-
1984
-
1985
- ```javascript
1986
- // Promise
1987
- const promise = user.getPlatformConfig({ name : value });
1988
-
1989
- // Async/Await
1990
- const data = await user.getPlatformConfig({ name : value });
1991
- ```
1992
-
1993
-
1994
-
1995
-
1996
-
1997
- | Argument | Type | Required | Description |
1998
- | --------- | ----- | -------- | ----------- |
1999
- | name | string | no | Name of the application, e.g. Fynd |
2000
-
2001
-
2002
-
2003
- Use this API to get all the platform configurations such as mobile image, desktop image, social logins, and all other text.
2004
-
2005
- *Returned Response:*
2006
-
2007
-
2008
-
2009
-
2010
- [PlatformSchema](#PlatformSchema)
2011
-
2012
- Success. Returns a JSON object containing the all the platform configurations. Refer `PlatformSchema` for more details.
2013
-
2014
-
2015
-
2016
-
2017
- <details>
2018
- <summary><i>&nbsp; Example:</i></summary>
2019
-
2020
- ```json
2021
- {
2022
- "active": true,
2023
- "mobile_image": null,
2024
- "desktop_image": null,
2025
- "social": {
2026
- "facebook": true,
2027
- "google": true,
2028
- "account_kit": true
2029
- },
2030
- "flash_card": {
2031
- "text": "",
2032
- "text_color": "#FFFFFF",
2033
- "background_color": "#EF5350"
2034
- },
2035
- "register": true,
2036
- "forgot_password": true,
2037
- "login": {
2038
- "password": true,
2039
- "otp": true
2040
- },
2041
- "skip_captcha": false,
2042
- "display": "Fynd",
2043
- "subtext": "Login to Fynd",
2044
- "name": "Fynd",
2045
- "meta": {},
2046
- "required_fields": {
2047
- "email": {
2048
- "is_required": false,
2049
- "level": "hard"
2050
- },
2051
- "mobile": {
2052
- "is_required": true,
2053
- "level": "hard"
2054
- }
2055
- },
2056
- "register_required_fields": {
2057
- "email": {
2058
- "is_required": false,
2059
- "level": "hard"
2060
- },
2061
- "mobile": {
2062
- "is_required": true,
2063
- "level": "hard"
2064
- }
2065
- },
2066
- "skip_login": false,
2067
- "look_and_feel": {
2068
- "background_color": "#F5F5F5",
2069
- "card_position": "center"
2070
- },
2071
- "social_tokens": {
2072
- "google": {
2073
- "appId": "token_123"
2074
- },
2075
- "facebook": {
2076
- "appId": "2033146826724884"
2077
- },
2078
- "account_kit": {
2079
- "appId": "548529975557631"
2080
- }
2081
- },
2082
- "delete_account_reasons": [
2083
- {
2084
- "reason_text": "test",
2085
- "reason_id": "123",
2086
- "show_text_area": true
2087
- }
2088
- ],
2089
- "delete_account_day": 7,
2090
- "delete_account_consent": {
2091
- "consent_text": ""
2092
- },
2093
- "session_config": {
2094
- "duration": "30",
2095
- "type": "Days",
2096
- "is_rolling": false
2097
- },
2098
- "_id": "5e04a5e5220bc15839ad9bc0",
2099
- "created_at": "2019-12-26T12:21:57.878Z",
2100
- "updated_at": "2020-08-13T14:31:09.878Z",
2101
- "__v": 0
2102
- }
2103
- ```
2104
- </details>
2105
-
2106
-
2107
-
2108
-
2109
-
2110
-
2111
-
2112
-
2113
-
2114
- ---
2115
-
2116
-
2117
- ### updateProfile
2118
- Edit Profile Details
2119
-
2120
-
2121
-
2122
- ```javascript
2123
- // Promise
2124
- const promise = user.updateProfile({ body : value,
2125
- platform : value });
2126
-
2127
- // Async/Await
2128
- const data = await user.updateProfile({ body : value,
2129
- platform : value });
2130
- ```
2131
-
2132
-
2133
-
2134
-
2135
-
2136
- | Argument | Type | Required | Description |
2137
- | --------- | ----- | -------- | ----------- |
2138
- | platform | string | no | ID of the application |
2139
- | body | [EditProfileRequestSchema](#EditProfileRequestSchema) | yes | Request body |
2140
-
2141
-
2142
- Use this API to update details in the user profile. Details can be first name, last name, gender, email, phone number, or profile picture.
2143
-
2144
- *Returned Response:*
2145
-
2146
-
2147
-
2148
-
2149
- [ProfileEditSuccess](#ProfileEditSuccess)
2150
-
2151
- Success. Check the example shown below or refer `LoginSuccess` for more details.
2152
-
2153
-
2154
-
2155
-
2156
- <details>
2157
- <summary><i>&nbsp; Examples:</i></summary>
2158
-
2159
-
2160
- <details>
2161
- <summary><i>&nbsp; default</i></summary>
2162
-
2163
- ```json
2164
- {
2165
- "value": {
2166
- "user": {
2167
- "debug": {
2168
- "source": "deadlock",
2169
- "platform": "000000000000000000000001"
2170
- },
2171
- "gender": "male",
2172
- "account_type": "user",
2173
- "active": true,
2174
- "profile_pic_url": "https://d2co8r51m5ca2d.cloudfront.net/inapp_banners/default_profile_img.png",
2175
- "has_old_password_hash": false,
2176
- "_id": "5e68af49cfa09bf7233022f1",
2177
- "first_name": "Akash",
2178
- "last_name": "Mane",
2179
- "username": "akashmane_gofynd_com_10039",
2180
- "phone_numbers": [
2181
- {
2182
- "active": true,
2183
- "primary": true,
2184
- "verified": true,
2185
- "phone": "8652523958",
2186
- "country_code": 91
2187
- }
2188
- ],
2189
- "emails": [
2190
- {
2191
- "active": true,
2192
- "primary": true,
2193
- "verified": true,
2194
- "email": "akashmane@gofynd.com"
2195
- },
2196
- {
2197
- "active": true,
2198
- "primary": false,
2199
- "verified": true,
2200
- "email": "akashmane@fynd.com"
2201
- },
2202
- {
2203
- "active": true,
2204
- "primary": false,
2205
- "verified": true,
2206
- "email": "akashmane@uniket.store"
2207
- }
2208
- ],
2209
- "created_at": "2020-03-11T09:28:41.982Z",
2210
- "updated_at": "2021-02-04T10:10:44.981Z"
2211
- }
2212
- }
2213
- }
2214
- ```
2215
- </details>
2216
-
2217
- </details>
2218
-
2219
-
2220
-
2221
-
2222
-
2223
-
2224
-
2225
-
2226
-
2227
- ---
2228
-
2229
-
2230
- ### addMobileNumber
2231
- Add mobile number to profile
2232
-
2233
-
2234
-
2235
- ```javascript
2236
- // Promise
2237
- const promise = user.addMobileNumber({ body : value,
2238
- platform : value });
2239
-
2240
- // Async/Await
2241
- const data = await user.addMobileNumber({ body : value,
2242
- platform : value });
2243
- ```
2244
-
2245
-
2246
-
2247
-
2248
-
2249
- | Argument | Type | Required | Description |
2250
- | --------- | ----- | -------- | ----------- |
2251
- | platform | string | no | ID of the application |
2252
- | body | [EditMobileRequestSchema](#EditMobileRequestSchema) | yes | Request body |
2253
-
2254
-
2255
- Use this API to add a new mobile number to a profile.
2256
-
2257
- *Returned Response:*
2258
-
2259
-
2260
-
2261
-
2262
- [VerifyMobileOTPSuccess](#VerifyMobileOTPSuccess)
2263
-
2264
- Success. Check the example shown below or refer `VerifyMobileOTPSuccess` for more details.
2265
-
2266
-
2267
-
2268
-
2269
- <details>
2270
- <summary><i>&nbsp; Examples:</i></summary>
2271
-
2272
-
2273
- <details>
2274
- <summary><i>&nbsp; default</i></summary>
2275
-
2276
- ```json
2277
- {
2278
- "value": {
2279
- "verify_mobile_link": true,
2280
- "user": {
2281
- "debug": {
2282
- "source": "deadlock",
2283
- "platform": "000000000000000000000001"
2284
- },
2285
- "gender": "male",
2286
- "account_type": "user",
2287
- "active": true,
2288
- "profile_pic_url": "https://d2co8r51m5ca2d.cloudfront.net/inapp_banners/default_profile_img.png",
2289
- "has_old_password_hash": false,
2290
- "_id": "5e68af49cfa09bf7233022f1",
2291
- "first_name": "Akash",
2292
- "last_name": "Mane",
2293
- "username": "akashmane_gofynd_com_10039",
2294
- "phone_numbers": [
2295
- {
2296
- "active": true,
2297
- "primary": true,
2298
- "verified": true,
2299
- "phone": "8652523958",
2300
- "country_code": 91
2301
- }
2302
- ],
2303
- "emails": [
2304
- {
2305
- "active": true,
2306
- "primary": true,
2307
- "verified": true,
2308
- "email": "akashmane@gofynd.com"
2309
- },
2310
- {
2311
- "active": true,
2312
- "primary": false,
2313
- "verified": true,
2314
- "email": "akashmane@fynd.com"
2315
- },
2316
- {
2317
- "active": true,
2318
- "primary": false,
2319
- "verified": true,
2320
- "email": "akashmane@uniket.store"
2321
- }
2322
- ],
2323
- "created_at": "2020-03-11T09:28:41.982Z",
2324
- "updated_at": "2021-02-04T10:10:44.981Z"
2325
- }
2326
- }
2327
- }
2328
- ```
2329
- </details>
2330
-
2331
- </details>
2332
-
2333
-
2334
-
2335
-
2336
-
2337
-
2338
-
2339
-
2340
-
2341
- ---
2342
-
2343
-
2344
- ### deleteMobileNumber
2345
- Delete mobile number from profile
2346
-
2347
-
2348
-
2349
- ```javascript
2350
- // Promise
2351
- const promise = user.deleteMobileNumber({ active : value,
2352
- primary : value,
2353
- verified : value,
2354
- countryCode : value,
2355
- phone : value,
2356
- platform : value });
2357
-
2358
- // Async/Await
2359
- const data = await user.deleteMobileNumber({ active : value,
2360
- primary : value,
2361
- verified : value,
2362
- countryCode : value,
2363
- phone : value,
2364
- platform : value });
2365
- ```
2366
-
2367
-
2368
-
2369
-
2370
-
2371
- | Argument | Type | Required | Description |
2372
- | --------- | ----- | -------- | ----------- |
2373
- | platform | string | no | ID of the application |
2374
- | active | boolean | yes | This is a boolean value to check if mobile number is active 1.True - Number is active 2. False - Number is inactive |
2375
- | primary | boolean | yes | This is a boolean value to check if mobile number is primary number (main number) 1. True - Number is primary 2. False - Number is not primary |
2376
- | verified | boolean | yes | This is a boolean value to check if mobile number is verified 1. True - Number is verified 2.False - Number is not verified yet |
2377
- | countryCode | string | yes | Country code of the phone number, e.g. 91 |
2378
- | phone | string | yes | Phone number |
2379
-
2380
-
2381
-
2382
- Use this API to delete a mobile number from a profile.
2383
-
2384
- *Returned Response:*
2385
-
2386
-
2387
-
2388
-
2389
- [LoginSuccess](#LoginSuccess)
2390
-
2391
- Success. Check the example shown below or refer `LoginSuccess` for more details.
2392
-
2393
-
2394
-
2395
-
2396
- <details>
2397
- <summary><i>&nbsp; Examples:</i></summary>
2398
-
2399
-
2400
- <details>
2401
- <summary><i>&nbsp; default</i></summary>
2402
-
2403
- ```json
2404
- {
2405
- "value": {
2406
- "user": {
2407
- "debug": {
2408
- "source": "deadlock",
2409
- "platform": "000000000000000000000001"
2410
- },
2411
- "gender": "male",
2412
- "account_type": "user",
2413
- "active": true,
2414
- "profile_pic_url": "https://d2co8r51m5ca2d.cloudfront.net/inapp_banners/default_profile_img.png",
2415
- "has_old_password_hash": false,
2416
- "_id": "5e68af49cfa09bf7233022f1",
2417
- "first_name": "Akash",
2418
- "last_name": "Mane",
2419
- "username": "akashmane_gofynd_com_10039",
2420
- "phone_numbers": [
2421
- {
2422
- "active": true,
2423
- "primary": true,
2424
- "verified": true,
2425
- "phone": "8652523958",
2426
- "country_code": 91
2427
- }
2428
- ],
2429
- "emails": [
2430
- {
2431
- "active": true,
2432
- "primary": true,
2433
- "verified": true,
2434
- "email": "akashmane@gofynd.com"
2435
- },
2436
- {
2437
- "active": true,
2438
- "primary": false,
2439
- "verified": true,
2440
- "email": "akashmane@fynd.com"
2441
- },
2442
- {
2443
- "active": true,
2444
- "primary": false,
2445
- "verified": true,
2446
- "email": "akashmane@uniket.store"
2447
- }
2448
- ],
2449
- "created_at": "2020-03-11T09:28:41.982Z",
2450
- "updated_at": "2021-02-04T10:10:44.981Z"
2451
- }
2452
- }
2453
- }
2454
- ```
2455
- </details>
2456
-
2457
- </details>
2458
-
2459
-
2460
-
2461
-
2462
-
2463
-
2464
-
2465
-
2466
-
2467
- ---
2468
-
2469
-
2470
- ### setMobileNumberAsPrimary
2471
- Set mobile as primary
2472
-
2473
-
2474
-
2475
- ```javascript
2476
- // Promise
2477
- const promise = user.setMobileNumberAsPrimary({ body : value });
2478
-
2479
- // Async/Await
2480
- const data = await user.setMobileNumberAsPrimary({ body : value });
2481
- ```
2482
-
2483
-
2484
-
2485
-
2486
-
2487
- | Argument | Type | Required | Description |
2488
- | --------- | ----- | -------- | ----------- |
2489
- | body | [SendVerificationLinkMobileRequestSchema](#SendVerificationLinkMobileRequestSchema) | yes | Request body |
2490
-
2491
-
2492
- Use this API to set a mobile number as primary. Primary number is a verified number used for all future communications.
2493
-
2494
- *Returned Response:*
2495
-
2496
-
2497
-
2498
-
2499
- [LoginSuccess](#LoginSuccess)
2500
-
2501
- Success. Check the example shown below or refer `LoginSuccess` for more details.
2502
-
2503
-
2504
-
2505
-
2506
- <details>
2507
- <summary><i>&nbsp; Examples:</i></summary>
2508
-
2509
-
2510
- <details>
2511
- <summary><i>&nbsp; default</i></summary>
2512
-
2513
- ```json
2514
- {
2515
- "value": {
2516
- "user": {
2517
- "debug": {
2518
- "source": "deadlock",
2519
- "platform": "000000000000000000000001"
2520
- },
2521
- "gender": "male",
2522
- "account_type": "user",
2523
- "active": true,
2524
- "profile_pic_url": "https://d2co8r51m5ca2d.cloudfront.net/inapp_banners/default_profile_img.png",
2525
- "has_old_password_hash": false,
2526
- "_id": "5e68af49cfa09bf7233022f1",
2527
- "first_name": "Akash",
2528
- "last_name": "Mane",
2529
- "username": "akashmane_gofynd_com_10039",
2530
- "phone_numbers": [
2531
- {
2532
- "active": true,
2533
- "primary": true,
2534
- "verified": true,
2535
- "phone": "8652523958",
2536
- "country_code": 91
2537
- }
2538
- ],
2539
- "emails": [
2540
- {
2541
- "active": true,
2542
- "primary": true,
2543
- "verified": true,
2544
- "email": "akashmane@gofynd.com"
2545
- },
2546
- {
2547
- "active": true,
2548
- "primary": false,
2549
- "verified": true,
2550
- "email": "akashmane@fynd.com"
2551
- },
2552
- {
2553
- "active": true,
2554
- "primary": false,
2555
- "verified": true,
2556
- "email": "akashmane@uniket.store"
2557
- }
2558
- ],
2559
- "created_at": "2020-03-11T09:28:41.982Z",
2560
- "updated_at": "2021-02-04T10:10:44.981Z"
2561
- }
2562
- }
2563
- }
2564
- ```
2565
- </details>
2566
-
2567
- </details>
2568
-
2569
-
2570
-
2571
-
2572
-
2573
-
2574
-
2575
-
2576
-
2577
- ---
2578
-
2579
-
2580
- ### sendVerificationLinkToMobile
2581
- Send verification link to mobile
2582
-
2583
-
2584
-
2585
- ```javascript
2586
- // Promise
2587
- const promise = user.sendVerificationLinkToMobile({ body : value,
2588
- platform : value });
2589
-
2590
- // Async/Await
2591
- const data = await user.sendVerificationLinkToMobile({ body : value,
2592
- platform : value });
2593
- ```
2594
-
2595
-
2596
-
2597
-
2598
-
2599
- | Argument | Type | Required | Description |
2600
- | --------- | ----- | -------- | ----------- |
2601
- | platform | string | no | ID of the application |
2602
- | body | [SendVerificationLinkMobileRequestSchema](#SendVerificationLinkMobileRequestSchema) | yes | Request body |
2603
-
2604
-
2605
- Use this API to send a verification link to a mobile number
2606
-
2607
- *Returned Response:*
2608
-
2609
-
2610
-
2611
-
2612
- [SendMobileVerifyLinkSuccess](#SendMobileVerifyLinkSuccess)
2613
-
2614
- Success. Check the example shown below or refer `SendMobileVerifyLinkSuccess` for more details.
2615
-
2616
-
2617
-
2618
-
2619
- <details>
2620
- <summary><i>&nbsp; Examples:</i></summary>
2621
-
2622
-
2623
- <details>
2624
- <summary><i>&nbsp; default</i></summary>
2625
-
2626
- ```json
2627
- {
2628
- "value": {
2629
- "verify_mobile_link": true,
2630
- "user": {
2631
- "debug": {
2632
- "source": "deadlock",
2633
- "platform": "000000000000000000000001"
2634
- },
2635
- "gender": "male",
2636
- "account_type": "user",
2637
- "active": true,
2638
- "profile_pic_url": "https://d2co8r51m5ca2d.cloudfront.net/inapp_banners/default_profile_img.png",
2639
- "has_old_password_hash": false,
2640
- "_id": "5e68af49cfa09bf7233022f1",
2641
- "first_name": "Akash",
2642
- "last_name": "Mane",
2643
- "username": "akashmane_gofynd_com_10039",
2644
- "phone_numbers": [
2645
- {
2646
- "active": true,
2647
- "primary": true,
2648
- "verified": true,
2649
- "phone": "8652523958",
2650
- "country_code": 91
2651
- }
2652
- ],
2653
- "emails": [
2654
- {
2655
- "active": true,
2656
- "primary": true,
2657
- "verified": true,
2658
- "email": "akashmane@gofynd.com"
2659
- },
2660
- {
2661
- "active": true,
2662
- "primary": false,
2663
- "verified": true,
2664
- "email": "akashmane@fynd.com"
2665
- },
2666
- {
2667
- "active": true,
2668
- "primary": false,
2669
- "verified": true,
2670
- "email": "akashmane@uniket.store"
2671
- }
2672
- ],
2673
- "created_at": "2020-03-11T09:28:41.982Z",
2674
- "updated_at": "2021-02-04T10:10:44.981Z"
2675
- }
2676
- }
2677
- }
2678
- ```
2679
- </details>
2680
-
2681
- </details>
2682
-
2683
-
2684
-
2685
-
2686
-
2687
-
2688
-
2689
-
2690
-
2691
- ---
2692
-
2693
-
2694
- ### addEmail
2695
- Add email to profile
2696
-
2697
-
2698
-
2699
- ```javascript
2700
- // Promise
2701
- const promise = user.addEmail({ body : value,
2702
- platform : value });
2703
-
2704
- // Async/Await
2705
- const data = await user.addEmail({ body : value,
2706
- platform : value });
2707
- ```
2708
-
2709
-
2710
-
2711
-
2712
-
2713
- | Argument | Type | Required | Description |
2714
- | --------- | ----- | -------- | ----------- |
2715
- | platform | string | no | ID of the application |
2716
- | body | [EditEmailRequestSchema](#EditEmailRequestSchema) | yes | Request body |
2717
-
2718
-
2719
- Use this API to add a new email address to a profile
2720
-
2721
- *Returned Response:*
2722
-
2723
-
2724
-
2725
-
2726
- [VerifyEmailOTPSuccess](#VerifyEmailOTPSuccess)
2727
-
2728
- Success. Returns a JSON object with user details. Refer `VerifyEmailOTPSuccess` for more details.
2729
-
2730
-
2731
-
2732
-
2733
- <details>
2734
- <summary><i>&nbsp; Examples:</i></summary>
2735
-
2736
-
2737
- <details>
2738
- <summary><i>&nbsp; default</i></summary>
2739
-
2740
- ```json
2741
- {
2742
- "value": {
2743
- "verify_email_link": true,
2744
- "user": {
2745
- "debug": {
2746
- "source": "deadlock",
2747
- "platform": "000000000000000000000001"
2748
- },
2749
- "gender": "male",
2750
- "account_type": "user",
2751
- "active": true,
2752
- "profile_pic_url": "https://d2co8r51m5ca2d.cloudfront.net/inapp_banners/default_profile_img.png",
2753
- "has_old_password_hash": false,
2754
- "_id": "5e68af49cfa09bf7233022f1",
2755
- "first_name": "Akash",
2756
- "last_name": "Mane",
2757
- "username": "akashmane_gofynd_com_10039",
2758
- "phone_numbers": [
2759
- {
2760
- "active": true,
2761
- "primary": true,
2762
- "verified": true,
2763
- "phone": "8652523958",
2764
- "country_code": 91
2765
- }
2766
- ],
2767
- "emails": [
2768
- {
2769
- "active": true,
2770
- "primary": true,
2771
- "verified": true,
2772
- "email": "akashmane@gofynd.com"
2773
- },
2774
- {
2775
- "active": true,
2776
- "primary": false,
2777
- "verified": true,
2778
- "email": "akashmane@fynd.com"
2779
- },
2780
- {
2781
- "active": true,
2782
- "primary": false,
2783
- "verified": true,
2784
- "email": "akashmane@uniket.store"
2785
- }
2786
- ],
2787
- "created_at": "2020-03-11T09:28:41.982Z",
2788
- "updated_at": "2021-02-04T10:10:44.981Z"
2789
- }
2790
- }
2791
- }
2792
- ```
2793
- </details>
2794
-
2795
- </details>
2796
-
2797
-
2798
-
2799
-
2800
-
2801
-
2802
-
2803
-
2804
-
2805
- ---
2806
-
2807
-
2808
- ### deleteEmail
2809
- Delete email from profile
2810
-
2811
-
2812
-
2813
- ```javascript
2814
- // Promise
2815
- const promise = user.deleteEmail({ active : value,
2816
- primary : value,
2817
- verified : value,
2818
- email : value,
2819
- platform : value });
2820
-
2821
- // Async/Await
2822
- const data = await user.deleteEmail({ active : value,
2823
- primary : value,
2824
- verified : value,
2825
- email : value,
2826
- platform : value });
2827
- ```
2828
-
2829
-
2830
-
2831
-
2832
-
2833
- | Argument | Type | Required | Description |
2834
- | --------- | ----- | -------- | ----------- |
2835
- | platform | string | no | ID of the application |
2836
- | active | boolean | yes | This is a boolean value to check if email ID is active 1. True - Email ID is active 2.False - Email ID is inactive |
2837
- | primary | boolean | yes | This is a boolean value to check if email ID is primary (main email ID) 1. True - Email ID is primary 2.False - Email ID is not primary |
2838
- | verified | boolean | yes | This is a boolean value to check if email ID is verified 1. True - Email ID is verified 2.False - Email ID is not verified yet |
2839
- | email | string | yes | The email ID to delete |
2840
-
2841
-
2842
-
2843
- Use this API to delete an email address from a profile
2844
-
2845
- *Returned Response:*
2846
-
2847
-
2848
-
2849
-
2850
- [LoginSuccess](#LoginSuccess)
2851
-
2852
- Success. Returns a JSON object with user details. Refer `LoginSuccess` for more details.
2853
-
2854
-
2855
-
2856
-
2857
- <details>
2858
- <summary><i>&nbsp; Examples:</i></summary>
2859
-
2860
-
2861
- <details>
2862
- <summary><i>&nbsp; default</i></summary>
2863
-
2864
- ```json
2865
- {
2866
- "value": {
2867
- "user": {
2868
- "debug": {
2869
- "source": "deadlock",
2870
- "platform": "000000000000000000000001"
2871
- },
2872
- "gender": "male",
2873
- "account_type": "user",
2874
- "active": true,
2875
- "profile_pic_url": "https://d2co8r51m5ca2d.cloudfront.net/inapp_banners/default_profile_img.png",
2876
- "has_old_password_hash": false,
2877
- "_id": "5e68af49cfa09bf7233022f1",
2878
- "first_name": "Akash",
2879
- "last_name": "Mane",
2880
- "username": "akashmane_gofynd_com_10039",
2881
- "phone_numbers": [
2882
- {
2883
- "active": true,
2884
- "primary": true,
2885
- "verified": true,
2886
- "phone": "8652523958",
2887
- "country_code": 91
2888
- }
2889
- ],
2890
- "emails": [
2891
- {
2892
- "active": true,
2893
- "primary": true,
2894
- "verified": true,
2895
- "email": "akashmane@gofynd.com"
2896
- },
2897
- {
2898
- "active": true,
2899
- "primary": false,
2900
- "verified": true,
2901
- "email": "akashmane@fynd.com"
2902
- },
2903
- {
2904
- "active": true,
2905
- "primary": false,
2906
- "verified": true,
2907
- "email": "akashmane@uniket.store"
2908
- }
2909
- ],
2910
- "created_at": "2020-03-11T09:28:41.982Z",
2911
- "updated_at": "2021-02-04T10:10:44.981Z"
2912
- }
2913
- }
2914
- }
2915
- ```
2916
- </details>
2917
-
2918
- </details>
2919
-
2920
-
2921
-
2922
-
2923
-
2924
-
2925
-
2926
-
2927
-
2928
- ---
2929
-
2930
-
2931
- ### setEmailAsPrimary
2932
- Set email as primary
2933
-
2934
-
2935
-
2936
- ```javascript
2937
- // Promise
2938
- const promise = user.setEmailAsPrimary({ body : value });
2939
-
2940
- // Async/Await
2941
- const data = await user.setEmailAsPrimary({ body : value });
2942
- ```
2943
-
2944
-
2945
-
2946
-
2947
-
2948
- | Argument | Type | Required | Description |
2949
- | --------- | ----- | -------- | ----------- |
2950
- | body | [EditEmailRequestSchema](#EditEmailRequestSchema) | yes | Request body |
2951
-
2952
-
2953
- Use this API to set an email address as primary. Primary email ID is a email address used for all future communications.
2954
-
2955
- *Returned Response:*
2956
-
2957
-
2958
-
2959
-
2960
- [LoginSuccess](#LoginSuccess)
2961
-
2962
- Success. Returns a JSON object with user details. Refer `LoginSuccess` for more details.
2963
-
2964
-
2965
-
2966
-
2967
- <details>
2968
- <summary><i>&nbsp; Examples:</i></summary>
2969
-
2970
-
2971
- <details>
2972
- <summary><i>&nbsp; default</i></summary>
2973
-
2974
- ```json
2975
- {
2976
- "value": {
2977
- "user": {
2978
- "debug": {
2979
- "source": "deadlock",
2980
- "platform": "000000000000000000000001"
2981
- },
2982
- "gender": "male",
2983
- "account_type": "user",
2984
- "active": true,
2985
- "profile_pic_url": "https://d2co8r51m5ca2d.cloudfront.net/inapp_banners/default_profile_img.png",
2986
- "has_old_password_hash": false,
2987
- "_id": "5e68af49cfa09bf7233022f1",
2988
- "first_name": "Akash",
2989
- "last_name": "Mane",
2990
- "username": "akashmane_gofynd_com_10039",
2991
- "phone_numbers": [
2992
- {
2993
- "active": true,
2994
- "primary": true,
2995
- "verified": true,
2996
- "phone": "8652523958",
2997
- "country_code": 91
2998
- }
2999
- ],
3000
- "emails": [
3001
- {
3002
- "active": true,
3003
- "primary": true,
3004
- "verified": true,
3005
- "email": "akashmane@gofynd.com"
3006
- },
3007
- {
3008
- "active": true,
3009
- "primary": false,
3010
- "verified": true,
3011
- "email": "akashmane@fynd.com"
3012
- },
3013
- {
3014
- "active": true,
3015
- "primary": false,
3016
- "verified": true,
3017
- "email": "akashmane@uniket.store"
3018
- }
3019
- ],
3020
- "created_at": "2020-03-11T09:28:41.982Z",
3021
- "updated_at": "2021-02-04T10:10:44.981Z"
3022
- }
3023
- }
3024
- }
3025
- ```
3026
- </details>
3027
-
3028
- </details>
3029
-
3030
-
3031
-
3032
-
3033
-
3034
-
3035
-
3036
-
3037
-
3038
- ---
3039
-
3040
-
3041
- ### sendVerificationLinkToEmail
3042
- Send verification link to email
3043
-
3044
-
3045
-
3046
- ```javascript
3047
- // Promise
3048
- const promise = user.sendVerificationLinkToEmail({ body : value,
3049
- platform : value });
3050
-
3051
- // Async/Await
3052
- const data = await user.sendVerificationLinkToEmail({ body : value,
3053
- platform : value });
3054
- ```
3055
-
3056
-
3057
-
3058
-
3059
-
3060
- | Argument | Type | Required | Description |
3061
- | --------- | ----- | -------- | ----------- |
3062
- | platform | string | no | ID of the application |
3063
- | body | [EditEmailRequestSchema](#EditEmailRequestSchema) | yes | Request body |
3064
-
3065
-
3066
- Use this API to send verification link to an email address.
3067
-
3068
- *Returned Response:*
3069
-
3070
-
3071
-
3072
-
3073
- [SendEmailVerifyLinkSuccess](#SendEmailVerifyLinkSuccess)
3074
-
3075
- Request body must contain an email ID. Refer `EditEmailRequestSchema` for more details.
3076
-
3077
-
3078
-
3079
-
3080
- <details>
3081
- <summary><i>&nbsp; Example:</i></summary>
3082
-
3083
- ```json
3084
-
3085
- ```
3086
- </details>
3087
-
3088
-
3089
-
3090
-
3091
-
3092
-
3093
-
3094
-
3095
-
3096
- ---
3097
-
3098
-
3099
-
3100
- ### Schemas
3101
-
3102
-
3103
-
3104
- #### [BlockUserRequestSchema](#BlockUserRequestSchema)
3105
-
3106
- | Properties | Type | Nullable | Description |
3107
- | ---------- | ---- | -------- | ----------- |
3108
- | status | boolean | no | |
3109
- | user_id | [string] | no | |
3110
- | reason | string | no | |
3111
-
3112
- ---
3113
-
3114
-
3115
-
3116
-
3117
- #### [ArchiveUserRequestSchema](#ArchiveUserRequestSchema)
3118
-
3119
- | Properties | Type | Nullable | Description |
3120
- | ---------- | ---- | -------- | ----------- |
3121
- | user_id | string | no | |
3122
-
3123
- ---
3124
-
3125
-
3126
-
3127
-
3128
- #### [DeleteApplicationUserRequestSchema](#DeleteApplicationUserRequestSchema)
3129
-
3130
- | Properties | Type | Nullable | Description |
3131
- | ---------- | ---- | -------- | ----------- |
3132
- | user_id | string | no | |
3133
- | reason | string | no | |
3134
- | reason_id | string | no | |
3135
- | request_id | string | no | |
3136
- | otp | string | no | |
3137
-
3138
- ---
3139
-
3140
-
3141
-
3142
-
3143
- #### [UnDeleteUserRequestSchema](#UnDeleteUserRequestSchema)
3144
-
3145
- | Properties | Type | Nullable | Description |
3146
- | ---------- | ---- | -------- | ----------- |
3147
- | user_id | string | no | |
3148
- | reason | string | no | |
3149
- | reason_id | string | no | |
3150
-
3151
- ---
3152
-
3153
-
3154
-
3155
-
3156
- #### [EditEmailRequestSchema](#EditEmailRequestSchema)
3157
-
3158
- | Properties | Type | Nullable | Description |
3159
- | ---------- | ---- | -------- | ----------- |
3160
- | email | string | no | |
3161
-
3162
- ---
3163
-
3164
-
3165
-
3166
-
3167
- #### [SendVerificationLinkMobileRequestSchema](#SendVerificationLinkMobileRequestSchema)
3168
-
3169
- | Properties | Type | Nullable | Description |
3170
- | ---------- | ---- | -------- | ----------- |
3171
- | verified | boolean | no | |
3172
- | active | boolean | no | |
3173
- | country_code | string | no | |
3174
- | phone | string | no | |
3175
- | primary | boolean | no | |
3176
-
3177
- ---
3178
-
3179
-
3180
-
3181
-
3182
- #### [EditMobileRequestSchema](#EditMobileRequestSchema)
3183
-
3184
- | Properties | Type | Nullable | Description |
3185
- | ---------- | ---- | -------- | ----------- |
3186
- | country_code | string | no | |
3187
- | phone | string | no | |
3188
-
3189
- ---
3190
-
3191
-
3192
-
3193
-
3194
- #### [EditProfileRequestSchema](#EditProfileRequestSchema)
3195
-
3196
- | Properties | Type | Nullable | Description |
3197
- | ---------- | ---- | -------- | ----------- |
3198
- | first_name | string | no | |
3199
- | last_name | string | no | |
3200
- | mobile | [EditProfileMobileSchema](#EditProfileMobileSchema) | no | |
3201
- | country_code | string | no | |
3202
- | email | string | no | |
3203
- | gender | string | no | |
3204
- | dob | string | no | |
3205
- | profile_pic_url | string | no | |
3206
- | android_hash | string | no | |
3207
- | sender | string | no | |
3208
- | register_token | string | no | |
3209
-
3210
- ---
3211
-
3212
-
3213
-
3214
-
3215
- #### [EditProfileMobileSchema](#EditProfileMobileSchema)
3216
-
3217
- | Properties | Type | Nullable | Description |
3218
- | ---------- | ---- | -------- | ----------- |
3219
- | phone | string | no | |
3220
- | country_code | string | no | |
3221
-
3222
- ---
3223
-
3224
-
3225
-
3226
-
3227
- #### [SendEmailOtpRequestSchema](#SendEmailOtpRequestSchema)
3228
-
3229
- | Properties | Type | Nullable | Description |
3230
- | ---------- | ---- | -------- | ----------- |
3231
- | email | string | no | |
3232
- | action | string | no | |
3233
- | token | string | no | |
3234
- | register_token | string | no | |
3235
-
3236
- ---
3237
-
3238
-
3239
-
3240
-
3241
- #### [VerifyEmailOtpRequestSchema](#VerifyEmailOtpRequestSchema)
3242
-
3243
- | Properties | Type | Nullable | Description |
3244
- | ---------- | ---- | -------- | ----------- |
3245
- | email | string | no | |
3246
- | action | string | no | |
3247
- | register_token | string | no | |
3248
- | otp | string | no | |
3249
-
3250
- ---
3251
-
3252
-
3253
-
3254
-
3255
- #### [VerifyOtpRequestSchema](#VerifyOtpRequestSchema)
3256
-
3257
- | Properties | Type | Nullable | Description |
3258
- | ---------- | ---- | -------- | ----------- |
3259
- | request_id | string | no | |
3260
- | register_token | string | no | |
3261
- | otp | string | no | |
3262
-
3263
- ---
3264
-
3265
-
3266
-
3267
-
3268
- #### [SendMobileOtpRequestSchema](#SendMobileOtpRequestSchema)
3269
-
3270
- | Properties | Type | Nullable | Description |
3271
- | ---------- | ---- | -------- | ----------- |
3272
- | mobile | string | no | |
3273
- | country_code | string | no | |
3274
- | action | string | no | |
3275
- | token | string | no | |
3276
- | android_hash | string | no | |
3277
- | force | string | no | |
3278
- | captcha_code | string | no | |
3279
-
3280
- ---
3281
-
3282
-
3283
-
3284
-
3285
- #### [UpdatePasswordRequestSchema](#UpdatePasswordRequestSchema)
3286
-
3287
- | Properties | Type | Nullable | Description |
3288
- | ---------- | ---- | -------- | ----------- |
3289
- | old_password | string | no | |
3290
- | new_password | string | no | |
3291
-
3292
- ---
3293
-
3294
-
3295
-
3296
-
3297
- #### [FormRegisterRequestSchema](#FormRegisterRequestSchema)
3298
-
3299
- | Properties | Type | Nullable | Description |
3300
- | ---------- | ---- | -------- | ----------- |
3301
- | first_name | string | no | |
3302
- | last_name | string | no | |
3303
- | gender | string | no | |
3304
- | email | string | no | |
3305
- | password | string | no | |
3306
- | phone | [FormRegisterRequestSchemaPhone](#FormRegisterRequestSchemaPhone) | no | |
3307
- | register_token | string | no | |
3308
-
3309
- ---
3310
-
3311
-
3312
-
3313
-
3314
- #### [TokenRequestBodySchema](#TokenRequestBodySchema)
3315
-
3316
- | Properties | Type | Nullable | Description |
3317
- | ---------- | ---- | -------- | ----------- |
3318
- | token | string | no | |
3319
-
3320
- ---
3321
-
3322
-
3323
-
3324
-
3325
- #### [ForgotPasswordRequestSchema](#ForgotPasswordRequestSchema)
3326
-
3327
- | Properties | Type | Nullable | Description |
3328
- | ---------- | ---- | -------- | ----------- |
3329
- | code | string | no | |
3330
- | password | string | no | |
3331
-
3332
- ---
3333
-
3334
-
3335
-
3336
-
3337
- #### [CodeRequestBodySchema](#CodeRequestBodySchema)
3338
-
3339
- | Properties | Type | Nullable | Description |
3340
- | ---------- | ---- | -------- | ----------- |
3341
- | code | string | no | |
3342
-
3343
- ---
3344
-
3345
-
3346
-
3347
-
3348
- #### [SendResetPasswordEmailRequestSchema](#SendResetPasswordEmailRequestSchema)
3349
-
3350
- | Properties | Type | Nullable | Description |
3351
- | ---------- | ---- | -------- | ----------- |
3352
- | email | string | no | |
3353
- | captcha_code | string | no | |
3354
-
3355
- ---
3356
-
3357
-
3358
-
3359
-
3360
- #### [SendResetPasswordMobileRequestSchema](#SendResetPasswordMobileRequestSchema)
3361
-
3362
- | Properties | Type | Nullable | Description |
3363
- | ---------- | ---- | -------- | ----------- |
3364
- | country_code | string | no | |
3365
- | mobile | string | no | |
3366
- | captcha_code | string | no | |
3367
-
3368
- ---
3369
-
3370
-
3371
-
3372
-
3373
- #### [PasswordLoginRequestSchema](#PasswordLoginRequestSchema)
3374
-
3375
- | Properties | Type | Nullable | Description |
3376
- | ---------- | ---- | -------- | ----------- |
3377
- | captcha_code | string | no | |
3378
- | password | string | no | |
3379
- | username | string | no | |
3380
-
3381
- ---
3382
-
3383
-
3384
-
3385
-
3386
- #### [SendOtpRequestSchema](#SendOtpRequestSchema)
3387
-
3388
- | Properties | Type | Nullable | Description |
3389
- | ---------- | ---- | -------- | ----------- |
3390
- | country_code | string | no | |
3391
- | captcha_code | string | no | |
3392
- | mobile | string | no | |
3393
- | android_hash | string | no | |
3394
-
3395
- ---
3396
-
3397
-
3398
-
3399
-
3400
- #### [OAuthRequestSchema](#OAuthRequestSchema)
3401
-
3402
- | Properties | Type | Nullable | Description |
3403
- | ---------- | ---- | -------- | ----------- |
3404
- | is_signed_in | boolean | no | |
3405
- | oauth2 | [OAuthRequestSchemaOauth2](#OAuthRequestSchemaOauth2) | no | |
3406
- | profile | [OAuthRequestSchemaProfile](#OAuthRequestSchemaProfile) | no | |
3407
-
3408
- ---
3409
-
3410
-
3411
-
3412
-
3413
- #### [OAuthRequestAppleSchema](#OAuthRequestAppleSchema)
3414
-
3415
- | Properties | Type | Nullable | Description |
3416
- | ---------- | ---- | -------- | ----------- |
3417
- | user_identifier | string | no | |
3418
- | oauth | [OAuthRequestAppleSchemaOauth](#OAuthRequestAppleSchemaOauth) | no | |
3419
- | profile | [OAuthRequestAppleSchemaProfile](#OAuthRequestAppleSchemaProfile) | no | |
3420
-
3421
- ---
3422
-
3423
-
3424
-
3425
-
3426
- #### [UserObjectSchema](#UserObjectSchema)
3427
-
3428
- | Properties | Type | Nullable | Description |
3429
- | ---------- | ---- | -------- | ----------- |
3430
- | user | [UserSchema](#UserSchema) | no | |
3431
-
3432
- ---
3433
-
3434
-
3435
-
3436
-
3437
- #### [AuthSuccess](#AuthSuccess)
3438
-
3439
- | Properties | Type | Nullable | Description |
3440
- | ---------- | ---- | -------- | ----------- |
3441
- | register_token | string | no | |
3442
- | user_exists | boolean | no | |
3443
- | user | [UserSchema](#UserSchema) | no | |
3444
-
3445
- ---
3446
-
3447
-
3448
-
3449
-
3450
- #### [SendOtpResponse](#SendOtpResponse)
3451
-
3452
- | Properties | Type | Nullable | Description |
3453
- | ---------- | ---- | -------- | ----------- |
3454
- | resend_timer | number | no | |
3455
- | resend_token | string | no | |
3456
- | success | boolean | no | |
3457
- | request_id | string | no | |
3458
- | message | string | no | |
3459
- | mobile | string | no | |
3460
- | country_code | string | no | |
3461
- | email | string | no | |
3462
- | resend_email_token | string | no | |
3463
- | register_token | string | no | |
3464
- | verify_email_otp | boolean | no | |
3465
- | verify_mobile_otp | boolean | no | |
3466
- | user_exists | boolean | no | |
3467
-
3468
- ---
3469
-
3470
-
3471
-
3472
-
3473
- #### [ProfileEditSuccess](#ProfileEditSuccess)
3474
-
3475
- | Properties | Type | Nullable | Description |
3476
- | ---------- | ---- | -------- | ----------- |
3477
- | user | [UserSchema](#UserSchema) | no | |
3478
- | register_token | string | no | |
3479
- | resend_email_token | string | no | |
3480
- | user_exists | boolean | no | |
3481
- | verify_email_link | boolean | no | |
3482
- | verify_email_otp | boolean | no | |
3483
- | verify_mobile_otp | boolean | no | |
3484
- | email | string | no | |
3485
- | request_id | string | no | |
3486
- | country_code | string | no | |
3487
- | mobile | string | no | |
3488
- | success | boolean | no | |
3489
- | message | string | no | |
3490
- | resend_timer | number | no | |
3491
- | resend_token | string | no | |
3492
-
3493
- ---
3494
-
3495
-
3496
-
3497
-
3498
- #### [LoginSuccess](#LoginSuccess)
3499
-
3500
- | Properties | Type | Nullable | Description |
3501
- | ---------- | ---- | -------- | ----------- |
3502
- | user | [UserSchema](#UserSchema) | no | |
3503
- | request_id | string | no | |
3504
- | register_token | string | no | |
3505
-
3506
- ---
3507
-
3508
-
3509
-
3510
-
3511
- #### [VerifyOtpSuccess](#VerifyOtpSuccess)
3512
-
3513
- | Properties | Type | Nullable | Description |
3514
- | ---------- | ---- | -------- | ----------- |
3515
- | user | [UserSchema](#UserSchema) | no | |
3516
- | user_exists | boolean | no | |
3517
- | register_token | string | no | |
3518
-
3519
- ---
3520
-
3521
-
3522
-
3523
-
3524
- #### [ResetPasswordSuccess](#ResetPasswordSuccess)
3525
-
3526
- | Properties | Type | Nullable | Description |
3527
- | ---------- | ---- | -------- | ----------- |
3528
- | status | string | no | |
3529
-
3530
- ---
3531
-
3532
-
3533
-
3534
-
3535
- #### [RegisterFormSuccess](#RegisterFormSuccess)
3536
-
3537
- | Properties | Type | Nullable | Description |
3538
- | ---------- | ---- | -------- | ----------- |
3539
- | email | string | no | |
3540
- | resend_timer | number | no | |
3541
- | resend_token | string | no | |
3542
- | resend_email_token | string | no | |
3543
- | register_token | string | no | |
3544
- | success | boolean | no | |
3545
- | request_id | string | no | |
3546
- | message | string | no | |
3547
- | mobile | string | no | |
3548
- | country_code | string | no | |
3549
- | verify_email_otp | boolean | no | |
3550
- | verify_mobile_otp | boolean | no | |
3551
- | user_exists | boolean | no | |
3552
-
3553
- ---
3554
-
3555
-
3556
-
3557
-
3558
- #### [VerifyEmailSuccess](#VerifyEmailSuccess)
3559
-
3560
- | Properties | Type | Nullable | Description |
3561
- | ---------- | ---- | -------- | ----------- |
3562
- | message | string | no | |
3563
-
3564
- ---
3565
-
3566
-
3567
-
3568
-
3569
- #### [HasPasswordSuccess](#HasPasswordSuccess)
3570
-
3571
- | Properties | Type | Nullable | Description |
3572
- | ---------- | ---- | -------- | ----------- |
3573
- | result | boolean | no | |
3574
-
3575
- ---
3576
-
3577
-
3578
-
3579
-
3580
- #### [LogoutSuccess](#LogoutSuccess)
3581
-
3582
- | Properties | Type | Nullable | Description |
3583
- | ---------- | ---- | -------- | ----------- |
3584
- | logout | boolean | no | |
3585
-
3586
- ---
3587
-
3588
-
3589
-
3590
-
3591
- #### [BlockUserSuccess](#BlockUserSuccess)
3592
-
3593
- | Properties | Type | Nullable | Description |
3594
- | ---------- | ---- | -------- | ----------- |
3595
- | success | boolean | no | |
3596
-
3597
- ---
3598
-
3599
-
3600
-
3601
-
3602
- #### [ArchiveUserSuccess](#ArchiveUserSuccess)
3603
-
3604
- | Properties | Type | Nullable | Description |
3605
- | ---------- | ---- | -------- | ----------- |
3606
- | success | boolean | no | |
3607
-
3608
- ---
3609
-
3610
-
3611
-
3612
-
3613
- #### [DeleteUserSuccess](#DeleteUserSuccess)
3614
-
3615
- | Properties | Type | Nullable | Description |
3616
- | ---------- | ---- | -------- | ----------- |
3617
- | success | boolean | no | |
3618
-
3619
- ---
3620
-
3621
-
3622
-
3623
-
3624
- #### [UnDeleteUserSuccess](#UnDeleteUserSuccess)
3625
-
3626
- | Properties | Type | Nullable | Description |
3627
- | ---------- | ---- | -------- | ----------- |
3628
- | success | boolean | no | |
3629
-
3630
- ---
3631
-
3632
-
3633
-
3634
-
3635
- #### [OtpSuccess](#OtpSuccess)
3636
-
3637
- | Properties | Type | Nullable | Description |
3638
- | ---------- | ---- | -------- | ----------- |
3639
- | resend_timer | number | no | |
3640
- | resend_token | string | no | |
3641
- | register_token | string | no | |
3642
- | success | boolean | no | |
3643
- | request_id | string | no | |
3644
- | message | string | no | |
3645
- | mobile | string | no | |
3646
- | country_code | string | no | |
3647
-
3648
- ---
3649
-
3650
-
3651
-
3652
-
3653
- #### [EmailOtpSuccess](#EmailOtpSuccess)
3654
-
3655
- | Properties | Type | Nullable | Description |
3656
- | ---------- | ---- | -------- | ----------- |
3657
- | success | boolean | no | |
3658
-
3659
- ---
3660
-
3661
-
3662
-
3663
-
3664
- #### [SessionListSuccess](#SessionListSuccess)
3665
-
3666
- | Properties | Type | Nullable | Description |
3667
- | ---------- | ---- | -------- | ----------- |
3668
- | sessions | [string] | no | |
3669
-
3670
- ---
3671
-
3672
-
3673
-
3674
-
3675
- #### [VerifyMobileOTPSuccess](#VerifyMobileOTPSuccess)
3676
-
3677
- | Properties | Type | Nullable | Description |
3678
- | ---------- | ---- | -------- | ----------- |
3679
- | user | [UserSchema](#UserSchema) | no | |
3680
- | verify_mobile_link | boolean | no | |
3681
-
3682
- ---
3683
-
3684
-
3685
-
3686
-
3687
- #### [VerifyEmailOTPSuccess](#VerifyEmailOTPSuccess)
3688
-
3689
- | Properties | Type | Nullable | Description |
3690
- | ---------- | ---- | -------- | ----------- |
3691
- | user | [UserSchema](#UserSchema) | no | |
3692
- | verify_email_link | boolean | no | |
3693
-
3694
- ---
3695
-
3696
-
3697
-
3698
-
3699
- #### [SendMobileVerifyLinkSuccess](#SendMobileVerifyLinkSuccess)
3700
-
3701
- | Properties | Type | Nullable | Description |
3702
- | ---------- | ---- | -------- | ----------- |
3703
- | verify_mobile_link | boolean | no | |
3704
-
3705
- ---
3706
-
3707
-
3708
-
3709
-
3710
- #### [SendEmailVerifyLinkSuccess](#SendEmailVerifyLinkSuccess)
3711
-
3712
- | Properties | Type | Nullable | Description |
3713
- | ---------- | ---- | -------- | ----------- |
3714
- | verify_email_link | boolean | no | |
3715
-
3716
- ---
3717
-
3718
-
3719
-
3720
-
3721
- #### [UserSearchResponseSchema](#UserSearchResponseSchema)
3722
-
3723
- | Properties | Type | Nullable | Description |
3724
- | ---------- | ---- | -------- | ----------- |
3725
- | users | [[UserSchema](#UserSchema)] | no | |
3726
-
3727
- ---
3728
-
3729
-
3730
-
3731
-
3732
- #### [CustomerListResponseSchema](#CustomerListResponseSchema)
3733
-
3734
- | Properties | Type | Nullable | Description |
3735
- | ---------- | ---- | -------- | ----------- |
3736
- | items | [[UserSchema](#UserSchema)] | no | |
3737
- | page | [PaginationSchema](#PaginationSchema) | no | |
3738
-
3739
- ---
3740
-
3741
-
3742
-
3743
-
3744
- #### [PaginationSchema](#PaginationSchema)
3745
-
3746
- | Properties | Type | Nullable | Description |
3747
- | ---------- | ---- | -------- | ----------- |
3748
- | size | number | no | |
3749
- | item_total | number | no | |
3750
- | has_next | boolean | no | |
3751
- | type | string | no | |
3752
- | current | number | no | |
3753
-
3754
- ---
3755
-
3756
-
3757
-
3758
-
3759
- #### [SessionListResponseSchema](#SessionListResponseSchema)
3760
-
3761
- | Properties | Type | Nullable | Description |
3762
- | ---------- | ---- | -------- | ----------- |
3763
- | items | [string] | no | |
3764
-
3765
- ---
3766
-
3767
-
3768
-
3769
-
3770
- #### [SessionDeleteResponseSchema](#SessionDeleteResponseSchema)
3771
-
3772
- | Properties | Type | Nullable | Description |
3773
- | ---------- | ---- | -------- | ----------- |
3774
- | items | [string] | no | |
3775
-
3776
- ---
3777
-
3778
-
3779
-
3780
-
3781
- #### [UnauthorizedSchema](#UnauthorizedSchema)
3782
-
3783
- | Properties | Type | Nullable | Description |
3784
- | ---------- | ---- | -------- | ----------- |
3785
- | message | string | no | |
3786
-
3787
- ---
3788
-
3789
-
3790
-
3791
-
3792
- #### [UnauthenticatedSchema](#UnauthenticatedSchema)
3793
-
3794
- | Properties | Type | Nullable | Description |
3795
- | ---------- | ---- | -------- | ----------- |
3796
- | authenticated | boolean | no | |
3797
-
3798
- ---
3799
-
3800
-
3801
-
3802
-
3803
- #### [NotFoundSchema](#NotFoundSchema)
3804
-
3805
- | Properties | Type | Nullable | Description |
3806
- | ---------- | ---- | -------- | ----------- |
3807
- | message | string | no | |
3808
-
3809
- ---
3810
-
3811
-
3812
-
3813
-
3814
- #### [AuthenticationInternalServerErrorSchema](#AuthenticationInternalServerErrorSchema)
3815
-
3816
- | Properties | Type | Nullable | Description |
3817
- | ---------- | ---- | -------- | ----------- |
3818
- | message | string | no | |
3819
-
3820
- ---
3821
-
3822
-
3823
-
3824
-
3825
- #### [AuthenticationApiErrorSchema](#AuthenticationApiErrorSchema)
3826
-
3827
- | Properties | Type | Nullable | Description |
3828
- | ---------- | ---- | -------- | ----------- |
3829
- | message | string | no | |
3830
-
3831
- ---
3832
-
3833
-
3834
-
3835
-
3836
- #### [ProfileEditSuccessSchema](#ProfileEditSuccessSchema)
3837
-
3838
- | Properties | Type | Nullable | Description |
3839
- | ---------- | ---- | -------- | ----------- |
3840
- | email | string | no | |
3841
- | verify_email_otp | boolean | no | |
3842
- | verify_email_link | boolean | no | |
3843
- | verify_mobile_otp | boolean | no | |
3844
- | user | string | no | |
3845
- | register_token | string | no | |
3846
- | user_exists | boolean | no | |
3847
-
3848
- ---
3849
-
3850
-
3851
-
3852
-
3853
- #### [FormRegisterRequestSchemaPhone](#FormRegisterRequestSchemaPhone)
3854
-
3855
- | Properties | Type | Nullable | Description |
3856
- | ---------- | ---- | -------- | ----------- |
3857
- | country_code | string | no | |
3858
- | mobile | string | no | |
3859
-
3860
- ---
3861
-
3862
-
3863
-
3864
-
3865
- #### [OAuthRequestSchemaOauth2](#OAuthRequestSchemaOauth2)
3866
-
3867
- | Properties | Type | Nullable | Description |
3868
- | ---------- | ---- | -------- | ----------- |
3869
- | access_token | string | no | |
3870
- | expiry | number | no | |
3871
- | refresh_token | string | no | |
3872
-
3873
- ---
3874
-
3875
-
3876
-
3877
-
3878
- #### [OAuthRequestSchemaProfile](#OAuthRequestSchemaProfile)
3879
-
3880
- | Properties | Type | Nullable | Description |
3881
- | ---------- | ---- | -------- | ----------- |
3882
- | last_name | string | no | |
3883
- | image | string | no | |
3884
- | id | string | no | |
3885
- | email | string | no | |
3886
- | full_name | string | no | |
3887
- | first_name | string | no | |
3888
-
3889
- ---
3890
-
3891
-
3892
-
3893
-
3894
- #### [OAuthRequestAppleSchemaOauth](#OAuthRequestAppleSchemaOauth)
3895
-
3896
- | Properties | Type | Nullable | Description |
3897
- | ---------- | ---- | -------- | ----------- |
3898
- | identity_token | string | no | |
3899
-
3900
- ---
3901
-
3902
-
3903
-
3904
-
3905
- #### [OAuthRequestAppleSchemaProfile](#OAuthRequestAppleSchemaProfile)
3906
-
3907
- | Properties | Type | Nullable | Description |
3908
- | ---------- | ---- | -------- | ----------- |
3909
- | last_name | string | no | |
3910
- | full_name | string | no | |
3911
- | first_name | string | no | |
3912
-
3913
- ---
3914
-
3915
-
3916
-
3917
-
3918
- #### [AuthSuccessUser](#AuthSuccessUser)
3919
-
3920
- | Properties | Type | Nullable | Description |
3921
- | ---------- | ---- | -------- | ----------- |
3922
- | first_name | string | no | |
3923
- | last_name | string | no | |
3924
- | debug | [AuthSuccessUserDebug](#AuthSuccessUserDebug) | no | |
3925
- | active | boolean | no | |
3926
- | emails | [AuthSuccessUserEmails](#AuthSuccessUserEmails) | no | |
3927
-
3928
- ---
3929
-
3930
-
3931
-
3932
-
3933
- #### [AuthSuccessUserDebug](#AuthSuccessUserDebug)
3934
-
3935
- | Properties | Type | Nullable | Description |
3936
- | ---------- | ---- | -------- | ----------- |
3937
- | platform | string | no | |
3938
-
3939
- ---
3940
-
3941
-
3942
-
3943
-
3944
- #### [AuthSuccessUserEmails](#AuthSuccessUserEmails)
3945
-
3946
- | Properties | Type | Nullable | Description |
3947
- | ---------- | ---- | -------- | ----------- |
3948
- | email | string | no | |
3949
- | verified | boolean | no | |
3950
- | primary | boolean | no | |
3951
- | active | boolean | no | |
3952
-
3953
- ---
3954
-
3955
-
3956
-
3957
-
3958
- #### [CreateUserRequestSchema](#CreateUserRequestSchema)
3959
-
3960
- | Properties | Type | Nullable | Description |
3961
- | ---------- | ---- | -------- | ----------- |
3962
- | phone_number | string | yes | |
3963
- | email | string | no | |
3964
- | first_name | string | no | |
3965
- | last_name | string | no | |
3966
- | gender | string | no | |
3967
- | username | string | yes | |
3968
- | meta | string | no | |
3969
-
3970
- ---
3971
-
3972
-
3973
-
3974
-
3975
- #### [CreateUserResponseSchema](#CreateUserResponseSchema)
3976
-
3977
- | Properties | Type | Nullable | Description |
3978
- | ---------- | ---- | -------- | ----------- |
3979
- | user | [UserSchema](#UserSchema) | no | |
3980
-
3981
- ---
3982
-
3983
-
3984
-
3985
-
3986
- #### [CreateUserSessionRequestSchema](#CreateUserSessionRequestSchema)
3987
-
3988
- | Properties | Type | Nullable | Description |
3989
- | ---------- | ---- | -------- | ----------- |
3990
- | domain | string | no | |
3991
- | max_age | number | no | |
3992
- | user_id | string | no | |
3993
-
3994
- ---
3995
-
3996
-
3997
-
3998
-
3999
- #### [CreateUserSessionResponseSchema](#CreateUserSessionResponseSchema)
4000
-
4001
- | Properties | Type | Nullable | Description |
4002
- | ---------- | ---- | -------- | ----------- |
4003
- | domain | string | no | |
4004
- | max_age | number | no | |
4005
- | secure | boolean | no | |
4006
- | http_only | boolean | no | |
4007
- | cookie | string | no | |
4008
-
4009
- ---
4010
-
4011
-
4012
-
4013
-
4014
- #### [PlatformSchema](#PlatformSchema)
4015
-
4016
- | Properties | Type | Nullable | Description |
4017
- | ---------- | ---- | -------- | ----------- |
4018
- | display | string | no | |
4019
- | look_and_feel | [LookAndFeel](#LookAndFeel) | no | |
4020
- | updated_at | string | no | |
4021
- | active | boolean | no | |
4022
- | forgot_password | boolean | no | |
4023
- | login | [Login](#Login) | no | |
4024
- | skip_captcha | boolean | no | |
4025
- | name | string | no | |
4026
- | meta | [MetaSchema](#MetaSchema) | no | |
4027
- | _id | string | no | |
4028
- | social | [Social](#Social) | no | |
4029
- | required_fields | [RequiredFields](#RequiredFields) | no | |
4030
- | register_required_fields | [RegisterRequiredFields](#RegisterRequiredFields) | no | |
4031
- | skip_login | boolean | no | |
4032
- | flash_card | [FlashCard](#FlashCard) | no | |
4033
- | subtext | string | no | |
4034
- | social_tokens | [SocialTokens](#SocialTokens) | no | |
4035
- | created_at | string | no | |
4036
- | register | boolean | no | |
4037
- | mobile_image | string | no | |
4038
- | desktop_image | string | no | |
4039
- | delete_account_day | number | no | |
4040
- | delete_account_reasons | [[DeleteAccountReasons](#DeleteAccountReasons)] | no | |
4041
- | delete_account_consent | string | no | |
4042
- | session_config | string | no | |
4043
-
4044
- ---
4045
-
4046
-
4047
-
4048
-
4049
- #### [LookAndFeel](#LookAndFeel)
4050
-
4051
- | Properties | Type | Nullable | Description |
4052
- | ---------- | ---- | -------- | ----------- |
4053
- | card_position | string | no | |
4054
- | background_color | string | no | |
4055
-
4056
- ---
4057
-
4058
-
4059
-
4060
-
4061
- #### [Login](#Login)
4062
-
4063
- | Properties | Type | Nullable | Description |
4064
- | ---------- | ---- | -------- | ----------- |
4065
- | password | boolean | no | |
4066
- | otp | boolean | no | |
4067
-
4068
- ---
4069
-
4070
-
4071
-
4072
-
4073
- #### [MetaSchema](#MetaSchema)
4074
-
4075
- | Properties | Type | Nullable | Description |
4076
- | ---------- | ---- | -------- | ----------- |
4077
- | fynd_default | boolean | no | |
4078
-
4079
- ---
4080
-
4081
-
4082
-
4083
-
4084
- #### [Social](#Social)
4085
-
4086
- | Properties | Type | Nullable | Description |
4087
- | ---------- | ---- | -------- | ----------- |
4088
- | account_kit | boolean | no | |
4089
- | facebook | boolean | no | |
4090
- | google | boolean | no | |
4091
- | apple | boolean | no | |
4092
-
4093
- ---
4094
-
4095
-
4096
-
4097
-
4098
- #### [RequiredFields](#RequiredFields)
4099
-
4100
- | Properties | Type | Nullable | Description |
4101
- | ---------- | ---- | -------- | ----------- |
4102
- | email | [PlatformEmail](#PlatformEmail) | no | |
4103
- | mobile | [PlatformMobile](#PlatformMobile) | no | |
4104
-
4105
- ---
4106
-
4107
-
4108
-
4109
-
4110
- #### [PlatformEmail](#PlatformEmail)
4111
-
4112
- | Properties | Type | Nullable | Description |
4113
- | ---------- | ---- | -------- | ----------- |
4114
- | is_required | boolean | no | |
4115
- | level | string | no | |
4116
-
4117
- ---
4118
-
4119
-
4120
-
4121
-
4122
- #### [PlatformMobile](#PlatformMobile)
4123
-
4124
- | Properties | Type | Nullable | Description |
4125
- | ---------- | ---- | -------- | ----------- |
4126
- | is_required | boolean | no | |
4127
- | level | string | no | |
4128
-
4129
- ---
4130
-
4131
-
4132
-
4133
-
4134
- #### [RegisterRequiredFields](#RegisterRequiredFields)
4135
-
4136
- | Properties | Type | Nullable | Description |
4137
- | ---------- | ---- | -------- | ----------- |
4138
- | email | [RegisterRequiredFieldsEmail](#RegisterRequiredFieldsEmail) | no | |
4139
- | mobile | [RegisterRequiredFieldsMobile](#RegisterRequiredFieldsMobile) | no | |
4140
-
4141
- ---
4142
-
4143
-
4144
-
4145
-
4146
- #### [RegisterRequiredFieldsEmail](#RegisterRequiredFieldsEmail)
4147
-
4148
- | Properties | Type | Nullable | Description |
4149
- | ---------- | ---- | -------- | ----------- |
4150
- | is_required | boolean | no | |
4151
- | level | string | no | |
4152
-
4153
- ---
4154
-
4155
-
4156
-
4157
-
4158
- #### [RegisterRequiredFieldsMobile](#RegisterRequiredFieldsMobile)
4159
-
4160
- | Properties | Type | Nullable | Description |
4161
- | ---------- | ---- | -------- | ----------- |
4162
- | is_required | boolean | no | |
4163
- | level | string | no | |
4164
-
4165
- ---
4166
-
4167
-
4168
-
4169
-
4170
- #### [FlashCard](#FlashCard)
4171
-
4172
- | Properties | Type | Nullable | Description |
4173
- | ---------- | ---- | -------- | ----------- |
4174
- | text | string | no | |
4175
- | text_color | string | no | |
4176
- | background_color | string | no | |
4177
-
4178
- ---
4179
-
4180
-
4181
-
4182
-
4183
- #### [SocialTokens](#SocialTokens)
4184
-
4185
- | Properties | Type | Nullable | Description |
4186
- | ---------- | ---- | -------- | ----------- |
4187
- | facebook | [Facebook](#Facebook) | no | |
4188
- | account_kit | [Accountkit](#Accountkit) | no | |
4189
- | google | [Google](#Google) | no | |
4190
-
4191
- ---
4192
-
4193
-
4194
-
4195
-
4196
- #### [DeleteAccountReasons](#DeleteAccountReasons)
4197
-
4198
- | Properties | Type | Nullable | Description |
4199
- | ---------- | ---- | -------- | ----------- |
4200
- | reason_text | string | no | |
4201
- | reason_id | string | no | |
4202
- | show_text_area | boolean | no | |
4203
-
4204
- ---
4205
-
4206
-
4207
-
4208
-
4209
- #### [DeleteAccountConsent](#DeleteAccountConsent)
4210
-
4211
- | Properties | Type | Nullable | Description |
4212
- | ---------- | ---- | -------- | ----------- |
4213
- | consent_text | string | no | |
4214
-
4215
- ---
4216
-
4217
-
4218
-
4219
-
4220
- #### [Facebook](#Facebook)
4221
-
4222
- | Properties | Type | Nullable | Description |
4223
- | ---------- | ---- | -------- | ----------- |
4224
- | app_id | string | no | |
4225
-
4226
- ---
4227
-
4228
-
4229
-
4230
-
4231
- #### [Accountkit](#Accountkit)
4232
-
4233
- | Properties | Type | Nullable | Description |
4234
- | ---------- | ---- | -------- | ----------- |
4235
- | app_id | string | no | |
4236
-
4237
- ---
4238
-
4239
-
4240
-
4241
-
4242
- #### [Google](#Google)
4243
-
4244
- | Properties | Type | Nullable | Description |
4245
- | ---------- | ---- | -------- | ----------- |
4246
- | app_id | string | no | |
4247
-
4248
- ---
4249
-
4250
-
4251
-
4252
-
4253
- #### [SessionExpiry](#SessionExpiry)
4254
-
4255
- | Properties | Type | Nullable | Description |
4256
- | ---------- | ---- | -------- | ----------- |
4257
- | duration | number | no | |
4258
- | type | string | no | |
4259
- | is_rolling | boolean | no | |
4260
-
4261
- ---
4262
-
4263
-
4264
-
4265
-
4266
- #### [UpdateUserRequestSchema](#UpdateUserRequestSchema)
4267
-
4268
- | Properties | Type | Nullable | Description |
4269
- | ---------- | ---- | -------- | ----------- |
4270
- | first_name | string | no | |
4271
- | last_name | string | no | |
4272
- | gender | string | no | |
4273
- | external_id | string | no | |
4274
- | meta | string | no | |
4275
-
4276
- ---
4277
-
4278
-
4279
-
4280
-
4281
- #### [UserSchema](#UserSchema)
4282
-
4283
- | Properties | Type | Nullable | Description |
4284
- | ---------- | ---- | -------- | ----------- |
4285
- | application_id | string | no | |
4286
- | user_id | string | no | |
4287
- | first_name | string | no | |
4288
- | meta | string | no | |
4289
- | last_name | string | no | |
4290
- | phone_numbers | [[PhoneNumber](#PhoneNumber)] | no | |
4291
- | emails | [[Email](#Email)] | no | |
4292
- | gender | string | no | |
4293
- | dob | string | no | |
4294
- | active | boolean | no | |
4295
- | profile_pic_url | string | no | |
4296
- | username | string | no | |
4297
- | account_type | string | no | |
4298
- | _id | string | no | |
4299
- | created_at | string | no | |
4300
- | updated_at | string | no | |
4301
-
4302
- ---
4303
-
4304
-
4305
-
4306
-
4307
- #### [PhoneNumber](#PhoneNumber)
4308
-
4309
- | Properties | Type | Nullable | Description |
4310
- | ---------- | ---- | -------- | ----------- |
4311
- | active | boolean | no | |
4312
- | primary | boolean | no | |
4313
- | verified | boolean | no | |
4314
- | phone | string | no | |
4315
- | country_code | number | no | |
4316
-
4317
- ---
4318
-
4319
-
4320
-
4321
-
4322
- #### [Email](#Email)
4323
-
4324
- | Properties | Type | Nullable | Description |
4325
- | ---------- | ---- | -------- | ----------- |
4326
- | primary | boolean | no | |
4327
- | verified | boolean | no | |
4328
- | email | string | no | |
4329
- | active | boolean | no | |
4330
-
4331
- ---
4332
-
4333
-
4334
-
4335
-