@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

package/sdk/application/User/UserApplicationValidator.d.ts

@@ -1,38 +1,462 @@
-export = UserValidator;
-declare class UserValidator {
-    static addEmail(): any;
-    static addMobileNumber(): any;
-    static deleteEmail(): any;
-    static deleteMobileNumber(): any;
-    static deleteUser(): any;
-    static forgotPassword(): any;
+export = UserApplicationValidator;
+/**
+ * @typedef AddEmailParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.EditEmailRequestSchema} body
+ */
+/**
+ * @typedef AddMobileNumberParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.EditMobileRequestSchema} body
+ */
+/**
+ * @typedef DeleteEmailParam
+ * @property {string} [platform] - ID of the application
+ * @property {boolean} active - This is a boolean value to check if email ID is
+ *   active 1. True - Email ID is active 2.False - Email ID is inactive
+ * @property {boolean} primary - 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
+ * @property {boolean} verified - 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
+ * @property {string} email - The email ID to delete
+ */
+/**
+ * @typedef DeleteMobileNumberParam
+ * @property {string} [platform] - ID of the application
+ * @property {boolean} active - This is a boolean value to check if mobile
+ *   number is active 1.True - Number is active 2. False - Number is inactive
+ * @property {boolean} primary - 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
+ * @property {boolean} verified - This is a boolean value to check if mobile
+ *   number is verified 1. True - Number is verified 2.False - Number is not verified yet
+ * @property {string} countryCode - Country code of the phone number, e.g. 91
+ * @property {string} phone - Phone number
+ */
+/**
+ * @typedef DeleteUserParam
+ * @property {UserApplicationModel.DeleteApplicationUserRequestSchema} body
+ */
+/**
+ * @typedef ForgotPasswordParam
+ * @property {UserApplicationModel.ForgotPasswordRequestSchema} body
+ */
+/** @typedef GetListOfActiveSessionsParam */
+/** @typedef GetLoggedInUserParam */
+/**
+ * @typedef GetPlatformConfigParam
+ * @property {string} [name] - Name of the application, e.g. Fynd
+ */
+/** @typedef HasPasswordParam */
+/**
+ * @typedef LoginWithAppleIOSParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.OAuthRequestAppleSchema} body
+ */
+/**
+ * @typedef LoginWithEmailAndPasswordParam
+ * @property {UserApplicationModel.PasswordLoginRequestSchema} body
+ */
+/**
+ * @typedef LoginWithFacebookParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.OAuthRequestSchema} body
+ */
+/**
+ * @typedef LoginWithGoogleParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.OAuthRequestSchema} body
+ */
+/**
+ * @typedef LoginWithGoogleAndroidParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.OAuthRequestSchema} body
+ */
+/**
+ * @typedef LoginWithGoogleIOSParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.OAuthRequestSchema} body
+ */
+/**
+ * @typedef LoginWithOTPParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.SendOtpRequestSchema} body
+ */
+/**
+ * @typedef LoginWithTokenParam
+ * @property {UserApplicationModel.TokenRequestBodySchema} body
+ */
+/** @typedef LogoutParam */
+/**
+ * @typedef RegisterWithFormParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.FormRegisterRequestSchema} body
+ */
+/**
+ * @typedef SendOTPOnEmailParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.SendEmailOtpRequestSchema} body
+ */
+/**
+ * @typedef SendOTPOnMobileParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.SendMobileOtpRequestSchema} body
+ */
+/**
+ * @typedef SendResetPasswordEmailParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.SendResetPasswordEmailRequestSchema} body
+ */
+/**
+ * @typedef SendResetPasswordMobileParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.SendResetPasswordMobileRequestSchema} body
+ */
+/**
+ * @typedef SendResetTokenParam
+ * @property {UserApplicationModel.CodeRequestBodySchema} body
+ */
+/**
+ * @typedef SendVerificationLinkToEmailParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.EditEmailRequestSchema} body
+ */
+/**
+ * @typedef SendVerificationLinkToMobileParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.SendVerificationLinkMobileRequestSchema} body
+ */
+/**
+ * @typedef SetEmailAsPrimaryParam
+ * @property {UserApplicationModel.EditEmailRequestSchema} body
+ */
+/**
+ * @typedef SetMobileNumberAsPrimaryParam
+ * @property {UserApplicationModel.SendVerificationLinkMobileRequestSchema} body
+ */
+/**
+ * @typedef UpdatePasswordParam
+ * @property {UserApplicationModel.UpdatePasswordRequestSchema} body
+ */
+/**
+ * @typedef UpdateProfileParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.EditProfileRequestSchema} body
+ */
+/**
+ * @typedef VerifyEmailParam
+ * @property {UserApplicationModel.CodeRequestBodySchema} body
+ */
+/**
+ * @typedef VerifyEmailOTPParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.VerifyEmailOtpRequestSchema} body
+ */
+/**
+ * @typedef VerifyMobileParam
+ * @property {UserApplicationModel.CodeRequestBodySchema} body
+ */
+/**
+ * @typedef VerifyMobileOTPParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.VerifyOtpRequestSchema} body
+ */
+declare class UserApplicationValidator {
+    /** @returns {AddEmailParam} */
+    static addEmail(): AddEmailParam;
+    /** @returns {AddMobileNumberParam} */
+    static addMobileNumber(): AddMobileNumberParam;
+    /** @returns {DeleteEmailParam} */
+    static deleteEmail(): DeleteEmailParam;
+    /** @returns {DeleteMobileNumberParam} */
+    static deleteMobileNumber(): DeleteMobileNumberParam;
+    /** @returns {DeleteUserParam} */
+    static deleteUser(): DeleteUserParam;
+    /** @returns {ForgotPasswordParam} */
+    static forgotPassword(): ForgotPasswordParam;
+    /** @returns {GetListOfActiveSessionsParam} */
     static getListOfActiveSessions(): any;
+    /** @returns {GetLoggedInUserParam} */
     static getLoggedInUser(): any;
-    static getPlatformConfig(): any;
+    /** @returns {GetPlatformConfigParam} */
+    static getPlatformConfig(): GetPlatformConfigParam;
+    /** @returns {HasPasswordParam} */
     static hasPassword(): any;
-    static loginWithAppleIOS(): any;
-    static loginWithEmailAndPassword(): any;
-    static loginWithFacebook(): any;
-    static loginWithGoogle(): any;
-    static loginWithGoogleAndroid(): any;
-    static loginWithGoogleIOS(): any;
-    static loginWithOTP(): any;
-    static loginWithToken(): any;
+    /** @returns {LoginWithAppleIOSParam} */
+    static loginWithAppleIOS(): LoginWithAppleIOSParam;
+    /** @returns {LoginWithEmailAndPasswordParam} */
+    static loginWithEmailAndPassword(): LoginWithEmailAndPasswordParam;
+    /** @returns {LoginWithFacebookParam} */
+    static loginWithFacebook(): LoginWithFacebookParam;
+    /** @returns {LoginWithGoogleParam} */
+    static loginWithGoogle(): LoginWithGoogleParam;
+    /** @returns {LoginWithGoogleAndroidParam} */
+    static loginWithGoogleAndroid(): LoginWithGoogleAndroidParam;
+    /** @returns {LoginWithGoogleIOSParam} */
+    static loginWithGoogleIOS(): LoginWithGoogleIOSParam;
+    /** @returns {LoginWithOTPParam} */
+    static loginWithOTP(): LoginWithOTPParam;
+    /** @returns {LoginWithTokenParam} */
+    static loginWithToken(): LoginWithTokenParam;
+    /** @returns {LogoutParam} */
     static logout(): any;
-    static registerWithForm(): any;
-    static sendOTPOnEmail(): any;
-    static sendOTPOnMobile(): any;
-    static sendResetPasswordEmail(): any;
-    static sendResetPasswordMobile(): any;
-    static sendResetToken(): any;
-    static sendVerificationLinkToEmail(): any;
-    static sendVerificationLinkToMobile(): any;
-    static setEmailAsPrimary(): any;
-    static setMobileNumberAsPrimary(): any;
-    static updatePassword(): any;
-    static updateProfile(): any;
-    static verifyEmail(): any;
-    static verifyEmailOTP(): any;
-    static verifyMobile(): any;
-    static verifyMobileOTP(): any;
+    /** @returns {RegisterWithFormParam} */
+    static registerWithForm(): RegisterWithFormParam;
+    /** @returns {SendOTPOnEmailParam} */
+    static sendOTPOnEmail(): SendOTPOnEmailParam;
+    /** @returns {SendOTPOnMobileParam} */
+    static sendOTPOnMobile(): SendOTPOnMobileParam;
+    /** @returns {SendResetPasswordEmailParam} */
+    static sendResetPasswordEmail(): SendResetPasswordEmailParam;
+    /** @returns {SendResetPasswordMobileParam} */
+    static sendResetPasswordMobile(): SendResetPasswordMobileParam;
+    /** @returns {SendResetTokenParam} */
+    static sendResetToken(): SendResetTokenParam;
+    /** @returns {SendVerificationLinkToEmailParam} */
+    static sendVerificationLinkToEmail(): SendVerificationLinkToEmailParam;
+    /** @returns {SendVerificationLinkToMobileParam} */
+    static sendVerificationLinkToMobile(): SendVerificationLinkToMobileParam;
+    /** @returns {SetEmailAsPrimaryParam} */
+    static setEmailAsPrimary(): SetEmailAsPrimaryParam;
+    /** @returns {SetMobileNumberAsPrimaryParam} */
+    static setMobileNumberAsPrimary(): SetMobileNumberAsPrimaryParam;
+    /** @returns {UpdatePasswordParam} */
+    static updatePassword(): UpdatePasswordParam;
+    /** @returns {UpdateProfileParam} */
+    static updateProfile(): UpdateProfileParam;
+    /** @returns {VerifyEmailParam} */
+    static verifyEmail(): VerifyEmailParam;
+    /** @returns {VerifyEmailOTPParam} */
+    static verifyEmailOTP(): VerifyEmailOTPParam;
+    /** @returns {VerifyMobileParam} */
+    static verifyMobile(): VerifyMobileParam;
+    /** @returns {VerifyMobileOTPParam} */
+    static verifyMobileOTP(): VerifyMobileOTPParam;
 }
+declare namespace UserApplicationValidator {
+    export { AddEmailParam, AddMobileNumberParam, DeleteEmailParam, DeleteMobileNumberParam, DeleteUserParam, ForgotPasswordParam, GetListOfActiveSessionsParam, GetLoggedInUserParam, GetPlatformConfigParam, HasPasswordParam, LoginWithAppleIOSParam, LoginWithEmailAndPasswordParam, LoginWithFacebookParam, LoginWithGoogleParam, LoginWithGoogleAndroidParam, LoginWithGoogleIOSParam, LoginWithOTPParam, LoginWithTokenParam, LogoutParam, RegisterWithFormParam, SendOTPOnEmailParam, SendOTPOnMobileParam, SendResetPasswordEmailParam, SendResetPasswordMobileParam, SendResetTokenParam, SendVerificationLinkToEmailParam, SendVerificationLinkToMobileParam, SetEmailAsPrimaryParam, SetMobileNumberAsPrimaryParam, UpdatePasswordParam, UpdateProfileParam, VerifyEmailParam, VerifyEmailOTPParam, VerifyMobileParam, VerifyMobileOTPParam };
+}
+type AddEmailParam = {
+    /**
+     * - ID of the application
+     */
+    platform?: string;
+    body: UserApplicationModel.EditEmailRequestSchema;
+};
+type AddMobileNumberParam = {
+    /**
+     * - ID of the application
+     */
+    platform?: string;
+    body: UserApplicationModel.EditMobileRequestSchema;
+};
+type DeleteEmailParam = {
+    /**
+     * - ID of the application
+     */
+    platform?: string;
+    /**
+     * - This is a boolean value to check if email ID is
+     * active 1. True - Email ID is active 2.False - Email ID is inactive
+     */
+    active: boolean;
+    /**
+     * - 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
+     */
+    primary: boolean;
+    /**
+     * - 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
+     */
+    verified: boolean;
+    /**
+     * - The email ID to delete
+     */
+    email: string;
+};
+type DeleteMobileNumberParam = {
+    /**
+     * - ID of the application
+     */
+    platform?: string;
+    /**
+     * - This is a boolean value to check if mobile
+     * number is active 1.True - Number is active 2. False - Number is inactive
+     */
+    active: boolean;
+    /**
+     * - 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
+     */
+    primary: boolean;
+    /**
+     * - This is a boolean value to check if mobile
+     * number is verified 1. True - Number is verified 2.False - Number is not verified yet
+     */
+    verified: boolean;
+    /**
+     * - Country code of the phone number, e.g. 91
+     */
+    countryCode: string;
+    /**
+     * - Phone number
+     */
+    phone: string;
+};
+type DeleteUserParam = {
+    body: UserApplicationModel.DeleteApplicationUserRequestSchema;
+};
+type ForgotPasswordParam = {
+    body: UserApplicationModel.ForgotPasswordRequestSchema;
+};
+type GetPlatformConfigParam = {
+    /**
+     * - Name of the application, e.g. Fynd
+     */
+    name?: string;
+};
+type LoginWithAppleIOSParam = {
+    /**
+     * - ID of the application
+     */
+    platform?: string;
+    body: UserApplicationModel.OAuthRequestAppleSchema;
+};
+type LoginWithEmailAndPasswordParam = {
+    body: UserApplicationModel.PasswordLoginRequestSchema;
+};
+type LoginWithFacebookParam = {
+    /**
+     * - ID of the application
+     */
+    platform?: string;
+    body: UserApplicationModel.OAuthRequestSchema;
+};
+type LoginWithGoogleParam = {
+    /**
+     * - ID of the application
+     */
+    platform?: string;
+    body: UserApplicationModel.OAuthRequestSchema;
+};
+type LoginWithGoogleAndroidParam = {
+    /**
+     * - ID of the application
+     */
+    platform?: string;
+    body: UserApplicationModel.OAuthRequestSchema;
+};
+type LoginWithGoogleIOSParam = {
+    /**
+     * - ID of the application
+     */
+    platform?: string;
+    body: UserApplicationModel.OAuthRequestSchema;
+};
+type LoginWithOTPParam = {
+    /**
+     * - ID of the application
+     */
+    platform?: string;
+    body: UserApplicationModel.SendOtpRequestSchema;
+};
+type LoginWithTokenParam = {
+    body: UserApplicationModel.TokenRequestBodySchema;
+};
+type RegisterWithFormParam = {
+    /**
+     * - ID of the application
+     */
+    platform?: string;
+    body: UserApplicationModel.FormRegisterRequestSchema;
+};
+type SendOTPOnEmailParam = {
+    /**
+     * - ID of the application
+     */
+    platform?: string;
+    body: UserApplicationModel.SendEmailOtpRequestSchema;
+};
+type SendOTPOnMobileParam = {
+    /**
+     * - ID of the application
+     */
+    platform?: string;
+    body: UserApplicationModel.SendMobileOtpRequestSchema;
+};
+type SendResetPasswordEmailParam = {
+    /**
+     * - ID of the application
+     */
+    platform?: string;
+    body: UserApplicationModel.SendResetPasswordEmailRequestSchema;
+};
+type SendResetPasswordMobileParam = {
+    /**
+     * - ID of the application
+     */
+    platform?: string;
+    body: UserApplicationModel.SendResetPasswordMobileRequestSchema;
+};
+type SendResetTokenParam = {
+    body: UserApplicationModel.CodeRequestBodySchema;
+};
+type SendVerificationLinkToEmailParam = {
+    /**
+     * - ID of the application
+     */
+    platform?: string;
+    body: UserApplicationModel.EditEmailRequestSchema;
+};
+type SendVerificationLinkToMobileParam = {
+    /**
+     * - ID of the application
+     */
+    platform?: string;
+    body: UserApplicationModel.SendVerificationLinkMobileRequestSchema;
+};
+type SetEmailAsPrimaryParam = {
+    body: UserApplicationModel.EditEmailRequestSchema;
+};
+type SetMobileNumberAsPrimaryParam = {
+    body: UserApplicationModel.SendVerificationLinkMobileRequestSchema;
+};
+type UpdatePasswordParam = {
+    body: UserApplicationModel.UpdatePasswordRequestSchema;
+};
+type UpdateProfileParam = {
+    /**
+     * - ID of the application
+     */
+    platform?: string;
+    body: UserApplicationModel.EditProfileRequestSchema;
+};
+type VerifyEmailParam = {
+    body: UserApplicationModel.CodeRequestBodySchema;
+};
+type VerifyEmailOTPParam = {
+    /**
+     * - ID of the application
+     */
+    platform?: string;
+    body: UserApplicationModel.VerifyEmailOtpRequestSchema;
+};
+type VerifyMobileParam = {
+    body: UserApplicationModel.CodeRequestBodySchema;
+};
+type VerifyMobileOTPParam = {
+    /**
+     * - ID of the application
+     */
+    platform?: string;
+    body: UserApplicationModel.VerifyOtpRequestSchema;
+};
+type GetListOfActiveSessionsParam = any;
+type GetLoggedInUserParam = any;
+type HasPasswordParam = any;
+type LogoutParam = any;
+import UserApplicationModel = require("./UserApplicationModel");