node-easywechat 2.9.1 → 3.0.0-alpha.1

package/dist/Work/ExternalContact/ContactWayClient.js

@@ -1,82 +0,0 @@
-'use strict';
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const BaseClient_1 = __importDefault(require("../../Core/BaseClient"));
-const Utils_1 = require("../../Core/Utils");
-class ContactWayClient extends BaseClient_1.default {
-    /**
-     * 配置客户联系「联系我」方式
-     * @see https://developer.work.weixin.qq.com/document/path/92572#%E9%85%8D%E7%BD%AE%E5%AE%A2%E6%88%B7%E8%81%94%E7%B3%BB%E3%80%8C%E8%81%94%E7%B3%BB%E6%88%91%E3%80%8D%E6%96%B9%E5%BC%8F
-     * @param type
-     * @param scene
-     * @param config
-     * @returns
-     */
-    create(type, scene, config) {
-        let params = (0, Utils_1.merge)({
-            type,
-            scene,
-        }, config);
-        return this.httpPostJson('cgi-bin/externalcontact/add_contact_way', params);
-    }
-    /**
-     * 获取企业已配置的「联系我」方式
-     * @see https://developer.work.weixin.qq.com/document/path/92572#%E8%8E%B7%E5%8F%96%E4%BC%81%E4%B8%9A%E5%B7%B2%E9%85%8D%E7%BD%AE%E7%9A%84%E3%80%8C%E8%81%94%E7%B3%BB%E6%88%91%E3%80%8D%E6%96%B9%E5%BC%8F
-     * @param configId
-     * @returns
-     */
-    get(configId) {
-        return this.httpGet('cgi-bin/externalcontact/get_contact_way', {
-            config_id: configId,
-        });
-    }
-    /**
-     * 更新企业已配置的「联系我」方式
-     * @see https://developer.work.weixin.qq.com/document/path/92572#%E6%9B%B4%E6%96%B0%E4%BC%81%E4%B8%9A%E5%B7%B2%E9%85%8D%E7%BD%AE%E7%9A%84%E3%80%8C%E8%81%94%E7%B3%BB%E6%88%91%E3%80%8D%E6%96%B9%E5%BC%8F
-     * @param configId
-     * @param config
-     * @returns
-     */
-    update(configId, config) {
-        let params = (0, Utils_1.merge)({
-            config_id: configId,
-        }, config);
-        return this.httpPostJson('cgi-bin/externalcontact/update_contact_way', params);
-    }
-    /**
-     * 删除企业已配置的「联系我」方式
-     * @see https://developer.work.weixin.qq.com/document/path/92572#%E5%88%A0%E9%99%A4%E4%BC%81%E4%B8%9A%E5%B7%B2%E9%85%8D%E7%BD%AE%E7%9A%84%E3%80%8C%E8%81%94%E7%B3%BB%E6%88%91%E3%80%8D%E6%96%B9%E5%BC%8F
-     * @param configId
-     * @returns
-     */
-    delete(configId) {
-        return this.httpGet('cgi-bin/externalcontact/del_contact_way', {
-            config_id: configId,
-        });
-    }
-    /**
-     * 获取企业已配置的「联系我」列表
-     * @see https://developer.work.weixin.qq.com/document/path/92572#%E8%8E%B7%E5%8F%96%E4%BC%81%E4%B8%9A%E5%B7%B2%E9%85%8D%E7%BD%AE%E7%9A%84%E3%80%8C%E8%81%94%E7%B3%BB%E6%88%91%E3%80%8D%E5%88%97%E8%A1%A8
-     * @param cursor
-     * @param limit
-     * @param startTime
-     * @param endTime
-     * @returns
-     */
-    list(cursor = '', limit = 100, startTime = null, endTime = null) {
-        let params = {
-            cursor,
-            limit,
-        };
-        if (startTime) {
-            params['start_time'] = startTime;
-        }
-        if (endTime) {
-            params['end_time'] = endTime;
-        }
-        return this.httpPostJson('cgi-bin/externalcontact/list_contact_way', params);
-    }
-}
-exports.default = ContactWayClient;

