@gofynd/fdk-client-javascript 1.0.2 → 1.0.4

package/documentation/platform/USER.md

@@ -1,2319 +0,0 @@
-
-
-
-
-
-##### [Back to Platform docs](./README.md)
-
-## User Methods
-Authentication Service
-
-* [getCustomers](#getcustomers)
-* [searchUsers](#searchusers)
-* [createUser](#createuser)
-* [blockOrUnblockUsers](#blockorunblockusers)
-* [archiveUser](#archiveuser)
-* [unDeleteUser](#undeleteuser)
-* [updateUser](#updateuser)
-* [createUserSession](#createusersession)
-* [getActiveSessions](#getactivesessions)
-* [deleteActiveSessions](#deleteactivesessions)
-* [getPlatformConfig](#getplatformconfig)
-* [updatePlatformConfig](#updateplatformconfig)
-
-
-
-## Methods with example and description
-
-
-
-
-### getCustomers
-Get a list of customers
-
-
-
-```javascript
-// Promise
-const promise = client.application("<APPLICATION_ID>").user.getCustomers({  q : value,
- pageSize : value,
- pageNo : value });
-
-// Async/Await
-const data = await client.application("<APPLICATION_ID>").user.getCustomers({  q : value,
- pageSize : value,
- pageNo : value });
-```
-
-
-
-
-
-| Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- |  
-| q | Object | no | The search query. Mobile number or email ID of a customer. |    
-| pageSize | number | no | The number of items to retrieve in each page. Default value is 10. |    
-| pageNo | number | no | The page number to navigate through the given set of results. Default value is 1.  |  
-
-
-
-Use this API to retrieve a list of customers who have registered in the application.
-
-*Returned Response:*
-
-
-
-
-[CustomerListResponseSchema](#CustomerListResponseSchema)
-
-Success. Refer `CustomerListResponseSchema` for more details.
-
-
-
-
-<details>
-<summary><i>&nbsp; Examples:</i></summary>
-
-
-<details>
-<summary><i>&nbsp; Success</i></summary>
-
-```json
-{
-  "value": {
-    "items": [
-      {
-        "_id": "000000000000000023106198",
-        "gender": "male",
-        "active": true,
-        "emails": [
-          {
-            "active": true,
-            "primary": true,
-            "verified": true,
-            "email": "raaz.crzy@gmail.com"
-          }
-        ],
-        "username": "raaz_crzy_gmail_com_63747_23106198",
-        "__v": 7,
-        "debug": {
-          "source": "deadlock",
-          "platform": "000000000000000000000003"
-        },
-        "dob": "1995-07-23T00:00:00.000Z",
-        "id": "000000000000000023106198",
-        "account_type": "user",
-        "profile_pic_url": "https://hdn-1.fynd.com/user/profile/original/000000000000000023106198/1586498418772.jpg",
-        "first_name": "Prince",
-        "last_name": "Raj",
-        "phone_numbers": [
-          {
-            "active": true,
-            "primary": true,
-            "verified": true,
-            "phone": "7008963113",
-            "country_code": 91
-          }
-        ],
-        "created_at": "2019-05-15T14:07:52.872Z",
-        "updated_at": "2020-09-21T06:38:41.388Z",
-        "has_old_password_hash": false
-      }
-    ],
-    "page": {
-      "type": "number",
-      "current": 1,
-      "size": 10,
-      "item_total": 0,
-      "has_next": false
-    }
-  }
-}
-```
-</details>
-
-</details>
-
-
-
-
-
-
-
-
-
----
-
-
-### searchUsers
-Search an existing user.
-
-
-
-```javascript
-// Promise
-const promise = client.application("<APPLICATION_ID>").user.searchUsers({  q : value });
-
-// Async/Await
-const data = await client.application("<APPLICATION_ID>").user.searchUsers({  q : value });
-```
-
-
-
-
-
-| Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- |  
-| q | string | no | The search query. Mobile number or email ID of a customer. |  
-
-
-
-Use this API to retrieve an existing user from a list.
-
-*Returned Response:*
-
-
-
-
-[UserSearchResponseSchema](#UserSearchResponseSchema)
-
-Success. Returns first name, last name, emails, phone number and gender of the user. Refer `UserSearchResponseSchema` for more details.
-
-
-
-
-<details>
-<summary><i>&nbsp; Example:</i></summary>
-
-```json
-{
-  "users": [
-    {
-      "_id": "5e68af49cfa09bf7233022f1",
-      "gender": "male",
-      "active": true,
-      "emails": [
-        {
-          "active": true,
-          "primary": true,
-          "verified": true,
-          "email": "akashmane@gofynd.com"
-        },
-        {
-          "active": true,
-          "primary": false,
-          "verified": true,
-          "email": "akashmane@fynd.com"
-        },
-        {
-          "active": true,
-          "primary": false,
-          "verified": true,
-          "email": "akashmane@uniket.store"
-        }
-      ],
-      "account_type": "user",
-      "first_name": "Akash",
-      "last_name": "Mane",
-      "phone_numbers": [
-        {
-          "active": true,
-          "primary": true,
-          "verified": true,
-          "phone": "8652523958",
-          "country_code": 91
-        }
-      ],
-      "created_at": "2020-03-11T09:28:41.982Z",
-      "updated_at": "2020-03-11T09:28:41.982Z"
-    }
-  ]
-}
-```
-</details>
-
-
-
-
-
-
-
-
-
----
-
-
-### createUser
-Create user
-
-
-
-```javascript
-// Promise
-const promise = client.application("<APPLICATION_ID>").user.createUser({  body : value });
-
-// Async/Await
-const data = await client.application("<APPLICATION_ID>").user.createUser({  body : value });
-```
-
-
-
-
-
-| Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- |
-| body | [CreateUserRequestSchema](#CreateUserRequestSchema) | yes | Request body |
-
-
-Create user
-
-*Returned Response:*
-
-
-
-
-[CreateUserResponseSchema](#CreateUserResponseSchema)
-
-User create
-
-
-
-
-<details>
-<summary><i>&nbsp; Example:</i></summary>
-
-```json
-{
-  "user": {
-    "_id": "5e68af49cfa09bf7233022f1",
-    "gender": "male",
-    "active": true,
-    "emails": [
-      {
-        "active": true,
-        "primary": true,
-        "verified": true,
-        "email": "akashmane@gofynd.com"
-      },
-      {
-        "active": true,
-        "primary": false,
-        "verified": true,
-        "email": "akashmane@fynd.com"
-      },
-      {
-        "active": true,
-        "primary": false,
-        "verified": true,
-        "email": "akashmane@uniket.store"
-      }
-    ],
-    "external_id": "100002000036789",
-    "account_type": "user",
-    "first_name": "Akash",
-    "last_name": "Mane",
-    "phone_numbers": [
-      {
-        "active": true,
-        "primary": true,
-        "verified": true,
-        "phone": "8652523958",
-        "country_code": 91
-      }
-    ],
-    "meta": {},
-    "created_at": "2020-03-11T09:28:41.982Z",
-    "updated_at": "2020-03-11T09:28:41.982Z"
-  }
-}
-```
-</details>
-
-
-
-
-
-
-
-
-
----
-
-
-### blockOrUnblockUsers
-Block/Unblock user
-
-
-
-```javascript
-// Promise
-const promise = client.application("<APPLICATION_ID>").user.blockOrUnblockUsers({  body : value });
-
-// Async/Await
-const data = await client.application("<APPLICATION_ID>").user.blockOrUnblockUsers({  body : value });
-```
-
-
-
-
-
-| Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- |
-| body | [BlockUserRequestSchema](#BlockUserRequestSchema) | yes | Request body |
-
-
-Block/Unblock user
-
-*Returned Response:*
-
-
-
-
-[BlockUserSuccess](#BlockUserSuccess)
-
-Success
-
-
-
-
-<details>
-<summary><i>&nbsp; Example:</i></summary>
-
-```json
-{
-  "success": true
-}
-```
-</details>
-
-
-
-
-
-
-
-
-
----
-
-
-### archiveUser
-archive user
-
-
-
-```javascript
-// Promise
-const promise = client.application("<APPLICATION_ID>").user.archiveUser({  body : value });
-
-// Async/Await
-const data = await client.application("<APPLICATION_ID>").user.archiveUser({  body : value });
-```
-
-
-
-
-
-| Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- |
-| body | [ArchiveUserRequestSchema](#ArchiveUserRequestSchema) | yes | Request body |
-
-
-archive user
-
-*Returned Response:*
-
-
-
-
-[ArchiveUserSuccess](#ArchiveUserSuccess)
-
-Success
-
-
-
-
-<details>
-<summary><i>&nbsp; Example:</i></summary>
-
-```json
-{
-  "success": true
-}
-```
-</details>
-
-
-
-
-
-
-
-
-
----
-
-
-### unDeleteUser
-undelete user who deleted from application and have not elapsed the platform configured delete days
-
-
-
-```javascript
-// Promise
-const promise = client.application("<APPLICATION_ID>").user.unDeleteUser({  body : value });
-
-// Async/Await
-const data = await client.application("<APPLICATION_ID>").user.unDeleteUser({  body : value });
-```
-
-
-
-
-
-| Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- |
-| body | [UnDeleteUserRequestSchema](#UnDeleteUserRequestSchema) | yes | Request body |
-
-
-undelete user who deleted from application and have not elapsed the platform configured delete days
-
-*Returned Response:*
-
-
-
-
-[UnDeleteUserSuccess](#UnDeleteUserSuccess)
-
-Success
-
-
-
-
-<details>
-<summary><i>&nbsp; Example:</i></summary>
-
-```json
-{
-  "success": true
-}
-```
-</details>
-
-
-
-
-
-
-
-
-
----
-
-
-### updateUser
-Update user
-
-
-
-```javascript
-// Promise
-const promise = client.application("<APPLICATION_ID>").user.updateUser({  userId : value,
- body : value });
-
-// Async/Await
-const data = await client.application("<APPLICATION_ID>").user.updateUser({  userId : value,
- body : value });
-```
-
-
-
-
-
-| Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- | 
-| userId | string | yes | User ID |  
-| body | [UpdateUserRequestSchema](#UpdateUserRequestSchema) | yes | Request body |
-
-
-Update user
-
-*Returned Response:*
-
-
-
-
-[CreateUserResponseSchema](#CreateUserResponseSchema)
-
-User update
-
-
-
-
-<details>
-<summary><i>&nbsp; Example:</i></summary>
-
-```json
-{
-  "user": {
-    "_id": "5e68af49cfa09bf7233022f1",
-    "gender": "male",
-    "active": true,
-    "emails": [
-      {
-        "active": true,
-        "primary": true,
-        "verified": true,
-        "email": "akashmane@gofynd.com"
-      },
-      {
-        "active": true,
-        "primary": false,
-        "verified": true,
-        "email": "akashmane@fynd.com"
-      },
-      {
-        "active": true,
-        "primary": false,
-        "verified": true,
-        "email": "akashmane@uniket.store"
-      }
-    ],
-    "external_id": "100002000036789",
-    "account_type": "user",
-    "first_name": "Akash",
-    "last_name": "Mane",
-    "phone_numbers": [
-      {
-        "active": true,
-        "primary": true,
-        "verified": true,
-        "phone": "8652523958",
-        "country_code": 91
-      }
-    ],
-    "meta": {},
-    "created_at": "2020-03-11T09:28:41.982Z",
-    "updated_at": "2020-03-11T09:28:41.982Z"
-  }
-}
-```
-</details>
-
-
-
-
-
-
-
-
-
----
-
-
-### createUserSession
-Create user session
-
-
-
-```javascript
-// Promise
-const promise = client.application("<APPLICATION_ID>").user.createUserSession({  body : value });
-
-// Async/Await
-const data = await client.application("<APPLICATION_ID>").user.createUserSession({  body : value });
-```
-
-
-
-
-
-| Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- |
-| body | [CreateUserSessionRequestSchema](#CreateUserSessionRequestSchema) | yes | Request body |
-
-
-Create user session
-
-*Returned Response:*
-
-
-
-
-[CreateUserSessionResponseSchema](#CreateUserSessionResponseSchema)
-
-Create user session
-
-
-
-
-<details>
-<summary><i>&nbsp; Example:</i></summary>
-
-```json
-{
-  "domain": "vinit.com",
-  "max_age": 4555555,
-  "secure": true,
-  "http_only": true,
-  "cookie": {
-    "f.session": "s%3A-LrEF5FVR8jrT5DCtCHSbAy7JFyX-f9T.uXOQwzje8nOfx4ODANrLi4yNX5fW2W5kLQ2rkBdO2xE"
-  }
-}
-```
-</details>
-
-
-
-
-
-
-
-
-
----
-
-
-### getActiveSessions
-Get a list of all session for a user
-
-
-
-```javascript
-// Promise
-const promise = client.application("<APPLICATION_ID>").user.getActiveSessions({  id : value });
-
-// Async/Await
-const data = await client.application("<APPLICATION_ID>").user.getActiveSessions({  id : value });
-```
-
-
-
-
-
-| Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- | 
-| id | string | yes | ID of a customer. |  
-
-
-
-Use this API to retrieve a list of session of customers who have registered in the application.
-
-*Returned Response:*
-
-
-
-
-[SessionListResponseSchema](#SessionListResponseSchema)
-
-Success. Refer `SessionListResponseSchema` for more details.
-
-
-
-
-<details>
-<summary><i>&nbsp; Examples:</i></summary>
-
-
-<details>
-<summary><i>&nbsp; Success</i></summary>
-
-```json
-{
-  "value": {
-    "items": [
-      "sess:123",
-      "sess:456"
-    ]
-  }
-}
-```
-</details>
-
-</details>
-
-
-
-
-
-
-
-
-
----
-
-
-### deleteActiveSessions
-Delete a list of all session for a user
-
-
-
-```javascript
-// Promise
-const promise = client.application("<APPLICATION_ID>").user.deleteActiveSessions({  id : value });
-
-// Async/Await
-const data = await client.application("<APPLICATION_ID>").user.deleteActiveSessions({  id : value });
-```
-
-
-
-
-
-| Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- | 
-| id | string | yes | ID of a customer. |  
-
-
-
-Use this API to Delete a list of session of customers who have registered in the application.
-
-*Returned Response:*
-
-
-
-
-[SessionDeleteResponseSchema](#SessionDeleteResponseSchema)
-
-Success. Refer `SessionDeleteResponseSchema` for more details.
-
-
-
-
-<details>
-<summary><i>&nbsp; Examples:</i></summary>
-
-
-<details>
-<summary><i>&nbsp; Success</i></summary>
-
-```json
-{
-  "value": {
-    "items": [
-      "sess:123",
-      "sess:456"
-    ]
-  }
-}
-```
-</details>
-
-</details>
-
-
-
-
-
-
-
-
-
----
-
-
-### getPlatformConfig
-Get platform configurations
-
-
-
-```javascript
-// Promise
-const promise = client.application("<APPLICATION_ID>").user.getPlatformConfig();
-
-// Async/Await
-const data = await client.application("<APPLICATION_ID>").user.getPlatformConfig();
-```
-
-
-
-
-
-
-Use this API to get all the platform configurations such as mobile image, desktop image, social logins, and all other text.
-
-*Returned Response:*
-
-
-
-
-[PlatformSchema](#PlatformSchema)
-
-Success. Returns a JSON object containing the all the platform configurations. Refer `PlatformSchema` for more details.
-
-
-
-
-<details>
-<summary><i>&nbsp; Example:</i></summary>
-
-```json
-{
-  "active": true,
-  "mobile_image": "",
-  "desktop_image": "",
-  "social": {
-    "facebook": true,
-    "google": true,
-    "account_kit": true
-  },
-  "flash_card": {
-    "text": "",
-    "text_color": "#FFFFFF",
-    "background_color": "#EF5350"
-  },
-  "register": true,
-  "forgot_password": true,
-  "login": {
-    "password": true,
-    "otp": true
-  },
-  "skip_captcha": false,
-  "display": "Fynd",
-  "subtext": "Login to Fynd",
-  "name": "Fynd",
-  "meta": {},
-  "required_fields": {
-    "email": {
-      "is_required": false,
-      "level": "hard"
-    },
-    "mobile": {
-      "is_required": true,
-      "level": "hard"
-    }
-  },
-  "register_required_fields": {
-    "email": {
-      "is_required": false,
-      "level": "hard"
-    },
-    "mobile": {
-      "is_required": true,
-      "level": "hard"
-    }
-  },
-  "skip_login": false,
-  "look_and_feel": {
-    "background_color": "#F5F5F5",
-    "card_position": "center"
-  },
-  "social_tokens": {
-    "google": {
-      "appId": "token_123"
-    },
-    "facebook": {
-      "appId": "token_123"
-    },
-    "account_kit": {
-      "appId": "token_123"
-    }
-  },
-  "session_config": {
-    "duration": 30,
-    "type": "Days",
-    "is_rolling": false
-  },
-  "delete_account_reasons": [
-    {
-      "reason_text": "test",
-      "reason_id": "123",
-      "show_text_area": true
-    }
-  ],
-  "delete_account_day": 7,
-  "delete_account_consent": {
-    "consent_text": ""
-  },
-  "_id": "5e04a5e5220bc15839ad9bc0",
-  "created_at": "2019-12-26T12:21:57.878Z",
-  "updated_at": "2020-08-13T14:31:09.878Z",
-  "__v": 0
-}
-```
-</details>
-
-
-
-
-
-
-
-
-
----
-
-
-### updatePlatformConfig
-Update platform configurations
-
-
-
-```javascript
-// Promise
-const promise = client.application("<APPLICATION_ID>").user.updatePlatformConfig({  body : value });
-
-// Async/Await
-const data = await client.application("<APPLICATION_ID>").user.updatePlatformConfig({  body : value });
-```
-
-
-
-
-
-| Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- |
-| body | [PlatformSchema](#PlatformSchema) | yes | Request body |
-
-
-Use this API to edit the existing platform configurations such as mobile image, desktop image, social logins, and all other text.
-
-*Returned Response:*
-
-
-
-
-[PlatformSchema](#PlatformSchema)
-
-Success. Returns a JSON object with the updated platform configurations. Refer `PlatformSchema` for more details.
-
-
-
-
-<details>
-<summary><i>&nbsp; Example:</i></summary>
-
-```json
-{
-  "active": true,
-  "mobile_image": "",
-  "desktop_image": "",
-  "social": {
-    "facebook": true,
-    "google": true,
-    "account_kit": true
-  },
-  "flash_card": {
-    "text": "",
-    "text_color": "#FFFFFF",
-    "background_color": "#EF5350"
-  },
-  "register": true,
-  "forgot_password": true,
-  "login": {
-    "password": true,
-    "otp": true
-  },
-  "skip_captcha": false,
-  "display": "Fynd",
-  "subtext": "Login to Fynd",
-  "name": "Fynd",
-  "meta": {},
-  "required_fields": {
-    "email": {
-      "is_required": false,
-      "level": "hard"
-    },
-    "mobile": {
-      "is_required": true,
-      "level": "hard"
-    }
-  },
-  "register_required_fields": {
-    "email": {
-      "is_required": false,
-      "level": "hard"
-    },
-    "mobile": {
-      "is_required": true,
-      "level": "hard"
-    }
-  },
-  "skip_login": false,
-  "look_and_feel": {
-    "background_color": "#F5F5F5",
-    "card_position": "center"
-  },
-  "social_tokens": {
-    "google": {
-      "appId": "token_123"
-    },
-    "facebook": {
-      "appId": "token_123"
-    },
-    "account_kit": {
-      "appId": "token_123"
-    }
-  },
-  "session_config": {
-    "duration": 30,
-    "type": "Days",
-    "is_rolling": false
-  },
-  "delete_account_reasons": [
-    {
-      "reason_text": "test",
-      "reason_id": "123",
-      "show_text_area": true
-    }
-  ],
-  "delete_account_day": 7,
-  "delete_account_consent": {
-    "consent_text": ""
-  },
-  "_id": "5e04a5e5220bc15839ad9bc0",
-  "created_at": "2019-12-26T12:21:57.878Z",
-  "updated_at": "2020-08-13T14:31:09.878Z",
-  "__v": 0
-}
-```
-</details>
-
-
-
-
-
-
-
-
-
----
-
-
-
-### Schemas
-
- 
- 
- #### [BlockUserRequestSchema](#BlockUserRequestSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | status | boolean |  no  |  |
- | user_id | [string] |  no  |  |
- | reason | string |  no  |  |
-
----
-
-
- 
- 
- #### [ArchiveUserRequestSchema](#ArchiveUserRequestSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | user_id | string |  no  |  |
-
----
-
-
- 
- 
- #### [DeleteApplicationUserRequestSchema](#DeleteApplicationUserRequestSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | user_id | string |  no  |  |
- | reason | string |  no  |  |
- | reason_id | string |  no  |  |
- | request_id | string |  no  |  |
- | otp | string |  no  |  |
-
----
-
-
- 
- 
- #### [UnDeleteUserRequestSchema](#UnDeleteUserRequestSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | user_id | string |  no  |  |
- | reason | string |  no  |  |
- | reason_id | string |  no  |  |
-
----
-
-
- 
- 
- #### [EditEmailRequestSchema](#EditEmailRequestSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | email | string |  no  |  |
-
----
-
-
- 
- 
- #### [SendVerificationLinkMobileRequestSchema](#SendVerificationLinkMobileRequestSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | verified | boolean |  no  |  |
- | active | boolean |  no  |  |
- | country_code | string |  no  |  |
- | phone | string |  no  |  |
- | primary | boolean |  no  |  |
-
----
-
-
- 
- 
- #### [EditMobileRequestSchema](#EditMobileRequestSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | country_code | string |  no  |  |
- | phone | string |  no  |  |
-
----
-
-
- 
- 
- #### [EditProfileRequestSchema](#EditProfileRequestSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | first_name | string |  no  |  |
- | last_name | string |  no  |  |
- | mobile | [EditProfileMobileSchema](#EditProfileMobileSchema) |  no  |  |
- | country_code | string |  no  |  |
- | email | string |  no  |  |
- | gender | string |  no  |  |
- | dob | string |  no  |  |
- | profile_pic_url | string |  no  |  |
- | android_hash | string |  no  |  |
- | sender | string |  no  |  |
- | register_token | string |  no  |  |
-
----
-
-
- 
- 
- #### [EditProfileMobileSchema](#EditProfileMobileSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | phone | string |  no  |  |
- | country_code | string |  no  |  |
-
----
-
-
- 
- 
- #### [SendEmailOtpRequestSchema](#SendEmailOtpRequestSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | email | string |  no  |  |
- | action | string |  no  |  |
- | token | string |  no  |  |
- | register_token | string |  no  |  |
-
----
-
-
- 
- 
- #### [VerifyEmailOtpRequestSchema](#VerifyEmailOtpRequestSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | email | string |  no  |  |
- | action | string |  no  |  |
- | register_token | string |  no  |  |
- | otp | string |  no  |  |
-
----
-
-
- 
- 
- #### [VerifyOtpRequestSchema](#VerifyOtpRequestSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | request_id | string |  no  |  |
- | register_token | string |  no  |  |
- | otp | string |  no  |  |
-
----
-
-
- 
- 
- #### [SendMobileOtpRequestSchema](#SendMobileOtpRequestSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | mobile | string |  no  |  |
- | country_code | string |  no  |  |
- | action | string |  no  |  |
- | token | string |  no  |  |
- | android_hash | string |  no  |  |
- | force | string |  no  |  |
- | captcha_code | string |  no  |  |
-
----
-
-
- 
- 
- #### [UpdatePasswordRequestSchema](#UpdatePasswordRequestSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | old_password | string |  no  |  |
- | new_password | string |  no  |  |
-
----
-
-
- 
- 
- #### [FormRegisterRequestSchema](#FormRegisterRequestSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | first_name | string |  no  |  |
- | last_name | string |  no  |  |
- | gender | string |  no  |  |
- | email | string |  no  |  |
- | password | string |  no  |  |
- | phone | [FormRegisterRequestSchemaPhone](#FormRegisterRequestSchemaPhone) |  no  |  |
- | register_token | string |  no  |  |
-
----
-
-
- 
- 
- #### [TokenRequestBodySchema](#TokenRequestBodySchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | token | string |  no  |  |
-
----
-
-
- 
- 
- #### [ForgotPasswordRequestSchema](#ForgotPasswordRequestSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | code | string |  no  |  |
- | password | string |  no  |  |
-
----
-
-
- 
- 
- #### [CodeRequestBodySchema](#CodeRequestBodySchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | code | string |  no  |  |
-
----
-
-
- 
- 
- #### [SendResetPasswordEmailRequestSchema](#SendResetPasswordEmailRequestSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | email | string |  no  |  |
- | captcha_code | string |  no  |  |
-
----
-
-
- 
- 
- #### [SendResetPasswordMobileRequestSchema](#SendResetPasswordMobileRequestSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | country_code | string |  no  |  |
- | mobile | string |  no  |  |
- | captcha_code | string |  no  |  |
-
----
-
-
- 
- 
- #### [PasswordLoginRequestSchema](#PasswordLoginRequestSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | captcha_code | string |  no  |  |
- | password | string |  no  |  |
- | username | string |  no  |  |
-
----
-
-
- 
- 
- #### [SendOtpRequestSchema](#SendOtpRequestSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | country_code | string |  no  |  |
- | captcha_code | string |  no  |  |
- | mobile | string |  no  |  |
- | android_hash | string |  no  |  |
-
----
-
-
- 
- 
- #### [OAuthRequestSchema](#OAuthRequestSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | is_signed_in | boolean |  no  |  |
- | oauth2 | [OAuthRequestSchemaOauth2](#OAuthRequestSchemaOauth2) |  no  |  |
- | profile | [OAuthRequestSchemaProfile](#OAuthRequestSchemaProfile) |  no  |  |
-
----
-
-
- 
- 
- #### [OAuthRequestAppleSchema](#OAuthRequestAppleSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | user_identifier | string |  no  |  |
- | oauth | [OAuthRequestAppleSchemaOauth](#OAuthRequestAppleSchemaOauth) |  no  |  |
- | profile | [OAuthRequestAppleSchemaProfile](#OAuthRequestAppleSchemaProfile) |  no  |  |
-
----
-
-
- 
- 
- #### [UserObjectSchema](#UserObjectSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | user | [UserSchema](#UserSchema) |  no  |  |
-
----
-
-
- 
- 
- #### [AuthSuccess](#AuthSuccess)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | register_token | string |  no  |  |
- | user_exists | boolean |  no  |  |
- | user | [UserSchema](#UserSchema) |  no  |  |
-
----
-
-
- 
- 
- #### [SendOtpResponse](#SendOtpResponse)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | resend_timer | number |  no  |  |
- | resend_token | string |  no  |  |
- | success | boolean |  no  |  |
- | request_id | string |  no  |  |
- | message | string |  no  |  |
- | mobile | string |  no  |  |
- | country_code | string |  no  |  |
- | email | string |  no  |  |
- | resend_email_token | string |  no  |  |
- | register_token | string |  no  |  |
- | verify_email_otp | boolean |  no  |  |
- | verify_mobile_otp | boolean |  no  |  |
- | user_exists | boolean |  no  |  |
-
----
-
-
- 
- 
- #### [ProfileEditSuccess](#ProfileEditSuccess)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | user | [UserSchema](#UserSchema) |  no  |  |
- | register_token | string |  no  |  |
- | resend_email_token | string |  no  |  |
- | user_exists | boolean |  no  |  |
- | verify_email_link | boolean |  no  |  |
- | verify_email_otp | boolean |  no  |  |
- | verify_mobile_otp | boolean |  no  |  |
- | email | string |  no  |  |
- | request_id | string |  no  |  |
- | country_code | string |  no  |  |
- | mobile | string |  no  |  |
- | success | boolean |  no  |  |
- | message | string |  no  |  |
- | resend_timer | number |  no  |  |
- | resend_token | string |  no  |  |
-
----
-
-
- 
- 
- #### [LoginSuccess](#LoginSuccess)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | user | [UserSchema](#UserSchema) |  no  |  |
- | request_id | string |  no  |  |
- | register_token | string |  no  |  |
-
----
-
-
- 
- 
- #### [VerifyOtpSuccess](#VerifyOtpSuccess)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | user | [UserSchema](#UserSchema) |  no  |  |
- | user_exists | boolean |  no  |  |
- | register_token | string |  no  |  |
-
----
-
-
- 
- 
- #### [ResetPasswordSuccess](#ResetPasswordSuccess)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | status | string |  no  |  |
-
----
-
-
- 
- 
- #### [RegisterFormSuccess](#RegisterFormSuccess)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | email | string |  no  |  |
- | resend_timer | number |  no  |  |
- | resend_token | string |  no  |  |
- | resend_email_token | string |  no  |  |
- | register_token | string |  no  |  |
- | success | boolean |  no  |  |
- | request_id | string |  no  |  |
- | message | string |  no  |  |
- | mobile | string |  no  |  |
- | country_code | string |  no  |  |
- | verify_email_otp | boolean |  no  |  |
- | verify_mobile_otp | boolean |  no  |  |
- | user_exists | boolean |  no  |  |
-
----
-
-
- 
- 
- #### [VerifyEmailSuccess](#VerifyEmailSuccess)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | message | string |  no  |  |
-
----
-
-
- 
- 
- #### [HasPasswordSuccess](#HasPasswordSuccess)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | result | boolean |  no  |  |
-
----
-
-
- 
- 
- #### [LogoutSuccess](#LogoutSuccess)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | logout | boolean |  no  |  |
-
----
-
-
- 
- 
- #### [BlockUserSuccess](#BlockUserSuccess)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | success | boolean |  no  |  |
-
----
-
-
- 
- 
- #### [ArchiveUserSuccess](#ArchiveUserSuccess)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | success | boolean |  no  |  |
-
----
-
-
- 
- 
- #### [DeleteUserSuccess](#DeleteUserSuccess)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | success | boolean |  no  |  |
-
----
-
-
- 
- 
- #### [UnDeleteUserSuccess](#UnDeleteUserSuccess)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | success | boolean |  no  |  |
-
----
-
-
- 
- 
- #### [OtpSuccess](#OtpSuccess)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | resend_timer | number |  no  |  |
- | resend_token | string |  no  |  |
- | register_token | string |  no  |  |
- | success | boolean |  no  |  |
- | request_id | string |  no  |  |
- | message | string |  no  |  |
- | mobile | string |  no  |  |
- | country_code | string |  no  |  |
-
----
-
-
- 
- 
- #### [EmailOtpSuccess](#EmailOtpSuccess)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | success | boolean |  no  |  |
-
----
-
-
- 
- 
- #### [SessionListSuccess](#SessionListSuccess)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | sessions | [string] |  no  |  |
-
----
-
-
- 
- 
- #### [VerifyMobileOTPSuccess](#VerifyMobileOTPSuccess)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | user | [UserSchema](#UserSchema) |  no  |  |
- | verify_mobile_link | boolean |  no  |  |
-
----
-
-
- 
- 
- #### [VerifyEmailOTPSuccess](#VerifyEmailOTPSuccess)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | user | [UserSchema](#UserSchema) |  no  |  |
- | verify_email_link | boolean |  no  |  |
-
----
-
-
- 
- 
- #### [SendMobileVerifyLinkSuccess](#SendMobileVerifyLinkSuccess)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | verify_mobile_link | boolean |  no  |  |
-
----
-
-
- 
- 
- #### [SendEmailVerifyLinkSuccess](#SendEmailVerifyLinkSuccess)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | verify_email_link | boolean |  no  |  |
-
----
-
-
- 
- 
- #### [UserSearchResponseSchema](#UserSearchResponseSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | users | [[UserSchema](#UserSchema)] |  no  |  |
-
----
-
-
- 
- 
- #### [CustomerListResponseSchema](#CustomerListResponseSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | items | [[UserSchema](#UserSchema)] |  no  |  |
- | page | [PaginationSchema](#PaginationSchema) |  no  |  |
-
----
-
-
- 
- 
- #### [PaginationSchema](#PaginationSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | size | number |  no  |  |
- | item_total | number |  no  |  |
- | has_next | boolean |  no  |  |
- | type | string |  no  |  |
- | current | number |  no  |  |
-
----
-
-
- 
- 
- #### [SessionListResponseSchema](#SessionListResponseSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | items | [string] |  no  |  |
-
----
-
-
- 
- 
- #### [SessionDeleteResponseSchema](#SessionDeleteResponseSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | items | [string] |  no  |  |
-
----
-
-
- 
- 
- #### [UnauthorizedSchema](#UnauthorizedSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | message | string |  no  |  |
-
----
-
-
- 
- 
- #### [UnauthenticatedSchema](#UnauthenticatedSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | authenticated | boolean |  no  |  |
-
----
-
-
- 
- 
- #### [NotFoundSchema](#NotFoundSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | message | string |  no  |  |
-
----
-
-
- 
- 
- #### [AuthenticationInternalServerErrorSchema](#AuthenticationInternalServerErrorSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | message | string |  no  |  |
-
----
-
-
- 
- 
- #### [AuthenticationApiErrorSchema](#AuthenticationApiErrorSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | message | string |  no  |  |
-
----
-
-
- 
- 
- #### [ProfileEditSuccessSchema](#ProfileEditSuccessSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | email | string |  no  |  |
- | verify_email_otp | boolean |  no  |  |
- | verify_email_link | boolean |  no  |  |
- | verify_mobile_otp | boolean |  no  |  |
- | user | string |  no  |  |
- | register_token | string |  no  |  |
- | user_exists | boolean |  no  |  |
-
----
-
-
- 
- 
- #### [FormRegisterRequestSchemaPhone](#FormRegisterRequestSchemaPhone)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | country_code | string |  no  |  |
- | mobile | string |  no  |  |
-
----
-
-
- 
- 
- #### [OAuthRequestSchemaOauth2](#OAuthRequestSchemaOauth2)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | access_token | string |  no  |  |
- | expiry | number |  no  |  |
- | refresh_token | string |  no  |  |
-
----
-
-
- 
- 
- #### [OAuthRequestSchemaProfile](#OAuthRequestSchemaProfile)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | last_name | string |  no  |  |
- | image | string |  no  |  |
- | id | string |  no  |  |
- | email | string |  no  |  |
- | full_name | string |  no  |  |
- | first_name | string |  no  |  |
-
----
-
-
- 
- 
- #### [OAuthRequestAppleSchemaOauth](#OAuthRequestAppleSchemaOauth)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | identity_token | string |  no  |  |
-
----
-
-
- 
- 
- #### [OAuthRequestAppleSchemaProfile](#OAuthRequestAppleSchemaProfile)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | last_name | string |  no  |  |
- | full_name | string |  no  |  |
- | first_name | string |  no  |  |
-
----
-
-
- 
- 
- #### [AuthSuccessUser](#AuthSuccessUser)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | first_name | string |  no  |  |
- | last_name | string |  no  |  |
- | debug | [AuthSuccessUserDebug](#AuthSuccessUserDebug) |  no  |  |
- | active | boolean |  no  |  |
- | emails | [AuthSuccessUserEmails](#AuthSuccessUserEmails) |  no  |  |
-
----
-
-
- 
- 
- #### [AuthSuccessUserDebug](#AuthSuccessUserDebug)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | platform | string |  no  |  |
-
----
-
-
- 
- 
- #### [AuthSuccessUserEmails](#AuthSuccessUserEmails)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | email | string |  no  |  |
- | verified | boolean |  no  |  |
- | primary | boolean |  no  |  |
- | active | boolean |  no  |  |
-
----
-
-
- 
- 
- #### [CreateUserRequestSchema](#CreateUserRequestSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | phone_number | string |  yes  |  |
- | email | string |  no  |  |
- | first_name | string |  no  |  |
- | last_name | string |  no  |  |
- | gender | string |  no  |  |
- | username | string |  yes  |  |
- | meta | string |  no  |  |
-
----
-
-
- 
- 
- #### [CreateUserResponseSchema](#CreateUserResponseSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | user | [UserSchema](#UserSchema) |  no  |  |
-
----
-
-
- 
- 
- #### [CreateUserSessionRequestSchema](#CreateUserSessionRequestSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | domain | string |  no  |  |
- | max_age | number |  no  |  |
- | user_id | string |  no  |  |
-
----
-
-
- 
- 
- #### [CreateUserSessionResponseSchema](#CreateUserSessionResponseSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | domain | string |  no  |  |
- | max_age | number |  no  |  |
- | secure | boolean |  no  |  |
- | http_only | boolean |  no  |  |
- | cookie | string |  no  |  |
-
----
-
-
- 
- 
- #### [PlatformSchema](#PlatformSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | display | string |  no  |  |
- | look_and_feel | [LookAndFeel](#LookAndFeel) |  no  |  |
- | updated_at | string |  no  |  |
- | active | boolean |  no  |  |
- | forgot_password | boolean |  no  |  |
- | login | [Login](#Login) |  no  |  |
- | skip_captcha | boolean |  no  |  |
- | name | string |  no  |  |
- | meta | [MetaSchema](#MetaSchema) |  no  |  |
- | _id | string |  no  |  |
- | social | [Social](#Social) |  no  |  |
- | required_fields | [RequiredFields](#RequiredFields) |  no  |  |
- | register_required_fields | [RegisterRequiredFields](#RegisterRequiredFields) |  no  |  |
- | skip_login | boolean |  no  |  |
- | flash_card | [FlashCard](#FlashCard) |  no  |  |
- | subtext | string |  no  |  |
- | social_tokens | [SocialTokens](#SocialTokens) |  no  |  |
- | created_at | string |  no  |  |
- | register | boolean |  no  |  |
- | mobile_image | string |  no  |  |
- | desktop_image | string |  no  |  |
- | delete_account_day | number |  no  |  |
- | delete_account_reasons | [[DeleteAccountReasons](#DeleteAccountReasons)] |  no  |  |
- | delete_account_consent | string |  no  |  |
- | session_config | string |  no  |  |
-
----
-
-
- 
- 
- #### [LookAndFeel](#LookAndFeel)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | card_position | string |  no  |  |
- | background_color | string |  no  |  |
-
----
-
-
- 
- 
- #### [Login](#Login)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | password | boolean |  no  |  |
- | otp | boolean |  no  |  |
-
----
-
-
- 
- 
- #### [MetaSchema](#MetaSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | fynd_default | boolean |  no  |  |
-
----
-
-
- 
- 
- #### [Social](#Social)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | account_kit | boolean |  no  |  |
- | facebook | boolean |  no  |  |
- | google | boolean |  no  |  |
- | apple | boolean |  no  |  |
-
----
-
-
- 
- 
- #### [RequiredFields](#RequiredFields)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | email | [PlatformEmail](#PlatformEmail) |  no  |  |
- | mobile | [PlatformMobile](#PlatformMobile) |  no  |  |
-
----
-
-
- 
- 
- #### [PlatformEmail](#PlatformEmail)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | is_required | boolean |  no  |  |
- | level | string |  no  |  |
-
----
-
-
- 
- 
- #### [PlatformMobile](#PlatformMobile)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | is_required | boolean |  no  |  |
- | level | string |  no  |  |
-
----
-
-
- 
- 
- #### [RegisterRequiredFields](#RegisterRequiredFields)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | email | [RegisterRequiredFieldsEmail](#RegisterRequiredFieldsEmail) |  no  |  |
- | mobile | [RegisterRequiredFieldsMobile](#RegisterRequiredFieldsMobile) |  no  |  |
-
----
-
-
- 
- 
- #### [RegisterRequiredFieldsEmail](#RegisterRequiredFieldsEmail)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | is_required | boolean |  no  |  |
- | level | string |  no  |  |
-
----
-
-
- 
- 
- #### [RegisterRequiredFieldsMobile](#RegisterRequiredFieldsMobile)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | is_required | boolean |  no  |  |
- | level | string |  no  |  |
-
----
-
-
- 
- 
- #### [FlashCard](#FlashCard)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | text | string |  no  |  |
- | text_color | string |  no  |  |
- | background_color | string |  no  |  |
-
----
-
-
- 
- 
- #### [SocialTokens](#SocialTokens)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | facebook | [Facebook](#Facebook) |  no  |  |
- | account_kit | [Accountkit](#Accountkit) |  no  |  |
- | google | [Google](#Google) |  no  |  |
-
----
-
-
- 
- 
- #### [DeleteAccountReasons](#DeleteAccountReasons)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | reason_text | string |  no  |  |
- | reason_id | string |  no  |  |
- | show_text_area | boolean |  no  |  |
-
----
-
-
- 
- 
- #### [DeleteAccountConsent](#DeleteAccountConsent)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | consent_text | string |  no  |  |
-
----
-
-
- 
- 
- #### [Facebook](#Facebook)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | app_id | string |  no  |  |
-
----
-
-
- 
- 
- #### [Accountkit](#Accountkit)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | app_id | string |  no  |  |
-
----
-
-
- 
- 
- #### [Google](#Google)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | app_id | string |  no  |  |
-
----
-
-
- 
- 
- #### [SessionExpiry](#SessionExpiry)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | duration | number |  no  |  |
- | type | string |  no  |  |
- | is_rolling | boolean |  no  |  |
-
----
-
-
- 
- 
- #### [UpdateUserRequestSchema](#UpdateUserRequestSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | first_name | string |  no  |  |
- | last_name | string |  no  |  |
- | gender | string |  no  |  |
- | external_id | string |  no  |  |
- | meta | string |  no  |  |
-
----
-
-
- 
- 
- #### [UserSchema](#UserSchema)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | application_id | string |  no  |  |
- | user_id | string |  no  |  |
- | first_name | string |  no  |  |
- | meta | string |  no  |  |
- | last_name | string |  no  |  |
- | phone_numbers | [[PhoneNumber](#PhoneNumber)] |  no  |  |
- | emails | [[Email](#Email)] |  no  |  |
- | gender | string |  no  |  |
- | dob | string |  no  |  |
- | active | boolean |  no  |  |
- | profile_pic_url | string |  no  |  |
- | username | string |  no  |  |
- | account_type | string |  no  |  |
- | _id | string |  no  |  |
- | created_at | string |  no  |  |
- | updated_at | string |  no  |  |
-
----
-
-
- 
- 
- #### [PhoneNumber](#PhoneNumber)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | active | boolean |  no  |  |
- | primary | boolean |  no  |  |
- | verified | boolean |  no  |  |
- | phone | string |  no  |  |
- | country_code | number |  no  |  |
-
----
-
-
- 
- 
- #### [Email](#Email)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | primary | boolean |  no  |  |
- | verified | boolean |  no  |  |
- | email | string |  no  |  |
- | active | boolean |  no  |  |
-
----
-
-
-
-