polyv-live-api-sdk 1.0.13 → 1.0.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. package/README.md +21 -0
  2. package/dist/client.d.ts.map +1 -1
  3. package/dist/index.cjs +8747 -5683
  4. package/dist/index.cjs.map +1 -1
  5. package/dist/index.d.cts +12589 -9410
  6. package/dist/index.d.ts +1 -1
  7. package/dist/index.d.ts.map +1 -1
  8. package/dist/index.js +8727 -5684
  9. package/dist/index.js.map +1 -1
  10. package/dist/services/account.service.d.ts +34 -26
  11. package/dist/services/account.service.d.ts.map +1 -1
  12. package/dist/services/channel.service.d.ts +373 -8
  13. package/dist/services/channel.service.d.ts.map +1 -1
  14. package/dist/services/chat.service.d.ts +12 -1
  15. package/dist/services/chat.service.d.ts.map +1 -1
  16. package/dist/services/finance.service.d.ts +16 -1
  17. package/dist/services/finance.service.d.ts.map +1 -1
  18. package/dist/services/index.d.ts +1 -0
  19. package/dist/services/index.d.ts.map +1 -1
  20. package/dist/services/live-interaction.service.d.ts +66 -385
  21. package/dist/services/live-interaction.service.d.ts.map +1 -1
  22. package/dist/services/v4/ai.service.d.ts +14 -2
  23. package/dist/services/v4/ai.service.d.ts.map +1 -1
  24. package/dist/services/v4/channel.service.d.ts +323 -23
  25. package/dist/services/v4/channel.service.d.ts.map +1 -1
  26. package/dist/services/v4/chat.service.d.ts +25 -4
  27. package/dist/services/v4/chat.service.d.ts.map +1 -1
  28. package/dist/services/v4/group.service.d.ts +14 -1
  29. package/dist/services/v4/group.service.d.ts.map +1 -1
  30. package/dist/services/v4/material.service.d.ts +37 -1
  31. package/dist/services/v4/material.service.d.ts.map +1 -1
  32. package/dist/services/v4/user.service.d.ts +113 -68
  33. package/dist/services/v4/user.service.d.ts.map +1 -1
  34. package/dist/services/web.service.d.ts +5 -5
  35. package/dist/services/web.service.d.ts.map +1 -1
  36. package/dist/types/account.d.ts +205 -86
  37. package/dist/types/account.d.ts.map +1 -1
  38. package/dist/types/channel.d.ts +874 -18
  39. package/dist/types/channel.d.ts.map +1 -1
  40. package/dist/types/chat.d.ts +3 -0
  41. package/dist/types/chat.d.ts.map +1 -1
  42. package/dist/types/client.d.ts +6 -2
  43. package/dist/types/client.d.ts.map +1 -1
  44. package/dist/types/finance.d.ts +69 -0
  45. package/dist/types/finance.d.ts.map +1 -1
  46. package/dist/types/index.d.ts +20 -19
  47. package/dist/types/index.d.ts.map +1 -1
  48. package/dist/types/live-interaction.d.ts +170 -171
  49. package/dist/types/live-interaction.d.ts.map +1 -1
  50. package/dist/types/v4-ai.d.ts +39 -0
  51. package/dist/types/v4-ai.d.ts.map +1 -1
  52. package/dist/types/v4-channel.d.ts +900 -82
  53. package/dist/types/v4-channel.d.ts.map +1 -1
  54. package/dist/types/v4-chat.d.ts +15 -4
  55. package/dist/types/v4-chat.d.ts.map +1 -1
  56. package/dist/types/v4-group.d.ts +41 -0
  57. package/dist/types/v4-group.d.ts.map +1 -1
  58. package/dist/types/v4-material.d.ts +46 -0
  59. package/dist/types/v4-material.d.ts.map +1 -1
  60. package/dist/types/v4-robot.d.ts +28 -0
  61. package/dist/types/v4-robot.d.ts.map +1 -1
  62. package/dist/types/v4-user.d.ts +816 -207
  63. package/dist/types/v4-user.d.ts.map +1 -1
  64. package/dist/types/web.d.ts +55 -39
  65. package/dist/types/web.d.ts.map +1 -1
  66. package/package.json +1 -1
@@ -817,14 +817,11 @@ export interface DonateSettings {
817
817
  /** Channel ID */
818
818
  channelId: string;
819
819
  /** Donate enabled */
820
- donateEnabled?: YNFlag;
821
- donateGiftEnabled?: YNFlag;
820
+ donateEnabled: YNFlag;
822
821
  /** Donate tips */
823
- donateTips?: string;
822
+ donateTips: string;
824
823
  /** Donate amounts */
825
- donateAmounts?: number[];
826
- giftDonate?: GiftDonateConfig;
827
- [key: string]: unknown;
824
+ donateAmounts: number[];
828
825
  }
829
826
  /**
830
827
  * Parameters for getting donate settings
@@ -841,32 +838,10 @@ export interface UpdateDonateParams {
841
838
  channelId: string;
842
839
  /** Donate enabled */
843
840
  donateEnabled?: YNFlag;
844
- donateGiftEnabled?: YNFlag;
845
841
  /** Donate tips */
846
842
  donateTips?: string;
847
843
  /** Donate amounts */
848
844
  donateAmounts?: number[];
849
- giftDonate?: GiftDonateConfig;
850
- }
851
- export interface GiftDonatePayItem {
852
- name?: string;
853
- enabled?: YNFlag;
854
- imgType?: 'STATIC' | 'DYNAMIC' | string;
855
- img?: string;
856
- dynamicImg?: string;
857
- dynamicFile?: string;
858
- price?: number | string;
859
- }
860
- export interface GiftDonateConfig {
861
- payWay?: 'CASH' | 'POINT' | string;
862
- pointUnit?: string;
863
- cashPays?: GiftDonatePayItem[];
864
- pointPays?: GiftDonatePayItem[];
865
- }
866
- export interface UpdateDonateGiftParams {
867
- channelId: string | number;
868
- donateGiftEnabled: YNFlag;
869
- giftDonate?: GiftDonateConfig;
870
845
  }
