@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

package/sdk/platform/User/UserPlatformModel.js

@@ -1,52 +1,811 @@
 const Joi = require("joi");
 
-class UserModel {
+/**
+ * @typedef Accountkit
+ * @property {string} [app_id]
+ */
+
+/**
+ * @typedef ArchiveUserRequestSchema
+ * @property {string} [user_id]
+ */
+
+/**
+ * @typedef ArchiveUserSuccess
+ * @property {boolean} [success]
+ */
+
+/**
+ * @typedef AuthenticationApiErrorSchema
+ * @property {string} [message]
+ */
+
+/**
+ * @typedef AuthenticationInternalServerErrorSchema
+ * @property {string} [message]
+ */
+
+/**
+ * @typedef AuthSuccess
+ * @property {string} [register_token]
+ * @property {UserSchema} [user]
+ * @property {boolean} [user_exists]
+ */
+
+/**
+ * @typedef AuthSuccessUser
+ * @property {boolean} [active]
+ * @property {AuthSuccessUserDebug} [debug]
+ * @property {AuthSuccessUserEmails} [emails]
+ * @property {string} [first_name]
+ * @property {string} [last_name]
+ */
+
+/**
+ * @typedef AuthSuccessUserDebug
+ * @property {string} [platform]
+ */
+
+/**
+ * @typedef AuthSuccessUserEmails
+ * @property {boolean} [active]
+ * @property {string} [email]
+ * @property {boolean} [primary]
+ * @property {boolean} [verified]
+ */
+
+/**
+ * @typedef BlockUserRequestSchema
+ * @property {string} [reason]
+ * @property {boolean} [status]
+ * @property {string[]} [user_id]
+ */
+
+/**
+ * @typedef BlockUserSuccess
+ * @property {boolean} [success]
+ */
+
+/**
+ * @typedef CodeRequestBodySchema
+ * @property {string} [code]
+ */
+
+/**
+ * @typedef CreateUserGroupSchema
+ * @property {string} description
+ * @property {string} file_url
+ * @property {string} name
+ */
+
+/**
+ * @typedef CreateUserRequestSchema
+ * @property {string} [email]
+ * @property {string} [first_name]
+ * @property {string} [gender]
+ * @property {string} [last_name]
+ * @property {Object} [meta]
+ * @property {string} phone_number
+ * @property {string} username
+ */
+
+/**
+ * @typedef CreateUserResponseSchema
+ * @property {UserSchema} [user]
+ */
+
+/**
+ * @typedef CreateUserSessionRequestSchema
+ * @property {string} [domain]
+ * @property {number} [max_age]
+ * @property {string} [user_id]
+ */
+
+/**
+ * @typedef CreateUserSessionResponseSchema
+ * @property {Object} [cookie]
+ * @property {string} [domain]
+ * @property {boolean} [http_only]
+ * @property {number} [max_age]
+ * @property {boolean} [secure]
+ */
+
+/**
+ * @typedef CustomerListResponseSchema
+ * @property {UserSchema[]} [items]
+ * @property {PaginationSchema} [page]
+ */
+
+/**
+ * @typedef DeleteAccountConsent
+ * @property {string} [consent_text]
+ */
+
+/**
+ * @typedef DeleteAccountReasons
+ * @property {string} [reason_id]
+ * @property {string} [reason_text]
+ * @property {boolean} [show_text_area]
+ */
+
+/**
+ * @typedef DeleteApplicationUserRequestSchema
+ * @property {string} [otp]
+ * @property {string} [reason]
+ * @property {string} [reason_id]
+ * @property {string} [request_id]
+ * @property {string} [user_id]
+ */
+
+/**
+ * @typedef DeleteUserSuccess
+ * @property {boolean} [success]
+ */
+
+/**
+ * @typedef EditEmailRequestSchema
+ * @property {string} [email]
+ */
+
+/**
+ * @typedef EditMobileRequestSchema
+ * @property {string} [country_code]
+ * @property {string} [phone]
+ */
+
+/**
+ * @typedef EditProfileMobileSchema
+ * @property {string} [country_code]
+ * @property {string} [phone]
+ */
+
+/**
+ * @typedef EditProfileRequestSchema
+ * @property {string} [android_hash]
+ * @property {string} [country_code]
+ * @property {string} [dob]
+ * @property {string} [email]
+ * @property {string} [first_name]
+ * @property {string} [gender]
+ * @property {string} [last_name]
+ * @property {EditProfileMobileSchema} [mobile]
+ * @property {string} [profile_pic_url]
+ * @property {string} [register_token]
+ * @property {string} [sender]
+ */
+
+/**
+ * @typedef Email
+ * @property {boolean} [active]
+ * @property {string} [email]
+ * @property {boolean} [primary]
+ * @property {boolean} [verified]
+ */
+
+/**
+ * @typedef EmailOtpSuccess
+ * @property {boolean} [success]
+ */
+
+/**
+ * @typedef Facebook
+ * @property {string} [app_id]
+ */
+
+/**
+ * @typedef FlashCard
+ * @property {string} [background_color]
+ * @property {string} [text]
+ * @property {string} [text_color]
+ */
+
+/**
+ * @typedef ForgotPasswordRequestSchema
+ * @property {string} [code]
+ * @property {string} [password]
+ */
+
+/**
+ * @typedef FormRegisterRequestSchema
+ * @property {string} [email]
+ * @property {string} [first_name]
+ * @property {string} [gender]
+ * @property {string} [last_name]
+ * @property {string} [password]
+ * @property {FormRegisterRequestSchemaPhone} [phone]
+ * @property {string} [register_token]
+ */
+
+/**
+ * @typedef FormRegisterRequestSchemaPhone
+ * @property {string} [country_code]
+ * @property {string} [mobile]
+ */
+
+/**
+ * @typedef Google
+ * @property {string} [app_id]
+ */
+
+/**
+ * @typedef HasPasswordSuccess
+ * @property {boolean} [result]
+ */
+
+/**
+ * @typedef Login
+ * @property {boolean} [otp]
+ * @property {boolean} [password]
+ */
+
+/**
+ * @typedef LoginSuccess
+ * @property {string} [register_token]
+ * @property {string} [request_id]
+ * @property {UserSchema} [user]
+ */
+
+/**
+ * @typedef LogoutSuccess
+ * @property {boolean} [logout]
+ */
+
+/**
+ * @typedef LookAndFeel
+ * @property {string} [background_color]
+ * @property {string} [card_position]
+ */
+
+/**
+ * @typedef MetaSchema
+ * @property {boolean} [fynd_default]
+ */
+
+/**
+ * @typedef NotFoundSchema
+ * @property {string} [message]
+ */
+
+/**
+ * @typedef OAuthRequestAppleSchema
+ * @property {OAuthRequestAppleSchemaOauth} [oauth]
+ * @property {OAuthRequestAppleSchemaProfile} [profile]
+ * @property {string} [user_identifier]
+ */
+
+/**
+ * @typedef OAuthRequestAppleSchemaOauth
+ * @property {string} [identity_token]
+ */
+
+/**
+ * @typedef OAuthRequestAppleSchemaProfile
+ * @property {string} [first_name]
+ * @property {string} [full_name]
+ * @property {string} [last_name]
+ */
+
+/**
+ * @typedef OAuthRequestSchema
+ * @property {boolean} [is_signed_in]
+ * @property {OAuthRequestSchemaOauth2} [oauth2]
+ * @property {OAuthRequestSchemaProfile} [profile]
+ */
+
+/**
+ * @typedef OAuthRequestSchemaOauth2
+ * @property {string} [access_token]
+ * @property {number} [expiry]
+ * @property {string} [refresh_token]
+ */
+
+/**
+ * @typedef OAuthRequestSchemaProfile
+ * @property {string} [email]
+ * @property {string} [first_name]
+ * @property {string} [full_name]
+ * @property {string} [id]
+ * @property {string} [image]
+ * @property {string} [last_name]
+ */
+
+/**
+ * @typedef OtpSuccess
+ * @property {string} [country_code]
+ * @property {string} [message]
+ * @property {string} [mobile]
+ * @property {string} [register_token]
+ * @property {string} [request_id]
+ * @property {number} [resend_timer]
+ * @property {string} [resend_token]
+ * @property {boolean} [success]
+ */
+
+/**
+ * @typedef PaginationSchema
+ * @property {number} [current]
+ * @property {boolean} [has_next]
+ * @property {number} [item_total]
+ * @property {number} [size]
+ * @property {string} [type]
+ */
+
+/**
+ * @typedef PasswordLoginRequestSchema
+ * @property {string} [captcha_code]
+ * @property {string} [password]
+ * @property {string} [username]
+ */
+
+/**
+ * @typedef PhoneNumber
+ * @property {boolean} [active]
+ * @property {number} [country_code]
+ * @property {string} [phone]
+ * @property {boolean} [primary]
+ * @property {boolean} [verified]
+ */
+
+/**
+ * @typedef PlatformEmail
+ * @property {boolean} [is_required]
+ * @property {string} [level]
+ */
+
+/**
+ * @typedef PlatformMobile
+ * @property {boolean} [is_required]
+ * @property {string} [level]
+ */
+
+/**
+ * @typedef PlatformSchema
+ * @property {string} [_id]
+ * @property {boolean} [active]
+ * @property {string} [created_at]
+ * @property {Object} [delete_account_consent]
+ * @property {number} [delete_account_day]
+ * @property {DeleteAccountReasons[]} [delete_account_reasons]
+ * @property {string} [desktop_image]
+ * @property {string} [display]
+ * @property {FlashCard} [flash_card]
+ * @property {boolean} [forgot_password]
+ * @property {Login} [login]
+ * @property {LookAndFeel} [look_and_feel]
+ * @property {MetaSchema} [meta]
+ * @property {string} [mobile_image]
+ * @property {string} [name]
+ * @property {boolean} [register]
+ * @property {RegisterRequiredFields} [register_required_fields]
+ * @property {RequiredFields} [required_fields]
+ * @property {Object} [session_config]
+ * @property {boolean} [skip_captcha]
+ * @property {boolean} [skip_login]
+ * @property {Social} [social]
+ * @property {SocialTokens} [social_tokens]
+ * @property {string} [subtext]
+ * @property {string} [updated_at]
+ */
+
+/**
+ * @typedef ProfileEditSuccess
+ * @property {string} [country_code]
+ * @property {string} [email]
+ * @property {string} [message]
+ * @property {string} [mobile]
+ * @property {string} [register_token]
+ * @property {string} [request_id]
+ * @property {string} [resend_email_token]
+ * @property {number} [resend_timer]
+ * @property {string} [resend_token]
+ * @property {boolean} [success]
+ * @property {UserSchema} [user]
+ * @property {boolean} [user_exists]
+ * @property {boolean} [verify_email_link]
+ * @property {boolean} [verify_email_otp]
+ * @property {boolean} [verify_mobile_otp]
+ */
+
+/**
+ * @typedef ProfileEditSuccessSchema
+ * @property {string} [email]
+ * @property {string} [register_token]
+ * @property {string} [user]
+ * @property {boolean} [user_exists]
+ * @property {boolean} [verify_email_link]
+ * @property {boolean} [verify_email_otp]
+ * @property {boolean} [verify_mobile_otp]
+ */
+
+/**
+ * @typedef RegisterFormSuccess
+ * @property {string} [country_code]
+ * @property {string} [email]
+ * @property {string} [message]
+ * @property {string} [mobile]
+ * @property {string} [register_token]
+ * @property {string} [request_id]
+ * @property {string} [resend_email_token]
+ * @property {number} [resend_timer]
+ * @property {string} [resend_token]
+ * @property {boolean} [success]
+ * @property {boolean} [user_exists]
+ * @property {boolean} [verify_email_otp]
+ * @property {boolean} [verify_mobile_otp]
+ */
+
+/**
+ * @typedef RegisterRequiredFields
+ * @property {RegisterRequiredFieldsEmail} [email]
+ * @property {RegisterRequiredFieldsMobile} [mobile]
+ */
+
+/**
+ * @typedef RegisterRequiredFieldsEmail
+ * @property {boolean} [is_required]
+ * @property {string} [level]
+ */
+
+/**
+ * @typedef RegisterRequiredFieldsMobile
+ * @property {boolean} [is_required]
+ * @property {string} [level]
+ */
+
+/**
+ * @typedef RequiredFields
+ * @property {PlatformEmail} [email]
+ * @property {PlatformMobile} [mobile]
+ */
+
+/**
+ * @typedef ResetPasswordSuccess
+ * @property {string} [status]
+ */
+
+/**
+ * @typedef SendEmailOtpRequestSchema
+ * @property {string} [action]
+ * @property {string} [email]
+ * @property {string} [register_token]
+ * @property {string} [token]
+ */
+
+/**
+ * @typedef SendEmailVerifyLinkSuccess
+ * @property {boolean} [verify_email_link]
+ */
+
+/**
+ * @typedef SendMobileOtpRequestSchema
+ * @property {string} [action]
+ * @property {string} [android_hash]
+ * @property {string} [captcha_code]
+ * @property {string} [country_code]
+ * @property {string} [force]
+ * @property {string} [mobile]
+ * @property {string} [token]
+ */
+
+/**
+ * @typedef SendMobileVerifyLinkSuccess
+ * @property {boolean} [verify_mobile_link]
+ */
+
+/**
+ * @typedef SendOtpRequestSchema
+ * @property {string} [android_hash]
+ * @property {string} [captcha_code]
+ * @property {string} [country_code]
+ * @property {string} [mobile]
+ */
+
+/**
+ * @typedef SendOtpResponse
+ * @property {string} [country_code]
+ * @property {string} [email]
+ * @property {string} [message]
+ * @property {string} [mobile]
+ * @property {string} [register_token]
+ * @property {string} [request_id]
+ * @property {string} [resend_email_token]
+ * @property {number} [resend_timer]
+ * @property {string} [resend_token]
+ * @property {boolean} [success]
+ * @property {boolean} [user_exists]
+ * @property {boolean} [verify_email_otp]
+ * @property {boolean} [verify_mobile_otp]
+ */
+
+/**
+ * @typedef SendResetPasswordEmailRequestSchema
+ * @property {string} [captcha_code]
+ * @property {string} [email]
+ */
+
+/**
+ * @typedef SendResetPasswordMobileRequestSchema
+ * @property {string} [captcha_code]
+ * @property {string} [country_code]
+ * @property {string} [mobile]
+ */
+
+/**
+ * @typedef SendVerificationLinkMobileRequestSchema
+ * @property {boolean} [active]
+ * @property {string} [country_code]
+ * @property {string} [phone]
+ * @property {boolean} [primary]
+ * @property {boolean} [verified]
+ */
+
+/**
+ * @typedef SessionDeleteResponseSchema
+ * @property {string[]} [items]
+ */
+
+/**
+ * @typedef SessionExpiry
+ * @property {number} [duration]
+ * @property {boolean} [is_rolling]
+ * @property {string} [type]
+ */
+
+/**
+ * @typedef SessionListResponseInfo
+ * @property {string} [domain]
+ * @property {string} [expire_in]
+ * @property {string} [ip]
+ * @property {string} [session_id]
+ * @property {string} [user_agent]
+ */
+
+/**
+ * @typedef SessionListResponseSchema
+ * @property {SessionListResponseInfo[]} [items]
+ */
+
+/**
+ * @typedef SessionListSuccess
+ * @property {string[]} [sessions]
+ */
+
+/**
+ * @typedef Social
+ * @property {boolean} [account_kit]
+ * @property {boolean} [apple]
+ * @property {boolean} [facebook]
+ * @property {boolean} [google]
+ */
+
+/**
+ * @typedef SocialTokens
+ * @property {Accountkit} [account_kit]
+ * @property {Facebook} [facebook]
+ * @property {Google} [google]
+ */
+
+/**
+ * @typedef TokenRequestBodySchema
+ * @property {string} [token]
+ */
+
+/**
+ * @typedef UnauthenticatedSchema
+ * @property {boolean} [authenticated]
+ */
+
+/**
+ * @typedef UnauthorizedSchema
+ * @property {string} [message]
+ */
+
+/**
+ * @typedef UnDeleteUserRequestSchema
+ * @property {string} [reason]
+ * @property {string} [reason_id]
+ * @property {string} [user_id]
+ */
+
+/**
+ * @typedef UnDeleteUserSuccess
+ * @property {boolean} [success]
+ */
+
+/**
+ * @typedef UpdatePasswordRequestSchema
+ * @property {string} [new_password]
+ * @property {string} [old_password]
+ */
+
+/**
+ * @typedef UpdateUserGroupSchema
+ * @property {string} [description]
+ * @property {string} [file_url]
+ * @property {string} [name]
+ */
+
+/**
+ * @typedef UpdateUserRequestSchema
+ * @property {UserEmails[]} [emails]
+ * @property {string} [external_id]
+ * @property {string} [first_name]
+ * @property {string} [gender]
+ * @property {string} [last_name]
+ * @property {Object} [meta]
+ * @property {UserPhoneNumbers[]} [phone_numbers]
+ */
+
+/**
+ * @typedef UserEmails
+ * @property {boolean} [active]
+ * @property {string} [email]
+ * @property {boolean} [primary]
+ * @property {boolean} [verified]
+ */
+
+/**
+ * @typedef UserGroupListResponseSchema
+ * @property {UserGroupResponseSchema[]} [items]
+ * @property {PaginationSchema} [page]
+ */
+
+/**
+ * @typedef UserGroupResponseSchema
+ * @property {number} [__v]
+ * @property {string} [_id]
+ * @property {string} [application_id]
+ * @property {string} [created_at]
+ * @property {string} [description]
+ * @property {string} [file_url]
+ * @property {string} [modified_at]
+ * @property {string} [name]
+ * @property {string} [status]
+ * @property {number} [uid]
+ */
+
+/**
+ * @typedef UserObjectSchema
+ * @property {UserSchema} [user]
+ */
+
+/**
+ * @typedef UserPhoneNumbers
+ * @property {boolean} [active]
+ * @property {string} [country_code]
+ * @property {string} [phone]
+ * @property {boolean} [primary]
+ * @property {boolean} [verified]
+ */
+
+/**
+ * @typedef UserSchema
+ * @property {string} [_id]
+ * @property {string} [account_type]
+ * @property {boolean} [active]
+ * @property {string} [application_id]
+ * @property {string} [created_at]
+ * @property {string} [dob]
+ * @property {Email[]} [emails]
+ * @property {string} [first_name]
+ * @property {string} [gender]
+ * @property {string} [last_name]
+ * @property {Object} [meta]
+ * @property {PhoneNumber[]} [phone_numbers]
+ * @property {string} [profile_pic_url]
+ * @property {string} [updated_at]
+ * @property {string} [user_id]
+ * @property {string} [username]
+ */
+
+/**
+ * @typedef UserSearchResponseSchema
+ * @property {UserSchema[]} [users]
+ */
+
+/**
+ * @typedef VerifyEmailOtpRequestSchema
+ * @property {string} [action]
+ * @property {string} [email]
+ * @property {string} [otp]
+ * @property {string} [register_token]
+ */
+
+/**
+ * @typedef VerifyEmailOTPSuccess
+ * @property {UserSchema} [user]
+ * @property {boolean} [verify_email_link]
+ */
+
+/**
+ * @typedef VerifyEmailSuccess
+ * @property {string} [message]
+ */
+
+/**
+ * @typedef VerifyMobileOTPSuccess
+ * @property {UserSchema} [user]
+ * @property {boolean} [verify_mobile_link]
+ */
+
+/**
+ * @typedef VerifyOtpRequestSchema
+ * @property {string} [otp]
+ * @property {string} [register_token]
+ * @property {string} [request_id]
+ */
+
+/**
+ * @typedef VerifyOtpSuccess
+ * @property {string} [register_token]
+ * @property {UserSchema} [user]
+ * @property {boolean} [user_exists]
+ */
+
+class UserPlatformModel {
+  /** @returns {Accountkit} */
   static Accountkit() {
     return Joi.object({
       app_id: Joi.string().allow(""),
     });
   }
+
+  /** @returns {ArchiveUserRequestSchema} */
   static ArchiveUserRequestSchema() {
     return Joi.object({
       user_id: Joi.string().allow(""),
     });
   }
+
+  /** @returns {ArchiveUserSuccess} */
   static ArchiveUserSuccess() {
     return Joi.object({
       success: Joi.boolean(),
     });
   }
+
+  /** @returns {AuthenticationApiErrorSchema} */
   static AuthenticationApiErrorSchema() {
     return Joi.object({
       message: Joi.string().allow(""),
     });
   }
+
+  /** @returns {AuthenticationInternalServerErrorSchema} */
   static AuthenticationInternalServerErrorSchema() {
     return Joi.object({
       message: Joi.string().allow(""),
     });
   }
+
+  /** @returns {AuthSuccess} */
   static AuthSuccess() {
     return Joi.object({
       register_token: Joi.string().allow(""),
-      user: UserModel.UserSchema(),
+      user: UserPlatformModel.UserSchema(),
       user_exists: Joi.boolean(),
     });
   }
+
+  /** @returns {AuthSuccessUser} */
   static AuthSuccessUser() {
     return Joi.object({
       active: Joi.boolean(),
-      debug: UserModel.AuthSuccessUserDebug(),
-      emails: UserModel.AuthSuccessUserEmails(),
+      debug: UserPlatformModel.AuthSuccessUserDebug(),
+      emails: UserPlatformModel.AuthSuccessUserEmails(),
       first_name: Joi.string().allow(""),
       last_name: Joi.string().allow(""),
     });
   }
+
+  /** @returns {AuthSuccessUserDebug} */
   static AuthSuccessUserDebug() {
     return Joi.object({
       platform: Joi.string().allow(""),
     });
   }
+
+  /** @returns {AuthSuccessUserEmails} */
   static AuthSuccessUserEmails() {
     return Joi.object({
       active: Joi.boolean(),
@@ -55,6 +814,8 @@ class UserModel {
       verified: Joi.boolean(),
     });
   }
+
+  /** @returns {BlockUserRequestSchema} */
   static BlockUserRequestSchema() {
     return Joi.object({
       reason: Joi.string().allow(""),
@@ -62,16 +823,22 @@ class UserModel {
       user_id: Joi.array().items(Joi.string().allow("")),
     });
   }
+
+  /** @returns {BlockUserSuccess} */
   static BlockUserSuccess() {
     return Joi.object({
       success: Joi.boolean(),
     });
   }
+
+  /** @returns {CodeRequestBodySchema} */
   static CodeRequestBodySchema() {
     return Joi.object({
       code: Joi.string().allow(""),
     });
   }
+
+  /** @returns {CreateUserGroupSchema} */
   static CreateUserGroupSchema() {
     return Joi.object({
       description: Joi.string().allow("").required(),
@@ -79,6 +846,8 @@ class UserModel {
       name: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {CreateUserRequestSchema} */
   static CreateUserRequestSchema() {
     return Joi.object({
       email: Joi.string().allow(""),
@@ -90,11 +859,15 @@ class UserModel {
       username: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {CreateUserResponseSchema} */
   static CreateUserResponseSchema() {
     return Joi.object({
-      user: UserModel.UserSchema(),
+      user: UserPlatformModel.UserSchema(),
     });
   }
+
+  /** @returns {CreateUserSessionRequestSchema} */
   static CreateUserSessionRequestSchema() {
     return Joi.object({
       domain: Joi.string().allow(""),
@@ -102,6 +875,8 @@ class UserModel {
       user_id: Joi.string().allow(""),
     });
   }
+
+  /** @returns {CreateUserSessionResponseSchema} */
   static CreateUserSessionResponseSchema() {
     return Joi.object({
       cookie: Joi.any(),
@@ -111,17 +886,23 @@ class UserModel {
       secure: Joi.boolean(),
     });
   }
+
+  /** @returns {CustomerListResponseSchema} */
   static CustomerListResponseSchema() {
     return Joi.object({
-      items: Joi.array().items(UserModel.UserSchema()),
-      page: UserModel.PaginationSchema(),
+      items: Joi.array().items(UserPlatformModel.UserSchema()),
+      page: UserPlatformModel.PaginationSchema(),
     });
   }
+
+  /** @returns {DeleteAccountConsent} */
   static DeleteAccountConsent() {
     return Joi.object({
       consent_text: Joi.string().allow(""),
     });
   }
+
+  /** @returns {DeleteAccountReasons} */
   static DeleteAccountReasons() {
     return Joi.object({
       reason_id: Joi.string().allow(""),
@@ -129,6 +910,8 @@ class UserModel {
       show_text_area: Joi.boolean(),
     });
   }
+
+  /** @returns {DeleteApplicationUserRequestSchema} */
   static DeleteApplicationUserRequestSchema() {
     return Joi.object({
       otp: Joi.string().allow(""),
@@ -138,28 +921,38 @@ class UserModel {
       user_id: Joi.string().allow(""),
     });
   }
+
+  /** @returns {DeleteUserSuccess} */
   static DeleteUserSuccess() {
     return Joi.object({
       success: Joi.boolean(),
     });
   }
+
+  /** @returns {EditEmailRequestSchema} */
   static EditEmailRequestSchema() {
     return Joi.object({
       email: Joi.string().allow(""),
     });
   }
+
+  /** @returns {EditMobileRequestSchema} */
   static EditMobileRequestSchema() {
     return Joi.object({
       country_code: Joi.string().allow(""),
       phone: Joi.string().allow(""),
     });
   }
+
+  /** @returns {EditProfileMobileSchema} */
   static EditProfileMobileSchema() {
     return Joi.object({
       country_code: Joi.string().allow(""),
       phone: Joi.string().allow(""),
     });
   }
+
+  /** @returns {EditProfileRequestSchema} */
   static EditProfileRequestSchema() {
     return Joi.object({
       android_hash: Joi.string().allow(""),
@@ -169,12 +962,14 @@ class UserModel {
       first_name: Joi.string().allow(""),
       gender: Joi.string().allow(""),
       last_name: Joi.string().allow(""),
-      mobile: UserModel.EditProfileMobileSchema(),
+      mobile: UserPlatformModel.EditProfileMobileSchema(),
       profile_pic_url: Joi.string().allow(""),
       register_token: Joi.string().allow(""),
       sender: Joi.string().allow(""),
     });
   }
+
+  /** @returns {Email} */
   static Email() {
     return Joi.object({
       active: Joi.boolean(),
@@ -183,16 +978,22 @@ class UserModel {
       verified: Joi.boolean(),
     });
   }
+
+  /** @returns {EmailOtpSuccess} */
   static EmailOtpSuccess() {
     return Joi.object({
       success: Joi.boolean(),
     });
   }
+
+  /** @returns {Facebook} */
   static Facebook() {
     return Joi.object({
       app_id: Joi.string().allow(""),
     });
   }
+
+  /** @returns {FlashCard} */
   static FlashCard() {
     return Joi.object({
       background_color: Joi.string().allow(""),
@@ -200,12 +1001,16 @@ class UserModel {
       text_color: Joi.string().allow(""),
     });
   }
+
+  /** @returns {ForgotPasswordRequestSchema} */
   static ForgotPasswordRequestSchema() {
     return Joi.object({
       code: Joi.string().allow(""),
       password: Joi.string().allow(""),
     });
   }
+
+  /** @returns {FormRegisterRequestSchema} */
   static FormRegisterRequestSchema() {
     return Joi.object({
       email: Joi.string().allow(""),
@@ -213,72 +1018,96 @@ class UserModel {
       gender: Joi.string().allow(""),
       last_name: Joi.string().allow(""),
       password: Joi.string().allow(""),
-      phone: UserModel.FormRegisterRequestSchemaPhone(),
+      phone: UserPlatformModel.FormRegisterRequestSchemaPhone(),
       register_token: Joi.string().allow(""),
     });
   }
+
+  /** @returns {FormRegisterRequestSchemaPhone} */
   static FormRegisterRequestSchemaPhone() {
     return Joi.object({
       country_code: Joi.string().allow(""),
       mobile: Joi.string().allow(""),
     });
   }
+
+  /** @returns {Google} */
   static Google() {
     return Joi.object({
       app_id: Joi.string().allow(""),
     });
   }
+
+  /** @returns {HasPasswordSuccess} */
   static HasPasswordSuccess() {
     return Joi.object({
       result: Joi.boolean(),
     });
   }
+
+  /** @returns {Login} */
   static Login() {
     return Joi.object({
       otp: Joi.boolean(),
       password: Joi.boolean(),
     });
   }
+
+  /** @returns {LoginSuccess} */
   static LoginSuccess() {
     return Joi.object({
       register_token: Joi.string().allow(""),
       request_id: Joi.string().allow(""),
-      user: UserModel.UserSchema(),
+      user: UserPlatformModel.UserSchema(),
     });
   }
+
+  /** @returns {LogoutSuccess} */
   static LogoutSuccess() {
     return Joi.object({
       logout: Joi.boolean(),
     });
   }
+
+  /** @returns {LookAndFeel} */
   static LookAndFeel() {
     return Joi.object({
       background_color: Joi.string().allow(""),
       card_position: Joi.string().allow(""),
     });
   }
+
+  /** @returns {MetaSchema} */
   static MetaSchema() {
     return Joi.object({
       fynd_default: Joi.boolean(),
     });
   }
+
+  /** @returns {NotFoundSchema} */
   static NotFoundSchema() {
     return Joi.object({
       message: Joi.string().allow(""),
     });
   }
+
+  /** @returns {OAuthRequestAppleSchema} */
   static OAuthRequestAppleSchema() {
     return Joi.object({
-      oauth: UserModel.OAuthRequestAppleSchemaOauth(),
-      profile: UserModel.OAuthRequestAppleSchemaProfile(),
+      oauth: UserPlatformModel.OAuthRequestAppleSchemaOauth(),
+      profile: UserPlatformModel.OAuthRequestAppleSchemaProfile(),
       user_identifier: Joi.string().allow(""),
     });
   }
+
+  /** @returns {OAuthRequestAppleSchemaOauth} */
   static OAuthRequestAppleSchemaOauth() {
     return Joi.object({
       identity_token: Joi.string().allow(""),
     });
   }
+
+  /** @returns {OAuthRequestAppleSchemaProfile} */
   static OAuthRequestAppleSchemaProfile() {
     return Joi.object({
       first_name: Joi.string().allow(""),
@@ -286,13 +1115,17 @@ class UserModel {
       last_name: Joi.string().allow(""),
     });
   }
+
+  /** @returns {OAuthRequestSchema} */
   static OAuthRequestSchema() {
     return Joi.object({
       is_signed_in: Joi.boolean(),
-      oauth2: UserModel.OAuthRequestSchemaOauth2(),
-      profile: UserModel.OAuthRequestSchemaProfile(),
+      oauth2: UserPlatformModel.OAuthRequestSchemaOauth2(),
+      profile: UserPlatformModel.OAuthRequestSchemaProfile(),
     });
   }
+
+  /** @returns {OAuthRequestSchemaOauth2} */
   static OAuthRequestSchemaOauth2() {
     return Joi.object({
       access_token: Joi.string().allow(""),
@@ -300,6 +1133,8 @@ class UserModel {
       refresh_token: Joi.string().allow(""),
     });
   }
+
+  /** @returns {OAuthRequestSchemaProfile} */
   static OAuthRequestSchemaProfile() {
     return Joi.object({
       email: Joi.string().allow(""),
@@ -310,6 +1145,8 @@ class UserModel {
       last_name: Joi.string().allow(""),
     });
   }
+
+  /** @returns {OtpSuccess} */
   static OtpSuccess() {
     return Joi.object({
       country_code: Joi.string().allow(""),
@@ -322,6 +1159,8 @@ class UserModel {
       success: Joi.boolean(),
     });
   }
+
+  /** @returns {PaginationSchema} */
   static PaginationSchema() {
     return Joi.object({
       current: Joi.number(),
@@ -331,6 +1170,8 @@ class UserModel {
       type: Joi.string().allow(""),
     });
   }
+
+  /** @returns {PasswordLoginRequestSchema} */
   static PasswordLoginRequestSchema() {
     return Joi.object({
       captcha_code: Joi.string().allow(""),
@@ -338,6 +1179,8 @@ class UserModel {
       username: Joi.string().allow(""),
     });
   }
+
+  /** @returns {PhoneNumber} */
   static PhoneNumber() {
     return Joi.object({
       active: Joi.boolean(),
@@ -347,18 +1190,24 @@ class UserModel {
       verified: Joi.boolean(),
     });
   }
+
+  /** @returns {PlatformEmail} */
   static PlatformEmail() {
     return Joi.object({
       is_required: Joi.boolean(),
       level: Joi.string().allow(""),
     });
   }
+
+  /** @returns {PlatformMobile} */
   static PlatformMobile() {
     return Joi.object({
       is_required: Joi.boolean(),
       level: Joi.string().allow(""),
     });
   }
+
+  /** @returns {PlatformSchema} */
   static PlatformSchema() {
     return Joi.object({
       _id: Joi.string().allow(""),
@@ -367,29 +1216,31 @@ class UserModel {
       delete_account_consent: Joi.any(),
       delete_account_day: Joi.number(),
       delete_account_reasons: Joi.array().items(
-        UserModel.DeleteAccountReasons()
+        UserPlatformModel.DeleteAccountReasons()
       ),
       desktop_image: Joi.string().allow(""),
       display: Joi.string().allow(""),
-      flash_card: UserModel.FlashCard(),
+      flash_card: UserPlatformModel.FlashCard(),
       forgot_password: Joi.boolean(),
-      login: UserModel.Login(),
-      look_and_feel: UserModel.LookAndFeel(),
-      meta: UserModel.MetaSchema(),
+      login: UserPlatformModel.Login(),
+      look_and_feel: UserPlatformModel.LookAndFeel(),
+      meta: UserPlatformModel.MetaSchema(),
       mobile_image: Joi.string().allow(""),
       name: Joi.string().allow(""),
       register: Joi.boolean(),
-      register_required_fields: UserModel.RegisterRequiredFields(),
-      required_fields: UserModel.RequiredFields(),
+      register_required_fields: UserPlatformModel.RegisterRequiredFields(),
+      required_fields: UserPlatformModel.RequiredFields(),
       session_config: Joi.any(),
       skip_captcha: Joi.boolean(),
       skip_login: Joi.boolean(),
-      social: UserModel.Social(),
-      social_tokens: UserModel.SocialTokens(),
+      social: UserPlatformModel.Social(),
+      social_tokens: UserPlatformModel.SocialTokens(),
       subtext: Joi.string().allow(""),
       updated_at: Joi.string().allow(""),
     });
   }
+
+  /** @returns {ProfileEditSuccess} */
   static ProfileEditSuccess() {
     return Joi.object({
       country_code: Joi.string().allow(""),
@@ -402,13 +1253,15 @@ class UserModel {
       resend_timer: Joi.number(),
       resend_token: Joi.string().allow(""),
       success: Joi.boolean(),
-      user: UserModel.UserSchema(),
+      user: UserPlatformModel.UserSchema(),
       user_exists: Joi.boolean(),
       verify_email_link: Joi.boolean(),
       verify_email_otp: Joi.boolean(),
       verify_mobile_otp: Joi.boolean(),
     });
   }
+
+  /** @returns {ProfileEditSuccessSchema} */
   static ProfileEditSuccessSchema() {
     return Joi.object({
       email: Joi.string().allow(""),
@@ -420,6 +1273,8 @@ class UserModel {
       verify_mobile_otp: Joi.boolean(),
     });
   }
+
+  /** @returns {RegisterFormSuccess} */
   static RegisterFormSuccess() {
     return Joi.object({
       country_code: Joi.string().allow(""),
@@ -437,35 +1292,47 @@ class UserModel {
       verify_mobile_otp: Joi.boolean(),
     });
   }
+
+  /** @returns {RegisterRequiredFields} */
   static RegisterRequiredFields() {
     return Joi.object({
-      email: UserModel.RegisterRequiredFieldsEmail(),
-      mobile: UserModel.RegisterRequiredFieldsMobile(),
+      email: UserPlatformModel.RegisterRequiredFieldsEmail(),
+      mobile: UserPlatformModel.RegisterRequiredFieldsMobile(),
     });
   }
+
+  /** @returns {RegisterRequiredFieldsEmail} */
   static RegisterRequiredFieldsEmail() {
     return Joi.object({
       is_required: Joi.boolean(),
       level: Joi.string().allow(""),
     });
   }
+
+  /** @returns {RegisterRequiredFieldsMobile} */
   static RegisterRequiredFieldsMobile() {
     return Joi.object({
       is_required: Joi.boolean(),
       level: Joi.string().allow(""),
     });
   }
+
+  /** @returns {RequiredFields} */
   static RequiredFields() {
     return Joi.object({
-      email: UserModel.PlatformEmail(),
-      mobile: UserModel.PlatformMobile(),
+      email: UserPlatformModel.PlatformEmail(),
+      mobile: UserPlatformModel.PlatformMobile(),
     });
   }
+
+  /** @returns {ResetPasswordSuccess} */
   static ResetPasswordSuccess() {
     return Joi.object({
       status: Joi.string().allow(""),
     });
   }
+
+  /** @returns {SendEmailOtpRequestSchema} */
   static SendEmailOtpRequestSchema() {
     return Joi.object({
       action: Joi.string().allow(""),
@@ -474,11 +1341,15 @@ class UserModel {
       token: Joi.string().allow(""),
     });
   }
+
+  /** @returns {SendEmailVerifyLinkSuccess} */
   static SendEmailVerifyLinkSuccess() {
     return Joi.object({
       verify_email_link: Joi.boolean(),
     });
   }
+
+  /** @returns {SendMobileOtpRequestSchema} */
   static SendMobileOtpRequestSchema() {
     return Joi.object({
       action: Joi.string().allow(""),
@@ -490,11 +1361,15 @@ class UserModel {
       token: Joi.string().allow(""),
     });
   }
+
+  /** @returns {SendMobileVerifyLinkSuccess} */
   static SendMobileVerifyLinkSuccess() {
     return Joi.object({
       verify_mobile_link: Joi.boolean(),
     });
   }
+
+  /** @returns {SendOtpRequestSchema} */
   static SendOtpRequestSchema() {
     return Joi.object({
       android_hash: Joi.string().allow(""),
@@ -503,6 +1378,8 @@ class UserModel {
       mobile: Joi.string().allow(""),
     });
   }
+
+  /** @returns {SendOtpResponse} */
   static SendOtpResponse() {
     return Joi.object({
       country_code: Joi.string().allow(""),
@@ -520,12 +1397,16 @@ class UserModel {
       verify_mobile_otp: Joi.boolean(),
     });
   }
+
+  /** @returns {SendResetPasswordEmailRequestSchema} */
   static SendResetPasswordEmailRequestSchema() {
     return Joi.object({
       captcha_code: Joi.string().allow(""),
       email: Joi.string().allow(""),
     });
   }
+
+  /** @returns {SendResetPasswordMobileRequestSchema} */
   static SendResetPasswordMobileRequestSchema() {
     return Joi.object({
       captcha_code: Joi.string().allow(""),
@@ -533,6 +1414,8 @@ class UserModel {
       mobile: Joi.string().allow(""),
     });
   }
+
+  /** @returns {SendVerificationLinkMobileRequestSchema} */
   static SendVerificationLinkMobileRequestSchema() {
     return Joi.object({
       active: Joi.boolean(),
@@ -542,11 +1425,15 @@ class UserModel {
       verified: Joi.boolean(),
     });
   }
+
+  /** @returns {SessionDeleteResponseSchema} */
   static SessionDeleteResponseSchema() {
     return Joi.object({
       items: Joi.array().items(Joi.string().allow("")),
     });
   }
+
+  /** @returns {SessionExpiry} */
   static SessionExpiry() {
     return Joi.object({
       duration: Joi.number(),
@@ -554,6 +1441,8 @@ class UserModel {
       type: Joi.string().allow(""),
     });
   }
+
+  /** @returns {SessionListResponseInfo} */
   static SessionListResponseInfo() {
     return Joi.object({
       domain: Joi.string().allow(""),
@@ -563,16 +1452,22 @@ class UserModel {
       user_agent: Joi.string().allow(""),
     });
   }
+
+  /** @returns {SessionListResponseSchema} */
   static SessionListResponseSchema() {
     return Joi.object({
-      items: Joi.array().items(UserModel.SessionListResponseInfo()),
+      items: Joi.array().items(UserPlatformModel.SessionListResponseInfo()),
     });
   }
+
+  /** @returns {SessionListSuccess} */
   static SessionListSuccess() {
     return Joi.object({
       sessions: Joi.array().items(Joi.string().allow("")),
     });
   }
+
+  /** @returns {Social} */
   static Social() {
     return Joi.object({
       account_kit: Joi.boolean(),
@@ -581,28 +1476,38 @@ class UserModel {
       google: Joi.boolean(),
     });
   }
+
+  /** @returns {SocialTokens} */
   static SocialTokens() {
     return Joi.object({
-      account_kit: UserModel.Accountkit(),
-      facebook: UserModel.Facebook(),
-      google: UserModel.Google(),
+      account_kit: UserPlatformModel.Accountkit(),
+      facebook: UserPlatformModel.Facebook(),
+      google: UserPlatformModel.Google(),
     });
   }
+
+  /** @returns {TokenRequestBodySchema} */
   static TokenRequestBodySchema() {
     return Joi.object({
       token: Joi.string().allow(""),
     });
   }
+
+  /** @returns {UnauthenticatedSchema} */
   static UnauthenticatedSchema() {
     return Joi.object({
       authenticated: Joi.boolean(),
     });
   }
+
+  /** @returns {UnauthorizedSchema} */
   static UnauthorizedSchema() {
     return Joi.object({
       message: Joi.string().allow(""),
     });
   }
+
+  /** @returns {UnDeleteUserRequestSchema} */
   static UnDeleteUserRequestSchema() {
     return Joi.object({
       reason: Joi.string().allow(""),
@@ -610,17 +1515,23 @@ class UserModel {
       user_id: Joi.string().allow(""),
     });
   }
+
+  /** @returns {UnDeleteUserSuccess} */
   static UnDeleteUserSuccess() {
     return Joi.object({
       success: Joi.boolean(),
     });
   }
+
+  /** @returns {UpdatePasswordRequestSchema} */
   static UpdatePasswordRequestSchema() {
     return Joi.object({
       new_password: Joi.string().allow(""),
       old_password: Joi.string().allow(""),
     });
   }
+
+  /** @returns {UpdateUserGroupSchema} */
   static UpdateUserGroupSchema() {
     return Joi.object({
       description: Joi.string().allow(""),
@@ -628,17 +1539,21 @@ class UserModel {
       name: Joi.string().allow(""),
     });
   }
+
+  /** @returns {UpdateUserRequestSchema} */
   static UpdateUserRequestSchema() {
     return Joi.object({
-      emails: Joi.array().items(UserModel.UserEmails()),
+      emails: Joi.array().items(UserPlatformModel.UserEmails()),
       external_id: Joi.string().allow(""),
       first_name: Joi.string().allow(""),
       gender: Joi.string().allow(""),
       last_name: Joi.string().allow(""),
       meta: Joi.any(),
-      phone_numbers: Joi.array().items(UserModel.UserPhoneNumbers()),
+      phone_numbers: Joi.array().items(UserPlatformModel.UserPhoneNumbers()),
     });
   }
+
+  /** @returns {UserEmails} */
   static UserEmails() {
     return Joi.object({
       active: Joi.boolean(),
@@ -647,12 +1562,16 @@ class UserModel {
       verified: Joi.boolean(),
     });
   }
+
+  /** @returns {UserGroupListResponseSchema} */
   static UserGroupListResponseSchema() {
     return Joi.object({
-      items: Joi.array().items(UserModel.UserGroupResponseSchema()),
-      page: UserModel.PaginationSchema(),
+      items: Joi.array().items(UserPlatformModel.UserGroupResponseSchema()),
+      page: UserPlatformModel.PaginationSchema(),
     });
   }
+
+  /** @returns {UserGroupResponseSchema} */
   static UserGroupResponseSchema() {
     return Joi.object({
       __v: Joi.number(),
@@ -667,11 +1586,15 @@ class UserModel {
       uid: Joi.number(),
     });
   }
+
+  /** @returns {UserObjectSchema} */
   static UserObjectSchema() {
     return Joi.object({
-      user: UserModel.UserSchema(),
+      user: UserPlatformModel.UserSchema(),
     });
   }
+
+  /** @returns {UserPhoneNumbers} */
   static UserPhoneNumbers() {
     return Joi.object({
       active: Joi.boolean(),
@@ -681,6 +1604,8 @@ class UserModel {
       verified: Joi.boolean(),
     });
   }
+
+  /** @returns {UserSchema} */
   static UserSchema() {
     return Joi.object({
       _id: Joi.string().allow(""),
@@ -689,23 +1614,27 @@ class UserModel {
       application_id: Joi.string().allow(""),
       created_at: Joi.string().allow(""),
       dob: Joi.string().allow(""),
-      emails: Joi.array().items(UserModel.Email()),
+      emails: Joi.array().items(UserPlatformModel.Email()),
       first_name: Joi.string().allow(""),
       gender: Joi.string().allow(""),
       last_name: Joi.string().allow(""),
       meta: Joi.any(),
-      phone_numbers: Joi.array().items(UserModel.PhoneNumber()),
+      phone_numbers: Joi.array().items(UserPlatformModel.PhoneNumber()),
       profile_pic_url: Joi.string().allow(""),
       updated_at: Joi.string().allow(""),
       user_id: Joi.string().allow(""),
       username: Joi.string().allow(""),
     });
   }
+
+  /** @returns {UserSearchResponseSchema} */
   static UserSearchResponseSchema() {
     return Joi.object({
-      users: Joi.array().items(UserModel.UserSchema()),
+      users: Joi.array().items(UserPlatformModel.UserSchema()),
     });
   }
+
+  /** @returns {VerifyEmailOtpRequestSchema} */
   static VerifyEmailOtpRequestSchema() {
     return Joi.object({
       action: Joi.string().allow(""),
@@ -714,23 +1643,31 @@ class UserModel {
       register_token: Joi.string().allow(""),
     });
   }
+
+  /** @returns {VerifyEmailOTPSuccess} */
   static VerifyEmailOTPSuccess() {
     return Joi.object({
-      user: UserModel.UserSchema(),
+      user: UserPlatformModel.UserSchema(),
       verify_email_link: Joi.boolean(),
     });
   }
+
+  /** @returns {VerifyEmailSuccess} */
   static VerifyEmailSuccess() {
     return Joi.object({
       message: Joi.string().allow(""),
     });
   }
+
+  /** @returns {VerifyMobileOTPSuccess} */
   static VerifyMobileOTPSuccess() {
     return Joi.object({
-      user: UserModel.UserSchema(),
+      user: UserPlatformModel.UserSchema(),
       verify_mobile_link: Joi.boolean(),
     });
   }
+
+  /** @returns {VerifyOtpRequestSchema} */
   static VerifyOtpRequestSchema() {
     return Joi.object({
       otp: Joi.string().allow(""),
@@ -738,12 +1675,14 @@ class UserModel {
       request_id: Joi.string().allow(""),
     });
   }
+
+  /** @returns {VerifyOtpSuccess} */
   static VerifyOtpSuccess() {
     return Joi.object({
       register_token: Joi.string().allow(""),
-      user: UserModel.UserSchema(),
+      user: UserPlatformModel.UserSchema(),
       user_exists: Joi.boolean(),
     });
   }
 }
-module.exports = UserModel;
+module.exports = UserPlatformModel;