@be-link/ecommerce-client-backend-service-node-sdk 0.0.10 → 0.0.12

package/enum.d.ts

@@ -172,4 +172,13 @@ export declare namespace ENUM {
             TEXT = 2
         }
     }
+    namespace LIVE_STREAM_TYPE {
+        /**
+         * 操作类型
+         */
+        enum ACTION {
+            CREATE = 1,
+            DELETE = 2
+        }
+    }
 }

package/enum.js

@@ -193,4 +193,15 @@ var ENUM;
             TYPE[TYPE["TEXT"] = 2] = "TEXT";
         })(TYPE = ROOM_TAG.TYPE || (ROOM_TAG.TYPE = {}));
     })(ROOM_TAG = ENUM.ROOM_TAG || (ENUM.ROOM_TAG = {}));
+    let LIVE_STREAM_TYPE;
+    (function (LIVE_STREAM_TYPE) {
+        /**
+         * 操作类型
+         */
+        let ACTION;
+        (function (ACTION) {
+            ACTION[ACTION["CREATE"] = 1] = "CREATE";
+            ACTION[ACTION["DELETE"] = 2] = "DELETE";
+        })(ACTION = LIVE_STREAM_TYPE.ACTION || (LIVE_STREAM_TYPE.ACTION = {}));
+    })(LIVE_STREAM_TYPE = ENUM.LIVE_STREAM_TYPE || (ENUM.LIVE_STREAM_TYPE = {}));
 })(ENUM || (exports.ENUM = ENUM = {}));

package/modules/room/service.d.ts

@@ -8,12 +8,15 @@ declare class RoomServiceClass extends BaseService implements RoomService.BaseCo
     detail(request: RoomService.Request.Detail): Promise<RoomService.Response.Detail>;
     share(request: RoomService.Request.Share): Promise<RoomService.Response.Share>;
     uploadShareCover(request: RoomService.Request.UploadShareCover): Promise<RoomService.Response.UploadShareCover>;
+    getShareCover(request: RoomService.Request.getShareCover): Promise<RoomService.Response.getShareCover>;
     settle(request: RoomService.Request.settle): Promise<RoomService.Response.settle>;
     roomStatus(request: RoomService.Request.RoomStatus): Promise<RoomService.Response.RoomStatus>;
     getBindStore(request: RoomService.Request.GetBindStore): Promise<RoomService.Response.GetBindStore>;
     bindStore(request: RoomService.Request.BindStore): Promise<void>;
     /** 根据门店绑定关系查询直播间列表 */
     listByStoreBind(request: RoomService.Request.ListByStoreBind): Promise<RoomService.Response.ListByStoreBind>;
+    /** 观看记录查询 */
+    viewRecord(request: RoomService.Request.ViewRecord): Promise<RoomService.Response.ViewRecord>;
 }
 export declare const roomService: RoomServiceClass;
 export default roomService;

package/modules/room/service.js