871
846
  /**
872
847
  * Distribute info
@@ -1052,17 +1027,6 @@ export interface QueryWinnerViewerResponse {
1052
1027
  /** Contents */
1053
1028
  contents: WinnerViewerInfo[];
1054
1029
  }
1055
- export interface LotteryReceiveInfo {
1056
- type?: 'userName' | 'userPhone' | 'custom' | string;
1057
- field: string;
1058
- tips?: string;
1059
- required?: boolean;
1060
- }
1061
- export interface LotteryPrizeInfo {
1062
- prizeItem: string;
1063
- correctAnswerCount: number;
1064
- [key: string]: unknown;
1065
- }
1066
1030
  /**
1067
1031
  * Lottery activity info
1068
1032
  */
@@ -2036,48 +2000,6 @@ export interface LikeInfo {
2036
2000
  /** Like time */
2037
2001
  likeTime: number;
2038
2002
  }
2039
- export interface RewardGiftRecord {
2040
- viewerId?: string;
2041
- viewerName?: string;
2042
- giftName?: string;
2043
- price?: number;
2044
- count?: number;
2045
- createTime?: number;
2046
- [key: string]: unknown;
2047
- }
2048
- export interface ListRewardGiftsParams extends V4PaginationParams {
2049
- channelId: string | number;
2050
- start: number;
2051
- end: number;
2052
- }
2053
- export interface ListRewardGiftsResponse {
2054
- pageNumber?: number;
2055
- pageSize?: number;
2056
- totalItems?: number;
2057
- totalPages?: number;
2058
- contents?: RewardGiftRecord[];
2059
- [key: string]: unknown;
2060
- }
2061
- export interface RewardLikeRecord {
2062
- viewerId?: string;
2063
- viewerName?: string;
2064
- likeCount?: number;
2065
- createTime?: number;
2066
- [key: string]: unknown;
2067
- }
2068
- export interface ListRewardLikesParams extends V4PaginationParams {
2069
- channelId: string | number;
2070
- start?: number;
2071
- end?: number;
2072
- }
2073
- export interface ListRewardLikesResponse {
2074
- pageNumber?: number;
2075
- pageSize?: number;
2076
- totalItems?: number;
2077
- totalPages?: number;
2078
- contents?: RewardLikeRecord[];
2079
- [key: string]: unknown;
2080
- }
2081
2003
  /**
2082
2004
  * Response for paging likes
2083
2005
  */
@@ -2485,10 +2407,907 @@ export interface LiveSessionInfo {
2485
2407
  /** Max viewer count */
2486
2408
  maxViewerCount: number;
2487
2409
  }
