@shencom/api/src/typings/user.d.ts

shencom api group

declare namespace SC {
  export namespace User {
    type Sex = 0 | 1 | 2 | 3 | '未知' | '男' | '女' | '保密';
    interface RefreshToken {
      /** 过期时间(默认30天) */
      expiration: number;
      /** refreshToken */
      value: string;
    }

    export interface TokenRoot {
      /** token(默认8小时) */
      value: string;
      /** 过期时间 */
      expiration: number;
      /** refreshToken */
      refreshToken: RefreshToken;
    }

    export interface WxInfo {
      readonly id: string;
      readonly openid: string;

      /** 小程序 sessionKey */
      sessionKey?: string;
      /** 0:公众号2:小程序 */
      type: number;
      avatar?: string;
      nickname?: string;
      realname?: string;
      isBindWx?: boolean;
      sex?: Sex;
    }

    export interface SysInfo {
      readonly id: string;
      readonly uid: string;

      tokenid: string;
      phone: string;
      username: string;

      /** 真实姓名 */
      realname?: string;
      /** 昵称 */
      nickname?: string;
      /** 邮箱 */
      email?: string;
      sex?: Sex;
      /** 地址 */
      address?: string;
      /** 备注 */
      remark?: string;
      /** 用户个人图像 */
      avatar?: string;

      /** 身份证 */
      pid?: string;
      /** 身份证证件正面 */
      pidCardThumb1?: string;
      /** 身份证证件反面 */
      pidCardThumb2?: string;
    }

    export type UpdateSysInfo = Partial<Omit<SysInfo, 'id' | 'uid' | 'tokenid'>>;
    export type UpdateWxInfo = Partial<Pick<WxInfo, 'avatar' | 'nickname' | 'sex' | 'openid'>>;

    export type UpdateSysKey = keyof UpdateSysInfo;

    export interface RootInfo extends TokenRoot {
      additionalInformation: Info;
    }

    export type Info = WxInfo & SysInfo;
  }
}