@be-link/ecommerce-client-backend-service-node-sdk 0.0.2 → 0.0.3

package/modules/room/service.d.ts

@@ -9,6 +9,7 @@ declare class RoomServiceClass extends BaseService implements RoomService.BaseCo
     share(request: RoomService.Request.Share): Promise<RoomService.Response.Share>;
     uploadShareCover(request: RoomService.Request.UploadShareCover): Promise<RoomService.Response.UploadShareCover>;
     settle(request: RoomService.Request.settle): Promise<RoomService.Response.settle>;
+    roomStatus(request: RoomService.Request.RoomStatus): Promise<RoomService.Response.RoomStatus>;
 }
 export declare const roomService: RoomServiceClass;
 export default roomService;

package/modules/room/service.js

@@ -39,6 +39,9 @@ let RoomServiceClass = class RoomServiceClass extends BaseService_1.default {
     settle(request) {
         return (0, http_1.callApi)(this.getApiUrl(this.settle), request);
     }
+    roomStatus(request) {
+        return (0, http_1.callApi)(this.getApiUrl(this.roomStatus), request);
+    }
 };
 __decorate([
     (0, tsoa_1.OperationId)('同步活动'),
@@ -70,6 +73,11 @@ __decorate([
     (0, tsoa_1.Post)('settle'),
     __param(0, (0, tsoa_1.Body)())
 ], RoomServiceClass.prototype, "settle", null);
+__decorate([
+    (0, tsoa_1.OperationId)('查询直播间状态'),
+    (0, tsoa_1.Post)('room-status'),
+    __param(0, (0, tsoa_1.Body)())
+], RoomServiceClass.prototype, "roomStatus", null);
 RoomServiceClass = __decorate([
     (0, tsoa_1.Route)('room'),
     (0, tsoa_1.Tags)('Room')

package/modules/room/types.d.ts

@@ -40,6 +40,12 @@ export declare namespace RoomService {
         interface settle {
             id: string;
         }
+        /**
+         * 查询直播间状态
+         */
+        interface RoomStatus {
+            id: string;
+        }
     }
     namespace Response {
         /**
@@ -76,6 +82,13 @@ export declare namespace RoomService {
             id: string;
             settleStatus: number;
         }
+        /**
+         * 查询直播间状态响应
+         */
+        interface RoomStatus {
+            id: string;
+            status: ENUM.ROOM.STATUS;
+        }
     }
     interface BaseController {
         sync(request: ListActivityAPIRequest): Promise<ListActivityAPIResponse>;
@@ -84,5 +97,6 @@ export declare namespace RoomService {
         share(request: Request.Share, req?: FastifyRequest): Promise<Response.Share>;
         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>;
     }
 }

package/package.json

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

package/types.d.ts

@@ -6,69 +6,119 @@
  * Room 实体接口
  */
 export interface Room {
+    /** id */
     id: number;
+    /** 直播流房间ID */
     liveStreamRoomId: string;
+    /** 直播间名称。长度为 1 到 150 个字符 */
     name: string;
+    /** 直播开始时间，默认为当前时间。Unix 时间戳，单位为秒。支持精确到分钟级。开始时间取值需小于 EndTime 的取值，且与 EndTime 的差值最大为 259,200，即 72 小时 */
     liveTime: number;
+    /** 1：直播中；2：预告；3：回放；4：已结束 */
     status: number;
+    /** 是否锁定预告。取值如下：0：否、1：是 */
     isLockPreview: number;
+    /** 被复制的直播间的 ID。可通过调用 ListActivityAPI 接口获取 ID。如需通过已创建的直播间复制出新的直播间，该参数必选 */
     oldId: number;
+    /** 复制直播间时，是否同时复制直播流。默认值为 0。取值如下：1：是；0：否 */
     copyStream: number;
+    /** 直播模板 ID。新创建的直播间与直播模板配置相同。可通过调用 GetAccountTemplateAPI 接口获取 ID。不传该参数，则使用默认直播模板，如未设置默认直播模板，则不使用直播模板，直接创建直播间。如需通过直播模板创建直播间，该参数必选。 */
     templateId: number;
+    /** 是否开启自动关播功能。默认值为 0。取值如下：0：关闭；1：开启 */
     isAutoEndEnable: number;
+    /** 直播结束时间。Unix 时间戳，单位为秒。支持精确到分钟级。结束时间取值需大于当前时间和 LiveTime 的取值，且与 LiveTime 的差值最大为 259,200，即 72 小时 */
     endTime: number;
+    /** 直播模式。默认值为 0。取值如下：0：视频直播；1：录播直播 */
     activityType: number;
+    /** 直播延时类型。默认值为 0。取值如下：0：继承直播模板配置的直播延时类型。有关如何创建直播模板，详见直播模板。1：超低延时（延时小于 1 秒）2：普通延时（延时 5-10 秒）当直播模式为录播直播（ActivityType 取值为 1）时，该参数不生效。 */
     liveMode: number;
+    /** 观看地址中的 path 字段，不填则由系统自动生成。例如观看地址为 https://live.byteoc.com/5528/3085317，则 ViewUrlPath 取值为 3085317。长度为 1 到 20 个字符。支持以下字符：大写字母 A - Z、小写字母 a - z、数字 */
     viewUrlPath: string;
+    /** 横屏直播的封面图 URL。若通过控制台配置横屏直播封面图且配置成功，则封面图的 URL 无协议头。若通过调用 API 接口配置横屏直播封面图，则封面图的 URL 有协议头。 */
     coverImage: string;
+    /** 分享封面，用于门店分享 */
     shareCover: string;
+    /** 直播间的小程序分享二维码 */
     shareUrl: string;
+    /** 竖屏直播的封面图 URL。若未设置该参数值，则默认读取 CoverImage 的值。若通过控制台配置竖屏直播封面图且配置成功，则封面图的 URL 无协议头。若通过调用 API 接口配置竖屏直播封面图，则封面图的 URL 有协议头。 */
     verticalCoverImage: string;
+    /** 是否开启答题重现功能。默认值为 0。取值如下：0：不开启、1：开启。直播中发送的答题和简答，将在直播回放的对应时间点自动弹出重现 */
     isAnswerRepetitionEnable: number;
+    /** 视频布局。默认值为 2。取值如下：1：三分屏。主播画面和视频画面使用不同视频源，主播画面不会遮挡视频画面。详见三分屏直播。2：纯视频。主播画面和视频画面共用一个视频源，支持调整主播画面位置 */
     liveLayout: number;
+    /** 创建直播间的账号信息。参数取值为子账号的账号，表示通过指定子账号创建直播间。可调用 ListSubAccounts 接口，通过参数 Name 获取子账号的账号。使用主账号调用接口时，不传该参数，则直播间将通过主账号创建。使用子账号调用接口时，直播间将默认通过该子账号创建，该参数不生效。 */
     creatorName: string;
+    /** 是否开启自动开播功能。默认值为 0。取值如下：0：关闭、1：开启。开启后，会在 LiveTime 时自动开播，请确保 LiveTime 的时间大于当前时间 */
     isAutoStartEnable: number;
+    /** 是否开启回放自动上架。默认值为 0。取值如下：0：关闭、1：开启。在直播结束后，自动将直播回放上架到观看页 */
     isReplayAutoOnlineEnable: number;
+    /** 视频库或直播暂存中视频的 Vid。可调用 ListActivityMediaAPI 接口，通过返回参数 Vid 获取视频的 Vid。新创建的直播间状态为回放，同时该视频会作为直播间的回放上架观看页。 */
     vid: string;
+    /** 创建人id */
     createUserId: string;
+    /** 直播总时长，单位：毫秒 */
     duration: number;
+    /** 审核状态。取值如下：1：审核中、2：审核通过、3：审核驳回、4：审核归档、5：草稿、6：无需审核 */
     liveReviewStatus: number;
+    /** 直播关闭30分钟后数据结算状态：0-未结算、1-已结算 */
     settleStatus: number;
+    /** 创建时间 */
     createdAt: number;
+    /** 更新时间 */
     updatedAt: number;
+    /** 删除时间 */
     deletedAt: number;
 }
 /**
  * RoomAutoStartConfig 实体接口
  */
 export interface RoomAutoStartConfig {
+    /** id */
     id: number;
+    /** 直播间id */
     liveStreamRoomId: string;
+    /** 开启自动开播后，重复开播的频率。默认值为 0。取值如下：0：不重复、1：每天、2：自定义 */
     repeatType: number;
+    /** 自定义重复频率。使用 RFC5545 规范中的 RRULE 格式，仅支持 FREQ 和 INTERVAL 字段，字段之间使用 ; 分隔。其中：FREQ 支持设为 DAILY （每天）和WEEKLY（每周）。INTERVAL 取值范围为 1-30 的整数，表示重复间隔。例如：INTERVAL=2 表示每 2 天或每 2 周。 */
     recurrenceRule: string;
+    /** 重复开播的截止日期（北京时间），以 Unix 时间戳表示，单位为毫秒。 */
     repeatDeadline: number;
+    /** 创建时间 */
     createdAt: number;
 }
 /**
  * RoomLoopVideo 实体接口
  */
 export interface RoomLoopVideo {
+    /** id */
     id: number;
+    /** 直播间id */
     liveStreamRoomId: string;
+    /** 录播直播视频序号。取值固定为 1 。 */
     index: number;
+    /** 录播直播视频名称。 */
     videoName: string;
+    /** 录播直播视频 Vid。可通过调用 ListActivityMediaAPI 接口获取 Vid。 */
     videoVid: string;
+    /** 录播直播视频的启动时刻。单位为秒。例如参数取值为 10，则从视频的第 10 秒开始播放。 */
     offset: number;
+    /** 创建时间 */
     createdAt: number;
 }
 /**
  * RoomTag 实体接口
  */
 export interface RoomTag {
+    /** id */
     id: number;
+    /** 直播间id */
     liveStreamRoomId: string;
+    /** 类型：0-未知、1-标签分类、2-文本标签 */
     type: number;
+    /** 分类标签的可选标签值 */
     value: string;
+    /** 分类标签的索引值，用于标识分类标签在控制台展示的位置。索引值越小，位置越靠前。取值范围为 [0,19]。 */
     index: number;
+    /** 创建时间 */
     createdAt: number;
 }