2410
+ export type ChannelIdListInput = string | Array<string | number>;
2411
+ export interface V4ChannelPageResponse<T> {
2412
+ pageNumber: number;
2413
+ pageSize: number;
2414
+ totalPages: number;
2415
+ totalItems: number;
2416
+ contents: T[];
2417
+ }
2418
+ export interface BatchPlaybackListParams {
2419
+ /** Channel IDs, max 100 */
2420
+ channelIds: ChannelIdListInput;
2421
+ }
2422
+ export interface PlaybackVideoListItem {
2423
+ videoId?: string | null;
2424
+ videoPoolId?: string | null;
2425
+ fileId?: string | null;
2426
+ duration?: string | null;
2427
+ name?: string | null;
2428
+ watchUrl?: string | null;
2429
+ }
2430
+ export interface ChannelPlaybackSetting {
2431
+ channelId: number;
2432
+ playBackEnabled: YNFlag;
2433
+ origin?: 'record' | 'playback' | 'vod' | string;
2434
+ type?: 'single' | 'list' | string;
2435
+ videoList?: PlaybackVideoListItem[];
2436
+ globalSettingEnabled?: YNFlag;
2437
+ }
2438
+ export type BatchPlaybackListResponse = ChannelPlaybackSetting[];
2439
+ export interface SessionExternalBySessionParams extends GetRelevanceParams {
2440
+ }
2441
+ export interface SessionExternalBySessionResponse {
2442
+ channelId: number;
2443
+ sessionId: string;
2444
+ externalSessionId?: string;
2445
+ }
2446
+ export interface ChannelLotteryListParams extends V4PaginationParams {
2447
+ channelId: string;
2448
+ lotteryId?: string;
2449
+ sessionId?: string;
2450
+ startTime?: number;
2451
+ endTime?: number;
2452
+ }
2453
+ export interface ChannelLotteryCollectInfo {
2454
+ field: string;
2455
+ tips: string;
2456
+ }
2457
+ export interface ChannelLotteryRecord {
2458
+ winnerCount: number;
2459
+ totalUsers: number;
2460
+ lotteryId: string;
2461
+ channelId: number;
2462
+ userId: string;
2463
+ sessionId: string;
2464
+ lotteryRange?: string;
2465
+ actor?: string;
2466
+ prize?: string;
2467
+ amount?: number;
2468
+ preset?: string;
2469
+ lotteryExt?: {
2470
+ collectInfo?: ChannelLotteryCollectInfo[];
2471
+ [key: string]: unknown;
2472
+ };
2473
+ createdTime: number;
2474
+ }
2475
+ export type ChannelLotteryListResponse = V4ChannelPageResponse<ChannelLotteryRecord>;
2476
+ export interface AccountViewerConfig {
2477
+ actor?: string;
2478
+ actorEnabled?: YNFlag;
2479
+ questionStudentTitle?: string;
2480
+ questionStudentTitleEnabled?: YNFlag;
2481
+ }
2482
+ export interface LiveDataParams {
2483
+ channelId: string;
2484
+ startTime?: number;
2485
+ endTime?: number;
2486
+ }
2487
+ export interface LiveDataSummary {
2488
+ watchData?: {
2489
+ viewers?: number;
2490
+ plays?: number;
2491
+ playDuration?: number;
2492
+ averagePlayDuration?: number;
2493
+ pageView?: number;
2494
+ likes?: number;
2495
+ };
2496
+ realTimeData?: {
2497
+ maxConcurrent?: number;
2498
+ date?: number;
2499
+ };
2500
+ provinceData?: Array<{
2501
+ province?: string;
2502
+ viewers?: number;
2503
+ averagePlayDuration?: number;
2504
+ }>;
2505
+ }
2506
+ export interface SubtitleConfigParams {
2507
+ channelId: string | number;
2508
+ }
2509
+ export interface SubtitleConfig {
2510
+ realTimeSubtitleEnabled?: YNFlag;
2511
+ realTimeSubtitleDisplayEnabled?: YNFlag;
2512
+ sourceLanguage?: string;
2513
+ subtitleTranslationEnabled?: YNFlag;
2514
+ translationLanguage?: string;
2515
+ translationLanguages?: string[];
2516
+ subtitleCallbackEnabled?: YNFlag;
2517
+ subtitleCallbackUrl?: string;
2518
+ realTimeSubtitleDisplayNumberLimitEnabled?: YNFlag;
2519
+ realTimeSubtitleDisplayNumber?: number;
2520
+ }
2521
+ export interface SubtitleLanguageInfo {
2522
+ code: string;
2523
+ text: string;
2524
+ type: 'source' | 'translate' | 'all' | string;
2525
+ }
2526
+ export interface SessionStatsListParams extends V4PaginationParams {
2527
+ startTime?: number;
2528
+ endTime?: number;
2529
+ }
2530
+ export interface LiveSessionStatsItem {
2531
+ channelId: number;
2532
+ sessionId: string;
2533
+ name?: string;
2534
+ startTime?: number;
2535
+ endTime?: number;
2536
+ userId?: string;
2537
+ }
2538
+ export type SessionStatsListResponse = V4ChannelPageResponse<LiveSessionStatsItem>;
2539
+ export interface ListAllChannelBasicParams extends V4PaginationParams {
2540
+ categoryIds?: string | Array<string | number>;
2541
+ channelIds?: ChannelIdListInput;
2542
+ watchStatus?: WatchStatus | 'banpush' | string;
2543
+ startTime?: number;
2544
+ endTime?: number;
2545
+ orderBy?: 'startTimeDesc' | 'startTimeAsc' | 'channelCreatedTimeDesc' | string;
2546
+ }
2547
+ export interface ListAllChannelSimpleParams extends V4PaginationParams {
2548
+ categoryId?: string | number;
2549
+ watchStatus?: WatchStatus | 'banpush' | string;
2550
+ keyword?: string;
2551
+ orderBy?: 'startTimeDesc' | 'startTimeAsc' | 'channelCreatedTimeDesc' | string;
2552
+ }
2553
+ export interface AllChannelSimpleListItem {
2554
+ channelId: string;
2555
+ name: string;
2556
+ channelPasswd?: string;
2557
+ categoryId?: string;
2558
+ scene?: string;
2559
+ sceneText?: string;
2560
+ watchStatus?: string;
2561
+ watchStatusText?: string;
2562
+ watchUrl?: string;
2563
+ }
2564
+ export type ListAllChannelBasicResponse = V4ChannelPageResponse<ChannelBasicInfo>;
2565
+ export type ListAllChannelSimpleResponse = V4ChannelPageResponse<AllChannelSimpleListItem>;
2566
+ export interface WeixinBookingListParams extends V4PaginationParams {
2567
+ channelId: string;
2568
+ startTime?: number;
2569
+ endTime?: number;
2570
+ }
2571
+ export interface WeixinBookingItem {
2572
+ channelId: string | number;
2573
+ channelName?: string;
2574
+ openId: string;
2575
+ nickname?: string | null;
2576
+ createdTime: number;
2577
+ TBname?: string | null;
2578
+ TBnumber?: string | null;
2579
+ }
2580
+ export type WeixinBookingListResponse = V4ChannelPageResponse<WeixinBookingItem>;
2581
+ export interface InviteListParams extends V4PaginationParams {
2582
+ channelId: string;
2583
+ senderViewerId?: string;
2584
+ startTime?: number;
2585
+ endTime?: number;
2586
+ }
2587
+ export interface InviteListItem {
2588
+ invitee?: string | null;
2589
+ openId?: string;
2590
+ viewerId?: string;
2591
+ nickname?: string;
2592
+ avatar?: string;
2593
+ createdTime?: number;
2594
+ receiverNickname?: string;
2595
+ receiverOpenId?: string;
2596
+ receiverViewerId?: string;
2597
+ receiverTime?: number;
2598
+ receiverAvatar?: string;
2599
+ receiverPlayDuration?: number;
2600
+ receiverLivePlayDuration?: number;
2601
+ receiverPlaybackPlayDuration?: number;
2602
+ receiverCheckInCount?: number;
2603
+ receiverRegion?: string;
2604
+ receiverCity?: string;
2605
+ }
2606
+ export type InviteListResponse = V4ChannelPageResponse<InviteListItem>;
2607
+ export interface DistributeStatisticExactParams {
2608
+ channelId: string;
2609
+ sessionIds?: string | string[];
2610
+ startTime?: number;
2611
+ endTime?: number;
2612
+ }
2613
+ export interface DistributeStatisticItem {
2614
+ channelId: number;
2615
+ sessionId?: string;
2616
+ liveStartTime?: number;
2617
+ liveEndTime?: number;
2618
+ distributeUrl?: string;
2619
+ distributeStartTime?: number;
2620
+ distributeEndTime?: number;
2621
+ duration?: number;
2622
+ desc?: string;
2623
+ }
2624
+ export type DistributeStatisticExactResponse = DistributeStatisticItem[];
2625
+ export interface CreateInitBasicSetting extends CreateChannelParams {
2626
+ streamType?: 'client' | 'disk' | string;
2627
+ logoImg?: string;
2628
+ description?: string;
2629
+ }
2630
+ export interface CreateInitMasterAuthSetting {
2631
+ enabled: YNFlag;
2632
+ authType?: string;
2633
+ authCode?: string;
2634
+ codeAuthTips?: string;
2635
+ qCodeTips?: string;
2636
+ qCodeImg?: string;
2637
+ payAuthTips?: string;
2638
+ price?: number;
2639
+ watchEndTime?: number;
2640
+ validTimePeriod?: number;
2641
+ customKey?: string;
2642
+ customUri?: string;
2643
+ externalKey?: string;
2644
+ externalUri?: string;
2645
+ externalRedirectUri?: string;
2646
+ externalEntryText?: string;
2647
+ directKey?: string;
2648
+ }
2649
+ export interface CreateInitPlaybackSetting {
2650
+ playbackEnabled?: YNFlag;
2651
+ sectionEnabled?: YNFlag;
2652
+ type?: 'single' | 'list' | string;
2653
+ origin?: 'record' | 'playback' | 'vod' | string;
2654
+ }
2655
+ export interface ChannelRoleInput {
2656
+ role: 'Teacher' | 'Assistant' | 'Guest' | string;
2657
+ nickName?: string;
2658
+ actor?: string;
2659
+ passwd?: string;
2660
+ avatar?: string;
2661
+ }
2662
+ export interface CreateInitChannelParams {
2663
+ basicSetting: CreateInitBasicSetting;
2664
+ masterAuthSetting?: CreateInitMasterAuthSetting;
2665
+ playbackSetting?: CreateInitPlaybackSetting;
2666
+ roles?: ChannelRoleInput[];
2667
+ }
2668
+ export interface CreateInitChannelResponse extends CreateChannelResponse {
2669
+ name?: string;
2670
+ publisher?: string;
2671
+ description?: string;
2672
+ newScene?: string;
2673
+ template?: string;
2674
+ linkMicLimit?: number;
2675
+ pureRtcEnabled?: YNFlag;
2676
+ type?: string;
2677
+ currentTimeMillis?: number;
2678
+ }
2679
+ export interface AccountPurview {
2680
+ code: string;
2681
+ enabled: YNFlag;
2682
+ }
2683
+ export interface CreateAccountParams {
2684
+ channelId: string;
2685
+ role: 'Assistant' | 'Guest' | string;
2686
+ actor?: string;
2687
+ nickName?: string;
2688
+ avatar?: string;
2689
+ passwd?: string;
2690
+ purviewList?: AccountPurview[];
2691
+ }
2692
+ export interface ChannelRoleAccount {
2693
+ account: string;
2694
+ userId?: string;
2695
+ channelId: number;
2696
+ passwd?: string;
2697
+ nickname?: string;
2698
+ stream?: string;
2699
+ status?: YNFlag;
2700
+ createdTime?: number;
2701
+ lastModified?: number;
2702
+ sort?: number;
2703
+ avatar?: string;
2704
+ actor?: string;
2705
+ role?: string;
2706
+ monitorEnabled?: YNFlag;
2707
+ pageTurnEnabled?: YNFlag;
2708
+ chatListEnabled?: YNFlag;
2709
+ chatAuditEnabled?: YNFlag;
2710
+ }
2711
+ export interface UpdateAccountInfoParams {
2712
+ channelId: string;
2713
+ account: string;
2714
+ actor?: string;
2715
+ nickName?: string;
2716
+ avatar?: string;
2717
+ passwd?: string;
2718
+ purviewList?: AccountPurview[];
2719
+ }
2720
+ export interface DeleteAccountsBatchParams {
2721
+ channelId: string;
2722
+ accounts: string | string[];
2723
+ }
2724
+ export interface CreateMrChannelExactParams extends CreateMrChannelParams {
2725
+ startTime?: number;
2726
+ channelPasswd?: string;
2727
+ assistantPasswd?: string;
2728
+ splashImg?: string;
2729
+ subAccount?: string;
2730
+ }
2731
+ export interface CreateMrChannelExactResponse {
2732
+ channelId: string;
2733
+ name: string;
2734
+ userId: string;
2735
+ channelPasswd?: string;
2736
+ assistantAccount?: string;
2737
+ assistantPasswd?: string;
2738
+ }
2739
+ export interface MonitorListStreamInfoParams {
2740
+ channelId: string;
2741
+ startTime?: string | number;
2742
+ endTime?: string | number;
2743
+ }
2744
+ export interface MonitorStreamInfoPoint {
2745
+ audioFrameRate?: string;
2746
+ bitRate?: string;
2747
+ streamUrl?: string;
2748
+ time?: string;
2749
+ timestamp?: number;
2750
+ videoFrameRate?: string;
2751
+ }
2752
+ export interface BatchPlaybackVideoInfoParams {
2753
+ channelIds: ChannelIdListInput;
2754
+ }
2755
+ export interface PlaybackVideoInfoByChannel {
2756
+ channelId: number;
2757
+ vid?: string | null;
2758
+ videoId?: string | null;
2759
+ videoPoolId?: string | null;
2760
+ videoName?: string | null;
2761
+ firstImg?: string | null;
2762
+ duration?: string | null;
2763
+ }
2764
+ export interface LiveStatusListParams {
2765
+ channelIds: ChannelIdListInput;
2766
+ }
2767
+ export interface ChannelLiveStatusItem {
2768
+ channelId: number;
2769
+ liveStatus: WatchStatus | 'banpush' | string;
2770
+ }
2771
+ export interface TeacherListParams {
2772
+ channelIds: Array<string | number>;
2773
+ }
2774
+ export interface TeacherInfo {
2775
+ channelId: number;
2776
+ passwd?: string;
2777
+ userId?: string;
2778
+ nickname?: string;
2779
+ customTeacherId?: string;
2780
+ actor?: string;
2781
+ avatar?: string;
2782
+ globalSettingEnabled?: YNFlag;
2783
+ notifyEnabled?: YNFlag;
2784
+ checkinEnabled?: YNFlag;
2785
+ voteEnabled?: YNFlag;
2786
+ lotteryEnabled?: YNFlag;
2787
+ }
2788
+ export interface ChannelSubtitleBatchItem {
2789
+ id: number;
2790
+ name?: string;
2791
+ status?: 'publish' | 'finish' | string;
2792
+ }
2793
+ export interface UpdateChannelSubtitleBatchParams {
2794
+ channelId: string | number;
2795
+ body: ChannelSubtitleBatchItem[];
2796
+ }
2797
+ export interface UpdateSkinBatchParams {
2798
+ channelIds: ChannelIdListInput;
2799
+ skin: 'black' | 'red' | 'blue' | 'white' | 'green' | 'golden' | string;
2800
+ }
2801
+ export interface UpdateAccountViewerConfigParams extends AccountViewerConfig {
2802
+ channelId: string;
2803
+ }
2804
+ export interface SetPullBitrateExactParams {
2805
+ channelId: string;
2806
+ pullBitRate: -1 | 400 | 600 | 800 | 1000 | 1500 | 2000 | 2500 | number;
2807
+ }
2808
+ export interface UpdateTemplateExactParams {
2809
+ channelId: string;
2810
+ template: ChannelTemplate | string;
2811
+ }
2812
+ export interface UpdateSubtitleConfigParams extends SubtitleConfig {
2813
+ channelId: string | number;
2814
+ }
2815
+ export interface LotteryReceiveInfo {
2816
+ type?: 'userName' | 'userPhone' | 'custom' | string;
2817
+ field: string;
2818
+ tips: string;
2819
+ required?: boolean;
2820
+ }
2821
+ export interface LotteryPrizeInfo {
2822
+ prizeItem: string;
2823
+ correctAnswerCount: number;
2824
+ prizeName: string;
2825
+ thumbnail?: string;
2826
+ realPrice?: number;
2827
+ price?: number;
2828
+ acceptType: 'form' | 'link' | 'qrCode' | string;
2829
+ formInfo?: LotteryReceiveInfo[];
2830
+ prizeUrl?: string;
2831
+ qrCode?: string;
2832
+ qrCodeTips?: string;
2833
+ amount: number;
2834
+ hiddenWinnerAmount?: YNFlag;
2835
+ }
2836
+ export interface LotteryViewerGroup {
2837
+ id: number;
2838
+ title: string;
2839
+ type?: string;
2840
+ count?: number | string;
2841
+ createTime?: number;
2842
+ [key: string]: unknown;
2843
+ }
2844
+ export interface CreateLotteryViewerGroupParams {
2845
+ channelId: string | number;
2846
+ title: string;
2847
+ }
2848
+ export type CreateLotteryViewerGroupResponse = LotteryViewerGroup;
2849
+ export interface UpdateLotteryViewerGroupParams {
2850
+ channelId: string | number;
2851
+ id: string | number;
2852
+ title: string;
2853
+ }
2854
+ export type UpdateLotteryViewerGroupResponse = LotteryViewerGroup;
2855
+ export interface DeleteLotteryViewerGroupParams {
2856
+ channelId: string | number;
2857
+ id: string | number;
2858
+ }
2859
+ export interface ListLotteryViewerGroupsParams extends V4PaginationParams {
2860
+ channelId: string | number;
2861
+ }
2862
+ export type ListLotteryViewerGroupsResponse = V4ChannelPageResponse<LotteryViewerGroup>;
2863
+ export interface LotteryGroupViewer {
2864
+ id: number;
2865
+ groupId: string | number;
2866
+ viewerId: string;
2867
+ viewerName?: string;
2868
+ createTime?: number;
2869
+ [key: string]: unknown;
2870
+ }
2871
+ export interface ListLotteryGroupViewersParams extends V4PaginationParams {
2872
+ channelId: string | number;
2873
+ groupId: string | number;
2874
+ }
2875
+ export type ListLotteryGroupViewersResponse = V4ChannelPageResponse<LotteryGroupViewer>;
2876
+ export interface CreateLotteryGroupViewersParams {
2877
+ channelId: string | number;
2878
+ groupId: string | number;
2879
+ viewerIds: Array<string | number>;
2880
+ }
2881
+ export type CreateLotteryGroupViewersResponse = LotteryGroupViewer[];
2882
+ export interface DeleteLotteryGroupViewersParams {
2883
+ channelId: string | number;
2884
+ groupId: string | number;
2885
+ ids: Array<string | number>;
2886
+ }
2887
+ export interface LotteryGroupViewerName {
2888
+ viewerId: string;
2889
+ viewerName: string;
2890
+ }
2891
+ export interface CreateLotteryGroupViewerNamesParams {
2892
+ channelId: string | number;
2893
+ groupId: string | number;
2894
+ viewerNames: LotteryGroupViewerName[];
2895
+ }
2896
+ export type CreateLotteryGroupViewerNamesResponse = LotteryGroupViewer[];
2897
+ export interface LotteryBlacklistViewer {
2898
+ id: number;
2899
+ viewerId: string;
2900
+ viewerName?: string;
2901
+ createTime?: number;
2902
+ [key: string]: unknown;
2903
+ }
2904
+ export interface ListLotteryBlacklistViewersParams extends V4PaginationParams {
2905
+ channelId: string | number;
2906
+ }
2907
+ export type ListLotteryBlacklistViewersResponse = V4ChannelPageResponse<LotteryBlacklistViewer>;
2908
+ export interface CreateLotteryBlacklistViewersParams {
2909
+ channelId: string | number;
2910
+ viewerIds: Array<string | number>;
2911
+ }
2912
+ export type CreateLotteryBlacklistViewersResponse = LotteryBlacklistViewer[];
2913
+ export interface DeleteLotteryBlacklistViewersParams {
2914
+ channelId: string | number;
2915
+ ids: Array<string | number>;
2916
+ }
2917
+ export interface LuckyBagWinner {
2918
+ viewerId?: string;
2919
+ viewerName?: string;
2920
+ nickname?: string;
2921
+ mobile?: string;
2922
+ winTime?: number;
2923
+ [key: string]: unknown;
2924
+ }
2925
+ export interface ListLuckyBagWinnersParams {
2926
+ activityId: string | number;
2927
+ sessionId?: string;
2928
+ currentPage?: number;
2929
+ pageSize?: number;
2930
+ }
2931
+ export type ListLuckyBagWinnersResponse = V4ChannelPageResponse<LuckyBagWinner>;
2932
+ export interface InteractionEventTask {
2933
+ taskId: string;
2934
+ activityId: string;
2935
+ type: string;
2936
+ startTime: number;
2937
+ endTime: number;
2938
+ status: 'waiting' | 'running' | 'ended' | string;
2939
+ userTags?: string[];
2940
+ payload?: string;
2941
+ onlineTime?: number;
2942
+ signCount?: number;
2943
+ likesCount?: number;
2944
+ speakCount?: number;
2945
+ speakContent?: string;
2946
+ customCount?: number;
2947
+ eventType?: string;
2948
+ loginDays?: number;
2949
+ minOnlineTimePerDay?: number;
2950
+ logicType?: 'AND' | 'OR' | string;
2951
+ allDone?: YNFlag;
2952
+ isUnlock?: YNFlag;
2953
+ parentTaskId?: string;
2954
+ [key: string]: unknown;
2955
+ }
2956
+ export interface ListInteractionEventsParams {
2957
+ roomId: string;
2958
+ }
2959
+ export interface ListInteractionEventsResponse {
2960
+ list: InteractionEventTask[];
2961
+ }
2962
+ export interface DiskVideoCustomScript {
2963
+ id: number | string;
2964
+ channelId?: number | string;
2965
+ diskVideoId?: string;
2966
+ labelId?: number;
2967
+ [key: string]: unknown;
2968
+ }
2969
+ export interface QueryDiskVideoCustomScriptParams {
2970
+ channelId: string | number;
2971
+ diskVideoId: string;
2972
+ }
2973
+ export type QueryDiskVideoCustomScriptResponse = DiskVideoCustomScript[];
2974
+ export interface UploadDiskVideoCustomScriptParams {
2975
+ channelId: string | number;
2976
+ diskVideoId: string;
2977
+ file: File | Blob;
2978
+ labelId?: string | number;
2979
+ }
2980
+ export interface UploadDiskVideoCustomScriptResponse {
2981
+ id: number | string;
2982
+ }
2983
+ export interface DeleteInteractionScriptParams {
2984
+ channelId: string | number;
2985
+ id: string | number;
2986
+ }
2987
+ export interface InvitePosterCreateParams {
2988
+ channelId: string | number;
2989
+ openId: string;
2990
+ nickname: string;
2991
+ avatar?: string;
2992
+ viewerId?: string;
2993
+ invitee?: string;
2994
+ }
2995
+ export interface InvitePosterCreateResponse {
2996
+ [key: string]: unknown;
2997
+ }
2998
+ export interface LotteryActivityRecord {
2999
+ id?: number | string;
3000
+ channelId?: number | string;
3001
+ lotteryId?: string;
3002
+ sessionId?: string;
3003
+ activityName?: string;
3004
+ startTime?: number;
3005
+ winnerCount?: number;
3006
+ totalUsers?: number;
3007
+ [key: string]: unknown;
3008
+ }
3009
+ export interface ListLotteryActivityRecordsParams extends V4PaginationParams {
3010
+ channelId: string | number;
3011
+ sessionId?: string;
3012
+ startTimeBegin?: number;
3013
+ startTimeEnd?: number;
3014
+ lotteryId?: string;
3015
+ }
3016
+ export type ListLotteryActivityRecordsResponse = V4ChannelPageResponse<LotteryActivityRecord>;
3017
+ export interface CreateConditionWaitLotteryParams {
3018
+ channelId: string | number;
3019
+ id: string | number;
3020
+ lotteryTime: number;
3021
+ }
3022
+ export interface CreateConditionWaitLotteryResponse {
3023
+ [key: string]: unknown;
3024
+ }
3025
+ export interface RewardGiftRecord {
3026
+ viewerId?: string;
3027
+ viewerName?: string;
3028
+ giftName?: string;
3029
+ price?: number;
3030
+ count?: number;
3031
+ createTime?: number;
3032
+ [key: string]: unknown;
3033
+ }
3034
+ export interface ListRewardGiftsParams extends V4PaginationParams {
3035
+ channelId: string | number;
3036
+ start: number;
3037
+ end: number;
3038
+ }
3039
+ export type ListRewardGiftsResponse = V4ChannelPageResponse<RewardGiftRecord>;
3040
+ export interface RewardLikeRecord {
3041
+ viewerId?: string;
3042
+ viewerName?: string;
3043
+ likeCount?: number;
3044
+ createTime?: number;
3045
+ [key: string]: unknown;
3046
+ }
3047
+ export interface ListRewardLikesParams extends V4PaginationParams {
3048
+ channelId: string | number;
3049
+ start?: number;
3050
+ end?: number;
3051
+ }
3052
+ export type ListRewardLikesResponse = V4ChannelPageResponse<RewardLikeRecord>;
3053
+ export interface TaskRewardReachCondition {
3054
+ type: 'sign' | 'online' | 'questionnaire' | 'custom' | string;
3055
+ amount: number;
3056
+ templateId?: number;
3057
+ customEvent?: string;
3058
+ customEventName?: string;
3059
+ customIcon?: string;
3060
+ customUnit?: string;
3061
+ customButtonText?: string;
3062
+ customReachText?: string;
3063
+ }
3064
+ export interface TaskRewardSetting {
3065
+ type: 'cash' | 'custom' | 'nothing' | 'externalPoint' | string;
3066
+ amount?: number;
3067
+ limit?: number;
3068
+ customReward?: string;
3069
+ }
3070
+ export interface TaskRewardActivityTask {
3071
+ sort?: number;
3072
+ reachCondition: TaskRewardReachCondition;
3073
+ rewardSetting: TaskRewardSetting;
3074
+ }
3075
+ export interface TaskRewardActivity {
3076
+ activityId: number;
3077
+ channelId?: number | string;
3078
+ activityName?: string;
3079
+ taskRule?: number;
3080
+ startTime?: number;
3081
+ endTime?: number;
3082
+ status?: string;
3083
+ tasks?: TaskRewardActivityTask[];
3084
+ [key: string]: unknown;
3085
+ }
3086
+ export interface CreateTaskRewardActivityParams {
3087
+ channelId: string | number;
3088
+ activityName: string;
3089
+ taskRule: number;
3090
+ startTime: number;
3091
+ endTime: number;
3092
+ tasks: TaskRewardActivityTask[];
3093
+ }
3094
+ export type CreateTaskRewardActivityResponse = number;
3095
+ export interface UpdateTaskRewardActivityParams {
3096
+ channelId: string | number;
3097
+ activityId: string | number;
3098
+ tasks: TaskRewardActivityTask[];
3099
+ activityName?: string;
3100
+ taskRule?: number;
3101
+ startTime?: number;
3102
+ endTime?: number;
3103
+ }
3104
+ export interface ListTaskRewardActivitiesParams extends V4PaginationParams {
3105
+ channelId: string | number;
3106
+ }
3107
+ export type ListTaskRewardActivitiesResponse = V4ChannelPageResponse<TaskRewardActivity>;
3108
+ export interface DeleteTaskRewardActivityParams {
3109
+ activityId: string | number;
3110
+ }
3111
+ export interface StopTaskRewardActivityParams {
3112
+ activityId: string | number;
3113
+ }
3114
+ export interface ListTaskRewardStatsParams extends V4PaginationParams {
3115
+ channelId: string | number;
3116
+ }
3117
+ export interface TaskRewardStatsRecord {
3118
+ activityId?: number | string;
3119
+ activityName?: string;
3120
+ submitCount?: number;
3121
+ rewardCount?: number;
3122
+ [key: string]: unknown;
3123
+ }
3124
+ export type ListTaskRewardStatsResponse = V4ChannelPageResponse<TaskRewardStatsRecord>;
3125
+ export interface ListTaskRewardViewerDetailsParams extends V4PaginationParams {
3126
+ channelId: string | number;
3127
+ activityId: string | number;
3128
+ viewerId?: string;
3129
+ }
3130
+ export interface TaskRewardViewerDetailRecord {
3131
+ id?: number | string;
3132
+ activityId?: number | string;
3133
+ viewerId?: string;
3134
+ formInfo?: TaskRewardAcceptFormInfo[];
3135
+ [key: string]: unknown;
3136
+ }
3137
+ export type ListTaskRewardViewerDetailsResponse = V4ChannelPageResponse<TaskRewardViewerDetailRecord>;
3138
+ export interface ListViewerTaskRewardDetailsParams extends V4PaginationParams {
3139
+ viewerId: string;
3140
+ }
3141
+ export type ListViewerTaskRewardDetailsResponse = V4ChannelPageResponse<TaskRewardViewerDetailRecord>;
3142
+ export interface TaskRewardAcceptFormInfo {
3143
+ field: string;
3144
+ value?: string;
3145
+ type?: string;
3146
+ [key: string]: unknown;
3147
+ }
3148
+ export interface SubmitViewerTaskRewardAcceptInfoParams {
3149
+ id: string | number;
3150
+ viewerId: string;
3151
+ formInfo: TaskRewardAcceptFormInfo[];
3152
+ }
3153
+ export interface GiftDonatePayItem {
3154
+ name?: string;
3155
+ enabled?: YNFlag;
3156
+ imgType?: 'STATIC' | 'DYNAMIC' | string;
3157
+ img?: string;
3158
+ dynamicImg?: string;
3159
+ dynamicFile?: string;
3160
+ price?: number | string;
3161
+ }
3162
+ export interface GiftDonateConfig {
3163
+ payWay?: 'CASH' | 'POINT' | string;
3164
+ pointUnit?: string;
3165
+ cashPays?: GiftDonatePayItem[];
3166
+ pointPays?: GiftDonatePayItem[];
3167
+ }
3168
+ export interface UpdateDonateGiftParams {
3169
+ channelId: string | number;
3170
+ donateGiftEnabled: YNFlag;
3171
+ giftDonate?: GiftDonateConfig;
3172
+ }
2488
3173
  export interface ListCardPushesParams {
2489
3174
  channelId: string | number;
2490
3175
  }