package/dist/Work/ExternalContact/MessageClient.d.ts

@@ -1,58 +0,0 @@
-import BaseClient from '../../Core/BaseClient';
-export default class MessageClient extends BaseClient {
-    protected required: string[];
-    protected textMessage: object;
-    protected imageMessage: object;
-    protected linkMessage: object;
-    protected miniprogramMessage: object;
-    /**
-     * 添加企业群发消息模板
-     * @param msg
-     * @returns
-     */
-    submit(msg: object): Promise<any>;
-    /**
-     * 获取企业群发消息发送结果
-     * @param msgId
-     * @returns
-     */
-    get(msgId: string): Promise<any>;
-    /**
-     * 获取群发记录列表
-     * @param chatType 群发任务的类型，默认为single，表示发送给客户，group表示发送给客户群
-     * @param startTime 群发任务记录开始时间
-     * @param endTime 群发任务记录结束时间
-     * @param creator 群发任务创建人企业账号id
-     * @param filterType 创建人类型。0：企业发表 1：个人发表 2：所有，包括个人创建以及企业创建，默认情况下为所有类型
-     * @param limit 返回的最大记录数，整型，最大值100，默认值50，超过最大值时取默认值
-     * @param cursor 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填
-     * @returns
-     */
-    getGroupmsgListV2(chatType: string, startTime: number, endTime: number, creator?: string, filterType?: number, limit?: number, cursor?: string): Promise<any>;
-    /**
-     * 获取群发成员发送任务列表
-     * @param msgId 群发消息的id，通过获取群发记录列表接口返回
-     * @param limit 返回的最大记录数，整型，最大值1000，默认值500，超过最大值时取默认值
-     * @param cursor 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填
-     * @returns
-     */
-    getGroupmsgTask(msgId: string, limit?: number, cursor?: string): Promise<any>;
-    /**
-     * 获取企业群发成员执行结果
-     * @param msgId 群发消息的id，通过获取群发记录列表接口返回
-     * @param userId 发送成员userid，通过获取群发成员发送任务列表接口返回
-     * @param limit 返回的最大记录数，整型，最大值1000，默认值500，超过最大值时取默认值
-     * @param cursor 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填
-     * @returns
-     */
-    getGroupmsgSendResult(msgId: string, userId: string, limit?: number, cursor?: string): Promise<any>;
-    /**
-     * 发送新客户欢迎语
-     * @param welcomeCode
-     * @param msg
-     * @returns
-     */
-    sendWelcome(welcomeCode: string, msg: object): Promise<any>;
-    protected formatMessage(data: object): object;
-    protected formatFields(data: object, defaults: object): object;
-}

package/dist/Work/ExternalContact/MessageClient.js

