polyv-live-api-sdk 1.0.13 → 1.0.14-rc.0

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 (67) 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 +17 -16
  67. package/LICENSE +0 -21
@@ -102,10 +102,14 @@ export interface GetChildAccountParams {
102
102
  * Parameters for updating a child account
103
103
  */
104
104
  export interface UpdateChildAccountParams {
105
- /** Child user ID (required) */
106
- childUserId: string;
105
+ /** Sub-account login email (required by current API docs) */
106
+ childEmail?: string;
107
+ /** Legacy child user ID alias */
108
+ childUserId?: string;
107
109
  /** Sub-account name */
108
110
  childName?: string;
111
+ /** Password */
112
+ password?: string;
109
113
  /** Phone number */
110
114
  telephone?: string;
111
115
  /** Description */
@@ -119,40 +123,81 @@ export interface UpdateChildAccountParams {
119
123
  * Parameters for deleting child accounts
120
124
  */
121
125
  export interface DeleteChildAccountsParams {
126
+ /** Sub-account login email */
127
+ childEmail?: string;
128
+ /** Sub-account login emails */
129
+ childEmails?: string[];
122
130
  /** Array of child user IDs to delete */
123
- childUserIds: string[];
131
+ childUserIds?: string[];
124
132
  }
125
133
  /**
126
134
  * Child account role entity
127
135
  */
128
136
  export interface ChildAccountRole {
129
137
  /** Role ID */
130
- roleId: number;
138
+ id: number;
131
139
  /** Role name */
132
- roleName: string;
140
+ name: string;
141
+ /** Role description */
142
+ description?: string;
143
+ /** Comma-separated permission names */
144
+ permissionName?: string;
133
145
  }
134
146
  /**
135
147
  * Parameters for getting child account by sale
136
148
  */
137
149
  export interface GetBySaleParams {
138
- /** Sale identifier */
139
- sale: string;
150
+ /** Sale ID. Required when saleCode is omitted. */
151
+ saleId?: string;
152
+ /** Sale invitation code. Required when saleId is omitted. */
153
+ saleCode?: string;
154
+ }
155
+ /**
156
+ * Invite customer sale account information
157
+ */
158
+ export interface InviteCustomerInfo {
159
+ /** PolyV user ID */
160
+ userId?: string;
161
+ /** Child account user ID */
162
+ childUserId?: string;
163
+ /** Child account name */
164
+ childName?: string;
165
+ /** Child account email */
166
+ childEmail?: string;
167
+ /** Child account avatar */
168
+ avatar?: string;
169
+ /** Child account telephone */
170
+ telephone?: string;
140
171
  }
141
172
  /**
142
173
  * Organization entity
143
174
  */
144
175
  export interface Organization {
145
176
  /** Organization ID */
146
- organizationId: number;
177
+ organizationId?: number;
178
+ /** Organization ID returned by API */
179
+ id?: number;
147
180
  /** Organization name */
148
- organizationName: string;
181
+ organizationName?: string;
182
+ /** Organization name returned by API */
183
+ name?: string;
184
+ /** Organization description */
185
+ description?: string;
186
+ /** Parent organization ID */
187
+ parentId?: number;
149
188
  }
150
189
  /**
151
190
  * Parameters for creating an organization
152
191
  */
153
192
  export interface CreateOrganizationParams {
154
- /** Organization name */
155
- organizationName: string;
193
+ /** Organization name (required by current API docs) */
194
+ name?: string;
195
+ /** Parent organization ID (required by current API docs) */
196
+ parentId?: number;
197
+ /** Organization description */
198
+ description?: string;
199
+ /** Legacy organization name alias */
200
+ organizationName?: string;
156
201
  }
157
202
  /**
158
203
  * Response for creating an organization
@@ -291,30 +336,94 @@ export interface DirectAuthViewerParams {
291
336
  export interface ExternalViewerItem {
292
337
  /** Viewer nickname */
293
338
  nickname: string;
294
- /** Phone number */
295
- mobile: string;
296
- /** Name */
297
- name?: string;
298
- /** Email */
299
- email?: string;
300
- /** Area */
301
- area?: string;
339
+ /** External viewer ID */
340
+ externalViewerId: string;
341
+ /** Viewer label IDs */
342
+ labelIds?: Array<string | number>;
343
+ /** Follow user info */
344
+ followUsers?: ViewerFollowUser;
345
+ }
346
+ /**
347
+ * Viewer follow user info
348
+ */
349
+ export interface ViewerFollowUser {
350
+ /** Follow user ID */
351
+ userId: string;
352
+ /** Follow user type, defaults to wxwork */
353
+ type?: string;
302
354
  }
303
355
  /**
304
356
  * Parameters for importing external viewers
305
357
  */
306
- export interface ImportExternalViewerParams {
307
- /** Array of viewers to import */
308
- viewers: ExternalViewerItem[];
358
+ export type ImportExternalViewerParams = ExternalViewerItem[];
359
+ /**
360
+ * Imported external viewer item
361
+ */
362
+ export interface ImportedExternalViewer {
363
+ /** Viewer union ID */
364
+ viewerUnionId: string;
365
+ /** Viewer nickname */
366
+ nickname: string;
367
+ /** External viewer ID */
368
+ externalViewerId: string;
369
+ /** Viewer source */
370
+ source?: ViewerSource;
371
+ /** Latest auth timestamp */
372
+ latestAuthTime?: number;
373
+ /** Created timestamp */
374
+ createTime?: number;
375
+ }
376
+ /**
377
+ * Response for importing external viewers
378
+ */
379
+ export type ImportExternalViewerResponse = ImportedExternalViewer[];
380
+ /**
381
+ * Y/N switch value
382
+ */
383
+ export type UserSwitchValue = 'Y' | 'N';
384
+ /**
385
+ * Tourist external auth link config
386
+ */
387
+ export interface TouristExternalHrefConfig {
388
+ pcLink?: string;
389
+ mobileLink?: string;
390
+ androidLink?: string;
391
+ iosLink?: string;
392
+ otherLink?: string;
393
+ wxMiniprogramLink?: string;
394
+ wxMiniprogramOriginalId?: string;
395
+ wxMiniprogramAppId?: string;
396
+ mobileAppLink?: string;
397
+ harmonyLink?: string;
398
+ jumpWay?: string;
399
+ }
400
+ /**
401
+ * Parameters for updating viewer user system config
402
+ */
403
+ export interface UpdateViewerUserSystemConfigParams {
404
+ /** Mobile login switch */
405
+ mobileLoginEnabled: UserSwitchValue;
406
+ /** WeCom login switch */
407
+ wxWorkLoginEnabled: UserSwitchValue;
408
+ /** WeChat auth validity period in days, 0-180 */
409
+ viewerWeixinAuthExpired?: number;
410
+ /** Collect mobile switch */
411
+ collectMobileEnabled?: UserSwitchValue;
412
+ /** Guest mode switch */
413
+ guestModeEnabled?: UserSwitchValue;
414
+ /** Tourist external login switch */
415
+ touristExternalHrefEnabled?: UserSwitchValue;
416
+ /** Tourist external login link config */
417
+ touristExternalHrefConfig?: TouristExternalHrefConfig;
309
418
  }
310
419
  /**
311
420
  * Viewer label entity
312
421
  */
313
422
  export interface ViewerLabel {
314
423
  /** Label ID */
315
- labelId: number;
424
+ id: string | number;
316
425
  /** Label name */
317
- labelName: string;
426
+ label: string;
318
427
  }
319
428
  /**
320
429
  * Response for listing viewer labels
@@ -327,29 +436,28 @@ export interface ListViewerLabelsResponse {
327
436
  * Parameters for creating a viewer label
328
437
  */
329
438
  export interface CreateViewerLabelParams {
330
- /** Label name */
331
- labelName: string;
439
+ /** Label names */
440
+ labels: string[];
332
441
  }
333
442
  /**
334
443
  * Response for creating a viewer label
335
444
  */
336
- export interface CreateViewerLabelResponse extends ViewerLabel {
337
- }
445
+ export type CreateViewerLabelResponse = ViewerLabel[];
338
446
  /**
339
447
  * Parameters for updating a viewer label
340
448
  */
341
449
  export interface UpdateViewerLabelParams {
342
450
  /** Label ID */
343
- labelId: number;
451
+ id: string | number;
344
452
  /** Label name */
345
- labelName: string;
453
+ label?: string;
346
454
  }
347
455
  /**
348
456
  * Parameters for deleting a viewer label
349
457
  */
350
458
  export interface DeleteViewerLabelParams {
351
459
  /** Label ID */
352
- labelId: number;
460
+ id: string | number;
353
461
  }
354
462
  /**
355
463
  * Parameters for adding a label to viewer
@@ -385,12 +493,56 @@ export interface Product {
385
493
  link?: string;
386
494
  /** Product type (normal, finance, position) */
387
495
  productType?: string;
496
+ /** PC link */
497
+ pcLink?: string;
498
+ /** Mobile link */
499
+ mobileLink?: string;
500
+ /** WeChat mini program original ID */
501
+ wxMiniprogramOriginalId?: string;
502
+ /** WeChat mini program link */
503
+ wxMiniprogramLink?: string;
504
+ /** Mobile app link */
505
+ mobileAppLink?: string;
506
+ /** iOS link */
507
+ iosLink?: string;
508
+ /** Android link */
509
+ androidLink?: string;
510
+ /** Other platform link */
511
+ otherLink?: string;
512
+ /** Product features as a JSON array string */
513
+ features?: string;
388
514
  /** Original price */
389
515
  price?: number;
390
516
  /** Actual price */
391
517
  realPrice?: number;
518
+ /** Actual price type */
519
+ priceType?: string;
520
+ /** Custom actual price */
521
+ customPrice?: string;
522
+ /** Original price type */
523
+ originalPriceType?: string;
524
+ /** Custom original price */
525
+ customOriginalPrice?: string;
526
+ /** API typo preserved for compatibility with the source document */
527
+ customOrignalPrice?: string;
392
528
  /** Product tag IDs */
393
529
  tagIds?: number[];
530
+ /** Button label */
531
+ btnShow?: string;
532
+ /** Product description */
533
+ productDesc?: string;
534
+ /** Product detail */
535
+ productDetail?: string;
536
+ /** Extended product information as a JSON object string */
537
+ ext?: string;
538
+ /** Product rank */
539
+ rank?: number;
540
+ /** Legacy type field returned by some APIs */
541
+ type?: string;
542
+ /** Extra returned params */
543
+ params?: unknown;
544
+ /** Yield/rate for finance products */
545
+ yield?: string | number | null;
394
546
  }
395
547
  /**
396
548
  * Parameters for listing products
@@ -420,18 +572,53 @@ export interface CreateProductParams {
420
572
  cover?: string;
421
573
  /** Product type */
422
574
  productType?: string;
575
+ /** PC link */
576
+ pcLink?: string;
577
+ /** Mobile link */
578
+ mobileLink?: string;
579
+ /** WeChat mini program original ID */
580
+ wxMiniprogramOriginalId?: string;
581
+ /** WeChat mini program link */
582
+ wxMiniprogramLink?: string;
583
+ /** Mobile app link */
584
+ mobileAppLink?: string;
585
+ /** iOS link */
586
+ iosLink?: string;
587
+ /** Android link */
588
+ androidLink?: string;
589
+ /** Other platform link */
590
+ otherLink?: string;
591
+ /** Product features as a JSON array string */
592
+ features?: string;
423
593
  /** Original price */
424
594
  price?: number;
425
595
  /** Actual price */
426
596
  realPrice?: number;
597
+ /** Actual price type */
598
+ priceType?: string;
599
+ /** Custom actual price */
600
+ customPrice?: string;
601
+ /** Original price type */
602
+ originalPriceType?: string;
603
+ /** Custom original price */
604
+ customOriginalPrice?: string;
605
+ /** API typo preserved for compatibility with the source document */
606
+ customOrignalPrice?: string;
427
607
  /** Product tag IDs */
428
608
  tagIds?: number[];
609
+ /** Button label */
610
+ btnShow?: string;
611
+ /** Product description */
612
+ productDesc?: string;
613
+ /** Product detail */
614
+ productDetail?: string;
615
+ /** Extended product information as a JSON object string */
616
+ ext?: string;
429
617
  }
430
618
  /**
431
619
  * Response for creating a product
432
620
  */
433
- export interface CreateProductResponse extends Product {
434
- }
621
+ export type CreateProductResponse = string | null;
435
622
  /**
436
623
  * Parameters for updating a product
437
624
  */
@@ -448,12 +635,48 @@ export interface UpdateProductParams {
448
635
  cover?: string;
449
636
  /** Product type */
450
637
  productType?: string;
638
+ /** PC link */
639
+ pcLink?: string;
640
+ /** Mobile link */
641
+ mobileLink?: string;
642
+ /** WeChat mini program original ID */
643
+ wxMiniprogramOriginalId?: string;
644
+ /** WeChat mini program link */
645
+ wxMiniprogramLink?: string;
646
+ /** Mobile app link */
647
+ mobileAppLink?: string;
648
+ /** iOS link */
649
+ iosLink?: string;
650
+ /** Android link */
651
+ androidLink?: string;
652
+ /** Other platform link */
653
+ otherLink?: string;
654
+ /** Product features as a JSON array string */
655
+ features?: string;
451
656
  /** Original price */
452
657
  price?: number;
453
658
  /** Actual price */
454
659
  realPrice?: number;
660
+ /** Actual price type */
661
+ priceType?: string;
662
+ /** Custom actual price */
663
+ customPrice?: string;
664
+ /** Original price type */
665
+ originalPriceType?: string;
666
+ /** Custom original price */
667
+ customOriginalPrice?: string;
668
+ /** API typo preserved for compatibility with the source document */
669
+ customOrignalPrice?: string;
455
670
  /** Product tag IDs */
456
671
  tagIds?: number[];
672
+ /** Button label */
673
+ btnShow?: string;
674
+ /** Product description */
675
+ productDesc?: string;
676
+ /** Product detail */
677
+ productDetail?: string;
678
+ /** Extended product information as a JSON object string */
679
+ ext?: string;
457
680
  }
458
681
  /**
459
682
  * Parameters for deleting a product
@@ -467,23 +690,44 @@ export interface DeleteProductParams {
467
690
  */
468
691
  export interface ProductTag {
469
692
  /** Tag ID */
470
- tagId: number;
693
+ id: number;
471
694
  /** Tag name */
472
- tagName: string;
695
+ name: string;
696
+ /** Legacy alias for tag ID */
697
+ tagId?: number;
698
+ /** Legacy alias for tag name */
699
+ tagName?: string;
700
+ /** Tag type */
701
+ type?: string;
702
+ /** Number of linked products */
703
+ productCount?: number;
704
+ /** Created timestamp */
705
+ createTime?: string | number;
706
+ /** Updated timestamp */
707
+ updateTime?: string | number | null;
708
+ }
709
+ /**
710
+ * Parameters for listing product tags
711
+ */
712
+ export interface ListProductTagsParams extends UserPaginationParams {
713
+ /** Channel ID */
714
+ channelId: string | number;
715
+ /** Keyword search */
716
+ keyword?: string;
473
717
  }
474
718
  /**
475
719
  * Response for listing product tags
476
720
  */
477
- export interface ListProductTagsResponse {
478
- /** Tag list */
479
- contents: ProductTag[];
721
+ export interface ListProductTagsResponse extends UserPaginatedResponse<ProductTag> {
480
722
  }
481
723
  /**
482
724
  * Parameters for creating a product tag
483
725
  */
484
726
  export interface CreateProductTagParams {
485
727
  /** Tag name */
486
- tagName: string;
728
+ name?: string;
729
+ /** Legacy alias for tag name */
730
+ tagName?: string;
487
731
  }
488
732
  /**
489
733
  * Response for creating a product tag
@@ -495,29 +739,85 @@ export interface CreateProductTagResponse extends ProductTag {
495
739
  */
496
740
  export interface UpdateProductTagParams {
497
741
  /** Tag ID */
498
- tagId: number;
742
+ id?: number;
499
743
  /** Tag name */
500
- tagName: string;
744
+ name?: string;
745
+ /** Legacy alias for tag ID */
746
+ tagId?: number;
747
+ /** Legacy alias for tag name */
748
+ tagName?: string;
501
749
  }
502
750
  /**
503
751
  * Parameters for deleting a product tag
504
752
  */
505
753
  export interface DeleteProductTagParams {
506
754
  /** Tag ID */
507
- tagId: number;
755
+ id?: number;
756
+ /** Legacy alias for tag ID */
757
+ tagId?: number;
508
758
  }
509
759
  /**
510
760
  * Product order entity
511
761
  */
512
762
  export interface ProductOrder {
513
- /** Order ID */
514
- orderId: string;
515
- /** Product ID */
516
- productId: string;
763
+ /** Order number */
764
+ orderNo: string;
765
+ /** Channel ID */
766
+ channelId?: number;
767
+ /** Viewer ID */
768
+ viewerId?: string;
769
+ /** Viewer nickname */
770
+ viewerNickName?: string;
771
+ /** WeChat transaction ID */
772
+ transactionId?: string;
773
+ /** Order amount */
774
+ amount?: number;
775
+ /** Whether express delivery is enabled */
776
+ expressEnabled?: string;
517
777
  /** Status */
518
778
  status: string;
519
779
  /** Created timestamp */
520
780
  createTime?: number;
781
+ /** Paid timestamp */
782
+ payTime?: number;
783
+ /** Delivery timestamp */
784
+ deliveryTime?: number;
785
+ /** Finish timestamp */
786
+ finishTime?: number;
787
+ /** Shipping address */
788
+ addressExt?: ProductOrderAddress;
789
+ /** Ordered products */
790
+ products?: ProductOrderProduct[];
791
+ }
792
+ /**
793
+ * Product order address
794
+ */
795
+ export interface ProductOrderAddress {
796
+ /** Mobile phone number */
797
+ mobile?: string;
798
+ /** Receiver name */
799
+ name?: string;
800
+ /** Province/city/area */
801
+ area?: string;
802
+ /** Detailed address */
803
+ address?: string;
804
+ }
805
+ /**
806
+ * Product item in an order
807
+ */
808
+ export interface ProductOrderProduct {
809
+ /** Product snapshot ID */
810
+ productSnapshotId?: number;
811
+ /** Product amount */
812
+ amount?: number;
813
+ /** Quantity */
814
+ quantity?: number;
815
+ /** Total amount */
816
+ totalAmount?: number;
817
+ /** Product name */
818
+ productName?: string;
819
+ /** Product cover image */
820
+ productCover?: string;
521
821
  }
522
822
  /**
523
823
  * Parameters for listing product orders
@@ -533,33 +833,56 @@ export interface ListProductOrdersResponse extends UserPaginatedResponse<Product
533
833
  * Parameters for getting a product order
534
834
  */
535
835
  export interface GetProductOrderParams {
536
- /** Order ID */
537
- orderId: string;
836
+ /** Order number */
837
+ orderNo: string;
538
838
  }
539
839
  /**
540
840
  * Parameters for batch updating order status
541
841
  */
542
842
  export interface BatchUpdateOrderStatusParams {
543
- /** Order IDs */
544
- orderIds: string[];
843
+ /** Order numbers, maximum 1000 */
844
+ orderNos: string[];
545
845
  /** New status */
546
846
  status: string;
547
847
  }
848
+ /**
849
+ * Failed order status update result
850
+ */
851
+ export interface BatchUpdateOrderStatusFailOrder {
852
+ /** Order number */
853
+ orderNo: string;
854
+ /** Error code */
855
+ errCode: number;
856
+ /** Error message */
857
+ errMsg: string;
858
+ }
859
+ /**
860
+ * Response for batch updating order status
861
+ */
862
+ export interface BatchUpdateOrderStatusResponse {
863
+ /** Successfully updated order numbers */
864
+ successOrderNos?: string[];
865
+ /** Failed order updates */
866
+ failOrderList?: BatchUpdateOrderStatusFailOrder[];
867
+ }
548
868
  /**
549
869
  * Label entity
550
870
  */
551
871
  export interface Label {
552
872
  /** Label ID */
553
- labelId: number;
873
+ id: string;
554
874
  /** Label name */
555
- labelName: string;
875
+ name: string;
876
+ }
877
+ /**
878
+ * Parameters for listing labels
879
+ */
880
+ export interface ListLabelsParams extends UserPaginationParams {
556
881
  }
557
882
  /**
558
883
  * Response for listing labels
559
884
  */
560
- export interface ListLabelsResponse {
561
- /** Label list */
562
- contents: Label[];
885
+ export interface ListLabelsResponse extends UserPaginatedResponse<Label> {
563
886
  }
564
887
  /**
565
888
  * Parameters for creating a label
@@ -578,7 +901,7 @@ export interface CreateLabelResponse extends Label {
578
901
  */
579
902
  export interface UpdateLabelParams {
580
903
  /** Label ID */
581
- labelId: number;
904
+ labelId: string;
582
905
  /** Label name */
583
906
  labelName: string;
584
907
  }
@@ -587,265 +910,468 @@ export interface UpdateLabelParams {
587
910
  */
588
911
  export interface DeleteLabelParams {
589
912
  /** Label ID */
590
- labelId: number;
913
+ labelId: string;
591
914
  }
592
915
  /**
593
916
  * Parameters for adding channel label refs
594
917
  */
595
918
  export interface AddChannelLabelRefsParams {
596
- /** Label ID */
597
- labelId: number;
919
+ /** Label IDs */
920
+ labelIds: string[];
598
921
  /** Channel IDs */
599
- channelIds: string[];
922
+ channelIds: Array<string | number>;
600
923
  }
601
924
  /**
602
925
  * Invite sale entity
603
926
  */
604
927
  export interface InviteSale {
605
- /** Invite ID */
606
- inviteId: number;
928
+ /** Invite sale user ID */
929
+ viewerUnionId: string;
607
930
  /** Nickname */
608
931
  nickname: string;
932
+ /** WeChat nickname */
933
+ wxNickName?: string | null;
934
+ /** WeChat avatar */
935
+ wxAvatar?: string | null;
936
+ /** Mobile phone number */
937
+ mobile?: string | null;
938
+ /** Source */
939
+ inviteSalesSource?: string;
940
+ /** Granted timestamp */
941
+ inviteSalesGrantedTime?: number;
942
+ /** Organization ID */
943
+ organizationId?: number;
944
+ /** Organization name */
945
+ organizationName?: string;
946
+ /** Whether the user is an invite sales admin */
947
+ inviteSalesAdmin?: string;
948
+ /** Bound customer count */
949
+ customerNum?: number;
950
+ }
951
+ /**
952
+ * Parameters for listing invite sales
953
+ */
954
+ export interface ListInviteSalesParams {
955
+ /** Invite sale user ID, exact match */
956
+ viewerUnionId?: string;
957
+ /** Mobile phone number, exact match */
958
+ mobile?: string;
959
+ /** Nickname keyword */
960
+ keyword?: string;
961
+ /** Organization ID */
962
+ organizationId?: number;
963
+ /** Page size */
964
+ pageSize?: number;
965
+ /** Page number */
966
+ pageNumber?: number;
609
967
  }
610
968
  /**
611
969
  * Response for listing invite sales
612
970
  */
613
- export interface ListInviteSalesResponse {
614
- /** Invite sales list */
615
- contents: InviteSale[];
971
+ export interface ListInviteSalesResponse extends UserPaginatedResponse<InviteSale> {
616
972
  }
617
973
  /**
618
974
  * Parameters for adding an invite sale
619
975
  */
620
976
  export interface AddInviteSaleParams {
621
- /** Nickname */
622
- nickname: string;
977
+ /** User IDs to add as invite sales, maximum 200 */
978
+ viewerUnionIds: string[];
979
+ /** Organization ID, defaults to headquarters when omitted */
980
+ organizationId?: number;
623
981
  }
624
982
  /**
625
983
  * Response for adding an invite sale
626
984
  */
627
- export interface AddInviteSaleResponse extends InviteSale {
628
- }
985
+ export type AddInviteSaleResponse = void;
629
986
  /**
630
987
  * Parameters for updating an invite sale
631
988
  */
632
989
  export interface UpdateInviteSaleParams {
633
- /** Invite ID */
634
- inviteId: number;
635
- /** Nickname */
636
- nickname: string;
990
+ /** Invite sale user IDs to update, maximum 200 */
991
+ viewerUnionIds: string[];
992
+ /** Organization ID */
993
+ organizationId: number;
637
994
  }
995
+ /**
996
+ * Response for updating invite sales
997
+ */
998
+ export type UpdateInviteSaleResponse = void;
638
999
  /**
639
1000
  * Parameters for removing an invite sale
640
1001
  */
641
1002
  export interface RemoveInviteSaleParams {
642
- /** Invite ID */
643
- inviteId: number;
1003
+ /** Invite sale user IDs to remove, maximum 100 */
1004
+ viewerUnionIds: string[];
1005
+ /** New invite sale user ID to receive followed viewers */
1006
+ newViewerUnionId?: string;
1007
+ /** Legacy/example field accepted by the API documentation examples */
1008
+ followViewersToNewViewerUnionId?: string;
644
1009
  }
1010
+ /**
1011
+ * Response for removing invite sales
1012
+ */
1013
+ export type RemoveInviteSaleResponse = void;
645
1014
  /**
646
1015
  * Follow viewer entity
647
1016
  */
648
1017
  export interface FollowViewer {
1018
+ /** Invite sale user ID */
1019
+ inviteCustomerId: string;
1020
+ /** Invite sale nickname */
1021
+ inviteCustomerNickname?: string;
649
1022
  /** Viewer ID */
650
1023
  viewerId: string;
651
1024
  /** Nickname */
652
1025
  nickname: string;
1026
+ /** Viewer phone number */
1027
+ telephone?: string;
1028
+ /** Follow status: 0=pending, 1=bound, 2=unbound */
1029
+ followStatus?: number;
1030
+ /** Follow timestamp */
1031
+ followTime?: number;
653
1032
  }
654
1033
  /**
655
1034
  * Parameters for listing follow viewers
656
1035
  */
657
1036
  export interface ListFollowViewersParams {
658
- /** Invite ID */
659
- inviteId: number;
1037
+ /** Invite sale user ID, exact match */
1038
+ inviteCustomerId?: string;
1039
+ /** Invite sale nickname keyword */
1040
+ inviteCustomerNickname?: string;
1041
+ /** Viewer ID, exact match */
1042
+ viewerId?: string;
1043
+ /** Viewer nickname keyword */
1044
+ username?: string;
1045
+ /** Viewer phone number, exact match */
1046
+ telephone?: string;
1047
+ /** Follow statuses joined by commas, e.g. "0,1" */
1048
+ followStatusList?: string;
1049
+ /** Page size */
1050
+ pageSize?: number;
1051
+ /** Page number */
1052
+ pageNumber?: number;
660
1053
  }
661
1054
  /**
662
1055
  * Response for listing follow viewers
663
1056
  */
664
- export interface ListFollowViewersResponse {
665
- /** Follow viewers list */
666
- contents: FollowViewer[];
1057
+ export interface ListFollowViewersResponse extends UserPaginatedResponse<FollowViewer> {
667
1058
  }
668
1059
  /**
669
1060
  * Custom field entity
670
1061
  */
671
1062
  export interface CustomField {
672
1063
  /** Field ID */
673
- fieldId: number;
1064
+ customFieldId: string;
674
1065
  /** Field name */
675
- fieldName: string;
1066
+ customFieldName: string;
676
1067
  /** Field type (text, select, etc.) */
677
- fieldType: string;
1068
+ customFieldType: string;
678
1069
  }
679
1070
  /**
680
1071
  * Response for listing custom fields
681
1072
  */
682
- export interface ListCustomFieldsResponse {
683
- /** Custom fields list */
684
- contents: CustomField[];
685
- }
1073
+ export type ListCustomFieldsResponse = CustomField[];
686
1074
  /**
687
1075
  * Parameters for adding a custom field
688
1076
  */
689
1077
  export interface AddCustomFieldParams {
690
- /** Field name */
691
- fieldName: string;
692
- /** Field type */
693
- fieldType: string;
1078
+ /** Custom field ID, maximum 64 characters */
1079
+ customFieldId: string;
1080
+ /** Custom field name, maximum 64 characters */
1081
+ customFieldName: string;
1082
+ /** Custom field type, such as text, image, or link */
1083
+ customFieldType: string;
694
1084
  }
695
1085
  /**
696
1086
  * Response for adding a custom field
697
1087
  */
698
- export interface AddCustomFieldResponse extends CustomField {
1088
+ export type AddCustomFieldResponse = void;
1089
+ /**
1090
+ * Viewer custom field value
1091
+ */
1092
+ export interface CustomFieldViewerValue {
1093
+ /** Viewer ID */
1094
+ viewerId: string;
1095
+ /** Custom field ID */
1096
+ customFieldId: string;
1097
+ /** Custom field value */
1098
+ customFieldValue: string;
699
1099
  }
700
1100
  /**
701
1101
  * Parameters for adding a custom field value
702
1102
  */
703
- export interface AddCustomFieldValueParams {
704
- /** Field ID */
705
- fieldId: number;
706
- /** Viewer union ID */
707
- viewerUnionId: string;
708
- /** Field value */
709
- value: string;
710
- }
1103
+ export type AddCustomFieldValueParams = CustomFieldViewerValue[];
1104
+ /**
1105
+ * Response for adding custom field viewer values
1106
+ */
1107
+ export type AddCustomFieldValueResponse = void;
711
1108
  /**
712
1109
  * Donate template settings
713
1110
  */
714
1111
  export interface DonateTemplate {
715
- /** Whether enabled */
716
- enabled: boolean;
717
- /** Minimum amount */
718
- minAmount?: number;
719
- /** Maximum amount */
720
- maxAmount?: number;
1112
+ /** Cash donate switch */
1113
+ donateCashEnabled?: UserSwitchValue;
1114
+ /** Cash donate settings */
1115
+ cashDonate?: TemplateCashDonate;
1116
+ /** Gift donate switch */
1117
+ donateGiftEnabled?: UserSwitchValue;
1118
+ /** Gift donate settings */
1119
+ giftDonate?: TemplateGiftDonate;
1120
+ }
1121
+ /**
1122
+ * Cash donate settings
1123
+ */
1124
+ export interface TemplateCashDonate {
1125
+ /** Fixed donate amounts */
1126
+ cashs?: number[];
1127
+ /** Minimum custom donate amount */
1128
+ cashMin?: number;
1129
+ }
1130
+ /**
1131
+ * Gift donate settings
1132
+ */
1133
+ export interface TemplateGiftDonate {
1134
+ /** Pay way */
1135
+ payWay?: 'CASH' | 'POINT' | string;
1136
+ /** Cash unit */
1137
+ cashUnit?: string | null;
1138
+ /** Point unit */
1139
+ pointUnit?: string | null;
1140
+ /** Cash pay gifts */
1141
+ cashPays?: GiftDonate[];
1142
+ /** Point pay gifts */
1143
+ pointPays?: GiftDonate[];
1144
+ }
1145
+ /**
1146
+ * Gift donate item
1147
+ */
1148
+ export interface GiftDonate {
1149
+ /** Gift name */
1150
+ name?: string;
1151
+ /** Gift image URL */
1152
+ img: string;
1153
+ /** Dynamic thumbnail URL */
1154
+ dynamicImg?: string | null;
1155
+ /** Dynamic file URL */
1156
+ dynamicFile?: string | null;
1157
+ /** Gift price */
1158
+ price?: number;
1159
+ /** Gift sequence */
1160
+ sequence?: number;
1161
+ /** Gift switch */
1162
+ enabled?: UserSwitchValue;
1163
+ /** Gift unit */
1164
+ unit?: string | null;
1165
+ /** Image type */
1166
+ imgType?: 'STATIC' | 'DYNAMIC' | string | null;
721
1167
  }
722
1168
  /**
723
1169
  * Parameters for updating donate template
724
1170
  */
725
1171
  export interface UpdateDonateTemplateParams {
726
- /** Whether enabled */
727
- enabled: boolean;
728
- /** Minimum amount */
729
- minAmount?: number;
730
- /** Maximum amount */
731
- maxAmount?: number;
1172
+ /** Gift donate switch */
1173
+ donateGiftEnabled: UserSwitchValue;
1174
+ /** Gift donate settings */
1175
+ giftDonate?: TemplateGiftDonate;
732
1176
  }
733
1177
  /**
734
1178
  * Marquee template settings
735
1179
  */
736
1180
  export interface MarqueeTemplate {
737
1181
  /** Whether enabled */
738
- enabled: boolean;
1182
+ enabled?: boolean;
1183
+ /** Content protection switch */
1184
+ enable?: UserSwitchValue;
1185
+ /** Content protection type */
1186
+ antiRecordType?: string;
1187
+ /** Content protection display model */
1188
+ modelType?: string;
739
1189
  /** Content */
740
1190
  content?: string;
1191
+ /** Opacity */
1192
+ opacity?: number | string;
741
1193
  /** Speed */
742
1194
  speed?: number;
1195
+ fontSize?: string;
1196
+ fontColor?: string;
1197
+ showMode?: string;
1198
+ doubleEnabled?: UserSwitchValue;
1199
+ autoZoomEnabled?: UserSwitchValue;
743
1200
  }
744
1201
  /**
745
1202
  * Parameters for updating marquee template
746
1203
  */
747
1204
  export interface UpdateMarqueeTemplateParams {
748
1205
  /** Whether enabled */
749
- enabled: boolean;
1206
+ enabled?: boolean;
1207
+ /** Content protection switch */
1208
+ enable?: UserSwitchValue;
1209
+ /** Content protection type */
1210
+ antiRecordType?: string;
1211
+ /** Content protection display model */
1212
+ modelType?: string;
750
1213
  /** Content */
751
1214
  content?: string;
1215
+ /** Opacity */
1216
+ opacity?: number | string;
752
1217
  /** Speed */
753
1218
  speed?: number;
1219
+ fontSize?: string;
1220
+ fontColor?: string;
1221
+ showMode?: string;
1222
+ doubleEnabled?: UserSwitchValue;
1223
+ autoZoomEnabled?: UserSwitchValue;
754
1224
  }
755
1225
  /**
756
1226
  * Role config template settings
757
1227
  */
758
1228
  export interface RoleConfigTemplate {
759
1229
  /** Roles list */
760
- roles: string[];
1230
+ roles?: string[];
1231
+ /** Teacher role config */
1232
+ teacherConfig?: Record<string, unknown>;
1233
+ /** Guest role config */
1234
+ guestConfig?: Record<string, unknown>;
761
1235
  }
762
1236
  /**
763
1237
  * Parameters for updating role config template
764
1238
  */
765
1239
  export interface UpdateRoleConfigTemplateParams {
766
1240
  /** Roles list */
767
- roles: string[];
1241
+ roles?: string[];
1242
+ /** Teacher role config */
1243
+ teacherConfig?: Record<string, unknown>;
1244
+ /** Guest role config */
1245
+ guestConfig?: Record<string, unknown>;
768
1246
  }
769
1247
  /**
770
1248
  * Playback setting
771
1249
  */
772
1250
  export interface PlaybackSetting {
773
- /** Auto play */
774
- autoPlay?: boolean;
775
- /** Quality */
776
- quality?: string;
1251
+ playbackEnabled?: UserSwitchValue;
1252
+ type?: 'single' | 'list' | string;
1253
+ origin?: 'record' | 'playback' | 'vod' | string;
1254
+ sectionEnabled?: UserSwitchValue;
1255
+ chatPlaybackEnabled?: UserSwitchValue;
1256
+ playbackMultiplierEnabled?: UserSwitchValue;
1257
+ playbackProgressBarEnabled?: UserSwitchValue;
1258
+ playbackProgressBarOperationType?: 'drag' | 'prohibitDrag' | 'dragHistoryOnly' | string;
1259
+ showPlayButtonEnabled?: UserSwitchValue;
1260
+ productPlaybackEnabled?: UserSwitchValue;
1261
+ questionnairePlaybackEnabled?: UserSwitchValue;
1262
+ qaPlaybackEnabled?: UserSwitchValue;
1263
+ cardPushPlaybackEnabled?: UserSwitchValue;
1264
+ checkInPlaybackEnabled?: UserSwitchValue;
777
1265
  }
778
1266
  /**
779
1267
  * Parameters for updating playback setting
780
1268
  */
781
1269
  export interface UpdatePlaybackSettingParams {
782
- /** Auto play */
783
- autoPlay?: boolean;
784
- /** Quality */
785
- quality?: string;
1270
+ playbackEnabled?: UserSwitchValue;
1271
+ type?: 'single' | 'list' | string;
1272
+ origin?: 'record' | 'playback' | 'vod' | string;
1273
+ sectionEnabled?: UserSwitchValue;
1274
+ playbackMultiplierEnabled?: UserSwitchValue;
1275
+ playbackProgressBarEnabled?: UserSwitchValue;
1276
+ playbackProgressBarOperationType?: 'drag' | 'prohibitDrag' | 'dragHistoryOnly' | string;
1277
+ showPlayButtonEnabled?: UserSwitchValue;
1278
+ chatPlaybackEnabled?: UserSwitchValue;
1279
+ productPlaybackEnabled?: UserSwitchValue;
1280
+ questionnairePlaybackEnabled?: UserSwitchValue;
1281
+ qaPlaybackEnabled?: UserSwitchValue;
1282
+ cardPushPlaybackEnabled?: UserSwitchValue;
1283
+ checkInPlaybackEnabled?: UserSwitchValue;
786
1284
  }
787
1285
  /**
788
1286
  * Audio moderation setting
789
1287
  */
790
1288
  export interface AudioModerationSetting {
791
1289
  /** Whether enabled */
792
- enabled: boolean;
1290
+ enabled?: boolean;
793
1291
  /** Moderation level */
794
1292
  level?: string;
1293
+ moderationEnabled?: UserSwitchValue;
1294
+ moderationStrategy?: string;
1295
+ badwordEnabled?: UserSwitchValue;
1296
+ illegalNotify?: Record<string, unknown>;
795
1297
  }
796
1298
  /**
797
1299
  * Parameters for updating audio moderation setting
798
1300
  */
799
1301
  export interface UpdateAudioModerationSettingParams {
800
1302
  /** Whether enabled */
801
- enabled: boolean;
1303
+ enabled?: boolean;
802
1304
  /** Moderation level */
803
1305
  level?: string;
1306
+ moderationEnabled?: UserSwitchValue;
1307
+ moderationStrategy?: string;
1308
+ badwordEnabled?: UserSwitchValue;
1309
+ illegalNotify?: Record<string, unknown>;
804
1310
  }
805
1311
  /**
806
1312
  * Video moderation setting
807
1313
  */
808
1314
  export interface VideoModerationSetting {
809
1315
  /** Whether enabled */
810
- enabled: boolean;
1316
+ enabled?: boolean;
811
1317
  /** Moderation level */
812
1318
  level?: string;
1319
+ moderationEnabled?: UserSwitchValue;
1320
+ moderationStrategy?: string;
1321
+ imageFrequency?: number;
1322
+ illegalNotify?: Record<string, unknown>;
813
1323
  }
814
1324
  /**
815
1325
  * Parameters for updating video moderation setting
816
1326
  */
817
1327
  export interface UpdateVideoModerationSettingParams {
818
1328
  /** Whether enabled */
819
- enabled: boolean;
1329
+ enabled?: boolean;
820
1330
  /** Moderation level */
821
1331
  level?: string;
1332
+ moderationEnabled?: UserSwitchValue;
1333
+ moderationStrategy?: string;
1334
+ imageFrequency?: number;
1335
+ illegalNotify?: Record<string, unknown>;
822
1336
  }
823
1337
  /**
824
1338
  * Callback settings
825
1339
  */
826
1340
  export interface CallbackSettings {
827
- streamCallbackUrl?: string;
828
- playbackCallbackUrl?: string;
829
1341
  recordCallbackUrl?: string;
830
- rebirthVodCallbackUrl?: string;
831
- rebirthVodCallbackEnabled?: 'Y' | 'N';
832
- /** Compatibility aliases used by older SDK consumers. */
833
- url?: string;
834
- enabled?: boolean;
835
- [key: string]: unknown;
1342
+ recordFileCallBackType?: 'all' | 'last' | string;
1343
+ recordCallbackVideoType?: 'm3u8' | 'mp4' | 'm3u8,mp4' | string;
1344
+ playbackCallbackUrl?: string;
1345
+ rebirthVodCallbackEnabled?: UserSwitchValue;
1346
+ pptRecordCallbackUrl?: string;
1347
+ streamCallbackUrl?: string;
1348
+ channelBasicUpdateCallbackUrl?: string;
1349
+ liveScanCallbackUrl?: string;
1350
+ chatUserStatusCallbackUrl?: string;
1351
+ interactionCallbackUrl?: string;
1352
+ playbackCacheCallbackUrl?: string;
1353
+ playbackSettingCallbackUrl?: string;
1354
+ aiPptVideoCallbackUrl?: string;
1355
+ liveViolationCutoffCallbackUrl?: string;
1356
+ liveStatsCallbackUrl?: string;
836
1357
  }
837
1358
  /**
838
1359
  * Parameters for updating callback settings
839
1360
  */
840
1361
  export interface UpdateCallbackParams {
841
- streamCallbackUrl?: string;
842
- playbackCallbackUrl?: string;
843
1362
  recordCallbackUrl?: string;
844
- rebirthVodCallbackUrl?: string;
845
- rebirthVodCallbackEnabled?: 'Y' | 'N';
846
- /** Compatibility aliases used by older SDK consumers. */
847
- url?: string;
848
- enabled?: boolean;
1363
+ recordFileCallBackType?: 'all' | 'last' | string;
1364
+ recordCallbackVideoType?: 'm3u8' | 'mp4' | 'm3u8,mp4' | string;
1365
+ playbackCallbackUrl?: string;
1366
+ rebirthVodCallbackEnabled?: UserSwitchValue;
1367
+ pptRecordCallbackUrl?: string;
1368
+ streamCallbackUrl?: string;
1369
+ channelBasicUpdateCallbackUrl?: string;
1370
+ liveScanCallbackUrl?: string;
1371
+ playbackCacheCallbackUrl?: string;
1372
+ aiPptVideoCallbackUrl?: string;
1373
+ liveViolationCutoffCallbackUrl?: string;
1374
+ liveStatsCallbackUrl?: string;
849
1375
  }
850
1376
  /**
851
1377
  * Global switch settings
@@ -869,145 +1395,228 @@ export interface UpdateGlobalSwitchParams {
869
1395
  * Global footer settings
870
1396
  */
871
1397
  export interface GlobalFooterSettings {
872
- /** Whether enabled */
873
- enabled?: boolean;
874
- /** Footer content */
875
- content?: string;
1398
+ /** PolyV user ID */
1399
+ userId?: string;
1400
+ /** Footer switch */
1401
+ showFooterEnabled?: UserSwitchValue;
1402
+ /** Footer text */
1403
+ footerText?: string;
1404
+ /** Footer link protocol */
1405
+ footTextLinkProtocol?: 'http://' | 'https://' | string;
1406
+ /** Footer link URL without protocol */
1407
+ footTextLinkUrl?: string;
876
1408
  }
877
1409
  /**
878
1410
  * Parameters for updating global footer settings
879
1411
  */
880
1412
  export interface UpdateGlobalFooterParams {
881
- /** Whether enabled */
882
- enabled?: boolean;
883
- /** Footer content */
884
- content?: string;
1413
+ showFooterEnabled?: UserSwitchValue;
1414
+ footerText?: string;
1415
+ footTextLinkProtocol?: 'http://' | 'https://' | string;
1416
+ footTextLinkUrl?: string;
885
1417
  }
886
1418
  /**
887
1419
  * PV show enable settings
888
1420
  */
889
1421
  export interface PvShowEnableSettings {
890
- /** Whether enabled */
891
- enabled?: boolean;
1422
+ /** PV show switch */
1423
+ enabled?: UserSwitchValue;
892
1424
  }
893
1425
  /**
894
1426
  * Parameters for updating PV show enable settings
895
1427
  */
896
1428
  export interface UpdatePvShowEnableParams {
897
- /** Whether enabled */
898
- enabled?: boolean;
1429
+ /** PV show switch */
1430
+ enabled: UserSwitchValue;
899
1431
  }
900
1432
  /**
901
1433
  * Parameters for getting mic duration
902
1434
  */
903
1435
  export interface GetMicDurationParams {
904
- /** Channel ID */
905
- channelId: string;
906
- /** Session ID */
907
- sessionId: string;
1436
+ /** Start timestamp in milliseconds */
1437
+ startTime?: number;
1438
+ /** End timestamp in milliseconds */
1439
+ endTime?: number;
908
1440
  }
909
1441
  /**
910
1442
  * Mic duration response
911
1443
  */
912
1444
  export interface MicDurationResponse {
913
- /** Duration */
914
- duration: number;
915
- /** Unit */
916
- unit?: string;
1445
+ /** User ID */
1446
+ userId: string;
1447
+ /** Used mic minutes */
1448
+ history: number;
917
1449
  }
918
1450
  /**
919
1451
  * MR concurrency detail response
920
1452
  */
921
1453
  export interface MrConcurrencyDetailResponse {
922
- /** Current concurrency */
923
- current: number;
924
- /** Max concurrency */
925
- max: number;
926
- /** Peak concurrency */
927
- peak: number;
1454
+ /** Total MR concurrency */
1455
+ mrLiveConcurrency: number;
1456
+ /** Currently used concurrency */
1457
+ usedCount: number;
1458
+ /** Residual concurrency */
1459
+ residualConcurrency: number;
1460
+ /** Channel IDs occupying concurrency */
1461
+ channelIds: string[];
928
1462
  }
929
1463
  /**
930
1464
  * Parameters for sending SMS
931
1465
  */
932
1466
  export interface SendSmsParams {
1467
+ /** Mobile numbers */
1468
+ phoneNumbers?: Array<string | number>;
1469
+ /** SMS template parameter names */
1470
+ templateParamNames?: string[];
1471
+ /** SMS template parameter values */
1472
+ templateParamValues?: Array<string | number>;
933
1473
  /** Mobile number */
934
- mobile: string;
1474
+ mobile?: string;
935
1475
  /** SMS content */
936
- content: string;
1476
+ content?: string;
937
1477
  }
938
1478
  /**
939
1479
  * Parameters for getting bill use detail list
940
1480
  */
941
1481
  export interface GetBillUseDetailListParams {
1482
+ /** Billing item category */
1483
+ itemCategory: string;
942
1484
  /** Start date (YYYY-MM-DD) */
943
1485
  startDate: string;
944
1486
  /** End date (YYYY-MM-DD) */
945
1487
  endDate: string;
1488
+ /** Channel ID */
1489
+ channelId?: string;
1490
+ /** Page number */
1491
+ pageNumber?: number;
1492
+ /** Page size */
1493
+ pageSize?: number;
946
1494
  }
947
1495
  /**
948
1496
  * Bill use detail item
949
1497
  */
950
1498
  export interface BillUseDetailItem {
951
- /** Bill ID */
952
- billId: number;
953
- /** Type */
954
- type: string;
955
- /** Amount */
956
- amount: number;
957
- /** Created timestamp */
958
- createTime: number;
1499
+ channelId?: number;
1500
+ consumeUnit?: string;
1501
+ consumed?: number;
1502
+ endTime?: string;
1503
+ itemCategory?: string;
1504
+ itemName?: string;
1505
+ production?: string;
1506
+ recordId?: string;
1507
+ remark?: string;
1508
+ sessionId?: string;
1509
+ avgBitRate?: string;
1510
+ startTime?: string;
1511
+ statDate?: string;
959
1512
  }
960
1513
  /**
961
1514
  * Response for getting bill use detail list
962
1515
  */
963
1516
  export interface GetBillUseDetailListResponse {
964
- /** Bill use details list */
1517
+ pageNumber: number;
1518
+ pageSize: number;
1519
+ totalPages: number;
1520
+ totalItems: number;
965
1521
  contents: BillUseDetailItem[];
966
1522
  }
967
1523
  /**
968
- * Parameters for viewer lottery win
1524
+ * Parameters for listing viewer lottery wins
969
1525
  */
970
- export interface ViewerLotteryWinParams {
971
- /** Lottery ID */
972
- lotteryId: number;
1526
+ export interface ViewerLotteryWinParams extends UserPaginationParams {
973
1527
  /** Viewer ID */
974
1528
  viewerId: string;
975
1529
  }
976
1530
  /**
977
- * Viewer lottery win response
1531
+ * Viewer lottery win item
978
1532
  */
979
- export interface ViewerLotteryWinResponse {
1533
+ export interface ViewerLotteryWinItem {
1534
+ /** Channel ID */
1535
+ channelId?: number;
1536
+ /** Channel name */
1537
+ channelName?: string;
1538
+ /** Session ID */
1539
+ sessionId?: string;
1540
+ /** Receive info JSON string */
1541
+ collectInfo?: string;
1542
+ /** Accept type */
1543
+ acceptType?: string;
980
1544
  /** Lottery ID */
981
- lotteryId: number;
982
- /** Prize */
1545
+ lotteryId?: string;
1546
+ /** Prize name */
983
1547
  prize?: string;
984
- /** Status */
985
- status?: string;
1548
+ /** Whether prize was received */
1549
+ received?: boolean;
1550
+ /** Winner code */
1551
+ winnerCode?: string;
1552
+ /** Activity name */
1553
+ activityName?: string;
1554
+ /** Win timestamp */
1555
+ createdTime?: number;
1556
+ /** Last modified timestamp */
1557
+ lastModified?: number;
1558
+ /** Whether receive info collection is enabled */
1559
+ receiveEnabled?: boolean;
1560
+ }
1561
+ /**
1562
+ * Response for listing viewer lottery wins
1563
+ */
1564
+ export interface ViewerLotteryWinResponse extends UserPaginatedResponse<ViewerLotteryWinItem> {
986
1565
  }
987
1566
  /**
988
1567
  * Parameters for getting watch log detail
989
1568
  */
990
1569
  export interface GetWatchLogDetailParams {
991
- /** Log ID */
992
- logId: number;
1570
+ /** Viewer ID */
1571
+ viewerId: string;
1572
+ /** Start date (YYYY-MM-DD) */
1573
+ startDate?: string;
1574
+ /** End date (YYYY-MM-DD) */
1575
+ endDate?: string;
1576
+ /** Page number */
1577
+ pageNumber?: number;
1578
+ /** Page size */
1579
+ pageSize?: number;
993
1580
  }
994
1581
  /**
995
- * Watch log detail response
1582
+ * Watch log detail item
996
1583
  */
997
- export interface WatchLogDetailResponse {
998
- /** Log ID */
999
- logId: number;
1584
+ export interface WatchLogDetailItem {
1585
+ area?: string;
1586
+ browser?: string;
1587
+ ip?: string;
1588
+ nick?: string;
1589
+ playDuration?: string;
1590
+ channelId?: number;
1591
+ sessionId?: string;
1592
+ startTime?: string | number;
1593
+ viewType?: string;
1000
1594
  /** Viewer ID */
1001
1595
  viewerId: string;
1002
- /** Duration */
1003
- duration: number;
1004
- /** Start time */
1005
- startTime: number;
1596
+ param4?: string;
1597
+ param5?: string;
1598
+ }
1599
+ /**
1600
+ * Watch log detail response
1601
+ */
1602
+ export interface WatchLogDetailResponse extends UserPaginatedResponse<WatchLogDetailItem> {
1006
1603
  }
1007
1604
  /**
1008
1605
  * Parameters for getting watch log list
1009
1606
  */
1010
- export interface GetWatchLogListParams extends UserPaginationParams {
1607
+ export interface GetWatchLogListParams {
1608
+ /** Start date (YYYY-MM-DD) */
1609
+ startDate?: string;
1610
+ /** End date (YYYY-MM-DD) */
1611
+ endDate?: string;
1612
+ /** Page number */
1613
+ pageNumber?: number;
1614
+ /** Page size */
1615
+ pageSize?: number;
1616
+ /** Viewer ID */
1617
+ viewerId?: string;
1618
+ /** Channel ID */
1619
+ channelId?: number;
1011
1620
  }
1012
1621
  /**
1013
1622
  * Global channel settings response
@@ -1055,14 +1664,14 @@ export interface UpdateGlobalChannelSettingsParams {
1055
1664
  * Watch log item
1056
1665
  */
1057
1666
  export interface WatchLogItem {
1058
- /** Log ID */
1059
- logId: number;
1667
+ avgDuration?: string;
1668
+ nick?: string;
1669
+ totalDuration?: string;
1670
+ viewCount?: number;
1060
1671
  /** Viewer ID */
1061
1672
  viewerId: string;
1062
- /** Channel ID */
1063
- channelId: string;
1064
- /** Duration */
1065
- duration: number;
1673
+ param4?: string;
1674
+ param5?: string;
1066
1675
  }
1067
1676
  /**
1068
1677
  * Response for getting watch log list