polyv-live-api-sdk 1.0.12 → 1.0.13
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.
- package/dist/index.cjs +369 -121
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +391 -337
- package/dist/index.js +369 -121
- package/dist/index.js.map +1 -1
- package/dist/services/account.service.d.ts +4 -2
- package/dist/services/account.service.d.ts.map +1 -1
- package/dist/services/live-interaction.service.d.ts +10 -1
- package/dist/services/live-interaction.service.d.ts.map +1 -1
- package/dist/services/v4/channel.service.d.ts +38 -13
- package/dist/services/v4/channel.service.d.ts.map +1 -1
- package/dist/services/v4/user.service.d.ts.map +1 -1
- package/dist/types/account.d.ts +16 -3
- package/dist/types/account.d.ts.map +1 -1
- package/dist/types/index.d.ts +1 -1
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/live-interaction.d.ts +80 -26
- package/dist/types/live-interaction.d.ts.map +1 -1
- package/dist/types/v4-channel.d.ts +221 -292
- package/dist/types/v4-channel.d.ts.map +1 -1
- package/dist/types/v4-user.d.ts +13 -4
- package/dist/types/v4-user.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -817,11 +817,14 @@ export interface DonateSettings {
|
|
|
817
817
|
/** Channel ID */
|
|
818
818
|
channelId: string;
|
|
819
819
|
/** Donate enabled */
|
|
820
|
-
donateEnabled
|
|
820
|
+
donateEnabled?: YNFlag;
|
|
821
|
+
donateGiftEnabled?: YNFlag;
|
|
821
822
|
/** Donate tips */
|
|
822
|
-
donateTips
|
|
823
|
+
donateTips?: string;
|
|
823
824
|
/** Donate amounts */
|
|
824
|
-
donateAmounts
|
|
825
|
+
donateAmounts?: number[];
|
|
826
|
+
giftDonate?: GiftDonateConfig;
|
|
827
|
+
[key: string]: unknown;
|
|
825
828
|
}
|
|
826
829
|
/**
|
|
827
830
|
* Parameters for getting donate settings
|
|
@@ -838,10 +841,32 @@ export interface UpdateDonateParams {
|
|
|
838
841
|
channelId: string;
|
|
839
842
|
/** Donate enabled */
|
|
840
843
|
donateEnabled?: YNFlag;
|
|
844
|
+
donateGiftEnabled?: YNFlag;
|
|
841
845
|
/** Donate tips */
|
|
842
846
|
donateTips?: string;
|
|
843
847
|
/** Donate amounts */
|
|
844
848
|
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;
|
|
845
870
|
}
|
|
846
871
|
/**
|
|
847
872
|
* Distribute info
|
|
@@ -1027,6 +1052,17 @@ export interface QueryWinnerViewerResponse {
|
|
|
1027
1052
|
/** Contents */
|
|
1028
1053
|
contents: WinnerViewerInfo[];
|
|
1029
1054
|
}
|
|
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
|
+
}
|
|
1030
1066
|
/**
|
|
1031
1067
|
* Lottery activity info
|
|
1032
1068
|
*/
|
|
@@ -1038,252 +1074,117 @@ export interface LotteryActivity {
|
|
|
1038
1074
|
/** Activity name */
|
|
1039
1075
|
activityName: string;
|
|
1040
1076
|
/** Lottery condition type */
|
|
1041
|
-
lotteryCondition:
|
|
1077
|
+
lotteryCondition: 'none' | 'invite' | 'duration' | 'comment' | 'question' | string;
|
|
1042
1078
|
/** Status */
|
|
1043
1079
|
status?: string | null;
|
|
1044
1080
|
/** Winner count */
|
|
1045
1081
|
amount: number;
|
|
1046
1082
|
/** Prize name */
|
|
1047
1083
|
prizeName: string;
|
|
1048
|
-
/** Hide winner count */
|
|
1049
1084
|
hiddenWinnerAmount?: YNFlag;
|
|
1050
|
-
|
|
1051
|
-
lotteryRange?: LotteryRange;
|
|
1052
|
-
/** Custom group info */
|
|
1085
|
+
lotteryRange?: 'all' | 'customGroup' | string;
|
|
1053
1086
|
customGroup?: Array<Record<string, unknown>>;
|
|
1054
|
-
|
|
1055
|
-
customGroupLotteryType?:
|
|
1056
|
-
/** Per-group winner count */
|
|
1087
|
+
customGroupIds?: Array<string | number>;
|
|
1088
|
+
customGroupLotteryType?: 'average' | 'random' | string;
|
|
1057
1089
|
customGroupLotteryAmount?: number | null;
|
|
1058
|
-
/** Hide attendee count */
|
|
1059
1090
|
hiddenAttendeeNumber?: YNFlag;
|
|
1060
|
-
/** Allow repeat wins */
|
|
1061
1091
|
repeatWinEnabled?: YNFlag;
|
|
1062
|
-
/** Whether prize receive info is enabled */
|
|
1063
1092
|
receiveEnabled?: YNFlag;
|
|
1064
|
-
/** Prize receive info fields */
|
|
1065
1093
|
receiveInfo?: LotteryReceiveInfo[] | null;
|
|
1066
|
-
/** Prize image */
|
|
1067
1094
|
thumbnail?: string | null;
|
|
1068
|
-
/** Activity duration */
|
|
1069
1095
|
activityDuration?: string | number | null;
|
|
1070
|
-
|
|
1071
|
-
|
|
1072
|
-
/** Invite type */
|
|
1073
|
-
inviteType?: InviteType | null;
|
|
1074
|
-
/** External invite list URL */
|
|
1096
|
+
activityDurationType?: 'second' | 'minute' | 'hour' | string | null;
|
|
1097
|
+
inviteType?: 'poster' | 'external' | string | null;
|
|
1075
1098
|
externalListLink?: string | null;
|
|
1076
|
-
/** External invite count URL */
|
|
1077
1099
|
externalInviteNumLink?: string | null;
|
|
1078
|
-
/** Invite count */
|
|
1079
1100
|
inviteNum?: number | null;
|
|
1080
|
-
/** Watch duration */
|
|
1081
1101
|
duration?: number | null;
|
|
1082
|
-
/** Comment keyword */
|
|
1083
1102
|
comment?: string | null;
|
|
1084
|
-
|
|
1085
|
-
acceptType?: AcceptType | null;
|
|
1086
|
-
/** Prize receive form fields */
|
|
1103
|
+
acceptType?: 'form' | 'link' | 'qrCode' | string | null;
|
|
1087
1104
|
formInfo?: LotteryReceiveInfo[] | null;
|
|
1088
|
-
/** Prize link */
|
|
1089
1105
|
prizeUrl?: string | null;
|
|
1090
|
-
/** Prize QR code URL */
|
|
1091
1106
|
qrCode?: string | null;
|
|
1092
|
-
/** Prize QR code tips */
|
|
1093
1107
|
qrCodeTips?: string | null;
|
|
1094
|
-
/** Discount price */
|
|
1095
1108
|
realPrice?: number | null;
|
|
1096
|
-
/** Original price */
|
|
1097
1109
|
price?: number | null;
|
|
1098
|
-
/** Question lottery prize info */
|
|
1099
1110
|
prizeInfo?: LotteryPrizeInfo[] | null;
|
|
1100
|
-
/** Question group ID */
|
|
1101
1111
|
questionGroupId?: number | null;
|
|
1102
|
-
/** Answer duration per question */
|
|
1103
1112
|
perAnswerDuration?: number | null;
|
|
1104
|
-
/** Winners must be online when drawing */
|
|
1105
1113
|
lotteryOnlineEnabled?: YNFlag;
|
|
1106
|
-
|
|
1107
|
-
answerType?: AnswerType;
|
|
1108
|
-
/** Show winner code */
|
|
1114
|
+
answerType?: 'pushQuestion' | 'autonomyAnswer' | string;
|
|
1109
1115
|
showWinnerCode?: YNFlag;
|
|
1110
|
-
/** Show winners */
|
|
1111
1116
|
showWinners?: YNFlag;
|
|
1112
|
-
|
|
1113
|
-
/**
|
|
1114
|
-
* Lottery condition type
|
|
1115
|
-
*/
|
|
1116
|
-
export type LotteryConditionType = 'none' | 'invite' | 'duration' | 'comment' | 'question';
|
|
1117
|
-
/**
|
|
1118
|
-
* Lottery participant range
|
|
1119
|
-
*/
|
|
1120
|
-
export type LotteryRange = 'all' | 'customGroup';
|
|
1121
|
-
/**
|
|
1122
|
-
* Custom group lottery type
|
|
1123
|
-
*/
|
|
1124
|
-
export type CustomGroupLotteryType = 'average' | 'random';
|
|
1125
|
-
/**
|
|
1126
|
-
* Activity duration unit
|
|
1127
|
-
*/
|
|
1128
|
-
export type ActivityDurationType = 'second' | 'minute' | 'hour';
|
|
1129
|
-
/**
|
|
1130
|
-
* Invite type
|
|
1131
|
-
*/
|
|
1132
|
-
export type InviteType = 'poster' | 'external';
|
|
1133
|
-
/**
|
|
1134
|
-
* Prize accept type
|
|
1135
|
-
*/
|
|
1136
|
-
export type AcceptType = 'form' | 'link' | 'qrCode';
|
|
1137
|
-
/**
|
|
1138
|
-
* Question lottery answer type
|
|
1139
|
-
*/
|
|
1140
|
-
export type AnswerType = 'pushQuestion' | 'autonomyAnswer';
|
|
1141
|
-
/**
|
|
1142
|
-
* Prize receive info field
|
|
1143
|
-
*/
|
|
1144
|
-
export interface LotteryReceiveInfo {
|
|
1145
|
-
/** Field type */
|
|
1146
|
-
type?: 'userName' | 'userPhone' | 'custom';
|
|
1147
|
-
/** Field label */
|
|
1148
|
-
field: string;
|
|
1149
|
-
/** Field tips */
|
|
1150
|
-
tips: string;
|
|
1151
|
-
/** Whether field is required */
|
|
1152
|
-
required?: boolean;
|
|
1153
|
-
}
|
|
1154
|
-
/**
|
|
1155
|
-
* Question lottery prize info
|
|
1156
|
-
*/
|
|
1157
|
-
export interface LotteryPrizeInfo {
|
|
1158
|
-
/** Prize item name */
|
|
1159
|
-
prizeItem: string;
|
|
1160
|
-
/** Correct answer count */
|
|
1161
|
-
correctAnswerCount: number;
|
|
1162
|
-
/** Prize name */
|
|
1163
|
-
prizeName: string;
|
|
1164
|
-
/** Prize image */
|
|
1165
|
-
thumbnail?: string;
|
|
1166
|
-
/** Discount price */
|
|
1167
|
-
realPrice?: number;
|
|
1168
|
-
/** Original price */
|
|
1169
|
-
price?: number;
|
|
1170
|
-
/** Prize accept type */
|
|
1171
|
-
acceptType: AcceptType;
|
|
1172
|
-
/** Prize receive form fields */
|
|
1173
|
-
formInfo?: LotteryReceiveInfo[];
|
|
1174
|
-
/** Prize link */
|
|
1175
|
-
prizeUrl?: string;
|
|
1176
|
-
/** Prize QR code URL */
|
|
1177
|
-
qrCode?: string;
|
|
1178
|
-
/** Prize QR code tips */
|
|
1179
|
-
qrCodeTips?: string;
|
|
1180
|
-
/** Winner count */
|
|
1181
|
-
amount: number;
|
|
1182
|
-
/** Hide winner count */
|
|
1183
|
-
hiddenWinnerAmount?: YNFlag;
|
|
1117
|
+
[key: string]: unknown;
|
|
1184
1118
|
}
|
|
1185
1119
|
/**
|
|
1186
1120
|
* Parameters for creating lottery activity
|
|
1187
1121
|
*/
|
|
1188
1122
|
export interface LotteryActivityCreateParams {
|
|
1189
1123
|
/** Channel ID */
|
|
1190
|
-
channelId: string;
|
|
1124
|
+
channelId: string | number;
|
|
1191
1125
|
/** Activity name */
|
|
1192
1126
|
activityName: string;
|
|
1193
1127
|
/** Lottery condition type */
|
|
1194
|
-
lotteryCondition:
|
|
1128
|
+
lotteryCondition: 'none' | 'invite' | 'duration' | 'comment' | 'question' | string;
|
|
1195
1129
|
/** Winner count */
|
|
1196
1130
|
amount: number;
|
|
1197
|
-
/**
|
|
1131
|
+
/** Prize name */
|
|
1132
|
+
prizeName: string;
|
|
1198
1133
|
hiddenWinnerAmount?: YNFlag;
|
|
1199
|
-
|
|
1200
|
-
|
|
1201
|
-
|
|
1202
|
-
customGroupIds?: number[];
|
|
1203
|
-
/** Custom group lottery type */
|
|
1204
|
-
customGroupLotteryType?: CustomGroupLotteryType;
|
|
1205
|
-
/** Per-group winner count */
|
|
1134
|
+
lotteryRange?: 'all' | 'customGroup' | string;
|
|
1135
|
+
customGroupIds?: Array<string | number>;
|
|
1136
|
+
customGroupLotteryType?: 'average' | 'random' | string;
|
|
1206
1137
|
customGroupLotteryAmount?: number;
|
|
1207
|
-
/** Hide attendee count */
|
|
1208
1138
|
hiddenAttendeeNumber?: YNFlag;
|
|
1209
|
-
/** Allow repeat wins */
|
|
1210
1139
|
repeatWinEnabled?: YNFlag;
|
|
1211
|
-
/** Whether prize receive info is enabled */
|
|
1212
1140
|
receiveEnabled?: YNFlag;
|
|
1213
|
-
/** Prize receive info fields */
|
|
1214
1141
|
receiveInfo?: LotteryReceiveInfo[];
|
|
1215
|
-
/** Prize name */
|
|
1216
|
-
prizeName: string;
|
|
1217
|
-
/** Prize image */
|
|
1218
1142
|
thumbnail?: string;
|
|
1219
|
-
|
|
1220
|
-
|
|
1221
|
-
|
|
1222
|
-
activityDurationType?: ActivityDurationType;
|
|
1223
|
-
/** Invite type */
|
|
1224
|
-
inviteType?: InviteType;
|
|
1225
|
-
/** External invite list URL */
|
|
1143
|
+
activityDuration?: string | number;
|
|
1144
|
+
activityDurationType?: 'second' | 'minute' | 'hour' | string;
|
|
1145
|
+
inviteType?: 'poster' | 'external' | string;
|
|
1226
1146
|
externalListLink?: string;
|
|
1227
|
-
/** External invite count URL */
|
|
1228
1147
|
externalInviteNumLink?: string;
|
|
1229
|
-
/** Invite count */
|
|
1230
1148
|
inviteNum?: number;
|
|
1231
|
-
/** Watch duration */
|
|
1232
1149
|
duration?: number;
|
|
1233
|
-
/** Comment keyword */
|
|
1234
1150
|
comment?: string;
|
|
1235
|
-
|
|
1236
|
-
acceptType?: AcceptType;
|
|
1237
|
-
/** Prize receive form fields */
|
|
1151
|
+
acceptType?: 'form' | 'link' | 'qrCode' | string;
|
|
1238
1152
|
formInfo?: LotteryReceiveInfo[];
|
|
1239
|
-
/** Prize link */
|
|
1240
1153
|
prizeUrl?: string;
|
|
1241
|
-
/** Prize QR code URL */
|
|
1242
1154
|
qrCode?: string;
|
|
1243
|
-
/** Prize QR code tips */
|
|
1244
1155
|
qrCodeTips?: string;
|
|
1245
|
-
/** Discount price */
|
|
1246
1156
|
realPrice?: number;
|
|
1247
|
-
/** Original price */
|
|
1248
1157
|
price?: number;
|
|
1249
|
-
/** Question lottery prize info */
|
|
1250
1158
|
prizeInfo?: LotteryPrizeInfo[];
|
|
1251
|
-
/** Question group ID */
|
|
1252
1159
|
questionGroupId?: number;
|
|
1253
|
-
/** Answer duration per question */
|
|
1254
1160
|
perAnswerDuration?: number;
|
|
1255
|
-
/** Winners must be online when drawing */
|
|
1256
1161
|
lotteryOnlineEnabled?: YNFlag;
|
|
1257
|
-
|
|
1258
|
-
answerType?: AnswerType;
|
|
1259
|
-
/** Show winner code */
|
|
1162
|
+
answerType?: 'pushQuestion' | 'autonomyAnswer' | string;
|
|
1260
1163
|
showWinnerCode?: YNFlag;
|
|
1261
|
-
/** Show winners */
|
|
1262
1164
|
showWinners?: YNFlag;
|
|
1263
1165
|
}
|
|
1264
1166
|
/**
|
|
1265
1167
|
* Response for creating lottery activity
|
|
1266
1168
|
*/
|
|
1267
|
-
export
|
|
1169
|
+
export interface LotteryActivityCreateResponse {
|
|
1170
|
+
/** Activity ID */
|
|
1171
|
+
id: number;
|
|
1172
|
+
}
|
|
1268
1173
|
/**
|
|
1269
1174
|
* Parameters for getting lottery activity
|
|
1270
1175
|
*/
|
|
1271
1176
|
export interface LotteryActivityGetParams {
|
|
1272
1177
|
/** Channel ID */
|
|
1273
|
-
channelId: string;
|
|
1178
|
+
channelId: string | number;
|
|
1274
1179
|
/** Activity ID */
|
|
1275
1180
|
id: string | number;
|
|
1276
1181
|
}
|
|
1277
1182
|
/**
|
|
1278
1183
|
* Parameters for listing lottery activities
|
|
1279
1184
|
*/
|
|
1280
|
-
export interface LotteryActivityListParams {
|
|
1185
|
+
export interface LotteryActivityListParams extends V4PaginationParams {
|
|
1281
1186
|
/** Channel ID */
|
|
1282
|
-
channelId: string;
|
|
1283
|
-
/** Page number */
|
|
1284
|
-
pageNumber?: number;
|
|
1285
|
-
/** Page size */
|
|
1286
|
-
pageSize?: number;
|
|
1187
|
+
channelId: string | number;
|
|
1287
1188
|
}
|
|
1288
1189
|
/**
|
|
1289
1190
|
* Response for listing lottery activities
|
|
@@ -1303,84 +1204,56 @@ export interface LotteryActivityListResponse {
|
|
|
1303
1204
|
*/
|
|
1304
1205
|
export interface LotteryActivityUpdateParams {
|
|
1305
1206
|
/** Channel ID */
|
|
1306
|
-
channelId: string;
|
|
1207
|
+
channelId: string | number;
|
|
1307
1208
|
/** Activity ID */
|
|
1308
1209
|
id: string | number;
|
|
1309
1210
|
/** Activity name */
|
|
1310
|
-
activityName
|
|
1211
|
+
activityName: string;
|
|
1311
1212
|
/** Lottery condition type */
|
|
1312
|
-
lotteryCondition
|
|
1213
|
+
lotteryCondition: 'none' | 'invite' | 'duration' | 'comment' | 'question' | string;
|
|
1313
1214
|
/** Winner count */
|
|
1314
|
-
amount
|
|
1315
|
-
/**
|
|
1215
|
+
amount: number;
|
|
1216
|
+
/** Prize name */
|
|
1217
|
+
prizeName: string;
|
|
1316
1218
|
hiddenWinnerAmount?: YNFlag;
|
|
1317
|
-
|
|
1318
|
-
|
|
1319
|
-
|
|
1320
|
-
customGroupIds?: number[];
|
|
1321
|
-
/** Custom group lottery type */
|
|
1322
|
-
customGroupLotteryType?: CustomGroupLotteryType;
|
|
1323
|
-
/** Per-group winner count */
|
|
1219
|
+
lotteryRange?: 'all' | 'customGroup' | string;
|
|
1220
|
+
customGroupIds?: Array<string | number>;
|
|
1221
|
+
customGroupLotteryType?: 'average' | 'random' | string;
|
|
1324
1222
|
customGroupLotteryAmount?: number;
|
|
1325
|
-
/** Hide attendee count */
|
|
1326
1223
|
hiddenAttendeeNumber?: YNFlag;
|
|
1327
|
-
/** Allow repeat wins */
|
|
1328
1224
|
repeatWinEnabled?: YNFlag;
|
|
1329
|
-
/** Whether prize receive info is enabled */
|
|
1330
1225
|
receiveEnabled?: YNFlag;
|
|
1331
|
-
/** Prize receive info fields */
|
|
1332
1226
|
receiveInfo?: LotteryReceiveInfo[];
|
|
1333
|
-
/** Prize name */
|
|
1334
|
-
prizeName?: string;
|
|
1335
|
-
/** Prize image */
|
|
1336
1227
|
thumbnail?: string;
|
|
1337
|
-
|
|
1338
|
-
|
|
1339
|
-
|
|
1340
|
-
activityDurationType?: ActivityDurationType;
|
|
1341
|
-
/** Invite type */
|
|
1342
|
-
inviteType?: InviteType;
|
|
1343
|
-
/** External invite list URL */
|
|
1228
|
+
activityDuration?: string | number;
|
|
1229
|
+
activityDurationType?: 'second' | 'minute' | 'hour' | string;
|
|
1230
|
+
inviteType?: 'poster' | 'external' | string;
|
|
1344
1231
|
externalListLink?: string;
|
|
1345
|
-
/** External invite count URL */
|
|
1346
1232
|
externalInviteNumLink?: string;
|
|
1347
|
-
/** Invite count */
|
|
1348
1233
|
inviteNum?: number;
|
|
1349
|
-
/** Watch duration */
|
|
1350
1234
|
duration?: number;
|
|
1351
|
-
/** Comment keyword */
|
|
1352
1235
|
comment?: string;
|
|
1353
|
-
|
|
1354
|
-
acceptType?: AcceptType;
|
|
1355
|
-
/** Prize receive form fields */
|
|
1236
|
+
acceptType?: 'form' | 'link' | 'qrCode' | string;
|
|
1356
1237
|
formInfo?: LotteryReceiveInfo[];
|
|
1357
|
-
/** Prize link */
|
|
1358
1238
|
prizeUrl?: string;
|
|
1359
|
-
/** Prize QR code URL */
|
|
1360
1239
|
qrCode?: string;
|
|
1361
|
-
/** Prize QR code tips */
|
|
1362
1240
|
qrCodeTips?: string;
|
|
1363
|
-
/** Discount price */
|
|
1364
1241
|
realPrice?: number;
|
|
1365
|
-
/** Original price */
|
|
1366
1242
|
price?: number;
|
|
1367
|
-
/** Question lottery prize info */
|
|
1368
1243
|
prizeInfo?: LotteryPrizeInfo[];
|
|
1369
|
-
/** Question group ID */
|
|
1370
1244
|
questionGroupId?: number;
|
|
1371
|
-
/** Answer duration per question */
|
|
1372
1245
|
perAnswerDuration?: number;
|
|
1373
|
-
/** Winners must be online when drawing */
|
|
1374
1246
|
lotteryOnlineEnabled?: YNFlag;
|
|
1375
|
-
|
|
1376
|
-
|
|
1247
|
+
answerType?: 'pushQuestion' | 'autonomyAnswer' | string;
|
|
1248
|
+
showWinnerCode?: YNFlag;
|
|
1249
|
+
showWinners?: YNFlag;
|
|
1377
1250
|
}
|
|
1378
1251
|
/**
|
|
1379
1252
|
* Parameters for deleting lottery activity
|
|
1380
1253
|
*/
|
|
1381
1254
|
export interface LotteryActivityDeleteParams {
|
|
1382
1255
|
/** Channel ID */
|
|
1383
|
-
channelId: string;
|
|
1256
|
+
channelId: string | number;
|
|
1384
1257
|
/** Activity ID */
|
|
1385
1258
|
id: string | number;
|
|
1386
1259
|
}
|
|
@@ -1669,126 +1542,137 @@ export interface DiskVideoScriptDeleteParams {
|
|
|
1669
1542
|
* Share settings
|
|
1670
1543
|
*/
|
|
1671
1544
|
export interface ShareSettings {
|
|
1672
|
-
|
|
1673
|
-
|
|
1674
|
-
|
|
1675
|
-
|
|
1676
|
-
|
|
1677
|
-
|
|
1678
|
-
|
|
1679
|
-
|
|
1545
|
+
shareBtnEnable?: YNFlag;
|
|
1546
|
+
titleType?: 'follow' | 'custom' | string;
|
|
1547
|
+
weixinShareTitle?: string;
|
|
1548
|
+
weixinShareDesc?: string;
|
|
1549
|
+
weixinShareCustomUrl?: string;
|
|
1550
|
+
webShareCustomUrl?: string;
|
|
1551
|
+
weixinShareCustomUrlWithParamEnabled?: YNFlag;
|
|
1552
|
+
webShareCustomUrlWithParamEnabled?: YNFlag;
|
|
1553
|
+
[key: string]: unknown;
|
|
1680
1554
|
}
|
|
1681
1555
|
/**
|
|
1682
1556
|
* Parameters for getting share settings
|
|
1683
1557
|
*/
|
|
1684
1558
|
export interface ShareGetParams {
|
|
1685
1559
|
/** Channel ID */
|
|
1686
|
-
channelId: string;
|
|
1560
|
+
channelId: string | number;
|
|
1687
1561
|
}
|
|
1688
1562
|
/**
|
|
1689
1563
|
* Parameters for updating share settings
|
|
1690
1564
|
*/
|
|
1691
1565
|
export interface ShareUpdateParams {
|
|
1692
1566
|
/** Channel ID */
|
|
1693
|
-
channelId: string;
|
|
1694
|
-
|
|
1695
|
-
|
|
1696
|
-
|
|
1697
|
-
|
|
1698
|
-
|
|
1699
|
-
|
|
1567
|
+
channelId: string | number;
|
|
1568
|
+
shareBtnEnable: YNFlag;
|
|
1569
|
+
titleType: 'follow' | 'custom' | string;
|
|
1570
|
+
weixinShareTitle?: string;
|
|
1571
|
+
weixinShareDesc?: string;
|
|
1572
|
+
weixinShareCustomUrl?: string;
|
|
1573
|
+
webShareCustomUrl?: string;
|
|
1574
|
+
weixinShareCustomUrlWithParamEnabled?: YNFlag;
|
|
1575
|
+
webShareCustomUrlWithParamEnabled?: YNFlag;
|
|
1700
1576
|
}
|
|
1701
1577
|
/**
|
|
1702
1578
|
* Card push info
|
|
1703
1579
|
*/
|
|
1704
1580
|
export interface CardPushInfo {
|
|
1705
|
-
|
|
1706
|
-
|
|
1707
|
-
|
|
1708
|
-
|
|
1709
|
-
|
|
1710
|
-
|
|
1711
|
-
|
|
1712
|
-
|
|
1713
|
-
|
|
1714
|
-
type: string;
|
|
1715
|
-
/** Card URL */
|
|
1716
|
-
url: string;
|
|
1717
|
-
/** Created time */
|
|
1718
|
-
createdTime: number;
|
|
1581
|
+
cardPushId?: number | string;
|
|
1582
|
+
channelId?: string | number;
|
|
1583
|
+
cardType?: 'common' | 'qrCode' | string;
|
|
1584
|
+
imageType?: 'giftbox' | 'redpack' | 'custom' | 'weixinWork' | string;
|
|
1585
|
+
title?: string;
|
|
1586
|
+
link?: string;
|
|
1587
|
+
duration?: 0 | 5 | 10 | 20 | 30 | number;
|
|
1588
|
+
showCondition?: 'PUSH' | 'WATCH' | string;
|
|
1589
|
+
[key: string]: unknown;
|
|
1719
1590
|
}
|
|
1720
1591
|
/**
|
|
1721
1592
|
* Parameters for creating card push
|
|
1722
1593
|
*/
|
|
1723
1594
|
export interface CardPushCreateParams {
|
|
1724
1595
|
/** Channel ID */
|
|
1725
|
-
channelId: string;
|
|
1726
|
-
|
|
1596
|
+
channelId: string | number;
|
|
1597
|
+
cardType?: 'common' | 'qrCode' | string;
|
|
1598
|
+
imageType: 'giftbox' | 'redpack' | 'custom' | 'weixinWork' | string;
|
|
1727
1599
|
title: string;
|
|
1728
|
-
|
|
1729
|
-
|
|
1730
|
-
|
|
1731
|
-
|
|
1732
|
-
|
|
1733
|
-
|
|
1600
|
+
link: string;
|
|
1601
|
+
duration: 0 | 5 | 10 | 20 | 30 | number;
|
|
1602
|
+
durationPosition?: 'bottom' | 'top' | string;
|
|
1603
|
+
showCondition: 'PUSH' | 'WATCH' | string;
|
|
1604
|
+
conditionValue?: number;
|
|
1605
|
+
conditionUnit?: 'SECONDS' | 'MINUTES' | string;
|
|
1606
|
+
countdownMsg?: string;
|
|
1607
|
+
enterEnabled?: YNFlag;
|
|
1608
|
+
linkEnabled?: YNFlag;
|
|
1609
|
+
redirectType?: 'iframe' | 'tab' | string;
|
|
1610
|
+
enterImage?: string;
|
|
1611
|
+
cardImage?: string;
|
|
1612
|
+
weixinWordQrCodeId?: string;
|
|
1613
|
+
qrCodeImage?: string;
|
|
1614
|
+
hrefType?: 'common' | 'multiplatform' | string;
|
|
1615
|
+
pcLink?: string;
|
|
1616
|
+
mobileLink?: string;
|
|
1617
|
+
wxMiniprogramOriginalId?: string;
|
|
1618
|
+
wxMiniprogramAppId?: string;
|
|
1619
|
+
wxMiniprogramLink?: string;
|
|
1620
|
+
mobileAppLink?: string;
|
|
1734
1621
|
}
|
|
1735
1622
|
/**
|
|
1736
1623
|
* Response for creating card push
|
|
1737
1624
|
*/
|
|
1738
1625
|
export interface CardPushCreateResponse {
|
|
1739
1626
|
/** Card push ID */
|
|
1740
|
-
|
|
1741
|
-
|
|
1742
|
-
/**
|
|
1743
|
-
* Parameters for getting card push
|
|
1744
|
-
*/
|
|
1745
|
-
export interface CardPushGetParams {
|
|
1746
|
-
/** Channel ID */
|
|
1747
|
-
channelId: string;
|
|
1748
|
-
/** Card push ID */
|
|
1749
|
-
id: number;
|
|
1627
|
+
cardPushId?: number | string;
|
|
1628
|
+
[key: string]: unknown;
|
|
1750
1629
|
}
|
|
1751
1630
|
/**
|
|
1752
1631
|
* Parameters for updating card push
|
|
1753
1632
|
*/
|
|
1754
1633
|
export interface CardPushUpdateParams {
|
|
1755
1634
|
/** Channel ID */
|
|
1756
|
-
channelId: string;
|
|
1635
|
+
channelId: string | number;
|
|
1757
1636
|
/** Card push ID */
|
|
1758
|
-
|
|
1759
|
-
/** Card title */
|
|
1637
|
+
cardPushId: string | number;
|
|
1760
1638
|
title?: string;
|
|
1761
|
-
|
|
1762
|
-
|
|
1763
|
-
|
|
1764
|
-
|
|
1639
|
+
duration?: 0 | 5 | 10 | 20 | 30 | number;
|
|
1640
|
+
imageType?: 'giftbox' | 'redpack' | 'custom' | 'weixinWork' | string;
|
|
1641
|
+
link?: string;
|
|
1642
|
+
showCondition?: 'PUSH' | 'WATCH' | string;
|
|
1643
|
+
conditionValue?: number;
|
|
1644
|
+
conditionUnit?: 'SECONDS' | 'MINUTES' | string;
|
|
1645
|
+
countdownMsg?: string;
|
|
1646
|
+
enterEnabled?: YNFlag;
|
|
1647
|
+
linkEnabled?: YNFlag;
|
|
1648
|
+
[key: string]: unknown;
|
|
1765
1649
|
}
|
|
1766
1650
|
/**
|
|
1767
1651
|
* Parameters for deleting card push
|
|
1768
1652
|
*/
|
|
1769
1653
|
export interface CardPushDeleteParams {
|
|
1770
1654
|
/** Channel ID */
|
|
1771
|
-
channelId: string;
|
|
1655
|
+
channelId: string | number;
|
|
1772
1656
|
/** Card push ID */
|
|
1773
|
-
|
|
1657
|
+
cardPushId: string | number;
|
|
1774
1658
|
}
|
|
1775
1659
|
/**
|
|
1776
1660
|
* Parameters for pushing card
|
|
1777
1661
|
*/
|
|
1778
1662
|
export interface CardPushPushParams {
|
|
1779
1663
|
/** Channel ID */
|
|
1780
|
-
channelId: string;
|
|
1664
|
+
channelId: string | number;
|
|
1781
1665
|
/** Card push ID */
|
|
1782
|
-
|
|
1666
|
+
cardPushId: string | number;
|
|
1783
1667
|
}
|
|
1784
1668
|
/**
|
|
1785
1669
|
* Parameters for canceling card push
|
|
1786
1670
|
*/
|
|
1787
1671
|
export interface CardPushCancelPushParams {
|
|
1788
1672
|
/** Channel ID */
|
|
1789
|
-
channelId: string;
|
|
1673
|
+
channelId: string | number;
|
|
1790
1674
|
/** Card push ID */
|
|
1791
|
-
|
|
1675
|
+
cardPushId: string | number;
|
|
1792
1676
|
}
|
|
1793
1677
|
/**
|
|
1794
1678
|
* Parameters for browsers summary
|
|
@@ -2022,67 +1906,64 @@ export interface ProductStatsPageResponse {
|
|
|
2022
1906
|
*/
|
|
2023
1907
|
export interface ProductTag {
|
|
2024
1908
|
/** Tag ID */
|
|
2025
|
-
|
|
1909
|
+
id?: number | string;
|
|
2026
1910
|
/** Tag name */
|
|
2027
|
-
name
|
|
2028
|
-
|
|
2029
|
-
color: string;
|
|
1911
|
+
name?: string;
|
|
1912
|
+
[key: string]: unknown;
|
|
2030
1913
|
}
|
|
2031
1914
|
/**
|
|
2032
1915
|
* Parameters for creating product tag
|
|
2033
1916
|
*/
|
|
2034
1917
|
export interface ProductTagCreateParams {
|
|
2035
1918
|
/** Channel ID */
|
|
2036
|
-
channelId: string;
|
|
1919
|
+
channelId: string | number;
|
|
2037
1920
|
/** Tag name */
|
|
2038
1921
|
name: string;
|
|
2039
|
-
/** Tag color */
|
|
2040
|
-
color?: string;
|
|
2041
1922
|
}
|
|
2042
1923
|
/**
|
|
2043
1924
|
* Response for creating product tag
|
|
2044
1925
|
*/
|
|
2045
1926
|
export interface ProductTagCreateResponse {
|
|
2046
1927
|
/** Tag ID */
|
|
2047
|
-
|
|
1928
|
+
id?: number | string;
|
|
1929
|
+
name?: string;
|
|
1930
|
+
[key: string]: unknown;
|
|
2048
1931
|
}
|
|
2049
1932
|
/**
|
|
2050
1933
|
* Parameters for getting product tag
|
|
2051
1934
|
*/
|
|
2052
1935
|
export interface ProductTagGetParams {
|
|
2053
1936
|
/** Channel ID */
|
|
2054
|
-
channelId: string;
|
|
1937
|
+
channelId: string | number;
|
|
2055
1938
|
/** Tag ID */
|
|
2056
|
-
|
|
1939
|
+
id: string | number;
|
|
2057
1940
|
}
|
|
2058
1941
|
/**
|
|
2059
1942
|
* Parameters for listing product tags
|
|
2060
1943
|
*/
|
|
2061
|
-
export interface ProductTagListParams {
|
|
1944
|
+
export interface ProductTagListParams extends V4PaginationParams {
|
|
2062
1945
|
/** Channel ID */
|
|
2063
|
-
channelId: string;
|
|
1946
|
+
channelId: string | number;
|
|
2064
1947
|
}
|
|
2065
1948
|
/**
|
|
2066
1949
|
* Parameters for updating product tag
|
|
2067
1950
|
*/
|
|
2068
1951
|
export interface ProductTagUpdateParams {
|
|
2069
1952
|
/** Channel ID */
|
|
2070
|
-
channelId: string;
|
|
1953
|
+
channelId: string | number;
|
|
2071
1954
|
/** Tag ID */
|
|
2072
|
-
|
|
1955
|
+
id: string | number;
|
|
2073
1956
|
/** Tag name */
|
|
2074
|
-
name
|
|
2075
|
-
/** Tag color */
|
|
2076
|
-
color?: string;
|
|
1957
|
+
name: string;
|
|
2077
1958
|
}
|
|
2078
1959
|
/**
|
|
2079
1960
|
* Parameters for deleting product tag
|
|
2080
1961
|
*/
|
|
2081
1962
|
export interface ProductTagDeleteParams {
|
|
2082
1963
|
/** Channel ID */
|
|
2083
|
-
channelId: string;
|
|
1964
|
+
channelId: string | number;
|
|
2084
1965
|
/** Tag ID */
|
|
2085
|
-
|
|
1966
|
+
id: string | number;
|
|
2086
1967
|
}
|
|
2087
1968
|
/**
|
|
2088
1969
|
* Parameters for paging gifts
|
|
@@ -2155,6 +2036,48 @@ export interface LikeInfo {
|
|
|
2155
2036
|
/** Like time */
|
|
2156
2037
|
likeTime: number;
|
|
2157
2038
|
}
|
|
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
|
+
}
|
|
2158
2081
|
/**
|
|
2159
2082
|
* Response for paging likes
|
|
2160
2083
|
*/
|
|
@@ -2562,6 +2485,10 @@ export interface LiveSessionInfo {
|
|
|
2562
2485
|
/** Max viewer count */
|
|
2563
2486
|
maxViewerCount: number;
|
|
2564
2487
|
}
|
|
2488
|
+
export interface ListCardPushesParams {
|
|
2489
|
+
channelId: string | number;
|
|
2490
|
+
}
|
|
2491
|
+
export type ListCardPushesResponse = CardPushInfo[];
|
|
2565
2492
|
/** V4 Pagination parameters */
|
|
2566
2493
|
export interface V4PaginationParams {
|
|
2567
2494
|
/** Page number (1-based) */
|
|
@@ -2582,6 +2509,7 @@ export interface V4PaginatedResponse<T> {
|
|
|
2582
2509
|
/** Page size */
|
|
2583
2510
|
pageSize?: number;
|
|
2584
2511
|
}
|
|
2512
|
+
export type V4ChannelPageResponse<T> = V4PaginatedResponse<T>;
|
|
2585
2513
|
/** Channel ID parameter */
|
|
2586
2514
|
export interface ChannelIdParam {
|
|
2587
2515
|
/** Channel ID */
|
|
@@ -2613,6 +2541,7 @@ export type CreateLotteryActivityParams = LotteryActivityCreateParams;
|
|
|
2613
2541
|
export type CreateLotteryActivityResponse = LotteryActivityCreateResponse;
|
|
2614
2542
|
export type GetLotteryActivityParams = LotteryActivityGetParams;
|
|
2615
2543
|
export type ListLotteryActivitiesParams = LotteryActivityListParams;
|
|
2544
|
+
export type ListLotteryActivitiesResponse = LotteryActivityListResponse;
|
|
2616
2545
|
export type UpdateLotteryActivityParams = LotteryActivityUpdateParams;
|
|
2617
2546
|
export type DeleteLotteryActivityParams = LotteryActivityDeleteParams;
|
|
2618
2547
|
export type GroupResponse = GroupAddResponse;
|
|
@@ -2622,7 +2551,6 @@ export type GetShareParams = ShareGetParams;
|
|
|
2622
2551
|
export type UpdateShareParams = ShareUpdateParams;
|
|
2623
2552
|
export type CreateCardPushParams = CardPushCreateParams;
|
|
2624
2553
|
export type CreateCardPushResponse = CardPushCreateResponse;
|
|
2625
|
-
export type GetCardPushParams = CardPushGetParams;
|
|
2626
2554
|
export type UpdateCardPushParams = CardPushUpdateParams;
|
|
2627
2555
|
export type DeleteCardPushParams = CardPushDeleteParams;
|
|
2628
2556
|
export type PushCardParams = CardPushPushParams;
|
|
@@ -2637,6 +2565,7 @@ export type CreateProductTagParams = ProductTagCreateParams;
|
|
|
2637
2565
|
export type CreateProductTagResponse = ProductTagCreateResponse;
|
|
2638
2566
|
export type GetProductTagParams = ProductTagGetParams;
|
|
2639
2567
|
export type ListProductTagsParams = ProductTagListParams;
|
|
2568
|
+
export type ListChannelProductTagsResponse = V4ChannelPageResponse<ProductTag>;
|
|
2640
2569
|
export type UpdateProductTagParams = ProductTagUpdateParams;
|
|
2641
2570
|
export type DeleteProductTagParams = ProductTagDeleteParams;
|
|
2642
2571
|
export type GiftItem = GiftInfo;
|