@@ -1,158 +0,0 @@
-'use strict';
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const BaseClient_1 = __importDefault(require("../../Core/BaseClient"));
-const Utils_1 = require("../../Core/Utils");
-class MessageClient extends BaseClient_1.default {
-    constructor() {
-        super(...arguments);
-        this.required = ['content', 'title', 'url', 'pic_media_id', 'appid', 'page'];
-        this.textMessage = {
-            content: '',
-        };
-        this.imageMessage = {};
-        this.linkMessage = {
-            title: '',
-            picurl: '',
-            desc: '',
-            url: '',
-        };
-        this.miniprogramMessage = {
-            title: '',
-            pic_media_id: '',
-            appid: '',
-            page: '',
-        };
-    }
-    /**
-     * 添加企业群发消息模板
-     * @param msg
-     * @returns
-     */
-    submit(msg) {
-        let params = this.formatMessage(msg);
-        return this.httpPostJson('cgi-bin/externalcontact/add_msg_template', params);
-    }
-    /**
-     * 获取企业群发消息发送结果
-     * @param msgId
-     * @returns
-     */
-    get(msgId) {
-        return this.httpPostJson('cgi-bin/externalcontact/get_group_msg_result', {
-            msgid: msgId,
-        });
-    }
-    /**
-     * 获取群发记录列表
-     * @param chatType 群发任务的类型，默认为single，表示发送给客户，group表示发送给客户群
-     * @param startTime 群发任务记录开始时间
-     * @param endTime 群发任务记录结束时间
-     * @param creator 群发任务创建人企业账号id
-     * @param filterType 创建人类型。0：企业发表 1：个人发表 2：所有，包括个人创建以及企业创建，默认情况下为所有类型
-     * @param limit 返回的最大记录数，整型，最大值100，默认值50，超过最大值时取默认值
-     * @param cursor 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填
-     * @returns
-     */
-    getGroupmsgListV2(chatType, startTime, endTime, creator = null, filterType = null, limit = null, cursor = null) {
-        let params = {
-            chat_type: chatType,
-            start_time: startTime,
-            end_time: endTime,
-            creator: creator,
-            filter_type: filterType,
-            limit: limit,
-            cursor: cursor,
-        };
-        Object.keys(params).map(key => {
-            if (params[key] === null || params[key] === undefined) {
-                delete params[key];
-            }
-        });
-        return this.httpPostJson('cgi-bin/externalcontact/get_groupmsg_list_v2', params);
-    }
-    /**
-     * 获取群发成员发送任务列表
-     * @param msgId 群发消息的id，通过获取群发记录列表接口返回
-     * @param limit 返回的最大记录数，整型，最大值1000，默认值500，超过最大值时取默认值
-     * @param cursor 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填
-     * @returns
-     */
-    getGroupmsgTask(msgId, limit = null, cursor = null) {
-        let params = {
-            msgid: msgId,
-            limit: limit,
-            cursor: cursor,
-        };
-        Object.keys(params).map(key => {
-            if (params[key] === null || params[key] === undefined) {
-                delete params[key];
-            }
-        });
-        return this.httpPostJson('cgi-bin/externalcontact/get_groupmsg_task', params);
-    }
-    /**
-     * 获取企业群发成员执行结果
-     * @param msgId 群发消息的id，通过获取群发记录列表接口返回
-     * @param userId 发送成员userid，通过获取群发成员发送任务列表接口返回
-     * @param limit 返回的最大记录数，整型，最大值1000，默认值500，超过最大值时取默认值
-     * @param cursor 用于分页查询的游标，字符串类型，由上一次调用返回，首次调用可不填
-     * @returns
-     */
-    getGroupmsgSendResult(msgId, userId, limit = null, cursor = null) {
-        let params = {
-            msgid: msgId,
-            userid: userId,
-            limit: limit,
-            cursor: cursor,
-        };
-        Object.keys(params).map(key => {
-            if (params[key] === null || params[key] === undefined) {
-                delete params[key];
-            }
-        });
-        return this.httpPostJson('cgi-bin/externalcontact/get_groupmsg_send_result', params);
-    }
-    /**
-     * 发送新客户欢迎语
-     * @param welcomeCode
-     * @param msg
-     * @returns
-     */
-    sendWelcome(welcomeCode, msg) {
-        let formattedMsg = this.formatMessage(msg);
-        let params = (0, Utils_1.merge)((0, Utils_1.merge)({}, formattedMsg), {
-            welcome_code: welcomeCode,
-        });
-        return this.httpPostJson('cgi-bin/externalcontact/send_welcome_msg', params);
-    }
-    formatMessage(data) {
-        let params = (0, Utils_1.merge)({}, data);
-        if (params['text']) {
-            params['text'] = this.formatFields(params['text'], this.textMessage);
-        }
-        if (params['image']) {
-            params['image'] = this.formatFields(params['image'], this.imageMessage);
-        }
-        if (params['link']) {
-            params['link'] = this.formatFields(params['link'], this.linkMessage);
-        }
-        if (params['miniprogram']) {
-            params['miniprogram'] = this.formatFields(params['miniprogram'], this.miniprogramMessage);
-        }
-        return params;
-    }
-    formatFields(data, defaults) {
-        let params = (0, Utils_1.merge)((0, Utils_1.merge)({}, defaults), data);
-        for (let key in params) {
-            if ((0, Utils_1.inArray)(key, this.required) && typeof params[key] == undefined && typeof defaults[key] == undefined) {
-                throw new Error(`Attribute "${key}" can not be empty!`);
-            }
-            params[key] = params[key] || defaults[key];
-        }
-        return params;
-    }
-}
-exports.default = MessageClient;

