@jctrans-materials/shared 1.0.21 → 1.0.22

package/dist/api/auth.d.ts

@@ -1,42 +1,143 @@
 import { ApiResponse, IResponse, LoginDataParams, LoginResponseData, ThirdResponseData } from './type';
+/**
+ * 验证账号是否存在 /auth/validateAccountExist
+ * @param data
+ * @returns
+ */
 export declare function validateAccountExistApi(data: {
     target: string;
 }): Promise<any>;
+/**
+ * 发送邮箱验证码
+ * @param data
+ * @returns
+ */
 export declare function sendEmailCodeApi(data: {
     target: string;
     countryId?: number;
     account?: string;
     uuid?: string;
 }): Promise<any>;
+/**
+ * 发送手机验证码
+ * @param data
+ * @returns
+ */
 export declare function sendMobileCodeApi(data: {
     target: string;
     countryId?: number;
     account?: string;
     uuid?: string;
 }): Promise<any>;
-export declare function checkEmailCodeApi(data: any): Promise<any>;
-export declare function checkMobileCodeApi(data: any): Promise<any>;
+/**
+ * 验证邮件验证码
+ * @param data
+ * @returns
+ */
+export declare function checkEmailCodeApi(data: {
+    uuid: string;
+    code: string;
+    target: string;
+}): Promise<any>;
+/**
+ * 验证手机验证码
+ * @param data
+ * @returns
+ */
+export declare function checkMobileCodeApi(data: {
+    code: string;
+    uuid: string;
+    target: string;
+}): Promise<any>;
+/**
+ * 校验注册公司是否重名
+ * @param data
+ * @returns
+ */
 export declare function validateCompanyApi(data: {
     countryId: number;
     cityId: number;
     compNameCn?: string;
     compNameEn?: string;
 }): Promise<any>;
+/**
+ * 用户注册加入公司
+ * @param data
+ * @returns
+ */
 export declare function registerJoinCompanyApi(data: any): Promise<any>;
+/**
+ * 第三方应用注册加入公司
+ * @param data
+ * @returns
+ */
 export declare function registerJoinCompByThirdPartyApi(data: any): Promise<any>;
+/**
+ * 获取用户加入公司信息
+ * @param data
+ * @returns
+ */
 export declare function getJoinCompanyApi(data: any): Promise<any>;
+/**
+ * 跳转其他站
+ * @param appId
+ * @param path
+ * @returns
+ */
 export declare function getRedirectPathApi(appId: string, path: string): Promise<any>;
+/**
+ * 国际站峰会注册
+ * @param data
+ * @returns
+ */
 export declare function registerApi(data: any): Promise<any>;
+/**
+ * 微信二维码登录注册用户公司
+ * @param data
+ * @returns
+ */
 export declare function registerUserCompBindWechatApi(data: any): Promise<any>;
+/**
+ * 微信二维码登录用户注册加入公司 🍉
+ * @param data
+ * @returns
+ */
 export declare function registerJoinCompanyBindWechatApi(data: any): Promise<any>;
+/**
+ * 微信二维码登录绑定用户(账号密码)
+ * @param data
+ * @returns
+ */
+export declare function loginPwdBindWechatApi(data: any): Promise<any>;
+/**
+ * 微信二维码登录绑定用户(验证码)
+ * @param data
+ * @returns
+ */
+export declare function loginCodeBindWechatApi(data: any): Promise<any>;
 export declare function loginApi(loginData: LoginDataParams): Promise<IResponse<ApiResponse<LoginResponseData>>>;
+/**
+ * 验证码登录注册
+ * @param data
+ * @returns
+ */
 export declare function loginByEmailOrMobileCodeApi(data: any): Promise<IResponse<ApiResponse<LoginResponseData>>>;
+/**
+ * 微信二维码登录(1s轮询)
+ * @param data
+ * @returns
+ */
 export declare function loginByQrCode(data: {
     uniqueCode: string;
     appId: string;
     redirectPath: string;
     kick: boolean;
 }): Promise<any>;
+/**
+ * 获取登录微信二维码
+ * @param data
+ * @returns
+ */
 export declare function getLoginQrCode(data?: {}): Promise<any>;
 /**
  * 1-1-2.TGC自动登录
@@ -61,11 +162,26 @@ export declare function completeCompRedirectApi(data: any): Promise<any>;
  */
 export declare function completeJoinCompanyRedirectApi(data: any): Promise<any>;
 export declare function checkAccountExistsFPApi(data: any): Promise<any>;
+/**
+ * 忘记密码发送验证码
+ * @param data
+ * @returns
+ */
 export declare function getMEVCodeApi(data: any): Promise<any>;
 export declare function resetPasswordApi(data: any): Promise<any>;
 export declare function loginByFacebookApi(data: any): Promise<IResponse<ApiResponse<ThirdResponseData>>>;
 export declare function loginByLinkedinApi(data: any): Promise<IResponse<ApiResponse<ThirdResponseData>>>;
+/**
+ * 验证密码绑定第三方应用
+ * @param data
+ * @returns
+ */
 export declare function bindThirdPartyByPwdApi(data: any): Promise<any>;
+/**
+ * 验证验证码绑定第三方应用
+ * @param data
+ * @returns
+ */
 export declare function bindThirdPartyByCodeApi(data: any): Promise<any>;
 export declare function registerByThirdPartyApi(data: any): Promise<any>;
 export declare function findListByMobileEmailApi(data: any): Promise<any>;
@@ -75,6 +191,10 @@ export declare function findListByMobileEmailApi(data: any): Promise<any>;
  * @returns
  */
 export declare function inviteJoinGetCompApi(data: any): Promise<any>;
+/**
+ * 全局设置 session
+ * @param data
+ */
 export declare function setAuthSessionItems(data: {
     activityCode?: string | null;
     referenceUserId?: string | null;
@@ -86,7 +206,14 @@ export declare function setAuthSessionItems(data: {
     registerType?: string | null;
     compKey?: string | null;
 }): void;
+/**
+ * 重置 session
+ */
 export declare function resetAuthSessionItems(): void;
+/**
+ * 全局获取 session
+ * @returns
+ */
 export declare function getAuthSessionItems(): {
     activityCode: string | null;
     referenceUserId: string | null;