@lcap/cli/out/popo/types.d.ts

utils for lcap

import type { TokenData } from '../utils';
/**
 * POPO 群消息数据
 *
 * @link https://open.popo.netease.com/docs/api/robot/msg-send
 */
export interface TeamMessageData {
    /** 机器人账号 */
    sender: string;
    /**
     * 群号
     *
     * @description 机器人必须在群内
     */
    receiver: string;
    /**
     * 消息内容
     *
     * @description 不能超过 3000 个字符
     */
    message: string;
    /**
     * 提醒的成员列表
     *
     * @description 成员只有在群内才生效
     * @description 文本中含有被圈的人的名称才有效
     */
    atUids?: string[];
    /**
     * 是否提醒所有人
     *
     * @description 群消息时有效
     * @description 消息文本中必须要有`'@所有人'`才有效
     * @default false
     */
    isAtAll?: boolean;
}
/**
 * POPO 个人消息数据
 *
 * @link https://open.popo.netease.com/docs/api/robot/msg-send
 */
export interface PersonMessageData {
    /** 机器人账号 */
    sender: string;
    /** 接受消息的用户邮箱 */
    receiver: string;
    /**
     * 消息内容
     *
     * @description 不能超过 3000 个字符
     */
    message: string;
}
/**
 * 授权凭证返回接口
 *
 * @link https://open.popo.netease.com/docs/api/robot/msg-send
 */
export interface TokenResponseData {
    openAccessToken: string;
    accessExpiredAt: number;
}
export interface MessageData {
    /** 机器人账号 */
    sender: string;
    /**
     * 接收消息方标志符
     *
     *  - 个人状态时，此项为个人邮箱
     *  - 群状态时，此项为群号
     */
    receiver: string;
    /**
     * 消息文本
     */
    message: string;
}
export interface CommandOptions extends TokenData, Omit<MessageData, 'sender'> {
    /** 消息类别 */
    kind: 'person' | 'team';
}
export interface SecretData {
    id: string;
    secret: string;
    sender: string;
}
export interface PersonDetail {
    /** 邮箱账号 */
    uid: string;
    /** 工号 */
    jobNumber: string;
    /** 姓名 */
    name: string;
    /** 花名 */
    nickname: string;
    /** 分机号 */
    extendTel: string;
    /** 区域名称 */
    areaName: string;
    /** 办公地点 */
    locationName: string;
    /** 办公楼层 */
    floorName: string;
    /** 部门名称 */
    deptNameList: string[];
}
export interface MessageTemplateData {
    /**
     * 项目名称
     */
    project: string;
}
export interface PopoResponse<T> {
    data: T;
    errcode: number;
    errmsg: string;
}
//# sourceMappingURL=types.d.ts.map