package/dist/Work/ExternalContact/MessageTemplateClient.d.ts

@@ -1,14 +0,0 @@
-import BaseClient from '../../Core/BaseClient';
-export default class MessageTemplateClient extends BaseClient {
-    protected required: string[];
-    protected textMessage: object;
-    protected imageMessage: object;
-    protected linkMessage: object;
-    protected miniprogramMessage: object;
-    create(msgTemplate: object): Promise<any>;
-    update(templateId: string, msgTemplate: object): Promise<any>;
-    get(templateId: string): Promise<any>;
-    delete(templateId: string): Promise<any>;
-    protected formatMessage(data: object): object;
-    protected formatFields(data: object, defaults: object): object;
-}

package/dist/Work/ExternalContact/MessageTemplateClient.js

@@ -1,78 +0,0 @@
-'use strict';
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const BaseClient_1 = __importDefault(require("../../Core/BaseClient"));
-const Utils_1 = require("../../Core/Utils");
-class MessageTemplateClient extends BaseClient_1.default {
-    constructor() {
-        super(...arguments);
-        this.required = ['title', 'url', 'pic_media_id', 'appid', 'page'];
-        this.textMessage = {
-            content: '',
-        };
-        this.imageMessage = {
-            media_id: '',
-            pic_url: '',
-        };
-        this.linkMessage = {
-            title: '',
-            picurl: '',
-            desc: '',
-            url: '',
-        };
-        this.miniprogramMessage = {
-            title: '',
-            pic_media_id: '',
-            appid: '',
-            page: '',
-        };
-    }
-    create(msgTemplate) {
-        let params = this.formatMessage(msgTemplate);
-        return this.httpPostJson('cgi-bin/externalcontact/group_welcome_template/add', params);
-    }
-    update(templateId, msgTemplate) {
-        let params = this.formatMessage(msgTemplate);
-        params['template_id'] = templateId;
-        return this.httpPostJson('cgi-bin/externalcontact/group_welcome_template/edit', params);
-    }
-    get(templateId) {
-        return this.httpPostJson('cgi-bin/externalcontact/group_welcome_template/get', {
-            template_id: templateId,
-        });
-    }
-    delete(templateId) {
-        return this.httpPostJson('cgi-bin/externalcontact/group_welcome_template/del', {
-            template_id: templateId,
-        });
-    }
-    formatMessage(data) {
-        let params = (0, Utils_1.merge)({}, data);
-        if (params['text']) {
-            params['text'] = this.formatFields(params['text'], this.textMessage);
-        }
-        if (params['image']) {
-            params['image'] = this.formatFields(params['image'], this.imageMessage);
-        }
-        if (params['link']) {
-            params['link'] = this.formatFields(params['link'], this.linkMessage);
-        }
-        if (params['miniprogram']) {
-            params['miniprogram'] = this.formatFields(params['miniprogram'], this.miniprogramMessage);
-        }
-        return params;
-    }
-    formatFields(data, defaults) {
-        let params = (0, Utils_1.merge)((0, Utils_1.merge)({}, defaults), data);
-        for (let key in params) {
-            if ((0, Utils_1.inArray)(key, this.required) && typeof params[key] == undefined && typeof defaults[key] == undefined) {
-                throw new Error(`Attribute "${key}" can not be empty!`);
-            }
-            params[key] = params[key] || defaults[key];
-        }
-        return params;
-    }
-}
-exports.default = MessageTemplateClient;

package/dist/Work/ExternalContact/MomentClient.d.ts

