ts-twitch-api 0.2.4 → 0.2.6
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 +114 -16
- package/dist/index.d.cts +699 -1451
- package/dist/index.d.ts +699 -1451
- package/dist/index.js +111 -13
- package/package.json +5 -6
package/dist/index.d.cts
CHANGED
|
@@ -374,8 +374,9 @@ interface components {
|
|
|
374
374
|
/** @description List of labels that should be set as the Channel’s CCLs. */
|
|
375
375
|
content_classification_labels?: ({
|
|
376
376
|
/**
|
|
377
|
-
* @description ID of the [Content Classification Labels](https://
|
|
377
|
+
* @description ID of the [Content Classification Labels](https://help.twitch.tv/s/article/content-classification-labels) that must be added/removed from the channel. Can be one of the following values:
|
|
378
378
|
*
|
|
379
|
+
* * DebatedSocialIssuesAndPolitics
|
|
379
380
|
* * DrugsIntoxication
|
|
380
381
|
* * SexualThemes
|
|
381
382
|
* * ViolentGraphic
|
|
@@ -383,7 +384,7 @@ interface components {
|
|
|
383
384
|
* * ProfanityVulgarity
|
|
384
385
|
* @enum {string}
|
|
385
386
|
*/
|
|
386
|
-
id: "DrugsIntoxication" | "SexualThemes" | "ViolentGraphic" | "Gambling" | "ProfanityVulgarity";
|
|
387
|
+
id: "DebatedSocialIssuesAndPolitics" | "DrugsIntoxication" | "SexualThemes" | "ViolentGraphic" | "Gambling" | "ProfanityVulgarity";
|
|
387
388
|
/** @description Boolean flag indicating whether the label should be enabled (true) or disabled for the channel. */
|
|
388
389
|
is_enabled: boolean;
|
|
389
390
|
})[];
|
|
@@ -643,6 +644,11 @@ interface components {
|
|
|
643
644
|
GetCustomRewardRedemptionResponse: {
|
|
644
645
|
/** @description The list of redemptions for the specified reward. The list is empty if there are no redemptions that match the redemption criteria. */
|
|
645
646
|
data: components["schemas"]["CustomRewardRedemption"][];
|
|
647
|
+
/** @description Contains the information used to page through the list of results. The object is empty if there are no more pages left to page through.[Read More](https://dev.twitch.tv/docs/api/guide#pagination) */
|
|
648
|
+
pagination?: {
|
|
649
|
+
/** @description The cursor used to get the next page of results. Use the cursor to set the request’s _after_ query parameter. */
|
|
650
|
+
cursor?: string;
|
|
651
|
+
};
|
|
646
652
|
};
|
|
647
653
|
UpdateCustomRewardBody: {
|
|
648
654
|
/** @description The reward’s title. The title may contain a maximum of 45 characters and it must be unique amongst all of the broadcaster’s custom rewards. */
|
|
@@ -1085,6 +1091,29 @@ interface components {
|
|
|
1085
1091
|
/** @description The list of chat settings. The list contains a single object with all the settings. */
|
|
1086
1092
|
data: components["schemas"]["ChatSettings"][];
|
|
1087
1093
|
};
|
|
1094
|
+
GetSharedChatSessionResponse: {
|
|
1095
|
+
data: {
|
|
1096
|
+
/** @description The unique identifier for the shared chat session. */
|
|
1097
|
+
session_id: string;
|
|
1098
|
+
/** @description The User ID of the host channel. */
|
|
1099
|
+
host_broadcaster_id: string;
|
|
1100
|
+
/** @description The list of participants in the session. */
|
|
1101
|
+
participants: {
|
|
1102
|
+
/** @description The User ID of the participant channel. */
|
|
1103
|
+
broadcaster_id: string;
|
|
1104
|
+
}[];
|
|
1105
|
+
/**
|
|
1106
|
+
* Format: date-time
|
|
1107
|
+
* @description The UTC date and time (in RFC3339 format) for when the session was created.
|
|
1108
|
+
*/
|
|
1109
|
+
created_at: string;
|
|
1110
|
+
/**
|
|
1111
|
+
* Format: date-time
|
|
1112
|
+
* @description The UTC date and time (in RFC3339 format) for when the session was last updated.
|
|
1113
|
+
*/
|
|
1114
|
+
updated_at: string;
|
|
1115
|
+
}[];
|
|
1116
|
+
};
|
|
1088
1117
|
GetUserEmotesResponse: {
|
|
1089
1118
|
data: ({
|
|
1090
1119
|
/** @description An ID that uniquely identifies this emote. */
|
|
@@ -1290,9 +1319,10 @@ interface components {
|
|
|
1290
1319
|
* * primary (default)
|
|
1291
1320
|
*
|
|
1292
1321
|
* If `color` is set to _primary_ or is not set, the channel’s accent color is used to highlight the announcement (see **Profile Accent Color** under [profile settings](https://www.twitch.tv/settings/profile), **Channel and Videos**, and **Brand**).
|
|
1322
|
+
* @default primary
|
|
1293
1323
|
* @enum {string}
|
|
1294
1324
|
*/
|
|
1295
|
-
color?: "blue" | "green" | "orange" | "purple" | "primary
|
|
1325
|
+
color?: "blue" | "green" | "orange" | "purple" | "primary";
|
|
1296
1326
|
};
|
|
1297
1327
|
SendChatMessageBody: {
|
|
1298
1328
|
/** @description The ID of the broadcaster whose chat room the message will be sent to. */
|
|
@@ -1303,6 +1333,14 @@ interface components {
|
|
|
1303
1333
|
message: string;
|
|
1304
1334
|
/** @description The ID of the chat message being replied to. */
|
|
1305
1335
|
reply_parent_message_id?: string;
|
|
1336
|
+
/**
|
|
1337
|
+
* @description **NOTE:** This parameter can only be set when utilizing an App Access Token. It cannot be specified when a User Access Token is used, and will instead result in an HTTP 400 error.
|
|
1338
|
+
*
|
|
1339
|
+
* Determines if the chat message is sent only to the source channel (defined by _broadcaster\_id_) during a shared chat session. This has no effect if the message is sent during a shared chat session.
|
|
1340
|
+
*
|
|
1341
|
+
* If this parameter is not set, the default value when using an App Access Token is `false`. On May 19, 2025 the default value for this parameter will be updated to `true`, and chat messages sent using an App Access Token will only be shared with the source channel by default. If you prefer to send a chat message to both channels in a shared chat session, make sure this parameter is explicitly set to `false` in your API request before May 19.
|
|
1342
|
+
*/
|
|
1343
|
+
for_source_only?: Record<string, never>;
|
|
1306
1344
|
};
|
|
1307
1345
|
SendChatMessageResponse: {
|
|
1308
1346
|
data: {
|
|
@@ -1350,7 +1388,7 @@ interface components {
|
|
|
1350
1388
|
id: string;
|
|
1351
1389
|
/** @description A URL to the clip. */
|
|
1352
1390
|
url: string;
|
|
1353
|
-
/** @description A URL that you can use in an iframe to embed the clip (see [Embedding Video and Clips](https://dev.twitch.tv/docs/embed/video-and-clips)). */
|
|
1391
|
+
/** @description A URL that you can use in an iframe to embed the clip (see [Embedding Video and Clips](https://dev.twitch.tv/docs/embed/video-and-clips/)). */
|
|
1354
1392
|
embed_url: string;
|
|
1355
1393
|
/** @description An ID that identifies the broadcaster that the video was clipped from. */
|
|
1356
1394
|
broadcaster_id: string;
|
|
@@ -2031,7 +2069,7 @@ interface components {
|
|
|
2031
2069
|
* @description The type of subscription to create. For a list of subscriptions that you can create, see [Subscription Types](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#subscription-types). Set this field to the value in the **Name** column of the Subscription Types table.
|
|
2032
2070
|
* @enum {string}
|
|
2033
2071
|
*/
|
|
2034
|
-
type: "automod.message.hold" | "automod.message.update" | "automod.settings.update" | "automod.terms.update" | "channel.update" | "channel.follow" | "channel.ad_break.begin" | "channel.chat.clear" | "channel.chat.clear_user_messages" | "channel.chat.message" | "channel.chat.message_delete" | "channel.chat.notification" | "channel.chat_settings.update" | "channel.chat.user_message_hold" | "channel.chat.user_message_update" | "channel.subscribe" | "channel.subscription.end" | "channel.subscription.gift" | "channel.subscription.message" | "channel.cheer" | "channel.raid" | "channel.ban" | "channel.unban" | "channel.unban_request.create" | "channel.unban_request.resolve" | "channel.moderate" | "channel.moderator.add" | "channel.moderator.remove" | "channel.guest_star_session.begin" | "channel.guest_star_session.end" | "channel.guest_star_guest.update" | "channel.guest_star_settings.update" | "channel.channel_points_automatic_reward_redemption.add" | "channel.channel_points_custom_reward.add" | "channel.channel_points_custom_reward.update" | "channel.channel_points_custom_reward.remove" | "channel.channel_points_custom_reward_redemption.add" | "channel.channel_points_custom_reward_redemption.update" | "channel.poll.begin" | "channel.poll.progress" | "channel.poll.end" | "channel.prediction.begin" | "channel.prediction.progress" | "channel.prediction.lock" | "channel.prediction.end" | "channel.suspicious_user.message" | "channel.suspicious_user.update" | "channel.vip.add" | "channel.vip.remove" | "channel.warning.acknowledge" | "channel.warning.send" | "channel.charity_campaign.donate" | "channel.charity_campaign.start" | "channel.charity_campaign.progress" | "channel.charity_campaign.stop" | "conduit.shard.disabled" | "drop.entitlement.grant" | "extension.bits_transaction.create" | "channel.goal.begin" | "channel.goal.progress" | "channel.goal.end" | "channel.hype_train.begin" | "channel.hype_train.progress" | "channel.hype_train.end" | "channel.shield_mode.begin" | "channel.shield_mode.end" | "channel.shoutout.create" | "channel.shoutout.receive" | "stream.online" | "stream.offline" | "user.authorization.grant" | "user.authorization.revoke" | "user.update" | "user.whisper.message";
|
|
2072
|
+
type: "automod.message.hold" | "automod.message.update" | "automod.settings.update" | "automod.terms.update" | "channel.bits.use" | "channel.update" | "channel.follow" | "channel.ad_break.begin" | "channel.chat.clear" | "channel.chat.clear_user_messages" | "channel.chat.message" | "channel.chat.message_delete" | "channel.chat.notification" | "channel.chat_settings.update" | "channel.chat.user_message_hold" | "channel.chat.user_message_update" | "channel.shared_chat.begin" | "channel.shared_chat.update" | "channel.shared_chat.end" | "channel.subscribe" | "channel.subscription.end" | "channel.subscription.gift" | "channel.subscription.message" | "channel.cheer" | "channel.raid" | "channel.ban" | "channel.unban" | "channel.unban_request.create" | "channel.unban_request.resolve" | "channel.moderate" | "channel.moderator.add" | "channel.moderator.remove" | "channel.guest_star_session.begin" | "channel.guest_star_session.end" | "channel.guest_star_guest.update" | "channel.guest_star_settings.update" | "channel.channel_points_automatic_reward_redemption.add" | "channel.channel_points_custom_reward.add" | "channel.channel_points_custom_reward.update" | "channel.channel_points_custom_reward.remove" | "channel.channel_points_custom_reward_redemption.add" | "channel.channel_points_custom_reward_redemption.update" | "channel.poll.begin" | "channel.poll.progress" | "channel.poll.end" | "channel.prediction.begin" | "channel.prediction.progress" | "channel.prediction.lock" | "channel.prediction.end" | "channel.suspicious_user.message" | "channel.suspicious_user.update" | "channel.vip.add" | "channel.vip.remove" | "channel.warning.acknowledge" | "channel.warning.send" | "channel.charity_campaign.donate" | "channel.charity_campaign.start" | "channel.charity_campaign.progress" | "channel.charity_campaign.stop" | "conduit.shard.disabled" | "drop.entitlement.grant" | "extension.bits_transaction.create" | "channel.goal.begin" | "channel.goal.progress" | "channel.goal.end" | "channel.hype_train.begin" | "channel.hype_train.progress" | "channel.hype_train.end" | "channel.shield_mode.begin" | "channel.shield_mode.end" | "channel.shoutout.create" | "channel.shoutout.receive" | "stream.online" | "stream.offline" | "user.authorization.grant" | "user.authorization.revoke" | "user.update" | "user.whisper.message";
|
|
2035
2073
|
/** @description The version number that identifies the definition of the subscription type that you want the response to use. */
|
|
2036
2074
|
version: string;
|
|
2037
2075
|
/** @description A JSON object that contains the parameter values that are specific to the specified subscription type. For the object’s required and optional fields, see the subscription type’s documentation. */
|
|
@@ -2090,7 +2128,7 @@ interface components {
|
|
|
2090
2128
|
* @description The subscription's type. See [Subscription Types](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#subscription-types).
|
|
2091
2129
|
* @enum {string}
|
|
2092
2130
|
*/
|
|
2093
|
-
type: "automod.message.hold" | "automod.message.update" | "automod.settings.update" | "automod.terms.update" | "channel.update" | "channel.follow" | "channel.ad_break.begin" | "channel.chat.clear" | "channel.chat.clear_user_messages" | "channel.chat.message" | "channel.chat.message_delete" | "channel.chat.notification" | "channel.chat_settings.update" | "channel.chat.user_message_hold" | "channel.chat.user_message_update" | "channel.subscribe" | "channel.subscription.end" | "channel.subscription.gift" | "channel.subscription.message" | "channel.cheer" | "channel.raid" | "channel.ban" | "channel.unban" | "channel.unban_request.create" | "channel.unban_request.resolve" | "channel.moderate" | "channel.moderator.add" | "channel.moderator.remove" | "channel.guest_star_session.begin" | "channel.guest_star_session.end" | "channel.guest_star_guest.update" | "channel.guest_star_settings.update" | "channel.channel_points_automatic_reward_redemption.add" | "channel.channel_points_custom_reward.add" | "channel.channel_points_custom_reward.update" | "channel.channel_points_custom_reward.remove" | "channel.channel_points_custom_reward_redemption.add" | "channel.channel_points_custom_reward_redemption.update" | "channel.poll.begin" | "channel.poll.progress" | "channel.poll.end" | "channel.prediction.begin" | "channel.prediction.progress" | "channel.prediction.lock" | "channel.prediction.end" | "channel.suspicious_user.message" | "channel.suspicious_user.update" | "channel.vip.add" | "channel.vip.remove" | "channel.warning.acknowledge" | "channel.warning.send" | "channel.charity_campaign.donate" | "channel.charity_campaign.start" | "channel.charity_campaign.progress" | "channel.charity_campaign.stop" | "conduit.shard.disabled" | "drop.entitlement.grant" | "extension.bits_transaction.create" | "channel.goal.begin" | "channel.goal.progress" | "channel.goal.end" | "channel.hype_train.begin" | "channel.hype_train.progress" | "channel.hype_train.end" | "channel.shield_mode.begin" | "channel.shield_mode.end" | "channel.shoutout.create" | "channel.shoutout.receive" | "stream.online" | "stream.offline" | "user.authorization.grant" | "user.authorization.revoke" | "user.update" | "user.whisper.message";
|
|
2131
|
+
type: "automod.message.hold" | "automod.message.update" | "automod.settings.update" | "automod.terms.update" | "channel.bits.use" | "channel.update" | "channel.follow" | "channel.ad_break.begin" | "channel.chat.clear" | "channel.chat.clear_user_messages" | "channel.chat.message" | "channel.chat.message_delete" | "channel.chat.notification" | "channel.chat_settings.update" | "channel.chat.user_message_hold" | "channel.chat.user_message_update" | "channel.shared_chat.begin" | "channel.shared_chat.update" | "channel.shared_chat.end" | "channel.subscribe" | "channel.subscription.end" | "channel.subscription.gift" | "channel.subscription.message" | "channel.cheer" | "channel.raid" | "channel.ban" | "channel.unban" | "channel.unban_request.create" | "channel.unban_request.resolve" | "channel.moderate" | "channel.moderator.add" | "channel.moderator.remove" | "channel.guest_star_session.begin" | "channel.guest_star_session.end" | "channel.guest_star_guest.update" | "channel.guest_star_settings.update" | "channel.channel_points_automatic_reward_redemption.add" | "channel.channel_points_custom_reward.add" | "channel.channel_points_custom_reward.update" | "channel.channel_points_custom_reward.remove" | "channel.channel_points_custom_reward_redemption.add" | "channel.channel_points_custom_reward_redemption.update" | "channel.poll.begin" | "channel.poll.progress" | "channel.poll.end" | "channel.prediction.begin" | "channel.prediction.progress" | "channel.prediction.lock" | "channel.prediction.end" | "channel.suspicious_user.message" | "channel.suspicious_user.update" | "channel.vip.add" | "channel.vip.remove" | "channel.warning.acknowledge" | "channel.warning.send" | "channel.charity_campaign.donate" | "channel.charity_campaign.start" | "channel.charity_campaign.progress" | "channel.charity_campaign.stop" | "conduit.shard.disabled" | "drop.entitlement.grant" | "extension.bits_transaction.create" | "channel.goal.begin" | "channel.goal.progress" | "channel.goal.end" | "channel.hype_train.begin" | "channel.hype_train.progress" | "channel.hype_train.end" | "channel.shield_mode.begin" | "channel.shield_mode.end" | "channel.shoutout.create" | "channel.shoutout.receive" | "stream.online" | "stream.offline" | "user.authorization.grant" | "user.authorization.revoke" | "user.update" | "user.whisper.message";
|
|
2094
2132
|
/** @description The version number that identifies this definition of the subscription's data. */
|
|
2095
2133
|
version: string;
|
|
2096
2134
|
/** @description The subscription's parameter values. This is a string-encoded JSON object whose contents are determined by the subscription type. */
|
|
@@ -2482,6 +2520,124 @@ interface components {
|
|
|
2482
2520
|
cursor?: string;
|
|
2483
2521
|
};
|
|
2484
2522
|
};
|
|
2523
|
+
GetHypeTrainStatusResponse: {
|
|
2524
|
+
/** @description A list that contains information related to the channel’s Hype Train. */
|
|
2525
|
+
data: ({
|
|
2526
|
+
/** @description An object describing the current Hype Train. Null if a Hype Train is not active. */
|
|
2527
|
+
current: {
|
|
2528
|
+
/** @description The Hype Train ID. */
|
|
2529
|
+
id: string;
|
|
2530
|
+
/** @description The broadcaster ID. */
|
|
2531
|
+
broadcaster_user_id: string;
|
|
2532
|
+
/** @description The broadcaster login. */
|
|
2533
|
+
broadcaster_user_login: string;
|
|
2534
|
+
/** @description The broadcaster display name. */
|
|
2535
|
+
broadcaster_user_name: string;
|
|
2536
|
+
/**
|
|
2537
|
+
* Format: int32
|
|
2538
|
+
* @description The current level of the Hype Train.
|
|
2539
|
+
*/
|
|
2540
|
+
level: number;
|
|
2541
|
+
/**
|
|
2542
|
+
* Format: int32
|
|
2543
|
+
* @description Total points contributed to the Hype Train.
|
|
2544
|
+
*/
|
|
2545
|
+
total: number;
|
|
2546
|
+
/**
|
|
2547
|
+
* Format: int32
|
|
2548
|
+
* @description The number of points contributed to the Hype Train at the current level.
|
|
2549
|
+
*/
|
|
2550
|
+
progress: number;
|
|
2551
|
+
/**
|
|
2552
|
+
* Format: int32
|
|
2553
|
+
* @description The number of points required to reach the next level.
|
|
2554
|
+
*/
|
|
2555
|
+
goal: number;
|
|
2556
|
+
/** @description The contributors with the most points contributed. */
|
|
2557
|
+
top_contributions: ({
|
|
2558
|
+
/** @description The ID of the user that made the contribution. */
|
|
2559
|
+
user_id: string;
|
|
2560
|
+
/** @description The user’s login name. */
|
|
2561
|
+
user_login: string;
|
|
2562
|
+
/** @description The user’s display name. */
|
|
2563
|
+
user_name: string;
|
|
2564
|
+
/**
|
|
2565
|
+
* @description The type of the Hype Train. Possible values are:
|
|
2566
|
+
*
|
|
2567
|
+
* * **treasure**
|
|
2568
|
+
* * **golden\_kappa**
|
|
2569
|
+
* * **regular**
|
|
2570
|
+
*
|
|
2571
|
+
* [Learn More](https://help.twitch.tv/s/article/hype-train-guide#special)
|
|
2572
|
+
* @enum {string}
|
|
2573
|
+
*/
|
|
2574
|
+
type: "treasure" | "golden_kappa" | "regular";
|
|
2575
|
+
/**
|
|
2576
|
+
* Format: int32
|
|
2577
|
+
* @description The total number of points contributed for the type.
|
|
2578
|
+
*/
|
|
2579
|
+
total: number;
|
|
2580
|
+
/** @description A list containing the broadcasters participating in the shared Hype Train. Null if the Hype Train is not shared. */
|
|
2581
|
+
shared_train_participants: {
|
|
2582
|
+
/** @description The broadcaster ID. */
|
|
2583
|
+
broadcaster_user_id: string;
|
|
2584
|
+
/** @description The broadcaster login. */
|
|
2585
|
+
broadcaster_user_login: string;
|
|
2586
|
+
/** @description The broadcaster display name. */
|
|
2587
|
+
broadcaster_user_name: string;
|
|
2588
|
+
}[];
|
|
2589
|
+
/**
|
|
2590
|
+
* Format: date-time
|
|
2591
|
+
* @description The time when the Hype Train started.
|
|
2592
|
+
*/
|
|
2593
|
+
started_at: string;
|
|
2594
|
+
/**
|
|
2595
|
+
* Format: date-time
|
|
2596
|
+
* @description The time when the Hype Train expires. The expiration is extended when the Hype Train reaches a new level.
|
|
2597
|
+
*/
|
|
2598
|
+
expires_at: string;
|
|
2599
|
+
/** @description Indicates if the Hype Train is shared. When true, shared\_train\_participants will contain the list of broadcasters the train is shared with. */
|
|
2600
|
+
is_shared_train: boolean;
|
|
2601
|
+
})[];
|
|
2602
|
+
};
|
|
2603
|
+
})[];
|
|
2604
|
+
/** @description An object with information about the channel’s Hype Train records. Null if a Hype Train has not occurred. */
|
|
2605
|
+
all_time_high: {
|
|
2606
|
+
/**
|
|
2607
|
+
* Format: int32
|
|
2608
|
+
* @description The level of the record Hype Train.
|
|
2609
|
+
*/
|
|
2610
|
+
level: number;
|
|
2611
|
+
/**
|
|
2612
|
+
* Format: int32
|
|
2613
|
+
* @description Total points contributed to the record Hype Train.
|
|
2614
|
+
*/
|
|
2615
|
+
total: number;
|
|
2616
|
+
/**
|
|
2617
|
+
* Format: date-time
|
|
2618
|
+
* @description The time when the record was achieved.
|
|
2619
|
+
*/
|
|
2620
|
+
achieved_at: string;
|
|
2621
|
+
};
|
|
2622
|
+
/** @description An object with information about the channel’s shared Hype Train records. Null if a Hype Train has not occurred. */
|
|
2623
|
+
shared_all_time_high: {
|
|
2624
|
+
/**
|
|
2625
|
+
* Format: int32
|
|
2626
|
+
* @description The level of the record Hype Train.
|
|
2627
|
+
*/
|
|
2628
|
+
level: number;
|
|
2629
|
+
/**
|
|
2630
|
+
* Format: int32
|
|
2631
|
+
* @description Total points contributed to the record Hype Train.
|
|
2632
|
+
*/
|
|
2633
|
+
total: number;
|
|
2634
|
+
/**
|
|
2635
|
+
* Format: date-time
|
|
2636
|
+
* @description The time when the record was achieved.
|
|
2637
|
+
*/
|
|
2638
|
+
achieved_at: string;
|
|
2639
|
+
};
|
|
2640
|
+
};
|
|
2485
2641
|
CheckAutoModStatusBody: {
|
|
2486
2642
|
/** @description The list of messages to check. The list must contain at least one message and may contain up to a maximum of 100 messages. */
|
|
2487
2643
|
data: {
|
|
@@ -3405,6 +3561,11 @@ interface components {
|
|
|
3405
3561
|
SearchCategoriesResponse: {
|
|
3406
3562
|
/** @description The list of games or categories that match the query. The list is empty if there are no matches. */
|
|
3407
3563
|
data: components["schemas"]["Category"][];
|
|
3564
|
+
/** @description Contains the information used to page through the list of results. The object is empty if there are no more pages left to page through.[Read More](https://dev.twitch.tv/docs/api/guide#pagination) */
|
|
3565
|
+
pagination?: {
|
|
3566
|
+
/** @description The cursor used to get the next page of results. Use the cursor to set the request’s _after_ query parameter. */
|
|
3567
|
+
cursor?: string;
|
|
3568
|
+
};
|
|
3408
3569
|
};
|
|
3409
3570
|
Channel: {
|
|
3410
3571
|
/** @description The ISO 639-1 two-letter language code of the language used by the broadcaster. For example, _en_ for English. If the broadcaster uses a language not in the list of [supported stream languages](https://help.twitch.tv/s/article/languages-on-twitch#streamlang), the value is _other_. */
|
|
@@ -3443,6 +3604,11 @@ interface components {
|
|
|
3443
3604
|
SearchChannelsResponse: {
|
|
3444
3605
|
/** @description The list of channels that match the query. The list is empty if there are no matches. */
|
|
3445
3606
|
data: components["schemas"]["Channel"][];
|
|
3607
|
+
/** @description Contains the information used to page through the list of results. The object is empty if there are no more pages left to page through.[Read More](https://dev.twitch.tv/docs/api/guide#pagination) */
|
|
3608
|
+
pagination?: {
|
|
3609
|
+
/** @description The cursor used to get the next page of results. Use the cursor to set the request’s _after_ query parameter. */
|
|
3610
|
+
cursor?: string;
|
|
3611
|
+
};
|
|
3446
3612
|
};
|
|
3447
3613
|
GetStreamKeyResponse: {
|
|
3448
3614
|
/** @description A list that contains the channel’s stream key. */
|
|
@@ -3840,6 +4006,11 @@ interface components {
|
|
|
3840
4006
|
GetUserBlockListResponse: {
|
|
3841
4007
|
/** @description The list of blocked users. The list is in descending order by when the user was blocked. */
|
|
3842
4008
|
data: components["schemas"]["UserBlockList"][];
|
|
4009
|
+
/** @description Contains the information used to page through the list of results. The object is empty if there are no more pages left to page through.[Read More](https://dev.twitch.tv/docs/api/guide#pagination) */
|
|
4010
|
+
pagination?: {
|
|
4011
|
+
/** @description The cursor used to get the next page of results. Use the cursor to set the request’s _after_ query parameter. */
|
|
4012
|
+
cursor?: string;
|
|
4013
|
+
};
|
|
3843
4014
|
};
|
|
3844
4015
|
UserExtension: {
|
|
3845
4016
|
/** @description An ID that identifies the extension. */
|
|
@@ -5698,6 +5869,45 @@ interface operations {
|
|
|
5698
5869
|
};
|
|
5699
5870
|
};
|
|
5700
5871
|
};
|
|
5872
|
+
/**
|
|
5873
|
+
* NEW Retrieves the active shared chat session for a channel.
|
|
5874
|
+
* @description NEW Retrieves the active shared chat session for a channel.
|
|
5875
|
+
*
|
|
5876
|
+
* __Authorization:__
|
|
5877
|
+
*
|
|
5878
|
+
* Requires an [app access token](https://dev.twitch.tv/docs/cli/token-command/#app-access-token) or [user access token](https://dev.twitch.tv/docs/authentication/#user-access-tokens).
|
|
5879
|
+
*/
|
|
5880
|
+
"get-shared-chat-session": {
|
|
5881
|
+
parameters: {
|
|
5882
|
+
query: {
|
|
5883
|
+
/** @description The User ID of the channel broadcaster. */
|
|
5884
|
+
broadcaster_id: string;
|
|
5885
|
+
};
|
|
5886
|
+
};
|
|
5887
|
+
responses: {
|
|
5888
|
+
/** @description Successfully retrieved the shared chat session. Returns an empty array if the broadcaster\_id in the request isn’t in a shared chat session. */
|
|
5889
|
+
200: {
|
|
5890
|
+
content: {
|
|
5891
|
+
"application/json": components["schemas"]["GetSharedChatSessionResponse"];
|
|
5892
|
+
};
|
|
5893
|
+
};
|
|
5894
|
+
/** @description The ID in the `broadcaster_id` query parameter is not valid. */
|
|
5895
|
+
400: {
|
|
5896
|
+
content: never;
|
|
5897
|
+
};
|
|
5898
|
+
/**
|
|
5899
|
+
* @description * The OAuth token is not valid.
|
|
5900
|
+
* * The Authorization header is required and must contain a user access token.
|
|
5901
|
+
*/
|
|
5902
|
+
401: {
|
|
5903
|
+
content: never;
|
|
5904
|
+
};
|
|
5905
|
+
/** @description Internal Server Error. */
|
|
5906
|
+
500: {
|
|
5907
|
+
content: never;
|
|
5908
|
+
};
|
|
5909
|
+
};
|
|
5910
|
+
};
|
|
5701
5911
|
/**
|
|
5702
5912
|
* NEW Retrieves emotes available to the user across all channels.
|
|
5703
5913
|
* @description NEW Retrieves emotes available to the user across all channels.
|
|
@@ -5752,6 +5962,8 @@ interface operations {
|
|
|
5752
5962
|
* Sends an announcement to the broadcaster’s chat room.
|
|
5753
5963
|
* @description Sends an announcement to the broadcaster’s chat room.
|
|
5754
5964
|
*
|
|
5965
|
+
* **Rate Limits**: One announcement may be sent every 2 seconds.
|
|
5966
|
+
*
|
|
5755
5967
|
* __Authorization:__
|
|
5756
5968
|
*
|
|
5757
5969
|
* Requires a [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens) that includes the **moderator:manage:announcements** scope.
|
|
@@ -5809,6 +6021,10 @@ interface operations {
|
|
|
5809
6021
|
401: {
|
|
5810
6022
|
content: never;
|
|
5811
6023
|
};
|
|
6024
|
+
/** @description The sender has exceeded the number of announcements they may send to this **broadcaster\_id** within a given window. */
|
|
6025
|
+
429: {
|
|
6026
|
+
content: never;
|
|
6027
|
+
};
|
|
5812
6028
|
};
|
|
5813
6029
|
};
|
|
5814
6030
|
/**
|
|
@@ -5817,7 +6033,7 @@ interface operations {
|
|
|
5817
6033
|
*
|
|
5818
6034
|
* Twitch’s Shoutout feature is a great way for you to show support for other broadcasters and help them grow. Viewers who do not follow the other broadcaster will see a pop-up Follow button in your chat that they can click to follow the other broadcaster. [Learn More](https://help.twitch.tv/s/article/shoutouts)
|
|
5819
6035
|
*
|
|
5820
|
-
* **Rate Limits
|
|
6036
|
+
* **Rate Limits**: The broadcaster may send a Shoutout once every 2 minutes. They may send the same broadcaster a Shoutout once every 60 minutes.
|
|
5821
6037
|
*
|
|
5822
6038
|
* To receive notifications when a Shoutout is sent or received, subscribe to the [channel.shoutout.create](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelshoutoutcreate) and [channel.shoutout.receive](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelshoutoutreceive) subscription types. The **channel.shoutout.create** event includes cooldown periods that indicate when the broadcaster may send another Shoutout without exceeding the endpoint’s rate limit.
|
|
5823
6039
|
*
|
|
@@ -5894,6 +6110,11 @@ interface operations {
|
|
|
5894
6110
|
* NEW Sends a message to the broadcaster’s chat room.
|
|
5895
6111
|
* @description NEW Sends a message to the broadcaster’s chat room.
|
|
5896
6112
|
*
|
|
6113
|
+
* **NOTE:** When sending messages to a Shared Chat session, behaviors differ depending on your authentication token type:
|
|
6114
|
+
*
|
|
6115
|
+
* * When using an _App Access Token_, messages will only be sent to the source channel (defined by the `broadcaster_id` parameter) by default starting on May 19, 2025\. Messages can be sent to all channels by using the `for_source_only` parameter and setting it to `false`.
|
|
6116
|
+
* * When using a _User Access Token_, messages will be sent to all channels in the shared chat session, including the source channel. This behavior cannot be changed with this token type.
|
|
6117
|
+
*
|
|
5897
6118
|
* __Authorization:__
|
|
5898
6119
|
*
|
|
5899
6120
|
* Requires an [app access token](https://dev.twitch.tv/docs/authentication#app-access-tokens) or [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens) that includes the `user:write:chat` scope. If app access token used, then additionally requires `user:bot` scope from chatting user, and either `channel:bot` scope from broadcaster or moderator status.
|
|
@@ -5918,6 +6139,7 @@ interface operations {
|
|
|
5918
6139
|
* * The ID in the _sender\_id_ query parameter is not valid.
|
|
5919
6140
|
* * The _text_ query parameter is required.
|
|
5920
6141
|
* * The ID in the _reply\_parent\_message\_id_ query parameter is not valid.
|
|
6142
|
+
* * Cannot set \*for\_source\_only\* if User Access Token is used.
|
|
5921
6143
|
*/
|
|
5922
6144
|
400: {
|
|
5923
6145
|
content: never;
|
|
@@ -6071,6 +6293,8 @@ interface operations {
|
|
|
6071
6293
|
* Gets one or more video clips.
|
|
6072
6294
|
* @description Gets one or more video clips that were captured from streams. For information about clips, see [How to use clips](https://help.twitch.tv/s/article/how-to-use-clips).
|
|
6073
6295
|
*
|
|
6296
|
+
* When using pagination for clips, note that the maximum number of results returned over multiple requests will be approximately 1,000\. If additional results are necessary, paginate over different query parameters such as multiple `started_at` and `ended_at` timeframes to refine the search.
|
|
6297
|
+
*
|
|
6074
6298
|
* __Authorization:__
|
|
6075
6299
|
*
|
|
6076
6300
|
* Requires an [app access token](https://dev.twitch.tv/docs/authentication#app-access-tokens) or [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens).
|
|
@@ -6191,7 +6415,7 @@ interface operations {
|
|
|
6191
6415
|
};
|
|
6192
6416
|
/**
|
|
6193
6417
|
* NEW Gets the conduits for a client ID.
|
|
6194
|
-
* @description NEW Gets the [conduits](https://dev.twitch.tv/docs/eventsub/handling-conduit-events) for a client ID.
|
|
6418
|
+
* @description NEW Gets the [conduits](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/) for a client ID.
|
|
6195
6419
|
*
|
|
6196
6420
|
* __Authorization:__
|
|
6197
6421
|
*
|
|
@@ -6213,7 +6437,7 @@ interface operations {
|
|
|
6213
6437
|
};
|
|
6214
6438
|
/**
|
|
6215
6439
|
* NEW Creates a new conduit.
|
|
6216
|
-
* @description NEW Creates a new [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events).
|
|
6440
|
+
* @description NEW Creates a new [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/).
|
|
6217
6441
|
*
|
|
6218
6442
|
* __Authorization:__
|
|
6219
6443
|
*
|
|
@@ -6248,7 +6472,7 @@ interface operations {
|
|
|
6248
6472
|
};
|
|
6249
6473
|
/**
|
|
6250
6474
|
* NEW Deletes a specified conduit.
|
|
6251
|
-
* @description NEW Deletes a specified [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/). Note that it may take some time for Eventsub subscriptions on a deleted [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events) to show as disabled when calling [Get Eventsub Subscriptions](https://dev.twitch.tv/docs/api/reference/#get-eventsub-subscriptions).
|
|
6475
|
+
* @description NEW Deletes a specified [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/). Note that it may take some time for Eventsub subscriptions on a deleted [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/) to show as disabled when calling [Get Eventsub Subscriptions](https://dev.twitch.tv/docs/api/reference/#get-eventsub-subscriptions).
|
|
6252
6476
|
*
|
|
6253
6477
|
* __Authorization:__
|
|
6254
6478
|
*
|
|
@@ -6297,7 +6521,7 @@ interface operations {
|
|
|
6297
6521
|
};
|
|
6298
6522
|
/**
|
|
6299
6523
|
* NEW Updates a conduit’s shard count.
|
|
6300
|
-
* @description NEW Updates a [conduit’s](https://dev.twitch.tv/docs/eventsub/handling-conduit-events) shard count. To delete shards, update the count to a lower number, and the shards above the count will be deleted. For example, if the existing shard count is 100, by resetting shard count to 50, shards 50-99 are disabled.
|
|
6524
|
+
* @description NEW Updates a [conduit’s](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/) shard count. To delete shards, update the count to a lower number, and the shards above the count will be deleted. For example, if the existing shard count is 100, by resetting shard count to 50, shards 50-99 are disabled.
|
|
6301
6525
|
*
|
|
6302
6526
|
* __Authorization:__
|
|
6303
6527
|
*
|
|
@@ -6338,7 +6562,7 @@ interface operations {
|
|
|
6338
6562
|
};
|
|
6339
6563
|
/**
|
|
6340
6564
|
* NEW Gets a lists of all shards for a conduit.
|
|
6341
|
-
* @description NEW Gets a lists of all shards for a [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events).
|
|
6565
|
+
* @description NEW Gets a lists of all shards for a [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/).
|
|
6342
6566
|
*
|
|
6343
6567
|
* __Authorization:__
|
|
6344
6568
|
*
|
|
@@ -6381,7 +6605,7 @@ interface operations {
|
|
|
6381
6605
|
};
|
|
6382
6606
|
/**
|
|
6383
6607
|
* NEW Updates shard(s) for a conduit.
|
|
6384
|
-
* @description NEW Updates shard(s) for a [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events).
|
|
6608
|
+
* @description NEW Updates shard(s) for a [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/).
|
|
6385
6609
|
*
|
|
6386
6610
|
* **NOTE:** Shard IDs are indexed starting at 0, so a conduit with a `shard_count` of 5 will have shards with IDs 0 through 4.
|
|
6387
6611
|
*
|
|
@@ -6477,7 +6701,7 @@ interface operations {
|
|
|
6477
6701
|
*
|
|
6478
6702
|
* __Authorization:__
|
|
6479
6703
|
*
|
|
6480
|
-
* Requires an [app access token](https://dev.twitch.tv/docs/authentication#app-access-tokens) or [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens). The
|
|
6704
|
+
* Requires an [app access token](https://dev.twitch.tv/docs/authentication#app-access-tokens) or [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens). The Client ID associated with the access token must be owned by a user who is a member of the [organization](https://dev.twitch.tv/docs/docs/companies/) that holds ownership of the game.
|
|
6481
6705
|
*/
|
|
6482
6706
|
"get-drops-entitlements": {
|
|
6483
6707
|
parameters: {
|
|
@@ -6551,7 +6775,7 @@ interface operations {
|
|
|
6551
6775
|
*
|
|
6552
6776
|
* __Authorization:__
|
|
6553
6777
|
*
|
|
6554
|
-
* Requires an [app access token](https://dev.twitch.tv/docs/authentication#app-access-tokens) or [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens). The
|
|
6778
|
+
* Requires an [app access token](https://dev.twitch.tv/docs/authentication#app-access-tokens) or [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens). The Client ID associated with the access token must be owned by a user who is a member of the [organization](https://dev.twitch.tv/docs/docs/companies/) that holds ownership of the game.
|
|
6555
6779
|
*/
|
|
6556
6780
|
"update-drops-entitlements": {
|
|
6557
6781
|
requestBody?: {
|
|
@@ -6867,7 +7091,7 @@ interface operations {
|
|
|
6867
7091
|
query: {
|
|
6868
7092
|
/** @description The ID of the extension to get. Returns the list of broadcasters that are live and that have installed or activated this extension. */
|
|
6869
7093
|
extension_id: string;
|
|
6870
|
-
/** @description The maximum number of items
|
|
7094
|
+
/** @description The specific maximum number of items per page in the response. The actual number returned may be less than this limit. [Read More](https://dev.twitch.tv/docs/api/guide#pagination) */
|
|
6871
7095
|
first?: number;
|
|
6872
7096
|
/** @description The cursor used to get the next page of results. The `pagination` field in the response contains the cursor’s value. [Read More](https://dev.twitch.tv/docs/api/guide#pagination) */
|
|
6873
7097
|
after?: string;
|
|
@@ -7209,13 +7433,13 @@ interface operations {
|
|
|
7209
7433
|
*
|
|
7210
7434
|
* __Authorization:__
|
|
7211
7435
|
*
|
|
7212
|
-
* If you use [Webhooks](https://dev.twitch.tv/docs/eventsub/handling-webhook-events) or [Conduits](https://dev.twitch.tv/docs/eventsub/handling-conduit-events) to receive events, the request must specify an app access token. The request will fail if you use a user access token.
|
|
7436
|
+
* If you use [Webhooks](https://dev.twitch.tv/docs/eventsub/handling-webhook-events) or [Conduits](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/) to receive events, the request must specify an app access token. The request will fail if you use a user access token.
|
|
7213
7437
|
*
|
|
7214
7438
|
* If you use [WebSockets to receive events](https://dev.twitch.tv/docs/eventsub/handling-websocket-events), the request must specify a user access token. The request will fail if you use an app access token. The token may include any scopes.
|
|
7215
7439
|
*
|
|
7216
7440
|
* __Request Query Parameters:__
|
|
7217
7441
|
*
|
|
7218
|
-
* Use the _status_, _type_, and
|
|
7442
|
+
* Use the _status_, _type_, _user\_id_, and _subscription\_id_ query parameters to filter the list of subscriptions that are returned. The filters are mutually exclusive; the request fails if you specify more than one filter.
|
|
7219
7443
|
*/
|
|
7220
7444
|
"get-eventsub-subscriptions": {
|
|
7221
7445
|
parameters: {
|
|
@@ -7244,9 +7468,11 @@ interface operations {
|
|
|
7244
7468
|
*/
|
|
7245
7469
|
status?: "enabled" | "webhook_callback_verification_pending" | "webhook_callback_verification_failed" | "notification_failures_exceeded" | "authorization_revoked" | "moderator_removed" | "user_removed" | "chat_user_banned" | "version_removed" | "beta_maintenance" | "websocket_disconnected" | "websocket_failed_ping_pong" | "websocket_received_inbound_traffic" | "websocket_connection_unused" | "websocket_internal_error" | "websocket_network_timeout" | "websocket_network_error" | "websocket_failed_to_reconnect";
|
|
7246
7470
|
/** @description Filter subscriptions by subscription type. For a list of subscription types, see [Subscription Types](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#subscription-types). */
|
|
7247
|
-
type?: "automod.message.hold" | "automod.message.update" | "automod.settings.update" | "automod.terms.update" | "channel.update" | "channel.follow" | "channel.ad_break.begin" | "channel.chat.clear" | "channel.chat.clear_user_messages" | "channel.chat.message" | "channel.chat.message_delete" | "channel.chat.notification" | "channel.chat_settings.update" | "channel.chat.user_message_hold" | "channel.chat.user_message_update" | "channel.subscribe" | "channel.subscription.end" | "channel.subscription.gift" | "channel.subscription.message" | "channel.cheer" | "channel.raid" | "channel.ban" | "channel.unban" | "channel.unban_request.create" | "channel.unban_request.resolve" | "channel.moderate" | "channel.moderator.add" | "channel.moderator.remove" | "channel.guest_star_session.begin" | "channel.guest_star_session.end" | "channel.guest_star_guest.update" | "channel.guest_star_settings.update" | "channel.channel_points_automatic_reward_redemption.add" | "channel.channel_points_custom_reward.add" | "channel.channel_points_custom_reward.update" | "channel.channel_points_custom_reward.remove" | "channel.channel_points_custom_reward_redemption.add" | "channel.channel_points_custom_reward_redemption.update" | "channel.poll.begin" | "channel.poll.progress" | "channel.poll.end" | "channel.prediction.begin" | "channel.prediction.progress" | "channel.prediction.lock" | "channel.prediction.end" | "channel.suspicious_user.message" | "channel.suspicious_user.update" | "channel.vip.add" | "channel.vip.remove" | "channel.warning.acknowledge" | "channel.warning.send" | "channel.charity_campaign.donate" | "channel.charity_campaign.start" | "channel.charity_campaign.progress" | "channel.charity_campaign.stop" | "conduit.shard.disabled" | "drop.entitlement.grant" | "extension.bits_transaction.create" | "channel.goal.begin" | "channel.goal.progress" | "channel.goal.end" | "channel.hype_train.begin" | "channel.hype_train.progress" | "channel.hype_train.end" | "channel.shield_mode.begin" | "channel.shield_mode.end" | "channel.shoutout.create" | "channel.shoutout.receive" | "stream.online" | "stream.offline" | "user.authorization.grant" | "user.authorization.revoke" | "user.update" | "user.whisper.message";
|
|
7471
|
+
type?: "automod.message.hold" | "automod.message.update" | "automod.settings.update" | "automod.terms.update" | "channel.bits.use" | "channel.update" | "channel.follow" | "channel.ad_break.begin" | "channel.chat.clear" | "channel.chat.clear_user_messages" | "channel.chat.message" | "channel.chat.message_delete" | "channel.chat.notification" | "channel.chat_settings.update" | "channel.chat.user_message_hold" | "channel.chat.user_message_update" | "channel.shared_chat.begin" | "channel.shared_chat.update" | "channel.shared_chat.end" | "channel.subscribe" | "channel.subscription.end" | "channel.subscription.gift" | "channel.subscription.message" | "channel.cheer" | "channel.raid" | "channel.ban" | "channel.unban" | "channel.unban_request.create" | "channel.unban_request.resolve" | "channel.moderate" | "channel.moderator.add" | "channel.moderator.remove" | "channel.guest_star_session.begin" | "channel.guest_star_session.end" | "channel.guest_star_guest.update" | "channel.guest_star_settings.update" | "channel.channel_points_automatic_reward_redemption.add" | "channel.channel_points_custom_reward.add" | "channel.channel_points_custom_reward.update" | "channel.channel_points_custom_reward.remove" | "channel.channel_points_custom_reward_redemption.add" | "channel.channel_points_custom_reward_redemption.update" | "channel.poll.begin" | "channel.poll.progress" | "channel.poll.end" | "channel.prediction.begin" | "channel.prediction.progress" | "channel.prediction.lock" | "channel.prediction.end" | "channel.suspicious_user.message" | "channel.suspicious_user.update" | "channel.vip.add" | "channel.vip.remove" | "channel.warning.acknowledge" | "channel.warning.send" | "channel.charity_campaign.donate" | "channel.charity_campaign.start" | "channel.charity_campaign.progress" | "channel.charity_campaign.stop" | "conduit.shard.disabled" | "drop.entitlement.grant" | "extension.bits_transaction.create" | "channel.goal.begin" | "channel.goal.progress" | "channel.goal.end" | "channel.hype_train.begin" | "channel.hype_train.progress" | "channel.hype_train.end" | "channel.shield_mode.begin" | "channel.shield_mode.end" | "channel.shoutout.create" | "channel.shoutout.receive" | "stream.online" | "stream.offline" | "user.authorization.grant" | "user.authorization.revoke" | "user.update" | "user.whisper.message";
|
|
7248
7472
|
/** @description Filter subscriptions by user ID. The response contains subscriptions where this ID matches a user ID that you specified in the **Condition** object when you [created the subscription](https://dev.twitch.tv/docs/api/reference#create-eventsub-subscription). */
|
|
7249
7473
|
user_id?: string;
|
|
7474
|
+
/** @description Returns an array with the subscription matching the ID (as long as it is owned by the client making the request), or an empty array if there is no matching subscription. */
|
|
7475
|
+
subscription_id?: string;
|
|
7250
7476
|
/** @description The cursor used to get the next page of results. The `pagination` object in the response contains the cursor's value. */
|
|
7251
7477
|
after?: string;
|
|
7252
7478
|
};
|
|
@@ -7287,7 +7513,7 @@ interface operations {
|
|
|
7287
7513
|
*
|
|
7288
7514
|
* If you use [WebSockets to receive events](https://dev.twitch.tv/docs/eventsub/handling-websocket-events), the request must specify a user access token. The request will fail if you use an app access token. If the subscription type requires user authorization, the token must include the required scope. However, if the subscription type doesn’t include user authorization, the token may include any scopes or no scopes.
|
|
7289
7515
|
*
|
|
7290
|
-
* If you use [Conduits](https://dev.twitch.tv/docs/eventsub/handling-conduit-events) to receive events, the request must specify an app access token. The request will fail if you use a user access token.
|
|
7516
|
+
* If you use [Conduits](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/) to receive events, the request must specify an app access token. The request will fail if you use a user access token.
|
|
7291
7517
|
*/
|
|
7292
7518
|
"create-eventsub-subscription": {
|
|
7293
7519
|
requestBody?: {
|
|
@@ -8240,6 +8466,47 @@ interface operations {
|
|
|
8240
8466
|
};
|
|
8241
8467
|
};
|
|
8242
8468
|
};
|
|
8469
|
+
/**
|
|
8470
|
+
* BETA Gets the status of a Hype Train for the specified broadcaster.
|
|
8471
|
+
* @description BETA Get the status of a Hype Train for the specified broadcaster.
|
|
8472
|
+
*
|
|
8473
|
+
* __Authorization:__
|
|
8474
|
+
*
|
|
8475
|
+
* * Requires an [user access token](https://dev.twitch.tv/docs/authentication/#user-access-tokens).
|
|
8476
|
+
* * Requires OAuth Scope: `channel:read:hype_train`.
|
|
8477
|
+
* * Requires that `broadcaster_id` and `user_id` match in the User-Access token.
|
|
8478
|
+
*/
|
|
8479
|
+
"get-hype-train-status": {
|
|
8480
|
+
parameters: {
|
|
8481
|
+
query: {
|
|
8482
|
+
/** @description The User ID of the channel broadcaster. */
|
|
8483
|
+
broadcaster_id: string;
|
|
8484
|
+
};
|
|
8485
|
+
};
|
|
8486
|
+
responses: {
|
|
8487
|
+
/** @description Successfully retrieved the status object. */
|
|
8488
|
+
200: {
|
|
8489
|
+
content: {
|
|
8490
|
+
"application/json": components["schemas"]["GetHypeTrainStatusResponse"];
|
|
8491
|
+
};
|
|
8492
|
+
};
|
|
8493
|
+
/** @description The ID in the `broadcaster_id` query parameter is not valid. */
|
|
8494
|
+
400: {
|
|
8495
|
+
content: never;
|
|
8496
|
+
};
|
|
8497
|
+
/**
|
|
8498
|
+
* @description * The OAuth token is not valid.
|
|
8499
|
+
* * The Authorization header is required and must contain a user access token.
|
|
8500
|
+
*/
|
|
8501
|
+
401: {
|
|
8502
|
+
content: never;
|
|
8503
|
+
};
|
|
8504
|
+
/** @description Internal Server Error. */
|
|
8505
|
+
500: {
|
|
8506
|
+
content: never;
|
|
8507
|
+
};
|
|
8508
|
+
};
|
|
8509
|
+
};
|
|
8243
8510
|
/**
|
|
8244
8511
|
* Checks whether AutoMod would flag the specified message for review.
|
|
8245
8512
|
* @description Checks whether AutoMod would flag the specified message for review.
|
|
@@ -8759,7 +9026,7 @@ interface operations {
|
|
|
8759
9026
|
*
|
|
8760
9027
|
* __Authorization:__
|
|
8761
9028
|
*
|
|
8762
|
-
* * Requires a user access token that includes the **moderator:manage:unban
|
|
9029
|
+
* * Requires a user access token that includes the **moderator:manage:unban\_requests** scope.
|
|
8763
9030
|
* * Query parameter `moderator_id` must match the `user_id` in the[user access token](https://dev.twitch.tv/docs/authentication/#user-access-tokens).
|
|
8764
9031
|
*/
|
|
8765
9032
|
"resolve-unban-requests": {
|
|
@@ -10562,6 +10829,10 @@ interface operations {
|
|
|
10562
10829
|
401: {
|
|
10563
10830
|
content: never;
|
|
10564
10831
|
};
|
|
10832
|
+
/** @description The user must complete additional steps in order to stream. Present the user with the returned error message. */
|
|
10833
|
+
403: {
|
|
10834
|
+
content: never;
|
|
10835
|
+
};
|
|
10565
10836
|
};
|
|
10566
10837
|
};
|
|
10567
10838
|
/**
|
|
@@ -11145,6 +11416,10 @@ interface operations {
|
|
|
11145
11416
|
401: {
|
|
11146
11417
|
content: never;
|
|
11147
11418
|
};
|
|
11419
|
+
/** @description The app exceeded the number of requests that it may make. */
|
|
11420
|
+
429: {
|
|
11421
|
+
content: never;
|
|
11422
|
+
};
|
|
11148
11423
|
};
|
|
11149
11424
|
};
|
|
11150
11425
|
/**
|
|
@@ -11720,6 +11995,7 @@ type GetEmoteSetsParams = ParamsSchema<'get-emote-sets'>;
|
|
|
11720
11995
|
type GetChannelChatBadgesParams = ParamsSchema<'get-channel-chat-badges'>;
|
|
11721
11996
|
type GetChatSettingsParams = ParamsSchema<'get-chat-settings'>;
|
|
11722
11997
|
type UpdateChatSettingsParams = ParamsSchema<'update-chat-settings'>;
|
|
11998
|
+
type GetSharedChatSessionParams = ParamsSchema<'get-shared-chat-session'>;
|
|
11723
11999
|
type GetUserEmotesParams = ParamsSchema<'get-user-emotes'>;
|
|
11724
12000
|
type SendChatAnnouncementParams = ParamsSchema<'send-chat-announcement'>;
|
|
11725
12001
|
type SendShoutoutParams = ParamsSchema<'send-a-shoutout'>;
|
|
@@ -11757,6 +12033,7 @@ type UpdateGuestStarSlotParams = ParamsSchema<'update-guest-star-slot'>;
|
|
|
11757
12033
|
type DeleteGuestStarSlotParams = ParamsSchema<'delete-guest-star-slot'>;
|
|
11758
12034
|
type UpdateGuestStarSlotSettingsParams = ParamsSchema<'update-guest-star-slot-settings'>;
|
|
11759
12035
|
type GetHypeTrainEventsParams = ParamsSchema<'get-hype-train-events'>;
|
|
12036
|
+
type GetHypeTrainStatusParams = ParamsSchema<'get-hype-train-status'>;
|
|
11760
12037
|
type CheckAutoModStatusParams = ParamsSchema<'check-automod-status'>;
|
|
11761
12038
|
type GetAutoModSettingsParams = ParamsSchema<'get-automod-settings'>;
|
|
11762
12039
|
type UpdateAutoModSettingsParams = ParamsSchema<'update-automod-settings'>;
|
|
@@ -11861,6 +12138,7 @@ type GetChannelChatBadgesResponse = Schema<'GetChannelChatBadgesResponse'>;
|
|
|
11861
12138
|
type GetGlobalChatBadgesResponse = Schema<'GetGlobalChatBadgesResponse'>;
|
|
11862
12139
|
type ChatSettings = Schema<'ChatSettings'>;
|
|
11863
12140
|
type GetChatSettingsResponse = Schema<'GetChatSettingsResponse'>;
|
|
12141
|
+
type GetSharedChatSessionResponse = Schema<'GetSharedChatSessionResponse'>;
|
|
11864
12142
|
type GetUserEmotesResponse = Schema<'GetUserEmotesResponse'>;
|
|
11865
12143
|
type UpdateChatSettingsBody = Schema<'UpdateChatSettingsBody'>;
|
|
11866
12144
|
type ChatSettingsUpdated = Schema<'ChatSettingsUpdated'>;
|
|
@@ -11927,6 +12205,7 @@ type GuestStarInvite = Schema<'GuestStarInvite'>;
|
|
|
11927
12205
|
type GetGuestStarInvitesResponse = Schema<'GetGuestStarInvitesResponse'>;
|
|
11928
12206
|
type HypeTrainEvent = Schema<'HypeTrainEvent'>;
|
|
11929
12207
|
type GetHypeTrainEventsResponse = Schema<'GetHypeTrainEventsResponse'>;
|
|
12208
|
+
type GetHypeTrainStatusResponse = Schema<'GetHypeTrainStatusResponse'>;
|
|
11930
12209
|
type CheckAutoModStatusBody = Schema<'CheckAutoModStatusBody'>;
|
|
11931
12210
|
type AutoModStatus = Schema<'AutoModStatus'>;
|
|
11932
12211
|
type CheckAutoModStatusResponse = Schema<'CheckAutoModStatusResponse'>;
|
|
@@ -12099,7 +12378,7 @@ declare class TwitchApi {
|
|
|
12099
12378
|
*
|
|
12100
12379
|
* @see https://dev.twitch.tv/docs/api/reference#start-commercial
|
|
12101
12380
|
*/
|
|
12102
|
-
startCommercial: (body: StartCommercialBody, options?: CallApiOptions[
|
|
12381
|
+
startCommercial: (body: StartCommercialBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
12103
12382
|
data: {
|
|
12104
12383
|
length: number;
|
|
12105
12384
|
message: string;
|
|
@@ -12131,7 +12410,7 @@ declare class TwitchApi {
|
|
|
12131
12410
|
*
|
|
12132
12411
|
* @see https://dev.twitch.tv/docs/api/reference#get-ad-schedule
|
|
12133
12412
|
*/
|
|
12134
|
-
getAdSchedule: (params: GetAdScheduleParams, options?: CallApiOptions[
|
|
12413
|
+
getAdSchedule: (params: GetAdScheduleParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
12135
12414
|
data: {
|
|
12136
12415
|
snooze_count: number;
|
|
12137
12416
|
snooze_refresh_at: string;
|
|
@@ -12172,7 +12451,7 @@ declare class TwitchApi {
|
|
|
12172
12451
|
*
|
|
12173
12452
|
* @see https://dev.twitch.tv/docs/api/reference#snooze-next-ad
|
|
12174
12453
|
*/
|
|
12175
|
-
snoozeNextAd: (params: SnoozeNextAdParams, options?: CallApiOptions[
|
|
12454
|
+
snoozeNextAd: (params: SnoozeNextAdParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
12176
12455
|
data: {
|
|
12177
12456
|
snooze_count: number;
|
|
12178
12457
|
snooze_refresh_at: string;
|
|
@@ -12220,16 +12499,8 @@ declare class TwitchApi {
|
|
|
12220
12499
|
*
|
|
12221
12500
|
* @see https://dev.twitch.tv/docs/api/reference#get-extension-analytics
|
|
12222
12501
|
*/
|
|
12223
|
-
getExtensionAnalytics: (params?: GetExtensionAnalyticsParams | null | undefined, options?: CallApiOptions[
|
|
12224
|
-
data:
|
|
12225
|
-
extension_id: string;
|
|
12226
|
-
URL: string;
|
|
12227
|
-
type: string;
|
|
12228
|
-
date_range: {
|
|
12229
|
-
started_at: string;
|
|
12230
|
-
ended_at: string;
|
|
12231
|
-
};
|
|
12232
|
-
}[];
|
|
12502
|
+
getExtensionAnalytics: (params?: GetExtensionAnalyticsParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
12503
|
+
data: components["schemas"]["ExtensionAnalytics"][];
|
|
12233
12504
|
pagination?: {
|
|
12234
12505
|
cursor?: string;
|
|
12235
12506
|
};
|
|
@@ -12273,16 +12544,8 @@ declare class TwitchApi {
|
|
|
12273
12544
|
*
|
|
12274
12545
|
* @see https://dev.twitch.tv/docs/api/reference#get-game-analytics
|
|
12275
12546
|
*/
|
|
12276
|
-
getGameAnalytics: (params?: GetGameAnalyticsParams | null | undefined, options?: CallApiOptions[
|
|
12277
|
-
data:
|
|
12278
|
-
game_id: string;
|
|
12279
|
-
URL: string;
|
|
12280
|
-
type: string;
|
|
12281
|
-
date_range: {
|
|
12282
|
-
started_at: string;
|
|
12283
|
-
ended_at: string;
|
|
12284
|
-
};
|
|
12285
|
-
}[];
|
|
12547
|
+
getGameAnalytics: (params?: GetGameAnalyticsParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
12548
|
+
data: components["schemas"]["GameAnalytics"][];
|
|
12286
12549
|
pagination?: {
|
|
12287
12550
|
cursor?: string;
|
|
12288
12551
|
};
|
|
@@ -12323,14 +12586,8 @@ declare class TwitchApi {
|
|
|
12323
12586
|
*
|
|
12324
12587
|
* @see https://dev.twitch.tv/docs/api/reference#get-bits-leaderboard
|
|
12325
12588
|
*/
|
|
12326
|
-
getBitsLeaderboard: (params?: GetBitsLeaderboardParams | null | undefined, options?: CallApiOptions[
|
|
12327
|
-
data:
|
|
12328
|
-
user_id: string;
|
|
12329
|
-
user_login: string;
|
|
12330
|
-
user_name: string;
|
|
12331
|
-
rank: number;
|
|
12332
|
-
score: number;
|
|
12333
|
-
}[];
|
|
12589
|
+
getBitsLeaderboard: (params?: GetBitsLeaderboardParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
12590
|
+
data: components["schemas"]["BitsLeaderboard"][];
|
|
12334
12591
|
date_range: {
|
|
12335
12592
|
started_at: string;
|
|
12336
12593
|
ended_at: string;
|
|
@@ -12361,55 +12618,8 @@ declare class TwitchApi {
|
|
|
12361
12618
|
*
|
|
12362
12619
|
* @see https://dev.twitch.tv/docs/api/reference#get-cheermotes
|
|
12363
12620
|
*/
|
|
12364
|
-
getCheermotes: (params?: GetCheermotesParams | null | undefined, options?: CallApiOptions[
|
|
12365
|
-
data:
|
|
12366
|
-
prefix: string;
|
|
12367
|
-
tiers: {
|
|
12368
|
-
min_bits: number;
|
|
12369
|
-
id: "1" | "100" | "500" | "1000" | "5000" | "10000" | "100000";
|
|
12370
|
-
color: string;
|
|
12371
|
-
images: {
|
|
12372
|
-
light?: {
|
|
12373
|
-
animated?: {
|
|
12374
|
-
1?: string;
|
|
12375
|
-
2?: string;
|
|
12376
|
-
3?: string;
|
|
12377
|
-
4?: string;
|
|
12378
|
-
"1.5"?: string;
|
|
12379
|
-
};
|
|
12380
|
-
static?: {
|
|
12381
|
-
1?: string;
|
|
12382
|
-
2?: string;
|
|
12383
|
-
3?: string;
|
|
12384
|
-
4?: string;
|
|
12385
|
-
"1.5"?: string;
|
|
12386
|
-
};
|
|
12387
|
-
};
|
|
12388
|
-
dark?: {
|
|
12389
|
-
animated?: {
|
|
12390
|
-
1?: string;
|
|
12391
|
-
2?: string;
|
|
12392
|
-
3?: string;
|
|
12393
|
-
4?: string;
|
|
12394
|
-
"1.5"?: string;
|
|
12395
|
-
};
|
|
12396
|
-
static?: {
|
|
12397
|
-
1?: string;
|
|
12398
|
-
2?: string;
|
|
12399
|
-
3?: string;
|
|
12400
|
-
4?: string;
|
|
12401
|
-
"1.5"?: string;
|
|
12402
|
-
};
|
|
12403
|
-
};
|
|
12404
|
-
};
|
|
12405
|
-
can_cheer: boolean;
|
|
12406
|
-
show_in_bits_card: boolean;
|
|
12407
|
-
}[];
|
|
12408
|
-
type: "global_first_party" | "global_third_party" | "channel_custom" | "display_only" | "sponsored";
|
|
12409
|
-
order: number;
|
|
12410
|
-
last_updated: string;
|
|
12411
|
-
is_charitable: boolean;
|
|
12412
|
-
}[];
|
|
12621
|
+
getCheermotes: (params?: GetCheermotesParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
12622
|
+
data: components["schemas"]["Cheermote"][];
|
|
12413
12623
|
}, 200, 401>;
|
|
12414
12624
|
/**
|
|
12415
12625
|
* Gets an extension’s list of transactions. A transaction records the exchange of a currency (for example, Bits) for a digital product.
|
|
@@ -12447,60 +12657,8 @@ declare class TwitchApi {
|
|
|
12447
12657
|
*
|
|
12448
12658
|
* @see https://dev.twitch.tv/docs/api/reference#get-extension-transactions
|
|
12449
12659
|
*/
|
|
12450
|
-
getExtensionTransactions: (params: GetExtensionTransactionsParams, options?: CallApiOptions[
|
|
12451
|
-
data:
|
|
12452
|
-
id: string;
|
|
12453
|
-
timestamp: string;
|
|
12454
|
-
broadcaster_id: string;
|
|
12455
|
-
broadcaster_login: string;
|
|
12456
|
-
broadcaster_name: string;
|
|
12457
|
-
user_id: string;
|
|
12458
|
-
user_login: string;
|
|
12459
|
-
user_name: string;
|
|
12460
|
-
product_type: "BITS_IN_EXTENSION";
|
|
12461
|
-
product_data: {
|
|
12462
|
-
sku: string;
|
|
12463
|
-
domain: string;
|
|
12464
|
-
cost: {
|
|
12465
|
-
amount: number;
|
|
12466
|
-
type: "bits";
|
|
12467
|
-
};
|
|
12468
|
-
inDevelopment: boolean;
|
|
12469
|
-
displayName: string; /**
|
|
12470
|
-
* Updates a configuration segment. The segment is limited to 5 KB. Extensions that are active on a channel do not receive the updated configuration.
|
|
12471
|
-
*
|
|
12472
|
-
* **Rate Limits**: You may update the configuration a maximum of 20 times per minute.
|
|
12473
|
-
*
|
|
12474
|
-
* __Authorization:__
|
|
12475
|
-
*
|
|
12476
|
-
* Requires a signed JSON Web Token (JWT) created by an Extension Backend Service (EBS). For signing requirements, see [Signing the JWT](https://dev.twitch.tv/docs/extensions/building/#signing-the-jwt). The signed JWT must include the `role`, `user_id`, and `exp` fields (see [JWT Schema](https://dev.twitch.tv/docs/extensions/reference/#jwt-schema)). The `role` field must be set to _external_.
|
|
12477
|
-
*
|
|
12478
|
-
* __URL:__
|
|
12479
|
-
*
|
|
12480
|
-
* `PUT https://api.twitch.tv/helix/extensions/configurations`
|
|
12481
|
-
*
|
|
12482
|
-
* __Response Codes:__
|
|
12483
|
-
*
|
|
12484
|
-
* _204 No Content_
|
|
12485
|
-
*
|
|
12486
|
-
* Successfully updated the configuration.
|
|
12487
|
-
*
|
|
12488
|
-
* _400 Bad Request_
|
|
12489
|
-
*
|
|
12490
|
-
* * The `broadcaster_id` field is required if `segment` is set to developer or broadcaster.
|
|
12491
|
-
*
|
|
12492
|
-
* _401 Unauthorized_
|
|
12493
|
-
*
|
|
12494
|
-
* * The Authorization header is required and must specify a JWT token.
|
|
12495
|
-
* * The JWT token is not valid.
|
|
12496
|
-
* * The Client-Id header is required.
|
|
12497
|
-
*
|
|
12498
|
-
* @see https://dev.twitch.tv/docs/api/reference#set-extension-configuration-segment
|
|
12499
|
-
*/
|
|
12500
|
-
expiration: string;
|
|
12501
|
-
broadcast: boolean;
|
|
12502
|
-
};
|
|
12503
|
-
}[];
|
|
12660
|
+
getExtensionTransactions: (params: GetExtensionTransactionsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
12661
|
+
data: components["schemas"]["ExtensionTransaction"][];
|
|
12504
12662
|
pagination?: {
|
|
12505
12663
|
cursor?: string;
|
|
12506
12664
|
};
|
|
@@ -12544,20 +12702,8 @@ declare class TwitchApi {
|
|
|
12544
12702
|
*
|
|
12545
12703
|
* @see https://dev.twitch.tv/docs/api/reference#get-channel-information
|
|
12546
12704
|
*/
|
|
12547
|
-
getChannelInformation: (params: GetChannelInformationParams, options?: CallApiOptions[
|
|
12548
|
-
data:
|
|
12549
|
-
broadcaster_id: string;
|
|
12550
|
-
broadcaster_login: string;
|
|
12551
|
-
broadcaster_name: string;
|
|
12552
|
-
broadcaster_language: string;
|
|
12553
|
-
game_name: string;
|
|
12554
|
-
game_id: string;
|
|
12555
|
-
title: string;
|
|
12556
|
-
delay: number;
|
|
12557
|
-
tags: string[];
|
|
12558
|
-
content_classification_labels: string[];
|
|
12559
|
-
is_branded_content: boolean;
|
|
12560
|
-
}[];
|
|
12705
|
+
getChannelInformation: (params: GetChannelInformationParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
12706
|
+
data: components["schemas"]["ChannelInformation"][];
|
|
12561
12707
|
}, 200, 400 | 401 | 429 | 500>;
|
|
12562
12708
|
/**
|
|
12563
12709
|
* Updates a channel’s properties.
|
|
@@ -12616,7 +12762,7 @@ declare class TwitchApi {
|
|
|
12616
12762
|
*
|
|
12617
12763
|
* @see https://dev.twitch.tv/docs/api/reference#modify-channel-information
|
|
12618
12764
|
*/
|
|
12619
|
-
modifyChannelInformation: (params: ModifyChannelInformationParams, body?: ModifyChannelInformationBody | null | undefined, options?: CallApiOptions[
|
|
12765
|
+
modifyChannelInformation: (params: ModifyChannelInformationParams, body?: ModifyChannelInformationBody | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 403 | 409 | 500>;
|
|
12620
12766
|
/**
|
|
12621
12767
|
* Gets the broadcaster’s list editors.
|
|
12622
12768
|
*
|
|
@@ -12648,12 +12794,8 @@ declare class TwitchApi {
|
|
|
12648
12794
|
*
|
|
12649
12795
|
* @see https://dev.twitch.tv/docs/api/reference#get-channel-editors
|
|
12650
12796
|
*/
|
|
12651
|
-
getChannelEditors: (params: GetChannelEditorsParams, options?: CallApiOptions[
|
|
12652
|
-
data:
|
|
12653
|
-
user_id: string;
|
|
12654
|
-
user_name: string;
|
|
12655
|
-
created_at: string;
|
|
12656
|
-
}[];
|
|
12797
|
+
getChannelEditors: (params: GetChannelEditorsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
12798
|
+
data: components["schemas"]["ChannelEditor"][];
|
|
12657
12799
|
}, 200, 400 | 401>;
|
|
12658
12800
|
/**
|
|
12659
12801
|
* Gets a list of broadcasters that the specified user follows. You can also use this endpoint to see whether a user follows a specific broadcaster.
|
|
@@ -12692,7 +12834,7 @@ declare class TwitchApi {
|
|
|
12692
12834
|
*
|
|
12693
12835
|
* @see https://dev.twitch.tv/docs/api/reference#get-followed-channels
|
|
12694
12836
|
*/
|
|
12695
|
-
getFollowedChannels: (params: GetFollowedChannelsParams, options?: CallApiOptions[
|
|
12837
|
+
getFollowedChannels: (params: GetFollowedChannelsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
12696
12838
|
data: {
|
|
12697
12839
|
broadcaster_id: string;
|
|
12698
12840
|
broadcaster_login: string;
|
|
@@ -12744,7 +12886,7 @@ declare class TwitchApi {
|
|
|
12744
12886
|
*
|
|
12745
12887
|
* @see https://dev.twitch.tv/docs/api/reference#get-channel-followers
|
|
12746
12888
|
*/
|
|
12747
|
-
getChannelFollowers: (params: GetChannelFollowersParams, options?: CallApiOptions[
|
|
12889
|
+
getChannelFollowers: (params: GetChannelFollowersParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
12748
12890
|
data: {
|
|
12749
12891
|
followed_at: string;
|
|
12750
12892
|
user_id: string;
|
|
@@ -12804,46 +12946,8 @@ declare class TwitchApi {
|
|
|
12804
12946
|
*
|
|
12805
12947
|
* @see https://dev.twitch.tv/docs/api/reference#create-custom-rewards
|
|
12806
12948
|
*/
|
|
12807
|
-
createCustomRewards: (params: CreateCustomRewardsParams, body: CreateCustomRewardsBody, options?: CallApiOptions[
|
|
12808
|
-
data:
|
|
12809
|
-
broadcaster_id: string;
|
|
12810
|
-
broadcaster_login: string;
|
|
12811
|
-
broadcaster_name: string;
|
|
12812
|
-
id: string;
|
|
12813
|
-
title: string;
|
|
12814
|
-
prompt: string;
|
|
12815
|
-
cost: number;
|
|
12816
|
-
image: {
|
|
12817
|
-
url_1x: string;
|
|
12818
|
-
url_2x: string;
|
|
12819
|
-
url_4x: string;
|
|
12820
|
-
};
|
|
12821
|
-
default_image: {
|
|
12822
|
-
url_1x: string;
|
|
12823
|
-
url_2x: string;
|
|
12824
|
-
url_4x: string;
|
|
12825
|
-
};
|
|
12826
|
-
background_color: string;
|
|
12827
|
-
is_enabled: boolean;
|
|
12828
|
-
is_user_input_required: boolean;
|
|
12829
|
-
max_per_stream_setting: {
|
|
12830
|
-
is_enabled: boolean;
|
|
12831
|
-
max_per_stream: number;
|
|
12832
|
-
};
|
|
12833
|
-
max_per_user_per_stream_setting: {
|
|
12834
|
-
is_enabled: boolean;
|
|
12835
|
-
max_per_user_per_stream: number;
|
|
12836
|
-
};
|
|
12837
|
-
global_cooldown_setting: {
|
|
12838
|
-
is_enabled: boolean;
|
|
12839
|
-
global_cooldown_seconds: number;
|
|
12840
|
-
};
|
|
12841
|
-
is_paused: boolean;
|
|
12842
|
-
is_in_stock: boolean;
|
|
12843
|
-
should_redemptions_skip_request_queue: boolean;
|
|
12844
|
-
redemptions_redeemed_current_stream: number | null;
|
|
12845
|
-
cooldown_expires_at: string | null;
|
|
12846
|
-
}[];
|
|
12949
|
+
createCustomRewards: (params: CreateCustomRewardsParams, body: CreateCustomRewardsBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
12950
|
+
data: components["schemas"]["CustomReward"][];
|
|
12847
12951
|
}, 200, 400 | 401 | 403 | 500>;
|
|
12848
12952
|
/**
|
|
12849
12953
|
* Deletes a custom reward that the broadcaster created.
|
|
@@ -12889,7 +12993,7 @@ declare class TwitchApi {
|
|
|
12889
12993
|
*
|
|
12890
12994
|
* @see https://dev.twitch.tv/docs/api/reference#delete-custom-reward
|
|
12891
12995
|
*/
|
|
12892
|
-
deleteCustomReward: (params: DeleteCustomRewardParams, options?: CallApiOptions[
|
|
12996
|
+
deleteCustomReward: (params: DeleteCustomRewardParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 403 | 404 | 500>;
|
|
12893
12997
|
/**
|
|
12894
12998
|
* Gets a list of custom rewards that the specified broadcaster created.
|
|
12895
12999
|
*
|
|
@@ -12933,46 +13037,8 @@ declare class TwitchApi {
|
|
|
12933
13037
|
*
|
|
12934
13038
|
* @see https://dev.twitch.tv/docs/api/reference#get-custom-reward
|
|
12935
13039
|
*/
|
|
12936
|
-
getCustomReward: (params: GetCustomRewardParams, options?: CallApiOptions[
|
|
12937
|
-
data:
|
|
12938
|
-
broadcaster_id: string;
|
|
12939
|
-
broadcaster_login: string;
|
|
12940
|
-
broadcaster_name: string;
|
|
12941
|
-
id: string;
|
|
12942
|
-
title: string;
|
|
12943
|
-
prompt: string;
|
|
12944
|
-
cost: number;
|
|
12945
|
-
image: {
|
|
12946
|
-
url_1x: string;
|
|
12947
|
-
url_2x: string;
|
|
12948
|
-
url_4x: string;
|
|
12949
|
-
};
|
|
12950
|
-
default_image: {
|
|
12951
|
-
url_1x: string;
|
|
12952
|
-
url_2x: string;
|
|
12953
|
-
url_4x: string;
|
|
12954
|
-
};
|
|
12955
|
-
background_color: string;
|
|
12956
|
-
is_enabled: boolean;
|
|
12957
|
-
is_user_input_required: boolean;
|
|
12958
|
-
max_per_stream_setting: {
|
|
12959
|
-
is_enabled: boolean;
|
|
12960
|
-
max_per_stream: number;
|
|
12961
|
-
};
|
|
12962
|
-
max_per_user_per_stream_setting: {
|
|
12963
|
-
is_enabled: boolean;
|
|
12964
|
-
max_per_user_per_stream: number;
|
|
12965
|
-
};
|
|
12966
|
-
global_cooldown_setting: {
|
|
12967
|
-
is_enabled: boolean;
|
|
12968
|
-
global_cooldown_seconds: number;
|
|
12969
|
-
};
|
|
12970
|
-
is_paused: boolean;
|
|
12971
|
-
is_in_stock: boolean;
|
|
12972
|
-
should_redemptions_skip_request_queue: boolean;
|
|
12973
|
-
redemptions_redeemed_current_stream: number | null;
|
|
12974
|
-
cooldown_expires_at: string | null;
|
|
12975
|
-
}[];
|
|
13040
|
+
getCustomReward: (params: GetCustomRewardParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
13041
|
+
data: components["schemas"]["CustomReward"][];
|
|
12976
13042
|
}, 200, 400 | 401 | 403 | 404 | 500>;
|
|
12977
13043
|
/**
|
|
12978
13044
|
* Updates a custom reward. The app used to create the reward is the only app that may update the reward.
|
|
@@ -13028,46 +13094,8 @@ declare class TwitchApi {
|
|
|
13028
13094
|
*
|
|
13029
13095
|
* @see https://dev.twitch.tv/docs/api/reference#update-custom-reward
|
|
13030
13096
|
*/
|
|
13031
|
-
updateCustomReward: (params: UpdateCustomRewardParams, body?: UpdateCustomRewardBody | null | undefined, options?: CallApiOptions[
|
|
13032
|
-
data:
|
|
13033
|
-
broadcaster_id: string;
|
|
13034
|
-
broadcaster_login: string;
|
|
13035
|
-
broadcaster_name: string;
|
|
13036
|
-
id: string;
|
|
13037
|
-
title: string;
|
|
13038
|
-
prompt: string;
|
|
13039
|
-
cost: number;
|
|
13040
|
-
image: {
|
|
13041
|
-
url_1x: string;
|
|
13042
|
-
url_2x: string;
|
|
13043
|
-
url_4x: string;
|
|
13044
|
-
};
|
|
13045
|
-
default_image: {
|
|
13046
|
-
url_1x: string;
|
|
13047
|
-
url_2x: string;
|
|
13048
|
-
url_4x: string;
|
|
13049
|
-
};
|
|
13050
|
-
background_color: string;
|
|
13051
|
-
is_enabled: boolean;
|
|
13052
|
-
is_user_input_required: boolean;
|
|
13053
|
-
max_per_stream_setting: {
|
|
13054
|
-
is_enabled: boolean;
|
|
13055
|
-
max_per_stream: number;
|
|
13056
|
-
};
|
|
13057
|
-
max_per_user_per_stream_setting: {
|
|
13058
|
-
is_enabled: boolean;
|
|
13059
|
-
max_per_user_per_stream: number;
|
|
13060
|
-
};
|
|
13061
|
-
global_cooldown_setting: {
|
|
13062
|
-
is_enabled: boolean;
|
|
13063
|
-
global_cooldown_seconds: number;
|
|
13064
|
-
};
|
|
13065
|
-
is_paused: boolean;
|
|
13066
|
-
is_in_stock: boolean;
|
|
13067
|
-
should_redemptions_skip_request_queue: boolean;
|
|
13068
|
-
redemptions_redeemed_current_stream: number | null;
|
|
13069
|
-
cooldown_expires_at: string | null;
|
|
13070
|
-
}[];
|
|
13097
|
+
updateCustomReward: (params: UpdateCustomRewardParams, body?: UpdateCustomRewardBody | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
13098
|
+
data: components["schemas"]["CustomReward"][];
|
|
13071
13099
|
}, 200, 400 | 401 | 403 | 404 | 500>;
|
|
13072
13100
|
/**
|
|
13073
13101
|
* Gets a list of redemptions for the specified custom reward. The app used to create the reward is the only app that may get the redemptions.
|
|
@@ -13114,25 +13142,11 @@ declare class TwitchApi {
|
|
|
13114
13142
|
*
|
|
13115
13143
|
* @see https://dev.twitch.tv/docs/api/reference#get-custom-reward-redemption
|
|
13116
13144
|
*/
|
|
13117
|
-
getCustomRewardRedemption: (params: GetCustomRewardRedemptionParams, options?: CallApiOptions[
|
|
13118
|
-
data:
|
|
13119
|
-
|
|
13120
|
-
|
|
13121
|
-
|
|
13122
|
-
id: string;
|
|
13123
|
-
user_id: string;
|
|
13124
|
-
user_name: string;
|
|
13125
|
-
user_login: string;
|
|
13126
|
-
reward: {
|
|
13127
|
-
id: string;
|
|
13128
|
-
title: string;
|
|
13129
|
-
prompt: string;
|
|
13130
|
-
cost: number;
|
|
13131
|
-
};
|
|
13132
|
-
user_input: string;
|
|
13133
|
-
status: "CANCELED" | "FULFILLED" | "UNFULFILLED";
|
|
13134
|
-
redeemed_at: string;
|
|
13135
|
-
}[];
|
|
13145
|
+
getCustomRewardRedemption: (params: GetCustomRewardRedemptionParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
13146
|
+
data: components["schemas"]["CustomRewardRedemption"][];
|
|
13147
|
+
pagination?: {
|
|
13148
|
+
cursor?: string;
|
|
13149
|
+
};
|
|
13136
13150
|
}, 200, 400 | 401 | 403 | 404 | 500>;
|
|
13137
13151
|
/**
|
|
13138
13152
|
* Updates a redemption’s status. You may update a redemption only if its status is UNFULFILLED. The app used to create the reward is the only app that may update the redemption.
|
|
@@ -13179,25 +13193,8 @@ declare class TwitchApi {
|
|
|
13179
13193
|
*
|
|
13180
13194
|
* @see https://dev.twitch.tv/docs/api/reference#update-redemption-status
|
|
13181
13195
|
*/
|
|
13182
|
-
updateRedemptionStatus: (params: UpdateRedemptionStatusParams, body: UpdateRedemptionStatusBody, options?: CallApiOptions[
|
|
13183
|
-
data:
|
|
13184
|
-
broadcaster_id: string;
|
|
13185
|
-
broadcaster_login: string;
|
|
13186
|
-
broadcaster_name: string;
|
|
13187
|
-
id: string;
|
|
13188
|
-
user_id: string;
|
|
13189
|
-
user_name: string;
|
|
13190
|
-
user_login: string;
|
|
13191
|
-
reward: {
|
|
13192
|
-
id: string;
|
|
13193
|
-
title: string;
|
|
13194
|
-
prompt: string;
|
|
13195
|
-
cost: number;
|
|
13196
|
-
};
|
|
13197
|
-
user_input: string;
|
|
13198
|
-
status: "CANCELED" | "FULFILLED" | "UNFULFILLED";
|
|
13199
|
-
redeemed_at: string;
|
|
13200
|
-
}[];
|
|
13196
|
+
updateRedemptionStatus: (params: UpdateRedemptionStatusParams, body: UpdateRedemptionStatusBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
13197
|
+
data: components["schemas"]["CustomRewardRedemption"][];
|
|
13201
13198
|
}, 200, 400 | 401 | 403 | 404 | 500>;
|
|
13202
13199
|
};
|
|
13203
13200
|
charity: {
|
|
@@ -13239,27 +13236,8 @@ declare class TwitchApi {
|
|
|
13239
13236
|
*
|
|
13240
13237
|
* @see https://dev.twitch.tv/docs/api/reference#get-charity-campaign
|
|
13241
13238
|
*/
|
|
13242
|
-
getCharityCampaign: (params: GetCharityCampaignParams, options?: CallApiOptions[
|
|
13243
|
-
data:
|
|
13244
|
-
id: string;
|
|
13245
|
-
broadcaster_id: string;
|
|
13246
|
-
broadcaster_login: string;
|
|
13247
|
-
broadcaster_name: string;
|
|
13248
|
-
charity_name: string;
|
|
13249
|
-
charity_description: string;
|
|
13250
|
-
charity_logo: string;
|
|
13251
|
-
charity_website: string;
|
|
13252
|
-
current_amount: {
|
|
13253
|
-
value: number;
|
|
13254
|
-
decimal_places: number;
|
|
13255
|
-
currency: string;
|
|
13256
|
-
};
|
|
13257
|
-
target_amount: {
|
|
13258
|
-
value: number;
|
|
13259
|
-
decimal_places: number;
|
|
13260
|
-
currency: string;
|
|
13261
|
-
};
|
|
13262
|
-
}[];
|
|
13239
|
+
getCharityCampaign: (params: GetCharityCampaignParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
13240
|
+
data: components["schemas"]["CharityCampaign"][];
|
|
13263
13241
|
}, 200, 400 | 401 | 403>;
|
|
13264
13242
|
/**
|
|
13265
13243
|
* Gets the list of donations that users have made to the broadcaster’s active charity campaign.
|
|
@@ -13299,19 +13277,8 @@ declare class TwitchApi {
|
|
|
13299
13277
|
*
|
|
13300
13278
|
* @see https://dev.twitch.tv/docs/api/reference#get-charity-campaign-donations
|
|
13301
13279
|
*/
|
|
13302
|
-
getCharityCampaignDonations: (params: GetCharityCampaignDonationsParams, options?: CallApiOptions[
|
|
13303
|
-
data:
|
|
13304
|
-
id: string;
|
|
13305
|
-
campaign_id: string;
|
|
13306
|
-
user_id: string;
|
|
13307
|
-
user_login: string;
|
|
13308
|
-
user_name: string;
|
|
13309
|
-
amount: {
|
|
13310
|
-
value: number;
|
|
13311
|
-
decimal_places: number;
|
|
13312
|
-
currency: string;
|
|
13313
|
-
};
|
|
13314
|
-
}[];
|
|
13280
|
+
getCharityCampaignDonations: (params: GetCharityCampaignDonationsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
13281
|
+
data: components["schemas"]["CharityCampaignDonation"][];
|
|
13315
13282
|
pagination?: {
|
|
13316
13283
|
cursor?: string;
|
|
13317
13284
|
};
|
|
@@ -13360,12 +13327,8 @@ declare class TwitchApi {
|
|
|
13360
13327
|
*
|
|
13361
13328
|
* @see https://dev.twitch.tv/docs/api/reference#get-chatters
|
|
13362
13329
|
*/
|
|
13363
|
-
getChatters: (params: GetChattersParams, options?: CallApiOptions[
|
|
13364
|
-
data:
|
|
13365
|
-
user_id: string;
|
|
13366
|
-
user_login: string;
|
|
13367
|
-
user_name: string;
|
|
13368
|
-
}[];
|
|
13330
|
+
getChatters: (params: GetChattersParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
13331
|
+
data: components["schemas"]["Chatter"][];
|
|
13369
13332
|
pagination?: {
|
|
13370
13333
|
cursor?: string;
|
|
13371
13334
|
};
|
|
@@ -13404,22 +13367,8 @@ declare class TwitchApi {
|
|
|
13404
13367
|
*
|
|
13405
13368
|
* @see https://dev.twitch.tv/docs/api/reference#get-channel-emotes
|
|
13406
13369
|
*/
|
|
13407
|
-
getChannelEmotes: (params: GetChannelEmotesParams, options?: CallApiOptions[
|
|
13408
|
-
data:
|
|
13409
|
-
id: string;
|
|
13410
|
-
name: string;
|
|
13411
|
-
images: {
|
|
13412
|
-
url_1x: string;
|
|
13413
|
-
url_2x: string;
|
|
13414
|
-
url_4x: string;
|
|
13415
|
-
};
|
|
13416
|
-
tier: string;
|
|
13417
|
-
emote_type: "bitstier" | "follower" | "subscriptions";
|
|
13418
|
-
emote_set_id: string;
|
|
13419
|
-
format: ("animated" | "static")[];
|
|
13420
|
-
scale: ("1.0" | "2.0" | "3.0")[];
|
|
13421
|
-
theme_mode: ("dark" | "light")[];
|
|
13422
|
-
}[];
|
|
13370
|
+
getChannelEmotes: (params: GetChannelEmotesParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
13371
|
+
data: components["schemas"]["ChannelEmote"][];
|
|
13423
13372
|
template: string;
|
|
13424
13373
|
}, 200, 400 | 401>;
|
|
13425
13374
|
/**
|
|
@@ -13453,19 +13402,8 @@ declare class TwitchApi {
|
|
|
13453
13402
|
*
|
|
13454
13403
|
* @see https://dev.twitch.tv/docs/api/reference#get-global-emotes
|
|
13455
13404
|
*/
|
|
13456
|
-
getGlobalEmotes: (options?: CallApiOptions[
|
|
13457
|
-
data:
|
|
13458
|
-
id: string;
|
|
13459
|
-
name: string;
|
|
13460
|
-
images: {
|
|
13461
|
-
url_1x: string;
|
|
13462
|
-
url_2x: string;
|
|
13463
|
-
url_4x: string;
|
|
13464
|
-
};
|
|
13465
|
-
format: ("animated" | "static")[];
|
|
13466
|
-
scale: ("1.0" | "2.0" | "3.0")[];
|
|
13467
|
-
theme_mode: ("dark" | "light")[];
|
|
13468
|
-
}[];
|
|
13405
|
+
getGlobalEmotes: (options?: CallApiOptions["options"]) => ApiResponse<{
|
|
13406
|
+
data: components["schemas"]["GlobalEmote"][];
|
|
13469
13407
|
template: string;
|
|
13470
13408
|
}, 200, 401>;
|
|
13471
13409
|
/**
|
|
@@ -13502,22 +13440,8 @@ declare class TwitchApi {
|
|
|
13502
13440
|
*
|
|
13503
13441
|
* @see https://dev.twitch.tv/docs/api/reference#get-emote-sets
|
|
13504
13442
|
*/
|
|
13505
|
-
getEmoteSets: (params: GetEmoteSetsParams, options?: CallApiOptions[
|
|
13506
|
-
data:
|
|
13507
|
-
id: string;
|
|
13508
|
-
name: string;
|
|
13509
|
-
images: {
|
|
13510
|
-
url_1x: string;
|
|
13511
|
-
url_2x: string;
|
|
13512
|
-
url_4x: string;
|
|
13513
|
-
};
|
|
13514
|
-
emote_type: "bitstier" | "follower" | "subscriptions";
|
|
13515
|
-
emote_set_id: string;
|
|
13516
|
-
owner_id: string;
|
|
13517
|
-
format: ("animated" | "static")[];
|
|
13518
|
-
scale: ("1.0" | "2.0" | "3.0")[];
|
|
13519
|
-
theme_mode: ("dark" | "light")[];
|
|
13520
|
-
}[];
|
|
13443
|
+
getEmoteSets: (params: GetEmoteSetsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
13444
|
+
data: components["schemas"]["Emote"][];
|
|
13521
13445
|
template: string;
|
|
13522
13446
|
}, 200, 400 | 401>;
|
|
13523
13447
|
/**
|
|
@@ -13549,20 +13473,8 @@ declare class TwitchApi {
|
|
|
13549
13473
|
*
|
|
13550
13474
|
* @see https://dev.twitch.tv/docs/api/reference#get-channel-chat-badges
|
|
13551
13475
|
*/
|
|
13552
|
-
getChannelChatBadges: (params: GetChannelChatBadgesParams, options?: CallApiOptions[
|
|
13553
|
-
data:
|
|
13554
|
-
set_id: string;
|
|
13555
|
-
versions: {
|
|
13556
|
-
id: string;
|
|
13557
|
-
image_url_1x: string;
|
|
13558
|
-
image_url_2x: string;
|
|
13559
|
-
image_url_4x: string;
|
|
13560
|
-
title: string;
|
|
13561
|
-
description: string;
|
|
13562
|
-
click_action: string;
|
|
13563
|
-
click_url: string;
|
|
13564
|
-
}[];
|
|
13565
|
-
}[];
|
|
13476
|
+
getChannelChatBadges: (params: GetChannelChatBadgesParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
13477
|
+
data: components["schemas"]["ChatBadge"][];
|
|
13566
13478
|
}, 200, 400 | 401>;
|
|
13567
13479
|
/**
|
|
13568
13480
|
* Gets Twitch’s list of chat badges, which users may use in any channel’s chat room. For information about chat badges, see [Twitch Chat Badges Guide](https://help.twitch.tv/s/article/twitch-chat-badges-guide).
|
|
@@ -13593,20 +13505,8 @@ declare class TwitchApi {
|
|
|
13593
13505
|
*
|
|
13594
13506
|
* @see https://dev.twitch.tv/docs/api/reference#get-global-chat-badges
|
|
13595
13507
|
*/
|
|
13596
|
-
getGlobalChatBadges: (options?: CallApiOptions[
|
|
13597
|
-
data:
|
|
13598
|
-
set_id: string;
|
|
13599
|
-
versions: {
|
|
13600
|
-
id: string;
|
|
13601
|
-
image_url_1x: string;
|
|
13602
|
-
image_url_2x: string;
|
|
13603
|
-
image_url_4x: string;
|
|
13604
|
-
title: string;
|
|
13605
|
-
description: string;
|
|
13606
|
-
click_action: string;
|
|
13607
|
-
click_url: string;
|
|
13608
|
-
}[];
|
|
13609
|
-
}[];
|
|
13508
|
+
getGlobalChatBadges: (options?: CallApiOptions["options"]) => ApiResponse<{
|
|
13509
|
+
data: components["schemas"]["ChatBadge"][];
|
|
13610
13510
|
}, 200, 401>;
|
|
13611
13511
|
/**
|
|
13612
13512
|
* Gets the broadcaster’s chat settings.
|
|
@@ -13639,20 +13539,8 @@ declare class TwitchApi {
|
|
|
13639
13539
|
*
|
|
13640
13540
|
* @see https://dev.twitch.tv/docs/api/reference#get-chat-settings
|
|
13641
13541
|
*/
|
|
13642
|
-
getChatSettings: (params: GetChatSettingsParams, options?: CallApiOptions[
|
|
13643
|
-
data:
|
|
13644
|
-
broadcaster_id: string;
|
|
13645
|
-
emote_mode: boolean;
|
|
13646
|
-
follower_mode: boolean;
|
|
13647
|
-
follower_mode_duration: number | null;
|
|
13648
|
-
moderator_id?: string;
|
|
13649
|
-
non_moderator_chat_delay?: boolean;
|
|
13650
|
-
non_moderator_chat_delay_duration?: number | null;
|
|
13651
|
-
slow_mode: boolean;
|
|
13652
|
-
slow_mode_wait_time: number | null;
|
|
13653
|
-
subscriber_mode: boolean;
|
|
13654
|
-
unique_chat_mode: boolean;
|
|
13655
|
-
}[];
|
|
13542
|
+
getChatSettings: (params: GetChatSettingsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
13543
|
+
data: components["schemas"]["ChatSettings"][];
|
|
13656
13544
|
}, 200, 400 | 401>;
|
|
13657
13545
|
/**
|
|
13658
13546
|
* Updates the broadcaster’s chat settings.
|
|
@@ -13703,21 +13591,52 @@ declare class TwitchApi {
|
|
|
13703
13591
|
*
|
|
13704
13592
|
* @see https://dev.twitch.tv/docs/api/reference#update-chat-settings
|
|
13705
13593
|
*/
|
|
13706
|
-
updateChatSettings: (params: UpdateChatSettingsParams, body?: UpdateChatSettingsBody | null | undefined, options?: CallApiOptions[
|
|
13594
|
+
updateChatSettings: (params: UpdateChatSettingsParams, body?: UpdateChatSettingsBody | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
13595
|
+
data: components["schemas"]["ChatSettingsUpdated"][];
|
|
13596
|
+
}, 200, 400 | 401 | 403>;
|
|
13597
|
+
/**
|
|
13598
|
+
* NEW Retrieves the active shared chat session for a channel.
|
|
13599
|
+
*
|
|
13600
|
+
* __Authorization:__
|
|
13601
|
+
*
|
|
13602
|
+
* Requires an [app access token](https://dev.twitch.tv/docs/cli/token-command/#app-access-token) or [user access token](https://dev.twitch.tv/docs/authentication/#user-access-tokens).
|
|
13603
|
+
*
|
|
13604
|
+
* __URL:__
|
|
13605
|
+
*
|
|
13606
|
+
* `GET https://api.twitch.tv/helix/shared_chat/session`
|
|
13607
|
+
*
|
|
13608
|
+
* __Response Codes:__
|
|
13609
|
+
*
|
|
13610
|
+
* _200 OK_
|
|
13611
|
+
*
|
|
13612
|
+
* Successfully retrieved the shared chat session. Returns an empty array if the broadcaster\_id in the request isn’t in a shared chat session.
|
|
13613
|
+
*
|
|
13614
|
+
* _400 Bad Request_
|
|
13615
|
+
*
|
|
13616
|
+
* The ID in the `broadcaster_id` query parameter is not valid.
|
|
13617
|
+
*
|
|
13618
|
+
* _401 Unauthorized_
|
|
13619
|
+
*
|
|
13620
|
+
* * The OAuth token is not valid.
|
|
13621
|
+
* * The Authorization header is required and must contain a user access token.
|
|
13622
|
+
*
|
|
13623
|
+
* _500 Internal Server Error_
|
|
13624
|
+
*
|
|
13625
|
+
* Internal Server Error.
|
|
13626
|
+
*
|
|
13627
|
+
* @see https://dev.twitch.tv/docs/api/reference#get-shared-chat-session
|
|
13628
|
+
*/
|
|
13629
|
+
getSharedChatSession: (params: GetSharedChatSessionParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
13707
13630
|
data: {
|
|
13708
|
-
|
|
13709
|
-
|
|
13710
|
-
|
|
13711
|
-
|
|
13712
|
-
|
|
13713
|
-
|
|
13714
|
-
|
|
13715
|
-
slow_mode: boolean;
|
|
13716
|
-
slow_mode_wait_time: number | null;
|
|
13717
|
-
subscriber_mode: boolean;
|
|
13718
|
-
unique_chat_mode: boolean;
|
|
13631
|
+
session_id: string;
|
|
13632
|
+
host_broadcaster_id: string;
|
|
13633
|
+
participants: {
|
|
13634
|
+
broadcaster_id: string;
|
|
13635
|
+
}[];
|
|
13636
|
+
created_at: string;
|
|
13637
|
+
updated_at: string;
|
|
13719
13638
|
}[];
|
|
13720
|
-
}, 200, 400 | 401 |
|
|
13639
|
+
}, 200, 400 | 401 | 500>;
|
|
13721
13640
|
/**
|
|
13722
13641
|
* NEW Retrieves emotes available to the user across all channels.
|
|
13723
13642
|
*
|
|
@@ -13751,17 +13670,17 @@ declare class TwitchApi {
|
|
|
13751
13670
|
*
|
|
13752
13671
|
* @see https://dev.twitch.tv/docs/api/reference#get-user-emotes
|
|
13753
13672
|
*/
|
|
13754
|
-
getUserEmotes: (params: GetUserEmotesParams, options?: CallApiOptions[
|
|
13755
|
-
data: {
|
|
13673
|
+
getUserEmotes: (params: GetUserEmotesParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
13674
|
+
data: ({
|
|
13756
13675
|
id: string;
|
|
13757
13676
|
name: string;
|
|
13758
|
-
emote_type: "
|
|
13677
|
+
emote_type: "none" | "bitstier" | "follower" | "subscriptions" | "channelpoints" | "rewards" | "hypetrain" | "prime" | "turbo" | "smilies" | "globals" | "owl2019" | "twofactor" | "limitedtime";
|
|
13759
13678
|
emote_set_id: string;
|
|
13760
13679
|
owner_id: string;
|
|
13761
13680
|
format: string[];
|
|
13762
13681
|
scale: string[];
|
|
13763
13682
|
theme_mode: string[];
|
|
13764
|
-
}[];
|
|
13683
|
+
})[];
|
|
13765
13684
|
template: string;
|
|
13766
13685
|
pagination?: {
|
|
13767
13686
|
cursor?: string;
|
|
@@ -13770,6 +13689,8 @@ declare class TwitchApi {
|
|
|
13770
13689
|
/**
|
|
13771
13690
|
* Sends an announcement to the broadcaster’s chat room.
|
|
13772
13691
|
*
|
|
13692
|
+
* **Rate Limits**: One announcement may be sent every 2 seconds.
|
|
13693
|
+
*
|
|
13773
13694
|
* __Authorization:__
|
|
13774
13695
|
*
|
|
13775
13696
|
* Requires a [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens) that includes the **moderator:manage:announcements** scope.
|
|
@@ -13798,15 +13719,19 @@ declare class TwitchApi {
|
|
|
13798
13719
|
* * The OAuth token is not valid.
|
|
13799
13720
|
* * The client ID specified in the Client-Id header does not match the client ID specified in the OAuth token.
|
|
13800
13721
|
*
|
|
13722
|
+
* _429 Too Many Requests_
|
|
13723
|
+
*
|
|
13724
|
+
* The sender has exceeded the number of announcements they may send to this **broadcaster\_id** within a given window.
|
|
13725
|
+
*
|
|
13801
13726
|
* @see https://dev.twitch.tv/docs/api/reference#send-chat-announcement
|
|
13802
13727
|
*/
|
|
13803
|
-
sendChatAnnouncement: (params: SendChatAnnouncementParams, body: SendChatAnnouncementBody, options?: CallApiOptions[
|
|
13728
|
+
sendChatAnnouncement: (params: SendChatAnnouncementParams, body: SendChatAnnouncementBody, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 429>;
|
|
13804
13729
|
/**
|
|
13805
13730
|
* Sends a Shoutout to the specified broadcaster. Typically, you send Shoutouts when you or one of your moderators notice another broadcaster in your chat, the other broadcaster is coming up in conversation, or after they raid your broadcast.
|
|
13806
13731
|
*
|
|
13807
13732
|
* Twitch’s Shoutout feature is a great way for you to show support for other broadcasters and help them grow. Viewers who do not follow the other broadcaster will see a pop-up Follow button in your chat that they can click to follow the other broadcaster. [Learn More](https://help.twitch.tv/s/article/shoutouts)
|
|
13808
13733
|
*
|
|
13809
|
-
* **Rate Limits
|
|
13734
|
+
* **Rate Limits**: The broadcaster may send a Shoutout once every 2 minutes. They may send the same broadcaster a Shoutout once every 60 minutes.
|
|
13810
13735
|
*
|
|
13811
13736
|
* To receive notifications when a Shoutout is sent or received, subscribe to the [channel.shoutout.create](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelshoutoutcreate) and [channel.shoutout.receive](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelshoutoutreceive) subscription types. The **channel.shoutout.create** event includes cooldown periods that indicate when the broadcaster may send another Shoutout without exceeding the endpoint’s rate limit.
|
|
13812
13737
|
*
|
|
@@ -13853,10 +13778,15 @@ declare class TwitchApi {
|
|
|
13853
13778
|
*
|
|
13854
13779
|
* @see https://dev.twitch.tv/docs/api/reference#send-a-shoutout
|
|
13855
13780
|
*/
|
|
13856
|
-
sendShoutout: (params: SendShoutoutParams, options?: CallApiOptions[
|
|
13781
|
+
sendShoutout: (params: SendShoutoutParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 403 | 429>;
|
|
13857
13782
|
/**
|
|
13858
13783
|
* NEW Sends a message to the broadcaster’s chat room.
|
|
13859
13784
|
*
|
|
13785
|
+
* **NOTE:** When sending messages to a Shared Chat session, behaviors differ depending on your authentication token type:
|
|
13786
|
+
*
|
|
13787
|
+
* * When using an _App Access Token_, messages will only be sent to the source channel (defined by the `broadcaster_id` parameter) by default starting on May 19, 2025\. Messages can be sent to all channels by using the `for_source_only` parameter and setting it to `false`.
|
|
13788
|
+
* * When using a _User Access Token_, messages will be sent to all channels in the shared chat session, including the source channel. This behavior cannot be changed with this token type.
|
|
13789
|
+
*
|
|
13860
13790
|
* __Authorization:__
|
|
13861
13791
|
*
|
|
13862
13792
|
* Requires an [app access token](https://dev.twitch.tv/docs/authentication#app-access-tokens) or [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens) that includes the `user:write:chat` scope. If app access token used, then additionally requires `user:bot` scope from chatting user, and either `channel:bot` scope from broadcaster or moderator status.
|
|
@@ -13879,6 +13809,7 @@ declare class TwitchApi {
|
|
|
13879
13809
|
* * The ID in the _sender\_id_ query parameter is not valid.
|
|
13880
13810
|
* * The _text_ query parameter is required.
|
|
13881
13811
|
* * The ID in the _reply\_parent\_message\_id_ query parameter is not valid.
|
|
13812
|
+
* * Cannot set \*for\_source\_only\* if User Access Token is used.
|
|
13882
13813
|
*
|
|
13883
13814
|
* _401 Unauthorized_
|
|
13884
13815
|
*
|
|
@@ -13898,7 +13829,7 @@ declare class TwitchApi {
|
|
|
13898
13829
|
*
|
|
13899
13830
|
* @see https://dev.twitch.tv/docs/api/reference#send-chat-message
|
|
13900
13831
|
*/
|
|
13901
|
-
sendChatMessage: (body: SendChatMessageBody, options?: CallApiOptions[
|
|
13832
|
+
sendChatMessage: (body: SendChatMessageBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
13902
13833
|
data: {
|
|
13903
13834
|
message_id: string;
|
|
13904
13835
|
is_sent: boolean;
|
|
@@ -13937,13 +13868,8 @@ declare class TwitchApi {
|
|
|
13937
13868
|
*
|
|
13938
13869
|
* @see https://dev.twitch.tv/docs/api/reference#get-user-chat-color
|
|
13939
13870
|
*/
|
|
13940
|
-
getUserChatColor: (params: GetUserChatColorParams, options?: CallApiOptions[
|
|
13941
|
-
data:
|
|
13942
|
-
user_id: string;
|
|
13943
|
-
user_login: string;
|
|
13944
|
-
user_name: string;
|
|
13945
|
-
color: string;
|
|
13946
|
-
}[];
|
|
13871
|
+
getUserChatColor: (params: GetUserChatColorParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
13872
|
+
data: components["schemas"]["UserChatColor"][];
|
|
13947
13873
|
}, 200, 400 | 401>;
|
|
13948
13874
|
/**
|
|
13949
13875
|
* Updates the color used for the user’s name in chat.
|
|
@@ -13979,7 +13905,7 @@ declare class TwitchApi {
|
|
|
13979
13905
|
*
|
|
13980
13906
|
* @see https://dev.twitch.tv/docs/api/reference#update-user-chat-color
|
|
13981
13907
|
*/
|
|
13982
|
-
updateUserChatColor: (params: UpdateUserChatColorParams, options?: CallApiOptions[
|
|
13908
|
+
updateUserChatColor: (params: UpdateUserChatColorParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401>;
|
|
13983
13909
|
};
|
|
13984
13910
|
clips: {
|
|
13985
13911
|
/**
|
|
@@ -14028,7 +13954,7 @@ declare class TwitchApi {
|
|
|
14028
13954
|
*
|
|
14029
13955
|
* @see https://dev.twitch.tv/docs/api/reference#create-clip
|
|
14030
13956
|
*/
|
|
14031
|
-
createClip: (params: CreateClipParams, options?: CallApiOptions[
|
|
13957
|
+
createClip: (params: CreateClipParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14032
13958
|
data: {
|
|
14033
13959
|
edit_url: string;
|
|
14034
13960
|
id: string;
|
|
@@ -14037,6 +13963,8 @@ declare class TwitchApi {
|
|
|
14037
13963
|
/**
|
|
14038
13964
|
* Gets one or more video clips that were captured from streams. For information about clips, see [How to use clips](https://help.twitch.tv/s/article/how-to-use-clips).
|
|
14039
13965
|
*
|
|
13966
|
+
* When using pagination for clips, note that the maximum number of results returned over multiple requests will be approximately 1,000\. If additional results are necessary, paginate over different query parameters such as multiple `started_at` and `ended_at` timeframes to refine the search.
|
|
13967
|
+
*
|
|
14040
13968
|
* __Authorization:__
|
|
14041
13969
|
*
|
|
14042
13970
|
* Requires an [app access token](https://dev.twitch.tv/docs/authentication#app-access-tokens) or [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens).
|
|
@@ -14072,26 +14000,8 @@ declare class TwitchApi {
|
|
|
14072
14000
|
*
|
|
14073
14001
|
* @see https://dev.twitch.tv/docs/api/reference#get-clips
|
|
14074
14002
|
*/
|
|
14075
|
-
getClips: (params?: GetClipsParams | null | undefined, options?: CallApiOptions[
|
|
14076
|
-
data:
|
|
14077
|
-
id: string;
|
|
14078
|
-
url: string;
|
|
14079
|
-
embed_url: string;
|
|
14080
|
-
broadcaster_id: string;
|
|
14081
|
-
broadcaster_name: string;
|
|
14082
|
-
creator_id: string;
|
|
14083
|
-
creator_name: string;
|
|
14084
|
-
video_id: string;
|
|
14085
|
-
game_id: string;
|
|
14086
|
-
language: string;
|
|
14087
|
-
title: string;
|
|
14088
|
-
view_count: number;
|
|
14089
|
-
created_at: string;
|
|
14090
|
-
thumbnail_url: string;
|
|
14091
|
-
duration: number;
|
|
14092
|
-
vod_offset: number | null;
|
|
14093
|
-
is_featured: boolean;
|
|
14094
|
-
}[];
|
|
14003
|
+
getClips: (params?: GetClipsParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14004
|
+
data: components["schemas"]["Clip"][];
|
|
14095
14005
|
pagination?: {
|
|
14096
14006
|
cursor?: string;
|
|
14097
14007
|
};
|
|
@@ -14099,7 +14009,7 @@ declare class TwitchApi {
|
|
|
14099
14009
|
};
|
|
14100
14010
|
conduits: {
|
|
14101
14011
|
/**
|
|
14102
|
-
* NEW Gets the [conduits](https://dev.twitch.tv/docs/eventsub/handling-conduit-events) for a client ID.
|
|
14012
|
+
* NEW Gets the [conduits](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/) for a client ID.
|
|
14103
14013
|
*
|
|
14104
14014
|
* __Authorization:__
|
|
14105
14015
|
*
|
|
@@ -14121,14 +14031,14 @@ declare class TwitchApi {
|
|
|
14121
14031
|
*
|
|
14122
14032
|
* @see https://dev.twitch.tv/docs/api/reference#get-conduits
|
|
14123
14033
|
*/
|
|
14124
|
-
getConduits: (options?: CallApiOptions[
|
|
14034
|
+
getConduits: (options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14125
14035
|
data: {
|
|
14126
14036
|
id: string;
|
|
14127
14037
|
shard_count: number;
|
|
14128
14038
|
}[];
|
|
14129
14039
|
}, 200, 401>;
|
|
14130
14040
|
/**
|
|
14131
|
-
* NEW Creates a new [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events).
|
|
14041
|
+
* NEW Creates a new [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/).
|
|
14132
14042
|
*
|
|
14133
14043
|
* __Authorization:__
|
|
14134
14044
|
*
|
|
@@ -14158,14 +14068,14 @@ declare class TwitchApi {
|
|
|
14158
14068
|
*
|
|
14159
14069
|
* @see https://dev.twitch.tv/docs/api/reference#create-conduits
|
|
14160
14070
|
*/
|
|
14161
|
-
createConduits: (body: CreateConduitsBody, options?: CallApiOptions[
|
|
14071
|
+
createConduits: (body: CreateConduitsBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14162
14072
|
data: {
|
|
14163
14073
|
id: string;
|
|
14164
14074
|
shard_count: number;
|
|
14165
14075
|
}[];
|
|
14166
14076
|
}, 200, 400 | 401 | 429>;
|
|
14167
14077
|
/**
|
|
14168
|
-
* NEW Updates a [conduit’s](https://dev.twitch.tv/docs/eventsub/handling-conduit-events) shard count. To delete shards, update the count to a lower number, and the shards above the count will be deleted. For example, if the existing shard count is 100, by resetting shard count to 50, shards 50-99 are disabled.
|
|
14078
|
+
* NEW Updates a [conduit’s](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/) shard count. To delete shards, update the count to a lower number, and the shards above the count will be deleted. For example, if the existing shard count is 100, by resetting shard count to 50, shards 50-99 are disabled.
|
|
14169
14079
|
*
|
|
14170
14080
|
* __Authorization:__
|
|
14171
14081
|
*
|
|
@@ -14197,14 +14107,14 @@ declare class TwitchApi {
|
|
|
14197
14107
|
*
|
|
14198
14108
|
* @see https://dev.twitch.tv/docs/api/reference#update-conduits
|
|
14199
14109
|
*/
|
|
14200
|
-
updateConduits: (body: UpdateConduitsBody, options?: CallApiOptions[
|
|
14110
|
+
updateConduits: (body: UpdateConduitsBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14201
14111
|
data: {
|
|
14202
14112
|
id: string;
|
|
14203
14113
|
shard_count: number;
|
|
14204
14114
|
}[];
|
|
14205
14115
|
}, 200, 400 | 401 | 404>;
|
|
14206
14116
|
/**
|
|
14207
|
-
* NEW Deletes a specified [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/). Note that it may take some time for Eventsub subscriptions on a deleted [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events) to show as disabled when calling [Get Eventsub Subscriptions](https://dev.twitch.tv/docs/api/reference/#get-eventsub-subscriptions).
|
|
14117
|
+
* NEW Deletes a specified [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/). Note that it may take some time for Eventsub subscriptions on a deleted [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/) to show as disabled when calling [Get Eventsub Subscriptions](https://dev.twitch.tv/docs/api/reference/#get-eventsub-subscriptions).
|
|
14208
14118
|
*
|
|
14209
14119
|
* __Authorization:__
|
|
14210
14120
|
*
|
|
@@ -14235,9 +14145,9 @@ declare class TwitchApi {
|
|
|
14235
14145
|
*
|
|
14236
14146
|
* @see https://dev.twitch.tv/docs/api/reference#delete-conduit
|
|
14237
14147
|
*/
|
|
14238
|
-
deleteConduit: (params: DeleteConduitParams, options?: CallApiOptions[
|
|
14148
|
+
deleteConduit: (params: DeleteConduitParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 404>;
|
|
14239
14149
|
/**
|
|
14240
|
-
* NEW Gets a lists of all shards for a [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events).
|
|
14150
|
+
* NEW Gets a lists of all shards for a [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/).
|
|
14241
14151
|
*
|
|
14242
14152
|
* __Authorization:__
|
|
14243
14153
|
*
|
|
@@ -14268,8 +14178,8 @@ declare class TwitchApi {
|
|
|
14268
14178
|
*
|
|
14269
14179
|
* @see https://dev.twitch.tv/docs/api/reference#get-conduit-shards
|
|
14270
14180
|
*/
|
|
14271
|
-
getConduitShards: (params: GetConduitShardsParams, options?: CallApiOptions[
|
|
14272
|
-
data: {
|
|
14181
|
+
getConduitShards: (params: GetConduitShardsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14182
|
+
data: ({
|
|
14273
14183
|
id: string;
|
|
14274
14184
|
status: "enabled" | "webhook_callback_verification_pending" | "webhook_callback_verification_failed" | "notification_failures_exceeded" | "websocket_disconnected" | "websocket_failed_ping_pong" | "websocket_received_inbound_traffic" | "websocket_internal_error" | "websocket_network_timeout" | "websocket_network_error" | "websocket_failed_to_reconnect";
|
|
14275
14185
|
transport: {
|
|
@@ -14279,13 +14189,13 @@ declare class TwitchApi {
|
|
|
14279
14189
|
connected_at?: string;
|
|
14280
14190
|
disconnected_at?: string;
|
|
14281
14191
|
};
|
|
14282
|
-
}[];
|
|
14192
|
+
})[];
|
|
14283
14193
|
pagination?: {
|
|
14284
14194
|
cursor?: string;
|
|
14285
14195
|
};
|
|
14286
14196
|
}, 200, 400 | 401 | 404>;
|
|
14287
14197
|
/**
|
|
14288
|
-
* NEW Updates shard(s) for a [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events).
|
|
14198
|
+
* NEW Updates shard(s) for a [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/).
|
|
14289
14199
|
*
|
|
14290
14200
|
* **NOTE:** Shard IDs are indexed starting at 0, so a conduit with a `shard_count` of 5 will have shards with IDs 0 through 4.
|
|
14291
14201
|
*
|
|
@@ -14318,8 +14228,8 @@ declare class TwitchApi {
|
|
|
14318
14228
|
*
|
|
14319
14229
|
* @see https://dev.twitch.tv/docs/api/reference#update-conduit-shards
|
|
14320
14230
|
*/
|
|
14321
|
-
updateConduitShards: (body: UpdateConduitShardsBody, options?: CallApiOptions[
|
|
14322
|
-
data: {
|
|
14231
|
+
updateConduitShards: (body: UpdateConduitShardsBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14232
|
+
data: ({
|
|
14323
14233
|
id: string;
|
|
14324
14234
|
status: "enabled" | "webhook_callback_verification_pending" | "webhook_callback_verification_failed" | "notification_failures_exceeded" | "websocket_disconnected" | "websocket_failed_ping_pong" | "websocket_received_inbound_traffic" | "websocket_internal_error" | "websocket_network_timeout" | "websocket_network_error" | "websocket_failed_to_reconnect";
|
|
14325
14235
|
transport: {
|
|
@@ -14329,7 +14239,7 @@ declare class TwitchApi {
|
|
|
14329
14239
|
connected_at?: string;
|
|
14330
14240
|
disconnected_at?: string;
|
|
14331
14241
|
};
|
|
14332
|
-
}[];
|
|
14242
|
+
})[];
|
|
14333
14243
|
errors: {
|
|
14334
14244
|
id: string;
|
|
14335
14245
|
message: string;
|
|
@@ -14363,12 +14273,8 @@ declare class TwitchApi {
|
|
|
14363
14273
|
*
|
|
14364
14274
|
* @see https://dev.twitch.tv/docs/api/reference#get-content-classification-labels
|
|
14365
14275
|
*/
|
|
14366
|
-
getContentClassificationLabels: (params?: GetContentClassificationLabelsParams | null | undefined, options?: CallApiOptions[
|
|
14367
|
-
data:
|
|
14368
|
-
id: string;
|
|
14369
|
-
description: string;
|
|
14370
|
-
name: string;
|
|
14371
|
-
}[];
|
|
14276
|
+
getContentClassificationLabels: (params?: GetContentClassificationLabelsParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14277
|
+
data: components["schemas"]["ContentClassificationLabel"][];
|
|
14372
14278
|
}, 200, 400 | 401 | 500>;
|
|
14373
14279
|
};
|
|
14374
14280
|
entitlements: {
|
|
@@ -14393,7 +14299,7 @@ declare class TwitchApi {
|
|
|
14393
14299
|
*
|
|
14394
14300
|
* __Authorization:__
|
|
14395
14301
|
*
|
|
14396
|
-
* Requires an [app access token](https://dev.twitch.tv/docs/authentication#app-access-tokens) or [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens). The
|
|
14302
|
+
* Requires an [app access token](https://dev.twitch.tv/docs/authentication#app-access-tokens) or [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens). The Client ID associated with the access token must be owned by a user who is a member of the [organization](https://dev.twitch.tv/docs/docs/companies/) that holds ownership of the game.
|
|
14397
14303
|
*
|
|
14398
14304
|
* __URL:__
|
|
14399
14305
|
*
|
|
@@ -14427,16 +14333,8 @@ declare class TwitchApi {
|
|
|
14427
14333
|
*
|
|
14428
14334
|
* @see https://dev.twitch.tv/docs/api/reference#get-drops-entitlements
|
|
14429
14335
|
*/
|
|
14430
|
-
getDropsEntitlements: (params?: GetDropsEntitlementsParams | null | undefined, options?: CallApiOptions[
|
|
14431
|
-
data:
|
|
14432
|
-
id: string;
|
|
14433
|
-
benefit_id: string;
|
|
14434
|
-
timestamp: string;
|
|
14435
|
-
user_id: string;
|
|
14436
|
-
game_id: string;
|
|
14437
|
-
fulfillment_status: "FULFILLED" | "CLAIMED";
|
|
14438
|
-
last_updated: string;
|
|
14439
|
-
}[];
|
|
14336
|
+
getDropsEntitlements: (params?: GetDropsEntitlementsParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14337
|
+
data: components["schemas"]["DropsEntitlement"][];
|
|
14440
14338
|
pagination?: {
|
|
14441
14339
|
cursor?: string;
|
|
14442
14340
|
};
|
|
@@ -14454,7 +14352,7 @@ declare class TwitchApi {
|
|
|
14454
14352
|
*
|
|
14455
14353
|
* __Authorization:__
|
|
14456
14354
|
*
|
|
14457
|
-
* Requires an [app access token](https://dev.twitch.tv/docs/authentication#app-access-tokens) or [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens). The
|
|
14355
|
+
* Requires an [app access token](https://dev.twitch.tv/docs/authentication#app-access-tokens) or [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens). The Client ID associated with the access token must be owned by a user who is a member of the [organization](https://dev.twitch.tv/docs/docs/companies/) that holds ownership of the game.
|
|
14458
14356
|
*
|
|
14459
14357
|
* __URL:__
|
|
14460
14358
|
*
|
|
@@ -14482,11 +14380,8 @@ declare class TwitchApi {
|
|
|
14482
14380
|
*
|
|
14483
14381
|
* @see https://dev.twitch.tv/docs/api/reference#update-drops-entitlements
|
|
14484
14382
|
*/
|
|
14485
|
-
updateDropsEntitlements: (body?: UpdateDropsEntitlementsBody | null | undefined, options?: CallApiOptions[
|
|
14486
|
-
data:
|
|
14487
|
-
status: "INVALID_ID" | "NOT_FOUND" | "SUCCESS" | "UNAUTHORIZED" | "UPDATE_FAILED";
|
|
14488
|
-
ids: string[];
|
|
14489
|
-
}[];
|
|
14383
|
+
updateDropsEntitlements: (body?: UpdateDropsEntitlementsBody | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14384
|
+
data: components["schemas"]["DropsEntitlementUpdated"][];
|
|
14490
14385
|
}, 200, 400 | 401 | 500>;
|
|
14491
14386
|
};
|
|
14492
14387
|
extensions: {
|
|
@@ -14527,13 +14422,8 @@ declare class TwitchApi {
|
|
|
14527
14422
|
*
|
|
14528
14423
|
* @see https://dev.twitch.tv/docs/api/reference#get-extension-configuration-segment
|
|
14529
14424
|
*/
|
|
14530
|
-
getExtensionConfigurationSegment: (params: GetExtensionConfigurationSegmentParams, options?: CallApiOptions[
|
|
14531
|
-
data:
|
|
14532
|
-
segment: "broadcaster" | "developer" | "global";
|
|
14533
|
-
broadcaster_id?: string;
|
|
14534
|
-
content: string;
|
|
14535
|
-
version: string;
|
|
14536
|
-
}[];
|
|
14425
|
+
getExtensionConfigurationSegment: (params: GetExtensionConfigurationSegmentParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14426
|
+
data: components["schemas"]["ExtensionConfigurationSegment"][];
|
|
14537
14427
|
}, 200, 400 | 401 | 429>;
|
|
14538
14428
|
/**
|
|
14539
14429
|
* Updates a configuration segment. The segment is limited to 5 KB. Extensions that are active on a channel do not receive the updated configuration.
|
|
@@ -14566,7 +14456,7 @@ declare class TwitchApi {
|
|
|
14566
14456
|
*
|
|
14567
14457
|
* @see https://dev.twitch.tv/docs/api/reference#set-extension-configuration-segment
|
|
14568
14458
|
*/
|
|
14569
|
-
setExtensionConfigurationSegment: (body: SetExtensionConfigurationSegmentBody, options?: CallApiOptions[
|
|
14459
|
+
setExtensionConfigurationSegment: (body: SetExtensionConfigurationSegmentBody, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401>;
|
|
14570
14460
|
/**
|
|
14571
14461
|
* Updates the extension’s required\_configuration string. Use this endpoint if your extension requires the broadcaster to configure the extension before activating it (to require configuration, you must select **Custom/My Own Service** in Extension [Capabilities](https://dev.twitch.tv/docs/extensions/life-cycle/#capabilities)). For more information, see [Required Configurations](https://dev.twitch.tv/docs/extensions/building#required-configurations) and [Setting Required Configuration](https://dev.twitch.tv/docs/extensions/building#setting-required-configuration-with-the-configuration-service-optional).
|
|
14572
14462
|
*
|
|
@@ -14599,7 +14489,7 @@ declare class TwitchApi {
|
|
|
14599
14489
|
*
|
|
14600
14490
|
* @see https://dev.twitch.tv/docs/api/reference#set-extension-required-configuration
|
|
14601
14491
|
*/
|
|
14602
|
-
setExtensionRequiredConfiguration: (params: SetExtensionRequiredConfigurationParams, body: SetExtensionRequiredConfigurationBody, options?: CallApiOptions[
|
|
14492
|
+
setExtensionRequiredConfiguration: (params: SetExtensionRequiredConfigurationParams, body: SetExtensionRequiredConfigurationBody, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401>;
|
|
14603
14493
|
/**
|
|
14604
14494
|
* Sends a message to one or more viewers. You can send messages to a specific channel or to all channels where your extension is active. This endpoint uses the same mechanism as the [send](https://dev.twitch.tv/docs/extensions/reference#send) JavaScript helper function used to send messages.
|
|
14605
14495
|
*
|
|
@@ -14669,7 +14559,7 @@ declare class TwitchApi {
|
|
|
14669
14559
|
*
|
|
14670
14560
|
* @see https://dev.twitch.tv/docs/api/reference#send-extension-pubsub-message
|
|
14671
14561
|
*/
|
|
14672
|
-
sendExtensionPubSubMessage: (body: SendExtensionPubSubMessageBody, options?: CallApiOptions[
|
|
14562
|
+
sendExtensionPubSubMessage: (body: SendExtensionPubSubMessageBody, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 422>;
|
|
14673
14563
|
/**
|
|
14674
14564
|
* Gets a list of broadcasters that are streaming live and have installed or activated the extension.
|
|
14675
14565
|
*
|
|
@@ -14706,14 +14596,8 @@ declare class TwitchApi {
|
|
|
14706
14596
|
*
|
|
14707
14597
|
* @see https://dev.twitch.tv/docs/api/reference#get-extension-live-channels
|
|
14708
14598
|
*/
|
|
14709
|
-
getExtensionLiveChannels: (params: GetExtensionLiveChannelsParams, options?: CallApiOptions[
|
|
14710
|
-
data:
|
|
14711
|
-
broadcaster_id: string;
|
|
14712
|
-
broadcaster_name: string;
|
|
14713
|
-
game_name: string;
|
|
14714
|
-
game_id: string;
|
|
14715
|
-
title: string;
|
|
14716
|
-
}[];
|
|
14599
|
+
getExtensionLiveChannels: (params: GetExtensionLiveChannelsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14600
|
+
data: components["schemas"]["ExtensionLiveChannel"][];
|
|
14717
14601
|
pagination?: string;
|
|
14718
14602
|
}, 200, 400 | 401 | 404>;
|
|
14719
14603
|
/**
|
|
@@ -14745,15 +14629,8 @@ declare class TwitchApi {
|
|
|
14745
14629
|
*
|
|
14746
14630
|
* @see https://dev.twitch.tv/docs/api/reference#get-extension-secrets
|
|
14747
14631
|
*/
|
|
14748
|
-
getExtensionSecrets: (options?: CallApiOptions[
|
|
14749
|
-
data:
|
|
14750
|
-
format_version: number;
|
|
14751
|
-
secrets: {
|
|
14752
|
-
content: string;
|
|
14753
|
-
active_at: string;
|
|
14754
|
-
expires_at: string;
|
|
14755
|
-
}[];
|
|
14756
|
-
}[];
|
|
14632
|
+
getExtensionSecrets: (options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14633
|
+
data: components["schemas"]["ExtensionSecret"][];
|
|
14757
14634
|
}, 200, 400 | 401>;
|
|
14758
14635
|
/**
|
|
14759
14636
|
* Creates a shared secret used to sign and verify JWT tokens. Creating a new secret removes the current secrets from service. Use this function only when you are ready to use the new secret it returns.
|
|
@@ -14785,15 +14662,8 @@ declare class TwitchApi {
|
|
|
14785
14662
|
*
|
|
14786
14663
|
* @see https://dev.twitch.tv/docs/api/reference#create-extension-secret
|
|
14787
14664
|
*/
|
|
14788
|
-
createExtensionSecret: (params: CreateExtensionSecretParams, options?: CallApiOptions[
|
|
14789
|
-
data:
|
|
14790
|
-
format_version: number;
|
|
14791
|
-
secrets: {
|
|
14792
|
-
content: string;
|
|
14793
|
-
active_at: string;
|
|
14794
|
-
expires_at: string;
|
|
14795
|
-
}[];
|
|
14796
|
-
}[];
|
|
14665
|
+
createExtensionSecret: (params: CreateExtensionSecretParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14666
|
+
data: components["schemas"]["ExtensionSecret"][];
|
|
14797
14667
|
}, 200, 400 | 401>;
|
|
14798
14668
|
/**
|
|
14799
14669
|
* Sends a message to the specified broadcaster’s chat room. The extension’s name is used as the username for the message in the chat room. To send a chat message, your extension must enable **Chat Capabilities** (under your extension’s **Capabilities** tab).
|
|
@@ -14831,7 +14701,7 @@ declare class TwitchApi {
|
|
|
14831
14701
|
*
|
|
14832
14702
|
* @see https://dev.twitch.tv/docs/api/reference#send-extension-chat-message
|
|
14833
14703
|
*/
|
|
14834
|
-
sendExtensionChatMessage: (params: SendExtensionChatMessageParams, body: SendExtensionChatMessageBody, options?: CallApiOptions[
|
|
14704
|
+
sendExtensionChatMessage: (params: SendExtensionChatMessageParams, body: SendExtensionChatMessageBody, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401>;
|
|
14835
14705
|
/**
|
|
14836
14706
|
* Gets information about an extension.
|
|
14837
14707
|
*
|
|
@@ -14866,62 +14736,8 @@ declare class TwitchApi {
|
|
|
14866
14736
|
*
|
|
14867
14737
|
* @see https://dev.twitch.tv/docs/api/reference#get-extensions
|
|
14868
14738
|
*/
|
|
14869
|
-
getExtensions: (params: GetExtensionsParams, options?: CallApiOptions[
|
|
14870
|
-
data:
|
|
14871
|
-
author_name: string;
|
|
14872
|
-
bits_enabled: boolean;
|
|
14873
|
-
can_install: boolean;
|
|
14874
|
-
configuration_location: "none" | "hosted" | "custom";
|
|
14875
|
-
description: string;
|
|
14876
|
-
eula_tos_url: string;
|
|
14877
|
-
has_chat_support: boolean;
|
|
14878
|
-
icon_url: string;
|
|
14879
|
-
icon_urls: {
|
|
14880
|
-
"100x100"?: string;
|
|
14881
|
-
"24x24"?: string;
|
|
14882
|
-
"300x200"?: string;
|
|
14883
|
-
};
|
|
14884
|
-
id: string;
|
|
14885
|
-
name: string;
|
|
14886
|
-
privacy_policy_url: string;
|
|
14887
|
-
request_identity_link: boolean;
|
|
14888
|
-
screenshot_urls: string[];
|
|
14889
|
-
state: "Approved" | "AssetsUploaded" | "Deleted" | "Deprecated" | "InReview" | "InTest" | "PendingAction" | "Rejected" | "Released";
|
|
14890
|
-
subscriptions_support_level: "none" | "optional";
|
|
14891
|
-
summary: string;
|
|
14892
|
-
support_email: string;
|
|
14893
|
-
version: string;
|
|
14894
|
-
viewer_summary: string;
|
|
14895
|
-
views: {
|
|
14896
|
-
mobile: {
|
|
14897
|
-
viewer_url: string;
|
|
14898
|
-
};
|
|
14899
|
-
panel: {
|
|
14900
|
-
viewer_url: string;
|
|
14901
|
-
height: number;
|
|
14902
|
-
can_link_external_content: boolean;
|
|
14903
|
-
};
|
|
14904
|
-
video_overlay: {
|
|
14905
|
-
viewer_url: string;
|
|
14906
|
-
can_link_external_content: boolean;
|
|
14907
|
-
};
|
|
14908
|
-
component: {
|
|
14909
|
-
viewer_url: string;
|
|
14910
|
-
aspect_ratio_x: number;
|
|
14911
|
-
aspect_ratio_y: number;
|
|
14912
|
-
autoscale: boolean;
|
|
14913
|
-
scale_pixels: number;
|
|
14914
|
-
target_height: number;
|
|
14915
|
-
can_link_external_content: boolean;
|
|
14916
|
-
};
|
|
14917
|
-
config: {
|
|
14918
|
-
viewer_url: string;
|
|
14919
|
-
can_link_external_content: boolean;
|
|
14920
|
-
};
|
|
14921
|
-
};
|
|
14922
|
-
allowlisted_config_urls: string[];
|
|
14923
|
-
allowlisted_panel_urls: string[];
|
|
14924
|
-
}[];
|
|
14739
|
+
getExtensions: (params: GetExtensionsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14740
|
+
data: components["schemas"]["Extension"][];
|
|
14925
14741
|
}, 200, 400 | 401 | 404>;
|
|
14926
14742
|
/**
|
|
14927
14743
|
* Gets information about a released extension. Returns the extension if its `state` is Released.
|
|
@@ -14956,62 +14772,8 @@ declare class TwitchApi {
|
|
|
14956
14772
|
*
|
|
14957
14773
|
* @see https://dev.twitch.tv/docs/api/reference#get-released-extensions
|
|
14958
14774
|
*/
|
|
14959
|
-
getReleasedExtensions: (params: GetReleasedExtensionsParams, options?: CallApiOptions[
|
|
14960
|
-
data:
|
|
14961
|
-
author_name: string;
|
|
14962
|
-
bits_enabled: boolean;
|
|
14963
|
-
can_install: boolean;
|
|
14964
|
-
configuration_location: "none" | "hosted" | "custom";
|
|
14965
|
-
description: string;
|
|
14966
|
-
eula_tos_url: string;
|
|
14967
|
-
has_chat_support: boolean;
|
|
14968
|
-
icon_url: string;
|
|
14969
|
-
icon_urls: {
|
|
14970
|
-
"100x100"?: string;
|
|
14971
|
-
"24x24"?: string;
|
|
14972
|
-
"300x200"?: string;
|
|
14973
|
-
};
|
|
14974
|
-
id: string;
|
|
14975
|
-
name: string;
|
|
14976
|
-
privacy_policy_url: string;
|
|
14977
|
-
request_identity_link: boolean;
|
|
14978
|
-
screenshot_urls: string[];
|
|
14979
|
-
state: "Approved" | "AssetsUploaded" | "Deleted" | "Deprecated" | "InReview" | "InTest" | "PendingAction" | "Rejected" | "Released";
|
|
14980
|
-
subscriptions_support_level: "none" | "optional";
|
|
14981
|
-
summary: string;
|
|
14982
|
-
support_email: string;
|
|
14983
|
-
version: string;
|
|
14984
|
-
viewer_summary: string;
|
|
14985
|
-
views: {
|
|
14986
|
-
mobile: {
|
|
14987
|
-
viewer_url: string;
|
|
14988
|
-
};
|
|
14989
|
-
panel: {
|
|
14990
|
-
viewer_url: string;
|
|
14991
|
-
height: number;
|
|
14992
|
-
can_link_external_content: boolean;
|
|
14993
|
-
};
|
|
14994
|
-
video_overlay: {
|
|
14995
|
-
viewer_url: string;
|
|
14996
|
-
can_link_external_content: boolean;
|
|
14997
|
-
};
|
|
14998
|
-
component: {
|
|
14999
|
-
viewer_url: string;
|
|
15000
|
-
aspect_ratio_x: number;
|
|
15001
|
-
aspect_ratio_y: number;
|
|
15002
|
-
autoscale: boolean;
|
|
15003
|
-
scale_pixels: number;
|
|
15004
|
-
target_height: number;
|
|
15005
|
-
can_link_external_content: boolean;
|
|
15006
|
-
};
|
|
15007
|
-
config: {
|
|
15008
|
-
viewer_url: string;
|
|
15009
|
-
can_link_external_content: boolean;
|
|
15010
|
-
};
|
|
15011
|
-
};
|
|
15012
|
-
allowlisted_config_urls: string[];
|
|
15013
|
-
allowlisted_panel_urls: string[];
|
|
15014
|
-
}[];
|
|
14775
|
+
getReleasedExtensions: (params: GetReleasedExtensionsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14776
|
+
data: components["schemas"]["Extension"][];
|
|
15015
14777
|
}, 200, 400 | 401 | 404>;
|
|
15016
14778
|
/**
|
|
15017
14779
|
* Gets the list of Bits products that belongs to the extension. The client ID in the app access token identifies the extension.
|
|
@@ -15042,18 +14804,8 @@ declare class TwitchApi {
|
|
|
15042
14804
|
*
|
|
15043
14805
|
* @see https://dev.twitch.tv/docs/api/reference#get-extension-bits-products
|
|
15044
14806
|
*/
|
|
15045
|
-
getExtensionBitsProducts: (params?: GetExtensionBitsProductsParams | null | undefined, options?: CallApiOptions[
|
|
15046
|
-
data:
|
|
15047
|
-
sku: string;
|
|
15048
|
-
cost: {
|
|
15049
|
-
amount: number;
|
|
15050
|
-
type: "bits";
|
|
15051
|
-
};
|
|
15052
|
-
in_development: boolean;
|
|
15053
|
-
display_name: string;
|
|
15054
|
-
expiration: string;
|
|
15055
|
-
is_broadcast: boolean;
|
|
15056
|
-
}[];
|
|
14807
|
+
getExtensionBitsProducts: (params?: GetExtensionBitsProductsParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14808
|
+
data: components["schemas"]["ExtensionBitsProduct"][];
|
|
15057
14809
|
}, 200, 400 | 401>;
|
|
15058
14810
|
/**
|
|
15059
14811
|
* Adds or updates a Bits product that the extension created. If the SKU doesn’t exist, the product is added. You may update all fields except the `sku` field.
|
|
@@ -15091,18 +14843,8 @@ declare class TwitchApi {
|
|
|
15091
14843
|
*
|
|
15092
14844
|
* @see https://dev.twitch.tv/docs/api/reference#update-extension-bits-product
|
|
15093
14845
|
*/
|
|
15094
|
-
updateExtensionBitsProduct: (body: UpdateExtensionBitsProductBody, options?: CallApiOptions[
|
|
15095
|
-
data:
|
|
15096
|
-
sku: string;
|
|
15097
|
-
cost: {
|
|
15098
|
-
amount: number;
|
|
15099
|
-
type: "bits";
|
|
15100
|
-
};
|
|
15101
|
-
in_development: boolean;
|
|
15102
|
-
display_name: string;
|
|
15103
|
-
expiration: string;
|
|
15104
|
-
is_broadcast: boolean;
|
|
15105
|
-
}[];
|
|
14846
|
+
updateExtensionBitsProduct: (body: UpdateExtensionBitsProductBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14847
|
+
data: components["schemas"]["ExtensionBitsProduct"][];
|
|
15106
14848
|
}, 200, 400 | 401>;
|
|
15107
14849
|
};
|
|
15108
14850
|
eventSub: {
|
|
@@ -15115,7 +14857,7 @@ declare class TwitchApi {
|
|
|
15115
14857
|
*
|
|
15116
14858
|
* If you use [WebSockets to receive events](https://dev.twitch.tv/docs/eventsub/handling-websocket-events), the request must specify a user access token. The request will fail if you use an app access token. If the subscription type requires user authorization, the token must include the required scope. However, if the subscription type doesn’t include user authorization, the token may include any scopes or no scopes.
|
|
15117
14859
|
*
|
|
15118
|
-
* If you use [Conduits](https://dev.twitch.tv/docs/eventsub/handling-conduit-events) to receive events, the request must specify an app access token. The request will fail if you use a user access token.
|
|
14860
|
+
* If you use [Conduits](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/) to receive events, the request must specify an app access token. The request will fail if you use a user access token.
|
|
15119
14861
|
*
|
|
15120
14862
|
* __URL:__
|
|
15121
14863
|
*
|
|
@@ -15162,23 +14904,8 @@ declare class TwitchApi {
|
|
|
15162
14904
|
*
|
|
15163
14905
|
* @see https://dev.twitch.tv/docs/api/reference#create-eventsub-subscription
|
|
15164
14906
|
*/
|
|
15165
|
-
createEventSubSubscription: (body: CreateEventSubSubscriptionBody, options?: CallApiOptions[
|
|
15166
|
-
data:
|
|
15167
|
-
id: string;
|
|
15168
|
-
status: "enabled" | "webhook_callback_verification_pending" | "webhook_callback_verification_failed" | "notification_failures_exceeded" | "websocket_disconnected" | "websocket_failed_ping_pong" | "websocket_received_inbound_traffic" | "websocket_internal_error" | "websocket_network_timeout" | "websocket_network_error" | "authorization_revoked" | "moderator_removed" | "user_removed" | "version_removed" | "beta_maintenance" | "websocket_connection_unused";
|
|
15169
|
-
type: "automod.message.hold" | "automod.message.update" | "automod.settings.update" | "automod.terms.update" | "channel.update" | "channel.follow" | "channel.ad_break.begin" | "channel.chat.clear" | "channel.chat.clear_user_messages" | "channel.chat.message" | "channel.chat.message_delete" | "channel.chat.notification" | "channel.chat_settings.update" | "channel.chat.user_message_hold" | "channel.chat.user_message_update" | "channel.subscribe" | "channel.subscription.end" | "channel.subscription.gift" | "channel.subscription.message" | "channel.cheer" | "channel.raid" | "channel.ban" | "channel.unban" | "channel.unban_request.create" | "channel.unban_request.resolve" | "channel.moderate" | "channel.moderator.add" | "channel.moderator.remove" | "channel.guest_star_session.begin" | "channel.guest_star_session.end" | "channel.guest_star_guest.update" | "channel.guest_star_settings.update" | "channel.channel_points_automatic_reward_redemption.add" | "channel.channel_points_custom_reward.add" | "channel.channel_points_custom_reward.update" | "channel.channel_points_custom_reward.remove" | "channel.channel_points_custom_reward_redemption.add" | "channel.channel_points_custom_reward_redemption.update" | "channel.poll.begin" | "channel.poll.progress" | "channel.poll.end" | "channel.prediction.begin" | "channel.prediction.progress" | "channel.prediction.lock" | "channel.prediction.end" | "channel.suspicious_user.message" | "channel.suspicious_user.update" | "channel.vip.add" | "channel.vip.remove" | "channel.warning.acknowledge" | "channel.warning.send" | "channel.charity_campaign.donate" | "channel.charity_campaign.start" | "channel.charity_campaign.progress" | "channel.charity_campaign.stop" | "conduit.shard.disabled" | "drop.entitlement.grant" | "extension.bits_transaction.create" | "channel.goal.begin" | "channel.goal.progress" | "channel.goal.end" | "channel.hype_train.begin" | "channel.hype_train.progress" | "channel.hype_train.end" | "channel.shield_mode.begin" | "channel.shield_mode.end" | "channel.shoutout.create" | "channel.shoutout.receive" | "stream.online" | "stream.offline" | "user.authorization.grant" | "user.authorization.revoke" | "user.update" | "user.whisper.message";
|
|
15170
|
-
version: string;
|
|
15171
|
-
condition: Record<string, never>;
|
|
15172
|
-
created_at: string;
|
|
15173
|
-
transport: {
|
|
15174
|
-
method: "webhook" | "websocket";
|
|
15175
|
-
callback?: string;
|
|
15176
|
-
session_id?: string;
|
|
15177
|
-
connected_at?: string;
|
|
15178
|
-
disconnected_at?: string;
|
|
15179
|
-
};
|
|
15180
|
-
cost: number;
|
|
15181
|
-
}[];
|
|
14907
|
+
createEventSubSubscription: (body: CreateEventSubSubscriptionBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14908
|
+
data: components["schemas"]["EventSubSubscription"][];
|
|
15182
14909
|
total: number;
|
|
15183
14910
|
total_cost: number;
|
|
15184
14911
|
max_total_cost: number;
|
|
@@ -15218,19 +14945,19 @@ declare class TwitchApi {
|
|
|
15218
14945
|
*
|
|
15219
14946
|
* @see https://dev.twitch.tv/docs/api/reference#delete-eventsub-subscription
|
|
15220
14947
|
*/
|
|
15221
|
-
deleteEventSubSubscription: (params: DeleteEventSubSubscriptionParams, options?: CallApiOptions[
|
|
14948
|
+
deleteEventSubSubscription: (params: DeleteEventSubSubscriptionParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 404>;
|
|
15222
14949
|
/**
|
|
15223
14950
|
* Gets a list of EventSub subscriptions that the client in the access token created.
|
|
15224
14951
|
*
|
|
15225
14952
|
* __Authorization:__
|
|
15226
14953
|
*
|
|
15227
|
-
* If you use [Webhooks](https://dev.twitch.tv/docs/eventsub/handling-webhook-events) or [Conduits](https://dev.twitch.tv/docs/eventsub/handling-conduit-events) to receive events, the request must specify an app access token. The request will fail if you use a user access token.
|
|
14954
|
+
* If you use [Webhooks](https://dev.twitch.tv/docs/eventsub/handling-webhook-events) or [Conduits](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/) to receive events, the request must specify an app access token. The request will fail if you use a user access token.
|
|
15228
14955
|
*
|
|
15229
14956
|
* If you use [WebSockets to receive events](https://dev.twitch.tv/docs/eventsub/handling-websocket-events), the request must specify a user access token. The request will fail if you use an app access token. The token may include any scopes.
|
|
15230
14957
|
*
|
|
15231
14958
|
* __Request Query Parameters:__
|
|
15232
14959
|
*
|
|
15233
|
-
* Use the _status_, _type_, and
|
|
14960
|
+
* Use the _status_, _type_, _user\_id_, and _subscription\_id_ query parameters to filter the list of subscriptions that are returned. The filters are mutually exclusive; the request fails if you specify more than one filter.
|
|
15234
14961
|
*
|
|
15235
14962
|
* __URL:__
|
|
15236
14963
|
*
|
|
@@ -15257,23 +14984,8 @@ declare class TwitchApi {
|
|
|
15257
14984
|
*
|
|
15258
14985
|
* @see https://dev.twitch.tv/docs/api/reference#get-eventsub-subscriptions
|
|
15259
14986
|
*/
|
|
15260
|
-
getEventSubSubscriptions: (params?: GetEventSubSubscriptionsParams | null | undefined, options?: CallApiOptions[
|
|
15261
|
-
data:
|
|
15262
|
-
id: string;
|
|
15263
|
-
status: "enabled" | "webhook_callback_verification_pending" | "webhook_callback_verification_failed" | "notification_failures_exceeded" | "websocket_disconnected" | "websocket_failed_ping_pong" | "websocket_received_inbound_traffic" | "websocket_internal_error" | "websocket_network_timeout" | "websocket_network_error" | "authorization_revoked" | "moderator_removed" | "user_removed" | "version_removed" | "beta_maintenance" | "websocket_connection_unused";
|
|
15264
|
-
type: "automod.message.hold" | "automod.message.update" | "automod.settings.update" | "automod.terms.update" | "channel.update" | "channel.follow" | "channel.ad_break.begin" | "channel.chat.clear" | "channel.chat.clear_user_messages" | "channel.chat.message" | "channel.chat.message_delete" | "channel.chat.notification" | "channel.chat_settings.update" | "channel.chat.user_message_hold" | "channel.chat.user_message_update" | "channel.subscribe" | "channel.subscription.end" | "channel.subscription.gift" | "channel.subscription.message" | "channel.cheer" | "channel.raid" | "channel.ban" | "channel.unban" | "channel.unban_request.create" | "channel.unban_request.resolve" | "channel.moderate" | "channel.moderator.add" | "channel.moderator.remove" | "channel.guest_star_session.begin" | "channel.guest_star_session.end" | "channel.guest_star_guest.update" | "channel.guest_star_settings.update" | "channel.channel_points_automatic_reward_redemption.add" | "channel.channel_points_custom_reward.add" | "channel.channel_points_custom_reward.update" | "channel.channel_points_custom_reward.remove" | "channel.channel_points_custom_reward_redemption.add" | "channel.channel_points_custom_reward_redemption.update" | "channel.poll.begin" | "channel.poll.progress" | "channel.poll.end" | "channel.prediction.begin" | "channel.prediction.progress" | "channel.prediction.lock" | "channel.prediction.end" | "channel.suspicious_user.message" | "channel.suspicious_user.update" | "channel.vip.add" | "channel.vip.remove" | "channel.warning.acknowledge" | "channel.warning.send" | "channel.charity_campaign.donate" | "channel.charity_campaign.start" | "channel.charity_campaign.progress" | "channel.charity_campaign.stop" | "conduit.shard.disabled" | "drop.entitlement.grant" | "extension.bits_transaction.create" | "channel.goal.begin" | "channel.goal.progress" | "channel.goal.end" | "channel.hype_train.begin" | "channel.hype_train.progress" | "channel.hype_train.end" | "channel.shield_mode.begin" | "channel.shield_mode.end" | "channel.shoutout.create" | "channel.shoutout.receive" | "stream.online" | "stream.offline" | "user.authorization.grant" | "user.authorization.revoke" | "user.update" | "user.whisper.message";
|
|
15265
|
-
version: string;
|
|
15266
|
-
condition: Record<string, never>;
|
|
15267
|
-
created_at: string;
|
|
15268
|
-
transport: {
|
|
15269
|
-
method: "webhook" | "websocket";
|
|
15270
|
-
callback?: string;
|
|
15271
|
-
session_id?: string;
|
|
15272
|
-
connected_at?: string;
|
|
15273
|
-
disconnected_at?: string;
|
|
15274
|
-
};
|
|
15275
|
-
cost: number;
|
|
15276
|
-
}[];
|
|
14987
|
+
getEventSubSubscriptions: (params?: GetEventSubSubscriptionsParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14988
|
+
data: components["schemas"]["EventSubSubscription"][];
|
|
15277
14989
|
total: number;
|
|
15278
14990
|
total_cost: number;
|
|
15279
14991
|
max_total_cost: number;
|
|
@@ -15313,13 +15025,8 @@ declare class TwitchApi {
|
|
|
15313
15025
|
*
|
|
15314
15026
|
* @see https://dev.twitch.tv/docs/api/reference#get-top-games
|
|
15315
15027
|
*/
|
|
15316
|
-
getTopGames: (params?: GetTopGamesParams | null | undefined, options?: CallApiOptions[
|
|
15317
|
-
data:
|
|
15318
|
-
id: string;
|
|
15319
|
-
name: string;
|
|
15320
|
-
box_art_url: string;
|
|
15321
|
-
igdb_id: string;
|
|
15322
|
-
}[];
|
|
15028
|
+
getTopGames: (params?: GetTopGamesParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
15029
|
+
data: components["schemas"]["Game"][];
|
|
15323
15030
|
pagination?: {
|
|
15324
15031
|
cursor?: string;
|
|
15325
15032
|
};
|
|
@@ -15356,13 +15063,8 @@ declare class TwitchApi {
|
|
|
15356
15063
|
*
|
|
15357
15064
|
* @see https://dev.twitch.tv/docs/api/reference#get-games
|
|
15358
15065
|
*/
|
|
15359
|
-
getGames: (params?: GetGamesParams | null | undefined, options?: CallApiOptions[
|
|
15360
|
-
data:
|
|
15361
|
-
id: string;
|
|
15362
|
-
name: string;
|
|
15363
|
-
box_art_url: string;
|
|
15364
|
-
igdb_id: string;
|
|
15365
|
-
}[];
|
|
15066
|
+
getGames: (params?: GetGamesParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
15067
|
+
data: components["schemas"]["Game"][];
|
|
15366
15068
|
}, 200, 400 | 401>;
|
|
15367
15069
|
};
|
|
15368
15070
|
goals: {
|
|
@@ -15399,18 +15101,8 @@ declare class TwitchApi {
|
|
|
15399
15101
|
*
|
|
15400
15102
|
* @see https://dev.twitch.tv/docs/api/reference#get-creator-goals
|
|
15401
15103
|
*/
|
|
15402
|
-
getCreatorGoals: (params: GetCreatorGoalsParams, options?: CallApiOptions[
|
|
15403
|
-
data:
|
|
15404
|
-
id: string;
|
|
15405
|
-
broadcaster_id: string;
|
|
15406
|
-
broadcaster_name: string;
|
|
15407
|
-
broadcaster_login: string;
|
|
15408
|
-
type: "follower" | "subscription" | "subscription_count" | "new_subscription" | "new_subscription_count";
|
|
15409
|
-
description: string;
|
|
15410
|
-
current_amount: number;
|
|
15411
|
-
target_amount: number;
|
|
15412
|
-
created_at: string;
|
|
15413
|
-
}[];
|
|
15104
|
+
getCreatorGoals: (params: GetCreatorGoalsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
15105
|
+
data: components["schemas"]["CreatorGoal"][];
|
|
15414
15106
|
}, 200, 400 | 401>;
|
|
15415
15107
|
};
|
|
15416
15108
|
guestStar: {
|
|
@@ -15441,7 +15133,7 @@ declare class TwitchApi {
|
|
|
15441
15133
|
*
|
|
15442
15134
|
* @see https://dev.twitch.tv/docs/api/reference#get-channel-guest-star-settings
|
|
15443
15135
|
*/
|
|
15444
|
-
getChannelGuestStarSettings: (params: GetChannelGuestStarSettingsParams, options?: CallApiOptions[
|
|
15136
|
+
getChannelGuestStarSettings: (params: GetChannelGuestStarSettingsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
15445
15137
|
is_moderator_send_live_enabled: boolean;
|
|
15446
15138
|
slot_count: number;
|
|
15447
15139
|
is_browser_source_audio_enabled: boolean;
|
|
@@ -15474,7 +15166,7 @@ declare class TwitchApi {
|
|
|
15474
15166
|
*
|
|
15475
15167
|
* @see https://dev.twitch.tv/docs/api/reference#update-channel-guest-star-settings
|
|
15476
15168
|
*/
|
|
15477
|
-
updateChannelGuestStarSettings: (params: UpdateChannelGuestStarSettingsParams, body?: UpdateChannelGuestStarSettingsBody | null | undefined, options?: CallApiOptions[
|
|
15169
|
+
updateChannelGuestStarSettings: (params: UpdateChannelGuestStarSettingsParams, body?: UpdateChannelGuestStarSettingsBody | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400>;
|
|
15478
15170
|
/**
|
|
15479
15171
|
* BETA Gets information about an ongoing Guest Star session for a particular channel.
|
|
15480
15172
|
*
|
|
@@ -15502,29 +15194,8 @@ declare class TwitchApi {
|
|
|
15502
15194
|
*
|
|
15503
15195
|
* @see https://dev.twitch.tv/docs/api/reference#get-guest-star-session
|
|
15504
15196
|
*/
|
|
15505
|
-
getGuestStarSession: (params: GetGuestStarSessionParams, options?: CallApiOptions[
|
|
15506
|
-
data:
|
|
15507
|
-
id: string;
|
|
15508
|
-
guests: {
|
|
15509
|
-
slot_id: string;
|
|
15510
|
-
is_live: boolean;
|
|
15511
|
-
user_id: string;
|
|
15512
|
-
user_display_name: string;
|
|
15513
|
-
user_login: string;
|
|
15514
|
-
volume: number;
|
|
15515
|
-
assigned_at: string;
|
|
15516
|
-
audio_settings: {
|
|
15517
|
-
is_host_enabled: boolean;
|
|
15518
|
-
is_guest_enabled: boolean;
|
|
15519
|
-
is_available: boolean;
|
|
15520
|
-
};
|
|
15521
|
-
video_settings: {
|
|
15522
|
-
is_host_enabled: boolean;
|
|
15523
|
-
is_guest_enabled: boolean;
|
|
15524
|
-
is_available: boolean;
|
|
15525
|
-
};
|
|
15526
|
-
}[];
|
|
15527
|
-
}[];
|
|
15197
|
+
getGuestStarSession: (params: GetGuestStarSessionParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
15198
|
+
data: components["schemas"]["GuestStarSession"][];
|
|
15528
15199
|
}, 200, 400 | 401>;
|
|
15529
15200
|
/**
|
|
15530
15201
|
* BETA Programmatically creates a Guest Star session on behalf of the broadcaster. Requires the broadcaster to be present in the call interface, or the call will be ended automatically.
|
|
@@ -15557,29 +15228,8 @@ declare class TwitchApi {
|
|
|
15557
15228
|
*
|
|
15558
15229
|
* @see https://dev.twitch.tv/docs/api/reference#create-guest-star-session
|
|
15559
15230
|
*/
|
|
15560
|
-
createGuestStarSession: (params: CreateGuestStarSessionParams, options?: CallApiOptions[
|
|
15561
|
-
data:
|
|
15562
|
-
id: string;
|
|
15563
|
-
guests: {
|
|
15564
|
-
slot_id: string;
|
|
15565
|
-
is_live: boolean;
|
|
15566
|
-
user_id: string;
|
|
15567
|
-
user_display_name: string;
|
|
15568
|
-
user_login: string;
|
|
15569
|
-
volume: number;
|
|
15570
|
-
assigned_at: string;
|
|
15571
|
-
audio_settings: {
|
|
15572
|
-
is_host_enabled: boolean;
|
|
15573
|
-
is_guest_enabled: boolean;
|
|
15574
|
-
is_available: boolean;
|
|
15575
|
-
};
|
|
15576
|
-
video_settings: {
|
|
15577
|
-
is_host_enabled: boolean;
|
|
15578
|
-
is_guest_enabled: boolean;
|
|
15579
|
-
is_available: boolean;
|
|
15580
|
-
};
|
|
15581
|
-
}[];
|
|
15582
|
-
}[];
|
|
15231
|
+
createGuestStarSession: (params: CreateGuestStarSessionParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
15232
|
+
data: components["schemas"]["GuestStarSession"][];
|
|
15583
15233
|
}, 200, 400 | 401 | 403>;
|
|
15584
15234
|
/**
|
|
15585
15235
|
* BETA Programmatically ends a Guest Star session on behalf of the broadcaster. Performs the same action as if the host clicked the “End Call” button in the Guest Star UI.
|
|
@@ -15609,7 +15259,7 @@ declare class TwitchApi {
|
|
|
15609
15259
|
*
|
|
15610
15260
|
* @see https://dev.twitch.tv/docs/api/reference#end-guest-star-session
|
|
15611
15261
|
*/
|
|
15612
|
-
endGuestStarSession: (params: EndGuestStarSessionParams, options?: CallApiOptions[
|
|
15262
|
+
endGuestStarSession: (params: EndGuestStarSessionParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 403>;
|
|
15613
15263
|
/**
|
|
15614
15264
|
* BETA Provides the caller with a list of pending invites to a Guest Star session, including the invitee’s ready status while joining the waiting room.
|
|
15615
15265
|
*
|
|
@@ -15633,16 +15283,8 @@ declare class TwitchApi {
|
|
|
15633
15283
|
*
|
|
15634
15284
|
* @see https://dev.twitch.tv/docs/api/reference#get-guest-star-invites
|
|
15635
15285
|
*/
|
|
15636
|
-
getGuestStarInvites: (params: GetGuestStarInvitesParams, options?: CallApiOptions[
|
|
15637
|
-
data:
|
|
15638
|
-
user_id: string;
|
|
15639
|
-
invited_at: string;
|
|
15640
|
-
status: string;
|
|
15641
|
-
is_video_enabled: boolean;
|
|
15642
|
-
is_audio_enabled: boolean;
|
|
15643
|
-
is_video_available: boolean;
|
|
15644
|
-
is_audio_available: boolean;
|
|
15645
|
-
}[];
|
|
15286
|
+
getGuestStarInvites: (params: GetGuestStarInvitesParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
15287
|
+
data: components["schemas"]["GuestStarInvite"][];
|
|
15646
15288
|
}, 200, 400>;
|
|
15647
15289
|
/**
|
|
15648
15290
|
* BETA Sends an invite to a specified guest on behalf of the broadcaster for a Guest Star session in progress.
|
|
@@ -15675,7 +15317,7 @@ declare class TwitchApi {
|
|
|
15675
15317
|
*
|
|
15676
15318
|
* @see https://dev.twitch.tv/docs/api/reference#send-guest-star-invite
|
|
15677
15319
|
*/
|
|
15678
|
-
sendGuestStarInvite: (params: SendGuestStarInviteParams, options?: CallApiOptions[
|
|
15320
|
+
sendGuestStarInvite: (params: SendGuestStarInviteParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 403>;
|
|
15679
15321
|
/**
|
|
15680
15322
|
* BETA Revokes a previously sent invite for a Guest Star session.
|
|
15681
15323
|
*
|
|
@@ -15705,7 +15347,7 @@ declare class TwitchApi {
|
|
|
15705
15347
|
*
|
|
15706
15348
|
* @see https://dev.twitch.tv/docs/api/reference#delete-guest-star-invite
|
|
15707
15349
|
*/
|
|
15708
|
-
deleteGuestStarInvite: (params: DeleteGuestStarInviteParams, options?: CallApiOptions[
|
|
15350
|
+
deleteGuestStarInvite: (params: DeleteGuestStarInviteParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 404>;
|
|
15709
15351
|
/**
|
|
15710
15352
|
* BETA Allows a previously invited user to be assigned a slot within the active Guest Star session, once that guest has indicated they are ready to join.
|
|
15711
15353
|
*
|
|
@@ -15745,7 +15387,7 @@ declare class TwitchApi {
|
|
|
15745
15387
|
*
|
|
15746
15388
|
* @see https://dev.twitch.tv/docs/api/reference#assign-guest-star-slot
|
|
15747
15389
|
*/
|
|
15748
|
-
assignGuestStarSlot: (params: AssignGuestStarSlotParams, options?: CallApiOptions[
|
|
15390
|
+
assignGuestStarSlot: (params: AssignGuestStarSlotParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 403>;
|
|
15749
15391
|
/**
|
|
15750
15392
|
* BETA Allows a user to update the assigned slot for a particular user within the active Guest Star session.
|
|
15751
15393
|
*
|
|
@@ -15772,7 +15414,7 @@ declare class TwitchApi {
|
|
|
15772
15414
|
*
|
|
15773
15415
|
* @see https://dev.twitch.tv/docs/api/reference#update-guest-star-slot
|
|
15774
15416
|
*/
|
|
15775
|
-
updateGuestStarSlot: (params: UpdateGuestStarSlotParams, options?: CallApiOptions[
|
|
15417
|
+
updateGuestStarSlot: (params: UpdateGuestStarSlotParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400>;
|
|
15776
15418
|
/**
|
|
15777
15419
|
* BETA Allows a caller to remove a slot assignment from a user participating in an active Guest Star session. This revokes their access to the session immediately and disables their access to publish or subscribe to media within the session.
|
|
15778
15420
|
*
|
|
@@ -15809,7 +15451,7 @@ declare class TwitchApi {
|
|
|
15809
15451
|
*
|
|
15810
15452
|
* @see https://dev.twitch.tv/docs/api/reference#delete-guest-star-slot
|
|
15811
15453
|
*/
|
|
15812
|
-
deleteGuestStarSlot: (params: DeleteGuestStarSlotParams, options?: CallApiOptions[
|
|
15454
|
+
deleteGuestStarSlot: (params: DeleteGuestStarSlotParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 403 | 404>;
|
|
15813
15455
|
/**
|
|
15814
15456
|
* BETA Allows a user to update slot settings for a particular guest within a Guest Star session, such as allowing the user to share audio or video within the call as a host. These settings will be broadcasted to all subscribers which control their view of the guest in that slot. One or more of the optional parameters to this API can be specified at any time.
|
|
15815
15457
|
*
|
|
@@ -15842,7 +15484,7 @@ declare class TwitchApi {
|
|
|
15842
15484
|
*
|
|
15843
15485
|
* @see https://dev.twitch.tv/docs/api/reference#update-guest-star-slot-settings
|
|
15844
15486
|
*/
|
|
15845
|
-
updateGuestStarSlotSettings: (params: UpdateGuestStarSlotSettingsParams, options?: CallApiOptions[
|
|
15487
|
+
updateGuestStarSlotSettings: (params: UpdateGuestStarSlotSettingsParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 403>;
|
|
15846
15488
|
};
|
|
15847
15489
|
hypeTrain: {
|
|
15848
15490
|
/**
|
|
@@ -15874,37 +15516,85 @@ declare class TwitchApi {
|
|
|
15874
15516
|
*
|
|
15875
15517
|
* @see https://dev.twitch.tv/docs/api/reference#get-hype-train-events
|
|
15876
15518
|
*/
|
|
15877
|
-
getHypeTrainEvents: (params: GetHypeTrainEventsParams, options?: CallApiOptions[
|
|
15878
|
-
data:
|
|
15879
|
-
|
|
15880
|
-
|
|
15881
|
-
|
|
15882
|
-
|
|
15883
|
-
|
|
15884
|
-
|
|
15885
|
-
|
|
15886
|
-
|
|
15887
|
-
|
|
15519
|
+
getHypeTrainEvents: (params: GetHypeTrainEventsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
15520
|
+
data: components["schemas"]["HypeTrainEvent"][];
|
|
15521
|
+
pagination?: {
|
|
15522
|
+
cursor?: string;
|
|
15523
|
+
};
|
|
15524
|
+
}, 200, 401>;
|
|
15525
|
+
/**
|
|
15526
|
+
* BETA Get the status of a Hype Train for the specified broadcaster.
|
|
15527
|
+
*
|
|
15528
|
+
* __Authorization:__
|
|
15529
|
+
*
|
|
15530
|
+
* * Requires an [user access token](https://dev.twitch.tv/docs/authentication/#user-access-tokens).
|
|
15531
|
+
* * Requires OAuth Scope: `channel:read:hype_train`.
|
|
15532
|
+
* * Requires that `broadcaster_id` and `user_id` match in the User-Access token.
|
|
15533
|
+
*
|
|
15534
|
+
* __URL:__
|
|
15535
|
+
*
|
|
15536
|
+
* `GET https://api.twitch.tv/helix/hypetrain/status`
|
|
15537
|
+
*
|
|
15538
|
+
* __Response Codes:__
|
|
15539
|
+
*
|
|
15540
|
+
* _200 OK_
|
|
15541
|
+
*
|
|
15542
|
+
* Successfully retrieved the status object.
|
|
15543
|
+
*
|
|
15544
|
+
* _400 Bad Request_
|
|
15545
|
+
*
|
|
15546
|
+
* The ID in the `broadcaster_id` query parameter is not valid.
|
|
15547
|
+
*
|
|
15548
|
+
* _401 Unauthorized_
|
|
15549
|
+
*
|
|
15550
|
+
* * The OAuth token is not valid.
|
|
15551
|
+
* * The Authorization header is required and must contain a user access token.
|
|
15552
|
+
*
|
|
15553
|
+
* _500 Internal Server Error_
|
|
15554
|
+
*
|
|
15555
|
+
* Internal Server Error.
|
|
15556
|
+
*
|
|
15557
|
+
* @see https://dev.twitch.tv/docs/api/reference#get-hype-train-status
|
|
15558
|
+
*/
|
|
15559
|
+
getHypeTrainStatus: (params: GetHypeTrainStatusParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
15560
|
+
data: ({
|
|
15561
|
+
current: {
|
|
15888
15562
|
id: string;
|
|
15889
|
-
|
|
15890
|
-
|
|
15891
|
-
|
|
15892
|
-
user: string;
|
|
15893
|
-
};
|
|
15563
|
+
broadcaster_user_id: string;
|
|
15564
|
+
broadcaster_user_login: string;
|
|
15565
|
+
broadcaster_user_name: string;
|
|
15894
15566
|
level: number;
|
|
15895
|
-
started_at: string;
|
|
15896
|
-
top_contributions: {
|
|
15897
|
-
total: number;
|
|
15898
|
-
type: "BITS" | "SUBS" | "OTHER";
|
|
15899
|
-
user: string;
|
|
15900
|
-
}[];
|
|
15901
15567
|
total: number;
|
|
15568
|
+
progress: number;
|
|
15569
|
+
goal: number;
|
|
15570
|
+
top_contributions: ({
|
|
15571
|
+
user_id: string;
|
|
15572
|
+
user_login: string;
|
|
15573
|
+
user_name: string;
|
|
15574
|
+
type: "treasure" | "golden_kappa" | "regular";
|
|
15575
|
+
total: number;
|
|
15576
|
+
shared_train_participants: {
|
|
15577
|
+
broadcaster_user_id: string;
|
|
15578
|
+
broadcaster_user_login: string;
|
|
15579
|
+
broadcaster_user_name: string;
|
|
15580
|
+
}[];
|
|
15581
|
+
started_at: string;
|
|
15582
|
+
expires_at: string;
|
|
15583
|
+
is_shared_train: boolean;
|
|
15584
|
+
})[];
|
|
15902
15585
|
};
|
|
15903
|
-
}[];
|
|
15904
|
-
|
|
15905
|
-
|
|
15586
|
+
})[];
|
|
15587
|
+
all_time_high: {
|
|
15588
|
+
level: number;
|
|
15589
|
+
total: number;
|
|
15590
|
+
achieved_at: string;
|
|
15906
15591
|
};
|
|
15907
|
-
|
|
15592
|
+
shared_all_time_high: {
|
|
15593
|
+
level: number;
|
|
15594
|
+
total: number;
|
|
15595
|
+
achieved_at: string;
|
|
15596
|
+
};
|
|
15597
|
+
}, 200, 400 | 401 | 500>;
|
|
15908
15598
|
};
|
|
15909
15599
|
moderation: {
|
|
15910
15600
|
/**
|
|
@@ -15961,11 +15651,8 @@ declare class TwitchApi {
|
|
|
15961
15651
|
*
|
|
15962
15652
|
* @see https://dev.twitch.tv/docs/api/reference#check-automod-status
|
|
15963
15653
|
*/
|
|
15964
|
-
checkAutoModStatus: (params: CheckAutoModStatusParams, body: CheckAutoModStatusBody, options?: CallApiOptions[
|
|
15965
|
-
data:
|
|
15966
|
-
msg_id: string;
|
|
15967
|
-
is_permitted: boolean;
|
|
15968
|
-
}[];
|
|
15654
|
+
checkAutoModStatus: (params: CheckAutoModStatusParams, body: CheckAutoModStatusBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
15655
|
+
data: components["schemas"]["AutoModStatus"][];
|
|
15969
15656
|
}, 200, 400 | 401 | 403 | 429>;
|
|
15970
15657
|
/**
|
|
15971
15658
|
* Allow or deny the message that AutoMod flagged for review. For information about AutoMod, see [How to Use AutoMod](https://help.twitch.tv/s/article/how-to-use-automod).
|
|
@@ -16011,7 +15698,7 @@ declare class TwitchApi {
|
|
|
16011
15698
|
*
|
|
16012
15699
|
* @see https://dev.twitch.tv/docs/api/reference#manage-held-automod-messages
|
|
16013
15700
|
*/
|
|
16014
|
-
manageHeldAutoModMessages: (body: ManageHeldAutoModMessagesBody, options?: CallApiOptions[
|
|
15701
|
+
manageHeldAutoModMessages: (body: ManageHeldAutoModMessagesBody, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 403 | 404>;
|
|
16015
15702
|
/**
|
|
16016
15703
|
* Gets the broadcaster’s AutoMod settings. The settings are used to automatically block inappropriate or harassing messages from appearing in the broadcaster’s chat room.
|
|
16017
15704
|
*
|
|
@@ -16048,20 +15735,8 @@ declare class TwitchApi {
|
|
|
16048
15735
|
*
|
|
16049
15736
|
* @see https://dev.twitch.tv/docs/api/reference#get-automod-settings
|
|
16050
15737
|
*/
|
|
16051
|
-
getAutoModSettings: (params: GetAutoModSettingsParams, options?: CallApiOptions[
|
|
16052
|
-
data:
|
|
16053
|
-
broadcaster_id: string;
|
|
16054
|
-
moderator_id: string;
|
|
16055
|
-
overall_level: number | null;
|
|
16056
|
-
disability: number;
|
|
16057
|
-
aggression: number;
|
|
16058
|
-
sexuality_sex_or_gender: number;
|
|
16059
|
-
misogyny: number;
|
|
16060
|
-
bullying: number;
|
|
16061
|
-
swearing: number;
|
|
16062
|
-
race_ethnicity_or_religion: number;
|
|
16063
|
-
sex_based_terms: number;
|
|
16064
|
-
}[];
|
|
15738
|
+
getAutoModSettings: (params: GetAutoModSettingsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
15739
|
+
data: components["schemas"]["AutoModSettings"][];
|
|
16065
15740
|
}, 200, 400 | 401 | 403>;
|
|
16066
15741
|
/**
|
|
16067
15742
|
* Updates the broadcaster’s AutoMod settings. The settings are used to automatically block inappropriate or harassing messages from appearing in the broadcaster’s chat room.
|
|
@@ -16115,20 +15790,8 @@ declare class TwitchApi {
|
|
|
16115
15790
|
*
|
|
16116
15791
|
* @see https://dev.twitch.tv/docs/api/reference#update-automod-settings
|
|
16117
15792
|
*/
|
|
16118
|
-
updateAutoModSettings: (params: UpdateAutoModSettingsParams, body?: UpdateAutoModSettingsBody | null | undefined, options?: CallApiOptions[
|
|
16119
|
-
data:
|
|
16120
|
-
broadcaster_id: string;
|
|
16121
|
-
moderator_id: string;
|
|
16122
|
-
overall_level: number | null;
|
|
16123
|
-
disability: number;
|
|
16124
|
-
aggression: number;
|
|
16125
|
-
sexuality_sex_or_gender: number;
|
|
16126
|
-
misogyny: number;
|
|
16127
|
-
bullying: number;
|
|
16128
|
-
swearing: number;
|
|
16129
|
-
race_ethnicity_or_religion: number;
|
|
16130
|
-
sex_based_terms: number;
|
|
16131
|
-
}[];
|
|
15793
|
+
updateAutoModSettings: (params: UpdateAutoModSettingsParams, body?: UpdateAutoModSettingsBody | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
15794
|
+
data: components["schemas"]["AutoModSettings"][];
|
|
16132
15795
|
}, 200, 400 | 401 | 403>;
|
|
16133
15796
|
/**
|
|
16134
15797
|
* Gets all users that the broadcaster banned or put in a timeout.
|
|
@@ -16161,18 +15824,8 @@ declare class TwitchApi {
|
|
|
16161
15824
|
*
|
|
16162
15825
|
* @see https://dev.twitch.tv/docs/api/reference#get-banned-users
|
|
16163
15826
|
*/
|
|
16164
|
-
getBannedUsers: (params: GetBannedUsersParams, options?: CallApiOptions[
|
|
16165
|
-
data:
|
|
16166
|
-
user_id: string;
|
|
16167
|
-
user_login: string;
|
|
16168
|
-
user_name: string;
|
|
16169
|
-
expires_at: string;
|
|
16170
|
-
created_at: string;
|
|
16171
|
-
reason: string;
|
|
16172
|
-
moderator_id: string;
|
|
16173
|
-
moderator_login: string;
|
|
16174
|
-
moderator_name: string;
|
|
16175
|
-
}[];
|
|
15827
|
+
getBannedUsers: (params: GetBannedUsersParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
15828
|
+
data: components["schemas"]["BannedUser"][];
|
|
16176
15829
|
pagination?: {
|
|
16177
15830
|
cursor?: string;
|
|
16178
15831
|
};
|
|
@@ -16233,14 +15886,14 @@ declare class TwitchApi {
|
|
|
16233
15886
|
*
|
|
16234
15887
|
* @see https://dev.twitch.tv/docs/api/reference#ban-user
|
|
16235
15888
|
*/
|
|
16236
|
-
banUser: (params: BanUserParams, body: BanUserBody, options?: CallApiOptions[
|
|
16237
|
-
data: {
|
|
15889
|
+
banUser: (params: BanUserParams, body: BanUserBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
15890
|
+
data: ({
|
|
16238
15891
|
broadcaster_id: string;
|
|
16239
15892
|
moderator_id: string;
|
|
16240
15893
|
user_id: string;
|
|
16241
15894
|
created_at: string;
|
|
16242
15895
|
end_time: string | null;
|
|
16243
|
-
}[];
|
|
15896
|
+
})[];
|
|
16244
15897
|
}, 200, 400 | 401 | 403 | 409 | 429>;
|
|
16245
15898
|
/**
|
|
16246
15899
|
* Removes the ban or timeout that was placed on the specified user.
|
|
@@ -16290,7 +15943,7 @@ declare class TwitchApi {
|
|
|
16290
15943
|
*
|
|
16291
15944
|
* @see https://dev.twitch.tv/docs/api/reference#unban-user
|
|
16292
15945
|
*/
|
|
16293
|
-
unbanUser: (params: UnbanUserParams, options?: CallApiOptions[
|
|
15946
|
+
unbanUser: (params: UnbanUserParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 403 | 409 | 429>;
|
|
16294
15947
|
/**
|
|
16295
15948
|
* NEW Gets a list of unban requests for a broadcaster’s channel.
|
|
16296
15949
|
*
|
|
@@ -16327,7 +15980,7 @@ declare class TwitchApi {
|
|
|
16327
15980
|
*
|
|
16328
15981
|
* @see https://dev.twitch.tv/docs/api/reference#get-unban-requests
|
|
16329
15982
|
*/
|
|
16330
|
-
getUnbanRequests: (params: GetUnbanRequestsParams, options?: CallApiOptions[
|
|
15983
|
+
getUnbanRequests: (params: GetUnbanRequestsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
16331
15984
|
data: {
|
|
16332
15985
|
id: string;
|
|
16333
15986
|
broadcaster_id: string;
|
|
@@ -16354,7 +16007,7 @@ declare class TwitchApi {
|
|
|
16354
16007
|
*
|
|
16355
16008
|
* __Authorization:__
|
|
16356
16009
|
*
|
|
16357
|
-
* * Requires a user access token that includes the **moderator:manage:unban
|
|
16010
|
+
* * Requires a user access token that includes the **moderator:manage:unban\_requests** scope.
|
|
16358
16011
|
* * Query parameter `moderator_id` must match the `user_id` in the[user access token](https://dev.twitch.tv/docs/authentication/#user-access-tokens).
|
|
16359
16012
|
*
|
|
16360
16013
|
* __URL:__
|
|
@@ -16391,7 +16044,7 @@ declare class TwitchApi {
|
|
|
16391
16044
|
*
|
|
16392
16045
|
* @see https://dev.twitch.tv/docs/api/reference#resolve-unban-requests
|
|
16393
16046
|
*/
|
|
16394
|
-
resolveUnbanRequests: (params: ResolveUnbanRequestsParams, options?: CallApiOptions[
|
|
16047
|
+
resolveUnbanRequests: (params: ResolveUnbanRequestsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
16395
16048
|
data: {
|
|
16396
16049
|
id: string;
|
|
16397
16050
|
broadcaster_id: string;
|
|
@@ -16446,16 +16099,8 @@ declare class TwitchApi {
|
|
|
16446
16099
|
*
|
|
16447
16100
|
* @see https://dev.twitch.tv/docs/api/reference#get-blocked-terms
|
|
16448
16101
|
*/
|
|
16449
|
-
getBlockedTerms: (params: GetBlockedTermsParams, options?: CallApiOptions[
|
|
16450
|
-
data:
|
|
16451
|
-
broadcaster_id: string;
|
|
16452
|
-
moderator_id: string;
|
|
16453
|
-
id: string;
|
|
16454
|
-
text: string;
|
|
16455
|
-
created_at: string;
|
|
16456
|
-
updated_at: string;
|
|
16457
|
-
expires_at: string | null;
|
|
16458
|
-
}[];
|
|
16102
|
+
getBlockedTerms: (params: GetBlockedTermsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
16103
|
+
data: components["schemas"]["BlockedTerm"][];
|
|
16459
16104
|
pagination?: {
|
|
16460
16105
|
cursor?: string;
|
|
16461
16106
|
};
|
|
@@ -16494,20 +16139,12 @@ declare class TwitchApi {
|
|
|
16494
16139
|
*
|
|
16495
16140
|
* _403 Forbidden_
|
|
16496
16141
|
*
|
|
16497
|
-
* * The user in _moderator\_id_ is not one of the broadcaster's moderators.
|
|
16498
|
-
*
|
|
16499
|
-
* @see https://dev.twitch.tv/docs/api/reference#add-blocked-term
|
|
16500
|
-
*/
|
|
16501
|
-
addBlockedTerm: (params: AddBlockedTermParams, body: AddBlockedTermBody, options?: CallApiOptions[
|
|
16502
|
-
data:
|
|
16503
|
-
broadcaster_id: string;
|
|
16504
|
-
moderator_id: string;
|
|
16505
|
-
id: string;
|
|
16506
|
-
text: string;
|
|
16507
|
-
created_at: string;
|
|
16508
|
-
updated_at: string;
|
|
16509
|
-
expires_at: string | null;
|
|
16510
|
-
}[];
|
|
16142
|
+
* * The user in _moderator\_id_ is not one of the broadcaster's moderators.
|
|
16143
|
+
*
|
|
16144
|
+
* @see https://dev.twitch.tv/docs/api/reference#add-blocked-term
|
|
16145
|
+
*/
|
|
16146
|
+
addBlockedTerm: (params: AddBlockedTermParams, body: AddBlockedTermBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
16147
|
+
data: components["schemas"]["BlockedTerm"][];
|
|
16511
16148
|
}, 200, 400 | 401 | 403>;
|
|
16512
16149
|
/**
|
|
16513
16150
|
* Removes the word or phrase from the broadcaster’s list of blocked terms.
|
|
@@ -16546,7 +16183,7 @@ declare class TwitchApi {
|
|
|
16546
16183
|
*
|
|
16547
16184
|
* @see https://dev.twitch.tv/docs/api/reference#remove-blocked-term
|
|
16548
16185
|
*/
|
|
16549
|
-
removeBlockedTerm: (params: RemoveBlockedTermParams, options?: CallApiOptions[
|
|
16186
|
+
removeBlockedTerm: (params: RemoveBlockedTermParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 403>;
|
|
16550
16187
|
/**
|
|
16551
16188
|
* Removes a single chat message or all chat messages from the broadcaster’s chat room.
|
|
16552
16189
|
*
|
|
@@ -16587,7 +16224,7 @@ declare class TwitchApi {
|
|
|
16587
16224
|
*
|
|
16588
16225
|
* @see https://dev.twitch.tv/docs/api/reference#delete-chat-messages
|
|
16589
16226
|
*/
|
|
16590
|
-
deleteChatMessages: (params: DeleteChatMessagesParams, options?: CallApiOptions[
|
|
16227
|
+
deleteChatMessages: (params: DeleteChatMessagesParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 403 | 404>;
|
|
16591
16228
|
/**
|
|
16592
16229
|
* Gets a list of channels that the specified user has moderator privileges in.
|
|
16593
16230
|
*
|
|
@@ -16614,7 +16251,7 @@ declare class TwitchApi {
|
|
|
16614
16251
|
*
|
|
16615
16252
|
* @see https://dev.twitch.tv/docs/api/reference#get-moderated-channels
|
|
16616
16253
|
*/
|
|
16617
|
-
getModeratedChannels: (params: GetModeratedChannelsParams, options?: CallApiOptions[
|
|
16254
|
+
getModeratedChannels: (params: GetModeratedChannelsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
16618
16255
|
data: {
|
|
16619
16256
|
broadcaster_id: string;
|
|
16620
16257
|
broadcaster_login: string;
|
|
@@ -16655,12 +16292,8 @@ declare class TwitchApi {
|
|
|
16655
16292
|
*
|
|
16656
16293
|
* @see https://dev.twitch.tv/docs/api/reference#get-moderators
|
|
16657
16294
|
*/
|
|
16658
|
-
getModerators: (params: GetModeratorsParams, options?: CallApiOptions[
|
|
16659
|
-
data:
|
|
16660
|
-
user_id: string;
|
|
16661
|
-
user_login: string;
|
|
16662
|
-
user_name: string;
|
|
16663
|
-
}[];
|
|
16295
|
+
getModerators: (params: GetModeratorsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
16296
|
+
data: components["schemas"]["UserModerator"][];
|
|
16664
16297
|
pagination?: {
|
|
16665
16298
|
cursor?: string;
|
|
16666
16299
|
};
|
|
@@ -16709,7 +16342,7 @@ declare class TwitchApi {
|
|
|
16709
16342
|
*
|
|
16710
16343
|
* @see https://dev.twitch.tv/docs/api/reference#add-channel-moderator
|
|
16711
16344
|
*/
|
|
16712
|
-
addChannelModerator: (params: AddChannelModeratorParams, options?: CallApiOptions[
|
|
16345
|
+
addChannelModerator: (params: AddChannelModeratorParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 422 | 429>;
|
|
16713
16346
|
/**
|
|
16714
16347
|
* Removes a moderator from the broadcaster’s chat room.
|
|
16715
16348
|
*
|
|
@@ -16749,7 +16382,7 @@ declare class TwitchApi {
|
|
|
16749
16382
|
*
|
|
16750
16383
|
* @see https://dev.twitch.tv/docs/api/reference#remove-channel-moderator
|
|
16751
16384
|
*/
|
|
16752
|
-
removeChannelModerator: (params: RemoveChannelModeratorParams, options?: CallApiOptions[
|
|
16385
|
+
removeChannelModerator: (params: RemoveChannelModeratorParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 429>;
|
|
16753
16386
|
/**
|
|
16754
16387
|
* Gets a list of the broadcaster’s VIPs.
|
|
16755
16388
|
*
|
|
@@ -16783,12 +16416,8 @@ declare class TwitchApi {
|
|
|
16783
16416
|
*
|
|
16784
16417
|
* @see https://dev.twitch.tv/docs/api/reference#get-vips
|
|
16785
16418
|
*/
|
|
16786
|
-
getVIPs: (params: GetVIPsParams, options?: CallApiOptions[
|
|
16787
|
-
data:
|
|
16788
|
-
user_id: string;
|
|
16789
|
-
user_name: string;
|
|
16790
|
-
user_login: string;
|
|
16791
|
-
}[];
|
|
16419
|
+
getVIPs: (params: GetVIPsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
16420
|
+
data: components["schemas"]["UserVip"][];
|
|
16792
16421
|
pagination?: {
|
|
16793
16422
|
cursor?: string;
|
|
16794
16423
|
};
|
|
@@ -16854,7 +16483,7 @@ declare class TwitchApi {
|
|
|
16854
16483
|
*
|
|
16855
16484
|
* @see https://dev.twitch.tv/docs/api/reference#add-channel-vip
|
|
16856
16485
|
*/
|
|
16857
|
-
addChannelVIP: (params: AddChannelVIPParams, options?: CallApiOptions[
|
|
16486
|
+
addChannelVIP: (params: AddChannelVIPParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 403 | 404 | 409 | 422 | 425 | 429>;
|
|
16858
16487
|
/**
|
|
16859
16488
|
* Removes the specified user as a VIP in the broadcaster’s channel.
|
|
16860
16489
|
*
|
|
@@ -16908,7 +16537,7 @@ declare class TwitchApi {
|
|
|
16908
16537
|
*
|
|
16909
16538
|
* @see https://dev.twitch.tv/docs/api/reference#remove-channel-vip
|
|
16910
16539
|
*/
|
|
16911
|
-
removeChannelVIP: (params: RemoveChannelVIPParams, options?: CallApiOptions[
|
|
16540
|
+
removeChannelVIP: (params: RemoveChannelVIPParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 403 | 404 | 422 | 429>;
|
|
16912
16541
|
/**
|
|
16913
16542
|
* Activates or deactivates the broadcaster’s Shield Mode.
|
|
16914
16543
|
*
|
|
@@ -16949,7 +16578,7 @@ declare class TwitchApi {
|
|
|
16949
16578
|
*
|
|
16950
16579
|
* @see https://dev.twitch.tv/docs/api/reference#update-shield-mode-status
|
|
16951
16580
|
*/
|
|
16952
|
-
updateShieldModeStatus: (params: UpdateShieldModeStatusParams, body: UpdateShieldModeStatusBody, options?: CallApiOptions[
|
|
16581
|
+
updateShieldModeStatus: (params: UpdateShieldModeStatusParams, body: UpdateShieldModeStatusBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
16953
16582
|
data: {
|
|
16954
16583
|
is_active: boolean;
|
|
16955
16584
|
moderator_id: string;
|
|
@@ -16996,7 +16625,7 @@ declare class TwitchApi {
|
|
|
16996
16625
|
*
|
|
16997
16626
|
* @see https://dev.twitch.tv/docs/api/reference#get-shield-mode-status
|
|
16998
16627
|
*/
|
|
16999
|
-
getShieldModeStatus: (params: GetShieldModeStatusParams, options?: CallApiOptions[
|
|
16628
|
+
getShieldModeStatus: (params: GetShieldModeStatusParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17000
16629
|
data: {
|
|
17001
16630
|
is_active: boolean;
|
|
17002
16631
|
moderator_id: string;
|
|
@@ -17057,7 +16686,7 @@ declare class TwitchApi {
|
|
|
17057
16686
|
*
|
|
17058
16687
|
* @see https://dev.twitch.tv/docs/api/reference#warn-chat-user
|
|
17059
16688
|
*/
|
|
17060
|
-
warnChatUser: (params: WarnChatUserParams, body: WarnChatUserBody, options?: CallApiOptions[
|
|
16689
|
+
warnChatUser: (params: WarnChatUserParams, body: WarnChatUserBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17061
16690
|
data: {
|
|
17062
16691
|
broadcaster_id: string;
|
|
17063
16692
|
user_id: string;
|
|
@@ -17104,29 +16733,8 @@ declare class TwitchApi {
|
|
|
17104
16733
|
*
|
|
17105
16734
|
* @see https://dev.twitch.tv/docs/api/reference#get-polls
|
|
17106
16735
|
*/
|
|
17107
|
-
getPolls: (params: GetPollsParams, options?: CallApiOptions[
|
|
17108
|
-
data:
|
|
17109
|
-
id: string;
|
|
17110
|
-
broadcaster_id: string;
|
|
17111
|
-
broadcaster_name: string;
|
|
17112
|
-
broadcaster_login: string;
|
|
17113
|
-
title: string;
|
|
17114
|
-
choices: {
|
|
17115
|
-
id: string;
|
|
17116
|
-
title: string;
|
|
17117
|
-
votes: number;
|
|
17118
|
-
channel_points_votes: number;
|
|
17119
|
-
bits_votes: number;
|
|
17120
|
-
}[];
|
|
17121
|
-
bits_voting_enabled: boolean;
|
|
17122
|
-
bits_per_vote: number;
|
|
17123
|
-
channel_points_voting_enabled: boolean;
|
|
17124
|
-
channel_points_per_vote: number;
|
|
17125
|
-
status: "ACTIVE" | "COMPLETED" | "TERMINATED" | "ARCHIVED" | "MODERATED" | "INVALID";
|
|
17126
|
-
duration: number;
|
|
17127
|
-
started_at: string;
|
|
17128
|
-
ended_at: string | null;
|
|
17129
|
-
}[];
|
|
16736
|
+
getPolls: (params: GetPollsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
16737
|
+
data: components["schemas"]["Poll"][];
|
|
17130
16738
|
pagination?: {
|
|
17131
16739
|
cursor?: string;
|
|
17132
16740
|
};
|
|
@@ -17175,29 +16783,8 @@ declare class TwitchApi {
|
|
|
17175
16783
|
*
|
|
17176
16784
|
* @see https://dev.twitch.tv/docs/api/reference#create-poll
|
|
17177
16785
|
*/
|
|
17178
|
-
createPoll: (body: CreatePollBody, options?: CallApiOptions[
|
|
17179
|
-
data:
|
|
17180
|
-
id: string;
|
|
17181
|
-
broadcaster_id: string;
|
|
17182
|
-
broadcaster_name: string;
|
|
17183
|
-
broadcaster_login: string;
|
|
17184
|
-
title: string;
|
|
17185
|
-
choices: {
|
|
17186
|
-
id: string;
|
|
17187
|
-
title: string;
|
|
17188
|
-
votes: number;
|
|
17189
|
-
channel_points_votes: number;
|
|
17190
|
-
bits_votes: number;
|
|
17191
|
-
}[];
|
|
17192
|
-
bits_voting_enabled: boolean;
|
|
17193
|
-
bits_per_vote: number;
|
|
17194
|
-
channel_points_voting_enabled: boolean;
|
|
17195
|
-
channel_points_per_vote: number;
|
|
17196
|
-
status: "ACTIVE" | "COMPLETED" | "TERMINATED" | "ARCHIVED" | "MODERATED" | "INVALID";
|
|
17197
|
-
duration: number;
|
|
17198
|
-
started_at: string;
|
|
17199
|
-
ended_at: string | null;
|
|
17200
|
-
}[];
|
|
16786
|
+
createPoll: (body: CreatePollBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
16787
|
+
data: components["schemas"]["Poll"][];
|
|
17201
16788
|
}, 200, 400 | 401>;
|
|
17202
16789
|
/**
|
|
17203
16790
|
* Ends an active poll. You have the option to end it or end it and archive it.
|
|
@@ -17234,29 +16821,8 @@ declare class TwitchApi {
|
|
|
17234
16821
|
*
|
|
17235
16822
|
* @see https://dev.twitch.tv/docs/api/reference#end-poll
|
|
17236
16823
|
*/
|
|
17237
|
-
endPoll: (body: EndPollBody, options?: CallApiOptions[
|
|
17238
|
-
data:
|
|
17239
|
-
id: string;
|
|
17240
|
-
broadcaster_id: string;
|
|
17241
|
-
broadcaster_name: string;
|
|
17242
|
-
broadcaster_login: string;
|
|
17243
|
-
title: string;
|
|
17244
|
-
choices: {
|
|
17245
|
-
id: string;
|
|
17246
|
-
title: string;
|
|
17247
|
-
votes: number;
|
|
17248
|
-
channel_points_votes: number;
|
|
17249
|
-
bits_votes: number;
|
|
17250
|
-
}[];
|
|
17251
|
-
bits_voting_enabled: boolean;
|
|
17252
|
-
bits_per_vote: number;
|
|
17253
|
-
channel_points_voting_enabled: boolean;
|
|
17254
|
-
channel_points_per_vote: number;
|
|
17255
|
-
status: "ACTIVE" | "COMPLETED" | "TERMINATED" | "ARCHIVED" | "MODERATED" | "INVALID";
|
|
17256
|
-
duration: number;
|
|
17257
|
-
started_at: string;
|
|
17258
|
-
ended_at: string | null;
|
|
17259
|
-
}[];
|
|
16824
|
+
endPoll: (body: EndPollBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
16825
|
+
data: components["schemas"]["Poll"][];
|
|
17260
16826
|
}, 200, 400 | 401>;
|
|
17261
16827
|
};
|
|
17262
16828
|
predictions: {
|
|
@@ -17291,34 +16857,8 @@ declare class TwitchApi {
|
|
|
17291
16857
|
*
|
|
17292
16858
|
* @see https://dev.twitch.tv/docs/api/reference#get-predictions
|
|
17293
16859
|
*/
|
|
17294
|
-
getPredictions: (params: GetPredictionsParams, options?: CallApiOptions[
|
|
17295
|
-
data:
|
|
17296
|
-
id: string;
|
|
17297
|
-
broadcaster_id: string;
|
|
17298
|
-
broadcaster_name: string;
|
|
17299
|
-
broadcaster_login: string;
|
|
17300
|
-
title: string;
|
|
17301
|
-
winning_outcome_id: string | null;
|
|
17302
|
-
outcomes: {
|
|
17303
|
-
id: string;
|
|
17304
|
-
title: string;
|
|
17305
|
-
users: number;
|
|
17306
|
-
channel_points: number;
|
|
17307
|
-
top_predictors: {
|
|
17308
|
-
user_id: string;
|
|
17309
|
-
user_name: string;
|
|
17310
|
-
user_login: string;
|
|
17311
|
-
channel_points_used: number;
|
|
17312
|
-
channel_points_won: number;
|
|
17313
|
-
}[] | null;
|
|
17314
|
-
color: "BLUE" | "PINK";
|
|
17315
|
-
}[];
|
|
17316
|
-
prediction_window: number;
|
|
17317
|
-
status: "CANCELED" | "ACTIVE" | "LOCKED" | "RESOLVED";
|
|
17318
|
-
created_at: string;
|
|
17319
|
-
ended_at: string | null;
|
|
17320
|
-
locked_at: string | null;
|
|
17321
|
-
}[];
|
|
16860
|
+
getPredictions: (params: GetPredictionsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
16861
|
+
data: components["schemas"]["Prediction"][];
|
|
17322
16862
|
pagination?: {
|
|
17323
16863
|
cursor?: string;
|
|
17324
16864
|
};
|
|
@@ -17367,34 +16907,8 @@ declare class TwitchApi {
|
|
|
17367
16907
|
*
|
|
17368
16908
|
* @see https://dev.twitch.tv/docs/api/reference#create-prediction
|
|
17369
16909
|
*/
|
|
17370
|
-
createPrediction: (body: CreatePredictionBody, options?: CallApiOptions[
|
|
17371
|
-
data:
|
|
17372
|
-
id: string;
|
|
17373
|
-
broadcaster_id: string;
|
|
17374
|
-
broadcaster_name: string;
|
|
17375
|
-
broadcaster_login: string;
|
|
17376
|
-
title: string;
|
|
17377
|
-
winning_outcome_id: string | null;
|
|
17378
|
-
outcomes: {
|
|
17379
|
-
id: string;
|
|
17380
|
-
title: string;
|
|
17381
|
-
users: number;
|
|
17382
|
-
channel_points: number;
|
|
17383
|
-
top_predictors: {
|
|
17384
|
-
user_id: string;
|
|
17385
|
-
user_name: string;
|
|
17386
|
-
user_login: string;
|
|
17387
|
-
channel_points_used: number;
|
|
17388
|
-
channel_points_won: number;
|
|
17389
|
-
}[] | null;
|
|
17390
|
-
color: "BLUE" | "PINK";
|
|
17391
|
-
}[];
|
|
17392
|
-
prediction_window: number;
|
|
17393
|
-
status: "CANCELED" | "ACTIVE" | "LOCKED" | "RESOLVED";
|
|
17394
|
-
created_at: string;
|
|
17395
|
-
ended_at: string | null;
|
|
17396
|
-
locked_at: string | null;
|
|
17397
|
-
}[];
|
|
16910
|
+
createPrediction: (body: CreatePredictionBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
16911
|
+
data: components["schemas"]["Prediction"][];
|
|
17398
16912
|
}, 200, 400 | 401 | 429>;
|
|
17399
16913
|
/**
|
|
17400
16914
|
* Locks, resolves, or cancels a Channel Points Prediction.
|
|
@@ -17438,34 +16952,8 @@ declare class TwitchApi {
|
|
|
17438
16952
|
*
|
|
17439
16953
|
* @see https://dev.twitch.tv/docs/api/reference#end-prediction
|
|
17440
16954
|
*/
|
|
17441
|
-
endPrediction: (body: EndPredictionBody, options?: CallApiOptions[
|
|
17442
|
-
data:
|
|
17443
|
-
id: string;
|
|
17444
|
-
broadcaster_id: string;
|
|
17445
|
-
broadcaster_name: string;
|
|
17446
|
-
broadcaster_login: string;
|
|
17447
|
-
title: string;
|
|
17448
|
-
winning_outcome_id: string | null;
|
|
17449
|
-
outcomes: {
|
|
17450
|
-
id: string;
|
|
17451
|
-
title: string;
|
|
17452
|
-
users: number;
|
|
17453
|
-
channel_points: number;
|
|
17454
|
-
top_predictors: {
|
|
17455
|
-
user_id: string;
|
|
17456
|
-
user_name: string;
|
|
17457
|
-
user_login: string;
|
|
17458
|
-
channel_points_used: number;
|
|
17459
|
-
channel_points_won: number;
|
|
17460
|
-
}[] | null;
|
|
17461
|
-
color: "BLUE" | "PINK";
|
|
17462
|
-
}[];
|
|
17463
|
-
prediction_window: number;
|
|
17464
|
-
status: "CANCELED" | "ACTIVE" | "LOCKED" | "RESOLVED";
|
|
17465
|
-
created_at: string;
|
|
17466
|
-
ended_at: string | null;
|
|
17467
|
-
locked_at: string | null;
|
|
17468
|
-
}[];
|
|
16955
|
+
endPrediction: (body: EndPredictionBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
16956
|
+
data: components["schemas"]["Prediction"][];
|
|
17469
16957
|
}, 200, 400 | 401 | 404>;
|
|
17470
16958
|
};
|
|
17471
16959
|
raids: {
|
|
@@ -17525,7 +17013,7 @@ declare class TwitchApi {
|
|
|
17525
17013
|
*
|
|
17526
17014
|
* @see https://dev.twitch.tv/docs/api/reference#start-a-raid
|
|
17527
17015
|
*/
|
|
17528
|
-
startRaid: (params?: StartRaidParams | null | undefined, options?: CallApiOptions[
|
|
17016
|
+
startRaid: (params?: StartRaidParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17529
17017
|
data: {
|
|
17530
17018
|
created_at: string;
|
|
17531
17019
|
is_mature: boolean;
|
|
@@ -17574,7 +17062,7 @@ declare class TwitchApi {
|
|
|
17574
17062
|
*
|
|
17575
17063
|
* @see https://dev.twitch.tv/docs/api/reference#cancel-a-raid
|
|
17576
17064
|
*/
|
|
17577
|
-
cancelRaid: (params: CancelRaidParams, options?: CallApiOptions[
|
|
17065
|
+
cancelRaid: (params: CancelRaidParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 404 | 429>;
|
|
17578
17066
|
};
|
|
17579
17067
|
schedule: {
|
|
17580
17068
|
/**
|
|
@@ -17617,20 +17105,9 @@ declare class TwitchApi {
|
|
|
17617
17105
|
*
|
|
17618
17106
|
* @see https://dev.twitch.tv/docs/api/reference#get-channel-stream-schedule
|
|
17619
17107
|
*/
|
|
17620
|
-
getChannelStreamSchedule: (params: GetChannelStreamScheduleParams, options?: CallApiOptions[
|
|
17108
|
+
getChannelStreamSchedule: (params: GetChannelStreamScheduleParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17621
17109
|
data: {
|
|
17622
|
-
segments:
|
|
17623
|
-
id: string;
|
|
17624
|
-
start_time: string;
|
|
17625
|
-
end_time: string;
|
|
17626
|
-
title: string;
|
|
17627
|
-
canceled_until: string | null;
|
|
17628
|
-
category: {
|
|
17629
|
-
id: string;
|
|
17630
|
-
name: string;
|
|
17631
|
-
};
|
|
17632
|
-
is_recurring: boolean;
|
|
17633
|
-
}[];
|
|
17110
|
+
segments: components["schemas"]["ChannelStreamScheduleSegment"][];
|
|
17634
17111
|
broadcaster_id: string;
|
|
17635
17112
|
broadcaster_name: string;
|
|
17636
17113
|
broadcaster_login: string;
|
|
@@ -17673,7 +17150,7 @@ declare class TwitchApi {
|
|
|
17673
17150
|
*
|
|
17674
17151
|
* @see https://dev.twitch.tv/docs/api/reference#get-channel-icalendar
|
|
17675
17152
|
*/
|
|
17676
|
-
getChannelICalendar: (params: GetChannelICalendarParams, options?: CallApiOptions[
|
|
17153
|
+
getChannelICalendar: (params: GetChannelICalendarParams, options?: CallApiOptions["options"]) => ApiResponse<string, 200, 400>;
|
|
17677
17154
|
/**
|
|
17678
17155
|
* Updates the broadcaster’s schedule settings, such as scheduling a vacation.
|
|
17679
17156
|
*
|
|
@@ -17713,7 +17190,7 @@ declare class TwitchApi {
|
|
|
17713
17190
|
*
|
|
17714
17191
|
* @see https://dev.twitch.tv/docs/api/reference#update-channel-stream-schedule
|
|
17715
17192
|
*/
|
|
17716
|
-
updateChannelStreamSchedule: (params: UpdateChannelStreamScheduleParams, options?: CallApiOptions[
|
|
17193
|
+
updateChannelStreamSchedule: (params: UpdateChannelStreamScheduleParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 404>;
|
|
17717
17194
|
/**
|
|
17718
17195
|
* Adds a single or recurring broadcast to the broadcaster’s streaming schedule. For information about scheduling broadcasts, see [Stream Schedule](https://help.twitch.tv/s/article/channel-page-setup#Schedule).
|
|
17719
17196
|
*
|
|
@@ -17755,20 +17232,9 @@ declare class TwitchApi {
|
|
|
17755
17232
|
*
|
|
17756
17233
|
* @see https://dev.twitch.tv/docs/api/reference#create-channel-stream-schedule-segment
|
|
17757
17234
|
*/
|
|
17758
|
-
createChannelStreamScheduleSegment: (params: CreateChannelStreamScheduleSegmentParams, body: CreateChannelStreamScheduleSegmentBody, options?: CallApiOptions[
|
|
17235
|
+
createChannelStreamScheduleSegment: (params: CreateChannelStreamScheduleSegmentParams, body: CreateChannelStreamScheduleSegmentBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17759
17236
|
data: {
|
|
17760
|
-
segments:
|
|
17761
|
-
id: string;
|
|
17762
|
-
start_time: string;
|
|
17763
|
-
end_time: string;
|
|
17764
|
-
title: string;
|
|
17765
|
-
canceled_until: string | null;
|
|
17766
|
-
category: {
|
|
17767
|
-
id: string;
|
|
17768
|
-
name: string;
|
|
17769
|
-
};
|
|
17770
|
-
is_recurring: boolean;
|
|
17771
|
-
}[];
|
|
17237
|
+
segments: components["schemas"]["ChannelStreamScheduleSegment"][];
|
|
17772
17238
|
broadcaster_id: string;
|
|
17773
17239
|
broadcaster_name: string;
|
|
17774
17240
|
broadcaster_login: string;
|
|
@@ -17823,20 +17289,9 @@ declare class TwitchApi {
|
|
|
17823
17289
|
*
|
|
17824
17290
|
* @see https://dev.twitch.tv/docs/api/reference#update-channel-stream-schedule-segment
|
|
17825
17291
|
*/
|
|
17826
|
-
updateChannelStreamScheduleSegment: (params: UpdateChannelStreamScheduleSegmentParams, body?: UpdateChannelStreamScheduleSegmentBody | null | undefined, options?: CallApiOptions[
|
|
17292
|
+
updateChannelStreamScheduleSegment: (params: UpdateChannelStreamScheduleSegmentParams, body?: UpdateChannelStreamScheduleSegmentBody | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17827
17293
|
data: {
|
|
17828
|
-
segments:
|
|
17829
|
-
id: string;
|
|
17830
|
-
start_time: string;
|
|
17831
|
-
end_time: string;
|
|
17832
|
-
title: string;
|
|
17833
|
-
canceled_until: string | null;
|
|
17834
|
-
category: {
|
|
17835
|
-
id: string;
|
|
17836
|
-
name: string;
|
|
17837
|
-
};
|
|
17838
|
-
is_recurring: boolean;
|
|
17839
|
-
}[];
|
|
17294
|
+
segments: components["schemas"]["ChannelStreamScheduleSegment"][];
|
|
17840
17295
|
broadcaster_id: string;
|
|
17841
17296
|
broadcaster_name: string;
|
|
17842
17297
|
broadcaster_login: string;
|
|
@@ -17882,7 +17337,7 @@ declare class TwitchApi {
|
|
|
17882
17337
|
*
|
|
17883
17338
|
* @see https://dev.twitch.tv/docs/api/reference#delete-channel-stream-schedule-segment
|
|
17884
17339
|
*/
|
|
17885
|
-
deleteChannelStreamScheduleSegment: (params: DeleteChannelStreamScheduleSegmentParams, options?: CallApiOptions[
|
|
17340
|
+
deleteChannelStreamScheduleSegment: (params: DeleteChannelStreamScheduleSegmentParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401>;
|
|
17886
17341
|
};
|
|
17887
17342
|
search: {
|
|
17888
17343
|
/**
|
|
@@ -17916,12 +17371,11 @@ declare class TwitchApi {
|
|
|
17916
17371
|
*
|
|
17917
17372
|
* @see https://dev.twitch.tv/docs/api/reference#search-categories
|
|
17918
17373
|
*/
|
|
17919
|
-
searchCategories: (params: SearchCategoriesParams, options?: CallApiOptions[
|
|
17920
|
-
data:
|
|
17921
|
-
|
|
17922
|
-
|
|
17923
|
-
|
|
17924
|
-
}[];
|
|
17374
|
+
searchCategories: (params: SearchCategoriesParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17375
|
+
data: components["schemas"]["Category"][];
|
|
17376
|
+
pagination?: {
|
|
17377
|
+
cursor?: string;
|
|
17378
|
+
};
|
|
17925
17379
|
}, 200, 400 | 401>;
|
|
17926
17380
|
/**
|
|
17927
17381
|
* Gets the channels that match the specified query and have streamed content within the past 6 months.
|
|
@@ -17958,21 +17412,11 @@ declare class TwitchApi {
|
|
|
17958
17412
|
*
|
|
17959
17413
|
* @see https://dev.twitch.tv/docs/api/reference#search-channels
|
|
17960
17414
|
*/
|
|
17961
|
-
searchChannels: (params: SearchChannelsParams, options?: CallApiOptions[
|
|
17962
|
-
data:
|
|
17963
|
-
|
|
17964
|
-
|
|
17965
|
-
|
|
17966
|
-
game_id: string;
|
|
17967
|
-
game_name: string;
|
|
17968
|
-
id: string;
|
|
17969
|
-
is_live: boolean;
|
|
17970
|
-
tag_ids: string[];
|
|
17971
|
-
tags: string[];
|
|
17972
|
-
thumbnail_url: string;
|
|
17973
|
-
title: string;
|
|
17974
|
-
started_at: string;
|
|
17975
|
-
}[];
|
|
17415
|
+
searchChannels: (params: SearchChannelsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17416
|
+
data: components["schemas"]["Channel"][];
|
|
17417
|
+
pagination?: {
|
|
17418
|
+
cursor?: string;
|
|
17419
|
+
};
|
|
17976
17420
|
}, 200, 400 | 401>;
|
|
17977
17421
|
};
|
|
17978
17422
|
streams: {
|
|
@@ -18006,13 +17450,17 @@ declare class TwitchApi {
|
|
|
18006
17450
|
* * The access token is not valid.
|
|
18007
17451
|
* * The client ID specified in the Client-Id header must match the client ID specified in the access token.
|
|
18008
17452
|
*
|
|
17453
|
+
* _403 Forbidden_
|
|
17454
|
+
*
|
|
17455
|
+
* The user must complete additional steps in order to stream. Present the user with the returned error message.
|
|
17456
|
+
*
|
|
18009
17457
|
* @see https://dev.twitch.tv/docs/api/reference#get-stream-key
|
|
18010
17458
|
*/
|
|
18011
|
-
getStreamKey: (params: GetStreamKeyParams, options?: CallApiOptions[
|
|
17459
|
+
getStreamKey: (params: GetStreamKeyParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
18012
17460
|
data: {
|
|
18013
17461
|
stream_key: string;
|
|
18014
17462
|
}[];
|
|
18015
|
-
}, 200, 400 | 401>;
|
|
17463
|
+
}, 200, 400 | 401 | 403>;
|
|
18016
17464
|
/**
|
|
18017
17465
|
* Gets a list of all streams. The list is in descending order by the number of viewers watching the stream. Because viewers come and go during a stream, it’s possible to find duplicate or missing streams in the list as you page through the results.
|
|
18018
17466
|
*
|
|
@@ -18042,24 +17490,8 @@ declare class TwitchApi {
|
|
|
18042
17490
|
*
|
|
18043
17491
|
* @see https://dev.twitch.tv/docs/api/reference#get-streams
|
|
18044
17492
|
*/
|
|
18045
|
-
getStreams: (params?: GetStreamsParams | null | undefined, options?: CallApiOptions[
|
|
18046
|
-
data:
|
|
18047
|
-
id: string;
|
|
18048
|
-
user_id: string;
|
|
18049
|
-
user_login: string;
|
|
18050
|
-
user_name: string;
|
|
18051
|
-
game_id: string;
|
|
18052
|
-
game_name: string;
|
|
18053
|
-
type: "live";
|
|
18054
|
-
title: string;
|
|
18055
|
-
viewer_count: number;
|
|
18056
|
-
started_at: string;
|
|
18057
|
-
language: string;
|
|
18058
|
-
thumbnail_url: string;
|
|
18059
|
-
tag_ids: string[];
|
|
18060
|
-
tags: string[];
|
|
18061
|
-
is_mature: boolean;
|
|
18062
|
-
}[];
|
|
17493
|
+
getStreams: (params?: GetStreamsParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17494
|
+
data: components["schemas"]["Stream"][];
|
|
18063
17495
|
pagination?: {
|
|
18064
17496
|
cursor?: string;
|
|
18065
17497
|
};
|
|
@@ -18095,24 +17527,8 @@ declare class TwitchApi {
|
|
|
18095
17527
|
*
|
|
18096
17528
|
* @see https://dev.twitch.tv/docs/api/reference#get-followed-streams
|
|
18097
17529
|
*/
|
|
18098
|
-
getFollowedStreams: (params: GetFollowedStreamsParams, options?: CallApiOptions[
|
|
18099
|
-
data:
|
|
18100
|
-
id: string;
|
|
18101
|
-
user_id: string;
|
|
18102
|
-
user_login: string;
|
|
18103
|
-
user_name: string;
|
|
18104
|
-
game_id: string;
|
|
18105
|
-
game_name: string;
|
|
18106
|
-
type: "live";
|
|
18107
|
-
title: string;
|
|
18108
|
-
viewer_count: number;
|
|
18109
|
-
started_at: string;
|
|
18110
|
-
language: string;
|
|
18111
|
-
thumbnail_url: string;
|
|
18112
|
-
tag_ids: string[];
|
|
18113
|
-
tags: string[];
|
|
18114
|
-
is_mature: boolean;
|
|
18115
|
-
}[];
|
|
17530
|
+
getFollowedStreams: (params: GetFollowedStreamsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17531
|
+
data: components["schemas"]["Stream"][];
|
|
18116
17532
|
pagination?: {
|
|
18117
17533
|
cursor?: string;
|
|
18118
17534
|
};
|
|
@@ -18165,13 +17581,8 @@ declare class TwitchApi {
|
|
|
18165
17581
|
*
|
|
18166
17582
|
* @see https://dev.twitch.tv/docs/api/reference#create-stream-marker
|
|
18167
17583
|
*/
|
|
18168
|
-
createStreamMarker: (body: CreateStreamMarkerBody, options?: CallApiOptions[
|
|
18169
|
-
data:
|
|
18170
|
-
id: string;
|
|
18171
|
-
created_at: string;
|
|
18172
|
-
position_seconds: number;
|
|
18173
|
-
description: string;
|
|
18174
|
-
}[];
|
|
17584
|
+
createStreamMarker: (body: CreateStreamMarkerBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17585
|
+
data: components["schemas"]["StreamMarkerCreated"][];
|
|
18175
17586
|
}, 200, 400 | 401 | 403 | 404>;
|
|
18176
17587
|
/**
|
|
18177
17588
|
* Gets a list of markers from the user’s most recent stream or from the specified VOD/video. A marker is an arbitrary point in a live stream that the broadcaster or editor marked, so they can return to that spot later to create video highlights (see Video Producer, Highlights in the Twitch UX).
|
|
@@ -18211,21 +17622,8 @@ declare class TwitchApi {
|
|
|
18211
17622
|
*
|
|
18212
17623
|
* @see https://dev.twitch.tv/docs/api/reference#get-stream-markers
|
|
18213
17624
|
*/
|
|
18214
|
-
getStreamMarkers: (params?: GetStreamMarkersParams | null | undefined, options?: CallApiOptions[
|
|
18215
|
-
data:
|
|
18216
|
-
user_id: string;
|
|
18217
|
-
user_name: string;
|
|
18218
|
-
user_login: string;
|
|
18219
|
-
videos: Record<string, never>[];
|
|
18220
|
-
video_id: string;
|
|
18221
|
-
markers: {
|
|
18222
|
-
id: string;
|
|
18223
|
-
created_at: string;
|
|
18224
|
-
description: string;
|
|
18225
|
-
position_seconds: number;
|
|
18226
|
-
url: string;
|
|
18227
|
-
}[];
|
|
18228
|
-
}[];
|
|
17625
|
+
getStreamMarkers: (params?: GetStreamMarkersParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17626
|
+
data: components["schemas"]["StreamMarkers"][];
|
|
18229
17627
|
pagination?: {
|
|
18230
17628
|
cursor?: string;
|
|
18231
17629
|
};
|
|
@@ -18265,21 +17663,8 @@ declare class TwitchApi {
|
|
|
18265
17663
|
*
|
|
18266
17664
|
* @see https://dev.twitch.tv/docs/api/reference#get-broadcaster-subscriptions
|
|
18267
17665
|
*/
|
|
18268
|
-
getBroadcasterSubscriptions: (params: GetBroadcasterSubscriptionsParams, options?: CallApiOptions[
|
|
18269
|
-
data:
|
|
18270
|
-
broadcaster_id: string;
|
|
18271
|
-
broadcaster_login: string;
|
|
18272
|
-
broadcaster_name: string;
|
|
18273
|
-
gifter_id: string;
|
|
18274
|
-
gifter_login: string;
|
|
18275
|
-
gifter_name: string;
|
|
18276
|
-
is_gift: boolean;
|
|
18277
|
-
plan_name: string;
|
|
18278
|
-
tier: "1000" | "2000" | "3000";
|
|
18279
|
-
user_id: string;
|
|
18280
|
-
user_name: string;
|
|
18281
|
-
user_login: string;
|
|
18282
|
-
}[];
|
|
17666
|
+
getBroadcasterSubscriptions: (params: GetBroadcasterSubscriptionsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17667
|
+
data: components["schemas"]["BroadcasterSubscription"][];
|
|
18283
17668
|
pagination?: {
|
|
18284
17669
|
cursor?: string;
|
|
18285
17670
|
};
|
|
@@ -18324,17 +17709,8 @@ declare class TwitchApi {
|
|
|
18324
17709
|
*
|
|
18325
17710
|
* @see https://dev.twitch.tv/docs/api/reference#check-user-subscription
|
|
18326
17711
|
*/
|
|
18327
|
-
checkUserSubscription: (params: CheckUserSubscriptionParams, options?: CallApiOptions[
|
|
18328
|
-
data:
|
|
18329
|
-
broadcaster_id: string;
|
|
18330
|
-
broadcaster_login: string;
|
|
18331
|
-
broadcaster_name: string;
|
|
18332
|
-
gifter_id?: string;
|
|
18333
|
-
gifter_login?: string;
|
|
18334
|
-
gifter_name?: string;
|
|
18335
|
-
is_gift: boolean;
|
|
18336
|
-
tier: "1000" | "2000" | "3000";
|
|
18337
|
-
}[];
|
|
17712
|
+
checkUserSubscription: (params: CheckUserSubscriptionParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17713
|
+
data: components["schemas"]["UserSubscription"][];
|
|
18338
17714
|
}, 200, 400 | 401 | 404>;
|
|
18339
17715
|
};
|
|
18340
17716
|
tags: {
|
|
@@ -18370,17 +17746,8 @@ declare class TwitchApi {
|
|
|
18370
17746
|
*
|
|
18371
17747
|
* @see https://dev.twitch.tv/docs/api/reference#get-all-stream-tags
|
|
18372
17748
|
*/
|
|
18373
|
-
getAllStreamTags: (params?: GetAllStreamTagsParams | null | undefined, options?: CallApiOptions[
|
|
18374
|
-
data:
|
|
18375
|
-
tag_id: string;
|
|
18376
|
-
is_auto: boolean;
|
|
18377
|
-
localization_names: {
|
|
18378
|
-
[key: string]: string;
|
|
18379
|
-
};
|
|
18380
|
-
localization_descriptions: {
|
|
18381
|
-
[key: string]: string;
|
|
18382
|
-
};
|
|
18383
|
-
}[];
|
|
17749
|
+
getAllStreamTags: (params?: GetAllStreamTagsParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17750
|
+
data: components["schemas"]["StreamTag"][];
|
|
18384
17751
|
pagination?: {
|
|
18385
17752
|
cursor?: string;
|
|
18386
17753
|
};
|
|
@@ -18417,17 +17784,8 @@ declare class TwitchApi {
|
|
|
18417
17784
|
*
|
|
18418
17785
|
* @see https://dev.twitch.tv/docs/api/reference#get-stream-tags
|
|
18419
17786
|
*/
|
|
18420
|
-
getStreamTags: (params: GetStreamTagsParams, options?: CallApiOptions[
|
|
18421
|
-
data:
|
|
18422
|
-
tag_id: string;
|
|
18423
|
-
is_auto: boolean;
|
|
18424
|
-
localization_names: {
|
|
18425
|
-
[key: string]: string;
|
|
18426
|
-
};
|
|
18427
|
-
localization_descriptions: {
|
|
18428
|
-
[key: string]: string;
|
|
18429
|
-
};
|
|
18430
|
-
}[];
|
|
17787
|
+
getStreamTags: (params: GetStreamTagsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17788
|
+
data: components["schemas"]["StreamTag"][];
|
|
18431
17789
|
}, 200, 400 | 401>;
|
|
18432
17790
|
};
|
|
18433
17791
|
teams: {
|
|
@@ -18464,21 +17822,8 @@ declare class TwitchApi {
|
|
|
18464
17822
|
*
|
|
18465
17823
|
* @see https://dev.twitch.tv/docs/api/reference#get-channel-teams
|
|
18466
17824
|
*/
|
|
18467
|
-
getChannelTeams: (params: GetChannelTeamsParams, options?: CallApiOptions[
|
|
18468
|
-
data:
|
|
18469
|
-
broadcaster_id: string;
|
|
18470
|
-
broadcaster_login: string;
|
|
18471
|
-
broadcaster_name: string;
|
|
18472
|
-
background_image_url: string;
|
|
18473
|
-
banner: string;
|
|
18474
|
-
created_at: string;
|
|
18475
|
-
updated_at: string;
|
|
18476
|
-
info: string;
|
|
18477
|
-
thumbnail_url: string;
|
|
18478
|
-
team_name: string;
|
|
18479
|
-
team_display_name: string;
|
|
18480
|
-
id: string;
|
|
18481
|
-
}[];
|
|
17825
|
+
getChannelTeams: (params: GetChannelTeamsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17826
|
+
data: components["schemas"]["ChannelTeam"][];
|
|
18482
17827
|
}, 200, 400 | 401 | 404>;
|
|
18483
17828
|
/**
|
|
18484
17829
|
* Gets information about the specified Twitch team. [Read More](https://help.twitch.tv/s/article/twitch-teams)
|
|
@@ -18515,23 +17860,8 @@ declare class TwitchApi {
|
|
|
18515
17860
|
*
|
|
18516
17861
|
* @see https://dev.twitch.tv/docs/api/reference#get-teams
|
|
18517
17862
|
*/
|
|
18518
|
-
getTeams: (params?: GetTeamsParams | null | undefined, options?: CallApiOptions[
|
|
18519
|
-
data:
|
|
18520
|
-
users: {
|
|
18521
|
-
user_id: string;
|
|
18522
|
-
user_login: string;
|
|
18523
|
-
user_name: string;
|
|
18524
|
-
}[];
|
|
18525
|
-
background_image_url: string;
|
|
18526
|
-
banner: string;
|
|
18527
|
-
created_at: string;
|
|
18528
|
-
updated_at: string;
|
|
18529
|
-
info: string;
|
|
18530
|
-
thumbnail_url: string;
|
|
18531
|
-
team_name: string;
|
|
18532
|
-
team_display_name: string;
|
|
18533
|
-
id: string;
|
|
18534
|
-
}[];
|
|
17863
|
+
getTeams: (params?: GetTeamsParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17864
|
+
data: components["schemas"]["Team"][];
|
|
18535
17865
|
}, 200, 400 | 401 | 404>;
|
|
18536
17866
|
};
|
|
18537
17867
|
users: {
|
|
@@ -18571,20 +17901,8 @@ declare class TwitchApi {
|
|
|
18571
17901
|
*
|
|
18572
17902
|
* @see https://dev.twitch.tv/docs/api/reference#get-users
|
|
18573
17903
|
*/
|
|
18574
|
-
getUsers: (params?: GetUsersParams | null | undefined, options?: CallApiOptions[
|
|
18575
|
-
data:
|
|
18576
|
-
id: string;
|
|
18577
|
-
login: string;
|
|
18578
|
-
display_name: string;
|
|
18579
|
-
type: "" | "admin" | "global_mod" | "staff";
|
|
18580
|
-
broadcaster_type: "" | "affiliate" | "partner";
|
|
18581
|
-
description: string;
|
|
18582
|
-
profile_image_url: string;
|
|
18583
|
-
offline_image_url: string;
|
|
18584
|
-
view_count: number;
|
|
18585
|
-
email?: string;
|
|
18586
|
-
created_at: string;
|
|
18587
|
-
}[];
|
|
17904
|
+
getUsers: (params?: GetUsersParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17905
|
+
data: components["schemas"]["User"][];
|
|
18588
17906
|
}, 200, 400 | 401>;
|
|
18589
17907
|
/**
|
|
18590
17908
|
* Updates the specified user’s information. The user ID in the OAuth token identifies the user whose information you want to update.
|
|
@@ -18616,23 +17934,15 @@ declare class TwitchApi {
|
|
|
18616
17934
|
* * The access token is not valid.
|
|
18617
17935
|
* * The ID specified in the Client-Id header does not match the client ID specified in the access token.
|
|
18618
17936
|
*
|
|
17937
|
+
* _429 Too Many Requests_
|
|
17938
|
+
*
|
|
17939
|
+
* The app exceeded the number of requests that it may make.
|
|
17940
|
+
*
|
|
18619
17941
|
* @see https://dev.twitch.tv/docs/api/reference#update-user
|
|
18620
17942
|
*/
|
|
18621
|
-
updateUser: (params?: UpdateUserParams | null | undefined, options?: CallApiOptions[
|
|
18622
|
-
data:
|
|
18623
|
-
|
|
18624
|
-
login: string;
|
|
18625
|
-
display_name: string;
|
|
18626
|
-
type: "" | "admin" | "global_mod" | "staff";
|
|
18627
|
-
broadcaster_type: "" | "affiliate" | "partner";
|
|
18628
|
-
description: string;
|
|
18629
|
-
profile_image_url: string;
|
|
18630
|
-
offline_image_url: string;
|
|
18631
|
-
view_count: number;
|
|
18632
|
-
email?: string;
|
|
18633
|
-
created_at: string;
|
|
18634
|
-
}[];
|
|
18635
|
-
}, 200, 400 | 401>;
|
|
17943
|
+
updateUser: (params?: UpdateUserParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17944
|
+
data: components["schemas"]["User"][];
|
|
17945
|
+
}, 200, 400 | 401 | 429>;
|
|
18636
17946
|
/**
|
|
18637
17947
|
* Gets the list of users that the broadcaster has blocked. [Read More](https://help.twitch.tv/s/article/how-to-manage-harassment-in-chat?language=en%5FUS#BlockWhispersandMessagesfromStrangers)
|
|
18638
17948
|
*
|
|
@@ -18664,12 +17974,11 @@ declare class TwitchApi {
|
|
|
18664
17974
|
*
|
|
18665
17975
|
* @see https://dev.twitch.tv/docs/api/reference#get-user-block-list
|
|
18666
17976
|
*/
|
|
18667
|
-
getUserBlockList: (params: GetUserBlockListParams, options?: CallApiOptions[
|
|
18668
|
-
data:
|
|
18669
|
-
|
|
18670
|
-
|
|
18671
|
-
|
|
18672
|
-
}[];
|
|
17977
|
+
getUserBlockList: (params: GetUserBlockListParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17978
|
+
data: components["schemas"]["UserBlockList"][];
|
|
17979
|
+
pagination?: {
|
|
17980
|
+
cursor?: string;
|
|
17981
|
+
};
|
|
18673
17982
|
}, 200, 400 | 401>;
|
|
18674
17983
|
/**
|
|
18675
17984
|
* Blocks the specified user from interacting with or having contact with the broadcaster. The user ID in the OAuth token identifies the broadcaster who is blocking the user.
|
|
@@ -18706,7 +18015,7 @@ declare class TwitchApi {
|
|
|
18706
18015
|
*
|
|
18707
18016
|
* @see https://dev.twitch.tv/docs/api/reference#block-user
|
|
18708
18017
|
*/
|
|
18709
|
-
blockUser: (params: BlockUserParams, options?: CallApiOptions[
|
|
18018
|
+
blockUser: (params: BlockUserParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401>;
|
|
18710
18019
|
/**
|
|
18711
18020
|
* Removes the user from the broadcaster’s list of blocked users. The user ID in the OAuth token identifies the broadcaster who’s removing the block.
|
|
18712
18021
|
*
|
|
@@ -18737,7 +18046,7 @@ declare class TwitchApi {
|
|
|
18737
18046
|
*
|
|
18738
18047
|
* @see https://dev.twitch.tv/docs/api/reference#unblock-user
|
|
18739
18048
|
*/
|
|
18740
|
-
unblockUser: (params: UnblockUserParams, options?: CallApiOptions[
|
|
18049
|
+
unblockUser: (params: UnblockUserParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401>;
|
|
18741
18050
|
/**
|
|
18742
18051
|
* Gets a list of all extensions (both active and inactive) that the broadcaster has installed. The user ID in the access token identifies the broadcaster.
|
|
18743
18052
|
*
|
|
@@ -18764,14 +18073,8 @@ declare class TwitchApi {
|
|
|
18764
18073
|
*
|
|
18765
18074
|
* @see https://dev.twitch.tv/docs/api/reference#get-user-extensions
|
|
18766
18075
|
*/
|
|
18767
|
-
getUserExtensions: (options?: CallApiOptions[
|
|
18768
|
-
data:
|
|
18769
|
-
id: string;
|
|
18770
|
-
version: string;
|
|
18771
|
-
name: string;
|
|
18772
|
-
can_activate: boolean;
|
|
18773
|
-
type: ("component" | "mobile" | "overlay" | "panel")[];
|
|
18774
|
-
}[];
|
|
18076
|
+
getUserExtensions: (options?: CallApiOptions["options"]) => ApiResponse<{
|
|
18077
|
+
data: components["schemas"]["UserExtension"][];
|
|
18775
18078
|
}, 200, 401>;
|
|
18776
18079
|
/**
|
|
18777
18080
|
* Gets the active extensions that the broadcaster has installed for each configuration.
|
|
@@ -18804,33 +18107,16 @@ declare class TwitchApi {
|
|
|
18804
18107
|
*
|
|
18805
18108
|
* @see https://dev.twitch.tv/docs/api/reference#get-user-active-extensions
|
|
18806
18109
|
*/
|
|
18807
|
-
getUserActiveExtensions: (params?: GetUserActiveExtensionsParams | null | undefined, options?: CallApiOptions[
|
|
18110
|
+
getUserActiveExtensions: (params?: GetUserActiveExtensionsParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
18808
18111
|
data?: {
|
|
18809
18112
|
panel?: {
|
|
18810
|
-
[key: string]:
|
|
18811
|
-
active: boolean;
|
|
18812
|
-
id?: string;
|
|
18813
|
-
version?: string;
|
|
18814
|
-
name?: string;
|
|
18815
|
-
};
|
|
18113
|
+
[key: string]: components["schemas"]["UserExtensionPanel"];
|
|
18816
18114
|
};
|
|
18817
18115
|
overlay?: {
|
|
18818
|
-
[key: string]:
|
|
18819
|
-
active: boolean;
|
|
18820
|
-
id?: string;
|
|
18821
|
-
version?: string;
|
|
18822
|
-
name?: string;
|
|
18823
|
-
};
|
|
18116
|
+
[key: string]: components["schemas"]["UserExtensionOverlay"];
|
|
18824
18117
|
};
|
|
18825
18118
|
component?: {
|
|
18826
|
-
[key: string]:
|
|
18827
|
-
active: boolean;
|
|
18828
|
-
id?: string;
|
|
18829
|
-
version?: string;
|
|
18830
|
-
name?: string;
|
|
18831
|
-
x?: number;
|
|
18832
|
-
y?: number;
|
|
18833
|
-
};
|
|
18119
|
+
[key: string]: components["schemas"]["UserExtensionComponent"];
|
|
18834
18120
|
};
|
|
18835
18121
|
};
|
|
18836
18122
|
}, 200, 400 | 401>;
|
|
@@ -18870,33 +18156,16 @@ declare class TwitchApi {
|
|
|
18870
18156
|
*
|
|
18871
18157
|
* @see https://dev.twitch.tv/docs/api/reference#update-user-extensions
|
|
18872
18158
|
*/
|
|
18873
|
-
updateUserExtensions: (body: UpdateUserExtensionsBody, options?: CallApiOptions[
|
|
18159
|
+
updateUserExtensions: (body: UpdateUserExtensionsBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
18874
18160
|
data: {
|
|
18875
18161
|
panel: {
|
|
18876
|
-
[key: string]:
|
|
18877
|
-
active: boolean;
|
|
18878
|
-
id?: string;
|
|
18879
|
-
version?: string;
|
|
18880
|
-
name?: string;
|
|
18881
|
-
};
|
|
18162
|
+
[key: string]: components["schemas"]["UserExtensionPanel"];
|
|
18882
18163
|
};
|
|
18883
18164
|
overlay: {
|
|
18884
|
-
[key: string]:
|
|
18885
|
-
active: boolean;
|
|
18886
|
-
id?: string;
|
|
18887
|
-
version?: string;
|
|
18888
|
-
name?: string;
|
|
18889
|
-
};
|
|
18165
|
+
[key: string]: components["schemas"]["UserExtensionOverlay"];
|
|
18890
18166
|
};
|
|
18891
18167
|
component: {
|
|
18892
|
-
[key: string]:
|
|
18893
|
-
active: boolean;
|
|
18894
|
-
id?: string;
|
|
18895
|
-
version?: string;
|
|
18896
|
-
name?: string;
|
|
18897
|
-
x?: number;
|
|
18898
|
-
y?: number;
|
|
18899
|
-
};
|
|
18168
|
+
[key: string]: components["schemas"]["UserExtensionComponent"];
|
|
18900
18169
|
};
|
|
18901
18170
|
};
|
|
18902
18171
|
}, 200, 400 | 401 | 404>;
|
|
@@ -18944,29 +18213,8 @@ declare class TwitchApi {
|
|
|
18944
18213
|
*
|
|
18945
18214
|
* @see https://dev.twitch.tv/docs/api/reference#get-videos
|
|
18946
18215
|
*/
|
|
18947
|
-
getVideos: (params?: GetVideosParams | null | undefined, options?: CallApiOptions[
|
|
18948
|
-
data:
|
|
18949
|
-
id: string;
|
|
18950
|
-
stream_id: string | null;
|
|
18951
|
-
user_id: string;
|
|
18952
|
-
user_login: string;
|
|
18953
|
-
user_name: string;
|
|
18954
|
-
title: string;
|
|
18955
|
-
description: string;
|
|
18956
|
-
created_at: string;
|
|
18957
|
-
published_at: string;
|
|
18958
|
-
url: string;
|
|
18959
|
-
thumbnail_url: string;
|
|
18960
|
-
viewable: string;
|
|
18961
|
-
view_count: number;
|
|
18962
|
-
language: string;
|
|
18963
|
-
type: "archive" | "highlight" | "upload";
|
|
18964
|
-
duration: string;
|
|
18965
|
-
muted_segments: {
|
|
18966
|
-
duration: number;
|
|
18967
|
-
offset: number;
|
|
18968
|
-
}[] | null;
|
|
18969
|
-
}[];
|
|
18216
|
+
getVideos: (params?: GetVideosParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
18217
|
+
data: components["schemas"]["Video"][];
|
|
18970
18218
|
pagination?: {
|
|
18971
18219
|
cursor?: string;
|
|
18972
18220
|
};
|
|
@@ -19003,7 +18251,7 @@ declare class TwitchApi {
|
|
|
19003
18251
|
*
|
|
19004
18252
|
* @see https://dev.twitch.tv/docs/api/reference#delete-videos
|
|
19005
18253
|
*/
|
|
19006
|
-
deleteVideos: (params: DeleteVideosParams, options?: CallApiOptions[
|
|
18254
|
+
deleteVideos: (params: DeleteVideosParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
19007
18255
|
data: string[];
|
|
19008
18256
|
}, 200, 400 | 401>;
|
|
19009
18257
|
};
|
|
@@ -19064,8 +18312,8 @@ declare class TwitchApi {
|
|
|
19064
18312
|
*
|
|
19065
18313
|
* @see https://dev.twitch.tv/docs/api/reference#send-whisper
|
|
19066
18314
|
*/
|
|
19067
|
-
sendWhisper: (params: SendWhisperParams, body: SendWhisperBody, options?: CallApiOptions[
|
|
18315
|
+
sendWhisper: (params: SendWhisperParams, body: SendWhisperBody, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 403 | 404 | 429>;
|
|
19068
18316
|
};
|
|
19069
18317
|
}
|
|
19070
18318
|
|
|
19071
|
-
export { type AddBlockedTermBody, type AddBlockedTermParams, type AddBlockedTermResponse, type AddChannelModeratorParams, type AddChannelVIPParams, type ApiResponse, type AssignGuestStarSlotParams, type AutoModSettings, type AutoModStatus, type BanUserBody, type BanUserParams, type BanUserResponse, type BannedUser, type BitsLeaderboard, type BlockUserParams, type BlockedTerm, type BroadcasterSubscription, type CancelRaidParams, type Category, type Channel, type ChannelEditor, type ChannelEmote, type ChannelInformation, type ChannelStreamScheduleSegment, type ChannelTeam, type CharityCampaign, type CharityCampaignDonation, type ChatBadge, type ChatSettings, type ChatSettingsUpdated, type Chatter, type CheckAutoModStatusBody, type CheckAutoModStatusParams, type CheckAutoModStatusResponse, type CheckUserSubscriptionParams, type CheckUserSubscriptionResponse, type Cheermote, type CheermoteImageFormat, type CheermoteImageTheme, type CheermoteImages, type Clip, type ContentClassificationLabel, type CreateChannelStreamScheduleSegmentBody, type CreateChannelStreamScheduleSegmentParams, type CreateChannelStreamScheduleSegmentResponse, type CreateClipParams, type CreateClipResponse, type CreateConduitsBody, type CreateConduitsResponse, type CreateCustomRewardsBody, type CreateCustomRewardsParams, type CreateCustomRewardsResponse, type CreateEventSubSubscriptionBody, type CreateEventSubSubscriptionResponse, type CreateExtensionSecretParams, type CreateExtensionSecretResponse, type CreateGuestStarSessionParams, type CreateGuestStarSessionResponse, type CreatePollBody, type CreatePollResponse, type CreatePredictionBody, type CreatePredictionResponse, type CreateStreamMarkerBody, type CreateStreamMarkerResponse, type CreatorGoal, type CustomReward, type CustomRewardRedemption, type DeleteChannelStreamScheduleSegmentParams, type DeleteChatMessagesParams, type DeleteConduitParams, type DeleteCustomRewardParams, type DeleteEventSubSubscriptionParams, type DeleteGuestStarInviteParams, type DeleteGuestStarSlotParams, type DeleteVideosParams, type DeleteVideosResponse, type DropsEntitlement, type DropsEntitlementUpdated, type Emote, type EndGuestStarSessionParams, type EndGuestStarSessionResponse, type EndPollBody, type EndPollResponse, type EndPredictionBody, type EndPredictionResponse, type EventSubSubscription, type Extension, type ExtensionAnalytics, type ExtensionBitsProduct, type ExtensionConfigurationSegment, type ExtensionIconUrls, type ExtensionLiveChannel, type ExtensionSecret, type ExtensionTransaction, type Game, type GameAnalytics, type GetAdScheduleParams, type GetAdScheduleResponse, type GetAllStreamTagsParams, type GetAllStreamTagsResponse, type GetAutoModSettingsParams, type GetAutoModSettingsResponse, type GetBannedUsersParams, type GetBannedUsersResponse, type GetBitsLeaderboardParams, type GetBitsLeaderboardResponse, type GetBlockedTermsParams, type GetBlockedTermsResponse, type GetBroadcasterSubscriptionsParams, type GetBroadcasterSubscriptionsResponse, type GetChannelChatBadgesParams, type GetChannelChatBadgesResponse, type GetChannelEditorsParams, type GetChannelEditorsResponse, type GetChannelEmotesParams, type GetChannelEmotesResponse, type GetChannelFollowersParams, type GetChannelFollowersResponse, type GetChannelGuestStarSettingsParams, type GetChannelGuestStarSettingsResponse, type GetChannelICalendarParams, type GetChannelInformationParams, type GetChannelInformationResponse, type GetChannelStreamScheduleParams, type GetChannelStreamScheduleResponse, type GetChannelTeamsParams, type GetChannelTeamsResponse, type GetCharityCampaignDonationsParams, type GetCharityCampaignDonationsResponse, type GetCharityCampaignParams, type GetCharityCampaignResponse, type GetChatSettingsParams, type GetChatSettingsResponse, type GetChattersParams, type GetChattersResponse, type GetCheermotesParams, type GetCheermotesResponse, type GetClipsParams, type GetClipsResponse, type GetConduitShardsParams, type GetConduitShardsResponse, type GetConduitsResponse, type GetContentClassificationLabelsParams, type GetContentClassificationLabelsResponse, type GetCreatorGoalsParams, type GetCreatorGoalsResponse, type GetCustomRewardParams, type GetCustomRewardRedemptionParams, type GetCustomRewardRedemptionResponse, type GetCustomRewardResponse, type GetDropsEntitlementsParams, type GetDropsEntitlementsResponse, type GetEmoteSetsParams, type GetEmoteSetsResponse, type GetEventSubSubscriptionsParams, type GetEventSubSubscriptionsResponse, type GetExtensionAnalyticsParams, type GetExtensionAnalyticsResponse, type GetExtensionBitsProductsParams, type GetExtensionBitsProductsResponse, type GetExtensionConfigurationSegmentParams, type GetExtensionConfigurationSegmentResponse, type GetExtensionLiveChannelsParams, type GetExtensionLiveChannelsResponse, type GetExtensionSecretsResponse, type GetExtensionTransactionsParams, type GetExtensionTransactionsResponse, type GetExtensionsParams, type GetExtensionsResponse, type GetFollowedChannelsParams, type GetFollowedChannelsResponse, type GetFollowedStreamsParams, type GetFollowedStreamsResponse, type GetGameAnalyticsParams, type GetGameAnalyticsResponse, type GetGamesParams, type GetGamesResponse, type GetGlobalChatBadgesResponse, type GetGlobalEmotesResponse, type GetGuestStarInvitesParams, type GetGuestStarInvitesResponse, type GetGuestStarSessionParams, type GetGuestStarSessionResponse, type GetHypeTrainEventsParams, type GetHypeTrainEventsResponse, type GetModeratedChannelsParams, type GetModeratedChannelsResponse, type GetModeratorsParams, type GetModeratorsResponse, type GetPollsParams, type GetPollsResponse, type GetPredictionsParams, type GetPredictionsResponse, type GetReleasedExtensionsParams, type GetReleasedExtensionsResponse, type GetShieldModeStatusParams, type GetShieldModeStatusResponse, type GetStreamKeyParams, type GetStreamKeyResponse, type GetStreamMarkersParams, type GetStreamMarkersResponse, type GetStreamTagsParams, type GetStreamTagsResponse, type GetStreamsParams, type GetStreamsResponse, type GetTeamsParams, type GetTeamsResponse, type GetTopGamesParams, type GetTopGamesResponse, type GetUnbanRequestsParams, type GetUnbanRequestsResponse, type GetUserActiveExtensionsParams, type GetUserActiveExtensionsResponse, type GetUserBlockListParams, type GetUserBlockListResponse, type GetUserChatColorParams, type GetUserChatColorResponse, type GetUserEmotesParams, type GetUserEmotesResponse, type GetUserExtensionsResponse, type GetUsersParams, type GetUsersResponse, type GetVIPsParams, type GetVIPsResponse, type GetVideosParams, type GetVideosResponse, type GlobalEmote, type Guest, type GuestStarInvite, type GuestStarSession, type HypeTrainEvent, type ManageHeldAutoModMessagesBody, type ModifyChannelInformationBody, type ModifyChannelInformationParams, type Poll, type Prediction, type PredictionOutcome, type RemoveBlockedTermParams, type RemoveChannelModeratorParams, type RemoveChannelVIPParams, type ResolveUnbanRequestsParams, type ResolveUnbanRequestsResponse, type SearchCategoriesParams, type SearchCategoriesResponse, type SearchChannelsParams, type SearchChannelsResponse, type SendChatAnnouncementBody, type SendChatAnnouncementParams, type SendChatMessageBody, type SendChatMessageResponse, type SendExtensionChatMessageBody, type SendExtensionChatMessageParams, type SendExtensionPubSubMessageBody, type SendGuestStarInviteParams, type SendShoutoutParams, type SendWhisperBody, type SendWhisperParams, type SetExtensionConfigurationSegmentBody, type SetExtensionRequiredConfigurationBody, type SetExtensionRequiredConfigurationParams, type SnoozeNextAdParams, type SnoozeNextAdResponse, type StartCommercialBody, type StartCommercialResponse, type StartRaidParams, type StartRaidResponse, type Stream, type StreamMarkerCreated, type StreamMarkers, type StreamTag, type Team, TwitchApi, type TwitchApiOptions, type UnbanUserParams, type UnblockUserParams, type UpdateAutoModSettingsBody, type UpdateAutoModSettingsParams, type UpdateAutoModSettingsResponse, type UpdateChannelGuestStarSettingsBody, type UpdateChannelGuestStarSettingsParams, type UpdateChannelStreamScheduleParams, type UpdateChannelStreamScheduleSegmentBody, type UpdateChannelStreamScheduleSegmentParams, type UpdateChannelStreamScheduleSegmentResponse, type UpdateChatSettingsBody, type UpdateChatSettingsParams, type UpdateChatSettingsResponse, type UpdateConduitShardsBody, type UpdateConduitShardsResponse, type UpdateConduitsBody, type UpdateConduitsResponse, type UpdateCustomRewardBody, type UpdateCustomRewardParams, type UpdateCustomRewardResponse, type UpdateDropsEntitlementsBody, type UpdateDropsEntitlementsResponse, type UpdateExtensionBitsProductBody, type UpdateExtensionBitsProductResponse, type UpdateGuestStarSlotParams, type UpdateGuestStarSlotSettingsParams, type UpdateRedemptionStatusBody, type UpdateRedemptionStatusParams, type UpdateRedemptionStatusResponse, type UpdateShieldModeStatusBody, type UpdateShieldModeStatusParams, type UpdateShieldModeStatusResponse, type UpdateUserChatColorParams, type UpdateUserExtensionsBody, type UpdateUserExtensionsResponse, type UpdateUserParams, type UpdateUserResponse, type User, type UserBlockList, type UserChatColor, type UserExtension, type UserExtensionComponent, type UserExtensionComponentUpdate, type UserExtensionOverlay, type UserExtensionOverlayUpdate, type UserExtensionPanel, type UserExtensionPanelUpdate, type UserModerator, type UserSubscription, type UserVip, type Video, type WarnChatUserBody, type WarnChatUserParams, type WarnChatUserResponse };
|
|
18319
|
+
export { type AddBlockedTermBody, type AddBlockedTermParams, type AddBlockedTermResponse, type AddChannelModeratorParams, type AddChannelVIPParams, type ApiResponse, type AssignGuestStarSlotParams, type AutoModSettings, type AutoModStatus, type BanUserBody, type BanUserParams, type BanUserResponse, type BannedUser, type BitsLeaderboard, type BlockUserParams, type BlockedTerm, type BroadcasterSubscription, type CancelRaidParams, type Category, type Channel, type ChannelEditor, type ChannelEmote, type ChannelInformation, type ChannelStreamScheduleSegment, type ChannelTeam, type CharityCampaign, type CharityCampaignDonation, type ChatBadge, type ChatSettings, type ChatSettingsUpdated, type Chatter, type CheckAutoModStatusBody, type CheckAutoModStatusParams, type CheckAutoModStatusResponse, type CheckUserSubscriptionParams, type CheckUserSubscriptionResponse, type Cheermote, type CheermoteImageFormat, type CheermoteImageTheme, type CheermoteImages, type Clip, type ContentClassificationLabel, type CreateChannelStreamScheduleSegmentBody, type CreateChannelStreamScheduleSegmentParams, type CreateChannelStreamScheduleSegmentResponse, type CreateClipParams, type CreateClipResponse, type CreateConduitsBody, type CreateConduitsResponse, type CreateCustomRewardsBody, type CreateCustomRewardsParams, type CreateCustomRewardsResponse, type CreateEventSubSubscriptionBody, type CreateEventSubSubscriptionResponse, type CreateExtensionSecretParams, type CreateExtensionSecretResponse, type CreateGuestStarSessionParams, type CreateGuestStarSessionResponse, type CreatePollBody, type CreatePollResponse, type CreatePredictionBody, type CreatePredictionResponse, type CreateStreamMarkerBody, type CreateStreamMarkerResponse, type CreatorGoal, type CustomReward, type CustomRewardRedemption, type DeleteChannelStreamScheduleSegmentParams, type DeleteChatMessagesParams, type DeleteConduitParams, type DeleteCustomRewardParams, type DeleteEventSubSubscriptionParams, type DeleteGuestStarInviteParams, type DeleteGuestStarSlotParams, type DeleteVideosParams, type DeleteVideosResponse, type DropsEntitlement, type DropsEntitlementUpdated, type Emote, type EndGuestStarSessionParams, type EndGuestStarSessionResponse, type EndPollBody, type EndPollResponse, type EndPredictionBody, type EndPredictionResponse, type EventSubSubscription, type Extension, type ExtensionAnalytics, type ExtensionBitsProduct, type ExtensionConfigurationSegment, type ExtensionIconUrls, type ExtensionLiveChannel, type ExtensionSecret, type ExtensionTransaction, type Game, type GameAnalytics, type GetAdScheduleParams, type GetAdScheduleResponse, type GetAllStreamTagsParams, type GetAllStreamTagsResponse, type GetAutoModSettingsParams, type GetAutoModSettingsResponse, type GetBannedUsersParams, type GetBannedUsersResponse, type GetBitsLeaderboardParams, type GetBitsLeaderboardResponse, type GetBlockedTermsParams, type GetBlockedTermsResponse, type GetBroadcasterSubscriptionsParams, type GetBroadcasterSubscriptionsResponse, type GetChannelChatBadgesParams, type GetChannelChatBadgesResponse, type GetChannelEditorsParams, type GetChannelEditorsResponse, type GetChannelEmotesParams, type GetChannelEmotesResponse, type GetChannelFollowersParams, type GetChannelFollowersResponse, type GetChannelGuestStarSettingsParams, type GetChannelGuestStarSettingsResponse, type GetChannelICalendarParams, type GetChannelInformationParams, type GetChannelInformationResponse, type GetChannelStreamScheduleParams, type GetChannelStreamScheduleResponse, type GetChannelTeamsParams, type GetChannelTeamsResponse, type GetCharityCampaignDonationsParams, type GetCharityCampaignDonationsResponse, type GetCharityCampaignParams, type GetCharityCampaignResponse, type GetChatSettingsParams, type GetChatSettingsResponse, type GetChattersParams, type GetChattersResponse, type GetCheermotesParams, type GetCheermotesResponse, type GetClipsParams, type GetClipsResponse, type GetConduitShardsParams, type GetConduitShardsResponse, type GetConduitsResponse, type GetContentClassificationLabelsParams, type GetContentClassificationLabelsResponse, type GetCreatorGoalsParams, type GetCreatorGoalsResponse, type GetCustomRewardParams, type GetCustomRewardRedemptionParams, type GetCustomRewardRedemptionResponse, type GetCustomRewardResponse, type GetDropsEntitlementsParams, type GetDropsEntitlementsResponse, type GetEmoteSetsParams, type GetEmoteSetsResponse, type GetEventSubSubscriptionsParams, type GetEventSubSubscriptionsResponse, type GetExtensionAnalyticsParams, type GetExtensionAnalyticsResponse, type GetExtensionBitsProductsParams, type GetExtensionBitsProductsResponse, type GetExtensionConfigurationSegmentParams, type GetExtensionConfigurationSegmentResponse, type GetExtensionLiveChannelsParams, type GetExtensionLiveChannelsResponse, type GetExtensionSecretsResponse, type GetExtensionTransactionsParams, type GetExtensionTransactionsResponse, type GetExtensionsParams, type GetExtensionsResponse, type GetFollowedChannelsParams, type GetFollowedChannelsResponse, type GetFollowedStreamsParams, type GetFollowedStreamsResponse, type GetGameAnalyticsParams, type GetGameAnalyticsResponse, type GetGamesParams, type GetGamesResponse, type GetGlobalChatBadgesResponse, type GetGlobalEmotesResponse, type GetGuestStarInvitesParams, type GetGuestStarInvitesResponse, type GetGuestStarSessionParams, type GetGuestStarSessionResponse, type GetHypeTrainEventsParams, type GetHypeTrainEventsResponse, type GetHypeTrainStatusParams, type GetHypeTrainStatusResponse, type GetModeratedChannelsParams, type GetModeratedChannelsResponse, type GetModeratorsParams, type GetModeratorsResponse, type GetPollsParams, type GetPollsResponse, type GetPredictionsParams, type GetPredictionsResponse, type GetReleasedExtensionsParams, type GetReleasedExtensionsResponse, type GetSharedChatSessionParams, type GetSharedChatSessionResponse, type GetShieldModeStatusParams, type GetShieldModeStatusResponse, type GetStreamKeyParams, type GetStreamKeyResponse, type GetStreamMarkersParams, type GetStreamMarkersResponse, type GetStreamTagsParams, type GetStreamTagsResponse, type GetStreamsParams, type GetStreamsResponse, type GetTeamsParams, type GetTeamsResponse, type GetTopGamesParams, type GetTopGamesResponse, type GetUnbanRequestsParams, type GetUnbanRequestsResponse, type GetUserActiveExtensionsParams, type GetUserActiveExtensionsResponse, type GetUserBlockListParams, type GetUserBlockListResponse, type GetUserChatColorParams, type GetUserChatColorResponse, type GetUserEmotesParams, type GetUserEmotesResponse, type GetUserExtensionsResponse, type GetUsersParams, type GetUsersResponse, type GetVIPsParams, type GetVIPsResponse, type GetVideosParams, type GetVideosResponse, type GlobalEmote, type Guest, type GuestStarInvite, type GuestStarSession, type HypeTrainEvent, type ManageHeldAutoModMessagesBody, type ModifyChannelInformationBody, type ModifyChannelInformationParams, type Poll, type Prediction, type PredictionOutcome, type RemoveBlockedTermParams, type RemoveChannelModeratorParams, type RemoveChannelVIPParams, type ResolveUnbanRequestsParams, type ResolveUnbanRequestsResponse, type SearchCategoriesParams, type SearchCategoriesResponse, type SearchChannelsParams, type SearchChannelsResponse, type SendChatAnnouncementBody, type SendChatAnnouncementParams, type SendChatMessageBody, type SendChatMessageResponse, type SendExtensionChatMessageBody, type SendExtensionChatMessageParams, type SendExtensionPubSubMessageBody, type SendGuestStarInviteParams, type SendShoutoutParams, type SendWhisperBody, type SendWhisperParams, type SetExtensionConfigurationSegmentBody, type SetExtensionRequiredConfigurationBody, type SetExtensionRequiredConfigurationParams, type SnoozeNextAdParams, type SnoozeNextAdResponse, type StartCommercialBody, type StartCommercialResponse, type StartRaidParams, type StartRaidResponse, type Stream, type StreamMarkerCreated, type StreamMarkers, type StreamTag, type Team, TwitchApi, type TwitchApiOptions, type UnbanUserParams, type UnblockUserParams, type UpdateAutoModSettingsBody, type UpdateAutoModSettingsParams, type UpdateAutoModSettingsResponse, type UpdateChannelGuestStarSettingsBody, type UpdateChannelGuestStarSettingsParams, type UpdateChannelStreamScheduleParams, type UpdateChannelStreamScheduleSegmentBody, type UpdateChannelStreamScheduleSegmentParams, type UpdateChannelStreamScheduleSegmentResponse, type UpdateChatSettingsBody, type UpdateChatSettingsParams, type UpdateChatSettingsResponse, type UpdateConduitShardsBody, type UpdateConduitShardsResponse, type UpdateConduitsBody, type UpdateConduitsResponse, type UpdateCustomRewardBody, type UpdateCustomRewardParams, type UpdateCustomRewardResponse, type UpdateDropsEntitlementsBody, type UpdateDropsEntitlementsResponse, type UpdateExtensionBitsProductBody, type UpdateExtensionBitsProductResponse, type UpdateGuestStarSlotParams, type UpdateGuestStarSlotSettingsParams, type UpdateRedemptionStatusBody, type UpdateRedemptionStatusParams, type UpdateRedemptionStatusResponse, type UpdateShieldModeStatusBody, type UpdateShieldModeStatusParams, type UpdateShieldModeStatusResponse, type UpdateUserChatColorParams, type UpdateUserExtensionsBody, type UpdateUserExtensionsResponse, type UpdateUserParams, type UpdateUserResponse, type User, type UserBlockList, type UserChatColor, type UserExtension, type UserExtensionComponent, type UserExtensionComponentUpdate, type UserExtensionOverlay, type UserExtensionOverlayUpdate, type UserExtensionPanel, type UserExtensionPanelUpdate, type UserModerator, type UserSubscription, type UserVip, type Video, type WarnChatUserBody, type WarnChatUserParams, type WarnChatUserResponse };
|