2491
3176
  export type ListCardPushesResponse = CardPushInfo[];
3177
+ export interface CardPushIdParams {
3178
+ channelId: string | number;
3179
+ cardPushId: string | number;
3180
+ }
3181
+ export interface CouponEnabled {
3182
+ enabled: YNFlag;
3183
+ [key: string]: unknown;
3184
+ }
3185
+ export interface CouponEnabledParams {
3186
+ channelId: string | number;
3187
+ }
3188
+ export interface UpdateCouponEnabledParams extends CouponEnabledParams {
3189
+ enabled: YNFlag;
3190
+ }
3191
+ export interface ChannelCoupon {
3192
+ couponId?: string;
3193
+ name?: string;
3194
+ status?: string;
3195
+ [key: string]: unknown;
3196
+ }
3197
+ export interface ListChannelCouponsParams extends V4PaginationParams {
3198
+ channelId: string | number;
3199
+ name?: string;
3200
+ }
3201
+ export type ListChannelCouponsResponse = V4ChannelPageResponse<ChannelCoupon>;
3202
+ export interface DeleteChannelCouponsParams {
3203
+ channelId: string | number;
3204
+ couponIds: Array<string | number>;
3205
+ }
3206
+ export interface ProductPushRule {
3207
+ productExplainEnabled?: YNFlag;
3208
+ productExplainingAutoPushAndSticky?: YNFlag;
3209
+ productListSortType?: 'ASC' | 'DESC' | string;
3210
+ productTagSortType?: 'DEFAULT' | 'CUSTOM' | string;
3211
+ productPushRule?: 'smallCard' | 'bigCard' | 'chooseCard' | string;
3212
+ productHotEffectEnabled?: YNFlag;
3213
+ normalProductHotEffectTips?: string;
3214
+ jobProductHotEffectTips?: string;
3215
+ financeProductHotEffectTips?: string;
3216
+ outLinkProductRedirectEnabled?: YNFlag;
3217
+ productTagSortOrderIds?: Array<string | number>;
3218
+ [key: string]: unknown;
3219
+ }
3220
+ export interface ProductPushRuleParams {
3221
+ channelId: string | number;
3222
+ }
3223
+ export interface UpdateProductPushRuleParams extends ProductPushRuleParams, ProductPushRule {
3224
+ }
3225
+ export interface ProductStatsExact {
3226
+ productId?: string | number;
3227
+ productName?: string;
3228
+ viewCount?: number;
3229
+ clickCount?: number;
3230
+ [key: string]: unknown;
3231
+ }
3232
+ export interface ListProductStatsParams extends V4PaginationParams {
3233
+ channelId: string | number;
3234
+ productId?: string;
3235
+ productName?: string;
3236
+ sessionId?: string;
3237
+ }
3238
+ export type ListProductStatsResponse = V4ChannelPageResponse<ProductStatsExact>;
3239
+ export interface ProductStatsSummaryParams {
3240
+ channelId: string | number;
3241
+ sessionId?: string;
3242
+ }
3243
+ export interface ProductStatsSummary {
3244
+ [key: string]: unknown;
3245
+ }
3246
+ export interface SortChannelProductRankParams {
3247
+ channelId: string | number;
3248
+ productId: string | number;
3249
+ rank: number;
3250
+ }
3251
+ export interface ChannelProductActionParams {
3252
+ channelId: string | number;
3253
+ productId: string | number;
3254
+ }
3255
+ export interface BatchCreatePopularizationsExactParams {
3256
+ channelId: string | number;
3257
+ names: string[];
3258
+ }
3259
+ export interface PopularizationExact {
3260
+ id?: number | string;
3261
+ name?: string;
3262
+ url?: string;
3263
+ [key: string]: unknown;
3264
+ }
3265
+ export type BatchCreatePopularizationsExactResponse = PopularizationExact[];
3266
+ export interface ListPopularizationsExactParams {
3267
+ channelId: string | number;
3268
+ }
3269
+ export type ListPopularizationsExactResponse = PopularizationExact[];
3270
+ export interface RecordFileExact {
3271
+ fileId?: string;
3272
+ channelId?: string | number;
3273
+ name?: string;
3274
+ duration?: number;
3275
+ [key: string]: unknown;
3276
+ }
3277
+ export interface ListMaterialRecordFilesParams extends V4PaginationParams {
3278
+ channelId: string | number;
3279
+ }
3280
+ export type ListMaterialRecordFilesResponse = V4ChannelPageResponse<RecordFileExact>;
3281
+ export interface CreateRecordFileOutlineParams {
3282
+ fileId: string;
3283
+ aiKnowledgeQuizEnabled?: YNFlag;
3284
+ aiSummaryAuditEnabled?: YNFlag;
3285
+ syncToPlaybackDotEnabled?: YNFlag;
3286
+ }
3287
+ export interface RecordFileOutline {
3288
+ fileId?: string;
3289
+ outline?: unknown;
3290
+ [key: string]: unknown;
3291
+ }
3292
+ export interface GetRecordFileOutlineParams {
3293
+ channelId: string | number;
3294
+ fileId: string;
3295
+ }
3296
+ export interface RecordFileSubtitlePublishItem {
3297
+ id: string | number;
3298
+ status: 'finish' | 'publish' | string;
3299
+ }
3300
+ export interface BatchPublishRecordFileSubtitlesParams {
3301
+ subtitles: RecordFileSubtitlePublishItem[];
3302
+ }
3303
+ export interface WatchViewerLogoutParams {
3304
+ channelId: string | number;
3305
+ token?: string;
3306
+ }
3307
+ export interface BatchUpdateChatEnabledParams {
3308
+ channelIds: Array<string | number>;
3309
+ chatEnabled: YNFlag;
3310
+ }
2492
3311
  /** V4 Pagination parameters */
2493
3312
  export interface V4PaginationParams {
2494
3313
  /** Page number (1-based) */
@@ -2509,7 +3328,6 @@ export interface V4PaginatedResponse<T> {
2509
3328
  /** Page size */
2510
3329
  pageSize?: number;
2511
3330
  }
2512
- export type V4ChannelPageResponse<T> = V4PaginatedResponse<T>;
2513
3331
  /** Channel ID parameter */
2514
3332
  export interface ChannelIdParam {
2515
3333
  /** Channel ID */