@@ -1,61 +0,0 @@
-import BaseClient from '../../Core/BaseClient';
-export default class MomentClient extends BaseClient {
-    /**
-     * 创建发表任务
-     * @see https://work.weixin.qq.com/api/doc/90000/90135/95094#%E5%88%9B%E5%BB%BA%E5%8F%91%E8%A1%A8%E4%BB%BB%E5%8A%A1
-     * @param params
-     * @returns
-     */
-    createTask(params: object): Promise<any>;
-    /**
-     * 获取任务创建结果
-     * @see https://work.weixin.qq.com/api/doc/90000/90135/95094#%E8%8E%B7%E5%8F%96%E4%BB%BB%E5%8A%A1%E5%88%9B%E5%BB%BA%E7%BB%93%E6%9E%9C
-     * @param jobId
-     * @returns
-     */
-    getTask(jobId: string): Promise<any>;
-    /**
-     * 获取企业全部的发表列表
-     * @see https://open.work.weixin.qq.com/api/doc/90000/90135/93333#获取企业全部的发表列表
-     * @param params
-     * @returns
-     */
-    list(params: object): Promise<any>;
-    /**
-     * 获取客户朋友圈企业发表的列表
-     * @see https://open.work.weixin.qq.com/api/doc/90000/90135/93333#获取客户朋友圈企业发表的列表
-     * @param momentId
-     * @param cursor
-     * @param limit
-     * @returns
-     */
-    getTasks(momentId: string, cursor?: string, limit?: number): Promise<any>;
-    /**
-     * 获取客户朋友圈发表时选择的可见范围
-     * @see https://open.work.weixin.qq.com/api/doc/90000/90135/93333#获取客户朋友圈发表时选择的可见范围
-     * @param momentId
-     * @param userId
-     * @param cursor
-     * @param limit
-     * @returns
-     */
-    getCustomers(momentId: string, userId: string, cursor?: string, limit?: number): Promise<any>;
-    /**
-     * 获取客户朋友圈发表后的可见客户列表
-     * @see https://open.work.weixin.qq.com/api/doc/90000/90135/93333#获取客户朋友圈发表后的可见客户列表
-     * @param momentId
-     * @param userId
-     * @param cursor
-     * @param limit
-     * @returns
-     */
-    getSendResult(momentId: string, userId: string, cursor?: string, limit?: number): Promise<any>;
-    /**
-     * 获取客户朋友圈的互动数据
-     * @see https://open.work.weixin.qq.com/api/doc/90000/90135/93333#获取客户朋友圈的互动数据
-     * @param momentId
-     * @param userId
-     * @returns
-     */
-    getComments(momentId: string, userId: string): Promise<any>;
-}

package/dist/Work/ExternalContact/MomentClient.js

