@gofynd/fdk-client-javascript 1.0.1 → 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (318) hide show
  1. package/documentation/application/CART.md +5934 -4502
  2. package/documentation/application/CATALOG.md +6338 -7245
  3. package/documentation/application/COMMON.md +95 -222
  4. package/documentation/application/COMMUNICATION.md +106 -186
  5. package/documentation/application/CONFIGURATION.md +903 -1597
  6. package/documentation/application/CONTENT.md +562 -1270
  7. package/documentation/application/FILESTORAGE.md +84 -220
  8. package/documentation/application/LEAD.md +314 -660
  9. package/documentation/application/LOGISTIC.md +229 -305
  10. package/documentation/application/ORDER.md +642 -1137
  11. package/documentation/application/PAYMENT.md +2285 -3031
  12. package/documentation/application/POSCART.md +6079 -4642
  13. package/documentation/application/REWARDS.md +94 -248
  14. package/documentation/application/SHARE.md +152 -250
  15. package/documentation/application/THEME.md +952 -1235
  16. package/documentation/application/USER.md +1228 -1765
  17. package/documentation/platform/ANALYTICS.md +207 -349
  18. package/documentation/platform/AUDITTRAIL.md +121 -204
  19. package/documentation/platform/BILLING.md +865 -1376
  20. package/documentation/platform/CART.md +2814 -3662
  21. package/documentation/platform/CATALOG.md +15266 -17619
  22. package/documentation/platform/COMMON.md +95 -222
  23. package/documentation/platform/COMMUNICATION.md +1632 -2380
  24. package/documentation/platform/COMPANYPROFILE.md +572 -957
  25. package/documentation/platform/CONFIGURATION.md +3050 -4073
  26. package/documentation/platform/CONTENT.md +3509 -4121
  27. package/documentation/platform/DISCOUNT.md +140 -236
  28. package/documentation/platform/FILESTORAGE.md +187 -323
  29. package/documentation/platform/INVENTORY.md +268 -911
  30. package/documentation/platform/LEAD.md +2195 -2541
  31. package/documentation/platform/ORDER.md +3750 -5636
  32. package/documentation/platform/PARTNER.md +9 -36
  33. package/documentation/platform/PAYMENT.md +903 -1213
  34. package/documentation/platform/REWARDS.md +183 -347
  35. package/documentation/platform/SHARE.md +120 -213
  36. package/documentation/platform/THEME.md +12956 -13239
  37. package/documentation/platform/USER.md +975 -1120
  38. package/documentation/platform/WEBHOOK.md +78 -184
  39. package/documentation/public/CONFIGURATION.md +95 -222
  40. package/documentation/public/INVENTORY.md +100 -282
  41. package/documentation/public/WEBHOOK.md +27 -133
  42. package/package.json +1 -1
  43. package/sdk/application/ApplicationConfig.js +1 -1
  44. package/sdk/application/Cart/CartApplicationClient.d.ts +243 -243
  45. package/sdk/application/Cart/CartApplicationClient.js +1058 -547
  46. package/sdk/application/Cart/CartApplicationModel.d.ts +64 -63
  47. package/sdk/application/Cart/CartApplicationModel.js +489 -886
  48. package/sdk/application/Cart/CartApplicationValidator.d.ts +17 -17
  49. package/sdk/application/Cart/CartApplicationValidator.js +98 -98
  50. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +358 -358
  51. package/sdk/application/Catalog/CatalogApplicationClient.js +1545 -949
  52. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +90 -90
  53. package/sdk/application/Catalog/CatalogApplicationModel.js +692 -1258
  54. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +19 -19
  55. package/sdk/application/Catalog/CatalogApplicationValidator.js +110 -110
  56. package/sdk/application/Common/CommonApplicationClient.d.ts +13 -13
  57. package/sdk/application/Common/CommonApplicationClient.js +76 -36
  58. package/sdk/application/Common/CommonApplicationModel.d.ts +12 -12
  59. package/sdk/application/Common/CommonApplicationModel.js +83 -160
  60. package/sdk/application/Common/CommonApplicationValidator.d.ts +1 -1
  61. package/sdk/application/Common/CommonApplicationValidator.js +6 -6
  62. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +11 -11
  63. package/sdk/application/Communication/CommunicationApplicationClient.js +92 -31
  64. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +6 -6
  65. package/sdk/application/Communication/CommunicationApplicationModel.js +38 -83
  66. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
  67. package/sdk/application/Communication/CommunicationApplicationValidator.js +4 -4
  68. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +116 -116
  69. package/sdk/application/Configuration/ConfigurationApplicationClient.js +638 -312
  70. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +85 -85
  71. package/sdk/application/Configuration/ConfigurationApplicationModel.js +480 -851
  72. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +8 -8
  73. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +33 -33
  74. package/sdk/application/Content/ContentApplicationClient.d.ts +67 -67
  75. package/sdk/application/Content/ContentApplicationClient.js +581 -213
  76. package/sdk/application/Content/ContentApplicationModel.d.ts +76 -75
  77. package/sdk/application/Content/ContentApplicationModel.js +468 -875
  78. package/sdk/application/Content/ContentApplicationValidator.d.ts +5 -5
  79. package/sdk/application/Content/ContentApplicationValidator.js +24 -24
  80. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +25 -25
  81. package/sdk/application/FileStorage/FileStorageApplicationClient.js +121 -59
  82. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +13 -13
  83. package/sdk/application/FileStorage/FileStorageApplicationModel.js +86 -169
  84. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +1 -1
  85. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +7 -7
  86. package/sdk/application/Lead/LeadApplicationClient.d.ts +24 -24
  87. package/sdk/application/Lead/LeadApplicationClient.js +230 -96
  88. package/sdk/application/Lead/LeadApplicationModel.d.ts +35 -35
  89. package/sdk/application/Lead/LeadApplicationModel.js +267 -474
  90. package/sdk/application/Lead/LeadApplicationValidator.d.ts +2 -2
  91. package/sdk/application/Lead/LeadApplicationValidator.js +11 -11
  92. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +30 -19
  93. package/sdk/application/Logistic/LogisticApplicationClient.js +196 -47
  94. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +17 -14
  95. package/sdk/application/Logistic/LogisticApplicationModel.js +133 -201
  96. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +3 -2
  97. package/sdk/application/Logistic/LogisticApplicationValidator.js +14 -8
  98. package/sdk/application/Order/OrderApplicationClient.d.ts +86 -86
  99. package/sdk/application/Order/OrderApplicationClient.js +448 -215
  100. package/sdk/application/Order/OrderApplicationModel.d.ts +50 -50
  101. package/sdk/application/Order/OrderApplicationModel.js +357 -661
  102. package/sdk/application/Order/OrderApplicationValidator.d.ts +7 -7
  103. package/sdk/application/Order/OrderApplicationValidator.js +28 -28
  104. package/sdk/application/Payment/PaymentApplicationClient.d.ts +318 -318
  105. package/sdk/application/Payment/PaymentApplicationClient.js +1525 -750
  106. package/sdk/application/Payment/PaymentApplicationModel.d.ts +72 -72
  107. package/sdk/application/Payment/PaymentApplicationModel.js +565 -1033
  108. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +28 -28
  109. package/sdk/application/Payment/PaymentApplicationValidator.js +107 -107
  110. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +254 -254
  111. package/sdk/application/PosCart/PosCartApplicationClient.js +1137 -606
  112. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +61 -60
  113. package/sdk/application/PosCart/PosCartApplicationModel.js +477 -873
  114. package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +18 -18
  115. package/sdk/application/PosCart/PosCartApplicationValidator.js +103 -103
  116. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +27 -27
  117. package/sdk/application/Rewards/RewardsApplicationClient.js +253 -113
  118. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +14 -14
  119. package/sdk/application/Rewards/RewardsApplicationModel.js +96 -191
  120. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +3 -3
  121. package/sdk/application/Rewards/RewardsApplicationValidator.js +12 -12
  122. package/sdk/application/Share/ShareApplicationClient.d.ts +37 -37
  123. package/sdk/application/Share/ShareApplicationClient.js +221 -96
  124. package/sdk/application/Share/ShareApplicationModel.d.ts +8 -8
  125. package/sdk/application/Share/ShareApplicationModel.js +63 -123
  126. package/sdk/application/Share/ShareApplicationValidator.d.ts +4 -4
  127. package/sdk/application/Share/ShareApplicationValidator.js +12 -12
  128. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
  129. package/sdk/application/Theme/ThemeApplicationClient.js +115 -37
  130. package/sdk/application/Theme/ThemeApplicationModel.d.ts +34 -34
  131. package/sdk/application/Theme/ThemeApplicationModel.js +190 -336
  132. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +1 -1
  133. package/sdk/application/Theme/ThemeApplicationValidator.js +4 -4
  134. package/sdk/application/User/UserApplicationClient.d.ts +280 -280
  135. package/sdk/application/User/UserApplicationClient.js +1201 -543
  136. package/sdk/application/User/UserApplicationModel.d.ts +79 -72
  137. package/sdk/application/User/UserApplicationModel.js +440 -689
  138. package/sdk/application/User/UserApplicationValidator.d.ts +24 -24
  139. package/sdk/application/User/UserApplicationValidator.js +89 -89
  140. package/sdk/common/AxiosHelper.js +1 -1
  141. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +55 -47
  142. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +308 -151
  143. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +6 -6
  144. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +20 -20
  145. package/sdk/platform/Analytics/AnalyticsPlatformClient.d.ts +8 -4
  146. package/sdk/platform/Analytics/AnalyticsPlatformClient.js +103 -16
  147. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +11 -11
  148. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +95 -178
  149. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +16 -12
  150. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +131 -44
  151. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +10 -10
  152. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +50 -89
  153. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -1
  154. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +6 -6
  155. package/sdk/platform/Billing/BillingPlatformClient.d.ts +68 -56
  156. package/sdk/platform/Billing/BillingPlatformClient.js +416 -171
  157. package/sdk/platform/Billing/BillingPlatformModel.d.ts +40 -40
  158. package/sdk/platform/Billing/BillingPlatformModel.js +342 -668
  159. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +8 -8
  160. package/sdk/platform/Billing/BillingPlatformValidator.js +25 -25
  161. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +176 -159
  162. package/sdk/platform/Cart/CartPlatformApplicationClient.js +837 -500
  163. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +11 -11
  164. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +63 -63
  165. package/sdk/platform/Cart/CartPlatformModel.d.ts +86 -85
  166. package/sdk/platform/Cart/CartPlatformModel.js +677 -1211
  167. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +582 -529
  168. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2642 -1533
  169. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +40 -40
  170. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +175 -175
  171. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +708 -590
  172. package/sdk/platform/Catalog/CatalogPlatformClient.js +3103 -1362
  173. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +293 -284
  174. package/sdk/platform/Catalog/CatalogPlatformModel.js +2149 -3660
  175. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +66 -64
  176. package/sdk/platform/Catalog/CatalogPlatformValidator.js +235 -216
  177. package/sdk/platform/Common/CommonPlatformClient.d.ts +14 -12
  178. package/sdk/platform/Common/CommonPlatformClient.js +80 -37
  179. package/sdk/platform/Common/CommonPlatformModel.d.ts +12 -12
  180. package/sdk/platform/Common/CommonPlatformModel.js +83 -160
  181. package/sdk/platform/Common/CommonPlatformValidator.d.ts +1 -1
  182. package/sdk/platform/Common/CommonPlatformValidator.js +6 -6
  183. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +333 -293
  184. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +1687 -855
  185. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +30 -30
  186. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +87 -87
  187. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -1
  188. package/sdk/platform/Communication/CommunicationPlatformClient.js +28 -4
  189. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +67 -67
  190. package/sdk/platform/Communication/CommunicationPlatformModel.js +522 -974
  191. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +70 -57
  192. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +463 -182
  193. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +28 -28
  194. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +294 -557
  195. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +7 -7
  196. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +24 -24
  197. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +175 -137
  198. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1168 -521
  199. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +22 -21
  200. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +69 -63
  201. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +137 -119
  202. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +691 -316
  203. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +148 -146
  204. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +854 -1508
  205. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -9
  206. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +38 -38
  207. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +542 -461
  208. package/sdk/platform/Content/ContentPlatformApplicationClient.js +2600 -1160
  209. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +50 -49
  210. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +159 -152
  211. package/sdk/platform/Content/ContentPlatformModel.d.ts +79 -75
  212. package/sdk/platform/Content/ContentPlatformModel.js +486 -867
  213. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +72 -61
  214. package/sdk/platform/Discount/DiscountPlatformClient.js +424 -198
  215. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +7 -7
  216. package/sdk/platform/Discount/DiscountPlatformModel.js +60 -121
  217. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +6 -6
  218. package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -29
  219. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +26 -22
  220. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +145 -59
  221. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
  222. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +8 -8
  223. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +58 -52
  224. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +240 -114
  225. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -13
  226. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +86 -169
  227. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +3 -3
  228. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +11 -11
  229. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +76 -63
  230. package/sdk/platform/Inventory/InventoryPlatformClient.js +461 -197
  231. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +30 -30
  232. package/sdk/platform/Inventory/InventoryPlatformModel.js +497 -964
  233. package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +7 -7
  234. package/sdk/platform/Inventory/InventoryPlatformValidator.js +28 -28
  235. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +84 -71
  236. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +441 -182
  237. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +7 -7
  238. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +28 -28
  239. package/sdk/platform/Lead/LeadPlatformClient.d.ts +86 -75
  240. package/sdk/platform/Lead/LeadPlatformClient.js +434 -212
  241. package/sdk/platform/Lead/LeadPlatformModel.d.ts +35 -35
  242. package/sdk/platform/Lead/LeadPlatformModel.js +267 -474
  243. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +6 -6
  244. package/sdk/platform/Lead/LeadPlatformValidator.js +24 -24
  245. package/sdk/platform/OAuthClient.js +8 -8
  246. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +14 -11
  247. package/sdk/platform/Order/OrderPlatformApplicationClient.js +113 -49
  248. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -1
  249. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +6 -6
  250. package/sdk/platform/Order/OrderPlatformClient.d.ts +367 -315
  251. package/sdk/platform/Order/OrderPlatformClient.js +1775 -893
  252. package/sdk/platform/Order/OrderPlatformModel.d.ts +198 -192
  253. package/sdk/platform/Order/OrderPlatformModel.js +1591 -2822
  254. package/sdk/platform/Order/OrderPlatformValidator.d.ts +32 -32
  255. package/sdk/platform/Order/OrderPlatformValidator.js +160 -155
  256. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -2
  257. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +52 -8
  258. package/sdk/platform/Partner/PartnerPlatformModel.js +6 -22
  259. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +65 -54
  260. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +395 -164
  261. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +6 -6
  262. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +23 -23
  263. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +55 -45
  264. package/sdk/platform/Payment/PaymentPlatformClient.js +362 -147
  265. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +27 -27
  266. package/sdk/platform/Payment/PaymentPlatformModel.js +220 -408
  267. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +4 -4
  268. package/sdk/platform/Payment/PaymentPlatformValidator.js +21 -21
  269. package/sdk/platform/PlatformApplicationClient.d.ts +1496 -10153
  270. package/sdk/platform/PlatformApplicationClient.js +1584 -13691
  271. package/sdk/platform/PlatformClient.d.ts +7918 -7666
  272. package/sdk/platform/PlatformClient.js +8701 -9926
  273. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +91 -78
  274. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +507 -253
  275. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +8 -8
  276. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +34 -34
  277. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +15 -15
  278. package/sdk/platform/Rewards/RewardsPlatformModel.js +92 -194
  279. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +16 -12
  280. package/sdk/platform/Share/SharePlatformApplicationClient.js +130 -52
  281. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
  282. package/sdk/platform/Share/SharePlatformApplicationValidator.js +6 -6
  283. package/sdk/platform/Share/SharePlatformModel.d.ts +8 -8
  284. package/sdk/platform/Share/SharePlatformModel.js +60 -118
  285. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +148 -124
  286. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +770 -295
  287. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +15 -15
  288. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +44 -44
  289. package/sdk/platform/Theme/ThemePlatformModel.d.ts +34 -34
  290. package/sdk/platform/Theme/ThemePlatformModel.js +190 -336
  291. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +146 -67
  292. package/sdk/platform/User/UserPlatformApplicationClient.js +742 -155
  293. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +12 -7
  294. package/sdk/platform/User/UserPlatformApplicationValidator.js +61 -23
  295. package/sdk/platform/User/UserPlatformModel.d.ts +79 -72
  296. package/sdk/platform/User/UserPlatformModel.js +440 -689
  297. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +35 -29
  298. package/sdk/platform/Webhook/WebhookPlatformClient.js +218 -91
  299. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +7 -7
  300. package/sdk/platform/Webhook/WebhookPlatformModel.js +68 -136
  301. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +3 -3
  302. package/sdk/platform/Webhook/WebhookPlatformValidator.js +14 -14
  303. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +13 -13
  304. package/sdk/public/Configuration/ConfigurationPublicClient.js +81 -38
  305. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +12 -12
  306. package/sdk/public/Configuration/ConfigurationPublicModel.js +85 -162
  307. package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +1 -1
  308. package/sdk/public/Configuration/ConfigurationPublicValidator.js +6 -6
  309. package/sdk/public/Inventory/InventoryPublicClient.d.ts +34 -34
  310. package/sdk/public/Inventory/InventoryPublicClient.js +228 -105
  311. package/sdk/public/Inventory/InventoryPublicModel.d.ts +10 -10
  312. package/sdk/public/Inventory/InventoryPublicModel.js +119 -245
  313. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +3 -3
  314. package/sdk/public/Inventory/InventoryPublicValidator.js +15 -15
  315. package/sdk/public/Webhook/WebhookPublicClient.js +51 -10
  316. package/sdk/public/Webhook/WebhookPublicModel.d.ts +7 -7
  317. package/sdk/public/Webhook/WebhookPublicModel.js +68 -136
  318. package/tests/application/catalog.spec.js +7 -0
