/** * 登录方式 * * @param XYAccount - 小鱼账号登录 * @param ExtUserId - 三方用户id登录 * @param ExtToken - authCode登录 */ export declare enum LoginType { XYAccount = 0, ExtUserId = 1, ExtToken = 2 } /** * 三方用户统一认证登录 - 小鱼账号登录参数 * * @param { string } account - 必填,用户账号 * @param { string } password - 必填,用户密码 * @param { string? } countryCode - 可选,国家码:默认+86 * @param { string? } extId - 必填,企业ID */ export interface LoginXYAccountParams { account: string; password: string; countryCode?: string; extId?: string; } /** * 三方用户统一认证登录 - 用户ID参数 * * @param { string } extUserId - 必填,三方用户ID * @param { string } authCode - 登录码 * @param { string } displayName - 用户名称 * @param { boolean? } tempUser - 是否临时用户 * @param { string? } extId - 企业ID */ export interface LoginExtUserIdParams { extUserId: string; authCode: string; displayName: string; tempUser?: boolean; extId?: string; } /** * 三方用户统一认证登录 - token登录 * * @param { string } authCode - 必填,登录码 * @param { string? } extId - 必填,企业ID */ export interface LoginExtTokenParams { authCode: string; extId?: string; } interface LoginParamsTemp extends LoginXYAccountParams, LoginExtUserIdParams, LoginExtTokenParams { } /** * 三方用户统一认证登录 参数 */ export type LoginParams = Partial; /** * 第三方登录用户信息/授权码登录信息 * * @property { string } displayName - 必填,用户名称 * @property { string } extId - 必填,企业id * @property { string } extUserId - 可选,三方用户ID * @property { string } authCode - 可选,授权码 * @property { boolean } tempUser - 可选,临时账号,默认是false,不是临时用户 */ export interface ILoginExtAccount { displayName: string; extId?: string; extUserId?: string; authCode?: string; tempUser?: boolean; } /** * 第三方登录sdk用户信息,由sdk server创建 * * @property { string } userName sdk用户名 * @property { string } password sdk密码 * @property { string? } extId sdk企业Id */ export interface ISdkUserInfo { userName: string; password: string; extId?: string; } /** * 三方账号统一认证登录-授权码登录信息 * * @property { string } extId 0 - 必填,企业id * @property { string } extUserId - 必填,用户id * @property { string } displayName - 必填,用户名 * @property { string } oauthCode - 必填,授权码 * @property { string } channelId - 必填,渠道id * @property { boolean? } isTempUser - 可选,是否是临时账号 */ export interface ILoginWidthAuthCode { extId: string; extUserId: string; displayName: string; oauthCode: string; channelId: string; isTempUser?: boolean; } /** * 三方账号统一认证登录-单点登录 * * @property { string } token - 单点登录Token信息 * @property { string } thirdPlatform - 三方平台名 * @property { string } path - 单点登录接口地址,可选参数 */ export interface LoginThirdAuthTokenParams { token: string; thirdPlatform: string; path?: string; } /** * 手机验证码登录 * * @property { string } account - 必填,用户账号 * @property { string } verificationCode - 必填,验证码 */ export interface LoginVerifyCodeParams { account: string; verificationCode: string; } /** * 新用户注册并登录 * * @property { string } loginIdentifier - 必填,手机号 * @property { string } verificationCode - 必填,验证码 * @property { string } deviceDisplayName - 必填,用户名 */ export interface RegisterAndLoginParams { loginIdentifier: string; verificationCode: string; deviceDisplayName?: string; } export {};