fishpi 0.0.21 → 0.0.23

package/lib/typing.d.ts

@@ -0,0 +1,2073 @@
+/**
+ * Api 响应
+ */
+export interface ApiResponse<T> {
+    /**
+     * 请求状态
+     */
+    code?: number;
+    /**
+     * 请求状态
+     */
+    result?: number;
+    /**
+     * 请求信息
+     */
+    msg?: string;
+    /**
+     * 请求数据
+     */
+    data?: T;
+}
+/**
+ * ApiKey 响应
+ */
+export interface ApiKey {
+    /**
+     * 请求状态
+     */
+    code: number;
+    /**
+     * 消息
+     */
+    msg: string;
+    /**
+     * Api Key
+     */
+    Key: string;
+}
+/**
+ * 数据类型
+ */
+export declare enum DataType {
+    /**
+     * 文章
+     */
+    article = 0,
+    /**
+     * 评论
+     */
+    comment = 1,
+    /**
+     * @
+     */
+    at = 2,
+    /**
+     * 被评论
+     */
+    commented = 3,
+    /**
+     * 关注者
+     */
+    followingUser = 4,
+    /**
+     * 积分 - 充值
+     */
+    pointCharge = 5,
+    /**
+     * 积分 - 转账
+     */
+    pointTransfer = 6,
+    /**
+     * 积分 - 文章打赏
+     */
+    pointArticleReward = 7,
+    /**
+     * 积分 - 评论感谢
+     */
+    pointCommentThank = 8,
+    /**
+     * 同城广播
+     */
+    broadcast = 9,
+    /**
+     * 积分 - 交易
+     */
+    pointExchange = 10,
+    /**
+     * 积分 - 滥用扣除
+     */
+    abusePointDeduct = 11,
+    /**
+     * 积分 - 文章被感谢
+     */
+    pointArticleThank = 12,
+    /**
+     * 回复
+     */
+    reply = 13,
+    /**
+     * 使用邀请码
+     */
+    invitecodeUsed = 14,
+    /**
+     * 系统公告 - 文章
+     */
+    sysAnnounceArticle = 15,
+    /**
+     * 系统公告 - 新用户
+     */
+    sysAnnounceNewUser = 16,
+    /**
+     * 新的关注者
+     */
+    newFollower = 17,
+    /**
+     * 邀请链接
+     */
+    invitationLinkUsed = 18,
+    /**
+     * 系统通知 - 角色变化
+     */
+    sysAnnounceRoleChanged = 19,
+    /**
+     * 关注的文章更新
+     */
+    followingArticleUpdate = 20,
+    /**
+     * 关注的文章评论
+     */
+    followingArticleComment = 21,
+    /**
+     * 积分 - 文章优选
+     */
+    pointPerfectArticle = 22,
+    /**
+     * 文章新的被关注者
+     */
+    articleNewFollower = 23,
+    /**
+     * 文章新的关注者
+     */
+    articleNewWatcher = 24,
+    /**
+     * 评论点赞
+     */
+    commentVoteUp = 25,
+    /**
+     * 评论点踩
+     */
+    commentVoteDown = 26,
+    /**
+     * 文章被点赞
+     */
+    articleVoteUp = 27,
+    /**
+     * 文章被点踩
+     */
+    articleVoteDown = 28,
+    /**
+     * 积分 - 评论被接受
+     */
+    pointCommentAccept = 33,
+    /**
+     * 积分 - 举报处理
+     */
+    pointReportHandled = 36,
+    /**
+     * 聊天室 @
+     */
+    chatRoomAt = 38,
+    /**
+     * 专属红包提醒
+     */
+    redPacket = 39
+}
+/**
+ * 登录信息
+ */
+export interface Account {
+    /**
+     * 用户名
+     */
+    username: string;
+    /**
+     * 密码
+     */
+    passwd: string;
+    /**
+     * 二次验证码，非必填
+     */
+    mfaCode?: string;
+}
+export declare enum UserAppRole {
+    /**
+     * 黑客
+     */
+    Hack = 0,
+    /**
+     * 画家
+     */
+    Artist = 1
+}
+/**
+ * 用户信息
+ */
+export interface UserInfo {
+    /**
+     * 用户 id
+     */
+    oId: string;
+    /**
+     * 用户编号
+     */
+    userNo: string;
+    /**
+     * 用户名
+     */
+    userName: string;
+    /**
+     * 昵称
+     */
+    userNickname: string;
+    /**
+     * 首页地址
+     */
+    userURL: string;
+    /**
+     * 所在城市
+     */
+    userCity: string;
+    /**
+     * 签名
+     */
+    userIntro: string;
+    /**
+     * 是否在线
+     */
+    userOnlineFlag: boolean;
+    /**
+     * 用户积分
+     */
+    userPoint: number;
+    /**
+     * 用户组
+     */
+    userRole: string;
+    /**
+     * 角色
+     */
+    userAppRole: UserAppRole;
+    /**
+     * 用户头像地址
+     */
+    userAvatarURL: string;
+    /**
+     * 用户卡片背景
+     */
+    cardBg: string;
+    /**
+     * 用户关注数
+     */
+    followingUserCount: number;
+    /**
+     * 用户被关注数
+     */
+    followerCount: number;
+    /**
+     * 在线时长，单位分钟
+     */
+    onlineMinute: number;
+    /**
+     * 是否已经关注，未登录则为 `hide`
+     */
+    canFollow: 'hide' | 'no' | 'yes';
+    /**
+     * 用户所有勋章列表，包含未佩戴
+     */
+    allMetalOwned: MetalList;
+    /**
+     * 用户勋章列表
+     */
+    sysMetal: MetalList;
+}
+/**
+ * 猜拳类型
+ */
+export declare enum GestureType {
+    /**
+     * 石头
+     */
+    Rock = 0,
+    /**
+     * 剪刀
+     */
+    Scissors = 1,
+    /**
+     * 布
+     */
+    Paper = 2
+}
+/**
+ * 红包类型
+ */
+export declare enum RedPacketType {
+    /**
+     * 拼手气
+     */
+    Random = "random",
+    /**
+     * 平分
+     */
+    Average = "average",
+    /**
+     * 专属
+     */
+    Specify = "specify",
+    /**
+     * 心跳
+     */
+    Heartbeat = "heartbeat",
+    /**
+     * 猜拳
+     */
+    RockPaperScissors = "rockPaperScissors"
+}
+/**
+ * 红包数据
+ */
+export interface RedPacket {
+    /**
+     * 红包类型
+     */
+    type: RedPacketType;
+    /**
+     * 红包积分
+     */
+    money: number;
+    /**
+     * 红包个数
+     */
+    count: number;
+    /**
+     * 祝福语
+     */
+    msg: string;
+    /**
+     * 接收者，专属红包有效
+     */
+    recivers?: Array<string>;
+    /**
+     * 出拳，猜拳红包有效
+     */
+    gesture?: GestureType;
+}
+/**
+ * 红包领取者信息
+ */
+export interface RedPacketGot {
+    /**
+     * 用户 id
+     */
+    userId: string;
+    /**
+     * 用户名
+     */
+    userName: string;
+    /**
+     * 用户头像
+     */
+    avatar: string;
+    /**
+     * 领取到的积分
+     */
+    userMoney: number;
+    /**
+     * 领取积分时间
+     */
+    time: string;
+}
+/**
+ * 红包历史信息
+ */
+export interface RedPacketMessage {
+    /**
+     * 消息类型，固定为 redPacket
+     */
+    msgType: string;
+    /**
+     * 红包数
+     */
+    count: number;
+    /**
+     * 领取数
+     */
+    got: number;
+    /**
+     * 内含积分
+     */
+    money: number;
+    /**
+     * 祝福语
+     */
+    msg: string;
+    /**
+     * 发送者 id
+     */
+    senderId: string;
+    /**
+     * 红包类型
+     */
+    interface: string;
+    /**
+     * 接收者，专属红包有效
+     */
+    recivers: Array<string>;
+    /**
+     * 已领取者列表
+     */
+    who: Array<RedPacketGot>;
+}
+/**
+ * 红包信息
+ */
+export interface RedPacketInfo {
+    /**
+     * 红包基本信息
+     */
+    info: {
+        /**
+         * 数量
+         */
+        count: number;
+        /**
+         * 猜拳类型
+         */
+        gesture?: GestureType;
+        /**
+         * 领取数
+         */
+        got: number;
+        /**
+         * 祝福语
+         */
+        msg: string;
+        /**
+         * 发送者用户名
+         */
+        userName: string;
+        /**
+         * 用户头像
+         */
+        userAvatarURL: string;
+    };
+    /**
+     * 接收者，专属红包有效
+     */
+    recivers: Array<string>;
+    /**
+     * 已领取者列表
+     */
+    who: Array<RedPacketGot>;
+}
+/**
+ * 红包状态信息
+ */
+export interface RedPacketStatusMsg {
+    /**
+     * 对应红包消息 oId
+     */
+    oId: string;
+    /**
+     * 红包个数
+     */
+    count: number;
+    /**
+     * 已领取数量
+     */
+    got: number;
+    /**
+     * 发送者信息
+     */
+    whoGive: any;
+    /**
+     * 领取者信息
+     */
+    whoGot: Array<any>;
+}
+/**
+ * 徽章信息
+ */
+export interface Metal {
+    /**
+     * 完整徽章地址（含文字）
+     */
+    url?: string;
+    /**
+     * 徽章地址（不含文字）
+     */
+    icon?: string;
+    /**
+     * 徽章属性
+     */
+    attr: {
+        /**
+         * 徽标图地址
+         */
+        url: string;
+        /**
+         * 背景色
+         */
+        backcolor: string;
+        /**
+         * 文字颜色
+         */
+        fontcolor: string;
+    } | string;
+    /**
+     * 徽章名
+     */
+    name: string;
+    /**
+     * 徽章描述
+     */
+    description: string;
+    /**
+     * 徽章数据
+     */
+    data: string;
+    /**
+     * 是否佩戴
+     */
+    enable: boolean;
+}
+/**
+ * 徽章列表
+ */
+export type MetalList = Array<Metal>;
+/**
+ * 聊天室消息
+ */
+export interface ChatRoomMessage {
+    /**
+     * 消息 Id
+     */
+    oId: string;
+    /**
+     * 发送者用户名
+     */
+    userName: string;
+    /**
+     * 用户昵称
+     */
+    userNickname: string;
+    /**
+     * 用户头像
+     */
+    userAvatarURL: string;
+    /**
+     * 用户徽章
+     */
+    sysMetal: MetalList;
+    /**
+     * 消息内容
+     */
+    content: string | RedPacketMessage;
+    /**
+     * 发送时间
+     */
+    time: string;
+}
+/**
+ * 历史消息类型
+ */
+export declare enum ChatContentType {
+    /**
+     * 原始 Markdown
+     */
+    Markdown = "md",
+    /**
+     * 渲染 HTML
+     */
+    HTML = "html"
+}
+/**
+ * chatroom get 接口获取 oId 的相关消息类型
+ */
+export declare enum ChatMessageType {
+    /**
+     * 前后消息
+     */
+    Context = 0,
+    /**
+     * 前面的消息
+     */
+    Before = 1,
+    /**
+     * 后面的消息
+     */
+    After = 2
+}
+/**
+ * 聊天室消息类型
+ */
+export declare enum ChatRoomMessageType {
+    /**
+     * 在线用户
+     */
+    online = "online",
+    /**
+     * 话题修改
+     */
+    discussChanged = "discussChanged",
+    /**
+     * 消息撤回
+     */
+    revoke = "revoke",
+    /**
+     * 消息
+     */
+    msg = "msg",
+    /**
+     * 红包
+     */
+    redPacket = "redPacket",
+    /**
+     * 红包状态
+     */
+    redPacketStatus = "redPacketStatus",
+    /**
+     * 弹幕
+     */
+    barrager = "barrager"
+}
+/**
+ * 聊天室消息
+ */
+export interface Message {
+    /**
+     * 消息类型，
+     */
+    interface: ChatRoomMessageType | string;
+    /**
+     * 消息内容
+     */
+    data: OnlineMsg | discussMsg | RevokeMsg | ChatMsg | RedPacketMessage | RedPacketStatusMsg | BarragerMsg;
+}
+export interface BarragerMsg {
+    barragerContent: string;
+    userAvatarURL: string;
+    userAvatarURL20: string;
+    userNickname: string;
+    barragerColor: string;
+    userName: string;
+    userAvatarURL210: string;
+    userAvatarURL48: string;
+}
+/**
+* 在线用户消息
+*/
+export type OnlineMsg = Array<{
+    /**
+     * 用户首页
+     */
+    homePage: string;
+    /**
+     * 用户头像
+     */
+    userAvatarURL: string;
+    /**
+     * 用户名
+     */
+    userName: string;
+}>;
+/**
+* 主题修改消息，主题内容
+*/
+export type discussMsg = string;
+/**
+* 撤回消息，被撤回消息的 oId
+*/
+export type RevokeMsg = string;
+/**
+* 聊天消息
+*/
+export interface ChatMsg {
+    /**
+     * 消息 oId
+     */
+    oId: string;
+    /**
+     * 消息发送时间
+     */
+    time: string;
+    /**
+     * 发送者用户名
+     */
+    userName: string;
+    /**
+     * 发送者昵称
+     */
+    userNickname: string;
+    /**
+     * 发送者头像
+     */
+    userAvatarURL: string;
+    /**
+     * 消息内容
+     */
+    content: string;
+    /**
+     * 消息内容 Markdown
+     */
+    md: string;
+}
+/**
+ * @ 用户列表
+ */
+export type AtUserList = Array<{
+    /**
+     * 用户名
+     */
+    userName: string;
+    /**
+     * 用户头像
+     */
+    userAvatarURL: string;
+    /**
+     * 全小写用户名
+     */
+    userNameLowerCase: string;
+}>;
+/**
+ * 上传文件响应
+ */
+export interface UploadInfo {
+    /**
+     * 上传失败文件
+     */
+    errFiles: Array<string>;
+    /**
+     * 上传成功文件
+     */
+    succMap: {
+        /**
+         * Key 是文件名，value 为地址
+         */
+        [key: string]: string;
+    };
+}
+/**
+ * 通知类型
+ */
+export declare enum NoticeType {
+    /**
+     * 积分
+     */
+    Point = "point",
+    /**
+     * 评论
+     */
+    Comment = "commented",
+    /**
+     * 回复
+     */
+    Reply = "reply",
+    /**
+     * 提及我的
+     */
+    At = "at",
+    /**
+     * 我关注的
+     */
+    Following = "following",
+    /**
+     * 同城
+     */
+    Broadcast = "broadcast",
+    /**
+     * 系统
+     */
+    System = "sys-announce"
+}
+/**
+ * 通知列表
+ */
+export type NoticeList = Array<NoticePoint | NoticeComment | NoticeAt | NoticeFollow | NoticeSystem>;
+/**
+ * 通知数
+ */
+export interface NoticeCount {
+    /**
+     * 请求结果，成功为 0
+     */
+    code: number;
+    /**
+     * 用户是否启用 Web 通知
+     */
+    userNotifyStatus: boolean;
+    /**
+     * 未读通知数
+     */
+    unreadNotificationCnt: number;
+    /**
+     * 未读回复通知数
+     */
+    unreadReplyNotificationCnt: number;
+    /**
+     * 未读积分通知数
+     */
+    unreadPointNotificationCnt: number;
+    /**
+     * 未读 @ 通知数
+     */
+    unreadAtNotificationCnt: number;
+    /**
+     * 未读同城通知数
+     */
+    unreadBroadcastNotificationCnt: number;
+    /**
+     * 未读系统通知数
+     */
+    unreadSysAnnounceNotificationCnt: number;
+    /**
+     * 未读关注者通知数
+     */
+    unreadNewFollowerNotificationCnt: number;
+    /**
+     * 未读关注通知数
+     */
+    unreadFollowingNotificationCnt: number;
+    /**
+     * 未读评论通知数
+     */
+    unreadCommentedNotificationCnt: number;
+}
+/**
+ * 积分通知
+ */
+export interface NoticePoint {
+    /**
+     * 通知 id
+     */
+    oId: string;
+    /**
+     * 数据 id
+     */
+    dataId: string;
+    /**
+     * 用户 id
+     */
+    userId: string;
+    /**
+     * 数据类型
+     */
+    dataType: DataType;
+    /**
+     * 通知描述
+     */
+    description: string;
+    /**
+     * 是否已读
+     */
+    hasRead: boolean;
+    /**
+     * 创建日期
+     */
+    createTime: string;
+}
+/**
+ * 评论/回帖通知
+ */
+export interface NoticeComment {
+    /**
+     * 通知 id
+     */
+    oId: string;
+    /**
+     * 文章标题
+     */
+    commentArticleTitle: string;
+    /**
+     * 文章作者
+     */
+    commentAuthorName: string;
+    /**
+     * 作者头像
+     */
+    commentAuthorThumbnailURL: string;
+    /**
+     * 文章类型
+     */
+    commentArticleType: number;
+    /**
+     * 是否精选
+     */
+    commentArticlePerfect: number;
+    /**
+     * 评论内容
+     */
+    commentContent: string;
+    /**
+     * 评论地址
+     */
+    commentSharpURL: string;
+    /**
+     * 是否已读
+     */
+    hasRead: boolean;
+    /**
+     * 评论时间
+     */
+    commentCreateTime: string;
+}
+/**
+ * 提到我通知
+ */
+export interface NoticeAt {
+    /**
+     * 通知 id
+     */
+    oId: string;
+    /**
+     * 数据类型
+     */
+    dataType: DataType;
+    /**
+     * 用户名
+     */
+    userName: string;
+    /**
+     * 用户头像
+     */
+    userAvatarURL: string;
+    /**
+     * 通知内容
+     */
+    content: string;
+    /**
+     * 是否已读
+     */
+    hasRead: boolean;
+    /**
+     * 创建时间
+     */
+    createTime: string;
+}
+/**
+ * 我关注的通知
+ */
+export interface NoticeFollow {
+    /**
+     * 通知 Id
+     */
+    oId: string;
+    /**
+     * 文章地址
+     */
+    url: string;
+    /**
+     * 数据类型
+     */
+    dataType: DataType;
+    /**
+     * 文章标题
+     */
+    articleTitle: string;
+    /**
+     * 作者
+     */
+    authorName: string;
+    /**
+     * 通知内容
+     */
+    content: string;
+    /**
+     * 是否评论
+     */
+    isComment: boolean;
+    /**
+     * 作者头像
+     */
+    thumbnailURL: string;
+    /**
+     * 文章评论数
+     */
+    articleCommentCount: number;
+    /**
+     * 是否精选
+     */
+    articlePerfect: number;
+    /**
+     * 文章标签列表
+     */
+    articleTagObjs: Array<ArticleTag>;
+    /**
+     * 文章标签
+     */
+    articleTags: string;
+    /**
+     * 文章类型
+     */
+    articleType: number;
+    /**
+     * 是否已读
+     */
+    hasRead: boolean;
+    /**
+     * 通知创建时间
+     */
+    createTime: string;
+}
+/**
+ * 系统通知数据
+ */
+export interface NoticeSystem {
+    /**
+     * 消息的 oId
+     */
+    oId: string;
+    /**
+     * 用户 Id
+     */
+    userId: string;
+    /**
+     * 数据 Id
+     */
+    dataId: string;
+    /**
+     * 数据类型
+     */
+    dataType: DataType;
+    /**
+     * 消息描述
+     */
+    description: string;
+    /**
+     * 是否已读
+     */
+    hasRead: boolean;
+    /**
+     * 创建日期
+     */
+    createTime: string;
+}
+export interface BreezemoonContent {
+    /**
+     * 发布者用户名
+     */
+    breezemoonAuthorName: string;
+    /**
+     * 最后更新时间
+     */
+    breezemoonUpdated: string;
+    /**
+     * 清风明月ID
+     */
+    oId: string;
+    /**
+     * 创建时间
+     */
+    breezemoonCreated: string;
+    /**
+     * 发布者头像URL
+     */
+    breezemoonAuthorThumbnailURL48: string;
+    /**
+     * 发布时间
+     */
+    timeAgo: string;
+    /**
+     * 正文
+     */
+    breezemoonContent: string;
+    /**
+     * 创建时间
+     */
+    breezemoonCreateTime: string;
+    /**
+     * 发布城市（可能为空，请注意做判断）
+     */
+    breezemoonCity: string;
+}
+/**
+ * 举报数据类型
+ */
+export declare enum ReportDataType {
+    /**
+     * 文章
+     */
+    article = 0,
+    /**
+     * 评论
+     */
+    comment = 1,
+    /**
+     * 用户
+     */
+    user = 2,
+    /**
+     * 聊天消息
+     */
+    chatroom = 3
+}
+/**
+ * 举报类型
+ */
+export declare enum ReportType {
+    /**
+     * 垃圾广告
+     */
+    advertise = 0,
+    /**
+     * 色情
+     */
+    porn = 1,
+    /**
+     * 违规
+     */
+    violate = 2,
+    /**
+     * 侵权
+     */
+    infringement = 3,
+    /**
+     * 人身攻击
+     */
+    attacks = 4,
+    /**
+     * 冒充他人账号
+     */
+    impersonate = 5,
+    /**
+     * 垃圾广告账号
+     */
+    advertisingAccount = 6,
+    /**
+     * 违规泄露个人信息
+     */
+    leakPrivacy = 7,
+    /**
+     * 其它
+     */
+    other = 8
+}
+/**
+ * 举报接口数据
+ */
+export interface Report {
+    /**
+     * API Key，登录取得
+     */
+    apiKey: string;
+    /**
+     * 举报对象的 oId
+     */
+    reportDataId: string;
+    /**
+     * 举报数据的类型
+     */
+    reportDataType: ReportDataType;
+    /**
+     * 举报的类型
+     */
+    reportType: ReportType;
+    /**
+     * 举报的理由
+     */
+    reportMemo: string;
+}
+/**
+ * 帖子类型
+ */
+export declare enum ArticleType {
+    Normal = 0,
+    Private = 1,
+    Broadcast = 2,
+    Thought = 3,
+    Question = 5
+}
+/**
+ * 发帖信息
+ */
+export interface ArticlePost {
+    /**
+     * 帖子标题
+     */
+    articleTitle: string;
+    /**
+     * 帖子内容
+     */
+    articleContent: string;
+    /**
+     * 帖子标签
+     */
+    articleTags: string;
+    /**
+     * 是否允许评论
+     */
+    articleCommentable: boolean;
+    /**
+     * 是否帖子关注者
+     */
+    articleNotifyFollowers: boolean;
+    /**
+     * 帖子类型
+     */
+    articleType: ArticleType;
+    /**
+     * 是否在列表展示
+     */
+    articleShowInList: 0 | 1;
+    /**
+     * 打赏内容
+     */
+    articleRewardContent?: string;
+    /**
+     * 打赏积分
+     */
+    articleRewardPoint?: string;
+    /**
+     * 是否匿名
+     */
+    articleAnonymous?: boolean;
+    /**
+     * 提问悬赏积分
+     */
+    articleQnAOfferPoint?: number;
+}
+/**
+ * 文章标签
+ */
+export interface ArticleTag {
+    /**
+     * 标签 id
+     */
+    oId: string;
+    /**
+     * 标签名
+     */
+    tagTitle: string;
+    /**
+     * 标签描述
+     */
+    tagDescription: string;
+    /**
+     * icon 地址
+     */
+    tagIconPath: string;
+    /**
+     * 标签地址
+     */
+    tagURI: string;
+    /**
+     * 标签自定义 CSS
+     */
+    tagCSS: string;
+    /**
+     * 反对数
+     */
+    tagBadCnt: number;
+    /**
+     * 标签回帖计数
+     */
+    tagCommentCount: number;
+    /**
+     * 关注数
+     */
+    tagFollowerCount: number;
+    /**
+     * 点赞数
+     */
+    tagGoodCnt: number;
+    /**
+     * 引用计数
+     */
+    tagReferenceCount: number;
+    /**
+     * 标签相关链接计数
+     */
+    tagLinkCount: number;
+    /**
+     * 标签 SEO 描述
+     */
+    tagSeoDesc: string;
+    /**
+     * 标签关键字
+     */
+    tagSeoKeywords: string;
+    /**
+     * 标签 SEO 标题
+     */
+    tagSeoTitle: string;
+    /**
+     * 标签广告内容
+     */
+    tagAd: string;
+    /**
+     * 是否展示广告
+     */
+    tagShowSideAd: 0 | 1;
+    /**
+     * 标签状态
+     */
+    tagStatus: 0 | 1;
+    /**
+     * 标签随机数
+     */
+    tagRandomDouble: number;
+}
+/**
+ * 公开状态
+ */
+export declare enum PublicStatus {
+    Public = 0,
+    Private = 1
+}
+/**
+ * 是否状态
+ */
+export declare enum YesNoStatus {
+    Yes = 0,
+    No = 1
+}
+/**
+ * 文章状态
+ */
+export declare enum ArticleStatus {
+    /**
+     * 正常
+     */
+    Normal = 0,
+    /**
+     * 封禁
+     */
+    Ban = 1,
+    /**
+     * 锁定
+     */
+    Lock = 2
+}
+/**
+ * 评论者信息
+ */
+export type CommentAuthor = ArticleAuthor;
+/**
+ * 文章作者信息
+ */
+export interface ArticleAuthor {
+    /**
+     * 用户是否在线
+     */
+    userOnlineFlag: boolean;
+    /**
+     * 用户在线时长
+     */
+    onlineMinute: number;
+    /**
+     * 是否公开积分列表
+     */
+    userPointStatus: PublicStatus;
+    /**
+     * 是否公开关注者列表
+     */
+    userFollowerStatus: PublicStatus;
+    /**
+     * 用户完成新手指引步数
+     */
+    userGuideStep: number;
+    /**
+     * 是否公开在线状态
+     */
+    userOnlineStatus: PublicStatus;
+    /**
+     * 上次登录日期
+     */
+    userCurrentCheckinStreakStart: number;
+    /**
+     * 是否聊天室图片自动模糊
+     */
+    chatRoomPictureStatus: boolean;
+    /**
+     * 用户标签
+     */
+    userTags: string;
+    /**
+     * 是否公开回帖列表
+     */
+    userCommentStatus: PublicStatus;
+    /**
+     * 用户时区
+     */
+    userTimezone: string;
+    /**
+     * 用户个人主页
+     */
+    userURL: string;
+    /**
+     * 是否启用站外链接跳转页面
+     */
+    userForwardPageStatus: boolean;
+    /**
+     * 是否公开 UA 信息
+     */
+    userUAStatus: PublicStatus;
+    /**
+     * 自定义首页跳转地址
+     */
+    userIndexRedirectURL: string;
+    /**
+     * 最近发帖时间
+     */
+    userLatestArticleTime: number;
+    /**
+     * 标签计数
+     */
+    userTagCount: number;
+    /**
+     * 昵称
+     */
+    userNickname: string;
+    /**
+     * 回帖浏览模式
+     */
+    userListViewMode: 0 | 1;
+    /**
+     * 最长连续签到
+     */
+    userLongestCheckinStreak: number;
+    /**
+     * 用户头像类型
+     */
+    userAvatarType: number;
+    /**
+     * 用户确认邮件发送时间
+     */
+    userSubMailSendTime: number;
+    /**
+     * 用户最后更新时间
+     */
+    userUpdateTime: number;
+    /**
+     * userSubMailStatus
+     */
+    userSubMailStatus: YesNoStatus;
+    /**
+     * 是否加入积分排行
+     */
+    userJoinPointRank: YesNoStatus;
+    /**
+     * 用户最后登录时间
+     */
+    userLatestLoginTime: number;
+    /**
+     * 应用角色
+     */
+    userAppRole: number;
+    /**
+     * 头像查看模式
+     */
+    userAvatarViewMode: number;
+    /**
+     * 用户状态
+     */
+    userStatus: number;
+    /**
+     * 用户上次最长连续签到日期
+     */
+    userLongestCheckinStreakEnd: number;
+    /**
+     * 是否公开关注帖子列表
+     */
+    userWatchingArticleStatus: PublicStatus;
+    /**
+     * 上次回帖时间
+     */
+    userLatestCmtTime: number;
+    /**
+     * 用户省份
+     */
+    userProvince: string;
+    /**
+     * 用户当前连续签到计数
+     */
+    userCurrentCheckinStreak: number;
+    /**
+     * 用户编号
+     */
+    userNo: number;
+    /**
+     * 用户头像
+     */
+    userAvatarURL: string;
+    /**
+     * 是否公开关注标签列表
+     */
+    userFollowingTagStatus: PublicStatus;
+    /**
+     * 用户语言
+     */
+    userLanguage: string;
+    /**
+     * 是否加入消费排行
+     */
+    userJoinUsedPointRank: YesNoStatus;
+    /**
+     * 上次签到日期
+     */
+    userCurrentCheckinStreakEnd: number;
+    /**
+     * 是否公开收藏帖子列表
+     */
+    userFollowingArticleStatus: PublicStatus;
+    /**
+     * 是否启用键盘快捷键
+     */
+    userKeyboardShortcutsStatus: YesNoStatus;
+    /**
+     * 是否回帖后自动关注帖子
+     */
+    userReplyWatchArticleStatus: YesNoStatus;
+    /**
+     * 回帖浏览模式
+     */
+    userCommentViewMode: number;
+    /**
+     * 是否公开清风明月列表
+     */
+    userBreezemoonStatus: PublicStatus;
+    /**
+     * 用户上次签到时间
+     */
+    userCheckinTime: number;
+    /**
+     * 用户消费积分
+     */
+    userUsedPoint: number;
+    /**
+     * 是否公开帖子列表
+     */
+    userArticleStatus: PublicStatus;
+    /**
+     * 用户积分
+     */
+    userPoint: number;
+    /**
+     * 用户回帖数量
+     */
+    userCommentCount: number;
+    /**
+     * 用户个性签名
+     */
+    userIntro: string;
+    /**
+     * 移动端主题
+     */
+    userMobileSkin: string;
+    /**
+     * 分页每页条目
+     */
+    userListPageSize: number;
+    /**
+     * 文章 Id
+     */
+    oId: string;
+    /**
+     * 用户名
+     */
+    userName: string;
+    /**
+     * 是否公开 IP 地理信息
+     */
+    userGeoStatus: PublicStatus;
+    /**
+     * 最长连续签到起始日
+     */
+    userLongestCheckinStreakStart: number;
+    /**
+     * 用户主题
+     */
+    userSkin: string;
+    /**
+     * 是否启用 Web 通知
+     */
+    userNotifyStatus: YesNoStatus;
+    /**
+     * 公开关注用户列表
+     */
+    userFollowingUserStatus: PublicStatus;
+    /**
+     * 文章数
+     */
+    userArticleCount: number;
+    /**
+     * 用户角色
+     */
+    userRole: string;
+    /**
+     * 徽章
+     */
+    sysMetal?: MetalList;
+}
+export interface ArticleDetail {
+    /**
+     * 是否在列表展示
+     */
+    articleShowInList: boolean;
+    /**
+     * 文章创建时间
+     */
+    articleCreateTime: string;
+    /**
+     * 发布者Id
+     */
+    articleAuthorId: string;
+    /**
+     * 反对数
+     */
+    articleBadCnt: number;
+    /**
+     * 文章最后修改时间
+     */
+    articleLatestCmtTime: string;
+    /**
+     * 赞同数
+     */
+    articleGoodCnt: number;
+    /**
+     * 悬赏积分
+     */
+    articleQnAOfferPoint: number;
+    /**
+     * 作者头像缩略图
+     */
+    articleThumbnailURL: string;
+    /**
+     * 置顶序号
+     */
+    articleStickRemains: number;
+    /**
+     * 发布时间简写
+     */
+    timeAgo: string;
+    /**
+     * 文章更新时间
+     */
+    articleUpdateTimeStr: string;
+    /**
+     * 作者用户名
+     */
+    articleAuthorName: string;
+    /**
+     * 文章类型
+     */
+    articleType: ArticleType;
+    /**
+     * 是否悬赏
+     */
+    offered: boolean;
+    /**
+     * 文章创建时间字符串
+     */
+    articleCreateTimeStr: string;
+    /**
+     * 文章浏览数
+     */
+    articleViewCount: number;
+    /**
+     * 作者头像缩略图
+     */
+    articleAuthorThumbnailURL20: string;
+    /**
+     * 关注数
+     */
+    articleWatchCnt: number;
+    /**
+     * 文章预览内容
+     */
+    articlePreviewContent: string;
+    /**
+     * 文章标题
+     */
+    articleTitleEmoj: string;
+    /**
+     * 文章标题
+     */
+    articleTitleEmojUnicode: string;
+    /**
+     * 文章标题
+     */
+    articleTitle: string;
+    /**
+     * 作者头像缩略图
+     */
+    articleAuthorThumbnailURL48: string;
+    /**
+     * 文章评论数
+     */
+    articleCommentCount: number;
+    /**
+     * 收藏数
+     */
+    articleCollectCnt: number;
+    /**
+     * 文章最后评论者
+     */
+    articleLatestCmterName: string;
+    /**
+     * 文章标签
+     */
+    articleTags: string;
+    /**
+     * 文章 id
+     */
+    oId: string;
+    /**
+     * 最后评论时间简写
+     */
+    cmtTimeAgo: string;
+    /**
+     * 是否置顶
+     */
+    articleStick: number;
+    /**
+     * 文章标签信息
+     */
+    articleTagObjs: Array<ArticleTag>;
+    /**
+     * 文章最后评论时间
+     */
+    articleLatestCmtTimeStr: string;
+    /**
+     * 是否匿名
+     */
+    articleAnonymous: boolean;
+    /**
+     * 文章感谢数
+     */
+    articleThankCnt: number;
+    /**
+     * 文章更新时间
+     */
+    articleUpdateTime: string;
+    /**
+     * 文章状态
+     */
+    articleStatus: ArticleStatus;
+    /**
+     * 文章点击数
+     */
+    articleHeat: number;
+    /**
+     * 文章是否优选
+     */
+    articlePerfect: boolean;
+    /**
+     * 作者头像缩略图
+     */
+    articleAuthorThumbnailURL210: string;
+    /**
+     * 文章固定链接
+     */
+    articlePermalink: string;
+    /**
+     * 作者用户信息
+     */
+    articleAuthor: ArticleAuthor;
+    /**
+     * 文章感谢数
+     */
+    thankedCnt?: number;
+    /**
+     * 文章匿名浏览量
+     */
+    articleAnonymousView?: number;
+    /**
+     * 文章浏览量简写
+     */
+    articleViewCntDisplayFormat?: string;
+    /**
+     * 文章是否启用评论
+     */
+    articleCommentable?: boolean;
+    /**
+     * 是否开启打赏
+     */
+    rewarded?: boolean;
+    /**
+     * 打赏人数
+     */
+    rewardedCnt?: number;
+    /**
+     * 文章打赏积分
+     */
+    articleRewardPoint?: number;
+    /**
+     * 是否已关注
+     */
+    isFollowing?: boolean;
+    /**
+     * 是否关注
+     */
+    isWatching?: boolean;
+    /**
+     * 是否是我的文章
+     */
+    isMyArticle?: boolean;
+    /**
+     * 是否感谢
+     */
+    thanked?: boolean;
+    /**
+     * 编辑器类型
+     */
+    articleEditorType?: number;
+    /**
+     * 文章音频地址
+     */
+    articleAudioURL?: string;
+    /**
+     * 文章目录 HTML
+     */
+    articleToC?: string;
+    /**
+     * 文章内容 HTML
+     */
+    articleContent?: string;
+    /**
+     * 文章内容 Markdown
+     */
+    articleOriginalContent?: string;
+    /**
+     * 文章缩略图
+     */
+    articleImg1URL?: string;
+    /**
+     * 文章点赞数
+     */
+    articleVote?: number;
+    /**
+     * 文章随机数
+     */
+    articleRandomDouble?: number;
+    /**
+     * 作者签名
+     */
+    articleAuthorIntro?: string;
+    /**
+     * 发布城市
+     */
+    articleCity?: string;
+    /**
+     * 发布者 IP
+     */
+    articleIP?: string;
+    /**
+     * 作者首页地址
+     */
+    articleAuthorURL?: string;
+    /**
+     * 推送 Email 推送顺序
+     */
+    articlePushOrder?: number;
+    /**
+     * 打赏内容
+     */
+    articleRewardContent?: string;
+    /**
+     * reddit分数
+     */
+    redditScore?: string;
+    /**
+     * 评论分页信息
+     */
+    pagination?: {
+        /**
+         * 评论分页数
+         */
+        paginationPageCount: string;
+        /**
+         * 建议分页页码
+         */
+        paginationPageNums: Array<number>;
+    };
+    /**
+     * 评论是否可见
+     */
+    discussionViewable: boolean;
+    /**
+     * 文章修改次数
+     */
+    articleRevisionCount: number;
+    /**
+     * 文章的评论
+     */
+    articleComments?: Array<ArticleComment>;
+    /**
+     * 文章最佳评论
+     */
+    articleNiceComments?: Array<ArticleComment>;
+}
+export interface ArticleComment {
+    commentNice: boolean;
+    commentCreateTimeStr: string;
+    commentAuthorId: string;
+    commentScore: number;
+    commentCreateTime: string;
+    commentAuthorURL: string;
+    commentVote: number;
+    commentRevisionCount: number;
+    timeAgo: string;
+    commentOriginalCommentId: string;
+    sysMetal: MetalList;
+    commentGoodCnt: number;
+    commentVisible: YesNoStatus;
+    commentOnArticleId: string;
+    rewardedCnt: number;
+    commentSharpURL: string;
+    commentAnonymous: boolean;
+    commentReplyCnt: number;
+    oId: string;
+    commentContent: string;
+    commentStatus: number;
+    commenter: CommentAuthor;
+    commentAuthorName: string;
+    commentThankCnt: number;
+    commentBadCnt: number;
+    rewarded: boolean;
+    commentAuthorThumbnailURL: string;
+    commentAudioURL: string;
+    commentQnAOffered: number;
+}
+export interface ArticleList {
+    articles: Array<ArticleDetail>;
+    pagination: {
+        paginationPageCount: number;
+        paginationPageNums: Array<number>;
+    };
+    tag?: ArticleTag;
+}
+/**
+ * 帖子列表查询类型
+ */
+export declare enum ArticleListType {
+    /**
+     * 最近
+     */
+    Recent = "",
+    /**
+     * 热门
+     */
+    Hot = "/hot",
+    /**
+     * 点赞
+     */
+    Good = "/good",
+    /**
+     * 最近回复
+     */
+    Reply = "/reply",
+    /**
+     * 优选，需包含标签
+     */
+    Perfect = "/perfact"
+}
+/**
+ * 点赞类型
+ */
+export declare enum VoteStatus {
+    /**
+     * 点赞
+     */
+    Voted = 0,
+    /**
+     * 取消点赞
+     */
+    Unvote = -1
+}
+export interface CommentPost {
+    /**
+     * 文章 Id
+     */
+    articleId: string;
+    /**
+     * 是否匿名评论
+     */
+    commentAnonymous: boolean;
+    /**
+     * 评论是否楼主可见
+     */
+    commentVisible: boolean;
+    /**
+     * 评论内容
+     */
+    commentContent: string;
+    /**
+     * 回复评论 Id
+     */
+    commentOriginalCommentId?: string;
+}
+/**
+ * 私聊内容
+ */
+export interface ChatData {
+    /**
+     * 接收者 Id
+     */
+    toId: string;
+    /**
+     * 预览内容
+     */
+    preview: string;
+    /**
+     * 消息用户 Session
+     */
+    user_session: string;
+    /**
+     * 发送者头像
+     */
+    senderAvatar: string;
+    /**
+     * 消息 Markdown
+     */
+    markdown: string;
+    /**
+     * 接收者头像
+     */
+    receiverAvatar: string;
+    /**
+     * 消息 Id
+     */
+    oId: string;
+    /**
+     * 发送时间
+     */
+    time: string;
+    /**
+     * 来源 Id
+     */
+    fromId: string;
+    /**
+     * 发送者用户名
+     */
+    senderUserName: string;
+    /**
+     * 消息内容 HTML
+     */
+    content: string;
+    /**
+     * 接收者用户名
+     */
+    receiverUserName: string;
+}
+/**
+ * 禁言用户信息
+ */
+export interface MuteItem {
+    /**
+     * 解除禁言时间戳
+     */
+    time: number;
+    /**
+     * 用户头像
+     */
+    userAvatarURL: string;
+    /**
+     * 用户名
+     */
+    userName: string;
+    /**
+     * 用户昵称
+     */
+    userNickname: string;
+}