@@ -36,6 +36,9 @@ let RoomServiceClass = class RoomServiceClass extends BaseService_1.default {
     uploadShareCover(request) {
         return (0, http_1.callApi)(this.getApiUrl(this.uploadShareCover), request);
     }
+    getShareCover(request) {
+        return (0, http_1.callApi)(this.getApiUrl(this.getShareCover), request);
+    }
     settle(request) {
         return (0, http_1.callApi)(this.getApiUrl(this.settle), request);
     }
@@ -52,6 +55,10 @@ let RoomServiceClass = class RoomServiceClass extends BaseService_1.default {
     listByStoreBind(request) {
         return (0, http_1.callApi)(this.getApiUrl(this.listByStoreBind), request);
     }
+    /** 观看记录查询 */
+    viewRecord(request) {
+        return (0, http_1.callApi)(this.getApiUrl(this.viewRecord), request);
+    }
 };
 __decorate([
     (0, tsoa_1.OperationId)('同步活动'),
@@ -78,6 +85,11 @@ __decorate([
     (0, tsoa_1.Post)('upload-share-cover'),
     __param(0, (0, tsoa_1.Body)())
 ], RoomServiceClass.prototype, "uploadShareCover", null);
+__decorate([
+    (0, tsoa_1.OperationId)('获取封面'),
+    (0, tsoa_1.Post)('get-share-cover'),
+    __param(0, (0, tsoa_1.Body)())
+], RoomServiceClass.prototype, "getShareCover", null);
 __decorate([
     (0, tsoa_1.OperationId)('结算状态查询'),
     (0, tsoa_1.Post)('settle'),
@@ -103,6 +115,11 @@ __decorate([
     (0, tsoa_1.Post)('list-by-store-bind'),
     __param(0, (0, tsoa_1.Body)())
 ], RoomServiceClass.prototype, "listByStoreBind", null);
+__decorate([
+    (0, tsoa_1.OperationId)('观看记录查询'),
+    (0, tsoa_1.Post)('view-record'),
+    __param(0, (0, tsoa_1.Body)())
+], RoomServiceClass.prototype, "viewRecord", null);
 RoomServiceClass = __decorate([
     (0, tsoa_1.Route)('room'),
     (0, tsoa_1.Tags)('Room')

package/modules/room/types.d.ts

@@ -1,7 +1,7 @@
 import { ListActivityAPIRequest, ListActivityAPIResponse } from '@be-link/ecommerce-volcengine-open-api-sdk';
 import { FastifyRequest } from 'fastify';
 import { ENUM } from '../../enum';
-import { Room } from '../../types';
+import { Room, ViewRecord as ViewRecordType } from '../../types';
 export declare namespace RoomService {
     namespace Request {
         /**
@@ -28,6 +28,13 @@ export declare namespace RoomService {
         interface Share {
             id: string;
         }
+        /**
+         * 获取封面
+         */
+        interface getShareCover {
+            /** 直播间id */
+            id: string;
+        }
         /**
          * 上传分分享封面
          */
@@ -74,6 +81,15 @@ export declare namespace RoomService {
             /** 每页数量，默认20，最大100 */
             pageSize?: number;
         }
+        interface ViewRecord {
+            id: string;
+            userId: string;
+            status?: ENUM.ROOM.STATUS;
+            startTime?: number;
+            endTime?: number;
+            pageIndex: number;
+            pageSize?: number;
+        }
     }
     namespace Response {
         /**
@@ -103,6 +119,19 @@ export declare namespace RoomService {
             id: string;
             shareCover: string;
         }
+        /**
+         * 获取封面
+         */
+        interface getShareCover {
+            /** 直播间id */
+            id: string;
+            /** 名称 */
+            name: string;
+            /** 分享封面url */
+            shareCover: string;
+            /** 开始时间 */
+            liveTime: number;
+        }
         /**
          * 结算状态响应
          */
@@ -131,12 +160,20 @@ export declare namespace RoomService {
             list: Room[];
             total: number;
         }
+        /**
+         * 观看记录响应
+         */
+        interface ViewRecord {
+            list: ViewRecordType[];
+            total: number;
+        }
     }
     interface BaseController {
         sync(request: ListActivityAPIRequest): Promise<ListActivityAPIResponse>;
         list(request: Request.List, req?: FastifyRequest): Promise<Response.List>;
         detail(request: Request.Detail, req?: FastifyRequest): Promise<Response.Detail>;
         share(request: Request.Share, req?: FastifyRequest): Promise<Response.Share>;
+        getShareCover(request: Request.getShareCover, req?: FastifyRequest): Promise<Response.getShareCover>;
         uploadShareCover(request: Request.UploadShareCover, req?: FastifyRequest): Promise<Response.UploadShareCover>;
         settle(request: Request.settle, req?: FastifyRequest): Promise<Response.settle>;
         roomStatus(request: Request.RoomStatus, req?: FastifyRequest): Promise<Response.RoomStatus>;
@@ -146,5 +183,6 @@ export declare namespace RoomService {
          * 根据门店绑定关系查询直播间列表
          */
         listByStoreBind(request: Request.ListByStoreBind, req?: FastifyRequest): Promise<Response.ListByStoreBind>;
+        viewRecord(request: Request.ViewRecord, req?: FastifyRequest): Promise<Response.ViewRecord>;
     }
 }

package/modules/room/types.js

@@ -1,4 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-// const roomService = new RoomService()
-// export default roomService

package/package.json

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

package/types.d.ts

@@ -34,6 +34,8 @@ export interface Room {
     liveMode: number;
     /** 观看地址中的 path 字段，不填则由系统自动生成。例如观看地址为 https://live.byteoc.com/5528/3085317，则 ViewUrlPath 取值为 3085317。长度为 1 到 20 个字符。支持以下字符：大写字母 A - Z、小写字母 a - z、数字 */
     viewUrlPath: string;
+    /** 观看 URL。 */
+    viewUrl: string;
     /** 横屏直播的封面图 URL。若通过控制台配置横屏直播封面图且配置成功，则封面图的 URL 无协议头。若通过调用 API 接口配置横屏直播封面图，则封面图的 URL 有协议头。 */
     coverImage: string;
     /** 分享封面，用于门店分享 */
@@ -141,3 +143,21 @@ export interface RoomBindStore {
     /** 直播间id，根据id是否为空字符串表示是否绑定了本店 */
     liveStreamRoomId: string;
 }
+export interface ViewRecord {
+    id: string;
+    userId: string;
+    /** 直播间名称。长度为 1 到 150 个字符 */
+    name: string;
+    /** 直播开始时间，默认为当前时间。Unix 时间戳，单位为秒。支持精确到分钟级。开始时间取值需小于 EndTime 的取值，且与 EndTime 的差值最大为 259,200，即 72 小时 */
+    liveTime: number;
+    /** 直播结束时间。Unix 时间戳，单位为秒。支持精确到分钟级。结束时间取值需大于当前时间和 LiveTime 的取值，且与 LiveTime 的差值最大为 259,200，即 72 小时 */
+    endTime: number;
+    /** 1：直播中；2：预告；3：回放；4：已结束 */
+    status: number;
+    /** 横屏直播的封面图 URL。若通过控制台配置横屏直播封面图且配置成功，则封面图的 URL 无协议头。若通过调用 API 接口配置横屏直播封面图，则封面图的 URL 有协议头。 */
+    coverImage: string;
+    /** 竖屏直播的封面图 URL。若未设置该参数值，则默认读取 CoverImage 的值。若通过控制台配置竖屏直播封面图且配置成功，则封面图的 URL 无协议头。若通过调用 API 接口配置竖屏直播封面图，则封面图的 URL 有协议头。 */
+    verticalCoverImage: string;
+    /** 观看 URL。 */
+    viewUrl: string;
+}