node-easywechat 2.7.1 → 2.8.2

package/dist/Work/Application.js

@@ -17,6 +17,7 @@ const WorkBase_1 = __importDefault(require("./Base/WorkBase"));
 const OAClient_1 = __importDefault(require("./OA/OAClient"));
 const AccessToken_1 = __importDefault(require("./Auth/AccessToken"));
 const AgentClient_1 = __importDefault(require("./Agent/AgentClient"));
+const WorkbenchClient_1 = __importDefault(require("./Agent/WorkbenchClient"));
 const CalendarClient_1 = __importDefault(require("./Calendar/CalendarClient"));
 const ChatClient_1 = __importDefault(require("./Chat/ChatClient"));
 const DepartmentClient_1 = __importDefault(require("./Department/DepartmentClient"));
@@ -24,6 +25,9 @@ const GroupRobotClient_1 = __importDefault(require("./GroupRobot/GroupRobotClien
 const Messenger_1 = __importDefault(require("./GroupRobot/Messenger"));
 const InvoiceClient_1 = __importDefault(require("./Invoice/InvoiceClient"));
 const JssdkClient_1 = __importDefault(require("./Jssdk/JssdkClient"));
+const KfAccountClient_1 = __importDefault(require("./Kf/KfAccountClient"));
+const KfMessageClient_1 = __importDefault(require("./Kf/KfMessageClient"));
+const KfServicerClient_1 = __importDefault(require("./Kf/KfServicerClient"));
 const LiveClient_1 = __importDefault(require("./Live/LiveClient"));
 const MediaClient_1 = __importDefault(require("./Media/MediaClient"));
 const MenuClient_1 = __importDefault(require("./Menu/MenuClient"));
@@ -56,6 +60,7 @@ class Work extends BaseApplication_1.default {
         this.oa = null;
         this.access_token = null;
         this.agent = null;
+        this.agent_workbench = null;
         this.base = null;
         this.calendar = null;
         this.chat = null;
@@ -72,6 +77,9 @@ class Work extends BaseApplication_1.default {
         this.group_robot_messenger = null;
         this.invoice = null;
         this.jssdk = null;
+        this.kf_account = null;
+        this.kf_message = null;
+        this.kf_servicer = null;
         this.live = null;
         this.media = null;
         this.menu = null;
@@ -101,6 +109,9 @@ class Work extends BaseApplication_1.default {
         this.offsetSet('agent', function (app) {
             return new AgentClient_1.default(app);
         });
+        this.offsetSet('agent_workbench', function (app) {
+            return new WorkbenchClient_1.default(app);
+        });
         this.offsetSet('calendar', function (app) {
             return new CalendarClient_1.default(app);
         });
@@ -146,6 +157,15 @@ class Work extends BaseApplication_1.default {
         this.offsetSet('jssdk', function (app) {
             return new JssdkClient_1.default(app);
         });
+        this.offsetSet('kf_account', function (app) {
+            return new KfAccountClient_1.default(app);
+        });
+        this.offsetSet('kf_message', function (app) {
+            return new KfMessageClient_1.default(app);
+        });
+        this.offsetSet('kf_servicer', function (app) {
+            return new KfServicerClient_1.default(app);
+        });
         this.offsetSet('live', function (app) {
             return new LiveClient_1.default(app);
         });

package/dist/Work/Calendar/CalendarClient.js

@@ -13,7 +13,7 @@ class CalendarClient extends BaseClient_1.default {
         return this.httpPostJson('cgi-bin/oa/calendar/add', params);
     }
     update(id, calendar) {
-        let params = Utils_1.merge({
+        let params = (0, Utils_1.merge)({
             cal_id: id,
         }, calendar);
         return this.httpPostJson('cgi-bin/oa/calendar/update', params);

package/dist/Work/Chat/ChatClient.js

@@ -15,7 +15,7 @@ class ChatClient extends BaseClient_1.default {
         return this.httpPostJson('cgi-bin/appchat/create', data);
     }
     update(chatId, data) {
-        let params = Utils_1.merge({
+        let params = (0, Utils_1.merge)({
             chatid: chatId,
         }, data);
         return this.httpPostJson('cgi-bin/appchat/update', params);

package/dist/Work/CorpGroup/CorpGroupClient.d.ts

@@ -1,6 +1,40 @@
 import BaseClient from '../../Core/BaseClient';
 export default class CorpGroupClient extends BaseClient {
+    /**
+     * 获取应用共享信息
+     * @see https://open.work.weixin.qq.com/api/doc/90000/90135/93403
+     * @param agentId
+     * @returns
+     */
     getAppShareInfo(agentId: number): Promise<any>;
+    /**
+     * 获取下级企业的access_token
+     * @see https://open.work.weixin.qq.com/api/doc/90000/90135/93359
+     * @param corpId
+     * @param agentId
+     * @returns
+     */
     getToken(corpId: string, agentId: number): Promise<any>;
+    /**
+     * 获取下级企业的小程序session
+     * @see https://open.work.weixin.qq.com/api/doc/90000/90135/93355
+     * @param userId
+     * @param sessionKey
+     * @returns
+     */
     getMiniProgramTransferSession(userId: string, sessionKey: number): Promise<any>;
+    /**
+     * 将明文corpid转换为第三方应用获取的corpid（仅限第三方服务商，转换已获授权企业的corpid）
+     * @see https://open.work.weixin.qq.com/api/doc/90001/90143/95327#1.4%20corpid%E8%BD%AC%E6%8D%A2
+     * @param corpId
+     * @returns
+     */
+    getOpenCorpid(corpId: string): Promise<any>;
+    /**
+     * 将自建应用获取的userid转换为第三方应用获取的userid（仅代开发自建应用或第三方应用可调用）
+     * @see https://open.work.weixin.qq.com/api/doc/90001/90143/95327#2.4%20userid%E7%9A%84%E8%BD%AC%E6%8D%A2
+     * @param useridList
+     * @returns
+     */
+    batchUseridToOpenUserid(useridList: string[]): Promise<any>;
 }

package/dist/Work/CorpGroup/CorpGroupClient.js

@@ -5,22 +5,64 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const BaseClient_1 = __importDefault(require("../../Core/BaseClient"));
 class CorpGroupClient extends BaseClient_1.default {
+    /**
+     * 获取应用共享信息
+     * @see https://open.work.weixin.qq.com/api/doc/90000/90135/93403
+     * @param agentId
+     * @returns
+     */
     getAppShareInfo(agentId) {
         return this.httpPostJson('cgi-bin/corpgroup/corp/list_app_share_info', {
             agentid: agentId,
         });
     }
+    /**
+     * 获取下级企业的access_token
+     * @see https://open.work.weixin.qq.com/api/doc/90000/90135/93359
+     * @param corpId
+     * @param agentId
+     * @returns
+     */
     getToken(corpId, agentId) {
         return this.httpPostJson('cgi-bin/corpgroup/corp/gettoken', {
             corpid: corpId,
             agentid: agentId,
         });
     }
+    /**
+     * 获取下级企业的小程序session
+     * @see https://open.work.weixin.qq.com/api/doc/90000/90135/93355
+     * @param userId
+     * @param sessionKey
+     * @returns
+     */
     getMiniProgramTransferSession(userId, sessionKey) {
         return this.httpPostJson('cgi-bin/miniprogram/transfer_session', {
             userid: userId,
             session_key: sessionKey,
         });
     }
+    /**
+     * 将明文corpid转换为第三方应用获取的corpid（仅限第三方服务商，转换已获授权企业的corpid）
+     * @see https://open.work.weixin.qq.com/api/doc/90001/90143/95327#1.4%20corpid%E8%BD%AC%E6%8D%A2
+     * @param corpId
+     * @returns
+     */
+    getOpenCorpid(corpId) {
+        return this.httpPostJson('cgi-bin/corp/to_open_corpid', {
+            corpid: corpId,
+        });
+    }
+    /**
+     * 将自建应用获取的userid转换为第三方应用获取的userid（仅代开发自建应用或第三方应用可调用）
+     * @see https://open.work.weixin.qq.com/api/doc/90001/90143/95327#2.4%20userid%E7%9A%84%E8%BD%AC%E6%8D%A2
+     * @param useridList
+     * @returns
+     */
+    batchUseridToOpenUserid(useridList) {
+        return this.httpPostJson('cgi-bin/batch/userid_to_openuserid', {
+            userid_list: useridList,
+        });
+    }
 }
 exports.default = CorpGroupClient;

package/dist/Work/Department/DepartmentClient.js

@@ -10,7 +10,7 @@ class DepartmentClient extends BaseClient_1.default {
         return this.httpPostJson('cgi-bin/department/create', data);
     }
     update(id, data) {
-        let params = Utils_1.merge({
+        let params = (0, Utils_1.merge)({
             id: id,
         }, data);
         return this.httpPostJson('cgi-bin/department/update', params);

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

@@ -1,23 +1,222 @@
+/// <reference types="node" />
 import BaseClient from '../../Core/BaseClient';
+import Stream from 'stream';
 export default class ExternalContactClient extends BaseClient {
+    /**
+     * 获取配置了客户联系功能的成员列表
+     * @see https://work.weixin.qq.com/api/doc#90000/90135/91554
+     * @returns
+     */
     getFollowUsers(): Promise<any>;
+    /**
+     * 获取外部联系人列表
+     * @see https://work.weixin.qq.com/api/doc#90000/90135/91555
+     * @param userId
+     * @returns
+     */
     list(userId: string): Promise<any>;
+    /**
+     * 获取外部联系人详情
+     * @see https://work.weixin.qq.com/api/doc#90000/90135/91556
+     * @param externalUserId
+     * @returns
+     */
     get(externalUserId: string): Promise<any>;
-    batchGet(userId: string, cursor?: string, limit?: number): Promise<any>;
-    batchGetByUser(userId: string, cursor?: string, limit?: number): Promise<any>;
+    /**
+     * 批量获取客户详情
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92994
+     * @param userIdList
+     * @param cursor
+     * @param limit
+     * @returns
+     */
+    batchGet(userIdList: string[], cursor?: string, limit?: number): Promise<any>;
+    /**
+     * 批量获取外部联系人详情
+     * @see https://work.weixin.qq.com/api/doc/90001/90143/93010
+     * @param userIdList
+     * @param cursor
+     * @param limit
+     * @returns
+     */
+    batchGetByUser(userIdList: string[], cursor?: string, limit?: number): Promise<any>;
+    /**
+     * 修改客户备注信息
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92115
+     * @param data
+     * @returns
+     */
     remark(data: object): Promise<any>;
+    /**
+     * 获取离职成员的客户列表
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92124
+     * @param pageId
+     * @param pageSize
+     * @param cursor
+     * @returns
+     */
     getUnassigned(pageId?: number, pageSize?: number, cursor?: string): Promise<any>;
+    /**
+     * 离职成员的外部联系人再分配
+     * @see https://work.weixin.qq.com/api/doc#90000/90135/91564
+     * @param externalUserId
+     * @param handoverUserId
+     * @param takeoverUserId
+     * @param transferSuccessMessage
+     * @returns
+     */
     transfer(externalUserId: string, handoverUserId: string, takeoverUserId: string, transferSuccessMessage: string): Promise<any>;
+    /**
+     * 分配在职成员的客户
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92125
+     * @param externalUserId
+     * @param handoverUserId
+     * @param takeoverUserId
+     * @param transferSuccessMessage
+     * @returns
+     */
     transferCustomer(externalUserId: string, handoverUserId: string, takeoverUserId: string, transferSuccessMessage: string): Promise<any>;
+    /**
+     * 分配离职成员的客户
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/94081
+     * @param externalUserId
+     * @param handoverUserId
+     * @param takeoverUserId
+     * @returns
+     */
     resignedTransferCustomer(externalUserId: string, handoverUserId: string, takeoverUserId: string): Promise<any>;
+    /**
+     * 离职成员的群再分配
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92127
+     * @param chatIds
+     * @param newOwner
+     * @returns
+     */
     transferGroupChat(chatIds: string[], newOwner: string): Promise<any>;
+    /**
+     * 查询客户接替状态
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/94082
+     * @param handoverUserId
+     * @param takeoverUserId
+     * @param cursor
+     * @returns
+     */
     transferResult(handoverUserId: string, takeoverUserId: string, cursor?: string): Promise<any>;
+    /**
+     * 查询客户接替结果
+     * @see https://work.weixin.qq.com/api/doc/90001/90143/93009
+     * @param externalUserId
+     * @param handoverUserId
+     * @param takeoverUserId
+     * @returns
+     */
     getTransferResult(externalUserId: string, handoverUserId: string, takeoverUserId: string): Promise<any>;
+    /**
+     * 获取客户群列表
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92120
+     * @param data
+     * @returns
+     */
     getGroupChats(data: object): Promise<any>;
-    getGroupChat(chatId: string): Promise<any>;
+    /**
+     * 获取客户群详情
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92122
+     * @param chatId
+     * @param needName
+     * @returns
+     */
+    getGroupChat(chatId: string, needName?: number): Promise<any>;
+    /**
+     * 获取企业标签库
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92117#获取企业标签库
+     * @param tagIds
+     * @param groupIds
+     * @returns
+     */
     getCorpTags(tagIds: string[], groupIds: string[]): Promise<any>;
+    /**
+     * 添加企业客户标签
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92117#添加企业客户标签
+     * @param data
+     * @returns
+     */
     addCorpTag(data: object): Promise<any>;
+    /**
+     * 编辑企业客户标签
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92117#编辑企业客户标签
+     * @param id
+     * @param name
+     * @param order
+     * @returns
+     */
     updateCorpTag(id: string, name?: string, order?: number): Promise<any>;
+    /**
+     * 删除企业客户标签
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92117#删除企业客户标签
+     * @param tagId
+     * @param groupId
+     * @returns
+     */
     deleteCorpTag(tagId: string[], groupId: string[]): Promise<any>;
+    /**
+     * 编辑客户企业标签
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92118
+     * @param data
+     * @returns
+     */
     markTags(data: object): Promise<any>;
+    /**
+     * 外部联系人unionid转换
+     * @see https://work.weixin.qq.com/api/doc/90001/90143/93274
+     * @param unionid 微信客户的unionid
+     * @param openid 微信客户的openid
+     * @returns
+     */
+    unionidToExternalUserid(unionid?: string, openid?: string): Promise<any>;
+    /**
+     * 代开发应用external_userid转换
+     * @see https://work.weixin.qq.com/api/doc/90001/90143/95195
+     * @param unionid 微信客户的unionid
+     * @returns
+     */
+    toServiceExternalUserid(externalUserid: string): Promise<any>;
+    /**
+     * 转换external_userid
+     * @see https://open.work.weixin.qq.com/api/doc/90001/90143/95327#%E8%BD%AC%E6%8D%A2external_userid
+     * @param externalUserIds
+     * @returns
+     */
+    getNewExternalUserid(externalUserIds: string[]): Promise<any>;
+    /**
+     * 设置迁移完成
+     * @see https://open.work.weixin.qq.com/api/doc/90001/90143/95327#%E8%AE%BE%E7%BD%AE%E8%BF%81%E7%A7%BB%E5%AE%8C%E6%88%90
+     * @param corpid
+     * @returns
+     */
+    finishExternalUseridMigration(corpid: string): Promise<any>;
+    /**
+     * unionid查询external_userid
+     * @see https://open.work.weixin.qq.com/api/doc/90001/90143/95327#4.2%20unionid%E6%9F%A5%E8%AF%A2external_userid
+     * @param unionid
+     * @param openid
+     * @param corpid
+     * @returns
+     */
+    unionidToexternalUserid3rd(unionid: string, openid: string, corpid?: string): Promise<any>;
+    /**
+     * 客户群opengid转换
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/94822
+     * @param opengid
+     * @returns
+     */
+    opengidToChatid(opengid: string): Promise<any>;
+    /**
+     * 上传附件资源
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/95098
+     * @param path
+     * @param mediaType
+     * @param attachmentType
+     * @returns
+     */
+    uploadAttachment(path: string | Stream.Readable, mediaType: string, attachmentType: string): Promise<any>;
 }