@be-link/ecommerce-trade-service-node-sdk 0.1.71 → 0.1.72

package/enums.d.ts

@@ -248,6 +248,54 @@ export declare namespace ENUM {
         /** 结束 */
         ENDED = "4"
     }
+    /** 业务打点场景 */
+    enum BizStatScene {
+        /** 正向订单 */
+        TRADE_ORDER = "TRADE_ORDER",
+        /** 逆向订单 */
+        TRADE_REVERSE_ORDER = "TRADE_REVERSE_ORDER"
+    }
+    /** 业务打点子场景 */
+    enum BizStatSubScene {
+        /** 订单预扣资源 */
+        FREEZE_RESOURCE = "FREEZE_RESOURCE",
+        /** 释放预扣资源 */
+        UNFREEZE_RESOURCE = "UNFREEZE_RESOURCE",
+        /** 创建正向订单 */
+        CREATE_ORDER = "CREATE_ORDER",
+        /** 订单实扣资源 */
+        DEDUCT_RESOURCE = "DEDUCT_RESOURCE",
+        /** 积分商城支付 */
+        POINT_MALL_PAY = "POINT_MALL_PAY",
+        /** 订单支付 */
+        ORDER_PAY = "ORDER_PAY",
+        /** 获取订单支付参数 */
+        FETCH_PAYMENT_PARAM = "FETCH_PAYMENT_PARAM",
+        /** 创建逆向订单 */
+        CREATE_REVERSE_ORDER = "CREATE_REVERSE_ORDER",
+        /** 逆向订单商家审批通过 */
+        REVERSE_AUDIT_PASS = "REVERSE_AUDIT_PASS",
+        /** 逆向订单商家审批拒绝 */
+        REVERSE_AUDIT_REJECT = "REVERSE_AUDIT_REJECT",
+        /** 逆向订单系统自动审批通过 */
+        REVERSE_AUTO_AUDIT_PASS = "REVERSE_AUTO_AUDIT_PASS",
+        /** 逆向订单资源退还 */
+        REVERSE_REFUND_RESOURCE = "REVERSE_REFUND_RESOURCE",
+        /** 逆向订单退款成功 */
+        REVERSE_REFUND_SUCCESS = "REVERSE_REFUND_SUCCESS",
+        /** 正向订单关闭 */
+        ORDER_CLOSED = "ORDER_CLOSED",
+        /** 正向订单用户确认收货 */
+        ORDER_CONFIRM_RECEIVE = "ORDER_CONFIRM_RECEIVE",
+        /** 正向订单系统自动确认收货 */
+        ORDER_AUTO_CONFIRM_RECEIVE = "ORDER_AUTO_CONFIRM_RECEIVE",
+        /** 正向订单用户取消 */
+        ORDER_CANCEL_BY_USER = "ORDER_CANCEL_BY_USER",
+        /** 正向订单超时取消 */
+        ORDER_CANCEL_BY_TIMEOUT = "ORDER_CANCEL_BY_TIMEOUT",
+        /** 逆向订单用户取消 */
+        REVERSE_ORDER_CANCEL_BY_USER = "REVERSE_ORDER_CANCEL_BY_USER"
+    }
 }
 /** RabbitMQ 交换机路由枚举 */
 export declare namespace EXCHANGE_ENUM {

package/enums.js

@@ -281,6 +281,56 @@ var ENUM;
         /** 结束 */
         LiveRoomStatus["ENDED"] = "4";
     })(LiveRoomStatus = ENUM.LiveRoomStatus || (ENUM.LiveRoomStatus = {}));
