node-easywechat 2.9.1 → 2.9.2

package/README.md

@@ -20,8 +20,6 @@
 
 绝大部分API都可以根据 [EasyWechat 的文档](https://www.easywechat.com/5.x/) 来使用。小部分（如获取请求相关数据、返回响应数据、支付证书等）的操作，由于语言环境的不同，会有不同处理。具体可以查看 [node-easywechat-demo](https://github.com/hpyer/node-easywechat-demo/) 以及下方的[自定义模块说明](#自定义模块模块替换使用方法) 。如果仍有疑问，请提issue，谢谢～
 
-更多信息详见：[API文档](docs/README.md)
-
 ```js
 // 公众号
 let officialAccount = new EasyWechat.Factory.OfficialAccount({

package/dist/MiniProgram/Express/ExpressClient.d.ts

@@ -1,5 +1,9 @@
 import BaseClient from '../../Core/BaseClient';
 export default class ExpressClient extends BaseClient {
+    /**
+     * 绑定、解绑物流账号
+     */
+    bind(params: object): Promise<any>;
     /**
      * 获取支持的快递公司列表
      */
@@ -44,4 +48,18 @@ export default class ExpressClient extends BaseClient {
      * @param openid 用户openid
      */
     unbindPrinter(openid?: string): Promise<any>;
+    /**
+     * 创建退货 ID
+     */
+    createReturn(params?: object): Promise<any>;
+    /**
+     * 查询退货 ID 状态
+     * @param returnId 退货id
+     */
+    getReturn(returnId?: string): Promise<any>;
+    /**
+     * 解绑退货 ID
+     * @param returnId 退货id
+     */
+    unbindReturn(returnId?: string): Promise<any>;
 }

package/dist/MiniProgram/Express/ExpressClient.js

@@ -5,6 +5,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const BaseClient_1 = __importDefault(require("../../Core/BaseClient"));
 class ExpressClient extends BaseClient_1.default {
+    /**
+     * 绑定、解绑物流账号
+     */
+    bind(params) {
+        if (!params['type'] || !params['biz_id'] || !params['delivery_id']) {
+            throw new Error('Missing parameter.');
+        }
+        return this.httpPostJson('cgi-bin/express/business/account/bind', params);
+    }
     /**
      * 获取支持的快递公司列表
      */
@@ -76,5 +85,29 @@ class ExpressClient extends BaseClient_1.default {
             openid: openid,
         });
     }
+    /**
+     * 创建退货 ID
+     */
+    createReturn(params = {}) {
+        return this.httpPostJson('cgi-bin/express/delivery/return/add', params);
+    }
+    /**
+     * 查询退货 ID 状态
+     * @param returnId 退货id
+     */
+    getReturn(returnId = '') {
+        return this.httpPostJson('cgi-bin/express/delivery/return/get', {
+            return_id: returnId,
+        });
+    }
+    /**
+     * 解绑退货 ID
+     * @param returnId 退货id
+     */
+    unbindReturn(returnId = '') {
+        return this.httpPostJson('cgi-bin/express/delivery/return/unbind', {
+            return_id: returnId,
+        });
+    }
 }
 exports.default = ExpressClient;

package/dist/MiniProgram/Shop/OrderClient.d.ts

@@ -22,6 +22,13 @@ export default class OrderClient extends BaseClient {
      * @returns
      */
     get(openid: string, orderIds: object): Promise<any>;
+    /**
+     * 获取订单列表
+     * @see https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/ministore/minishopopencomponent2/API/order/get_order_list.html
+     * @param params 查询参数
+     * @returns
+     */
+    getList(params: object): Promise<any>;
     /**
      * 同步订单支付结果
      * @see https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/ministore/minishopopencomponent2/API/order/pay_order.html

package/dist/MiniProgram/Shop/OrderClient.js

@@ -38,6 +38,15 @@ class OrderClient extends BaseClient_1.default {
             openid,
         }));
     }
+    /**
+     * 获取订单列表
+     * @see https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/ministore/minishopopencomponent2/API/order/get_order_list.html
+     * @param params 查询参数
+     * @returns
+     */
+    getList(params) {
+        return this.httpPostJson('shop/order/get_list', params);
+    }
     /**
      * 同步订单支付结果
      * @see https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/ministore/minishopopencomponent2/API/order/pay_order.html

package/dist/OfficialAccount/Base/OfficialAccountBase.d.ts

@@ -1,5 +1,10 @@
 import BaseClient from '../../Core/BaseClient';
 export default class OfficialAccountBase extends BaseClient {
+    /**
+     * 查询openAPI调用次数
+     * @param cgiPath api的请求地址，例如"/cgi-bin/message/custom/send";不要前缀“https://api.weixin.qq.com” ，也不要漏了"/",否则都会76003的报错
+     */
+    getQuota(cgiPath: string): Promise<any>;
     /**
      * 清理接口调用次数
      * 此接口官方有每月调用限制，不可随意调用

package/dist/OfficialAccount/Base/OfficialAccountBase.js

@@ -6,6 +6,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const BaseClient_1 = __importDefault(require("../../Core/BaseClient"));
 const Utils_1 = require("../../Core/Utils");
 class OfficialAccountBase extends BaseClient_1.default {
+    /**
+     * 查询openAPI调用次数
+     * @param cgiPath api的请求地址，例如"/cgi-bin/message/custom/send";不要前缀“https://api.weixin.qq.com” ，也不要漏了"/",否则都会76003的报错
+     */
+    getQuota(cgiPath) {
+        return this.httpPostJson('cgi-bin/openapi/quota/get', {
+            cgi_path: cgiPath,
+        });
+    }
     /**
      * 清理接口调用次数
      * 此接口官方有每月调用限制，不可随意调用

package/dist/Work/Application.d.ts

@@ -28,6 +28,7 @@ import TagClient from './User/TagClient';
 import MiniProgram from './MiniProgram/Application';
 import ExternalContactClient from './ExternalContact/Client';
 import ExternalContactWayClient from './ExternalContact/ContactWayClient';
+import ExternalGroupChatWayClient from './ExternalContact/GroupChatWayClient';
 import ExternalStatisticsClient from './ExternalContact/StatisticsClient';
 import ExternalMessageClient from './ExternalContact/MessageClient';
 import ExternalMessageTemplateClient from './ExternalContact/MessageTemplateClient';
@@ -48,6 +49,7 @@ export default class Work extends BaseApplication {
     department: DepartmentClient;
     external_contact: ExternalContactClient;
     contact_way: ExternalContactWayClient;
+    group_chat_way: ExternalGroupChatWayClient;
     external_contact_statistics: ExternalStatisticsClient;
     external_contact_message: ExternalMessageClient;
     external_contact_message_template: ExternalMessageTemplateClient;

package/dist/Work/Application.js

@@ -42,6 +42,7 @@ const FinallResult_1 = __importDefault(require("../Core/Decorators/FinallResult"
 const Application_1 = __importDefault(require("./MiniProgram/Application"));
 const Client_1 = __importDefault(require("./ExternalContact/Client"));
 const ContactWayClient_1 = __importDefault(require("./ExternalContact/ContactWayClient"));
+const GroupChatWayClient_1 = __importDefault(require("./ExternalContact/GroupChatWayClient"));
 const StatisticsClient_1 = __importDefault(require("./ExternalContact/StatisticsClient"));
 const MessageClient_2 = __importDefault(require("./ExternalContact/MessageClient"));
 const MessageTemplateClient_1 = __importDefault(require("./ExternalContact/MessageTemplateClient"));
@@ -68,6 +69,7 @@ class Work extends BaseApplication_1.default {
         this.department = null;
         this.external_contact = null;
         this.contact_way = null;
+        this.group_chat_way = null;
         this.external_contact_statistics = null;
         this.external_contact_message = null;
         this.external_contact_message_template = null;
@@ -130,6 +132,9 @@ class Work extends BaseApplication_1.default {
         this.offsetSet('contact_way', function (app) {
             return new ContactWayClient_1.default(app);
         });
+        this.offsetSet('group_chat_way', function (app) {
+            return new GroupChatWayClient_1.default(app);
+        });
         this.offsetSet('external_contact_statistics', function (app) {
             return new StatisticsClient_1.default(app);
         });

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

@@ -0,0 +1,32 @@
+import BaseClient from '../../Core/BaseClient';
+export default class GroupChatWayClient extends BaseClient {
+    /**
+     * 配置客户群进群方式
+     * @see https://developer.work.weixin.qq.com/document/path/92229#%E9%85%8D%E7%BD%AE%E5%AE%A2%E6%88%B7%E7%BE%A4%E8%BF%9B%E7%BE%A4%E6%96%B9%E5%BC%8F
+     * @param params
+     * @returns
+     */
+    create(params: object): Promise<any>;
+    /**
+     * 获取客户群进群方式配置
+     * @see https://developer.work.weixin.qq.com/document/path/92229#%E8%8E%B7%E5%8F%96%E5%AE%A2%E6%88%B7%E7%BE%A4%E8%BF%9B%E7%BE%A4%E6%96%B9%E5%BC%8F%E9%85%8D%E7%BD%AE
+     * @param configId
+     * @returns
+     */
+    get(configId: string): Promise<any>;
+    /**
+     * 更新客户群进群方式配置
+     * @see https://developer.work.weixin.qq.com/document/path/92229#%E6%9B%B4%E6%96%B0%E5%AE%A2%E6%88%B7%E7%BE%A4%E8%BF%9B%E7%BE%A4%E6%96%B9%E5%BC%8F%E9%85%8D%E7%BD%AE
+     * @param configId
+     * @param config
+     * @returns
+     */
+    update(configId: string, config: object): Promise<any>;
+    /**
+     * 删除客户群进群方式配置
+     * @see https://developer.work.weixin.qq.com/document/path/92229#%E5%88%A0%E9%99%A4%E5%AE%A2%E6%88%B7%E7%BE%A4%E8%BF%9B%E7%BE%A4%E6%96%B9%E5%BC%8F%E9%85%8D%E7%BD%AE
+     * @param configId
+     * @returns
+     */
+    delete(configId: string): Promise<any>;
+}

package/dist/Work/ExternalContact/GroupChatWayClient.js

@@ -0,0 +1,54 @@
+'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 GroupChatWayClient extends BaseClient_1.default {
+    /**
+     * 配置客户群进群方式
+     * @see https://developer.work.weixin.qq.com/document/path/92229#%E9%85%8D%E7%BD%AE%E5%AE%A2%E6%88%B7%E7%BE%A4%E8%BF%9B%E7%BE%A4%E6%96%B9%E5%BC%8F
+     * @param params
+     * @returns
+     */
+    create(params) {
+        return this.httpPostJson('cgi-bin/externalcontact/groupchat/add_join_way', params);
+    }
+    /**
+     * 获取客户群进群方式配置
+     * @see https://developer.work.weixin.qq.com/document/path/92229#%E8%8E%B7%E5%8F%96%E5%AE%A2%E6%88%B7%E7%BE%A4%E8%BF%9B%E7%BE%A4%E6%96%B9%E5%BC%8F%E9%85%8D%E7%BD%AE
+     * @param configId
+     * @returns
+     */
+    get(configId) {
+        return this.httpGet('cgi-bin/externalcontact/groupchat/get_join_way', {
+            config_id: configId,
+        });
+    }
+    /**
+     * 更新客户群进群方式配置
+     * @see https://developer.work.weixin.qq.com/document/path/92229#%E6%9B%B4%E6%96%B0%E5%AE%A2%E6%88%B7%E7%BE%A4%E8%BF%9B%E7%BE%A4%E6%96%B9%E5%BC%8F%E9%85%8D%E7%BD%AE
+     * @param configId
+     * @param config
+     * @returns
+     */
+    update(configId, config) {
+        let params = (0, Utils_1.merge)({
+            config_id: configId,
+        }, config);
+        return this.httpPostJson('cgi-bin/externalcontact/groupchat/update_join_way', params);
+    }
+    /**
+     * 删除客户群进群方式配置
+     * @see https://developer.work.weixin.qq.com/document/path/92229#%E5%88%A0%E9%99%A4%E5%AE%A2%E6%88%B7%E7%BE%A4%E8%BF%9B%E7%BE%A4%E6%96%B9%E5%BC%8F%E9%85%8D%E7%BD%AE
+     * @param configId
+     * @returns
+     */
+    delete(configId) {
+        return this.httpGet('cgi-bin/externalcontact/groupchat/del_join_way', {
+            config_id: configId,
+        });
+    }
+}
+exports.default = GroupChatWayClient;

package/package.json

@@ -1,11 +1,10 @@
 {
   "name": "node-easywechat",
-  "version": "2.9.1",
+  "version": "2.9.2",
   "description": "EasyWechat SDK for Node.js (NOT OFFICIAL)",
   "main": "dist/index.js",
   "scripts": {
     "build": "rm -rf dist && npx tsc",
-    "docs": "rm -rf doc && npx typedoc --out docs --plugin typedoc-plugin-markdown ./src/",
     "test": "npx mocha ./test/**/*.js"
   },
   "repository": {
@@ -22,8 +21,6 @@
     "@types/node": "^17.0.8",
     "mocha": "^9.2.0",
     "sinon": "^12.0.1",
-    "typedoc": "^0.22.11",
-    "typedoc-plugin-markdown": "^3.11.9",
     "typescript": "^4.5.4"
   },
   "dependencies": {