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