+    /** 业务打点场景 */
+    let BizStatScene;
+    (function (BizStatScene) {
+        /** 正向订单 */
+        BizStatScene["TRADE_ORDER"] = "TRADE_ORDER";
+        /** 逆向订单 */
+        BizStatScene["TRADE_REVERSE_ORDER"] = "TRADE_REVERSE_ORDER";
+    })(BizStatScene = ENUM.BizStatScene || (ENUM.BizStatScene = {}));
+    /** 业务打点子场景 */
+    let BizStatSubScene;
+    (function (BizStatSubScene) {
+        /** 订单预扣资源 */
+        BizStatSubScene["FREEZE_RESOURCE"] = "FREEZE_RESOURCE";
+        /** 释放预扣资源 */
+        BizStatSubScene["UNFREEZE_RESOURCE"] = "UNFREEZE_RESOURCE";
+        /** 创建正向订单 */
+        BizStatSubScene["CREATE_ORDER"] = "CREATE_ORDER";
+        /** 订单实扣资源 */
+        BizStatSubScene["DEDUCT_RESOURCE"] = "DEDUCT_RESOURCE";
+        /** 积分商城支付 */
+        BizStatSubScene["POINT_MALL_PAY"] = "POINT_MALL_PAY";
+        /** 订单支付 */
+        BizStatSubScene["ORDER_PAY"] = "ORDER_PAY";
+        /** 获取订单支付参数 */
+        BizStatSubScene["FETCH_PAYMENT_PARAM"] = "FETCH_PAYMENT_PARAM";
+        /** 创建逆向订单 */
+        BizStatSubScene["CREATE_REVERSE_ORDER"] = "CREATE_REVERSE_ORDER";
+        /** 逆向订单商家审批通过 */
+        BizStatSubScene["REVERSE_AUDIT_PASS"] = "REVERSE_AUDIT_PASS";
+        /** 逆向订单商家审批拒绝 */
+        BizStatSubScene["REVERSE_AUDIT_REJECT"] = "REVERSE_AUDIT_REJECT";
+        /** 逆向订单系统自动审批通过 */
+        BizStatSubScene["REVERSE_AUTO_AUDIT_PASS"] = "REVERSE_AUTO_AUDIT_PASS";
+        /** 逆向订单资源退还 */
+        BizStatSubScene["REVERSE_REFUND_RESOURCE"] = "REVERSE_REFUND_RESOURCE";
+        /** 逆向订单退款成功 */
+        BizStatSubScene["REVERSE_REFUND_SUCCESS"] = "REVERSE_REFUND_SUCCESS";
+        /** 正向订单关闭 */
+        BizStatSubScene["ORDER_CLOSED"] = "ORDER_CLOSED";
+        /** 正向订单用户确认收货 */
+        BizStatSubScene["ORDER_CONFIRM_RECEIVE"] = "ORDER_CONFIRM_RECEIVE";
+        /** 正向订单系统自动确认收货 */
+        BizStatSubScene["ORDER_AUTO_CONFIRM_RECEIVE"] = "ORDER_AUTO_CONFIRM_RECEIVE";
+        /** 正向订单用户取消 */
+        BizStatSubScene["ORDER_CANCEL_BY_USER"] = "ORDER_CANCEL_BY_USER";
+        /** 正向订单超时取消 */
+        BizStatSubScene["ORDER_CANCEL_BY_TIMEOUT"] = "ORDER_CANCEL_BY_TIMEOUT";
+        /** 逆向订单用户取消 */
+        BizStatSubScene["REVERSE_ORDER_CANCEL_BY_USER"] = "REVERSE_ORDER_CANCEL_BY_USER";
+    })(BizStatSubScene = ENUM.BizStatSubScene || (ENUM.BizStatSubScene = {}));
 })(ENUM || (exports.ENUM = ENUM = {}));
 /** RabbitMQ 交换机路由枚举 */
 var EXCHANGE_ENUM;

package/index.d.ts

@@ -1,5 +1,6 @@
 export * as POS from './modules/pos';
 export * as ROS from './modules/ros';
+export * as STATISTICS from './modules/statistics';
 export { ENUM, ENUM_CN, EXCHANGE_ENUM } from './enums';
 export * as CONSTS from './consts';
 export * as DTO from './types';

package/index.js

@@ -33,9 +33,10 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.verificationService = exports.DTO = exports.CONSTS = exports.EXCHANGE_ENUM = exports.ENUM_CN = exports.ENUM = exports.ROS = exports.POS = void 0;
+exports.verificationService = exports.DTO = exports.CONSTS = exports.EXCHANGE_ENUM = exports.ENUM_CN = exports.ENUM = exports.STATISTICS = exports.ROS = exports.POS = void 0;
 exports.POS = __importStar(require("./modules/pos"));
 exports.ROS = __importStar(require("./modules/ros"));
