node-easywechat 2.6.10 → 2.8.0

package/dist/Work/ExternalContact/Client.js

@@ -5,43 +5,105 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const BaseClient_1 = __importDefault(require("../../Core/BaseClient"));
 class ExternalContactClient extends BaseClient_1.default {
+    /**
+     * 获取配置了客户联系功能的成员列表
+     * @see https://work.weixin.qq.com/api/doc#90000/90135/91554
+     * @returns
+     */
     getFollowUsers() {
         return this.httpGet('cgi-bin/externalcontact/get_follow_user_list');
     }
+    /**
+     * 获取外部联系人列表
+     * @see https://work.weixin.qq.com/api/doc#90000/90135/91555
+     * @param userId
+     * @returns
+     */
     list(userId) {
         return this.httpGet('cgi-bin/externalcontact/list', {
             userid: userId,
         });
     }
+    /**
+     * 获取外部联系人详情
+     * @see https://work.weixin.qq.com/api/doc#90000/90135/91556
+     * @param externalUserId
+     * @returns
+     */
     get(externalUserId) {
         return this.httpGet('cgi-bin/externalcontact/get', {
             external_userid: externalUserId,
         });
     }
-    batchGet(userId, cursor = '', limit = 1) {
+    /**
+     * 批量获取客户详情
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92994
+     * @param userIdList
+     * @param cursor
+     * @param limit
+     * @returns
+     */
+    batchGet(userIdList, cursor = '', limit = 1) {
         return this.httpPostJson('cgi-bin/externalcontact/batch/get_by_user', {
-            userid: userId,
+            userid_list: userIdList,
             cursor,
             limit,
         });
     }
-    batchGetByUser(userId, cursor = '', limit = 1) {
+    /**
+     * 批量获取外部联系人详情
+     * @see https://work.weixin.qq.com/api/doc/90001/90143/93010
+     * @param userIdList
+     * @param cursor
+     * @param limit
+     * @returns
+     */
+    batchGetByUser(userIdList, cursor = '', limit = 1) {
         return this.httpPostJson('cgi-bin/externalcontact/batch/get_by_user', {
-            userid: userId,
+            userid_list: userIdList,
             cursor,
             limit,
         });
     }
+    /**
+     * 修改客户备注信息
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92115
+     * @param data
+     * @returns
+     */
     remark(data) {
         return this.httpPostJson('cgi-bin/externalcontact/remark', data);
     }
+    /**
+     * 获取离职成员的客户列表
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92124
+     * @param pageId
+     * @param pageSize
+     * @param cursor
+     * @returns
+     */
     getUnassigned(pageId = 0, pageSize = 1000, cursor = null) {
-        return this.httpPostJson('cgi-bin/externalcontact/get_unassigned_list', {
+        let params = {
             page_id: pageId,
             page_size: pageSize,
             cursor,
+        };
+        Object.keys(params).map(key => {
+            if (params[key] === null || params[key] === undefined) {
+                delete params[key];
+            }
         });
+        return this.httpPostJson('cgi-bin/externalcontact/get_unassigned_list', params);
     }
+    /**
+     * 离职成员的外部联系人再分配
+     * @see https://work.weixin.qq.com/api/doc#90000/90135/91564
+     * @param externalUserId
+     * @param handoverUserId
+     * @param takeoverUserId
+     * @param transferSuccessMessage
+     * @returns
+     */
     transfer(externalUserId, handoverUserId, takeoverUserId, transferSuccessMessage) {
         return this.httpPostJson('cgi-bin/externalcontact/transfer', {
             external_userid: externalUserId,
@@ -50,6 +112,15 @@ class ExternalContactClient extends BaseClient_1.default {
             transfer_success_msg: transferSuccessMessage,
         });
     }
+    /**
+     * 分配在职成员的客户
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92125
+     * @param externalUserId
+     * @param handoverUserId
+     * @param takeoverUserId
+     * @param transferSuccessMessage
+     * @returns
+     */
     transferCustomer(externalUserId, handoverUserId, takeoverUserId, transferSuccessMessage) {
         return this.httpPostJson('cgi-bin/externalcontact/transfer_customer', {
             external_userid: externalUserId,
@@ -58,6 +129,14 @@ class ExternalContactClient extends BaseClient_1.default {
             transfer_success_msg: transferSuccessMessage,
         });
     }
+    /**
+     * 分配离职成员的客户
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/94081
+     * @param externalUserId
+     * @param handoverUserId
+     * @param takeoverUserId
+     * @returns
+     */
     resignedTransferCustomer(externalUserId, handoverUserId, takeoverUserId) {
         return this.httpPostJson('cgi-bin/externalcontact/resigned/transfer_customer', {
             external_userid: externalUserId,
@@ -65,12 +144,27 @@ class ExternalContactClient extends BaseClient_1.default {
             takeover_userid: takeoverUserId,
         });
     }
+    /**
+     * 离职成员的群再分配
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92127
+     * @param chatIds
+     * @param newOwner
+     * @returns
+     */
     transferGroupChat(chatIds, newOwner) {
         return this.httpPostJson('cgi-bin/externalcontact/groupchat/transfer', {
             chat_id_list: chatIds,
             new_owner: newOwner,
         });
     }
+    /**
+     * 查询客户接替状态
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/94082
+     * @param handoverUserId
+     * @param takeoverUserId
+     * @param cursor
+     * @returns
+     */
     transferResult(handoverUserId, takeoverUserId, cursor = null) {
         return this.httpPostJson('cgi-bin/externalcontact/resigned/transfer_result', {
             handover_userid: handoverUserId,
@@ -78,6 +172,14 @@ class ExternalContactClient extends BaseClient_1.default {
             cursor,
         });
     }
+    /**
+     * 查询客户接替结果
+     * @see https://work.weixin.qq.com/api/doc/90001/90143/93009
+     * @param externalUserId
+     * @param handoverUserId
+     * @param takeoverUserId
+     * @returns
+     */
     getTransferResult(externalUserId, handoverUserId, takeoverUserId) {
         return this.httpPostJson('cgi-bin/externalcontact/get_transfer_result', {
             external_userid: externalUserId,
@@ -85,23 +187,58 @@ class ExternalContactClient extends BaseClient_1.default {
             takeover_userid: takeoverUserId,
         });
     }
+    /**
+     * 获取客户群列表
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92120
+     * @param data
+     * @returns
+     */
     getGroupChats(data) {
         return this.httpPostJson('cgi-bin/externalcontact/groupchat/list', data);
     }
-    getGroupChat(chatId) {
+    /**
+     * 获取客户群详情
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92122
+     * @param chatId
+     * @param needName
+     * @returns
+     */
+    getGroupChat(chatId, needName = 0) {
         return this.httpPostJson('cgi-bin/externalcontact/groupchat/get', {
             chat_id: chatId,
+            need_name: needName,
         });
     }
+    /**
+     * 获取企业标签库
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92117#获取企业标签库
+     * @param tagIds
+     * @param groupIds
+     * @returns
+     */
     getCorpTags(tagIds, groupIds) {
         return this.httpPostJson('cgi-bin/externalcontact/get_corp_tag_list', {
             tag_id: tagIds,
             group_id: groupIds,
         });
     }
+    /**
+     * 添加企业客户标签
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92117#添加企业客户标签
+     * @param data
+     * @returns
+     */
     addCorpTag(data) {
         return this.httpPostJson('cgi-bin/externalcontact/add_corp_tag', data);
     }
+    /**
+     * 编辑企业客户标签
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92117#编辑企业客户标签
+     * @param id
+     * @param name
+     * @param order
+     * @returns
+     */
     updateCorpTag(id, name = null, order = null) {
         let params = {
             id,
@@ -114,12 +251,25 @@ class ExternalContactClient extends BaseClient_1.default {
         }
         return this.httpPostJson('cgi-bin/externalcontact/edit_corp_tag', params);
     }
+    /**
+     * 删除企业客户标签
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92117#删除企业客户标签
+     * @param tagId
+     * @param groupId
+     * @returns
+     */
     deleteCorpTag(tagId, groupId) {
         return this.httpPostJson('cgi-bin/externalcontact/del_corp_tag', {
             tag_id: tagId,
             group_id: groupId,
         });
     }
+    /**
+     * 编辑客户企业标签
+     * @see https://work.weixin.qq.com/api/doc/90000/90135/92118
+     * @param data
+     * @returns
+     */
     markTags(data) {
         return this.httpPostJson('cgi-bin/externalcontact/mark_tag', data);
     }

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

@@ -5,8 +5,53 @@ export default class MessageClient extends BaseClient {
     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

@@ -26,15 +26,101 @@ class MessageClient extends BaseClient_1.default {
             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 = Utils_1.merge(Utils_1.merge({}, formattedMsg), {

package/dist/index.d.ts

@@ -4,6 +4,7 @@ import MiniProgram from './MiniProgram/Application';
 import OpenPlatform from './OpenPlatform/Application';
 import Payment from './Payment/Application';
 import Work from './Work/Application';
+import MicroMerchant from './MicroMerchant/Application';
 import CacheInterface from './Core/Contracts/CacheInterface';
 import FinallResult from './Core/Decorators/FinallResult';
 import TerminateResult from './Core/Decorators/TerminateResult';
@@ -23,6 +24,7 @@ declare function getInstance(service: 'MiniProgram', config?: EasyWechatConfig):
 declare function getInstance(service: 'OpenPlatform', config?: EasyWechatConfig): OpenPlatform;
 declare function getInstance(service: 'Payment', config?: EasyWechatConfig): Payment;
 declare function getInstance(service: 'Work', config?: EasyWechatConfig): Work;
+declare function getInstance(service: 'MicroMerchant', config?: EasyWechatConfig): MicroMerchant;
 declare class EasyWechat {
     /**
      * 实例工厂
@@ -52,6 +54,10 @@ declare class EasyWechat {
          * 企业微信类
          */
         Work: typeof Work;
+        /**
+         * 小微商户类
+         */
+        MicroMerchant: typeof MicroMerchant;
         /**
          * 通用获取实例方法
          * @param service 服务名称，可选值：'BaseService' | 'OfficialAccount' | 'MiniProgram' | 'OpenPlatform' | 'Payment'

package/dist/index.js

@@ -28,6 +28,7 @@ const Application_3 = __importDefault(require("./MiniProgram/Application"));
 const Application_4 = __importDefault(require("./OpenPlatform/Application"));
 const Application_5 = __importDefault(require("./Payment/Application"));
 const Application_6 = __importDefault(require("./Work/Application"));
+const Application_7 = __importDefault(require("./MicroMerchant/Application"));
 const CacheInterface_1 = __importDefault(require("./Core/Contracts/CacheInterface"));
 const FinallResult_1 = __importDefault(require("./Core/Decorators/FinallResult"));
 const TerminateResult_1 = __importDefault(require("./Core/Decorators/TerminateResult"));
@@ -63,6 +64,7 @@ class EasyWechat {
             OpenPlatform: Application_4.default,
             Payment: Application_5.default,
             Work: Application_6.default,
+            MicroMerchant: Application_7.default,
             getInstance: getInstance,
         };
         this.CacheInterface = CacheInterface_1.default;

package/node-easywechat.file_cache.easywechat.kernel.access_token.8a9684b45da7de42a06a70ba01a7005a.cache

@@ -1 +1 @@
-{"data":{"errcode":0,"errmsg":"ok","access_token":"moke-token","expires_in":7200},"lifeTime":1628010086}
+{"data":{"errcode":0,"errmsg":"ok","access_token":"moke-token","expires_in":7200},"lifeTime":1641409629}

package/node-easywechat.file_cache.easywechat.kernel.access_token.c3d06edaf326aad75d32f31348df787a.cache

@@ -1 +1 @@
-{"data":{"errcode":0,"errmsg":"ok"},"lifeTime":1628010086}
+{"data":{"errcode":0,"errmsg":"ok"},"lifeTime":1641409628}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-easywechat",
-  "version": "2.6.10",
+  "version": "2.8.0",
   "description": "EasyWechat SDK for Node.js (NOT OFFICIAL)",
   "main": "dist/index.js",
   "scripts": {
@@ -27,11 +27,10 @@
     "typescript": "^4.2.3"
   },
   "dependencies": {
-    "axios": "^0.21.1",
+    "axios": "^0.21.4",
     "form-data": "^4.0.0",
-    "node-rsa": "^1.1.1",
-    "node-socialite": "^1.2.3",
-    "qs": "^6.9.6",
+    "node-socialite": "^1.2.4",
+    "qs": "^6.10.1",
     "raw-body": "^2.4.1",
     "xml2js": "^0.4.23"
   }