@be-link/ecommerce-client-backend-service-node-sdk 0.1.4 → 0.1.6

package/modules/data/service.d.ts

@@ -8,6 +8,10 @@ declare class DataServiceClass extends BaseService implements DataService.BaseCo
     getUserLiveStreamInfo(request: DataService.Request.UserLiveStreamInfo): Promise<DataService.Response.UserLiveStreamInfo>;
     /** 直播间观众列表查询 */
     getAudienceList(request: DataService.Request.AudienceList): Promise<DataService.Response.AudienceList>;
+    /** 直播间统计查询 */
+    getLiveStreamStatistics(request: DataService.Request.LiveStreamStatistics): Promise<DataService.Response.LiveStreamStatistics>;
+    /** 直播间商品销量排行查询 */
+    getLiveStreamProductTop(request: DataService.Request.LiveStreamProductTop): Promise<DataService.Response.LiveStreamProductTop>;
 }
 export declare const dataService: DataServiceClass;
 export default dataService;

package/modules/data/service.js

@@ -37,6 +37,14 @@ let DataServiceClass = class DataServiceClass extends BaseService_1.default {
     getAudienceList(request) {
         return (0, http_1.callApi)(this.getApiUrl(this.getAudienceList), request);
     }
+    /** 直播间统计查询 */
+    getLiveStreamStatistics(request) {
+        return (0, http_1.callApi)(this.getApiUrl(this.getLiveStreamStatistics), request);
+    }
+    /** 直播间商品销量排行查询 */
+    getLiveStreamProductTop(request) {
+        return (0, http_1.callApi)(this.getApiUrl(this.getLiveStreamProductTop), request);
+    }
 };
 __decorate([
     (0, tsoa_1.OperationId)('获取用户观看时长'),
@@ -63,6 +71,16 @@ __decorate([
     (0, tsoa_1.Post)('get-audience-list'),
     __param(0, (0, tsoa_1.Body)())
 ], DataServiceClass.prototype, "getAudienceList", null);
+__decorate([
+    (0, tsoa_1.OperationId)('直播间统计查询'),
+    (0, tsoa_1.Post)('get-livestream-statistics'),
+    __param(0, (0, tsoa_1.Body)())
+], DataServiceClass.prototype, "getLiveStreamStatistics", null);
+__decorate([
+    (0, tsoa_1.OperationId)('直播间商品销量排行查询'),
+    (0, tsoa_1.Post)('get-livestream-product-top'),
+    __param(0, (0, tsoa_1.Body)())
+], DataServiceClass.prototype, "getLiveStreamProductTop", null);
 DataServiceClass = __decorate([
     (0, tsoa_1.Route)('data'),
     (0, tsoa_1.Tags)('Data')

package/modules/data/types.d.ts

@@ -33,7 +33,6 @@ export declare namespace DataService {
             /** 查询观看类型 */
             viewType: ENUM.LIVE_STREAM_AUDIENCE.VIEW_TYPE;
             /** 用户行为 */
-            action: ENUM.LIVE_STREAM_AUDIENCE.REPORT_ACTION;
             /** 事件发生时间，毫秒时间戳 */
             eventAt: number;
         }
@@ -61,6 +60,20 @@ export declare namespace DataService {
             /** 每页数量，默认20，最大100 */
             pageSize?: number;
         }
+        /**
+         * 直播间统计查询
+         */
+        interface LiveStreamStatistics {
+            /** 直播间id */
+            liveStreamRoomId: string;
+        }
+        /**
+         * 直播间商品销量排行查询
+         */
+        interface LiveStreamProductTop {
+            /** 直播间id */
+            liveStreamRoomId: string;
+        }
     }
     namespace Response {
         /**
@@ -91,6 +104,18 @@ export declare namespace DataService {
             list: Audience[];
             total: number;
         }
+        /**
+         * 直播间统计响应
+         */
+        interface LiveStreamStatistics {
+            roomStatistics: RoomStatistics;
+        }
+        /**
+         * 直播间商品销量排行响应
+         */
+        interface LiveStreamProductTop {
+            list: Product[];
+        }
     }
     interface BaseController {
         userLiveStreamRelation(request: Request.UserLiveStreamRelation, req?: FastifyRequest): Promise<void>;
@@ -98,8 +123,13 @@ export declare namespace DataService {
         userReport(request: Request.UserReport, req?: FastifyRequest): Promise<void>;
         getUserLiveStreamInfo(request: Request.UserLiveStreamInfo, req?: FastifyRequest): Promise<Response.UserLiveStreamInfo>;
         getAudienceList(request: Request.AudienceList, req?: FastifyRequest): Promise<Response.AudienceList>;
+        getLiveStreamStatistics(request: Request.LiveStreamStatistics, req?: FastifyRequest): Promise<Response.LiveStreamStatistics>;
+        getLiveStreamProductTop(request: Request.LiveStreamProductTop, req?: FastifyRequest): Promise<Response.LiveStreamProductTop>;
     }
 }
+/**
+ * 观众
+ */
 export interface Audience {
     /** 主播间id */
     liveStreamRoomId: string;
@@ -128,3 +158,56 @@ export interface Audience {
     /** 最后一次进入时间，毫秒时间戳 */
     lastTime: number;
 }
+/**
+ * 直播间统计
+ */
+export interface RoomStatistics {
+    /** 直播间数据id */
+    id: number;
+    /** 直播间id */
+    liveStreamRoomId: string;
+    /** 交易总金额（待支付金额+实收金额、含退款金额） */
+    gmv: number;
+    /** 实收金额： 支付成功且未退款金额 */
+    actualReceivedAmount: number;
+    /** 客单价：交易总金额/下单人数 */
+    averageOrderAmount: string;
+    /** 成交订单数：支付成功订单数 */
+    transactOrderCount: number;
+    /** 下单人数去重 */
+    orderUserCount: number;
+    /** 成交转化率：支付成功人数/累计观看人数 */
+    orderConversionRate: string;
+    /** 退款金额 */
+    refundAmount: number;
+    /** 退款人数去重 */
+    refundUserCount: number;
+    /** 待支付金额 */
+    pendingPaymentAmount: number;
+    /** 商品销售量 */
+    salesVolume: number;
+}
+export interface Product {
+    /** 直播间id */
+    liveStreamRoomId: string;
+    /** 直播间id */
+    productId: string;
+    /** 商品名称 */
+    productName: string;
+    /** 商品图片 */
+    productImage: string;
+    /** 商品SKU ID */
+    skuId: string;
+    /** 商品SKU名称 */
+    attrs: Attr[];
+    /** 销售量 */
+    salesVolume: number;
+    /** 成交金额 */
+    paymentAmount: number;
+}
+export interface Attr {
+    /** 属性名称 */
+    attrName: string;
+    /** 属性值 */
+    attrValue: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@be-link/ecommerce-client-backend-service-node-sdk",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "description": "EcommerceClientBackendService Node.js SDK",
   "main": "index.js",
   "types": "index.d.ts",