+exports.STATISTICS = __importStar(require("./modules/statistics"));
 var enums_1 = require("./enums");
 Object.defineProperty(exports, "ENUM", { enumerable: true, get: function () { return enums_1.ENUM; } });
 Object.defineProperty(exports, "ENUM_CN", { enumerable: true, get: function () { return enums_1.ENUM_CN; } });

package/modules/statistics/index.d.ts

@@ -0,0 +1,2 @@
+export { statisticsService } from './service';
+export { StatisticsService as StatisticsTypes } from './types';

package/modules/statistics/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.statisticsService = void 0;
+var service_1 = require("./service");
+Object.defineProperty(exports, "statisticsService", { enumerable: true, get: function () { return service_1.statisticsService; } });

package/modules/statistics/service.d.ts

@@ -0,0 +1,10 @@
+import { StatisticsService } from './types';
+import BaseService from '../BaseService';
+declare class StatisticsServiceImpl extends BaseService implements StatisticsService.ByPos.QueryController, StatisticsService.ByRos.QueryController, StatisticsService.ByUs.QueryController {
+    protected prefixUrl: string;
+    forwardStatistics(request: StatisticsService.ByPos.Request.IForwardStatistics, req?: any): Promise<StatisticsService.ByPos.Response.IForwardStatistics>;
+    reverseStatistics(request: StatisticsService.ByRos.Request.IReverseStatistics, req?: any): Promise<StatisticsService.ByRos.Response.IReverseStatistics>;
+    orderUserStatistics(request: StatisticsService.ByUs.Request.IOrderUserStatistics, req?: any): Promise<StatisticsService.ByUs.Response.IOrderUserStatistics>;
+}
+export declare const statisticsService: StatisticsServiceImpl;
+export default statisticsService;

package/modules/statistics/service.js

@@ -0,0 +1,48 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.statisticsService = void 0;
+const tsoa_1 = require("tsoa");
+const http_1 = require("../../utils/http");
+const BaseService_1 = __importDefault(require("../BaseService"));
+let StatisticsServiceImpl = class StatisticsServiceImpl extends BaseService_1.default {
+    constructor() {
+        super(...arguments);
+        this.prefixUrl = '/statistics';
+    }
+    forwardStatistics(request, req) {
+        return (0, http_1.callApi)(this.getApiUrl(this.forwardStatistics), request);
+    }
+    reverseStatistics(request, req) {
+        return (0, http_1.callApi)(this.getApiUrl(this.reverseStatistics), request);
+    }
+    orderUserStatistics(request, req) {
+        return (0, http_1.callApi)(this.getApiUrl(this.orderUserStatistics), request);
+    }
+};
+__decorate([
+    (0, tsoa_1.OperationId)('正向统计接口'),
+    (0, tsoa_1.Post)('forward-statistics')
+], StatisticsServiceImpl.prototype, "forwardStatistics", null);
+__decorate([
+    (0, tsoa_1.OperationId)('逆向统计接口'),
+    (0, tsoa_1.Post)('reverse-statistics')
+], StatisticsServiceImpl.prototype, "reverseStatistics", null);
+__decorate([
+    (0, tsoa_1.OperationId)('下单人统计接口'),
+    (0, tsoa_1.Post)('order-user-statistics')
+], StatisticsServiceImpl.prototype, "orderUserStatistics", null);
+StatisticsServiceImpl = __decorate([
+    (0, tsoa_1.Route)('statistics'),
+    (0, tsoa_1.Tags)('Statistics')
+], StatisticsServiceImpl);
+exports.statisticsService = new StatisticsServiceImpl();
+exports.default = exports.statisticsService;

package/modules/statistics/types.d.ts

