ts-twitch-api 0.2.1 → 0.2.2
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 +131 -2
- package/dist/index.d.cts +798 -61
- package/dist/index.d.ts +798 -61
- package/dist/index.js +131 -2
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -1085,6 +1085,64 @@ interface components {
|
|
|
1085
1085
|
/** @description The list of chat settings. The list contains a single object with all the settings. */
|
|
1086
1086
|
data: components["schemas"]["ChatSettings"][];
|
|
1087
1087
|
};
|
|
1088
|
+
GetUserEmotesResponse: {
|
|
1089
|
+
data: ({
|
|
1090
|
+
/** @description An ID that uniquely identifies this emote. */
|
|
1091
|
+
id: string;
|
|
1092
|
+
/** @description The User ID of broadcaster whose channel is receiving the unban request. */
|
|
1093
|
+
name: string;
|
|
1094
|
+
/**
|
|
1095
|
+
* @description The type of emote. The possible values are:
|
|
1096
|
+
*
|
|
1097
|
+
* * **bitstier** — A Bits tier emote.
|
|
1098
|
+
* * **follower** — A follower emote.
|
|
1099
|
+
* * **subscriptions** — A subscriber emote.
|
|
1100
|
+
* @enum {string}
|
|
1101
|
+
*/
|
|
1102
|
+
emote_type: "bitstier" | "follower" | "subscriptions";
|
|
1103
|
+
/** @description An ID that identifies the emote set that the emote belongs to. */
|
|
1104
|
+
emote_set_id: string;
|
|
1105
|
+
/** @description The ID of the broadcaster who owns the emote. */
|
|
1106
|
+
owner_id: string;
|
|
1107
|
+
/**
|
|
1108
|
+
* @description The formats that the emote is available in. For example, if the emote is available only as a static PNG, the array contains only static. But if the emote is available as a static PNG and an animated GIF, the array contains static and animated.
|
|
1109
|
+
*
|
|
1110
|
+
* * **animated** — An animated GIF is available for this emote.
|
|
1111
|
+
* * **static** — A static PNG file is available for this emote.
|
|
1112
|
+
*/
|
|
1113
|
+
format: string[];
|
|
1114
|
+
/**
|
|
1115
|
+
* @description The sizes that the emote is available in. For example, if the emote is available in small and medium sizes, the array contains 1.0 and 2.0\.
|
|
1116
|
+
*
|
|
1117
|
+
* * **1.0** — A small version (28px x 28px) is available.
|
|
1118
|
+
* * **2.0** — A medium version (56px x 56px) is available.
|
|
1119
|
+
* * **3.0** — A large version (112px x 112px) is available.
|
|
1120
|
+
*/
|
|
1121
|
+
scale: string[];
|
|
1122
|
+
/**
|
|
1123
|
+
* @description The background themes that the emote is available in.
|
|
1124
|
+
*
|
|
1125
|
+
* * **dark**
|
|
1126
|
+
* * **light**
|
|
1127
|
+
*/
|
|
1128
|
+
theme_mode: string[];
|
|
1129
|
+
})[];
|
|
1130
|
+
/**
|
|
1131
|
+
* @description A templated URL. Uses the values from the _id_, _format_, _scale_, and _theme\_mode_ fields to replace the like-named placeholder strings in the templated URL to create a CDN (content delivery network) URL that you use to fetch the emote.
|
|
1132
|
+
*
|
|
1133
|
+
* For information about what the template looks like and how to use it to fetch emotes, see [Emote CDN URL](https://dev.twitch.tv/docs/irc/emotes#cdn-template) format.
|
|
1134
|
+
*/
|
|
1135
|
+
template: string;
|
|
1136
|
+
/**
|
|
1137
|
+
* @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.
|
|
1138
|
+
*
|
|
1139
|
+
* For more information about pagination support, see [Twitch API Guide - Pagination](https://dev.twitch.tv/docs/api/guide#pagination).
|
|
1140
|
+
*/
|
|
1141
|
+
pagination?: {
|
|
1142
|
+
/** @description The cursor used to get the next page of results. Use the cursor to set the request’s after query parameter. */
|
|
1143
|
+
cursor?: string;
|
|
1144
|
+
};
|
|
1145
|
+
};
|
|
1088
1146
|
UpdateChatSettingsBody: {
|
|
1089
1147
|
/**
|
|
1090
1148
|
* @description A Boolean value that determines whether chat messages must contain only emotes.
|
|
@@ -1960,7 +2018,7 @@ interface components {
|
|
|
1960
2018
|
* @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.
|
|
1961
2019
|
* @enum {string}
|
|
1962
2020
|
*/
|
|
1963
|
-
type: "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.subscribe" | "channel.subscription.end" | "channel.subscription.gift" | "channel.subscription.message" | "channel.cheer" | "channel.raid" | "channel.ban" | "channel.unban" | "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_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.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";
|
|
2021
|
+
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.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_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.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";
|
|
1964
2022
|
/** @description The version number that identifies the definition of the subscription type that you want the response to use. */
|
|
1965
2023
|
version: string;
|
|
1966
2024
|
/** @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. */
|
|
@@ -2019,7 +2077,7 @@ interface components {
|
|
|
2019
2077
|
* @description The subscription's type. See [Subscription Types](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#subscription-types).
|
|
2020
2078
|
* @enum {string}
|
|
2021
2079
|
*/
|
|
2022
|
-
type: "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.subscribe" | "channel.subscription.end" | "channel.subscription.gift" | "channel.subscription.message" | "channel.cheer" | "channel.raid" | "channel.ban" | "channel.unban" | "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_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.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";
|
|
2080
|
+
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.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_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.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";
|
|
2023
2081
|
/** @description The version number that identifies this definition of the subscription's data. */
|
|
2024
2082
|
version: string;
|
|
2025
2083
|
/** @description The subscription's parameter values. This is a string-encoded JSON object whose contents are determined by the subscription type. */
|
|
@@ -2220,11 +2278,7 @@ interface components {
|
|
|
2220
2278
|
/** @description Flag determining if Guest Star should regenerate the auth token associated with the channel’s browser sources. Providing a true value for this will immediately invalidate all browser sources previously configured in your streaming software. */
|
|
2221
2279
|
regenerate_browser_sources?: boolean;
|
|
2222
2280
|
};
|
|
2223
|
-
|
|
2224
|
-
/** @description ID uniquely representing the Guest Star session. */
|
|
2225
|
-
id: string;
|
|
2226
|
-
/** @description List of guests currently interacting with the Guest Star session. */
|
|
2227
|
-
guests: Record<string, never>;
|
|
2281
|
+
Guest: {
|
|
2228
2282
|
/**
|
|
2229
2283
|
* @description ID representing this guest’s slot assignment.
|
|
2230
2284
|
*
|
|
@@ -2271,6 +2325,12 @@ interface components {
|
|
|
2271
2325
|
is_available: boolean;
|
|
2272
2326
|
};
|
|
2273
2327
|
};
|
|
2328
|
+
GuestStarSession: {
|
|
2329
|
+
/** @description ID uniquely representing the Guest Star session. */
|
|
2330
|
+
id: string;
|
|
2331
|
+
/** @description List of guests currently interacting with the Guest Star session. */
|
|
2332
|
+
guests: components["schemas"]["Guest"][];
|
|
2333
|
+
};
|
|
2274
2334
|
GetGuestStarSessionResponse: {
|
|
2275
2335
|
/** @description Summary of the session details */
|
|
2276
2336
|
data: components["schemas"]["GuestStarSession"][];
|
|
@@ -2622,6 +2682,105 @@ interface components {
|
|
|
2622
2682
|
end_time: string | null;
|
|
2623
2683
|
})[];
|
|
2624
2684
|
};
|
|
2685
|
+
GetUnbanRequestsResponse: {
|
|
2686
|
+
/** @description A list that contains information about the channel's unban requests. */
|
|
2687
|
+
data: {
|
|
2688
|
+
/** @description Unban request ID. */
|
|
2689
|
+
id: string;
|
|
2690
|
+
/** @description User ID of broadcaster whose channel is receiving the unban request. */
|
|
2691
|
+
broadcaster_id: string;
|
|
2692
|
+
/** @description The broadcaster's display name. */
|
|
2693
|
+
broadcaster_name: string;
|
|
2694
|
+
/** @description The broadcaster's login name. */
|
|
2695
|
+
broadcaster_login: string;
|
|
2696
|
+
/** @description User ID of moderator who approved/denied the request. */
|
|
2697
|
+
moderator_id: string;
|
|
2698
|
+
/** @description The moderator's login name. */
|
|
2699
|
+
moderator_login: string;
|
|
2700
|
+
/** @description The moderator's display name. */
|
|
2701
|
+
moderator_name: string;
|
|
2702
|
+
/** @description User ID of the requestor who is asking for an unban. */
|
|
2703
|
+
user_id: string;
|
|
2704
|
+
/** @description The user's login name. */
|
|
2705
|
+
user_login: string;
|
|
2706
|
+
/** @description The user's display name. */
|
|
2707
|
+
user_name: string;
|
|
2708
|
+
/** @description Text of the request from the requesting user. */
|
|
2709
|
+
text: string;
|
|
2710
|
+
/**
|
|
2711
|
+
* @description Status of the request. One of:
|
|
2712
|
+
*
|
|
2713
|
+
* * pending
|
|
2714
|
+
* * approved
|
|
2715
|
+
* * denied
|
|
2716
|
+
* * acknowledged
|
|
2717
|
+
* * canceled
|
|
2718
|
+
*/
|
|
2719
|
+
status: string;
|
|
2720
|
+
/**
|
|
2721
|
+
* Format: date-time
|
|
2722
|
+
* @description Timestamp of when the unban request was created.
|
|
2723
|
+
*/
|
|
2724
|
+
created_at: string;
|
|
2725
|
+
/**
|
|
2726
|
+
* Format: date-time
|
|
2727
|
+
* @description Timestamp of when moderator/broadcaster approved or denied the request.
|
|
2728
|
+
*/
|
|
2729
|
+
resolved_at: string;
|
|
2730
|
+
/** @description Text input by the resolver (moderator) of the unban. request */
|
|
2731
|
+
resolution_text: string;
|
|
2732
|
+
}[];
|
|
2733
|
+
/** @description Contains information used to page through a list of results. The object is empty if there are no more pages left to page through. */
|
|
2734
|
+
pagination?: {
|
|
2735
|
+
/** @description The cursor used to get the next page of results. Use the cursor to set the request’s after query parameter. */
|
|
2736
|
+
cursor?: string;
|
|
2737
|
+
};
|
|
2738
|
+
};
|
|
2739
|
+
ResolveUnbanRequestsResponse: {
|
|
2740
|
+
data: {
|
|
2741
|
+
/** @description Unban request ID. */
|
|
2742
|
+
id: string;
|
|
2743
|
+
/** @description User ID of broadcaster whose channel is receiving the unban request. */
|
|
2744
|
+
broadcaster_id: string;
|
|
2745
|
+
/** @description The broadcaster's display name. */
|
|
2746
|
+
broadcaster_name: string;
|
|
2747
|
+
/** @description The broadcaster's login name. */
|
|
2748
|
+
broadcaster_login: string;
|
|
2749
|
+
/** @description User ID of moderator who approved/denied the request. */
|
|
2750
|
+
moderator_id: string;
|
|
2751
|
+
/** @description The moderator's login name. */
|
|
2752
|
+
moderator_login: string;
|
|
2753
|
+
/** @description The moderator's display name. */
|
|
2754
|
+
moderator_name: string;
|
|
2755
|
+
/** @description User ID of the requestor who is asking for an unban. */
|
|
2756
|
+
user_id: string;
|
|
2757
|
+
/** @description The user's login name. */
|
|
2758
|
+
user_login: string;
|
|
2759
|
+
/** @description The user's display name */
|
|
2760
|
+
user_name: string;
|
|
2761
|
+
/** @description Text of the request from the requesting user. */
|
|
2762
|
+
text: string;
|
|
2763
|
+
/**
|
|
2764
|
+
* @description Status of the request. One of:
|
|
2765
|
+
*
|
|
2766
|
+
* * approved
|
|
2767
|
+
* * denied
|
|
2768
|
+
*/
|
|
2769
|
+
status: string;
|
|
2770
|
+
/**
|
|
2771
|
+
* Format: date-time
|
|
2772
|
+
* @description Timestamp of when the unban request was created.
|
|
2773
|
+
*/
|
|
2774
|
+
created_at: string;
|
|
2775
|
+
/**
|
|
2776
|
+
* Format: date-time
|
|
2777
|
+
* @description Timestamp of when moderator/broadcaster approved or denied the request.
|
|
2778
|
+
*/
|
|
2779
|
+
resolved_at: string;
|
|
2780
|
+
/** @description Text input by the resolver (moderator) of the unban request. */
|
|
2781
|
+
resolution_text: string;
|
|
2782
|
+
}[];
|
|
2783
|
+
};
|
|
2625
2784
|
BlockedTerm: {
|
|
2626
2785
|
/** @description The broadcaster that owns the list of blocked terms. */
|
|
2627
2786
|
broadcaster_id: string;
|
|
@@ -2840,11 +2999,11 @@ interface components {
|
|
|
2840
2999
|
ended_at: string | null;
|
|
2841
3000
|
};
|
|
2842
3001
|
GetPollsResponse: {
|
|
2843
|
-
/** @description A list of polls. The polls are returned in descending order of start time unless you specify IDs in the request, in which case they
|
|
3002
|
+
/** @description A list of polls. The polls are returned in descending order of start time unless you specify IDs in the request, in which case they're returned in the same order as you passed them in the request. The list is empty if the broadcaster hasn't created polls. */
|
|
2844
3003
|
data: components["schemas"]["Poll"][];
|
|
2845
3004
|
/** @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) */
|
|
2846
3005
|
pagination?: {
|
|
2847
|
-
/** @description The cursor used to get the next page of results. Use the cursor to set the request
|
|
3006
|
+
/** @description The cursor used to get the next page of results. Use the cursor to set the request's _after_ query parameter. */
|
|
2848
3007
|
cursor?: string;
|
|
2849
3008
|
};
|
|
2850
3009
|
};
|
|
@@ -3596,7 +3755,7 @@ interface components {
|
|
|
3596
3755
|
/**
|
|
3597
3756
|
* @description The type of broadcaster. Possible values are:
|
|
3598
3757
|
*
|
|
3599
|
-
* * affiliate — An [affiliate broadcaster](https://help.twitch.tv/s/article/joining-the-affiliate-program
|
|
3758
|
+
* * affiliate — An [affiliate broadcaster](https://help.twitch.tv/s/article/joining-the-affiliate-program)
|
|
3600
3759
|
* * partner — A [partner broadcaster](https://help.twitch.tv/s/article/partner-program-overview)
|
|
3601
3760
|
* * "" — A normal broadcaster
|
|
3602
3761
|
* @enum {string}
|
|
@@ -5503,6 +5662,52 @@ interface operations {
|
|
|
5503
5662
|
};
|
|
5504
5663
|
};
|
|
5505
5664
|
};
|
|
5665
|
+
/**
|
|
5666
|
+
* BETA Retrieves emotes available to the user across all channels.
|
|
5667
|
+
* @description BETA Retrieves emotes available to the user across all channels.
|
|
5668
|
+
*
|
|
5669
|
+
* __Authorization:__
|
|
5670
|
+
*
|
|
5671
|
+
* * Requires a user access token that includes the **user:read:emotes** scope.
|
|
5672
|
+
* * Query parameter `user_id` must match the `user_id` in the user access token.
|
|
5673
|
+
*/
|
|
5674
|
+
"get-user-emotes": {
|
|
5675
|
+
parameters: {
|
|
5676
|
+
query: {
|
|
5677
|
+
/** @description The ID of the user. This ID must match the user ID in the user access token. */
|
|
5678
|
+
user_id: string;
|
|
5679
|
+
/** @description Returns all emotes available to the user within the chat owned by the specified broadcaster. This includes the Global and Subscriber Emotes the user has access to, as well as channel-only specific emotes such as Follower Emotes. */
|
|
5680
|
+
broadcaster_id?: string;
|
|
5681
|
+
/** @description The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value. */
|
|
5682
|
+
after?: string;
|
|
5683
|
+
};
|
|
5684
|
+
};
|
|
5685
|
+
responses: {
|
|
5686
|
+
/** @description Successfully retrieved the emotes. */
|
|
5687
|
+
200: {
|
|
5688
|
+
content: {
|
|
5689
|
+
"application/json": components["schemas"]["GetUserEmotesResponse"];
|
|
5690
|
+
};
|
|
5691
|
+
};
|
|
5692
|
+
/**
|
|
5693
|
+
* @description * The _user\_id_ query parameter is required.
|
|
5694
|
+
* * The ID in the _user\_id_ query parameter is not valid.
|
|
5695
|
+
*/
|
|
5696
|
+
400: {
|
|
5697
|
+
content: never;
|
|
5698
|
+
};
|
|
5699
|
+
/**
|
|
5700
|
+
* @description * The ID in _user\_id_ must match the user ID in the user access token.
|
|
5701
|
+
* * The Authorization header is required and must contain a user access token.
|
|
5702
|
+
* * The user access token must include the **user:read:emotes** scope.
|
|
5703
|
+
* * The access token is not valid.
|
|
5704
|
+
* * The client ID specified in the Client-Id header does not match the client ID specified in the access token.
|
|
5705
|
+
*/
|
|
5706
|
+
401: {
|
|
5707
|
+
content: never;
|
|
5708
|
+
};
|
|
5709
|
+
};
|
|
5710
|
+
};
|
|
5506
5711
|
/**
|
|
5507
5712
|
* Sends an announcement to the broadcaster’s chat room.
|
|
5508
5713
|
* @description Sends an announcement to the broadcaster’s chat room.
|
|
@@ -6214,6 +6419,8 @@ interface operations {
|
|
|
6214
6419
|
* Gets an organization’s list of entitlements that have been granted to a game, a user, or both.
|
|
6215
6420
|
* @description Gets an organization’s list of entitlements that have been granted to a game, a user, or both.
|
|
6216
6421
|
*
|
|
6422
|
+
* **NOTE:** Entitlements returned in the response body data are not guaranteed to be sorted by any field returned by the API. To retrieve **CLAIMED** or **FULFILLED** entitlements, use the `fulfillment_status` query parameter to filter results. To retrieve entitlements for a specific game, use the `game_id` query parameter to filter results.
|
|
6423
|
+
*
|
|
6217
6424
|
* The following table identifies the request parameters that you may specify based on the type of access token used.
|
|
6218
6425
|
*
|
|
6219
6426
|
* | Access token type | Parameter | Description |
|
|
@@ -6962,7 +7169,7 @@ interface operations {
|
|
|
6962
7169
|
*
|
|
6963
7170
|
* __Authorization:__
|
|
6964
7171
|
*
|
|
6965
|
-
* If you use [
|
|
7172
|
+
* 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.
|
|
6966
7173
|
*
|
|
6967
7174
|
* 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.
|
|
6968
7175
|
*
|
|
@@ -6995,7 +7202,7 @@ interface operations {
|
|
|
6995
7202
|
*/
|
|
6996
7203
|
status?: "enabled" | "webhook_callback_verification_pending" | "webhook_callback_verification_failed" | "notification_failures_exceeded" | "authorization_revoked" | "moderator_removed" | "user_removed" | "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";
|
|
6997
7204
|
/** @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). */
|
|
6998
|
-
type?: "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.subscribe" | "channel.subscription.end" | "channel.subscription.gift" | "channel.subscription.message" | "channel.cheer" | "channel.raid" | "channel.ban" | "channel.unban" | "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_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.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";
|
|
7205
|
+
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.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_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.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";
|
|
6999
7206
|
/** @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). */
|
|
7000
7207
|
user_id?: string;
|
|
7001
7208
|
/** @description The cursor used to get the next page of results. The `pagination` object in the response contains the cursor's value. */
|
|
@@ -8398,7 +8605,7 @@ interface operations {
|
|
|
8398
8605
|
* Removes a ban or timeout from a user.
|
|
8399
8606
|
*
|
|
8400
8607
|
* ```bash
|
|
8401
|
-
* curl -X DELETE 'https://api.twitch.tv/helix/moderation/bans?broadcaster_id=1234&moderator_id=5678&user_id=
|
|
8608
|
+
* curl -X DELETE 'https://api.twitch.tv/helix/moderation/bans?broadcaster_id=1234&moderator_id=5678&user_id=5432' \
|
|
8402
8609
|
* -H 'Authorization: Bearer 4a4x78f5wqvkybms7mxfist3jmzul' \
|
|
8403
8610
|
* -H 'Client-Id: t214nt8z1rdtbj69hyarjvh5mi6fh'
|
|
8404
8611
|
* ```
|
|
@@ -8441,6 +8648,133 @@ interface operations {
|
|
|
8441
8648
|
};
|
|
8442
8649
|
};
|
|
8443
8650
|
};
|
|
8651
|
+
/**
|
|
8652
|
+
* BETA Gets a list of unban requests for a broadcaster’s channel.
|
|
8653
|
+
* @description BETA Gets a list of unban requests for a broadcaster’s channel.
|
|
8654
|
+
*
|
|
8655
|
+
* __Authorization:__
|
|
8656
|
+
*
|
|
8657
|
+
* * Requires a user access token that includes the **moderator:read:unban\_requests** or **moderator:manage:unban\_requests** scope.
|
|
8658
|
+
* * Query parameter `moderator_id` must match the `user_id` in the [user access token](https://dev.twitch.tv/docs/authentication/#user-access-tokens).
|
|
8659
|
+
*/
|
|
8660
|
+
"get-unban-requests": {
|
|
8661
|
+
parameters: {
|
|
8662
|
+
query: {
|
|
8663
|
+
/** @description The ID of the broadcaster whose channel is receiving unban requests. */
|
|
8664
|
+
broadcaster_id: string;
|
|
8665
|
+
/** @description The ID of the broadcaster or a user that has permission to moderate the broadcaster’s unban requests. This ID must match the user ID in the user access token. */
|
|
8666
|
+
moderator_id: string;
|
|
8667
|
+
/**
|
|
8668
|
+
* @description Filter by a status.
|
|
8669
|
+
*
|
|
8670
|
+
* * pending
|
|
8671
|
+
* * approved
|
|
8672
|
+
* * denied
|
|
8673
|
+
* * acknowledged
|
|
8674
|
+
* * canceled
|
|
8675
|
+
*/
|
|
8676
|
+
status: string;
|
|
8677
|
+
/** @description The ID used to filter what unban requests are returned. */
|
|
8678
|
+
user_id?: string;
|
|
8679
|
+
/** @description Cursor used to get next page of results. Pagination object in response contains cursor value. */
|
|
8680
|
+
after?: string;
|
|
8681
|
+
/** @description The maximum number of items to return per page in response */
|
|
8682
|
+
first?: number;
|
|
8683
|
+
};
|
|
8684
|
+
};
|
|
8685
|
+
responses: {
|
|
8686
|
+
/** @description Successfully retrieved the list of unban requests. */
|
|
8687
|
+
200: {
|
|
8688
|
+
content: {
|
|
8689
|
+
"application/json": components["schemas"]["GetUnbanRequestsResponse"];
|
|
8690
|
+
};
|
|
8691
|
+
};
|
|
8692
|
+
/**
|
|
8693
|
+
* @description * The _broadcaster\_id_ query parameter is required.
|
|
8694
|
+
* * The ID in the _broadcaster\_id_ query parameter is not valid.
|
|
8695
|
+
* * The _moderator\_id_ query parameter is required.
|
|
8696
|
+
* * The ID in the _moderator\_id_ query parameter is not valid.
|
|
8697
|
+
* * The pagination cursor is not valid.
|
|
8698
|
+
*/
|
|
8699
|
+
400: {
|
|
8700
|
+
content: never;
|
|
8701
|
+
};
|
|
8702
|
+
/**
|
|
8703
|
+
* @description * The ID in _moderator\_id_ must match the user ID in the user access token.
|
|
8704
|
+
* * The Authorization header is required and must contain a user access token.
|
|
8705
|
+
* * The user access token must include the **moderator:read:unban\_requests** or **moderator:manage:unban\_requests** scope.
|
|
8706
|
+
* * The access token is not valid.
|
|
8707
|
+
* * The client ID specified in the Client-Id header does not match the client ID specified in the access token.
|
|
8708
|
+
*/
|
|
8709
|
+
401: {
|
|
8710
|
+
content: never;
|
|
8711
|
+
};
|
|
8712
|
+
};
|
|
8713
|
+
};
|
|
8714
|
+
/**
|
|
8715
|
+
* BETA Resolves an unban request by approving or denying it.
|
|
8716
|
+
* @description BETA Resolves an unban request by approving or denying it.
|
|
8717
|
+
*
|
|
8718
|
+
* __Authorization:__
|
|
8719
|
+
*
|
|
8720
|
+
* * Requires a user access token that includes the **moderator:manage:unban\_requests** scope.
|
|
8721
|
+
* * Query parameter `moderator_id` must match the `user_id` in the [user access token](https://dev.twitch.tv/docs/authentication/#user-access-tokens).
|
|
8722
|
+
*/
|
|
8723
|
+
"resolve-unban-requests": {
|
|
8724
|
+
parameters: {
|
|
8725
|
+
query: {
|
|
8726
|
+
/** @description The ID of the broadcaster whose channel is approving or denying the unban request. */
|
|
8727
|
+
broadcaster_id: string;
|
|
8728
|
+
/** @description The ID of the broadcaster or a user that has permission to moderate the broadcaster’s unban requests. This ID must match the user ID in the user access token. */
|
|
8729
|
+
moderator_id: string;
|
|
8730
|
+
/** @description The UUID of the unban request. */
|
|
8731
|
+
unban_request_id: string;
|
|
8732
|
+
/**
|
|
8733
|
+
* @description Resolution status.
|
|
8734
|
+
*
|
|
8735
|
+
* * approved
|
|
8736
|
+
* * denied
|
|
8737
|
+
*/
|
|
8738
|
+
status: string;
|
|
8739
|
+
/** @description Message supplied by the unban request resolver */
|
|
8740
|
+
resolution_text?: string;
|
|
8741
|
+
};
|
|
8742
|
+
};
|
|
8743
|
+
responses: {
|
|
8744
|
+
/** @description Successfully resolved the unban request. */
|
|
8745
|
+
200: {
|
|
8746
|
+
content: {
|
|
8747
|
+
"application/json": components["schemas"]["ResolveUnbanRequestsResponse"];
|
|
8748
|
+
};
|
|
8749
|
+
};
|
|
8750
|
+
/**
|
|
8751
|
+
* @description * The _broadcaster\_id_ query parameter is required.
|
|
8752
|
+
* * The ID in the _broadcaster\_id_ query parameter is not valid.
|
|
8753
|
+
* * The _moderator\_id_ query parameter is required.
|
|
8754
|
+
* * The ID in the _moderator\_id_ query parameter is not valid.
|
|
8755
|
+
* * The pagination cursor is not valid.
|
|
8756
|
+
* * The broadcaster is not receiving unban requests
|
|
8757
|
+
* * Invalid requested update
|
|
8758
|
+
*/
|
|
8759
|
+
400: {
|
|
8760
|
+
content: never;
|
|
8761
|
+
};
|
|
8762
|
+
/**
|
|
8763
|
+
* @description * The ID in _moderator\_id_ must match the user ID in the user access token.
|
|
8764
|
+
* * The Authorization header is required and must contain a user access token.
|
|
8765
|
+
* * The user access token must include the **moderator:manage:unban\_requests** scope.
|
|
8766
|
+
* * The access token is not valid.
|
|
8767
|
+
* * The client ID specified in the Client-Id header does not match the client ID specified in the access token.
|
|
8768
|
+
*/
|
|
8769
|
+
401: {
|
|
8770
|
+
content: never;
|
|
8771
|
+
};
|
|
8772
|
+
/** @description The unban request ID was not found. */
|
|
8773
|
+
404: {
|
|
8774
|
+
content: never;
|
|
8775
|
+
};
|
|
8776
|
+
};
|
|
8777
|
+
};
|
|
8444
8778
|
/**
|
|
8445
8779
|
* Gets the broadcaster’s list of non-private, blocked words or phrases.
|
|
8446
8780
|
* @description Gets the broadcaster’s list of non-private, blocked words or phrases. These are the terms that the broadcaster or moderator added manually or that were denied by AutoMod.
|
|
@@ -9253,7 +9587,7 @@ interface operations {
|
|
|
9253
9587
|
};
|
|
9254
9588
|
};
|
|
9255
9589
|
responses: {
|
|
9256
|
-
/** @description Successfully retrieved the broadcaster
|
|
9590
|
+
/** @description Successfully retrieved the broadcaster's polls. */
|
|
9257
9591
|
200: {
|
|
9258
9592
|
content: {
|
|
9259
9593
|
"application/json": components["schemas"]["GetPollsResponse"];
|
|
@@ -11276,6 +11610,7 @@ type GetEmoteSetsParams = ParamsSchema<'get-emote-sets'>;
|
|
|
11276
11610
|
type GetChannelChatBadgesParams = ParamsSchema<'get-channel-chat-badges'>;
|
|
11277
11611
|
type GetChatSettingsParams = ParamsSchema<'get-chat-settings'>;
|
|
11278
11612
|
type UpdateChatSettingsParams = ParamsSchema<'update-chat-settings'>;
|
|
11613
|
+
type GetUserEmotesParams = ParamsSchema<'get-user-emotes'>;
|
|
11279
11614
|
type SendChatAnnouncementParams = ParamsSchema<'send-chat-announcement'>;
|
|
11280
11615
|
type SendShoutoutParams = ParamsSchema<'send-a-shoutout'>;
|
|
11281
11616
|
type GetUserChatColorParams = ParamsSchema<'get-user-chat-color'>;
|
|
@@ -11318,6 +11653,8 @@ type UpdateAutoModSettingsParams = ParamsSchema<'update-automod-settings'>;
|
|
|
11318
11653
|
type GetBannedUsersParams = ParamsSchema<'get-banned-users'>;
|
|
11319
11654
|
type BanUserParams = ParamsSchema<'ban-user'>;
|
|
11320
11655
|
type UnbanUserParams = ParamsSchema<'unban-user'>;
|
|
11656
|
+
type GetUnbanRequestsParams = ParamsSchema<'get-unban-requests'>;
|
|
11657
|
+
type ResolveUnbanRequestsParams = ParamsSchema<'resolve-unban-requests'>;
|
|
11321
11658
|
type GetBlockedTermsParams = ParamsSchema<'get-blocked-terms'>;
|
|
11322
11659
|
type AddBlockedTermParams = ParamsSchema<'add-blocked-term'>;
|
|
11323
11660
|
type RemoveBlockedTermParams = ParamsSchema<'remove-blocked-term'>;
|
|
@@ -11413,6 +11750,7 @@ type GetChannelChatBadgesResponse = Schema<'GetChannelChatBadgesResponse'>;
|
|
|
11413
11750
|
type GetGlobalChatBadgesResponse = Schema<'GetGlobalChatBadgesResponse'>;
|
|
11414
11751
|
type ChatSettings = Schema<'ChatSettings'>;
|
|
11415
11752
|
type GetChatSettingsResponse = Schema<'GetChatSettingsResponse'>;
|
|
11753
|
+
type GetUserEmotesResponse = Schema<'GetUserEmotesResponse'>;
|
|
11416
11754
|
type UpdateChatSettingsBody = Schema<'UpdateChatSettingsBody'>;
|
|
11417
11755
|
type ChatSettingsUpdated = Schema<'ChatSettingsUpdated'>;
|
|
11418
11756
|
type UpdateChatSettingsResponse = Schema<'UpdateChatSettingsResponse'>;
|
|
@@ -11469,6 +11807,7 @@ type CreatorGoal = Schema<'CreatorGoal'>;
|
|
|
11469
11807
|
type GetCreatorGoalsResponse = Schema<'GetCreatorGoalsResponse'>;
|
|
11470
11808
|
type GetChannelGuestStarSettingsResponse = Schema<'GetChannelGuestStarSettingsResponse'>;
|
|
11471
11809
|
type UpdateChannelGuestStarSettingsBody = Schema<'UpdateChannelGuestStarSettingsBody'>;
|
|
11810
|
+
type Guest = Schema<'Guest'>;
|
|
11472
11811
|
type GuestStarSession = Schema<'GuestStarSession'>;
|
|
11473
11812
|
type GetGuestStarSessionResponse = Schema<'GetGuestStarSessionResponse'>;
|
|
11474
11813
|
type CreateGuestStarSessionResponse = Schema<'CreateGuestStarSessionResponse'>;
|
|
@@ -11489,6 +11828,8 @@ type BannedUser = Schema<'BannedUser'>;
|
|
|
11489
11828
|
type GetBannedUsersResponse = Schema<'GetBannedUsersResponse'>;
|
|
11490
11829
|
type BanUserBody = Schema<'BanUserBody'>;
|
|
11491
11830
|
type BanUserResponse = Schema<'BanUserResponse'>;
|
|
11831
|
+
type GetUnbanRequestsResponse = Schema<'GetUnbanRequestsResponse'>;
|
|
11832
|
+
type ResolveUnbanRequestsResponse = Schema<'ResolveUnbanRequestsResponse'>;
|
|
11492
11833
|
type BlockedTerm = Schema<'BlockedTerm'>;
|
|
11493
11834
|
type GetBlockedTermsResponse = Schema<'GetBlockedTermsResponse'>;
|
|
11494
11835
|
type AddBlockedTermBody = Schema<'AddBlockedTermBody'>;
|
|
@@ -12776,7 +13117,42 @@ declare class TwitchApi {
|
|
|
12776
13117
|
data: {
|
|
12777
13118
|
broadcaster_id: string;
|
|
12778
13119
|
broadcaster_login: string;
|
|
12779
|
-
broadcaster_name: string;
|
|
13120
|
+
broadcaster_name: string; /**
|
|
13121
|
+
* 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.
|
|
13122
|
+
*
|
|
13123
|
+
* __Authorization:__
|
|
13124
|
+
*
|
|
13125
|
+
* Requires an [app access token](https://dev.twitch.tv/docs/authentication#app-access-tokens). The client ID in the app access token must match the extension’s client ID.
|
|
13126
|
+
*
|
|
13127
|
+
* __URL:__
|
|
13128
|
+
*
|
|
13129
|
+
* `PUT https://api.twitch.tv/helix/bits/extensions`
|
|
13130
|
+
*
|
|
13131
|
+
* __Response Codes:__
|
|
13132
|
+
*
|
|
13133
|
+
* _200 OK_
|
|
13134
|
+
*
|
|
13135
|
+
* Successfully created the product.
|
|
13136
|
+
*
|
|
13137
|
+
* _400 Bad Request_
|
|
13138
|
+
*
|
|
13139
|
+
* * The `sku` field is required.
|
|
13140
|
+
* * The value in the `sku` field is not valid. The SKU may contain only alphanumeric characters, dashes (-), underscores (\_), and periods (.).
|
|
13141
|
+
* * The `cost` object's `amount` field is required.
|
|
13142
|
+
* * The value in the `cost` object's `amount` field is not valid.
|
|
13143
|
+
* * The `cost` object's `type` field is required.
|
|
13144
|
+
* * The value in the `cost` object's `type` field is not valid.
|
|
13145
|
+
* * The `display_name` field is required.
|
|
13146
|
+
* * The ID in the Client-Id header must belong to the extension.
|
|
13147
|
+
*
|
|
13148
|
+
* _401 Unauthorized_
|
|
13149
|
+
*
|
|
13150
|
+
* * The Authorization header is required and must specify an app access token; you may not specify a user access token.
|
|
13151
|
+
* * The OAuth token is not valid.
|
|
13152
|
+
* * The ID in the Client-Id header must match the Client ID in the OAuth token.
|
|
13153
|
+
*
|
|
13154
|
+
* @see https://dev.twitch.tv/docs/api/reference#update-extension-bits-product
|
|
13155
|
+
*/
|
|
12780
13156
|
id: string;
|
|
12781
13157
|
user_id: string;
|
|
12782
13158
|
user_name: string;
|
|
@@ -12849,7 +13225,42 @@ declare class TwitchApi {
|
|
|
12849
13225
|
data: {
|
|
12850
13226
|
broadcaster_id: string;
|
|
12851
13227
|
broadcaster_login: string;
|
|
12852
|
-
broadcaster_name: string;
|
|
13228
|
+
broadcaster_name: string; /**
|
|
13229
|
+
* 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.
|
|
13230
|
+
*
|
|
13231
|
+
* __Authorization:__
|
|
13232
|
+
*
|
|
13233
|
+
* Requires an [app access token](https://dev.twitch.tv/docs/authentication#app-access-tokens). The client ID in the app access token must match the extension’s client ID.
|
|
13234
|
+
*
|
|
13235
|
+
* __URL:__
|
|
13236
|
+
*
|
|
13237
|
+
* `PUT https://api.twitch.tv/helix/bits/extensions`
|
|
13238
|
+
*
|
|
13239
|
+
* __Response Codes:__
|
|
13240
|
+
*
|
|
13241
|
+
* _200 OK_
|
|
13242
|
+
*
|
|
13243
|
+
* Successfully created the product.
|
|
13244
|
+
*
|
|
13245
|
+
* _400 Bad Request_
|
|
13246
|
+
*
|
|
13247
|
+
* * The `sku` field is required.
|
|
13248
|
+
* * The value in the `sku` field is not valid. The SKU may contain only alphanumeric characters, dashes (-), underscores (\_), and periods (.).
|
|
13249
|
+
* * The `cost` object's `amount` field is required.
|
|
13250
|
+
* * The value in the `cost` object's `amount` field is not valid.
|
|
13251
|
+
* * The `cost` object's `type` field is required.
|
|
13252
|
+
* * The value in the `cost` object's `type` field is not valid.
|
|
13253
|
+
* * The `display_name` field is required.
|
|
13254
|
+
* * The ID in the Client-Id header must belong to the extension.
|
|
13255
|
+
*
|
|
13256
|
+
* _401 Unauthorized_
|
|
13257
|
+
*
|
|
13258
|
+
* * The Authorization header is required and must specify an app access token; you may not specify a user access token.
|
|
13259
|
+
* * The OAuth token is not valid.
|
|
13260
|
+
* * The ID in the Client-Id header must match the Client ID in the OAuth token.
|
|
13261
|
+
*
|
|
13262
|
+
* @see https://dev.twitch.tv/docs/api/reference#update-extension-bits-product
|
|
13263
|
+
*/
|
|
12853
13264
|
id: string;
|
|
12854
13265
|
user_id: string;
|
|
12855
13266
|
user_name: string;
|
|
@@ -13465,6 +13876,63 @@ declare class TwitchApi {
|
|
|
13465
13876
|
}[];
|
|
13466
13877
|
};
|
|
13467
13878
|
}>;
|
|
13879
|
+
/**
|
|
13880
|
+
* BETA Retrieves emotes available to the user across all channels.
|
|
13881
|
+
*
|
|
13882
|
+
* __Authorization:__
|
|
13883
|
+
*
|
|
13884
|
+
* * Requires a user access token that includes the **user:read:emotes** scope.
|
|
13885
|
+
* * Query parameter `user_id` must match the `user_id` in the user access token.
|
|
13886
|
+
*
|
|
13887
|
+
* __URL:__
|
|
13888
|
+
*
|
|
13889
|
+
* `GET https://api.twitch.tv/helix/chat/emotes/user`
|
|
13890
|
+
*
|
|
13891
|
+
* __Response Codes:__
|
|
13892
|
+
*
|
|
13893
|
+
* _200 OK_
|
|
13894
|
+
*
|
|
13895
|
+
* Successfully retrieved the emotes.
|
|
13896
|
+
*
|
|
13897
|
+
* _400 Bad Request_
|
|
13898
|
+
*
|
|
13899
|
+
* * The _user\_id_ query parameter is required.
|
|
13900
|
+
* * The ID in the _user\_id_ query parameter is not valid.
|
|
13901
|
+
*
|
|
13902
|
+
* _401 Unauthorized_
|
|
13903
|
+
*
|
|
13904
|
+
* * The ID in _user\_id_ must match the user ID in the user access token.
|
|
13905
|
+
* * The Authorization header is required and must contain a user access token.
|
|
13906
|
+
* * The user access token must include the **user:read:emotes** scope.
|
|
13907
|
+
* * The access token is not valid.
|
|
13908
|
+
* * The client ID specified in the Client-Id header does not match the client ID specified in the access token.
|
|
13909
|
+
*
|
|
13910
|
+
* @see https://dev.twitch.tv/docs/api/reference#get-user-emotes
|
|
13911
|
+
*/
|
|
13912
|
+
getUserEmotes: (params: GetUserEmotesParams, options?: CallApiOptions['options']) => Promise<{
|
|
13913
|
+
ok: false;
|
|
13914
|
+
status: 400 | 401;
|
|
13915
|
+
data: unknown;
|
|
13916
|
+
} | {
|
|
13917
|
+
ok: true;
|
|
13918
|
+
status: 200;
|
|
13919
|
+
data: {
|
|
13920
|
+
data: {
|
|
13921
|
+
id: string;
|
|
13922
|
+
name: string;
|
|
13923
|
+
emote_type: "bitstier" | "follower" | "subscriptions";
|
|
13924
|
+
emote_set_id: string;
|
|
13925
|
+
owner_id: string;
|
|
13926
|
+
format: string[];
|
|
13927
|
+
scale: string[];
|
|
13928
|
+
theme_mode: string[];
|
|
13929
|
+
}[];
|
|
13930
|
+
template: string;
|
|
13931
|
+
pagination?: {
|
|
13932
|
+
cursor?: string;
|
|
13933
|
+
};
|
|
13934
|
+
};
|
|
13935
|
+
}>;
|
|
13468
13936
|
/**
|
|
13469
13937
|
* Sends an announcement to the broadcaster’s chat room.
|
|
13470
13938
|
*
|
|
@@ -13835,7 +14303,37 @@ declare class TwitchApi {
|
|
|
13835
14303
|
creator_id: string;
|
|
13836
14304
|
creator_name: string;
|
|
13837
14305
|
video_id: string;
|
|
13838
|
-
game_id: string;
|
|
14306
|
+
game_id: string; /**
|
|
14307
|
+
* Gets all users that the broadcaster banned or put in a timeout.
|
|
14308
|
+
*
|
|
14309
|
+
* __Authorization:__
|
|
14310
|
+
*
|
|
14311
|
+
* Requires a [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens) that includes the **moderation:read** or **moderator:manage:banned\_users** scope.
|
|
14312
|
+
*
|
|
14313
|
+
* __URL:__
|
|
14314
|
+
*
|
|
14315
|
+
* `GET https://api.twitch.tv/helix/moderation/banned`
|
|
14316
|
+
*
|
|
14317
|
+
* __Response Codes:__
|
|
14318
|
+
*
|
|
14319
|
+
* _200 OK_
|
|
14320
|
+
*
|
|
14321
|
+
* Successfully retrieved the list of banned users.
|
|
14322
|
+
*
|
|
14323
|
+
* _400 Bad Request_
|
|
14324
|
+
*
|
|
14325
|
+
* * The _broadcaster\_id_ query parameter is required.
|
|
14326
|
+
*
|
|
14327
|
+
* _401 Unauthorized_
|
|
14328
|
+
*
|
|
14329
|
+
* * The ID in _broadcaster\_id_ must match the user ID in the user access token.
|
|
14330
|
+
* * The Authorization header is required and must contain a user access token.
|
|
14331
|
+
* * The user access token must include the **moderation:read** scope.
|
|
14332
|
+
* * The access token is not valid.
|
|
14333
|
+
* * The client ID specified in the Client-Id header does not match the client ID specified in the access token.
|
|
14334
|
+
*
|
|
14335
|
+
* @see https://dev.twitch.tv/docs/api/reference#get-banned-users
|
|
14336
|
+
*/
|
|
13839
14337
|
language: string;
|
|
13840
14338
|
title: string;
|
|
13841
14339
|
view_count: number;
|
|
@@ -14071,7 +14569,42 @@ declare class TwitchApi {
|
|
|
14071
14569
|
session_id?: string;
|
|
14072
14570
|
connected_at?: string;
|
|
14073
14571
|
disconnected_at?: string;
|
|
14074
|
-
};
|
|
14572
|
+
}; /**
|
|
14573
|
+
* BETA Gets a list of unban requests for a broadcaster’s channel.
|
|
14574
|
+
*
|
|
14575
|
+
* __Authorization:__
|
|
14576
|
+
*
|
|
14577
|
+
* * Requires a user access token that includes the **moderator:read:unban\_requests** or **moderator:manage:unban\_requests** scope.
|
|
14578
|
+
* * Query parameter `moderator_id` must match the `user_id` in the [user access token](https://dev.twitch.tv/docs/authentication/#user-access-tokens).
|
|
14579
|
+
*
|
|
14580
|
+
* __URL:__
|
|
14581
|
+
*
|
|
14582
|
+
* `GET https://api.twitch.tv/helix/moderation/unban_requests`
|
|
14583
|
+
*
|
|
14584
|
+
* __Response Codes:__
|
|
14585
|
+
*
|
|
14586
|
+
* _200 OK_
|
|
14587
|
+
*
|
|
14588
|
+
* Successfully retrieved the list of unban requests.
|
|
14589
|
+
*
|
|
14590
|
+
* _400 Bad Request_
|
|
14591
|
+
*
|
|
14592
|
+
* * The _broadcaster\_id_ query parameter is required.
|
|
14593
|
+
* * The ID in the _broadcaster\_id_ query parameter is not valid.
|
|
14594
|
+
* * The _moderator\_id_ query parameter is required.
|
|
14595
|
+
* * The ID in the _moderator\_id_ query parameter is not valid.
|
|
14596
|
+
* * The pagination cursor is not valid.
|
|
14597
|
+
*
|
|
14598
|
+
* _401 Unauthorized_
|
|
14599
|
+
*
|
|
14600
|
+
* * The ID in _moderator\_id_ must match the user ID in the user access token.
|
|
14601
|
+
* * The Authorization header is required and must contain a user access token.
|
|
14602
|
+
* * The user access token must include the **moderator:read:unban\_requests** or **moderator:manage:unban\_requests** scope.
|
|
14603
|
+
* * The access token is not valid.
|
|
14604
|
+
* * The client ID specified in the Client-Id header does not match the client ID specified in the access token.
|
|
14605
|
+
*
|
|
14606
|
+
* @see https://dev.twitch.tv/docs/api/reference#get-unban-requests
|
|
14607
|
+
*/
|
|
14075
14608
|
}[];
|
|
14076
14609
|
pagination?: {
|
|
14077
14610
|
cursor?: string;
|
|
@@ -14185,6 +14718,8 @@ declare class TwitchApi {
|
|
|
14185
14718
|
/**
|
|
14186
14719
|
* Gets an organization’s list of entitlements that have been granted to a game, a user, or both.
|
|
14187
14720
|
*
|
|
14721
|
+
* **NOTE:** Entitlements returned in the response body data are not guaranteed to be sorted by any field returned by the API. To retrieve **CLAIMED** or **FULFILLED** entitlements, use the `fulfillment_status` query parameter to filter results. To retrieve entitlements for a specific game, use the `game_id` query parameter to filter results.
|
|
14722
|
+
*
|
|
14188
14723
|
* The following table identifies the request parameters that you may specify based on the type of access token used.
|
|
14189
14724
|
*
|
|
14190
14725
|
* | Access token type | Parameter | Description |
|
|
@@ -15089,7 +15624,7 @@ declare class TwitchApi {
|
|
|
15089
15624
|
data: {
|
|
15090
15625
|
id: string;
|
|
15091
15626
|
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";
|
|
15092
|
-
type: "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.subscribe" | "channel.subscription.end" | "channel.subscription.gift" | "channel.subscription.message" | "channel.cheer" | "channel.raid" | "channel.ban" | "channel.unban" | "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_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.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";
|
|
15627
|
+
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.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_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.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";
|
|
15093
15628
|
version: string;
|
|
15094
15629
|
condition: Record<string, never>;
|
|
15095
15630
|
created_at: string;
|
|
@@ -15160,7 +15695,7 @@ declare class TwitchApi {
|
|
|
15160
15695
|
*
|
|
15161
15696
|
* __Authorization:__
|
|
15162
15697
|
*
|
|
15163
|
-
* If you use [
|
|
15698
|
+
* 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.
|
|
15164
15699
|
*
|
|
15165
15700
|
* 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.
|
|
15166
15701
|
*
|
|
@@ -15204,7 +15739,7 @@ declare class TwitchApi {
|
|
|
15204
15739
|
data: {
|
|
15205
15740
|
id: string;
|
|
15206
15741
|
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";
|
|
15207
|
-
type: "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.subscribe" | "channel.subscription.end" | "channel.subscription.gift" | "channel.subscription.message" | "channel.cheer" | "channel.raid" | "channel.ban" | "channel.unban" | "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_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.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";
|
|
15742
|
+
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.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_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.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";
|
|
15208
15743
|
version: string;
|
|
15209
15744
|
condition: Record<string, never>;
|
|
15210
15745
|
created_at: string;
|
|
@@ -15496,24 +16031,25 @@ declare class TwitchApi {
|
|
|
15496
16031
|
data: {
|
|
15497
16032
|
data: {
|
|
15498
16033
|
id: string;
|
|
15499
|
-
guests:
|
|
15500
|
-
|
|
15501
|
-
|
|
15502
|
-
|
|
15503
|
-
|
|
15504
|
-
|
|
15505
|
-
|
|
15506
|
-
|
|
15507
|
-
|
|
15508
|
-
|
|
15509
|
-
|
|
15510
|
-
|
|
15511
|
-
|
|
15512
|
-
|
|
15513
|
-
|
|
15514
|
-
|
|
15515
|
-
|
|
15516
|
-
|
|
16034
|
+
guests: {
|
|
16035
|
+
slot_id: string;
|
|
16036
|
+
is_live: boolean;
|
|
16037
|
+
user_id: string;
|
|
16038
|
+
user_display_name: string;
|
|
16039
|
+
user_login: string;
|
|
16040
|
+
volume: number;
|
|
16041
|
+
assigned_at: string;
|
|
16042
|
+
audio_settings: {
|
|
16043
|
+
is_host_enabled: boolean;
|
|
16044
|
+
is_guest_enabled: boolean;
|
|
16045
|
+
is_available: boolean;
|
|
16046
|
+
};
|
|
16047
|
+
video_settings: {
|
|
16048
|
+
is_host_enabled: boolean;
|
|
16049
|
+
is_guest_enabled: boolean;
|
|
16050
|
+
is_available: boolean;
|
|
16051
|
+
};
|
|
16052
|
+
}[];
|
|
15517
16053
|
}[];
|
|
15518
16054
|
};
|
|
15519
16055
|
}>;
|
|
@@ -15558,24 +16094,25 @@ declare class TwitchApi {
|
|
|
15558
16094
|
data: {
|
|
15559
16095
|
data: {
|
|
15560
16096
|
id: string;
|
|
15561
|
-
guests:
|
|
15562
|
-
|
|
15563
|
-
|
|
15564
|
-
|
|
15565
|
-
|
|
15566
|
-
|
|
15567
|
-
|
|
15568
|
-
|
|
15569
|
-
|
|
15570
|
-
|
|
15571
|
-
|
|
15572
|
-
|
|
15573
|
-
|
|
15574
|
-
|
|
15575
|
-
|
|
15576
|
-
|
|
15577
|
-
|
|
15578
|
-
|
|
16097
|
+
guests: {
|
|
16098
|
+
slot_id: string;
|
|
16099
|
+
is_live: boolean;
|
|
16100
|
+
user_id: string;
|
|
16101
|
+
user_display_name: string;
|
|
16102
|
+
user_login: string;
|
|
16103
|
+
volume: number;
|
|
16104
|
+
assigned_at: string;
|
|
16105
|
+
audio_settings: {
|
|
16106
|
+
is_host_enabled: boolean;
|
|
16107
|
+
is_guest_enabled: boolean;
|
|
16108
|
+
is_available: boolean;
|
|
16109
|
+
};
|
|
16110
|
+
video_settings: {
|
|
16111
|
+
is_host_enabled: boolean;
|
|
16112
|
+
is_guest_enabled: boolean;
|
|
16113
|
+
is_available: boolean;
|
|
16114
|
+
};
|
|
16115
|
+
}[];
|
|
15579
16116
|
}[];
|
|
15580
16117
|
};
|
|
15581
16118
|
}>;
|
|
@@ -15957,7 +16494,41 @@ declare class TwitchApi {
|
|
|
15957
16494
|
id: string;
|
|
15958
16495
|
last_contribution: {
|
|
15959
16496
|
total: number;
|
|
15960
|
-
type: "BITS" | "SUBS" | "OTHER";
|
|
16497
|
+
type: "BITS" | "SUBS" | "OTHER"; /**
|
|
16498
|
+
* Gets the channels that match the specified query and have streamed content within the past 6 months.
|
|
16499
|
+
*
|
|
16500
|
+
* The fields that the API uses for comparison depends on the value that the _live\_only_ query parameter is set to. If _live\_only_ is **false**, the API matches on the broadcaster’s login name. However, if _live\_only_ is **true**, the API matches on the broadcaster’s name and category name.
|
|
16501
|
+
*
|
|
16502
|
+
* To match, the beginning of the broadcaster’s name or category must match the query string. The comparison is case insensitive. If the query string is angel\_of\_death, it matches all names that begin with angel\_of\_death. However, if the query string is a phrase like _angel of death_, it matches to names starting with angelofdeath or names starting with angel\_of\_death.
|
|
16503
|
+
*
|
|
16504
|
+
* By default, the results include both live and offline channels. To get only live channels set the _live\_only_ query parameter to **true**.
|
|
16505
|
+
*
|
|
16506
|
+
* __Authorization:__
|
|
16507
|
+
*
|
|
16508
|
+
* 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).
|
|
16509
|
+
*
|
|
16510
|
+
* __URL:__
|
|
16511
|
+
*
|
|
16512
|
+
* `GET https://api.twitch.tv/helix/search/channels`
|
|
16513
|
+
*
|
|
16514
|
+
* __Response Codes:__
|
|
16515
|
+
*
|
|
16516
|
+
* _200 OK_
|
|
16517
|
+
*
|
|
16518
|
+
* Successfully retrieved the list of category names that matched the specified query string.
|
|
16519
|
+
*
|
|
16520
|
+
* _400 Bad Request_
|
|
16521
|
+
*
|
|
16522
|
+
* * The _query_ query parameter is required.
|
|
16523
|
+
*
|
|
16524
|
+
* _401 Unauthorized_
|
|
16525
|
+
*
|
|
16526
|
+
* * The Authorization header is required and must contain an app access token or user access token.
|
|
16527
|
+
* * The access token is not valid.
|
|
16528
|
+
* * The client ID specified in the Client-Id header does not match the client ID specified in the access token.
|
|
16529
|
+
*
|
|
16530
|
+
* @see https://dev.twitch.tv/docs/api/reference#search-channels
|
|
16531
|
+
*/
|
|
15961
16532
|
user: string;
|
|
15962
16533
|
};
|
|
15963
16534
|
level: number;
|
|
@@ -16417,6 +16988,141 @@ declare class TwitchApi {
|
|
|
16417
16988
|
status: 400 | 401 | 403 | 409 | 429;
|
|
16418
16989
|
data: unknown;
|
|
16419
16990
|
}>;
|
|
16991
|
+
/**
|
|
16992
|
+
* BETA Gets a list of unban requests for a broadcaster’s channel.
|
|
16993
|
+
*
|
|
16994
|
+
* __Authorization:__
|
|
16995
|
+
*
|
|
16996
|
+
* * Requires a user access token that includes the **moderator:read:unban\_requests** or **moderator:manage:unban\_requests** scope.
|
|
16997
|
+
* * Query parameter `moderator_id` must match the `user_id` in the [user access token](https://dev.twitch.tv/docs/authentication/#user-access-tokens).
|
|
16998
|
+
*
|
|
16999
|
+
* __URL:__
|
|
17000
|
+
*
|
|
17001
|
+
* `GET https://api.twitch.tv/helix/moderation/unban_requests`
|
|
17002
|
+
*
|
|
17003
|
+
* __Response Codes:__
|
|
17004
|
+
*
|
|
17005
|
+
* _200 OK_
|
|
17006
|
+
*
|
|
17007
|
+
* Successfully retrieved the list of unban requests.
|
|
17008
|
+
*
|
|
17009
|
+
* _400 Bad Request_
|
|
17010
|
+
*
|
|
17011
|
+
* * The _broadcaster\_id_ query parameter is required.
|
|
17012
|
+
* * The ID in the _broadcaster\_id_ query parameter is not valid.
|
|
17013
|
+
* * The _moderator\_id_ query parameter is required.
|
|
17014
|
+
* * The ID in the _moderator\_id_ query parameter is not valid.
|
|
17015
|
+
* * The pagination cursor is not valid.
|
|
17016
|
+
*
|
|
17017
|
+
* _401 Unauthorized_
|
|
17018
|
+
*
|
|
17019
|
+
* * The ID in _moderator\_id_ must match the user ID in the user access token.
|
|
17020
|
+
* * The Authorization header is required and must contain a user access token.
|
|
17021
|
+
* * The user access token must include the **moderator:read:unban\_requests** or **moderator:manage:unban\_requests** scope.
|
|
17022
|
+
* * The access token is not valid.
|
|
17023
|
+
* * The client ID specified in the Client-Id header does not match the client ID specified in the access token.
|
|
17024
|
+
*
|
|
17025
|
+
* @see https://dev.twitch.tv/docs/api/reference#get-unban-requests
|
|
17026
|
+
*/
|
|
17027
|
+
getUnbanRequests: (params: GetUnbanRequestsParams, options?: CallApiOptions['options']) => Promise<{
|
|
17028
|
+
ok: false;
|
|
17029
|
+
status: 400 | 401;
|
|
17030
|
+
data: unknown;
|
|
17031
|
+
} | {
|
|
17032
|
+
ok: true;
|
|
17033
|
+
status: 200;
|
|
17034
|
+
data: {
|
|
17035
|
+
data: {
|
|
17036
|
+
id: string;
|
|
17037
|
+
broadcaster_id: string;
|
|
17038
|
+
broadcaster_name: string;
|
|
17039
|
+
broadcaster_login: string;
|
|
17040
|
+
moderator_id: string;
|
|
17041
|
+
moderator_login: string;
|
|
17042
|
+
moderator_name: string;
|
|
17043
|
+
user_id: string;
|
|
17044
|
+
user_login: string;
|
|
17045
|
+
user_name: string;
|
|
17046
|
+
text: string;
|
|
17047
|
+
status: string;
|
|
17048
|
+
created_at: string;
|
|
17049
|
+
resolved_at: string;
|
|
17050
|
+
resolution_text: string;
|
|
17051
|
+
}[];
|
|
17052
|
+
pagination?: {
|
|
17053
|
+
cursor?: string;
|
|
17054
|
+
};
|
|
17055
|
+
};
|
|
17056
|
+
}>;
|
|
17057
|
+
/**
|
|
17058
|
+
* BETA Resolves an unban request by approving or denying it.
|
|
17059
|
+
*
|
|
17060
|
+
* __Authorization:__
|
|
17061
|
+
*
|
|
17062
|
+
* * Requires a user access token that includes the **moderator:manage:unban\_requests** scope.
|
|
17063
|
+
* * Query parameter `moderator_id` must match the `user_id` in the [user access token](https://dev.twitch.tv/docs/authentication/#user-access-tokens).
|
|
17064
|
+
*
|
|
17065
|
+
* __URL:__
|
|
17066
|
+
*
|
|
17067
|
+
* `PATCH https://api.twitch.tv/helix/moderation/unban_requests`
|
|
17068
|
+
*
|
|
17069
|
+
* __Response Codes:__
|
|
17070
|
+
*
|
|
17071
|
+
* _200 OK_
|
|
17072
|
+
*
|
|
17073
|
+
* Successfully resolved the unban request.
|
|
17074
|
+
*
|
|
17075
|
+
* _400 Bad Request_
|
|
17076
|
+
*
|
|
17077
|
+
* * The _broadcaster\_id_ query parameter is required.
|
|
17078
|
+
* * The ID in the _broadcaster\_id_ query parameter is not valid.
|
|
17079
|
+
* * The _moderator\_id_ query parameter is required.
|
|
17080
|
+
* * The ID in the _moderator\_id_ query parameter is not valid.
|
|
17081
|
+
* * The pagination cursor is not valid.
|
|
17082
|
+
* * The broadcaster is not receiving unban requests
|
|
17083
|
+
* * Invalid requested update
|
|
17084
|
+
*
|
|
17085
|
+
* _401 Unauthorized_
|
|
17086
|
+
*
|
|
17087
|
+
* * The ID in _moderator\_id_ must match the user ID in the user access token.
|
|
17088
|
+
* * The Authorization header is required and must contain a user access token.
|
|
17089
|
+
* * The user access token must include the **moderator:manage:unban\_requests** scope.
|
|
17090
|
+
* * The access token is not valid.
|
|
17091
|
+
* * The client ID specified in the Client-Id header does not match the client ID specified in the access token.
|
|
17092
|
+
*
|
|
17093
|
+
* _404 Not Found_
|
|
17094
|
+
*
|
|
17095
|
+
* The unban request ID was not found.
|
|
17096
|
+
*
|
|
17097
|
+
* @see https://dev.twitch.tv/docs/api/reference#resolve-unban-requests
|
|
17098
|
+
*/
|
|
17099
|
+
resolveUnbanRequests: (params: ResolveUnbanRequestsParams, options?: CallApiOptions['options']) => Promise<{
|
|
17100
|
+
ok: false;
|
|
17101
|
+
status: 400 | 401 | 404;
|
|
17102
|
+
data: unknown;
|
|
17103
|
+
} | {
|
|
17104
|
+
ok: true;
|
|
17105
|
+
status: 200;
|
|
17106
|
+
data: {
|
|
17107
|
+
data: {
|
|
17108
|
+
id: string;
|
|
17109
|
+
broadcaster_id: string;
|
|
17110
|
+
broadcaster_name: string;
|
|
17111
|
+
broadcaster_login: string;
|
|
17112
|
+
moderator_id: string;
|
|
17113
|
+
moderator_login: string;
|
|
17114
|
+
moderator_name: string;
|
|
17115
|
+
user_id: string;
|
|
17116
|
+
user_login: string;
|
|
17117
|
+
user_name: string;
|
|
17118
|
+
text: string;
|
|
17119
|
+
status: string;
|
|
17120
|
+
created_at: string;
|
|
17121
|
+
resolved_at: string;
|
|
17122
|
+
resolution_text: string;
|
|
17123
|
+
}[];
|
|
17124
|
+
};
|
|
17125
|
+
}>;
|
|
16420
17126
|
/**
|
|
16421
17127
|
* Gets the broadcaster’s list of non-private, blocked words or phrases. These are the terms that the broadcaster or moderator added manually or that were denied by AutoMod.
|
|
16422
17128
|
*
|
|
@@ -17111,7 +17817,38 @@ declare class TwitchApi {
|
|
|
17111
17817
|
is_active: boolean;
|
|
17112
17818
|
moderator_id: string;
|
|
17113
17819
|
moderator_login: string;
|
|
17114
|
-
moderator_name: string;
|
|
17820
|
+
moderator_name: string; /**
|
|
17821
|
+
* Updates the specified user’s information. The user ID in the OAuth token identifies the user whose information you want to update.
|
|
17822
|
+
*
|
|
17823
|
+
* To include the user’s verified email address in the response, the user access token must also include the **user:read:email** scope.
|
|
17824
|
+
*
|
|
17825
|
+
* __Authorization:__
|
|
17826
|
+
*
|
|
17827
|
+
* Requires a [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens) that includes the **user:edit** scope.
|
|
17828
|
+
*
|
|
17829
|
+
* __URL:__
|
|
17830
|
+
*
|
|
17831
|
+
* `PUT https://api.twitch.tv/helix/users`
|
|
17832
|
+
*
|
|
17833
|
+
* __Response Codes:__
|
|
17834
|
+
*
|
|
17835
|
+
* _200 OK_
|
|
17836
|
+
*
|
|
17837
|
+
* Successfully updated the specified user's information.
|
|
17838
|
+
*
|
|
17839
|
+
* _400 Bad Request_
|
|
17840
|
+
*
|
|
17841
|
+
* * The string in the _description_ query parameter is too long.
|
|
17842
|
+
*
|
|
17843
|
+
* _401 Unauthorized_
|
|
17844
|
+
*
|
|
17845
|
+
* * The Authorization header is required and must contain a user access token.
|
|
17846
|
+
* * The user access token must include the **user:edit** scope.
|
|
17847
|
+
* * The access token is not valid.
|
|
17848
|
+
* * The ID specified in the Client-Id header does not match the client ID specified in the access token.
|
|
17849
|
+
*
|
|
17850
|
+
* @see https://dev.twitch.tv/docs/api/reference#update-user
|
|
17851
|
+
*/
|
|
17115
17852
|
last_activated_at: string;
|
|
17116
17853
|
}[];
|
|
17117
17854
|
};
|
|
@@ -17135,7 +17872,7 @@ declare class TwitchApi {
|
|
|
17135
17872
|
*
|
|
17136
17873
|
* _200 OK_
|
|
17137
17874
|
*
|
|
17138
|
-
* Successfully retrieved the broadcaster
|
|
17875
|
+
* Successfully retrieved the broadcaster's polls.
|
|
17139
17876
|
*
|
|
17140
17877
|
* _400 Bad Request_
|
|
17141
17878
|
*
|
|
@@ -19423,4 +20160,4 @@ declare class TwitchApi {
|
|
|
19423
20160
|
};
|
|
19424
20161
|
}
|
|
19425
20162
|
|
|
19426
|
-
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 GetUserActiveExtensionsParams, type GetUserActiveExtensionsResponse, type GetUserBlockListParams, type GetUserBlockListResponse, type GetUserChatColorParams, type GetUserChatColorResponse, type GetUserExtensionsResponse, type GetUsersParams, type GetUsersResponse, type GetVIPsParams, type GetVIPsResponse, type GetVideosParams, type GetVideosResponse, type GlobalEmote, 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 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 };
|
|
20163
|
+
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 };
|