@@ -1,104 +0,0 @@
-'use strict';
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const BaseClient_1 = __importDefault(require("../../Core/BaseClient"));
-class MomentClient extends BaseClient_1.default {
-    /**
-     * 创建发表任务
-     * @see https://work.weixin.qq.com/api/doc/90000/90135/95094#%E5%88%9B%E5%BB%BA%E5%8F%91%E8%A1%A8%E4%BB%BB%E5%8A%A1
-     * @param params
-     * @returns
-     */
-    createTask(params) {
-        return this.httpPostJson('cgi-bin/externalcontact/add_moment_task', params);
-    }
-    /**
-     * 获取任务创建结果
-     * @see https://work.weixin.qq.com/api/doc/90000/90135/95094#%E8%8E%B7%E5%8F%96%E4%BB%BB%E5%8A%A1%E5%88%9B%E5%BB%BA%E7%BB%93%E6%9E%9C
-     * @param jobId
-     * @returns
-     */
-    getTask(jobId) {
-        return this.httpGet('cgi-bin/externalcontact/get_moment_task_result', {
-            jobid: jobId,
-        });
-    }
-    /**
-     * 获取企业全部的发表列表
-     * @see https://open.work.weixin.qq.com/api/doc/90000/90135/93333#获取企业全部的发表列表
-     * @param params
-     * @returns
-     */
-    list(params) {
-        return this.httpPostJson('cgi-bin/externalcontact/get_moment_list', params);
-    }
-    /**
-     * 获取客户朋友圈企业发表的列表
-     * @see https://open.work.weixin.qq.com/api/doc/90000/90135/93333#获取客户朋友圈企业发表的列表
-     * @param momentId
-     * @param cursor
-     * @param limit
-     * @returns
-     */
-    getTasks(momentId, cursor = '', limit = 500) {
-        let params = {
-            moment_id: momentId,
-            cursor,
-            limit,
-        };
-        return this.httpPostJson('cgi-bin/externalcontact/get_moment_task', params);
-    }
-    /**
-     * 获取客户朋友圈发表时选择的可见范围
-     * @see https://open.work.weixin.qq.com/api/doc/90000/90135/93333#获取客户朋友圈发表时选择的可见范围
-     * @param momentId
-     * @param userId
-     * @param cursor
-     * @param limit
-     * @returns
-     */
-    getCustomers(momentId, userId, cursor = '', limit = 500) {
-        let params = {
-            moment_id: momentId,
-            userid: userId,
-            cursor,
-            limit,
-        };
-        return this.httpPostJson('cgi-bin/externalcontact/get_moment_customer_list', params);
-    }
-    /**
-     * 获取客户朋友圈发表后的可见客户列表
-     * @see https://open.work.weixin.qq.com/api/doc/90000/90135/93333#获取客户朋友圈发表后的可见客户列表
-     * @param momentId
-     * @param userId
-     * @param cursor
-     * @param limit
-     * @returns
-     */
-    getSendResult(momentId, userId, cursor = '', limit = 3000) {
-        let params = {
-            moment_id: momentId,
-            userid: userId,
-            cursor,
-            limit,
-        };
-        return this.httpPostJson('cgi-bin/externalcontact/get_moment_send_result', params);
-    }
-    /**
-     * 获取客户朋友圈的互动数据
-     * @see https://open.work.weixin.qq.com/api/doc/90000/90135/93333#获取客户朋友圈的互动数据
-     * @param momentId
-     * @param userId
-     * @returns
-     */
-    getComments(momentId, userId) {
-        let params = {
-            moment_id: momentId,
-            userid: userId,
-        };
-        return this.httpPostJson('cgi-bin/externalcontact/get_moment_comments', params);
-    }
-}
-exports.default = MomentClient;

package/dist/Work/ExternalContact/SchoolClient.d.ts

@@ -1,28 +0,0 @@
-import BaseClient from '../../Core/BaseClient';
-export default class SchoolClient extends BaseClient {
-    createDepartment(name: string, parentId: number, type: number, standardGrade: number, registerYear: number, order: number, departmentAdmins: string[]): Promise<any>;
-    updateDepartment(id: number, name: string, parentId: number, type: number, standardGrade: number, registerYear: number, order: number, departmentAdmins: string[]): Promise<any>;
-    deleteDepartment(id: string): Promise<any>;
-    getDepartments(id: string): Promise<any>;
-    createStudent(userId: string, name: string, department: string[]): Promise<any>;
-    updateStudent(userId: string, name?: string, newUserId?: string, department?: string[]): Promise<any>;
-    deleteStudent(userId: string): Promise<any>;
-    batchCreateStudents(students: any[]): Promise<any>;
-    batchUpdateStudents(students: any[]): Promise<any>;
-    batchDeleteStudents(userIdList: string[]): Promise<any>;
-    createParent(userId: string, mobile: string, toInvite: boolean, children: object[]): Promise<any>;
-    updateParent(userId: string, mobile?: string, newUserId?: string, children?: string[]): Promise<any>;
-    deleteParent(userId: string): Promise<any>;
-    batchCreateParents(parents: any[]): Promise<any>;
-    batchUpdateParents(parents: any[]): Promise<any>;
-    batchDeleteParents(userIdList: string[]): Promise<any>;
-    getUser(userId: string): Promise<any>;
-    getStudents(departmentId: number, fetchChild: boolean): Promise<any>;
-    getSubscribeQrCode(): Promise<any>;
-    setSubscribeMode(mode: number): Promise<any>;
-    getSubscribeMode(): Promise<any>;
-    setTeacherViewMode(mode: number): Promise<any>;
-    getTeacherViewMode(): Promise<any>;
-    convertOpenid(userId: string): Promise<any>;
-    protected filterNullValue(data: object): {};
-}