@@ -8,18 +8,23 @@
8
8
  ## User Methods
9
9
  Authentication Service
10
10
 
11
- * [getCustomers](#getcustomers)
12
- * [searchUsers](#searchusers)
13
- * [createUser](#createuser)
14
- * [blockOrUnblockUsers](#blockorunblockusers)
15
11
  * [archiveUser](#archiveuser)
16
- * [unDeleteUser](#undeleteuser)
17
- * [updateUser](#updateuser)
12
+ * [blockOrUnblockUsers](#blockorunblockusers)
13
+ * [createUser](#createuser)
14
+ * [createUserGroup](#createusergroup)
18
15
  * [createUserSession](#createusersession)
19
- * [getActiveSessions](#getactivesessions)
20
16
  * [deleteActiveSessions](#deleteactivesessions)
17
+ * [deleteSession](#deletesession)
18
+ * [getActiveSessions](#getactivesessions)
19
+ * [getCustomers](#getcustomers)
21
20
  * [getPlatformConfig](#getplatformconfig)
21
+ * [getUserGroupById](#getusergroupbyid)
22
+ * [getUserGroups](#getusergroups)
23
+ * [searchUsers](#searchusers)
24
+ * [unDeleteUser](#undeleteuser)
22
25
  * [updatePlatformConfig](#updateplatformconfig)
26
+ * [updateUser](#updateuser)
27
+ * [updateUserGroup](#updateusergroup)
23
28
 
24
29
 
25
30
 
@@ -28,21 +33,17 @@ Authentication Service
28
33
 
29
34
 
30
35
 
31
- ### getCustomers
32
- Get a list of customers
36
+ ### archiveUser
37
+ archive user
33
38
 
34
39
 
35
40
 
36
41
  ```javascript
37
42
  // Promise
38
- const promise = client.application("<APPLICATION_ID>").user.getCustomers({ q : value,
39
- pageSize : value,
40
- pageNo : value });
43
+ const promise = client.application("<APPLICATION_ID>").user.archiveUser({ body : value });
41
44
 
42
45
  // Async/Await
43
- const data = await client.application("<APPLICATION_ID>").user.getCustomers({ q : value,
44
- pageSize : value,
45
- pageNo : value });
46
+ const data = await client.application("<APPLICATION_ID>").user.archiveUser({ body : value });
46
47
  ```
47
48
 
48
49
 
@@ -50,90 +51,34 @@ const data = await client.application("<APPLICATION_ID>").user.getCustomers({ q
50
51
 
51
52
 
52
53
  | Argument | Type | Required | Description |
53
- | --------- | ----- | -------- | ----------- |
54
- | q | Object | no | The search query. Mobile number or email ID of a customer. |
55
- | pageSize | number | no | The number of items to retrieve in each page. Default value is 10. |
56
- | pageNo | number | no | The page number to navigate through the given set of results. Default value is 1. |
57
-
54
+ | --------- | ----- | -------- | ----------- |
55
+ | body | [ArchiveUserRequestSchema](#ArchiveUserRequestSchema) | yes | Request body |
58
56
 
59
57
 
60
- Use this API to retrieve a list of customers who have registered in the application.
58
+ archive user
61
59
 
62
60
  *Returned Response:*
63
61
 
64
62
 
65
63
 
66
64
 
67
- [CustomerListResponseSchema](#CustomerListResponseSchema)
68
-
69
- Success. Refer `CustomerListResponseSchema` for more details.
70
-
65
+ [ArchiveUserSuccess](#ArchiveUserSuccess)
71
66
 
67
+ Success
72
68
 
73
69
 
74
- <details>
75
- <summary><i>&nbsp; Examples:</i></summary>
76
70
 
77
71
 
78
72
  <details>
79
- <summary><i>&nbsp; Success</i></summary>
73
+ <summary><i>&nbsp; Example:</i></summary>
80
74
 
81
75
  ```json
82
76
  {
83
- "value": {
84
- "items": [
85
- {
86
- "_id": "000000000000000023106198",
87
- "gender": "male",
88
- "active": true,
89
- "emails": [
90
- {
91
- "active": true,
92
- "primary": true,
93
- "verified": true,
94
- "email": "raaz.crzy@gmail.com"
95
- }
96
- ],
97
- "username": "raaz_crzy_gmail_com_63747_23106198",
98
- "__v": 7,
99
- "debug": {
100
- "source": "deadlock",
101
- "platform": "000000000000000000000003"
102
- },
103
- "dob": "1995-07-23T00:00:00.000Z",
104
- "id": "000000000000000023106198",
105
- "account_type": "user",
106
- "profile_pic_url": "https://hdn-1.fynd.com/user/profile/original/000000000000000023106198/1586498418772.jpg",
107
- "first_name": "Prince",
108
- "last_name": "Raj",
109
- "phone_numbers": [
110
- {
111
- "active": true,
112
- "primary": true,
113
- "verified": true,
114
- "phone": "7008963113",
115
- "country_code": 91
116
- }
117
- ],
118
- "created_at": "2019-05-15T14:07:52.872Z",
119
- "updated_at": "2020-09-21T06:38:41.388Z",
120
- "has_old_password_hash": false
121
- }
122
- ],
123
- "page": {
124
- "type": "number",
125
- "current": 1,
126
- "size": 10,
127
- "item_total": 0,
128
- "has_next": false
129
- }
130
- }
77
+ "success": true
131
78
  }
132
79
  ```
133
80
  </details>
134
81
 
135
- </details>
136
-
137
82
 
138
83
 
139
84
 
@@ -145,17 +90,17 @@ Success. Refer `CustomerListResponseSchema` for more details.
145
90
  ---
146
91
 
147
92
 
148
- ### searchUsers
149
- Search an existing user.
93
+ ### blockOrUnblockUsers
94
+ Block/Unblock user
150
95
 
151
96
 
152
97
 
153
98
  ```javascript
154
99
  // Promise
155
- const promise = client.application("<APPLICATION_ID>").user.searchUsers({ q : value });
100
+ const promise = client.application("<APPLICATION_ID>").user.blockOrUnblockUsers({ body : value });
156
101
 
157
102
  // Async/Await
158
- const data = await client.application("<APPLICATION_ID>").user.searchUsers({ q : value });
103
+ const data = await client.application("<APPLICATION_ID>").user.blockOrUnblockUsers({ body : value });
159
104
  ```
160
105
 
161
106
 
@@ -163,21 +108,20 @@ const data = await client.application("<APPLICATION_ID>").user.searchUsers({ q
163
108
 
164
109
 
165
110
  | Argument | Type | Required | Description |
166
- | --------- | ----- | -------- | ----------- |
167
- | q | string | no | The search query. Mobile number or email ID of a customer. |
168
-
111
+ | --------- | ----- | -------- | ----------- |
112
+ | body | [BlockUserRequestSchema](#BlockUserRequestSchema) | yes | Request body |
169
113
 
170
114
 
171
- Use this API to retrieve an existing user from a list.
115
+ Block/Unblock user
172
116
 
173
117
  *Returned Response:*
174
118
 
175
119
 
176
120
 
177
121
 
178
- [UserSearchResponseSchema](#UserSearchResponseSchema)
122
+ [BlockUserSuccess](#BlockUserSuccess)
179
123
 
180
- Success. Returns first name, last name, emails, phone number and gender of the user. Refer `UserSearchResponseSchema` for more details.
124
+ Success
181
125
 
182
126
 
183
127
 
@@ -187,47 +131,7 @@ Success. Returns first name, last name, emails, phone number and gender of the u
187
131
 
188
132
  ```json
189
133
  {
190
- "users": [
191
- {
192
- "_id": "5e68af49cfa09bf7233022f1",
193
- "gender": "male",
194
- "active": true,
195
- "emails": [
196
- {
197
- "active": true,
198
- "primary": true,
199
- "verified": true,
200
- "email": "akashmane@gofynd.com"
201
- },
202
- {
203
- "active": true,
204
- "primary": false,
205
- "verified": true,
206
- "email": "akashmane@fynd.com"
207
- },
208
- {
209
- "active": true,
210
- "primary": false,
211
- "verified": true,
212
- "email": "akashmane@uniket.store"
213
- }
214
- ],
215
- "account_type": "user",
216
- "first_name": "Akash",
217
- "last_name": "Mane",
218
- "phone_numbers": [
219
- {
220
- "active": true,
221
- "primary": true,
222
- "verified": true,
223
- "phone": "8652523958",
224
- "country_code": 91
225
- }
226
- ],
227
- "created_at": "2020-03-11T09:28:41.982Z",
228
- "updated_at": "2020-03-11T09:28:41.982Z"
229
- }
230
- ]
134
+ "success": true
231
135
  }
232
136
  ```
233
137
  </details>
@@ -340,17 +244,17 @@ User create
340
244
  ---
341
245
 
342
246
 
343
- ### blockOrUnblockUsers
344
- Block/Unblock user
247
+ ### createUserGroup
248
+ Create an User Group
345
249
 
346
250
 
347
251
 
348
252
  ```javascript
349
253
  // Promise
350
- const promise = client.application("<APPLICATION_ID>").user.blockOrUnblockUsers({ body : value });
254
+ const promise = client.application("<APPLICATION_ID>").user.createUserGroup({ body : value });
351
255
 
352
256
  // Async/Await
353
- const data = await client.application("<APPLICATION_ID>").user.blockOrUnblockUsers({ body : value });
257
+ const data = await client.application("<APPLICATION_ID>").user.createUserGroup({ body : value });
354
258
  ```
355
259
 
356
260
 
@@ -359,19 +263,19 @@ const data = await client.application("<APPLICATION_ID>").user.blockOrUnblockUse
359
263
 
360
264
  | Argument | Type | Required | Description |
361
265
  | --------- | ----- | -------- | ----------- |
362
- | body | [BlockUserRequestSchema](#BlockUserRequestSchema) | yes | Request body |
266
+ | body | [CreateUserGroupSchema](#CreateUserGroupSchema) | yes | Request body |
363
267
 
364
268
 
365
- Block/Unblock user
269
+ Use this API to create new user Group
366
270
 
367
271
  *Returned Response:*
368
272
 
369
273
 
370
274
 
371
275
 
372
- [BlockUserSuccess](#BlockUserSuccess)
276
+ [UserGroupResponseSchema](#UserGroupResponseSchema)
373
277
 
374
- Success
278
+ Success. returns created User Group. `UserGroupResponseSchema` for more details.
375
279
 
376
280
 
377
281
 
@@ -381,7 +285,17 @@ Success
381
285
 
382
286
  ```json
383
287
  {
384
- "success": true
288
+ "is_active": true,
289
+ "_id": "6345677535474fbb6944b7ce",
290
+ "name": "Group 1",
291
+ "description": "description",
292
+ "file_url": "url",
293
+ "status": "pending",
294
+ "uid": 1,
295
+ "application_id": "000000000000000000000001",
296
+ "created_at": "2022-10-11T12:54:13.539Z",
297
+ "modified_at": "2022-10-11T12:54:13.539Z",
298
+ "__v": 0
385
299
  }
386
300
  ```
387
301
  </details>
@@ -397,17 +311,17 @@ Success
397
311
  ---
398
312
 
399
313
 
400
- ### archiveUser
401
- archive user
314
+ ### createUserSession
315
+ Create user session
402
316
 
403
317
 
404
318
 
405
319
  ```javascript
406
320
  // Promise
407
- const promise = client.application("<APPLICATION_ID>").user.archiveUser({ body : value });
321
+ const promise = client.application("<APPLICATION_ID>").user.createUserSession({ body : value });
408
322
 
409
323
  // Async/Await
410
- const data = await client.application("<APPLICATION_ID>").user.archiveUser({ body : value });
324
+ const data = await client.application("<APPLICATION_ID>").user.createUserSession({ body : value });
411
325
  ```
412
326
 
413
327
 
@@ -416,19 +330,19 @@ const data = await client.application("<APPLICATION_ID>").user.archiveUser({ bo
416
330
 
417
331
  | Argument | Type | Required | Description |
418
332
  | --------- | ----- | -------- | ----------- |
419
- | body | [ArchiveUserRequestSchema](#ArchiveUserRequestSchema) | yes | Request body |
333
+ | body | [CreateUserSessionRequestSchema](#CreateUserSessionRequestSchema) | yes | Request body |
420
334
 
421
335
 
422
- archive user
336
+ Create user session
423
337
 
424
338
  *Returned Response:*
425
339
 
426
340
 
427
341
 
428
342
 
429
- [ArchiveUserSuccess](#ArchiveUserSuccess)
343
+ [CreateUserSessionResponseSchema](#CreateUserSessionResponseSchema)
430
344
 
431
- Success
345
+ Create user session
432
346
 
433
347
 
434
348
 
@@ -438,7 +352,13 @@ Success
438
352
 
439
353
  ```json
440
354
  {
441
- "success": true
355
+ "domain": "vinit.com",
356
+ "max_age": 4555555,
357
+ "secure": true,
358
+ "http_only": true,
359
+ "cookie": {
360
+ "f.session": "s%3A-LrEF5FVR8jrT5DCtCHSbAy7JFyX-f9T.uXOQwzje8nOfx4ODANrLi4yNX5fW2W5kLQ2rkBdO2xE"
361
+ }
442
362
  }
443
363
  ```
444
364
  </details>
@@ -454,17 +374,19 @@ Success
454
374
  ---
455
375
 
456
376
 
457
- ### unDeleteUser
458
- undelete user who deleted from application and have not elapsed the platform configured delete days
377
+ ### deleteActiveSessions
378
+ Delete a list of all session for a user
459
379
 
460
380
 
461
381
 
462
382
  ```javascript
463
383
  // Promise
464
- const promise = client.application("<APPLICATION_ID>").user.unDeleteUser({ body : value });
384
+ const promise = client.application("<APPLICATION_ID>").user.deleteActiveSessions({ id : value,
385
+ reason : value });
465
386
 
466
387
  // Async/Await
467
- const data = await client.application("<APPLICATION_ID>").user.unDeleteUser({ body : value });
388
+ const data = await client.application("<APPLICATION_ID>").user.deleteActiveSessions({ id : value,
389
+ reason : value });
468
390
  ```
469
391
 
470
392
 
@@ -472,34 +394,47 @@ const data = await client.application("<APPLICATION_ID>").user.unDeleteUser({ b
472
394
 
473
395
 
474
396
  | Argument | Type | Required | Description |
475
- | --------- | ----- | -------- | ----------- |
476
- | body | [UnDeleteUserRequestSchema](#UnDeleteUserRequestSchema) | yes | Request body |
397
+ | --------- | ----- | -------- | ----------- |
398
+ | id | string | yes | ID of a customer. |
399
+ | reason | string | yes | Reason to delete sessions. |
477
400
 
478
401
 
479
- undelete user who deleted from application and have not elapsed the platform configured delete days
402
+
403
+ Use this API to Delete a list of session of customers who have registered in the application.
480
404
 
481
405
  *Returned Response:*
482
406
 
483
407
 
484
408
 
485
409
 
486
- [UnDeleteUserSuccess](#UnDeleteUserSuccess)
410
+ [SessionDeleteResponseSchema](#SessionDeleteResponseSchema)
487
411
 
488
- Success
412
+ Success. Refer `SessionDeleteResponseSchema` for more details.
489
413
 
490
414
 
491
415
 
492
416
 
493
417
  <details>
494
- <summary><i>&nbsp; Example:</i></summary>
418
+ <summary><i>&nbsp; Examples:</i></summary>
419
+
420
+
421
+ <details>
422
+ <summary><i>&nbsp; Success</i></summary>
495
423
 
496
424
  ```json
497
425
  {
498
- "success": true
426
+ "value": {
427
+ "items": [
428
+ "sess:123",
429
+ "sess:456"
430
+ ]
431
+ }
499
432
  }
500
433
  ```
501
434
  </details>
502
435
 
436
+ </details>
437
+
503
438
 
504
439
 
505
440
 
@@ -511,19 +446,21 @@ Success
511
446
  ---
512
447
 
513
448
 
514
- ### updateUser
515
- Update user
449
+ ### deleteSession
450
+ Delete a session for a user
516
451
 
517
452
 
518
453
 
519
454
  ```javascript
520
455
  // Promise
521
- const promise = client.application("<APPLICATION_ID>").user.updateUser({ userId : value,
522
- body : value });
456
+ const promise = client.application("<APPLICATION_ID>").user.deleteSession({ id : value,
457
+ sessionId : value,
458
+ reason : value });
523
459
 
524
460
  // Async/Await
525
- const data = await client.application("<APPLICATION_ID>").user.updateUser({ userId : value,
526
- body : value });
461
+ const data = await client.application("<APPLICATION_ID>").user.deleteSession({ id : value,
462
+ sessionId : value,
463
+ reason : value });
527
464
  ```
528
465
 
529
466
 
@@ -532,74 +469,365 @@ const data = await client.application("<APPLICATION_ID>").user.updateUser({ use
532
469
 
533
470
  | Argument | Type | Required | Description |
534
471
  | --------- | ----- | -------- | ----------- |
535
- | userId | string | yes | User ID |
536
- | body | [UpdateUserRequestSchema](#UpdateUserRequestSchema) | yes | Request body |
472
+ | id | string | yes | ID of a customer. |
473
+ | sessionId | string | yes | Session ID of a customer. |
474
+ | reason | string | yes | Reason for deleting session. |
537
475
 
538
476
 
539
- Update user
477
+
478
+ Use this API to Delete a session of customers who have registered in the application.
540
479
 
541
480
  *Returned Response:*
542
481
 
543
482
 
544
483
 
545
484
 
546
- [CreateUserResponseSchema](#CreateUserResponseSchema)
485
+ [SessionDeleteResponseSchema](#SessionDeleteResponseSchema)
547
486
 
548
- User update
487
+ Success. Refer `SessionDeleteResponseSchema` for more details.
549
488
 
550
489
 
551
490
 
552
491
 
553
492
  <details>
554
- <summary><i>&nbsp; Example:</i></summary>
493
+ <summary><i>&nbsp; Examples:</i></summary>
494
+
495
+
496
+ <details>
497
+ <summary><i>&nbsp; Success</i></summary>
555
498
 
556
499
  ```json
557
500
  {
558
- "user": {
559
- "_id": "5e68af49cfa09bf7233022f1",
560
- "gender": "male",
561
- "active": true,
562
- "emails": [
563
- {
564
- "active": true,
565
- "primary": true,
566
- "verified": true,
567
- "email": "akashmane@gofynd.com"
568
- },
569
- {
570
- "active": true,
571
- "primary": false,
572
- "verified": true,
573
- "email": "akashmane@fynd.com"
574
- },
575
- {
576
- "active": true,
577
- "primary": false,
578
- "verified": true,
579
- "email": "akashmane@uniket.store"
580
- }
581
- ],
582
- "external_id": "100002000036789",
583
- "account_type": "user",
584
- "first_name": "Akash",
585
- "last_name": "Mane",
586
- "phone_numbers": [
501
+ "value": {
502
+ "items": [
503
+ "sess:123",
504
+ "sess:456"
505
+ ]
506
+ }
507
+ }
508
+ ```
509
+ </details>
510
+
511
+ </details>
512
+
513
+
514
+
515
+
516
+
517
+
518
+
519
+
520
+
521
+ ---
522
+
523
+
524
+ ### getActiveSessions
525
+ Get a list of all session with info for a user
526
+
527
+
528
+
529
+ ```javascript
530
+ // Promise
531
+ const promise = client.application("<APPLICATION_ID>").user.getActiveSessions({ id : value });
532
+
533
+ // Async/Await
534
+ const data = await client.application("<APPLICATION_ID>").user.getActiveSessions({ id : value });
535
+ ```
536
+
537
+
538
+
539
+
540
+
541
+ | Argument | Type | Required | Description |
542
+ | --------- | ----- | -------- | ----------- |
543
+ | id | string | yes | ID of a customer. |
544
+
545
+
546
+
547
+ Use this API to retrieve a list of session with info of customers who have registered in the application.
548
+
549
+ *Returned Response:*
550
+
551
+
552
+
553
+
554
+ [SessionListResponseSchema](#SessionListResponseSchema)
555
+
556
+ Success. Refer `SessionListResponseSchema` for more details.
557
+
558
+
559
+
560
+
561
+ <details>
562
+ <summary><i>&nbsp; Examples:</i></summary>
563
+
564
+
565
+ <details>
566
+ <summary><i>&nbsp; Success</i></summary>
567
+
568
+ ```json
569
+ {
570
+ "value": {
571
+ "items": [
572
+ "sess:123",
573
+ "sess:456"
574
+ ]
575
+ }
576
+ }
577
+ ```
578
+ </details>
579
+
580
+ </details>
581
+
582
+
583
+
584
+
585
+
586
+
587
+
588
+
589
+
590
+ ---
591
+
592
+
593
+ ### getCustomers
594
+ Get a list of customers
595
+
596
+
597
+
598
+ ```javascript
599
+ // Promise
600
+ const promise = client.application("<APPLICATION_ID>").user.getCustomers({ q : value,
601
+ pageSize : value,
602
+ pageNo : value });
603
+
604
+ // Async/Await
605
+ const data = await client.application("<APPLICATION_ID>").user.getCustomers({ q : value,
606
+ pageSize : value,
607
+ pageNo : value });
608
+ ```
609
+
610
+
611
+
612
+
613
+
614
+ | Argument | Type | Required | Description |
615
+ | --------- | ----- | -------- | ----------- |
616
+ | q | Object | no | The search query. Mobile number or email ID of a customer. |
617
+ | pageSize | number | no | The number of items to retrieve in each page. Default value is 10. |
618
+ | pageNo | number | no | The page number to navigate through the given set of results. Default value is 1. |
619
+
620
+
621
+
622
+ Use this API to retrieve a list of customers who have registered in the application.
623
+
624
+ *Returned Response:*
625
+
626
+
627
+
628
+
629
+ [CustomerListResponseSchema](#CustomerListResponseSchema)
630
+
631
+ Success. Refer `CustomerListResponseSchema` for more details.
632
+
633
+
634
+
635
+
636
+ <details>
637
+ <summary><i>&nbsp; Examples:</i></summary>
638
+
639
+
640
+ <details>
641
+ <summary><i>&nbsp; Success</i></summary>
642
+
643
+ ```json
644
+ {
645
+ "value": {
646
+ "items": [
587
647
  {
648
+ "_id": "000000000000000023106198",
649
+ "gender": "male",
588
650
  "active": true,
589
- "primary": true,
590
- "verified": true,
591
- "phone": "8652523958",
592
- "country_code": 91
651
+ "emails": [
652
+ {
653
+ "active": true,
654
+ "primary": true,
655
+ "verified": true,
656
+ "email": "raaz.crzy@gmail.com"
657
+ }
658
+ ],
659
+ "username": "raaz_crzy_gmail_com_63747_23106198",
660
+ "__v": 7,
661
+ "debug": {
662
+ "source": "deadlock",
663
+ "platform": "000000000000000000000003"
664
+ },
665
+ "dob": "1995-07-23T00:00:00.000Z",
666
+ "id": "000000000000000023106198",
667
+ "account_type": "user",
668
+ "profile_pic_url": "https://hdn-1.fynd.com/user/profile/original/000000000000000023106198/1586498418772.jpg",
669
+ "first_name": "Prince",
670
+ "last_name": "Raj",
671
+ "phone_numbers": [
672
+ {
673
+ "active": true,
674
+ "primary": true,
675
+ "verified": true,
676
+ "phone": "7008963113",
677
+ "country_code": 91
678
+ }
679
+ ],
680
+ "created_at": "2019-05-15T14:07:52.872Z",
681
+ "updated_at": "2020-09-21T06:38:41.388Z",
682
+ "has_old_password_hash": false
593
683
  }
594
684
  ],
595
- "meta": {},
596
- "created_at": "2020-03-11T09:28:41.982Z",
597
- "updated_at": "2020-03-11T09:28:41.982Z"
685
+ "page": {
686
+ "type": "number",
687
+ "current": 1,
688
+ "size": 10,
689
+ "item_total": 0,
690
+ "has_next": false
691
+ }
598
692
  }
599
693
  }
600
694
  ```
601
695
  </details>
602
696
 
697
+ </details>
698
+
699
+
700
+
701
+
702
+
703
+
704
+
705
+
706
+
707
+ ---
708
+
709
+
710
+ ### getPlatformConfig
711
+ Get platform configurations
712
+
713
+
714
+
715
+ ```javascript
716
+ // Promise
717
+ const promise = client.application("<APPLICATION_ID>").user.getPlatformConfig();
718
+
719
+ // Async/Await
720
+ const data = await client.application("<APPLICATION_ID>").user.getPlatformConfig();
721
+ ```
722
+
723
+
724
+
725
+
726
+
727
+
728
+ Use this API to get all the platform configurations such as mobile image, desktop image, social logins, and all other text.
729
+
730
+ *Returned Response:*
731
+
732
+
733
+
734
+
735
+ [PlatformSchema](#PlatformSchema)
736
+
737
+ Success. Returns a JSON object containing the all the platform configurations. Refer `PlatformSchema` for more details.
738
+
739
+
740
+
741
+
742
+ <details>
743
+ <summary><i>&nbsp; Example:</i></summary>
744
+
745
+ ```json
746
+ {
747
+ "active": true,
748
+ "mobile_image": "",
749
+ "desktop_image": "",
750
+ "social": {
751
+ "facebook": true,
752
+ "google": true,
753
+ "account_kit": true
754
+ },
755
+ "flash_card": {
756
+ "text": "",
757
+ "text_color": "#FFFFFF",
758
+ "background_color": "#EF5350"
759
+ },
760
+ "register": true,
761
+ "forgot_password": true,
762
+ "login": {
763
+ "password": true,
764
+ "otp": true
765
+ },
766
+ "skip_captcha": false,
767
+ "display": "Fynd",
768
+ "subtext": "Login to Fynd",
769
+ "name": "Fynd",
770
+ "meta": {},
771
+ "required_fields": {
772
+ "email": {
773
+ "is_required": false,
774
+ "level": "hard"
775
+ },
776
+ "mobile": {
777
+ "is_required": true,
778
+ "level": "hard"
779
+ }
780
+ },
781
+ "register_required_fields": {
782
+ "email": {
783
+ "is_required": false,
784
+ "level": "hard"
785
+ },
786
+ "mobile": {
787
+ "is_required": true,
788
+ "level": "hard"
789
+ }
790
+ },
791
+ "skip_login": false,
792
+ "look_and_feel": {
793
+ "background_color": "#F5F5F5",
794
+ "card_position": "center"
795
+ },
796
+ "social_tokens": {
797
+ "google": {
798
+ "appId": "token_123"
799
+ },
800
+ "facebook": {
801
+ "appId": "token_123"
802
+ },
803
+ "account_kit": {
804
+ "appId": "token_123"
805
+ }
806
+ },
807
+ "session_config": {
808
+ "duration": 30,
809
+ "type": "Days",
810
+ "is_rolling": false
811
+ },
812
+ "delete_account_reasons": [
813
+ {
814
+ "reason_text": "test",
815
+ "reason_id": "123",
816
+ "show_text_area": true
817
+ }
818
+ ],
819
+ "delete_account_day": 7,
820
+ "delete_account_consent": {
821
+ "consent_text": ""
822
+ },
823
+ "_id": "5e04a5e5220bc15839ad9bc0",
824
+ "created_at": "2019-12-26T12:21:57.878Z",
825
+ "updated_at": "2020-08-13T14:31:09.878Z",
826
+ "__v": 0
827
+ }
828
+ ```
829
+ </details>
830
+
603
831
 
604
832
 
605
833
 
@@ -611,17 +839,17 @@ User update
611
839
  ---
612
840
 
613
841
 
614
- ### createUserSession
615
- Create user session
842
+ ### getUserGroupById
843
+ Get an User Group by Id
616
844
 
617
845
 
618
846
 
619
847
  ```javascript
620
848
  // Promise
621
- const promise = client.application("<APPLICATION_ID>").user.createUserSession({ body : value });
849
+ const promise = client.application("<APPLICATION_ID>").user.getUserGroupById({ groupId : value });
622
850
 
623
851
  // Async/Await
624
- const data = await client.application("<APPLICATION_ID>").user.createUserSession({ body : value });
852
+ const data = await client.application("<APPLICATION_ID>").user.getUserGroupById({ groupId : value });
625
853
  ```
626
854
 
627
855
 
@@ -629,20 +857,21 @@ const data = await client.application("<APPLICATION_ID>").user.createUserSession
629
857
 
630
858
 
631
859
  | Argument | Type | Required | Description |
632
- | --------- | ----- | -------- | ----------- |
633
- | body | [CreateUserSessionRequestSchema](#CreateUserSessionRequestSchema) | yes | Request body |
860
+ | --------- | ----- | -------- | ----------- |
861
+ | groupId | string | yes | Numeric ID allotted to a User Group |
634
862
 
635
863
 
636
- Create user session
864
+
865
+ Use this API to get details of an existing user Group
637
866
 
638
867
  *Returned Response:*
639
868
 
640
869
 
641
870
 
642
871
 
643
- [CreateUserSessionResponseSchema](#CreateUserSessionResponseSchema)
872
+ [UserGroupResponseSchema](#UserGroupResponseSchema)
644
873
 
645
- Create user session
874
+ Success. User Group details. `UserGroupResponseSchema` for more details.
646
875
 
647
876
 
648
877
 
@@ -652,13 +881,17 @@ Create user session
652
881
 
653
882
  ```json
654
883
  {
655
- "domain": "vinit.com",
656
- "max_age": 4555555,
657
- "secure": true,
658
- "http_only": true,
659
- "cookie": {
660
- "f.session": "s%3A-LrEF5FVR8jrT5DCtCHSbAy7JFyX-f9T.uXOQwzje8nOfx4ODANrLi4yNX5fW2W5kLQ2rkBdO2xE"
661
- }
884
+ "is_active": true,
885
+ "_id": "6345677535474fbb6944b7ce",
886
+ "name": "Group 1",
887
+ "description": "description",
888
+ "file_url": "url",
889
+ "status": "pending",
890
+ "uid": 1,
891
+ "application_id": "000000000000000000000001",
892
+ "created_at": "2022-10-11T12:54:13.539Z",
893
+ "modified_at": "2022-10-11T12:54:13.539Z",
894
+ "__v": 0
662
895
  }
663
896
  ```
664
897
  </details>
@@ -674,17 +907,25 @@ Create user session
674
907
  ---
675
908
 
676
909
 
677
- ### getActiveSessions
678
- Get a list of all session for a user
910
+ ### getUserGroups
911
+ Get User Groups mathcing criteria
679
912
 
680
913
 
681
914
 
682
915
  ```javascript
683
916
  // Promise
684
- const promise = client.application("<APPLICATION_ID>").user.getActiveSessions({ id : value });
917
+ const promise = client.application("<APPLICATION_ID>").user.getUserGroups({ pageNo : value,
918
+ pageSize : value,
919
+ name : value,
920
+ status : value,
921
+ groupUid : value });
685
922
 
686
923
  // Async/Await
687
- const data = await client.application("<APPLICATION_ID>").user.getActiveSessions({ id : value });
924
+ const data = await client.application("<APPLICATION_ID>").user.getUserGroups({ pageNo : value,
925
+ pageSize : value,
926
+ name : value,
927
+ status : value,
928
+ groupUid : value });
688
929
  ```
689
930
 
690
931
 
@@ -692,46 +933,73 @@ const data = await client.application("<APPLICATION_ID>").user.getActiveSessions
692
933
 
693
934
 
694
935
  | Argument | Type | Required | Description |
695
- | --------- | ----- | -------- | ----------- |
696
- | id | string | yes | ID of a customer. |
936
+ | --------- | ----- | -------- | ----------- |
937
+ | pageNo | string | no | page number for pagination result |
938
+ | pageSize | string | no | page size for pagination result |
939
+ | name | string | no | to seartch for User Groups which contains given string in their name |
940
+ | status | string | no | to get User Groups with given status |
941
+ | groupUid | number | no | to get User Groups with given uid |
697
942
 
698
943
 
699
944
 
700
- Use this API to retrieve a list of session of customers who have registered in the application.
945
+ Use this API to get User Groups mathing criteria passed in query
701
946
 
702
947
  *Returned Response:*
703
948
 
704
949
 
705
950
 
706
951
 
707
- [SessionListResponseSchema](#SessionListResponseSchema)
708
-
709
- Success. Refer `SessionListResponseSchema` for more details.
710
-
952
+ [UserGroupListResponseSchema](#UserGroupListResponseSchema)
711
953
 
954
+ Success. User Group details. `UserGroupListResponseSchema` for more details.
712
955
 
713
956
 
714
- <details>
715
- <summary><i>&nbsp; Examples:</i></summary>
716
957
 
717
958
 
718
959
  <details>
719
- <summary><i>&nbsp; Success</i></summary>
960
+ <summary><i>&nbsp; Example:</i></summary>
720
961
 
721
962
  ```json
722
963
  {
723
- "value": {
724
- "items": [
725
- "sess:123",
726
- "sess:456"
727
- ]
964
+ "items": [
965
+ {
966
+ "is_active": true,
967
+ "_id": "6345677535474fbb6944b7ce",
968
+ "name": "Group 1",
969
+ "description": "description",
970
+ "file_url": "url",
971
+ "status": "pending",
972
+ "uid": 1,
973
+ "application_id": "000000000000000000000001",
974
+ "created_at": "2022-10-11T12:54:13.539Z",
975
+ "modified_at": "2022-10-11T12:54:13.539Z",
976
+ "__v": 0
977
+ },
978
+ {
979
+ "is_active": true,
980
+ "_id": "6345677535474fbb6944b7ced",
981
+ "name": "Group 2",
982
+ "description": "description",
983
+ "file_url": "url2",
984
+ "status": "pending",
985
+ "uid": 1,
986
+ "application_id": "000000000000000000000001",
987
+ "created_at": "2022-10-11T12:54:13.539Z",
988
+ "modified_at": "2022-10-11T12:54:13.539Z",
989
+ "__v": 0
990
+ }
991
+ ],
992
+ "page": {
993
+ "type": "number",
994
+ "current": 1,
995
+ "size": 10,
996
+ "item_total": 0,
997
+ "has_next": false
728
998
  }
729
999
  }
730
1000
  ```
731
1001
  </details>
732
1002
 
733
- </details>
734
-
735
1003
 
736
1004
 
737
1005
 
@@ -743,17 +1011,17 @@ Success. Refer `SessionListResponseSchema` for more details.
743
1011
  ---
744
1012
 
745
1013
 
746
- ### deleteActiveSessions
747
- Delete a list of all session for a user
1014
+ ### searchUsers
1015
+ Search an existing user.
748
1016
 
749
1017
 
750
1018
 
751
1019
  ```javascript
752
1020
  // Promise
753
- const promise = client.application("<APPLICATION_ID>").user.deleteActiveSessions({ id : value });
1021
+ const promise = client.application("<APPLICATION_ID>").user.searchUsers({ q : value });
754
1022
 
755
1023
  // Async/Await
756
- const data = await client.application("<APPLICATION_ID>").user.deleteActiveSessions({ id : value });
1024
+ const data = await client.application("<APPLICATION_ID>").user.searchUsers({ q : value });
757
1025
  ```
758
1026
 
759
1027
 
@@ -761,46 +1029,132 @@ const data = await client.application("<APPLICATION_ID>").user.deleteActiveSessi
761
1029
 
762
1030
 
763
1031
  | Argument | Type | Required | Description |
764
- | --------- | ----- | -------- | ----------- |
765
- | id | string | yes | ID of a customer. |
1032
+ | --------- | ----- | -------- | ----------- |
1033
+ | q | string | no | The search query. Mobile number or email ID of a customer. |
766
1034
 
767
1035
 
768
1036
 
769
- Use this API to Delete a list of session of customers who have registered in the application.
1037
+ Use this API to retrieve an existing user from a list.
770
1038
 
771
1039
  *Returned Response:*
772
1040
 
773
1041
 
774
1042
 
775
1043
 
776
- [SessionDeleteResponseSchema](#SessionDeleteResponseSchema)
1044
+ [UserSearchResponseSchema](#UserSearchResponseSchema)
777
1045
 
778
- Success. Refer `SessionDeleteResponseSchema` for more details.
1046
+ Success. Returns first name, last name, emails, phone number and gender of the user. Refer `UserSearchResponseSchema` for more details.
779
1047
 
780
1048
 
781
1049
 
782
1050
 
783
1051
  <details>
784
- <summary><i>&nbsp; Examples:</i></summary>
1052
+ <summary><i>&nbsp; Example:</i></summary>
1053
+
1054
+ ```json
1055
+ {
1056
+ "users": [
1057
+ {
1058
+ "_id": "5e68af49cfa09bf7233022f1",
1059
+ "gender": "male",
1060
+ "active": true,
1061
+ "emails": [
1062
+ {
1063
+ "active": true,
1064
+ "primary": true,
1065
+ "verified": true,
1066
+ "email": "akashmane@gofynd.com"
1067
+ },
1068
+ {
1069
+ "active": true,
1070
+ "primary": false,
1071
+ "verified": true,
1072
+ "email": "akashmane@fynd.com"
1073
+ },
1074
+ {
1075
+ "active": true,
1076
+ "primary": false,
1077
+ "verified": true,
1078
+ "email": "akashmane@uniket.store"
1079
+ }
1080
+ ],
1081
+ "account_type": "user",
1082
+ "first_name": "Akash",
1083
+ "last_name": "Mane",
1084
+ "phone_numbers": [
1085
+ {
1086
+ "active": true,
1087
+ "primary": true,
1088
+ "verified": true,
1089
+ "phone": "8652523958",
1090
+ "country_code": 91
1091
+ }
1092
+ ],
1093
+ "created_at": "2020-03-11T09:28:41.982Z",
1094
+ "updated_at": "2020-03-11T09:28:41.982Z"
1095
+ }
1096
+ ]
1097
+ }
1098
+ ```
1099
+ </details>
1100
+
1101
+
1102
+
1103
+
1104
+
1105
+
1106
+
1107
+
1108
+
1109
+ ---
1110
+
1111
+
1112
+ ### unDeleteUser
1113
+ undelete user who deleted from application and have not elapsed the platform configured delete days
1114
+
1115
+
1116
+
1117
+ ```javascript
1118
+ // Promise
1119
+ const promise = client.application("<APPLICATION_ID>").user.unDeleteUser({ body : value });
1120
+
1121
+ // Async/Await
1122
+ const data = await client.application("<APPLICATION_ID>").user.unDeleteUser({ body : value });
1123
+ ```
1124
+
1125
+
1126
+
1127
+
1128
+
1129
+ | Argument | Type | Required | Description |
1130
+ | --------- | ----- | -------- | ----------- |
1131
+ | body | [UnDeleteUserRequestSchema](#UnDeleteUserRequestSchema) | yes | Request body |
1132
+
1133
+
1134
+ undelete user who deleted from application and have not elapsed the platform configured delete days
1135
+
1136
+ *Returned Response:*
1137
+
1138
+
1139
+
1140
+
1141
+ [UnDeleteUserSuccess](#UnDeleteUserSuccess)
1142
+
1143
+ Success
1144
+
1145
+
785
1146
 
786
1147
 
787
1148
  <details>
788
- <summary><i>&nbsp; Success</i></summary>
1149
+ <summary><i>&nbsp; Example:</i></summary>
789
1150
 
790
1151
  ```json
791
1152
  {
792
- "value": {
793
- "items": [
794
- "sess:123",
795
- "sess:456"
796
- ]
797
- }
1153
+ "success": true
798
1154
  }
799
1155
  ```
800
1156
  </details>
801
1157
 
802
- </details>
803
-
804
1158
 
805
1159
 
806
1160
 
@@ -812,25 +1166,29 @@ Success. Refer `SessionDeleteResponseSchema` for more details.
812
1166
  ---
813
1167
 
814
1168
 
815
- ### getPlatformConfig
816
- Get platform configurations
1169
+ ### updatePlatformConfig
1170
+ Update platform configurations
817
1171
 
818
1172
 
819
1173
 
820
1174
  ```javascript
821
1175
  // Promise
822
- const promise = client.application("<APPLICATION_ID>").user.getPlatformConfig();
1176
+ const promise = client.application("<APPLICATION_ID>").user.updatePlatformConfig({ body : value });
823
1177
 
824
1178
  // Async/Await
825
- const data = await client.application("<APPLICATION_ID>").user.getPlatformConfig();
1179
+ const data = await client.application("<APPLICATION_ID>").user.updatePlatformConfig({ body : value });
826
1180
  ```
827
1181
 
828
1182
 
829
1183
 
830
1184
 
831
1185
 
1186
+ | Argument | Type | Required | Description |
1187
+ | --------- | ----- | -------- | ----------- |
1188
+ | body | [PlatformSchema](#PlatformSchema) | yes | Request body |
1189
+
832
1190
 
833
- Use this API to get all the platform configurations such as mobile image, desktop image, social logins, and all other text.
1191
+ Use this API to edit the existing platform configurations such as mobile image, desktop image, social logins, and all other text.
834
1192
 
835
1193
  *Returned Response:*
836
1194
 
@@ -839,7 +1197,7 @@ Use this API to get all the platform configurations such as mobile image, deskto
839
1197
 
840
1198
  [PlatformSchema](#PlatformSchema)
841
1199
 
842
- Success. Returns a JSON object containing the all the platform configurations. Refer `PlatformSchema` for more details.
1200
+ Success. Returns a JSON object with the updated platform configurations. Refer `PlatformSchema` for more details.
843
1201
 
844
1202
 
845
1203
 
@@ -944,17 +1302,119 @@ Success. Returns a JSON object containing the all the platform configurations. R
944
1302
  ---
945
1303
 
946
1304
 
947
- ### updatePlatformConfig
948
- Update platform configurations
1305
+ ### updateUser
1306
+ Update user
1307
+
1308
+
1309
+
1310
+ ```javascript
1311
+ // Promise
1312
+ const promise = client.application("<APPLICATION_ID>").user.updateUser({ userId : value,
1313
+ body : value });
1314
+
1315
+ // Async/Await
1316
+ const data = await client.application("<APPLICATION_ID>").user.updateUser({ userId : value,
1317
+ body : value });
1318
+ ```
1319
+
1320
+
1321
+
1322
+
1323
+
1324
+ | Argument | Type | Required | Description |
1325
+ | --------- | ----- | -------- | ----------- |
1326
+ | userId | string | yes | User ID |
1327
+ | body | [UpdateUserRequestSchema](#UpdateUserRequestSchema) | yes | Request body |
1328
+
1329
+
1330
+ Use this API to update user details, Note: Existing emails and phone numbers of user will be replaced directly if phone_numbers or emails field sent in request data.
1331
+
1332
+ *Returned Response:*
1333
+
1334
+
1335
+
1336
+
1337
+ [CreateUserResponseSchema](#CreateUserResponseSchema)
1338
+
1339
+ User update
1340
+
1341
+
1342
+
1343
+
1344
+ <details>
1345
+ <summary><i>&nbsp; Example:</i></summary>
1346
+
1347
+ ```json
1348
+ {
1349
+ "user": {
1350
+ "_id": "5e68af49cfa09bf7233022f1",
1351
+ "gender": "male",
1352
+ "active": true,
1353
+ "emails": [
1354
+ {
1355
+ "active": true,
1356
+ "primary": true,
1357
+ "verified": true,
1358
+ "email": "akashmane@gofynd.com"
1359
+ },
1360
+ {
1361
+ "active": true,
1362
+ "primary": false,
1363
+ "verified": true,
1364
+ "email": "akashmane@fynd.com"
1365
+ },
1366
+ {
1367
+ "active": true,
1368
+ "primary": false,
1369
+ "verified": true,
1370
+ "email": "akashmane@uniket.store"
1371
+ }
1372
+ ],
1373
+ "external_id": "100002000036789",
1374
+ "account_type": "user",
1375
+ "first_name": "Akash",
1376
+ "last_name": "Mane",
1377
+ "phone_numbers": [
1378
+ {
1379
+ "active": true,
1380
+ "primary": true,
1381
+ "verified": true,
1382
+ "phone": "8652523958",
1383
+ "country_code": 91
1384
+ }
1385
+ ],
1386
+ "meta": {},
1387
+ "created_at": "2020-03-11T09:28:41.982Z",
1388
+ "updated_at": "2020-03-11T09:28:41.982Z"
1389
+ }
1390
+ }
1391
+ ```
1392
+ </details>
1393
+
1394
+
1395
+
1396
+
1397
+
1398
+
1399
+
1400
+
1401
+
1402
+ ---
1403
+
1404
+
1405
+ ### updateUserGroup
1406
+ Update an User Group
949
1407
 
950
1408
 
951
1409
 
952
1410
  ```javascript
953
1411
  // Promise
954
- const promise = client.application("<APPLICATION_ID>").user.updatePlatformConfig({ body : value });
1412
+ const promise = client.application("<APPLICATION_ID>").user.updateUserGroup({ groupId : value,
1413
+ body : value });
955
1414
 
956
1415
  // Async/Await
957
- const data = await client.application("<APPLICATION_ID>").user.updatePlatformConfig({ body : value });
1416
+ const data = await client.application("<APPLICATION_ID>").user.updateUserGroup({ groupId : value,
1417
+ body : value });
958
1418
  ```
959
1419
 
960
1420
 
@@ -962,20 +1422,21 @@ const data = await client.application("<APPLICATION_ID>").user.updatePlatformCon
962
1422
 
963
1423
 
964
1424
  | Argument | Type | Required | Description |
965
- | --------- | ----- | -------- | ----------- |
966
- | body | [PlatformSchema](#PlatformSchema) | yes | Request body |
1425
+ | --------- | ----- | -------- | ----------- |
1426
+ | groupId | string | yes | Numeric ID allotted to a User Group |
1427
+ | body | [UpdateUserGroupSchema](#UpdateUserGroupSchema) | yes | Request body |
967
1428
 
968
1429
 
969
- Use this API to edit the existing platform configurations such as mobile image, desktop image, social logins, and all other text.
1430
+ Use this API to update an existing user Group
970
1431
 
971
1432
  *Returned Response:*
972
1433
 
973
1434
 
974
1435
 
975
1436
 
976
- [PlatformSchema](#PlatformSchema)
1437
+ [UserGroupResponseSchema](#UserGroupResponseSchema)
977
1438
 
978
- Success. Returns a JSON object with the updated platform configurations. Refer `PlatformSchema` for more details.
1439
+ Success. returns updated User Group. `UserGroupResponseSchema` for more details.
979
1440
 
980
1441
 
981
1442
 
@@ -985,85 +1446,16 @@ Success. Returns a JSON object with the updated platform configurations. Refer `
985
1446
 
986
1447
  ```json
987
1448
  {
988
- "active": true,
989
- "mobile_image": "",
990
- "desktop_image": "",
991
- "social": {
992
- "facebook": true,
993
- "google": true,
994
- "account_kit": true
995
- },
996
- "flash_card": {
997
- "text": "",
998
- "text_color": "#FFFFFF",
999
- "background_color": "#EF5350"
1000
- },
1001
- "register": true,
1002
- "forgot_password": true,
1003
- "login": {
1004
- "password": true,
1005
- "otp": true
1006
- },
1007
- "skip_captcha": false,
1008
- "display": "Fynd",
1009
- "subtext": "Login to Fynd",
1010
- "name": "Fynd",
1011
- "meta": {},
1012
- "required_fields": {
1013
- "email": {
1014
- "is_required": false,
1015
- "level": "hard"
1016
- },
1017
- "mobile": {
1018
- "is_required": true,
1019
- "level": "hard"
1020
- }
1021
- },
1022
- "register_required_fields": {
1023
- "email": {
1024
- "is_required": false,
1025
- "level": "hard"
1026
- },
1027
- "mobile": {
1028
- "is_required": true,
1029
- "level": "hard"
1030
- }
1031
- },
1032
- "skip_login": false,
1033
- "look_and_feel": {
1034
- "background_color": "#F5F5F5",
1035
- "card_position": "center"
1036
- },
1037
- "social_tokens": {
1038
- "google": {
1039
- "appId": "token_123"
1040
- },
1041
- "facebook": {
1042
- "appId": "token_123"
1043
- },
1044
- "account_kit": {
1045
- "appId": "token_123"
1046
- }
1047
- },
1048
- "session_config": {
1049
- "duration": 30,
1050
- "type": "Days",
1051
- "is_rolling": false
1052
- },
1053
- "delete_account_reasons": [
1054
- {
1055
- "reason_text": "test",
1056
- "reason_id": "123",
1057
- "show_text_area": true
1058
- }
1059
- ],
1060
- "delete_account_day": 7,
1061
- "delete_account_consent": {
1062
- "consent_text": ""
1063
- },
1064
- "_id": "5e04a5e5220bc15839ad9bc0",
1065
- "created_at": "2019-12-26T12:21:57.878Z",
1066
- "updated_at": "2020-08-13T14:31:09.878Z",
1449
+ "is_active": true,
1450
+ "_id": "6345677535474fbb6944b7ce",
1451
+ "name": "Group 1",
1452
+ "description": "description",
1453
+ "file_url": "url",
1454
+ "status": "pending",
1455
+ "uid": 1,
1456
+ "application_id": "000000000000000000000001",
1457
+ "created_at": "2022-10-11T12:54:13.539Z",
1458
+ "modified_at": "2022-10-11T12:54:13.539Z",
1067
1459
  "__v": 0
1068
1460
  }
1069
1461
  ```
@@ -1083,1234 +1475,697 @@ Success. Returns a JSON object with the updated platform configurations. Refer `
1083
1475
 
1084
1476
  ### Schemas
1085
1477
 
1086
-
1087
-
1088
- #### [BlockUserRequestSchema](#BlockUserRequestSchema)
1478
+
1479
+ #### [Accountkit](#Accountkit)
1089
1480
 
1090
1481
  | Properties | Type | Nullable | Description |
1091
- | ---------- | ---- | -------- | ----------- |
1092
- | status | boolean | no | |
1093
- | user_id | [string] | no | |
1094
- | reason | string | no | |
1482
+ | ---------- | ---- | -------- | ----------- || app_id | string | no | |
1095
1483
 
1096
1484
  ---
1097
1485
 
1098
-
1099
-
1100
-
1101
- #### [ArchiveUserRequestSchema](#ArchiveUserRequestSchema)
1486
+ #### [ArchiveUserRequestSchema](#ArchiveUserRequestSchema)
1102
1487
 
1103
1488
  | Properties | Type | Nullable | Description |
1104
- | ---------- | ---- | -------- | ----------- |
1105
- | user_id | string | no | |
1489
+ | ---------- | ---- | -------- | ----------- || user_id | string | no | |
1106
1490
 
1107
1491
  ---
1108
1492
 
1109
-
1110
-
1111
-
1112
- #### [DeleteApplicationUserRequestSchema](#DeleteApplicationUserRequestSchema)
1493
+ #### [ArchiveUserSuccess](#ArchiveUserSuccess)
1113
1494
 
1114
1495
  | Properties | Type | Nullable | Description |
1115
- | ---------- | ---- | -------- | ----------- |
1116
- | user_id | string | no | |
1117
- | reason | string | no | |
1118
- | reason_id | string | no | |
1119
- | request_id | string | no | |
1120
- | otp | string | no | |
1496
+ | ---------- | ---- | -------- | ----------- || success | boolean | no | |
1121
1497
 
1122
1498
  ---
1123
1499
 
1124
-
1125
-
1126
-
1127
- #### [UnDeleteUserRequestSchema](#UnDeleteUserRequestSchema)
1500
+ #### [AuthenticationApiErrorSchema](#AuthenticationApiErrorSchema)
1128
1501
 
1129
1502
  | Properties | Type | Nullable | Description |
1130
- | ---------- | ---- | -------- | ----------- |
1131
- | user_id | string | no | |
1132
- | reason | string | no | |
1133
- | reason_id | string | no | |
1503
+ | ---------- | ---- | -------- | ----------- || message | string | no | |
1134
1504
 
1135
1505
  ---
1136
1506
 
1137
-
1138
-
1139
-
1140
- #### [EditEmailRequestSchema](#EditEmailRequestSchema)
1507
+ #### [AuthenticationInternalServerErrorSchema](#AuthenticationInternalServerErrorSchema)
1141
1508
 
1142
1509
  | Properties | Type | Nullable | Description |
1143
- | ---------- | ---- | -------- | ----------- |
1144
- | email | string | no | |
1510
+ | ---------- | ---- | -------- | ----------- || message | string | no | |
1145
1511
 
1146
1512
  ---
1147
1513
 
1148
-
1149
-
1150
-
1151
- #### [SendVerificationLinkMobileRequestSchema](#SendVerificationLinkMobileRequestSchema)
1514
+ #### [AuthSuccess](#AuthSuccess)
1152
1515
 
1153
1516
  | Properties | Type | Nullable | Description |
1154
- | ---------- | ---- | -------- | ----------- |
1155
- | verified | boolean | no | |
1156
- | active | boolean | no | |
1157
- | country_code | string | no | |
1158
- | phone | string | no | |
1159
- | primary | boolean | no | |
1517
+ | ---------- | ---- | -------- | ----------- || register_token | string | no | || user | [UserSchema](#UserSchema) | no | || user_exists | boolean | no | |
1160
1518
 
1161
1519
  ---
1162
1520
 
1163
-
1164
-
1165
-
1166
- #### [EditMobileRequestSchema](#EditMobileRequestSchema)
1521
+ #### [AuthSuccessUser](#AuthSuccessUser)
1167
1522
 
1168
1523
  | Properties | Type | Nullable | Description |
1169
- | ---------- | ---- | -------- | ----------- |
1170
- | country_code | string | no | |
1171
- | phone | string | no | |
1524
+ | ---------- | ---- | -------- | ----------- || active | boolean | no | || debug | [AuthSuccessUserDebug](#AuthSuccessUserDebug) | no | || emails | [AuthSuccessUserEmails](#AuthSuccessUserEmails) | no | || first_name | string | no | || last_name | string | no | |
1172
1525
 
1173
1526
  ---
1174
1527
 
1175
-
1176
-
1177
-
1178
- #### [EditProfileRequestSchema](#EditProfileRequestSchema)
1528
+ #### [AuthSuccessUserDebug](#AuthSuccessUserDebug)
1179
1529
 
1180
1530
  | Properties | Type | Nullable | Description |
1181
- | ---------- | ---- | -------- | ----------- |
1182
- | first_name | string | no | |
1183
- | last_name | string | no | |
1184
- | mobile | [EditProfileMobileSchema](#EditProfileMobileSchema) | no | |
1185
- | country_code | string | no | |
1186
- | email | string | no | |
1187
- | gender | string | no | |
1188
- | dob | string | no | |
1189
- | profile_pic_url | string | no | |
1190
- | android_hash | string | no | |
1191
- | sender | string | no | |
1192
- | register_token | string | no | |
1531
+ | ---------- | ---- | -------- | ----------- || platform | string | no | |
1193
1532
 
1194
1533
  ---
1195
1534
 
1196
-
1197
-
1198
-
1199
- #### [EditProfileMobileSchema](#EditProfileMobileSchema)
1535
+ #### [AuthSuccessUserEmails](#AuthSuccessUserEmails)
1200
1536
 
1201
1537
  | Properties | Type | Nullable | Description |
1202
- | ---------- | ---- | -------- | ----------- |
1203
- | phone | string | no | |
1204
- | country_code | string | no | |
1538
+ | ---------- | ---- | -------- | ----------- || active | boolean | no | || email | string | no | || primary | boolean | no | || verified | boolean | no | |
1205
1539
 
1206
1540
  ---
1207
1541
 
1208
-
1209
-
1210
-
1211
- #### [SendEmailOtpRequestSchema](#SendEmailOtpRequestSchema)
1542
+ #### [BlockUserRequestSchema](#BlockUserRequestSchema)
1212
1543
 
1213
1544
  | Properties | Type | Nullable | Description |
1214
- | ---------- | ---- | -------- | ----------- |
1215
- | email | string | no | |
1216
- | action | string | no | |
1217
- | token | string | no | |
1218
- | register_token | string | no | |
1545
+ | ---------- | ---- | -------- | ----------- || reason | string | no | || status | boolean | no | || user_id | [string] | no | |
1219
1546
 
1220
1547
  ---
1221
1548
 
1222
-
1223
-
1224
-
1225
- #### [VerifyEmailOtpRequestSchema](#VerifyEmailOtpRequestSchema)
1549
+ #### [BlockUserSuccess](#BlockUserSuccess)
1226
1550
 
1227
1551
  | Properties | Type | Nullable | Description |
1228
- | ---------- | ---- | -------- | ----------- |
1229
- | email | string | no | |
1230
- | action | string | no | |
1231
- | register_token | string | no | |
1232
- | otp | string | no | |
1552
+ | ---------- | ---- | -------- | ----------- || success | boolean | no | |
1233
1553
 
1234
1554
  ---
1235
1555
 
1236
-
1237
-
1238
-
1239
- #### [VerifyOtpRequestSchema](#VerifyOtpRequestSchema)
1556
+ #### [CodeRequestBodySchema](#CodeRequestBodySchema)
1240
1557
 
1241
1558
  | Properties | Type | Nullable | Description |
1242
- | ---------- | ---- | -------- | ----------- |
1243
- | request_id | string | no | |
1244
- | register_token | string | no | |
1245
- | otp | string | no | |
1559
+ | ---------- | ---- | -------- | ----------- || code | string | no | |
1246
1560
 
1247
1561
  ---
1248
1562
 
1249
-
1250
-
1251
-
1252
- #### [SendMobileOtpRequestSchema](#SendMobileOtpRequestSchema)
1563
+ #### [CreateUserGroupSchema](#CreateUserGroupSchema)
1253
1564
 
1254
1565
  | Properties | Type | Nullable | Description |
1255
- | ---------- | ---- | -------- | ----------- |
1256
- | mobile | string | no | |
1257
- | country_code | string | no | |
1258
- | action | string | no | |
1259
- | token | string | no | |
1260
- | android_hash | string | no | |
1261
- | force | string | no | |
1262
- | captcha_code | string | no | |
1566
+ | ---------- | ---- | -------- | ----------- || description | string | yes | || file_url | string | yes | || name | string | yes | |
1263
1567
 
1264
1568
  ---
1265
1569
 
1266
-
1267
-
1268
-
1269
- #### [UpdatePasswordRequestSchema](#UpdatePasswordRequestSchema)
1570
+ #### [CreateUserRequestSchema](#CreateUserRequestSchema)
1270
1571
 
1271
1572
  | Properties | Type | Nullable | Description |
1272
- | ---------- | ---- | -------- | ----------- |
1273
- | old_password | string | no | |
1274
- | new_password | string | no | |
1573
+ | ---------- | ---- | -------- | ----------- || email | string | no | || first_name | string | no | || gender | string | no | || last_name | string | no | || meta | string | no | || phone_number | string | yes | || username | string | yes | |
1275
1574
 
1276
1575
  ---
1277
1576
 
1278
-
1279
-
1280
-
1281
- #### [FormRegisterRequestSchema](#FormRegisterRequestSchema)
1577
+ #### [CreateUserResponseSchema](#CreateUserResponseSchema)
1282
1578
 
1283
1579
  | Properties | Type | Nullable | Description |
1284
- | ---------- | ---- | -------- | ----------- |
1285
- | first_name | string | no | |
1286
- | last_name | string | no | |
1287
- | gender | string | no | |
1288
- | email | string | no | |
1289
- | password | string | no | |
1290
- | phone | [FormRegisterRequestSchemaPhone](#FormRegisterRequestSchemaPhone) | no | |
1291
- | register_token | string | no | |
1580
+ | ---------- | ---- | -------- | ----------- || user | [UserSchema](#UserSchema) | no | |
1292
1581
 
1293
1582
  ---
1294
1583
 
1295
-
1296
-
1297
-
1298
- #### [TokenRequestBodySchema](#TokenRequestBodySchema)
1584
+ #### [CreateUserSessionRequestSchema](#CreateUserSessionRequestSchema)
1299
1585
 
1300
1586
  | Properties | Type | Nullable | Description |
1301
- | ---------- | ---- | -------- | ----------- |
1302
- | token | string | no | |
1587
+ | ---------- | ---- | -------- | ----------- || domain | string | no | || max_age | number | no | || user_id | string | no | |
1303
1588
 
1304
1589
  ---
1305
1590
 
1306
-
1307
-
1308
-
1309
- #### [ForgotPasswordRequestSchema](#ForgotPasswordRequestSchema)
1591
+ #### [CreateUserSessionResponseSchema](#CreateUserSessionResponseSchema)
1310
1592
 
1311
1593
  | Properties | Type | Nullable | Description |
1312
- | ---------- | ---- | -------- | ----------- |
1313
- | code | string | no | |
1314
- | password | string | no | |
1594
+ | ---------- | ---- | -------- | ----------- || cookie | string | no | || domain | string | no | || http_only | boolean | no | || max_age | number | no | || secure | boolean | no | |
1315
1595
 
1316
1596
  ---
1317
1597
 
1318
-
1319
-
1320
-
1321
- #### [CodeRequestBodySchema](#CodeRequestBodySchema)
1598
+ #### [CustomerListResponseSchema](#CustomerListResponseSchema)
1322
1599
 
1323
1600
  | Properties | Type | Nullable | Description |
1324
- | ---------- | ---- | -------- | ----------- |
1325
- | code | string | no | |
1601
+ | ---------- | ---- | -------- | ----------- || items | [[UserSchema](#UserSchema)] | no | || page | [PaginationSchema](#PaginationSchema) | no | |
1326
1602
 
1327
1603
  ---
1328
1604
 
1329
-
1330
-
1331
-
1332
- #### [SendResetPasswordEmailRequestSchema](#SendResetPasswordEmailRequestSchema)
1605
+ #### [DeleteAccountConsent](#DeleteAccountConsent)
1333
1606
 
1334
1607
  | Properties | Type | Nullable | Description |
1335
- | ---------- | ---- | -------- | ----------- |
1336
- | email | string | no | |
1337
- | captcha_code | string | no | |
1608
+ | ---------- | ---- | -------- | ----------- || consent_text | string | no | |
1338
1609
 
1339
1610
  ---
1340
1611
 
1341
-
1342
-
1343
-
1344
- #### [SendResetPasswordMobileRequestSchema](#SendResetPasswordMobileRequestSchema)
1612
+ #### [DeleteAccountReasons](#DeleteAccountReasons)
1345
1613
 
1346
1614
  | Properties | Type | Nullable | Description |
1347
- | ---------- | ---- | -------- | ----------- |
1348
- | country_code | string | no | |
1349
- | mobile | string | no | |
1350
- | captcha_code | string | no | |
1615
+ | ---------- | ---- | -------- | ----------- || reason_id | string | no | || reason_text | string | no | || show_text_area | boolean | no | |
1351
1616
 
1352
1617
  ---
1353
1618
 
1354
-
1355
-
1356
-
1357
- #### [PasswordLoginRequestSchema](#PasswordLoginRequestSchema)
1619
+ #### [DeleteApplicationUserRequestSchema](#DeleteApplicationUserRequestSchema)
1358
1620
 
1359
1621
  | Properties | Type | Nullable | Description |
1360
- | ---------- | ---- | -------- | ----------- |
1361
- | captcha_code | string | no | |
1362
- | password | string | no | |
1363
- | username | string | no | |
1622
+ | ---------- | ---- | -------- | ----------- || otp | string | no | || reason | string | no | || reason_id | string | no | || request_id | string | no | || user_id | string | no | |
1364
1623
 
1365
1624
  ---
1366
1625
 
1367
-
1368
-
1369
-
1370
- #### [SendOtpRequestSchema](#SendOtpRequestSchema)
1626
+ #### [DeleteUserSuccess](#DeleteUserSuccess)
1371
1627
 
1372
1628
  | Properties | Type | Nullable | Description |
1373
- | ---------- | ---- | -------- | ----------- |
1374
- | country_code | string | no | |
1375
- | captcha_code | string | no | |
1376
- | mobile | string | no | |
1377
- | android_hash | string | no | |
1629
+ | ---------- | ---- | -------- | ----------- || success | boolean | no | |
1378
1630
 
1379
1631
  ---
1380
1632
 
1381
-
1382
-
1383
-
1384
- #### [OAuthRequestSchema](#OAuthRequestSchema)
1633
+ #### [EditEmailRequestSchema](#EditEmailRequestSchema)
1385
1634
 
1386
1635
  | Properties | Type | Nullable | Description |
1387
- | ---------- | ---- | -------- | ----------- |
1388
- | is_signed_in | boolean | no | |
1389
- | oauth2 | [OAuthRequestSchemaOauth2](#OAuthRequestSchemaOauth2) | no | |
1390
- | profile | [OAuthRequestSchemaProfile](#OAuthRequestSchemaProfile) | no | |
1636
+ | ---------- | ---- | -------- | ----------- || email | string | no | |
1391
1637
 
1392
1638
  ---
1393
1639
 
1394
-
1395
-
1396
-
1397
- #### [OAuthRequestAppleSchema](#OAuthRequestAppleSchema)
1640
+ #### [EditMobileRequestSchema](#EditMobileRequestSchema)
1398
1641
 
1399
1642
  | Properties | Type | Nullable | Description |
1400
- | ---------- | ---- | -------- | ----------- |
1401
- | user_identifier | string | no | |
1402
- | oauth | [OAuthRequestAppleSchemaOauth](#OAuthRequestAppleSchemaOauth) | no | |
1403
- | profile | [OAuthRequestAppleSchemaProfile](#OAuthRequestAppleSchemaProfile) | no | |
1643
+ | ---------- | ---- | -------- | ----------- || country_code | string | no | || phone | string | no | |
1404
1644
 
1405
1645
  ---
1406
1646
 
1407
-
1408
-
1409
-
1410
- #### [UserObjectSchema](#UserObjectSchema)
1647
+ #### [EditProfileMobileSchema](#EditProfileMobileSchema)
1411
1648
 
1412
1649
  | Properties | Type | Nullable | Description |
1413
- | ---------- | ---- | -------- | ----------- |
1414
- | user | [UserSchema](#UserSchema) | no | |
1650
+ | ---------- | ---- | -------- | ----------- || country_code | string | no | || phone | string | no | |
1415
1651
 
1416
1652
  ---
1417
1653
 
1418
-
1419
-
1420
-
1421
- #### [AuthSuccess](#AuthSuccess)
1654
+ #### [EditProfileRequestSchema](#EditProfileRequestSchema)
1422
1655
 
1423
1656
  | Properties | Type | Nullable | Description |
1424
- | ---------- | ---- | -------- | ----------- |
1425
- | register_token | string | no | |
1426
- | user_exists | boolean | no | |
1427
- | user | [UserSchema](#UserSchema) | no | |
1657
+ | ---------- | ---- | -------- | ----------- || android_hash | string | no | || country_code | string | no | || dob | string | no | || email | string | no | || first_name | string | no | || gender | string | no | || last_name | string | no | || mobile | [EditProfileMobileSchema](#EditProfileMobileSchema) | no | || profile_pic_url | string | no | || register_token | string | no | || sender | string | no | |
1428
1658
 
1429
1659
  ---
1430
1660
 
1431
-
1432
-
1433
-
1434
- #### [SendOtpResponse](#SendOtpResponse)
1661
+ #### [Email](#Email)
1435
1662
 
1436
1663
  | Properties | Type | Nullable | Description |
1437
- | ---------- | ---- | -------- | ----------- |
1438
- | resend_timer | number | no | |
1439
- | resend_token | string | no | |
1440
- | success | boolean | no | |
1441
- | request_id | string | no | |
1442
- | message | string | no | |
1443
- | mobile | string | no | |
1444
- | country_code | string | no | |
1445
- | email | string | no | |
1446
- | resend_email_token | string | no | |
1447
- | register_token | string | no | |
1448
- | verify_email_otp | boolean | no | |
1449
- | verify_mobile_otp | boolean | no | |
1450
- | user_exists | boolean | no | |
1664
+ | ---------- | ---- | -------- | ----------- || active | boolean | no | || email | string | no | || primary | boolean | no | || verified | boolean | no | |
1451
1665
 
1452
1666
  ---
1453
1667
 
1454
-
1455
-
1456
-
1457
- #### [ProfileEditSuccess](#ProfileEditSuccess)
1668
+ #### [EmailOtpSuccess](#EmailOtpSuccess)
1458
1669
 
1459
1670
  | Properties | Type | Nullable | Description |
1460
- | ---------- | ---- | -------- | ----------- |
1461
- | user | [UserSchema](#UserSchema) | no | |
1462
- | register_token | string | no | |
1463
- | resend_email_token | string | no | |
1464
- | user_exists | boolean | no | |
1465
- | verify_email_link | boolean | no | |
1466
- | verify_email_otp | boolean | no | |
1467
- | verify_mobile_otp | boolean | no | |
1468
- | email | string | no | |
1469
- | request_id | string | no | |
1470
- | country_code | string | no | |
1471
- | mobile | string | no | |
1472
- | success | boolean | no | |
1473
- | message | string | no | |
1474
- | resend_timer | number | no | |
1475
- | resend_token | string | no | |
1671
+ | ---------- | ---- | -------- | ----------- || success | boolean | no | |
1476
1672
 
1477
1673
  ---
1478
1674
 
1479
-
1480
-
1481
-
1482
- #### [LoginSuccess](#LoginSuccess)
1675
+ #### [Facebook](#Facebook)
1483
1676
 
1484
1677
  | Properties | Type | Nullable | Description |
1485
- | ---------- | ---- | -------- | ----------- |
1486
- | user | [UserSchema](#UserSchema) | no | |
1487
- | request_id | string | no | |
1488
- | register_token | string | no | |
1678
+ | ---------- | ---- | -------- | ----------- || app_id | string | no | |
1489
1679
 
1490
1680
  ---
1491
1681
 
1492
-
1493
-
1494
-
1495
- #### [VerifyOtpSuccess](#VerifyOtpSuccess)
1682
+ #### [FlashCard](#FlashCard)
1496
1683
 
1497
1684
  | Properties | Type | Nullable | Description |
1498
- | ---------- | ---- | -------- | ----------- |
1499
- | user | [UserSchema](#UserSchema) | no | |
1500
- | user_exists | boolean | no | |
1501
- | register_token | string | no | |
1685
+ | ---------- | ---- | -------- | ----------- || background_color | string | no | || text | string | no | || text_color | string | no | |
1502
1686
 
1503
1687
  ---
1504
1688
 
1505
-
1506
-
1507
-
1508
- #### [ResetPasswordSuccess](#ResetPasswordSuccess)
1689
+ #### [ForgotPasswordRequestSchema](#ForgotPasswordRequestSchema)
1509
1690
 
1510
1691
  | Properties | Type | Nullable | Description |
1511
- | ---------- | ---- | -------- | ----------- |
1512
- | status | string | no | |
1692
+ | ---------- | ---- | -------- | ----------- || code | string | no | || password | string | no | |
1513
1693
 
1514
1694
  ---
1515
1695
 
1516
-
1517
-
1518
-
1519
- #### [RegisterFormSuccess](#RegisterFormSuccess)
1696
+ #### [FormRegisterRequestSchema](#FormRegisterRequestSchema)
1520
1697
 
1521
1698
  | Properties | Type | Nullable | Description |
1522
- | ---------- | ---- | -------- | ----------- |
1523
- | email | string | no | |
1524
- | resend_timer | number | no | |
1525
- | resend_token | string | no | |
1526
- | resend_email_token | string | no | |
1527
- | register_token | string | no | |
1528
- | success | boolean | no | |
1529
- | request_id | string | no | |
1530
- | message | string | no | |
1531
- | mobile | string | no | |
1532
- | country_code | string | no | |
1533
- | verify_email_otp | boolean | no | |
1534
- | verify_mobile_otp | boolean | no | |
1535
- | user_exists | boolean | no | |
1699
+ | ---------- | ---- | -------- | ----------- || email | string | no | || first_name | string | no | || gender | string | no | || last_name | string | no | || password | string | no | || phone | [FormRegisterRequestSchemaPhone](#FormRegisterRequestSchemaPhone) | no | || register_token | string | no | |
1536
1700
 
1537
1701
  ---
1538
1702
 
1539
-
1540
-
1541
-
1542
- #### [VerifyEmailSuccess](#VerifyEmailSuccess)
1703
+ #### [FormRegisterRequestSchemaPhone](#FormRegisterRequestSchemaPhone)
1543
1704
 
1544
1705
  | Properties | Type | Nullable | Description |
1545
- | ---------- | ---- | -------- | ----------- |
1546
- | message | string | no | |
1706
+ | ---------- | ---- | -------- | ----------- || country_code | string | no | || mobile | string | no | |
1547
1707
 
1548
1708
  ---
1549
1709
 
1550
-
1551
-
1552
-
1553
- #### [HasPasswordSuccess](#HasPasswordSuccess)
1710
+ #### [Google](#Google)
1554
1711
 
1555
1712
  | Properties | Type | Nullable | Description |
1556
- | ---------- | ---- | -------- | ----------- |
1557
- | result | boolean | no | |
1713
+ | ---------- | ---- | -------- | ----------- || app_id | string | no | |
1558
1714
 
1559
1715
  ---
1560
1716
 
1561
-
1562
-
1563
-
1564
- #### [LogoutSuccess](#LogoutSuccess)
1717
+ #### [HasPasswordSuccess](#HasPasswordSuccess)
1565
1718
 
1566
1719
  | Properties | Type | Nullable | Description |
1567
- | ---------- | ---- | -------- | ----------- |
1568
- | logout | boolean | no | |
1720
+ | ---------- | ---- | -------- | ----------- || result | boolean | no | |
1569
1721
 
1570
1722
  ---
1571
1723
 
1572
-
1573
-
1574
-
1575
- #### [BlockUserSuccess](#BlockUserSuccess)
1724
+ #### [Login](#Login)
1576
1725
 
1577
1726
  | Properties | Type | Nullable | Description |
1578
- | ---------- | ---- | -------- | ----------- |
1579
- | success | boolean | no | |
1727
+ | ---------- | ---- | -------- | ----------- || otp | boolean | no | || password | boolean | no | |
1580
1728
 
1581
1729
  ---
1582
1730
 
1583
-
1584
-
1585
-
1586
- #### [ArchiveUserSuccess](#ArchiveUserSuccess)
1731
+ #### [LoginSuccess](#LoginSuccess)
1587
1732
 
1588
1733
  | Properties | Type | Nullable | Description |
1589
- | ---------- | ---- | -------- | ----------- |
1590
- | success | boolean | no | |
1734
+ | ---------- | ---- | -------- | ----------- || register_token | string | no | || request_id | string | no | || user | [UserSchema](#UserSchema) | no | |
1591
1735
 
1592
1736
  ---
1593
1737
 
1594
-
1595
-
1596
-
1597
- #### [DeleteUserSuccess](#DeleteUserSuccess)
1738
+ #### [LogoutSuccess](#LogoutSuccess)
1598
1739
 
1599
1740
  | Properties | Type | Nullable | Description |
1600
- | ---------- | ---- | -------- | ----------- |
1601
- | success | boolean | no | |
1741
+ | ---------- | ---- | -------- | ----------- || logout | boolean | no | |
1602
1742
 
1603
1743
  ---
1604
1744
 
1605
-
1606
-
1607
-
1608
- #### [UnDeleteUserSuccess](#UnDeleteUserSuccess)
1745
+ #### [LookAndFeel](#LookAndFeel)
1609
1746
 
1610
1747
  | Properties | Type | Nullable | Description |
1611
- | ---------- | ---- | -------- | ----------- |
1612
- | success | boolean | no | |
1748
+ | ---------- | ---- | -------- | ----------- || background_color | string | no | || card_position | string | no | |
1613
1749
 
1614
1750
  ---
1615
1751
 
1616
-
1617
-
1618
-
1619
- #### [OtpSuccess](#OtpSuccess)
1752
+ #### [MetaSchema](#MetaSchema)
1620
1753
 
1621
1754
  | Properties | Type | Nullable | Description |
1622
- | ---------- | ---- | -------- | ----------- |
1623
- | resend_timer | number | no | |
1624
- | resend_token | string | no | |
1625
- | register_token | string | no | |
1626
- | success | boolean | no | |
1627
- | request_id | string | no | |
1628
- | message | string | no | |
1629
- | mobile | string | no | |
1630
- | country_code | string | no | |
1755
+ | ---------- | ---- | -------- | ----------- || fynd_default | boolean | no | |
1631
1756
 
1632
1757
  ---
1633
1758
 
1634
-
1635
-
1636
-
1637
- #### [EmailOtpSuccess](#EmailOtpSuccess)
1759
+ #### [NotFoundSchema](#NotFoundSchema)
1638
1760
 
1639
1761
  | Properties | Type | Nullable | Description |
1640
- | ---------- | ---- | -------- | ----------- |
1641
- | success | boolean | no | |
1762
+ | ---------- | ---- | -------- | ----------- || message | string | no | |
1642
1763
 
1643
1764
  ---
1644
1765
 
1645
-
1646
-
1647
-
1648
- #### [SessionListSuccess](#SessionListSuccess)
1766
+ #### [OAuthRequestAppleSchema](#OAuthRequestAppleSchema)
1649
1767
 
1650
1768
  | Properties | Type | Nullable | Description |
1651
- | ---------- | ---- | -------- | ----------- |
1652
- | sessions | [string] | no | |
1769
+ | ---------- | ---- | -------- | ----------- || oauth | [OAuthRequestAppleSchemaOauth](#OAuthRequestAppleSchemaOauth) | no | || profile | [OAuthRequestAppleSchemaProfile](#OAuthRequestAppleSchemaProfile) | no | || user_identifier | string | no | |
1653
1770
 
1654
1771
  ---
1655
1772
 
1656
-
1657
-
1658
-
1659
- #### [VerifyMobileOTPSuccess](#VerifyMobileOTPSuccess)
1773
+ #### [OAuthRequestAppleSchemaOauth](#OAuthRequestAppleSchemaOauth)
1660
1774
 
1661
1775
  | Properties | Type | Nullable | Description |
1662
- | ---------- | ---- | -------- | ----------- |
1663
- | user | [UserSchema](#UserSchema) | no | |
1664
- | verify_mobile_link | boolean | no | |
1776
+ | ---------- | ---- | -------- | ----------- || identity_token | string | no | |
1665
1777
 
1666
1778
  ---
1667
1779
 
1668
-
1669
-
1670
-
1671
- #### [VerifyEmailOTPSuccess](#VerifyEmailOTPSuccess)
1780
+ #### [OAuthRequestAppleSchemaProfile](#OAuthRequestAppleSchemaProfile)
1672
1781
 
1673
1782
  | Properties | Type | Nullable | Description |
1674
- | ---------- | ---- | -------- | ----------- |
1675
- | user | [UserSchema](#UserSchema) | no | |
1676
- | verify_email_link | boolean | no | |
1783
+ | ---------- | ---- | -------- | ----------- || first_name | string | no | || full_name | string | no | || last_name | string | no | |
1677
1784
 
1678
1785
  ---
1679
1786
 
1680
-
1681
-
1682
-
1683
- #### [SendMobileVerifyLinkSuccess](#SendMobileVerifyLinkSuccess)
1787
+ #### [OAuthRequestSchema](#OAuthRequestSchema)
1684
1788
 
1685
1789
  | Properties | Type | Nullable | Description |
1686
- | ---------- | ---- | -------- | ----------- |
1687
- | verify_mobile_link | boolean | no | |
1790
+ | ---------- | ---- | -------- | ----------- || is_signed_in | boolean | no | || oauth2 | [OAuthRequestSchemaOauth2](#OAuthRequestSchemaOauth2) | no | || profile | [OAuthRequestSchemaProfile](#OAuthRequestSchemaProfile) | no | |
1688
1791
 
1689
1792
  ---
1690
1793
 
1691
-
1692
-
1693
-
1694
- #### [SendEmailVerifyLinkSuccess](#SendEmailVerifyLinkSuccess)
1794
+ #### [OAuthRequestSchemaOauth2](#OAuthRequestSchemaOauth2)
1695
1795
 
1696
1796
  | Properties | Type | Nullable | Description |
1697
- | ---------- | ---- | -------- | ----------- |
1698
- | verify_email_link | boolean | no | |
1797
+ | ---------- | ---- | -------- | ----------- || access_token | string | no | || expiry | number | no | || refresh_token | string | no | |
1699
1798
 
1700
1799
  ---
1701
1800
 
1702
-
1703
-
1704
-
1705
- #### [UserSearchResponseSchema](#UserSearchResponseSchema)
1801
+ #### [OAuthRequestSchemaProfile](#OAuthRequestSchemaProfile)
1706
1802
 
1707
1803
  | Properties | Type | Nullable | Description |
1708
- | ---------- | ---- | -------- | ----------- |
1709
- | users | [[UserSchema](#UserSchema)] | no | |
1804
+ | ---------- | ---- | -------- | ----------- || email | string | no | || first_name | string | no | || full_name | string | no | || id | string | no | || image | string | no | || last_name | string | no | |
1710
1805
 
1711
1806
  ---
1712
1807
 
1713
-
1714
-
1715
-
1716
- #### [CustomerListResponseSchema](#CustomerListResponseSchema)
1808
+ #### [OtpSuccess](#OtpSuccess)
1717
1809
 
1718
1810
  | Properties | Type | Nullable | Description |
1719
- | ---------- | ---- | -------- | ----------- |
1720
- | items | [[UserSchema](#UserSchema)] | no | |
1721
- | page | [PaginationSchema](#PaginationSchema) | no | |
1811
+ | ---------- | ---- | -------- | ----------- || country_code | string | no | || message | string | no | || mobile | string | no | || register_token | string | no | || request_id | string | no | || resend_timer | number | no | || resend_token | string | no | || success | boolean | no | |
1722
1812
 
1723
1813
  ---
1724
1814
 
1725
-
1726
-
1727
-
1728
- #### [PaginationSchema](#PaginationSchema)
1815
+ #### [PaginationSchema](#PaginationSchema)
1729
1816
 
1730
1817
  | Properties | Type | Nullable | Description |
1731
- | ---------- | ---- | -------- | ----------- |
1732
- | size | number | no | |
1733
- | item_total | number | no | |
1734
- | has_next | boolean | no | |
1735
- | type | string | no | |
1736
- | current | number | no | |
1818
+ | ---------- | ---- | -------- | ----------- || current | number | no | || has_next | boolean | no | || item_total | number | no | || size | number | no | || type | string | no | |
1737
1819
 
1738
1820
  ---
1739
1821
 
1740
-
1741
-
1742
-
1743
- #### [SessionListResponseSchema](#SessionListResponseSchema)
1822
+ #### [PasswordLoginRequestSchema](#PasswordLoginRequestSchema)
1744
1823
 
1745
1824
  | Properties | Type | Nullable | Description |
1746
- | ---------- | ---- | -------- | ----------- |
1747
- | items | [string] | no | |
1825
+ | ---------- | ---- | -------- | ----------- || captcha_code | string | no | || password | string | no | || username | string | no | |
1748
1826
 
1749
1827
  ---
1750
1828
 
1751
-
1752
-
1753
-
1754
- #### [SessionDeleteResponseSchema](#SessionDeleteResponseSchema)
1829
+ #### [PhoneNumber](#PhoneNumber)
1755
1830
 
1756
1831
  | Properties | Type | Nullable | Description |
1757
- | ---------- | ---- | -------- | ----------- |
1758
- | items | [string] | no | |
1832
+ | ---------- | ---- | -------- | ----------- || active | boolean | no | || country_code | number | no | || phone | string | no | || primary | boolean | no | || verified | boolean | no | |
1759
1833
 
1760
1834
  ---
1761
1835
 
1762
-
1763
-
1764
-
1765
- #### [UnauthorizedSchema](#UnauthorizedSchema)
1836
+ #### [PlatformEmail](#PlatformEmail)
1766
1837
 
1767
1838
  | Properties | Type | Nullable | Description |
1768
- | ---------- | ---- | -------- | ----------- |
1769
- | message | string | no | |
1839
+ | ---------- | ---- | -------- | ----------- || is_required | boolean | no | || level | string | no | |
1770
1840
 
1771
1841
  ---
1772
1842
 
1773
-
1774
-
1775
-
1776
- #### [UnauthenticatedSchema](#UnauthenticatedSchema)
1843
+ #### [PlatformMobile](#PlatformMobile)
1777
1844
 
1778
1845
  | Properties | Type | Nullable | Description |
1779
- | ---------- | ---- | -------- | ----------- |
1780
- | authenticated | boolean | no | |
1846
+ | ---------- | ---- | -------- | ----------- || is_required | boolean | no | || level | string | no | |
1781
1847
 
1782
1848
  ---
1783
1849
 
1784
-
1785
-
1786
-
1787
- #### [NotFoundSchema](#NotFoundSchema)
1850
+ #### [PlatformSchema](#PlatformSchema)
1788
1851
 
1789
1852
  | Properties | Type | Nullable | Description |
1790
- | ---------- | ---- | -------- | ----------- |
1791
- | message | string | no | |
1853
+ | ---------- | ---- | -------- | ----------- || _id | string | no | || active | boolean | no | || created_at | string | no | || delete_account_consent | string | no | || delete_account_day | number | no | || delete_account_reasons | [[DeleteAccountReasons](#DeleteAccountReasons)] | no | || desktop_image | string | no | || display | string | no | || flash_card | [FlashCard](#FlashCard) | no | || forgot_password | boolean | no | || login | [Login](#Login) | no | || look_and_feel | [LookAndFeel](#LookAndFeel) | no | || meta | [MetaSchema](#MetaSchema) | no | || mobile_image | string | no | || name | string | no | || register | boolean | no | || register_required_fields | [RegisterRequiredFields](#RegisterRequiredFields) | no | || required_fields | [RequiredFields](#RequiredFields) | no | || session_config | string | no | || skip_captcha | boolean | no | || skip_login | boolean | no | || social | [Social](#Social) | no | || social_tokens | [SocialTokens](#SocialTokens) | no | || subtext | string | no | || updated_at | string | no | |
1792
1854
 
1793
1855
  ---
1794
1856
 
1795
-
1796
-
1797
-
1798
- #### [AuthenticationInternalServerErrorSchema](#AuthenticationInternalServerErrorSchema)
1857
+ #### [ProfileEditSuccess](#ProfileEditSuccess)
1799
1858
 
1800
1859
  | Properties | Type | Nullable | Description |
1801
- | ---------- | ---- | -------- | ----------- |
1802
- | message | string | no | |
1860
+ | ---------- | ---- | -------- | ----------- || country_code | string | no | || email | string | no | || message | string | no | || mobile | string | no | || register_token | string | no | || request_id | string | no | || resend_email_token | string | no | || resend_timer | number | no | || resend_token | string | no | || success | boolean | no | || user | [UserSchema](#UserSchema) | no | || user_exists | boolean | no | || verify_email_link | boolean | no | || verify_email_otp | boolean | no | || verify_mobile_otp | boolean | no | |
1803
1861
 
1804
1862
  ---
1805
1863
 
1806
-
1807
-
1808
-
1809
- #### [AuthenticationApiErrorSchema](#AuthenticationApiErrorSchema)
1864
+ #### [ProfileEditSuccessSchema](#ProfileEditSuccessSchema)
1810
1865
 
1811
1866
  | Properties | Type | Nullable | Description |
1812
- | ---------- | ---- | -------- | ----------- |
1813
- | message | string | no | |
1867
+ | ---------- | ---- | -------- | ----------- || email | string | no | || register_token | string | no | || user | string | no | || user_exists | boolean | no | || verify_email_link | boolean | no | || verify_email_otp | boolean | no | || verify_mobile_otp | boolean | no | |
1814
1868
 
1815
1869
  ---
1816
1870
 
1817
-
1818
-
1819
-
1820
- #### [ProfileEditSuccessSchema](#ProfileEditSuccessSchema)
1871
+ #### [RegisterFormSuccess](#RegisterFormSuccess)
1821
1872
 
1822
1873
  | Properties | Type | Nullable | Description |
1823
- | ---------- | ---- | -------- | ----------- |
1824
- | email | string | no | |
1825
- | verify_email_otp | boolean | no | |
1826
- | verify_email_link | boolean | no | |
1827
- | verify_mobile_otp | boolean | no | |
1828
- | user | string | no | |
1829
- | register_token | string | no | |
1830
- | user_exists | boolean | no | |
1874
+ | ---------- | ---- | -------- | ----------- || country_code | string | no | || email | string | no | || message | string | no | || mobile | string | no | || register_token | string | no | || request_id | string | no | || resend_email_token | string | no | || resend_timer | number | no | || resend_token | string | no | || success | boolean | no | || user_exists | boolean | no | || verify_email_otp | boolean | no | || verify_mobile_otp | boolean | no | |
1831
1875
 
1832
1876
  ---
1833
1877
 
1834
-
1835
-
1836
-
1837
- #### [FormRegisterRequestSchemaPhone](#FormRegisterRequestSchemaPhone)
1878
+ #### [RegisterRequiredFields](#RegisterRequiredFields)
1838
1879
 
1839
1880
  | Properties | Type | Nullable | Description |
1840
- | ---------- | ---- | -------- | ----------- |
1841
- | country_code | string | no | |
1842
- | mobile | string | no | |
1881
+ | ---------- | ---- | -------- | ----------- || email | [RegisterRequiredFieldsEmail](#RegisterRequiredFieldsEmail) | no | || mobile | [RegisterRequiredFieldsMobile](#RegisterRequiredFieldsMobile) | no | |
1843
1882
 
1844
1883
  ---
1845
1884
 
1846
-
1847
-
1848
-
1849
- #### [OAuthRequestSchemaOauth2](#OAuthRequestSchemaOauth2)
1885
+ #### [RegisterRequiredFieldsEmail](#RegisterRequiredFieldsEmail)
1850
1886
 
1851
1887
  | Properties | Type | Nullable | Description |
1852
- | ---------- | ---- | -------- | ----------- |
1853
- | access_token | string | no | |
1854
- | expiry | number | no | |
1855
- | refresh_token | string | no | |
1888
+ | ---------- | ---- | -------- | ----------- || is_required | boolean | no | || level | string | no | |
1856
1889
 
1857
1890
  ---
1858
1891
 
1859
-
1860
-
1861
-
1862
- #### [OAuthRequestSchemaProfile](#OAuthRequestSchemaProfile)
1892
+ #### [RegisterRequiredFieldsMobile](#RegisterRequiredFieldsMobile)
1863
1893
 
1864
1894
  | Properties | Type | Nullable | Description |
1865
- | ---------- | ---- | -------- | ----------- |
1866
- | last_name | string | no | |
1867
- | image | string | no | |
1868
- | id | string | no | |
1869
- | email | string | no | |
1870
- | full_name | string | no | |
1871
- | first_name | string | no | |
1895
+ | ---------- | ---- | -------- | ----------- || is_required | boolean | no | || level | string | no | |
1872
1896
 
1873
1897
  ---
1874
1898
 
1875
-
1876
-
1877
-
1878
- #### [OAuthRequestAppleSchemaOauth](#OAuthRequestAppleSchemaOauth)
1899
+ #### [RequiredFields](#RequiredFields)
1879
1900
 
1880
1901
  | Properties | Type | Nullable | Description |
1881
- | ---------- | ---- | -------- | ----------- |
1882
- | identity_token | string | no | |
1902
+ | ---------- | ---- | -------- | ----------- || email | [PlatformEmail](#PlatformEmail) | no | || mobile | [PlatformMobile](#PlatformMobile) | no | |
1883
1903
 
1884
1904
  ---
1885
1905
 
1886
-
1887
-
1888
-
1889
- #### [OAuthRequestAppleSchemaProfile](#OAuthRequestAppleSchemaProfile)
1906
+ #### [ResetPasswordSuccess](#ResetPasswordSuccess)
1890
1907
 
1891
1908
  | Properties | Type | Nullable | Description |
1892
- | ---------- | ---- | -------- | ----------- |
1893
- | last_name | string | no | |
1894
- | full_name | string | no | |
1895
- | first_name | string | no | |
1909
+ | ---------- | ---- | -------- | ----------- || status | string | no | |
1896
1910
 
1897
1911
  ---
1898
1912
 
1899
-
1900
-
1901
-
1902
- #### [AuthSuccessUser](#AuthSuccessUser)
1913
+ #### [SendEmailOtpRequestSchema](#SendEmailOtpRequestSchema)
1903
1914
 
1904
1915
  | Properties | Type | Nullable | Description |
1905
- | ---------- | ---- | -------- | ----------- |
1906
- | first_name | string | no | |
1907
- | last_name | string | no | |
1908
- | debug | [AuthSuccessUserDebug](#AuthSuccessUserDebug) | no | |
1909
- | active | boolean | no | |
1910
- | emails | [AuthSuccessUserEmails](#AuthSuccessUserEmails) | no | |
1916
+ | ---------- | ---- | -------- | ----------- || action | string | no | || email | string | no | || register_token | string | no | || token | string | no | |
1911
1917
 
1912
1918
  ---
1913
1919
 
1914
-
1915
-
1916
-
1917
- #### [AuthSuccessUserDebug](#AuthSuccessUserDebug)
1920
+ #### [SendEmailVerifyLinkSuccess](#SendEmailVerifyLinkSuccess)
1918
1921
 
1919
1922
  | Properties | Type | Nullable | Description |
1920
- | ---------- | ---- | -------- | ----------- |
1921
- | platform | string | no | |
1923
+ | ---------- | ---- | -------- | ----------- || verify_email_link | boolean | no | |
1922
1924
 
1923
1925
  ---
1924
1926
 
1925
-
1926
-
1927
-
1928
- #### [AuthSuccessUserEmails](#AuthSuccessUserEmails)
1927
+ #### [SendMobileOtpRequestSchema](#SendMobileOtpRequestSchema)
1929
1928
 
1930
1929
  | Properties | Type | Nullable | Description |
1931
- | ---------- | ---- | -------- | ----------- |
1932
- | email | string | no | |
1933
- | verified | boolean | no | |
1934
- | primary | boolean | no | |
1935
- | active | boolean | no | |
1930
+ | ---------- | ---- | -------- | ----------- || action | string | no | || android_hash | string | no | || captcha_code | string | no | || country_code | string | no | || force | string | no | || mobile | string | no | || token | string | no | |
1936
1931
 
1937
1932
  ---
1938
1933
 
1939
-
1940
-
1941
-
1942
- #### [CreateUserRequestSchema](#CreateUserRequestSchema)
1934
+ #### [SendMobileVerifyLinkSuccess](#SendMobileVerifyLinkSuccess)
1943
1935
 
1944
1936
  | Properties | Type | Nullable | Description |
1945
- | ---------- | ---- | -------- | ----------- |
1946
- | phone_number | string | yes | |
1947
- | email | string | no | |
1948
- | first_name | string | no | |
1949
- | last_name | string | no | |
1950
- | gender | string | no | |
1951
- | username | string | yes | |
1952
- | meta | string | no | |
1937
+ | ---------- | ---- | -------- | ----------- || verify_mobile_link | boolean | no | |
1953
1938
 
1954
1939
  ---
1955
1940
 
1956
-
1957
-
1958
-
1959
- #### [CreateUserResponseSchema](#CreateUserResponseSchema)
1941
+ #### [SendOtpRequestSchema](#SendOtpRequestSchema)
1960
1942
 
1961
1943
  | Properties | Type | Nullable | Description |
1962
- | ---------- | ---- | -------- | ----------- |
1963
- | user | [UserSchema](#UserSchema) | no | |
1944
+ | ---------- | ---- | -------- | ----------- || android_hash | string | no | || captcha_code | string | no | || country_code | string | no | || mobile | string | no | |
1964
1945
 
1965
1946
  ---
1966
1947
 
1967
-
1968
-
1969
-
1970
- #### [CreateUserSessionRequestSchema](#CreateUserSessionRequestSchema)
1948
+ #### [SendOtpResponse](#SendOtpResponse)
1971
1949
 
1972
1950
  | Properties | Type | Nullable | Description |
1973
- | ---------- | ---- | -------- | ----------- |
1974
- | domain | string | no | |
1975
- | max_age | number | no | |
1976
- | user_id | string | no | |
1951
+ | ---------- | ---- | -------- | ----------- || country_code | string | no | || email | string | no | || message | string | no | || mobile | string | no | || register_token | string | no | || request_id | string | no | || resend_email_token | string | no | || resend_timer | number | no | || resend_token | string | no | || success | boolean | no | || user_exists | boolean | no | || verify_email_otp | boolean | no | || verify_mobile_otp | boolean | no | |
1977
1952
 
1978
1953
  ---
1979
1954
 
1980
-
1981
-
1982
-
1983
- #### [CreateUserSessionResponseSchema](#CreateUserSessionResponseSchema)
1955
+ #### [SendResetPasswordEmailRequestSchema](#SendResetPasswordEmailRequestSchema)
1984
1956
 
1985
1957
  | Properties | Type | Nullable | Description |
1986
- | ---------- | ---- | -------- | ----------- |
1987
- | domain | string | no | |
1988
- | max_age | number | no | |
1989
- | secure | boolean | no | |
1990
- | http_only | boolean | no | |
1991
- | cookie | string | no | |
1958
+ | ---------- | ---- | -------- | ----------- || captcha_code | string | no | || email | string | no | |
1992
1959
 
1993
1960
  ---
1994
1961
 
1995
-
1996
-
1997
-
1998
- #### [PlatformSchema](#PlatformSchema)
1962
+ #### [SendResetPasswordMobileRequestSchema](#SendResetPasswordMobileRequestSchema)
1999
1963
 
2000
1964
  | Properties | Type | Nullable | Description |
2001
- | ---------- | ---- | -------- | ----------- |
2002
- | display | string | no | |
2003
- | look_and_feel | [LookAndFeel](#LookAndFeel) | no | |
2004
- | updated_at | string | no | |
2005
- | active | boolean | no | |
2006
- | forgot_password | boolean | no | |
2007
- | login | [Login](#Login) | no | |
2008
- | skip_captcha | boolean | no | |
2009
- | name | string | no | |
2010
- | meta | [MetaSchema](#MetaSchema) | no | |
2011
- | _id | string | no | |
2012
- | social | [Social](#Social) | no | |
2013
- | required_fields | [RequiredFields](#RequiredFields) | no | |
2014
- | register_required_fields | [RegisterRequiredFields](#RegisterRequiredFields) | no | |
2015
- | skip_login | boolean | no | |
2016
- | flash_card | [FlashCard](#FlashCard) | no | |
2017
- | subtext | string | no | |
2018
- | social_tokens | [SocialTokens](#SocialTokens) | no | |
2019
- | created_at | string | no | |
2020
- | register | boolean | no | |
2021
- | mobile_image | string | no | |
2022
- | desktop_image | string | no | |
2023
- | delete_account_day | number | no | |
2024
- | delete_account_reasons | [[DeleteAccountReasons](#DeleteAccountReasons)] | no | |
2025
- | delete_account_consent | string | no | |
2026
- | session_config | string | no | |
1965
+ | ---------- | ---- | -------- | ----------- || captcha_code | string | no | || country_code | string | no | || mobile | string | no | |
2027
1966
 
2028
1967
  ---
2029
1968
 
2030
-
2031
-
2032
-
2033
- #### [LookAndFeel](#LookAndFeel)
1969
+ #### [SendVerificationLinkMobileRequestSchema](#SendVerificationLinkMobileRequestSchema)
2034
1970
 
2035
1971
  | Properties | Type | Nullable | Description |
2036
- | ---------- | ---- | -------- | ----------- |
2037
- | card_position | string | no | |
2038
- | background_color | string | no | |
1972
+ | ---------- | ---- | -------- | ----------- || active | boolean | no | || country_code | string | no | || phone | string | no | || primary | boolean | no | || verified | boolean | no | |
2039
1973
 
2040
1974
  ---
2041
1975
 
2042
-
2043
-
2044
-
2045
- #### [Login](#Login)
1976
+ #### [SessionDeleteResponseSchema](#SessionDeleteResponseSchema)
2046
1977
 
2047
1978
  | Properties | Type | Nullable | Description |
2048
- | ---------- | ---- | -------- | ----------- |
2049
- | password | boolean | no | |
2050
- | otp | boolean | no | |
1979
+ | ---------- | ---- | -------- | ----------- || items | [string] | no | |
2051
1980
 
2052
1981
  ---
2053
1982
 
2054
-
2055
-
2056
-
2057
- #### [MetaSchema](#MetaSchema)
1983
+ #### [SessionExpiry](#SessionExpiry)
2058
1984
 
2059
1985
  | Properties | Type | Nullable | Description |
2060
- | ---------- | ---- | -------- | ----------- |
2061
- | fynd_default | boolean | no | |
1986
+ | ---------- | ---- | -------- | ----------- || duration | number | no | || is_rolling | boolean | no | || type | string | no | |
2062
1987
 
2063
1988
  ---
2064
1989
 
2065
-
2066
-
2067
-
2068
- #### [Social](#Social)
1990
+ #### [SessionListResponseInfo](#SessionListResponseInfo)
2069
1991
 
2070
1992
  | Properties | Type | Nullable | Description |
2071
- | ---------- | ---- | -------- | ----------- |
2072
- | account_kit | boolean | no | |
2073
- | facebook | boolean | no | |
2074
- | google | boolean | no | |
2075
- | apple | boolean | no | |
1993
+ | ---------- | ---- | -------- | ----------- || domain | string | no | || expire_in | string | no | || ip | string | no | || session_id | string | no | || user_agent | string | no | |
2076
1994
 
2077
1995
  ---
2078
1996
 
2079
-
2080
-
2081
-
2082
- #### [RequiredFields](#RequiredFields)
1997
+ #### [SessionListResponseSchema](#SessionListResponseSchema)
2083
1998
 
2084
1999
  | Properties | Type | Nullable | Description |
2085
- | ---------- | ---- | -------- | ----------- |
2086
- | email | [PlatformEmail](#PlatformEmail) | no | |
2087
- | mobile | [PlatformMobile](#PlatformMobile) | no | |
2000
+ | ---------- | ---- | -------- | ----------- || items | [[SessionListResponseInfo](#SessionListResponseInfo)] | no | |
2088
2001
 
2089
2002
  ---
2090
2003
 
2091
-
2092
-
2093
-
2094
- #### [PlatformEmail](#PlatformEmail)
2004
+ #### [SessionListSuccess](#SessionListSuccess)
2095
2005
 
2096
2006
  | Properties | Type | Nullable | Description |
2097
- | ---------- | ---- | -------- | ----------- |
2098
- | is_required | boolean | no | |
2099
- | level | string | no | |
2007
+ | ---------- | ---- | -------- | ----------- || sessions | [string] | no | |
2100
2008
 
2101
2009
  ---
2102
2010
 
2103
-
2104
-
2105
-
2106
- #### [PlatformMobile](#PlatformMobile)
2011
+ #### [Social](#Social)
2107
2012
 
2108
2013
  | Properties | Type | Nullable | Description |
2109
- | ---------- | ---- | -------- | ----------- |
2110
- | is_required | boolean | no | |
2111
- | level | string | no | |
2014
+ | ---------- | ---- | -------- | ----------- || account_kit | boolean | no | || apple | boolean | no | || facebook | boolean | no | || google | boolean | no | |
2112
2015
 
2113
2016
  ---
2114
2017
 
2115
-
2116
-
2117
-
2118
- #### [RegisterRequiredFields](#RegisterRequiredFields)
2018
+ #### [SocialTokens](#SocialTokens)
2119
2019
 
2120
2020
  | Properties | Type | Nullable | Description |
2121
- | ---------- | ---- | -------- | ----------- |
2122
- | email | [RegisterRequiredFieldsEmail](#RegisterRequiredFieldsEmail) | no | |
2123
- | mobile | [RegisterRequiredFieldsMobile](#RegisterRequiredFieldsMobile) | no | |
2021
+ | ---------- | ---- | -------- | ----------- || account_kit | [Accountkit](#Accountkit) | no | || facebook | [Facebook](#Facebook) | no | || google | [Google](#Google) | no | |
2124
2022
 
2125
2023
  ---
2126
2024
 
2127
-
2128
-
2129
-
2130
- #### [RegisterRequiredFieldsEmail](#RegisterRequiredFieldsEmail)
2025
+ #### [TokenRequestBodySchema](#TokenRequestBodySchema)
2131
2026
 
2132
2027
  | Properties | Type | Nullable | Description |
2133
- | ---------- | ---- | -------- | ----------- |
2134
- | is_required | boolean | no | |
2135
- | level | string | no | |
2028
+ | ---------- | ---- | -------- | ----------- || token | string | no | |
2136
2029
 
2137
2030
  ---
2138
2031
 
2139
-
2140
-
2141
-
2142
- #### [RegisterRequiredFieldsMobile](#RegisterRequiredFieldsMobile)
2032
+ #### [UnauthenticatedSchema](#UnauthenticatedSchema)
2143
2033
 
2144
2034
  | Properties | Type | Nullable | Description |
2145
- | ---------- | ---- | -------- | ----------- |
2146
- | is_required | boolean | no | |
2147
- | level | string | no | |
2035
+ | ---------- | ---- | -------- | ----------- || authenticated | boolean | no | |
2148
2036
 
2149
2037
  ---
2150
2038
 
2151
-
2152
-
2153
-
2154
- #### [FlashCard](#FlashCard)
2039
+ #### [UnauthorizedSchema](#UnauthorizedSchema)
2155
2040
 
2156
2041
  | Properties | Type | Nullable | Description |
2157
- | ---------- | ---- | -------- | ----------- |
2158
- | text | string | no | |
2159
- | text_color | string | no | |
2160
- | background_color | string | no | |
2042
+ | ---------- | ---- | -------- | ----------- || message | string | no | |
2161
2043
 
2162
2044
  ---
2163
2045
 
2164
-
2165
-
2166
-
2167
- #### [SocialTokens](#SocialTokens)
2046
+ #### [UnDeleteUserRequestSchema](#UnDeleteUserRequestSchema)
2168
2047
 
2169
2048
  | Properties | Type | Nullable | Description |
2170
- | ---------- | ---- | -------- | ----------- |
2171
- | facebook | [Facebook](#Facebook) | no | |
2172
- | account_kit | [Accountkit](#Accountkit) | no | |
2173
- | google | [Google](#Google) | no | |
2049
+ | ---------- | ---- | -------- | ----------- || reason | string | no | || reason_id | string | no | || user_id | string | no | |
2174
2050
 
2175
2051
  ---
2176
2052
 
2177
-
2178
-
2179
-
2180
- #### [DeleteAccountReasons](#DeleteAccountReasons)
2053
+ #### [UnDeleteUserSuccess](#UnDeleteUserSuccess)
2181
2054
 
2182
2055
  | Properties | Type | Nullable | Description |
2183
- | ---------- | ---- | -------- | ----------- |
2184
- | reason_text | string | no | |
2185
- | reason_id | string | no | |
2186
- | show_text_area | boolean | no | |
2056
+ | ---------- | ---- | -------- | ----------- || success | boolean | no | |
2187
2057
 
2188
2058
  ---
2189
2059
 
2190
-
2191
-
2192
-
2193
- #### [DeleteAccountConsent](#DeleteAccountConsent)
2060
+ #### [UpdatePasswordRequestSchema](#UpdatePasswordRequestSchema)
2194
2061
 
2195
2062
  | Properties | Type | Nullable | Description |
2196
- | ---------- | ---- | -------- | ----------- |
2197
- | consent_text | string | no | |
2063
+ | ---------- | ---- | -------- | ----------- || new_password | string | no | || old_password | string | no | |
2198
2064
 
2199
2065
  ---
2200
2066
 
2201
-
2202
-
2203
-
2204
- #### [Facebook](#Facebook)
2067
+ #### [UpdateUserGroupSchema](#UpdateUserGroupSchema)
2205
2068
 
2206
2069
  | Properties | Type | Nullable | Description |
2207
- | ---------- | ---- | -------- | ----------- |
2208
- | app_id | string | no | |
2070
+ | ---------- | ---- | -------- | ----------- || description | string | no | || file_url | string | no | || name | string | no | |
2209
2071
 
2210
2072
  ---
2211
2073
 
2074
+ #### [UpdateUserRequestSchema](#UpdateUserRequestSchema)
2075
+
2076
+ | Properties | Type | Nullable | Description |
2077
+ | ---------- | ---- | -------- | ----------- || emails | [[UserEmails](#UserEmails)] | no | || external_id | string | no | || first_name | string | no | || gender | string | no | || last_name | string | no | || meta | string | no | || phone_numbers | [[UserPhoneNumbers](#UserPhoneNumbers)] | no | |
2078
+
2079
+ ---
2212
2080
 
2213
-
2214
-
2215
- #### [Accountkit](#Accountkit)
2081
+ #### [UserEmails](#UserEmails)
2216
2082
 
2217
2083
  | Properties | Type | Nullable | Description |
2218
- | ---------- | ---- | -------- | ----------- |
2219
- | app_id | string | no | |
2084
+ | ---------- | ---- | -------- | ----------- || active | boolean | no | || email | string | no | || primary | boolean | no | || verified | boolean | no | |
2220
2085
 
2221
2086
  ---
2222
2087
 
2088
+ #### [UserGroupListResponseSchema](#UserGroupListResponseSchema)
2223
2089
 
2224
-
2225
-
2226
- #### [Google](#Google)
2090
+ | Properties | Type | Nullable | Description |
2091
+ | ---------- | ---- | -------- | ----------- || items | [[UserGroupResponseSchema](#UserGroupResponseSchema)] | no | || page | [PaginationSchema](#PaginationSchema) | no | |
2092
+
2093
+ ---
2094
+
2095
+ #### [UserGroupResponseSchema](#UserGroupResponseSchema)
2227
2096
 
2228
2097
  | Properties | Type | Nullable | Description |
2229
- | ---------- | ---- | -------- | ----------- |
2230
- | app_id | string | no | |
2098
+ | ---------- | ---- | -------- | ----------- || __v | number | no | || _id | string | no | || application_id | string | no | || created_at | string | no | || description | string | no | || file_url | string | no | || modified_at | string | no | || name | string | no | || status | string | no | || uid | number | no | |
2231
2099
 
2232
2100
  ---
2233
2101
 
2102
+ #### [UserObjectSchema](#UserObjectSchema)
2103
+
2104
+ | Properties | Type | Nullable | Description |
2105
+ | ---------- | ---- | -------- | ----------- || user | [UserSchema](#UserSchema) | no | |
2106
+
2107
+ ---
2234
2108
 
2235
-
2236
-
2237
- #### [SessionExpiry](#SessionExpiry)
2109
+ #### [UserPhoneNumbers](#UserPhoneNumbers)
2238
2110
 
2239
2111
  | Properties | Type | Nullable | Description |
2240
- | ---------- | ---- | -------- | ----------- |
2241
- | duration | number | no | |
2242
- | type | string | no | |
2243
- | is_rolling | boolean | no | |
2112
+ | ---------- | ---- | -------- | ----------- || active | boolean | no | || country_code | string | no | || phone | string | no | || primary | boolean | no | || verified | boolean | no | |
2244
2113
 
2245
2114
  ---
2246
2115
 
2116
+ #### [UserSchema](#UserSchema)
2247
2117
 
2248
-
2249
-
2250
- #### [UpdateUserRequestSchema](#UpdateUserRequestSchema)
2118
+ | Properties | Type | Nullable | Description |
2119
+ | ---------- | ---- | -------- | ----------- || _id | string | no | || account_type | string | no | || active | boolean | no | || application_id | string | no | || created_at | string | no | || dob | string | no | || emails | [[Email](#Email)] | no | || first_name | string | no | || gender | string | no | || last_name | string | no | || meta | string | no | || phone_numbers | [[PhoneNumber](#PhoneNumber)] | no | || profile_pic_url | string | no | || updated_at | string | no | || user_id | string | no | || username | string | no | |
2120
+
2121
+ ---
2122
+
2123
+ #### [UserSearchResponseSchema](#UserSearchResponseSchema)
2251
2124
 
2252
2125
  | Properties | Type | Nullable | Description |
2253
- | ---------- | ---- | -------- | ----------- |
2254
- | first_name | string | no | |
2255
- | last_name | string | no | |
2256
- | gender | string | no | |
2257
- | external_id | string | no | |
2258
- | meta | string | no | |
2126
+ | ---------- | ---- | -------- | ----------- || users | [[UserSchema](#UserSchema)] | no | |
2259
2127
 
2260
2128
  ---
2261
2129
 
2130
+ #### [VerifyEmailOtpRequestSchema](#VerifyEmailOtpRequestSchema)
2131
+
2132
+ | Properties | Type | Nullable | Description |
2133
+ | ---------- | ---- | -------- | ----------- || action | string | no | || email | string | no | || otp | string | no | || register_token | string | no | |
2134
+
2135
+ ---
2262
2136
 
2263
-
2264
-
2265
- #### [UserSchema](#UserSchema)
2137
+ #### [VerifyEmailOTPSuccess](#VerifyEmailOTPSuccess)
2266
2138
 
2267
2139
  | Properties | Type | Nullable | Description |
2268
- | ---------- | ---- | -------- | ----------- |
2269
- | application_id | string | no | |
2270
- | user_id | string | no | |
2271
- | first_name | string | no | |
2272
- | meta | string | no | |
2273
- | last_name | string | no | |
2274
- | phone_numbers | [[PhoneNumber](#PhoneNumber)] | no | |
2275
- | emails | [[Email](#Email)] | no | |
2276
- | gender | string | no | |
2277
- | dob | string | no | |
2278
- | active | boolean | no | |
2279
- | profile_pic_url | string | no | |
2280
- | username | string | no | |
2281
- | account_type | string | no | |
2282
- | _id | string | no | |
2283
- | created_at | string | no | |
2284
- | updated_at | string | no | |
2140
+ | ---------- | ---- | -------- | ----------- || user | [UserSchema](#UserSchema) | no | || verify_email_link | boolean | no | |
2285
2141
 
2286
2142
  ---
2287
2143
 
2144
+ #### [VerifyEmailSuccess](#VerifyEmailSuccess)
2288
2145
 
2289
-
2290
-
2291
- #### [PhoneNumber](#PhoneNumber)
2146
+ | Properties | Type | Nullable | Description |
2147
+ | ---------- | ---- | -------- | ----------- || message | string | no | |
2148
+
2149
+ ---
2150
+
2151
+ #### [VerifyMobileOTPSuccess](#VerifyMobileOTPSuccess)
2292
2152
 
2293
2153
  | Properties | Type | Nullable | Description |
2294
- | ---------- | ---- | -------- | ----------- |
2295
- | active | boolean | no | |
2296
- | primary | boolean | no | |
2297
- | verified | boolean | no | |
2298
- | phone | string | no | |
2299
- | country_code | number | no | |
2154
+ | ---------- | ---- | -------- | ----------- || user | [UserSchema](#UserSchema) | no | || verify_mobile_link | boolean | no | |
2300
2155
 
2301
2156
  ---
2302
2157
 
2158
+ #### [VerifyOtpRequestSchema](#VerifyOtpRequestSchema)
2159
+
2160
+ | Properties | Type | Nullable | Description |
2161
+ | ---------- | ---- | -------- | ----------- || otp | string | no | || register_token | string | no | || request_id | string | no | |
2162
+
2163
+ ---
2303
2164
 
2304
-
2305
-
2306
- #### [Email](#Email)
2165
+ #### [VerifyOtpSuccess](#VerifyOtpSuccess)
2307
2166
 
2308
2167
  | Properties | Type | Nullable | Description |
2309
- | ---------- | ---- | -------- | ----------- |
2310
- | primary | boolean | no | |
2311
- | verified | boolean | no | |
2312
- | email | string | no | |
2313
- | active | boolean | no | |
2168
+ | ---------- | ---- | -------- | ----------- || register_token | string | no | || user | [UserSchema](#UserSchema) | no | || user_exists | boolean | no | |
2314
2169
 
2315
2170
  ---
2316
2171