@@ -0,0 +1,128 @@
+export declare namespace StatisticsService {
+    namespace Dto {
+        interface IPagination {
+            /** 页码(从0开始) */
+            pageIndex: number;
+            /** 每页数量 */
+            pageSize: number;
+        }
+        interface IStore {
+            /** 门店ID */
+            storeId?: string;
+        }
+    }
+    namespace ByPos {
+        namespace Request {
+            interface IForwardStatistics {
+                /** 开始时间 */
+                startTime?: number;
+                /** 结束时间 */
+                endTime?: number;
+                /** 分页 */
+                pagination: Dto.IPagination;
+                /** 门店条件 */
+                store?: Dto.IStore;
+            }
+        }
+        namespace Response {
+            interface IForwardStatisticsItem {
+                /** 门店ID */
+                storeId: string;
+                /** 总GMV - 销售日期内，门店客户支付成功的订单金额之和（包括退款订单） */
+                totalGMV: number;
+                /** 总订单量 - 销售日期内，门店客户支付成功的订单数（包括退款订单） */
+                totalOrderCount: number;
+                /** 下单人数 - 销售日期内，门店客户支付成功的人数（已做订单去重） */
+                orderUserCount: number;
+                /** 直播GMV - 销售日期内，门店客户支付成功且带直播间Id的订单金额之和（包括退款订单） */
+                liveGMV: number;
+                /** 私域GMV - 销售日期内，门店客户支付成功且无直播间Id的订单金额之和（包括退款订单） */
+                privateGMV: number;
+                /** 快递到家GMV - 销售日期内，门店客户支付成功且取货方式=快递到家的订单金额之和（包括退款订单） */
+                deliveryHomeGMV: number;
+                /** 门店自提GMV - 销售日期内，门店客户支付成功且取货方式=门店自提的订单金额之和（包括虚拟订单及退款订单） */
+                selfPickupGMV: number;
+                /** 快递到家订单数 - 销售日期内，门店客户支付成功且取货方式=快递到家的订单数（包括退款订单） */
+                deliveryHomeOrderCount: number;
+                /** 门店自提订单数 - 销售日期内，门店客户支付成功且取货方式=门店自提的订单数（包括虚拟订单及退款订单） */
+                selfPickupOrderCount: number;
+                /** 客单价 - 总GMV / 总订单量 */
+                customerPrice: number;
+                /** ARPU（人均支付金额） - 总GMV / 下单人数 */
+                arpu: number;
+                /** 会员用户数 - 销售日期内，门店客户支付成功且是会员的订单人数（已做订单去重） */
+                memberUserCount: number;
+            }
+            interface IForwardStatistics {
+                list: IForwardStatisticsItem[];
+                total: number;
+            }
+        }
+        interface QueryController {
+            /** 正向统计接口 */
+            forwardStatistics(request: Request.IForwardStatistics, req: any): Promise<Response.IForwardStatistics>;
+        }
+    }
+    namespace ByRos {
+        namespace Request {
+            interface IReverseStatistics {
+                /** 开始时间 */
+                startTime?: number;
+                /** 结束时间 */
+                endTime?: number;
+                /** 分页 */
+                pagination: Dto.IPagination;
+                /** 门店条件 */
+                store?: Dto.IStore;
+            }
+        }
+        namespace Response {
+            interface IReverseStatisticsItem {
+                /** 门店ID */
+                storeId: string;
+                /** 退款GMV - 选定时间段内，门店客户退款成功的订单金额之和 */
+                refundGMV: number;
+                /** 退款订单数 - 选定时间段内，门店客户退款成功的订单数 */
+                refundOrderCount: number;
+            }
+            interface IReverseStatistics {
+                list: IReverseStatisticsItem[];
+                total: number;
+            }
+        }
+        interface QueryController {
+            /** 逆向统计接口 */
+            reverseStatistics(request: Request.IReverseStatistics, req: any): Promise<Response.IReverseStatistics>;
+        }
+    }
+    namespace ByUs {
+        namespace Request {
+            interface IOrderUserStatistics {
+                /** 开始时间 */
+                startTime?: number;
+                /** 结束时间 */
+                endTime?: number;
+                /** 分页 */
+                pagination: Dto.IPagination;
+                /** 门店条件 */
+                store?: Dto.IStore;
+            }
+        }
+        namespace Response {
+            interface IOrderUserStatisticsItem {
+                /** 门店ID */
+                storeId: string;
+                /** 用户ID列表 */
+                userIds: string[];
+            }
+            interface IOrderUserStatistics {
+                list: IOrderUserStatisticsItem[];
+                total: number;
+            }
+        }
+        interface QueryController {
+            /** 下单人统计接口 */
+            orderUserStatistics(request: Request.IOrderUserStatistics, req: any): Promise<Response.IOrderUserStatistics>;
+        }
+    }
+}

package/modules/statistics/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@be-link/ecommerce-trade-service-node-sdk",
-  "version": "0.1.71",
+  "version": "0.1.72",
   "description": "EcommerceTradeService Node.js SDK",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",