ts-twitch-api 0.2.0 → 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 +279 -150
- package/dist/index.d.cts +990 -460
- package/dist/index.d.ts +990 -460
- package/dist/index.js +279 -150
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -840,7 +840,7 @@ interface components {
|
|
|
840
840
|
/** @description A URL to the large version (112px x 112px) of the emote. */
|
|
841
841
|
url_4x: string;
|
|
842
842
|
};
|
|
843
|
-
/** @description The subscriber tier at which the emote is unlocked. This field contains the tier information only if `emote_type` is set to `subscriptions`, otherwise, it
|
|
843
|
+
/** @description The subscriber tier at which the emote is unlocked. This field contains the tier information only if `emote_type` is set to `subscriptions`, otherwise, it's an empty string. */
|
|
844
844
|
tier: string;
|
|
845
845
|
/**
|
|
846
846
|
* @description The type of emote. The possible values are:
|
|
@@ -877,7 +877,7 @@ interface components {
|
|
|
877
877
|
theme_mode: ("dark" | "light")[];
|
|
878
878
|
};
|
|
879
879
|
GetChannelEmotesResponse: {
|
|
880
|
-
/** @description The list of emotes that the specified broadcaster created. If the broadcaster hasn
|
|
880
|
+
/** @description The list of emotes that the specified broadcaster created. If the broadcaster hasn't created custom emotes, the list is empty. */
|
|
881
881
|
data: components["schemas"]["ChannelEmote"][];
|
|
882
882
|
/** @description A templated URL. Use 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. For information about what the template looks like and how to use it to fetch emotes, see [Emote CDN URL format](https://dev.twitch.tv/docs/irc/emotes#cdn-template). You should use this template instead of using the URLs in the `images` object. */
|
|
883
883
|
template: string;
|
|
@@ -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
|
};
|
|
@@ -3579,9 +3738,9 @@ interface components {
|
|
|
3579
3738
|
User: {
|
|
3580
3739
|
/** @description An ID that identifies the user. */
|
|
3581
3740
|
id: string;
|
|
3582
|
-
/** @description The user
|
|
3741
|
+
/** @description The user's login name. */
|
|
3583
3742
|
login: string;
|
|
3584
|
-
/** @description The user
|
|
3743
|
+
/** @description The user's display name. */
|
|
3585
3744
|
display_name: string;
|
|
3586
3745
|
/**
|
|
3587
3746
|
* @description The type of user. Possible values are:
|
|
@@ -3596,34 +3755,34 @@ 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}
|
|
3603
3762
|
*/
|
|
3604
3763
|
broadcaster_type: "affiliate" | "partner" | "";
|
|
3605
|
-
/** @description The user
|
|
3764
|
+
/** @description The user's description of their channel. */
|
|
3606
3765
|
description: string;
|
|
3607
|
-
/** @description A URL to the user
|
|
3766
|
+
/** @description A URL to the user's profile image. */
|
|
3608
3767
|
profile_image_url: string;
|
|
3609
|
-
/** @description A URL to the user
|
|
3768
|
+
/** @description A URL to the user's offline image. */
|
|
3610
3769
|
offline_image_url: string;
|
|
3611
3770
|
/**
|
|
3612
3771
|
* Format: int32
|
|
3613
|
-
* @description The number of times the user
|
|
3772
|
+
* @description The number of times the user's channel has been viewed.
|
|
3614
3773
|
*
|
|
3615
|
-
* **NOTE**: This field has been deprecated (see [Get Users API endpoint –
|
|
3774
|
+
* **NOTE**: This field has been deprecated (see [Get Users API endpoint – "view\_count" deprecation](https://discuss.dev.twitch.tv/t/get-users-api-endpoint-view-count-deprecation/37777)). Any data in this field is not valid and should not be used.
|
|
3616
3775
|
*/
|
|
3617
3776
|
view_count: number;
|
|
3618
3777
|
/**
|
|
3619
|
-
* @description The user
|
|
3778
|
+
* @description The user's verified email address. The object includes this field only if the user access token includes the **user:read:email** scope.
|
|
3620
3779
|
*
|
|
3621
3780
|
* If the request contains more than one user, only the user associated with the access token that provided consent will include an email address — the email address for all other users will be empty.
|
|
3622
3781
|
*/
|
|
3623
3782
|
email?: string;
|
|
3624
3783
|
/**
|
|
3625
3784
|
* Format: date-time
|
|
3626
|
-
* @description The UTC date and time that the user
|
|
3785
|
+
* @description The UTC date and time that the user's account was created. The timestamp is in RFC3339 format.
|
|
3627
3786
|
*/
|
|
3628
3787
|
created_at: string;
|
|
3629
3788
|
};
|
|
@@ -3650,9 +3809,9 @@ interface components {
|
|
|
3650
3809
|
UserExtension: {
|
|
3651
3810
|
/** @description An ID that identifies the extension. */
|
|
3652
3811
|
id: string;
|
|
3653
|
-
/** @description The extension
|
|
3812
|
+
/** @description The extension's version. */
|
|
3654
3813
|
version: string;
|
|
3655
|
-
/** @description The extension
|
|
3814
|
+
/** @description The extension's name. */
|
|
3656
3815
|
name: string;
|
|
3657
3816
|
/** @description A Boolean value that determines whether the extension is configured and can be activated. Is **true** if the extension is configured and can be activated. */
|
|
3658
3817
|
can_activate: boolean;
|
|
@@ -3801,17 +3960,17 @@ interface components {
|
|
|
3801
3960
|
Video: {
|
|
3802
3961
|
/** @description An ID that identifies the video. */
|
|
3803
3962
|
id: string;
|
|
3804
|
-
/** @description The ID of the stream that the video originated from if the video
|
|
3963
|
+
/** @description The ID of the stream that the video originated from if the video's type is "archive;" otherwise, **null**. */
|
|
3805
3964
|
stream_id: string | null;
|
|
3806
3965
|
/** @description The ID of the broadcaster that owns the video. */
|
|
3807
3966
|
user_id: string;
|
|
3808
|
-
/** @description The broadcaster
|
|
3967
|
+
/** @description The broadcaster's login name. */
|
|
3809
3968
|
user_login: string;
|
|
3810
|
-
/** @description The broadcaster
|
|
3969
|
+
/** @description The broadcaster's display name. */
|
|
3811
3970
|
user_name: string;
|
|
3812
|
-
/** @description The video
|
|
3971
|
+
/** @description The video's title. */
|
|
3813
3972
|
title: string;
|
|
3814
|
-
/** @description The video
|
|
3973
|
+
/** @description The video's description. */
|
|
3815
3974
|
description: string;
|
|
3816
3975
|
/**
|
|
3817
3976
|
* Format: date-time
|
|
@@ -3823,21 +3982,21 @@ interface components {
|
|
|
3823
3982
|
* @description The date and time, in UTC, of when the video was published. The timestamp is in RFC3339 format.
|
|
3824
3983
|
*/
|
|
3825
3984
|
published_at: string;
|
|
3826
|
-
/** @description The video
|
|
3985
|
+
/** @description The video's URL. */
|
|
3827
3986
|
url: string;
|
|
3828
3987
|
/** @description A URL to a thumbnail image of the video. Before using the URL, you must replace the `%{width}` and `%{height}` placeholders with the width and height of the thumbnail you want returned. Due to current limitations, `${width}` must be 320 and `${height}` must be 180. */
|
|
3829
3988
|
thumbnail_url: string;
|
|
3830
|
-
/** @description The video
|
|
3989
|
+
/** @description The video's viewable state. Always set to **public**. */
|
|
3831
3990
|
viewable: string;
|
|
3832
3991
|
/**
|
|
3833
3992
|
* Format: int32
|
|
3834
3993
|
* @description The number of times that users have watched the video.
|
|
3835
3994
|
*/
|
|
3836
3995
|
view_count: number;
|
|
3837
|
-
/** @description The ISO 639-1 two-letter language code that the video was broadcast in. For example, the language code is DE if the video was broadcast in German. For a list of supported languages, see [Supported Stream Language](https://help.twitch.tv/s/article/languages-on-twitch#streamlang). The language value is
|
|
3996
|
+
/** @description The ISO 639-1 two-letter language code that the video was broadcast in. For example, the language code is DE if the video was broadcast in German. For a list of supported languages, see [Supported Stream Language](https://help.twitch.tv/s/article/languages-on-twitch#streamlang). The language value is "other" if the video was broadcast in a language not in the list of supported languages. */
|
|
3838
3997
|
language: string;
|
|
3839
3998
|
/**
|
|
3840
|
-
* @description The video
|
|
3999
|
+
* @description The video's type. Possible values are:
|
|
3841
4000
|
*
|
|
3842
4001
|
* * archive — An on-demand video (VOD) of one of the broadcaster's past streams.
|
|
3843
4002
|
* * highlight — A highlight reel of one of the broadcaster's past streams. See [Creating Highlights](https://help.twitch.tv/s/article/creating-highlights-and-stream-markers).
|
|
@@ -3845,7 +4004,7 @@ interface components {
|
|
|
3845
4004
|
* @enum {string}
|
|
3846
4005
|
*/
|
|
3847
4006
|
type: "archive" | "highlight" | "upload";
|
|
3848
|
-
/** @description The video
|
|
4007
|
+
/** @description The video's length in ISO 8601 duration format. For example, 3m21s represents 3 minutes, 21 seconds. */
|
|
3849
4008
|
duration: string;
|
|
3850
4009
|
/** @description The segments that Twitch Audio Recognition muted; otherwise, **null**. */
|
|
3851
4010
|
muted_segments: {
|
|
@@ -3866,7 +4025,7 @@ interface components {
|
|
|
3866
4025
|
data: components["schemas"]["Video"][];
|
|
3867
4026
|
/** @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) */
|
|
3868
4027
|
pagination?: {
|
|
3869
|
-
/** @description The cursor used to get the next page of results. Use the cursor to set the request
|
|
4028
|
+
/** @description The cursor used to get the next page of results. Use the cursor to set the request's _after_ or _before_ query parameter depending on whether you're paging forwards or backwards through the results. */
|
|
3870
4029
|
cursor?: string;
|
|
3871
4030
|
};
|
|
3872
4031
|
};
|
|
@@ -4497,7 +4656,7 @@ interface operations {
|
|
|
4497
4656
|
};
|
|
4498
4657
|
};
|
|
4499
4658
|
responses: {
|
|
4500
|
-
/** @description Successfully retrieved the broadcaster
|
|
4659
|
+
/** @description Successfully retrieved the broadcaster's list of editors. */
|
|
4501
4660
|
200: {
|
|
4502
4661
|
content: {
|
|
4503
4662
|
"application/json": components["schemas"]["GetChannelEditorsResponse"];
|
|
@@ -4541,7 +4700,7 @@ interface operations {
|
|
|
4541
4700
|
};
|
|
4542
4701
|
};
|
|
4543
4702
|
responses: {
|
|
4544
|
-
/** @description Successfully retrieved the broadcaster
|
|
4703
|
+
/** @description Successfully retrieved the broadcaster's list of followers. */
|
|
4545
4704
|
200: {
|
|
4546
4705
|
content: {
|
|
4547
4706
|
"application/json": components["schemas"]["GetFollowedChannelsResponse"];
|
|
@@ -5227,7 +5386,7 @@ interface operations {
|
|
|
5227
5386
|
};
|
|
5228
5387
|
};
|
|
5229
5388
|
responses: {
|
|
5230
|
-
/** @description Successfully retrieved broadcaster
|
|
5389
|
+
/** @description Successfully retrieved broadcaster's list of custom emotes. */
|
|
5231
5390
|
200: {
|
|
5232
5391
|
content: {
|
|
5233
5392
|
"application/json": components["schemas"]["GetChannelEmotesResponse"];
|
|
@@ -5263,7 +5422,7 @@ interface operations {
|
|
|
5263
5422
|
*/
|
|
5264
5423
|
"get-global-emotes": {
|
|
5265
5424
|
responses: {
|
|
5266
|
-
/** @description Successfully retrieved Twitch
|
|
5425
|
+
/** @description Successfully retrieved Twitch's list of global emotes. */
|
|
5267
5426
|
200: {
|
|
5268
5427
|
content: {
|
|
5269
5428
|
"application/json": components["schemas"]["GetGlobalEmotesResponse"];
|
|
@@ -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.
|
|
@@ -8692,8 +9026,8 @@ interface operations {
|
|
|
8692
9026
|
};
|
|
8693
9027
|
};
|
|
8694
9028
|
/**
|
|
8695
|
-
*
|
|
8696
|
-
* @description
|
|
9029
|
+
* Gets a list of channels that the specified user has moderator privileges in.
|
|
9030
|
+
* @description Gets a list of channels that the specified user has moderator privileges in.
|
|
8697
9031
|
*
|
|
8698
9032
|
* __Authorization:__
|
|
8699
9033
|
*
|
|
@@ -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"];
|
|
@@ -10585,7 +10919,7 @@ interface operations {
|
|
|
10585
10919
|
};
|
|
10586
10920
|
};
|
|
10587
10921
|
responses: {
|
|
10588
|
-
/** @description Successfully retrieved the team
|
|
10922
|
+
/** @description Successfully retrieved the team's information. */
|
|
10589
10923
|
200: {
|
|
10590
10924
|
content: {
|
|
10591
10925
|
"application/json": components["schemas"]["GetTeamsResponse"];
|
|
@@ -10637,7 +10971,7 @@ interface operations {
|
|
|
10637
10971
|
};
|
|
10638
10972
|
};
|
|
10639
10973
|
responses: {
|
|
10640
|
-
/** @description Successfully retrieved the specified users
|
|
10974
|
+
/** @description Successfully retrieved the specified users' information. */
|
|
10641
10975
|
200: {
|
|
10642
10976
|
content: {
|
|
10643
10977
|
"application/json": components["schemas"]["GetUsersResponse"];
|
|
@@ -10682,7 +11016,7 @@ interface operations {
|
|
|
10682
11016
|
};
|
|
10683
11017
|
};
|
|
10684
11018
|
responses: {
|
|
10685
|
-
/** @description Successfully updated the specified user
|
|
11019
|
+
/** @description Successfully updated the specified user's information. */
|
|
10686
11020
|
200: {
|
|
10687
11021
|
content: {
|
|
10688
11022
|
"application/json": components["schemas"]["UpdateUserResponse"];
|
|
@@ -10723,7 +11057,7 @@ interface operations {
|
|
|
10723
11057
|
};
|
|
10724
11058
|
};
|
|
10725
11059
|
responses: {
|
|
10726
|
-
/** @description Successfully retrieved the broadcaster
|
|
11060
|
+
/** @description Successfully retrieved the broadcaster's list of blocked users. */
|
|
10727
11061
|
200: {
|
|
10728
11062
|
content: {
|
|
10729
11063
|
"application/json": components["schemas"]["GetUserBlockListResponse"];
|
|
@@ -10877,7 +11211,7 @@ interface operations {
|
|
|
10877
11211
|
*/
|
|
10878
11212
|
"get-user-extensions": {
|
|
10879
11213
|
responses: {
|
|
10880
|
-
/** @description Successfully retrieved the user
|
|
11214
|
+
/** @description Successfully retrieved the user's installed extensions. */
|
|
10881
11215
|
200: {
|
|
10882
11216
|
content: {
|
|
10883
11217
|
"application/json": components["schemas"]["GetUserExtensionsResponse"];
|
|
@@ -10916,7 +11250,7 @@ interface operations {
|
|
|
10916
11250
|
};
|
|
10917
11251
|
};
|
|
10918
11252
|
responses: {
|
|
10919
|
-
/** @description Successfully retrieved the user
|
|
11253
|
+
/** @description Successfully retrieved the user's active extensions. */
|
|
10920
11254
|
200: {
|
|
10921
11255
|
content: {
|
|
10922
11256
|
"application/json": components["schemas"]["GetUserActiveExtensionsResponse"];
|
|
@@ -10992,7 +11326,7 @@ interface operations {
|
|
|
10992
11326
|
parameters: {
|
|
10993
11327
|
query?: {
|
|
10994
11328
|
/**
|
|
10995
|
-
* @description A list of IDs that identify the videos you want to get. To get more than one video, include this parameter for each video you want to get. For example, `id=1234&id=5678`. You may specify a maximum of 100 IDs. The endpoint ignores duplicate IDs and IDs that weren
|
|
11329
|
+
* @description A list of IDs that identify the videos you want to get. To get more than one video, include this parameter for each video you want to get. For example, `id=1234&id=5678`. You may specify a maximum of 100 IDs. The endpoint ignores duplicate IDs and IDs that weren't found (if there's at least one valid ID).
|
|
10996
11330
|
*
|
|
10997
11331
|
* The _id_, _user\_id_, and _game\_id_ parameters are mutually exclusive.
|
|
10998
11332
|
*/
|
|
@@ -11023,7 +11357,7 @@ interface operations {
|
|
|
11023
11357
|
* * month
|
|
11024
11358
|
* * week
|
|
11025
11359
|
*
|
|
11026
|
-
* The default is
|
|
11360
|
+
* The default is "all," which returns videos published in all periods.
|
|
11027
11361
|
*
|
|
11028
11362
|
* Specify this parameter only if you specify the _game\_id_ or _user\_id_ query parameter.
|
|
11029
11363
|
*/
|
|
@@ -11035,20 +11369,20 @@ interface operations {
|
|
|
11035
11369
|
* * trending — Sort the results in descending order by biggest gains in viewership (i.e., highest trending video first).
|
|
11036
11370
|
* * views — Sort the results in descending order by most views (i.e., highest number of views first).
|
|
11037
11371
|
*
|
|
11038
|
-
* The default is
|
|
11372
|
+
* The default is "time."
|
|
11039
11373
|
*
|
|
11040
11374
|
* Specify this parameter only if you specify the _game\_id_ or _user\_id_ query parameter.
|
|
11041
11375
|
*/
|
|
11042
11376
|
sort?: "time" | "trending" | "views";
|
|
11043
11377
|
/**
|
|
11044
|
-
* @description A filter used to filter the list of videos by the video
|
|
11378
|
+
* @description A filter used to filter the list of videos by the video's type. Possible case-sensitive values are:
|
|
11045
11379
|
*
|
|
11046
11380
|
* * all
|
|
11047
11381
|
* * archive — On-demand videos (VODs) of past streams.
|
|
11048
11382
|
* * highlight — Highlight reels of past streams.
|
|
11049
11383
|
* * upload — External videos that the broadcaster uploaded using the Video Producer.
|
|
11050
11384
|
*
|
|
11051
|
-
* The default is
|
|
11385
|
+
* The default is "all," which returns all video types.
|
|
11052
11386
|
*
|
|
11053
11387
|
* Specify this parameter only if you specify the _game\_id_ or _user\_id_ query parameter.
|
|
11054
11388
|
*/
|
|
@@ -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'>;
|
|
@@ -11582,9 +11923,9 @@ type CallApiOptions = {
|
|
|
11582
11923
|
params?: Record<string, any> | null;
|
|
11583
11924
|
body?: Record<string, any> | null;
|
|
11584
11925
|
requiresAuth?: boolean;
|
|
11585
|
-
options
|
|
11586
|
-
clientId?: string
|
|
11587
|
-
accessToken?: string
|
|
11926
|
+
options?: {
|
|
11927
|
+
clientId?: string;
|
|
11928
|
+
accessToken?: string;
|
|
11588
11929
|
requestInit?: RequestInit;
|
|
11589
11930
|
};
|
|
11590
11931
|
};
|
|
@@ -11645,7 +11986,7 @@ declare class TwitchApi {
|
|
|
11645
11986
|
*
|
|
11646
11987
|
* @see https://dev.twitch.tv/docs/api/reference#start-commercial
|
|
11647
11988
|
*/
|
|
11648
|
-
startCommercial: (body: StartCommercialBody, options
|
|
11989
|
+
startCommercial: (body: StartCommercialBody, options?: CallApiOptions['options']) => Promise<{
|
|
11649
11990
|
ok: true;
|
|
11650
11991
|
status: 200;
|
|
11651
11992
|
data: {
|
|
@@ -11685,7 +12026,7 @@ declare class TwitchApi {
|
|
|
11685
12026
|
*
|
|
11686
12027
|
* @see https://dev.twitch.tv/docs/api/reference#get-ad-schedule
|
|
11687
12028
|
*/
|
|
11688
|
-
getAdSchedule: (params: GetAdScheduleParams, options
|
|
12029
|
+
getAdSchedule: (params: GetAdScheduleParams, options?: CallApiOptions['options']) => Promise<{
|
|
11689
12030
|
ok: true;
|
|
11690
12031
|
status: 200;
|
|
11691
12032
|
data: {
|
|
@@ -11734,7 +12075,7 @@ declare class TwitchApi {
|
|
|
11734
12075
|
*
|
|
11735
12076
|
* @see https://dev.twitch.tv/docs/api/reference#snooze-next-ad
|
|
11736
12077
|
*/
|
|
11737
|
-
snoozeNextAd: (params: SnoozeNextAdParams, options
|
|
12078
|
+
snoozeNextAd: (params: SnoozeNextAdParams, options?: CallApiOptions['options']) => Promise<{
|
|
11738
12079
|
ok: true;
|
|
11739
12080
|
status: 200;
|
|
11740
12081
|
data: {
|
|
@@ -11790,7 +12131,7 @@ declare class TwitchApi {
|
|
|
11790
12131
|
*
|
|
11791
12132
|
* @see https://dev.twitch.tv/docs/api/reference#get-extension-analytics
|
|
11792
12133
|
*/
|
|
11793
|
-
getExtensionAnalytics: (params
|
|
12134
|
+
getExtensionAnalytics: (params?: GetExtensionAnalyticsParams | null | undefined, options?: CallApiOptions['options']) => Promise<{
|
|
11794
12135
|
ok: true;
|
|
11795
12136
|
status: 200;
|
|
11796
12137
|
data: {
|
|
@@ -11851,7 +12192,7 @@ declare class TwitchApi {
|
|
|
11851
12192
|
*
|
|
11852
12193
|
* @see https://dev.twitch.tv/docs/api/reference#get-game-analytics
|
|
11853
12194
|
*/
|
|
11854
|
-
getGameAnalytics: (params
|
|
12195
|
+
getGameAnalytics: (params?: GetGameAnalyticsParams | null | undefined, options?: CallApiOptions['options']) => Promise<{
|
|
11855
12196
|
ok: false;
|
|
11856
12197
|
status: 400 | 401 | 404;
|
|
11857
12198
|
data: unknown;
|
|
@@ -11909,7 +12250,7 @@ declare class TwitchApi {
|
|
|
11909
12250
|
*
|
|
11910
12251
|
* @see https://dev.twitch.tv/docs/api/reference#get-bits-leaderboard
|
|
11911
12252
|
*/
|
|
11912
|
-
getBitsLeaderboard: (params
|
|
12253
|
+
getBitsLeaderboard: (params?: GetBitsLeaderboardParams | null | undefined, options?: CallApiOptions['options']) => Promise<{
|
|
11913
12254
|
ok: true;
|
|
11914
12255
|
status: 200;
|
|
11915
12256
|
data: {
|
|
@@ -11955,7 +12296,7 @@ declare class TwitchApi {
|
|
|
11955
12296
|
*
|
|
11956
12297
|
* @see https://dev.twitch.tv/docs/api/reference#get-cheermotes
|
|
11957
12298
|
*/
|
|
11958
|
-
getCheermotes: (params
|
|
12299
|
+
getCheermotes: (params?: GetCheermotesParams | null | undefined, options?: CallApiOptions['options']) => Promise<{
|
|
11959
12300
|
ok: true;
|
|
11960
12301
|
status: 200;
|
|
11961
12302
|
data: {
|
|
@@ -12001,47 +12342,7 @@ declare class TwitchApi {
|
|
|
12001
12342
|
};
|
|
12002
12343
|
can_cheer: boolean;
|
|
12003
12344
|
show_in_bits_card: boolean;
|
|
12004
|
-
}[];
|
|
12005
|
-
* Updates the Drop entitlement’s fulfillment status.
|
|
12006
|
-
*
|
|
12007
|
-
* The following table identifies which entitlements are updated based on the type of access token used.
|
|
12008
|
-
*
|
|
12009
|
-
* | Access token type | Data that’s updated |
|
|
12010
|
-
* | - | - |
|
|
12011
|
-
* | App | Updates all entitlements with benefits owned by the organization in the access token. |
|
|
12012
|
-
* | User | Updates all entitlements owned by the user in the access token and where the benefits are owned by the organization in the access token. |
|
|
12013
|
-
*
|
|
12014
|
-
*
|
|
12015
|
-
* __Authorization:__
|
|
12016
|
-
*
|
|
12017
|
-
* Requires an [app access token](https://dev.twitch.tv/docs/authentication#app-access-tokens) or [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens). The client ID in the access token must own the game.
|
|
12018
|
-
*
|
|
12019
|
-
* __URL:__
|
|
12020
|
-
*
|
|
12021
|
-
* `PATCH https://api.twitch.tv/helix/entitlements/drops`
|
|
12022
|
-
*
|
|
12023
|
-
* __Response Codes:__
|
|
12024
|
-
*
|
|
12025
|
-
* _200 OK_
|
|
12026
|
-
*
|
|
12027
|
-
* Successfully requested the updates. Check the response to determine which updates succeeded.
|
|
12028
|
-
*
|
|
12029
|
-
* _400 Bad Request_
|
|
12030
|
-
*
|
|
12031
|
-
* * The value in the `fulfillment_status` field is not valid.
|
|
12032
|
-
* * The client in the access token is not associated with a known organization.
|
|
12033
|
-
* * The owner of the client in the access token is not a member of the organization.
|
|
12034
|
-
*
|
|
12035
|
-
* _401 Unauthorized_
|
|
12036
|
-
*
|
|
12037
|
-
* * The Authorization header is required and must specify an app access token or user access token.
|
|
12038
|
-
* * The access token is not valid.
|
|
12039
|
-
* * The ID in the Client-Id header must match the Client ID in the access token.
|
|
12040
|
-
*
|
|
12041
|
-
* _500 Internal Server Error_
|
|
12042
|
-
*
|
|
12043
|
-
* @see https://dev.twitch.tv/docs/api/reference#update-drops-entitlements
|
|
12044
|
-
*/
|
|
12345
|
+
}[];
|
|
12045
12346
|
type: "global_first_party" | "global_third_party" | "channel_custom" | "display_only" | "sponsored";
|
|
12046
12347
|
order: number;
|
|
12047
12348
|
last_updated: string;
|
|
@@ -12089,7 +12390,7 @@ declare class TwitchApi {
|
|
|
12089
12390
|
*
|
|
12090
12391
|
* @see https://dev.twitch.tv/docs/api/reference#get-extension-transactions
|
|
12091
12392
|
*/
|
|
12092
|
-
getExtensionTransactions: (params: GetExtensionTransactionsParams, options
|
|
12393
|
+
getExtensionTransactions: (params: GetExtensionTransactionsParams, options?: CallApiOptions['options']) => Promise<{
|
|
12093
12394
|
ok: false;
|
|
12094
12395
|
status: 400 | 401 | 404;
|
|
12095
12396
|
data: unknown;
|
|
@@ -12164,7 +12465,7 @@ declare class TwitchApi {
|
|
|
12164
12465
|
*
|
|
12165
12466
|
* @see https://dev.twitch.tv/docs/api/reference#get-channel-information
|
|
12166
12467
|
*/
|
|
12167
|
-
getChannelInformation: (params: GetChannelInformationParams, options
|
|
12468
|
+
getChannelInformation: (params: GetChannelInformationParams, options?: CallApiOptions['options']) => Promise<{
|
|
12168
12469
|
ok: true;
|
|
12169
12470
|
status: 200;
|
|
12170
12471
|
data: {
|
|
@@ -12244,7 +12545,7 @@ declare class TwitchApi {
|
|
|
12244
12545
|
*
|
|
12245
12546
|
* @see https://dev.twitch.tv/docs/api/reference#modify-channel-information
|
|
12246
12547
|
*/
|
|
12247
|
-
modifyChannelInformation: (params: ModifyChannelInformationParams, body
|
|
12548
|
+
modifyChannelInformation: (params: ModifyChannelInformationParams, body?: ModifyChannelInformationBody | null | undefined, options?: CallApiOptions['options']) => Promise<{
|
|
12248
12549
|
ok: true;
|
|
12249
12550
|
status: 204;
|
|
12250
12551
|
data: void;
|
|
@@ -12268,7 +12569,7 @@ declare class TwitchApi {
|
|
|
12268
12569
|
*
|
|
12269
12570
|
* _200 OK_
|
|
12270
12571
|
*
|
|
12271
|
-
* Successfully retrieved the broadcaster
|
|
12572
|
+
* Successfully retrieved the broadcaster's list of editors.
|
|
12272
12573
|
*
|
|
12273
12574
|
* _400 Bad Request_
|
|
12274
12575
|
*
|
|
@@ -12284,7 +12585,7 @@ declare class TwitchApi {
|
|
|
12284
12585
|
*
|
|
12285
12586
|
* @see https://dev.twitch.tv/docs/api/reference#get-channel-editors
|
|
12286
12587
|
*/
|
|
12287
|
-
getChannelEditors: (params: GetChannelEditorsParams, options
|
|
12588
|
+
getChannelEditors: (params: GetChannelEditorsParams, options?: CallApiOptions['options']) => Promise<{
|
|
12288
12589
|
ok: true;
|
|
12289
12590
|
status: 200;
|
|
12290
12591
|
data: {
|
|
@@ -12314,7 +12615,7 @@ declare class TwitchApi {
|
|
|
12314
12615
|
*
|
|
12315
12616
|
* _200 OK_
|
|
12316
12617
|
*
|
|
12317
|
-
* Successfully retrieved the broadcaster
|
|
12618
|
+
* Successfully retrieved the broadcaster's list of followers.
|
|
12318
12619
|
*
|
|
12319
12620
|
* _400 Bad Request_
|
|
12320
12621
|
*
|
|
@@ -12336,7 +12637,7 @@ declare class TwitchApi {
|
|
|
12336
12637
|
*
|
|
12337
12638
|
* @see https://dev.twitch.tv/docs/api/reference#get-followed-channels
|
|
12338
12639
|
*/
|
|
12339
|
-
getFollowedChannels: (params: GetFollowedChannelsParams, options
|
|
12640
|
+
getFollowedChannels: (params: GetFollowedChannelsParams, options?: CallApiOptions['options']) => Promise<{
|
|
12340
12641
|
ok: false;
|
|
12341
12642
|
status: 400 | 401;
|
|
12342
12643
|
data: unknown;
|
|
@@ -12347,42 +12648,7 @@ declare class TwitchApi {
|
|
|
12347
12648
|
data: {
|
|
12348
12649
|
broadcaster_id: string;
|
|
12349
12650
|
broadcaster_login: string;
|
|
12350
|
-
broadcaster_name: string;
|
|
12351
|
-
* Gets a list of broadcasters that are streaming live and have installed or activated the extension.
|
|
12352
|
-
*
|
|
12353
|
-
* It may take a few minutes for the list to include or remove broadcasters that have recently gone live or stopped broadcasting.
|
|
12354
|
-
*
|
|
12355
|
-
* __Authorization:__
|
|
12356
|
-
*
|
|
12357
|
-
* 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).
|
|
12358
|
-
*
|
|
12359
|
-
* __URL:__
|
|
12360
|
-
*
|
|
12361
|
-
* `GET https://api.twitch.tv/helix/extensions/live`
|
|
12362
|
-
*
|
|
12363
|
-
* __Response Codes:__
|
|
12364
|
-
*
|
|
12365
|
-
* _200 OK_
|
|
12366
|
-
*
|
|
12367
|
-
* Successfully retrieved the list of broadcasters.
|
|
12368
|
-
*
|
|
12369
|
-
* _400 Bad Request_
|
|
12370
|
-
*
|
|
12371
|
-
* * The _extension\_id_ query parameter is required.
|
|
12372
|
-
* * The pagination cursor is not valid.
|
|
12373
|
-
*
|
|
12374
|
-
* _401 Unauthorized_
|
|
12375
|
-
*
|
|
12376
|
-
* * The Authorization header is required and must specify an app access token or user access token.
|
|
12377
|
-
* * The access token is not valid.
|
|
12378
|
-
* * The ID in the Client-Id header must match the client ID in the access token.
|
|
12379
|
-
*
|
|
12380
|
-
* _404 Not Found_
|
|
12381
|
-
*
|
|
12382
|
-
* * The extension specified in the _extension\_id_ query parameter was not found or it's not being used in a live stream.
|
|
12383
|
-
*
|
|
12384
|
-
* @see https://dev.twitch.tv/docs/api/reference#get-extension-live-channels
|
|
12385
|
-
*/
|
|
12651
|
+
broadcaster_name: string;
|
|
12386
12652
|
followed_at: string;
|
|
12387
12653
|
}[];
|
|
12388
12654
|
pagination?: {
|
|
@@ -12431,7 +12697,7 @@ declare class TwitchApi {
|
|
|
12431
12697
|
*
|
|
12432
12698
|
* @see https://dev.twitch.tv/docs/api/reference#get-channel-followers
|
|
12433
12699
|
*/
|
|
12434
|
-
getChannelFollowers: (params: GetChannelFollowersParams, options
|
|
12700
|
+
getChannelFollowers: (params: GetChannelFollowersParams, options?: CallApiOptions['options']) => Promise<{
|
|
12435
12701
|
ok: false;
|
|
12436
12702
|
status: 400 | 401;
|
|
12437
12703
|
data: unknown;
|
|
@@ -12499,7 +12765,7 @@ declare class TwitchApi {
|
|
|
12499
12765
|
*
|
|
12500
12766
|
* @see https://dev.twitch.tv/docs/api/reference#create-custom-rewards
|
|
12501
12767
|
*/
|
|
12502
|
-
createCustomRewards: (params: CreateCustomRewardsParams, body: CreateCustomRewardsBody, options
|
|
12768
|
+
createCustomRewards: (params: CreateCustomRewardsParams, body: CreateCustomRewardsBody, options?: CallApiOptions['options']) => Promise<{
|
|
12503
12769
|
ok: true;
|
|
12504
12770
|
status: 200;
|
|
12505
12771
|
data: {
|
|
@@ -12592,7 +12858,7 @@ declare class TwitchApi {
|
|
|
12592
12858
|
*
|
|
12593
12859
|
* @see https://dev.twitch.tv/docs/api/reference#delete-custom-reward
|
|
12594
12860
|
*/
|
|
12595
|
-
deleteCustomReward: (params: DeleteCustomRewardParams, options
|
|
12861
|
+
deleteCustomReward: (params: DeleteCustomRewardParams, options?: CallApiOptions['options']) => Promise<{
|
|
12596
12862
|
ok: true;
|
|
12597
12863
|
status: 204;
|
|
12598
12864
|
data: void;
|
|
@@ -12644,7 +12910,7 @@ declare class TwitchApi {
|
|
|
12644
12910
|
*
|
|
12645
12911
|
* @see https://dev.twitch.tv/docs/api/reference#get-custom-reward
|
|
12646
12912
|
*/
|
|
12647
|
-
getCustomReward: (params: GetCustomRewardParams, options
|
|
12913
|
+
getCustomReward: (params: GetCustomRewardParams, options?: CallApiOptions['options']) => Promise<{
|
|
12648
12914
|
ok: false;
|
|
12649
12915
|
status: 400 | 401 | 403 | 404 | 500;
|
|
12650
12916
|
data: unknown;
|
|
@@ -12746,7 +13012,7 @@ declare class TwitchApi {
|
|
|
12746
13012
|
*
|
|
12747
13013
|
* @see https://dev.twitch.tv/docs/api/reference#update-custom-reward
|
|
12748
13014
|
*/
|
|
12749
|
-
updateCustomReward: (params: UpdateCustomRewardParams, body
|
|
13015
|
+
updateCustomReward: (params: UpdateCustomRewardParams, body?: UpdateCustomRewardBody | null | undefined, options?: CallApiOptions['options']) => Promise<{
|
|
12750
13016
|
ok: false;
|
|
12751
13017
|
status: 400 | 401 | 403 | 404 | 500;
|
|
12752
13018
|
data: unknown;
|
|
@@ -12840,7 +13106,7 @@ declare class TwitchApi {
|
|
|
12840
13106
|
*
|
|
12841
13107
|
* @see https://dev.twitch.tv/docs/api/reference#get-custom-reward-redemption
|
|
12842
13108
|
*/
|
|
12843
|
-
getCustomRewardRedemption: (params: GetCustomRewardRedemptionParams, options
|
|
13109
|
+
getCustomRewardRedemption: (params: GetCustomRewardRedemptionParams, options?: CallApiOptions['options']) => Promise<{
|
|
12844
13110
|
ok: false;
|
|
12845
13111
|
status: 400 | 401 | 403 | 404 | 500;
|
|
12846
13112
|
data: unknown;
|
|
@@ -12851,7 +13117,42 @@ declare class TwitchApi {
|
|
|
12851
13117
|
data: {
|
|
12852
13118
|
broadcaster_id: string;
|
|
12853
13119
|
broadcaster_login: string;
|
|
12854
|
-
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
|
+
*/
|
|
12855
13156
|
id: string;
|
|
12856
13157
|
user_id: string;
|
|
12857
13158
|
user_name: string;
|
|
@@ -12913,7 +13214,7 @@ declare class TwitchApi {
|
|
|
12913
13214
|
*
|
|
12914
13215
|
* @see https://dev.twitch.tv/docs/api/reference#update-redemption-status
|
|
12915
13216
|
*/
|
|
12916
|
-
updateRedemptionStatus: (params: UpdateRedemptionStatusParams, body: UpdateRedemptionStatusBody, options
|
|
13217
|
+
updateRedemptionStatus: (params: UpdateRedemptionStatusParams, body: UpdateRedemptionStatusBody, options?: CallApiOptions['options']) => Promise<{
|
|
12917
13218
|
ok: false;
|
|
12918
13219
|
status: 400 | 401 | 403 | 404 | 500;
|
|
12919
13220
|
data: unknown;
|
|
@@ -12924,7 +13225,42 @@ declare class TwitchApi {
|
|
|
12924
13225
|
data: {
|
|
12925
13226
|
broadcaster_id: string;
|
|
12926
13227
|
broadcaster_login: string;
|
|
12927
|
-
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
|
+
*/
|
|
12928
13264
|
id: string;
|
|
12929
13265
|
user_id: string;
|
|
12930
13266
|
user_name: string;
|
|
@@ -12981,7 +13317,7 @@ declare class TwitchApi {
|
|
|
12981
13317
|
*
|
|
12982
13318
|
* @see https://dev.twitch.tv/docs/api/reference#get-charity-campaign
|
|
12983
13319
|
*/
|
|
12984
|
-
getCharityCampaign: (params: GetCharityCampaignParams, options
|
|
13320
|
+
getCharityCampaign: (params: GetCharityCampaignParams, options?: CallApiOptions['options']) => Promise<{
|
|
12985
13321
|
ok: false;
|
|
12986
13322
|
status: 400 | 401 | 403;
|
|
12987
13323
|
data: unknown;
|
|
@@ -13049,7 +13385,7 @@ declare class TwitchApi {
|
|
|
13049
13385
|
*
|
|
13050
13386
|
* @see https://dev.twitch.tv/docs/api/reference#get-charity-campaign-donations
|
|
13051
13387
|
*/
|
|
13052
|
-
getCharityCampaignDonations: (params: GetCharityCampaignDonationsParams, options
|
|
13388
|
+
getCharityCampaignDonations: (params: GetCharityCampaignDonationsParams, options?: CallApiOptions['options']) => Promise<{
|
|
13053
13389
|
ok: false;
|
|
13054
13390
|
status: 400 | 401 | 403;
|
|
13055
13391
|
data: unknown;
|
|
@@ -13057,38 +13393,6 @@ declare class TwitchApi {
|
|
|
13057
13393
|
ok: true;
|
|
13058
13394
|
status: 200;
|
|
13059
13395
|
data: {
|
|
13060
|
-
/**
|
|
13061
|
-
* Gets information about specified categories or games.
|
|
13062
|
-
*
|
|
13063
|
-
* You may get up to 100 categories or games by specifying their ID or name. You may specify all IDs, all names, or a combination of IDs and names. If you specify a combination of IDs and names, the total number of IDs and names must not exceed 100.
|
|
13064
|
-
*
|
|
13065
|
-
* __Authorization:__
|
|
13066
|
-
*
|
|
13067
|
-
* 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).
|
|
13068
|
-
*
|
|
13069
|
-
* __URL:__
|
|
13070
|
-
*
|
|
13071
|
-
* `GET https://api.twitch.tv/helix/games`
|
|
13072
|
-
*
|
|
13073
|
-
* __Response Codes:__
|
|
13074
|
-
*
|
|
13075
|
-
* _200 OK_
|
|
13076
|
-
*
|
|
13077
|
-
* Successfully retrieved the specified games.
|
|
13078
|
-
*
|
|
13079
|
-
* _400 Bad Request_
|
|
13080
|
-
*
|
|
13081
|
-
* * The request must specify the _id_ or _name_ or _igdb\_id_ query parameter.
|
|
13082
|
-
* * The combined number of game IDs (_id_ and _igdb\_id_) and game names that you specify in the request must not exceed 100.
|
|
13083
|
-
*
|
|
13084
|
-
* _401 Unauthorized_
|
|
13085
|
-
*
|
|
13086
|
-
* * The Authorization header is required and must specify an app access token or user access token.
|
|
13087
|
-
* * The access token is not valid.
|
|
13088
|
-
* * The ID in the Client-Id header must match the client ID in the access token.
|
|
13089
|
-
*
|
|
13090
|
-
* @see https://dev.twitch.tv/docs/api/reference#get-games
|
|
13091
|
-
*/
|
|
13092
13396
|
data: {
|
|
13093
13397
|
id: string;
|
|
13094
13398
|
campaign_id: string;
|
|
@@ -13150,7 +13454,7 @@ declare class TwitchApi {
|
|
|
13150
13454
|
*
|
|
13151
13455
|
* @see https://dev.twitch.tv/docs/api/reference#get-chatters
|
|
13152
13456
|
*/
|
|
13153
|
-
getChatters: (params: GetChattersParams, options
|
|
13457
|
+
getChatters: (params: GetChattersParams, options?: CallApiOptions['options']) => Promise<{
|
|
13154
13458
|
ok: false;
|
|
13155
13459
|
status: 400 | 401 | 403;
|
|
13156
13460
|
data: unknown;
|
|
@@ -13188,7 +13492,7 @@ declare class TwitchApi {
|
|
|
13188
13492
|
*
|
|
13189
13493
|
* _200 OK_
|
|
13190
13494
|
*
|
|
13191
|
-
* Successfully retrieved broadcaster
|
|
13495
|
+
* Successfully retrieved broadcaster's list of custom emotes.
|
|
13192
13496
|
*
|
|
13193
13497
|
* _400 Bad Request_
|
|
13194
13498
|
*
|
|
@@ -13202,7 +13506,7 @@ declare class TwitchApi {
|
|
|
13202
13506
|
*
|
|
13203
13507
|
* @see https://dev.twitch.tv/docs/api/reference#get-channel-emotes
|
|
13204
13508
|
*/
|
|
13205
|
-
getChannelEmotes: (params: GetChannelEmotesParams, options
|
|
13509
|
+
getChannelEmotes: (params: GetChannelEmotesParams, options?: CallApiOptions['options']) => Promise<{
|
|
13206
13510
|
ok: false;
|
|
13207
13511
|
status: 400 | 401;
|
|
13208
13512
|
data: unknown;
|
|
@@ -13249,7 +13553,7 @@ declare class TwitchApi {
|
|
|
13249
13553
|
*
|
|
13250
13554
|
* _200 OK_
|
|
13251
13555
|
*
|
|
13252
|
-
* Successfully retrieved Twitch
|
|
13556
|
+
* Successfully retrieved Twitch's list of global emotes.
|
|
13253
13557
|
*
|
|
13254
13558
|
* _401 Unauthorized_
|
|
13255
13559
|
*
|
|
@@ -13259,7 +13563,7 @@ declare class TwitchApi {
|
|
|
13259
13563
|
*
|
|
13260
13564
|
* @see https://dev.twitch.tv/docs/api/reference#get-global-emotes
|
|
13261
13565
|
*/
|
|
13262
|
-
getGlobalEmotes: (options
|
|
13566
|
+
getGlobalEmotes: (options?: CallApiOptions['options']) => Promise<{
|
|
13263
13567
|
ok: false;
|
|
13264
13568
|
status: 401;
|
|
13265
13569
|
data: unknown;
|
|
@@ -13316,7 +13620,7 @@ declare class TwitchApi {
|
|
|
13316
13620
|
*
|
|
13317
13621
|
* @see https://dev.twitch.tv/docs/api/reference#get-emote-sets
|
|
13318
13622
|
*/
|
|
13319
|
-
getEmoteSets: (params: GetEmoteSetsParams, options
|
|
13623
|
+
getEmoteSets: (params: GetEmoteSetsParams, options?: CallApiOptions['options']) => Promise<{
|
|
13320
13624
|
ok: false;
|
|
13321
13625
|
status: 400 | 401;
|
|
13322
13626
|
data: unknown;
|
|
@@ -13371,7 +13675,7 @@ declare class TwitchApi {
|
|
|
13371
13675
|
*
|
|
13372
13676
|
* @see https://dev.twitch.tv/docs/api/reference#get-channel-chat-badges
|
|
13373
13677
|
*/
|
|
13374
|
-
getChannelChatBadges: (params: GetChannelChatBadgesParams, options
|
|
13678
|
+
getChannelChatBadges: (params: GetChannelChatBadgesParams, options?: CallApiOptions['options']) => Promise<{
|
|
13375
13679
|
ok: false;
|
|
13376
13680
|
status: 400 | 401;
|
|
13377
13681
|
data: unknown;
|
|
@@ -13423,7 +13727,7 @@ declare class TwitchApi {
|
|
|
13423
13727
|
*
|
|
13424
13728
|
* @see https://dev.twitch.tv/docs/api/reference#get-global-chat-badges
|
|
13425
13729
|
*/
|
|
13426
|
-
getGlobalChatBadges: (options
|
|
13730
|
+
getGlobalChatBadges: (options?: CallApiOptions['options']) => Promise<{
|
|
13427
13731
|
ok: false;
|
|
13428
13732
|
status: 401;
|
|
13429
13733
|
data: unknown;
|
|
@@ -13477,7 +13781,7 @@ declare class TwitchApi {
|
|
|
13477
13781
|
*
|
|
13478
13782
|
* @see https://dev.twitch.tv/docs/api/reference#get-chat-settings
|
|
13479
13783
|
*/
|
|
13480
|
-
getChatSettings: (params: GetChatSettingsParams, options
|
|
13784
|
+
getChatSettings: (params: GetChatSettingsParams, options?: CallApiOptions['options']) => Promise<{
|
|
13481
13785
|
ok: false;
|
|
13482
13786
|
status: 400 | 401;
|
|
13483
13787
|
data: unknown;
|
|
@@ -13549,7 +13853,7 @@ declare class TwitchApi {
|
|
|
13549
13853
|
*
|
|
13550
13854
|
* @see https://dev.twitch.tv/docs/api/reference#update-chat-settings
|
|
13551
13855
|
*/
|
|
13552
|
-
updateChatSettings: (params: UpdateChatSettingsParams, body
|
|
13856
|
+
updateChatSettings: (params: UpdateChatSettingsParams, body?: UpdateChatSettingsBody | null | undefined, options?: CallApiOptions['options']) => Promise<{
|
|
13553
13857
|
ok: false;
|
|
13554
13858
|
status: 400 | 401 | 403;
|
|
13555
13859
|
data: unknown;
|
|
@@ -13572,6 +13876,63 @@ declare class TwitchApi {
|
|
|
13572
13876
|
}[];
|
|
13573
13877
|
};
|
|
13574
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
|
+
}>;
|
|
13575
13936
|
/**
|
|
13576
13937
|
* Sends an announcement to the broadcaster’s chat room.
|
|
13577
13938
|
*
|
|
@@ -13605,7 +13966,7 @@ declare class TwitchApi {
|
|
|
13605
13966
|
*
|
|
13606
13967
|
* @see https://dev.twitch.tv/docs/api/reference#send-chat-announcement
|
|
13607
13968
|
*/
|
|
13608
|
-
sendChatAnnouncement: (params: SendChatAnnouncementParams, body: SendChatAnnouncementBody, options
|
|
13969
|
+
sendChatAnnouncement: (params: SendChatAnnouncementParams, body: SendChatAnnouncementBody, options?: CallApiOptions['options']) => Promise<{
|
|
13609
13970
|
ok: true;
|
|
13610
13971
|
status: 204;
|
|
13611
13972
|
data: void;
|
|
@@ -13666,7 +14027,7 @@ declare class TwitchApi {
|
|
|
13666
14027
|
*
|
|
13667
14028
|
* @see https://dev.twitch.tv/docs/api/reference#send-a-shoutout
|
|
13668
14029
|
*/
|
|
13669
|
-
sendShoutout: (params: SendShoutoutParams, options
|
|
14030
|
+
sendShoutout: (params: SendShoutoutParams, options?: CallApiOptions['options']) => Promise<{
|
|
13670
14031
|
ok: true;
|
|
13671
14032
|
status: 204;
|
|
13672
14033
|
data: void;
|
|
@@ -13719,7 +14080,7 @@ declare class TwitchApi {
|
|
|
13719
14080
|
*
|
|
13720
14081
|
* @see https://dev.twitch.tv/docs/api/reference#send-chat-message
|
|
13721
14082
|
*/
|
|
13722
|
-
sendChatMessage: (body: SendChatMessageBody, options
|
|
14083
|
+
sendChatMessage: (body: SendChatMessageBody, options?: CallApiOptions['options']) => Promise<{
|
|
13723
14084
|
ok: true;
|
|
13724
14085
|
status: 200;
|
|
13725
14086
|
data: {
|
|
@@ -13766,7 +14127,7 @@ declare class TwitchApi {
|
|
|
13766
14127
|
*
|
|
13767
14128
|
* @see https://dev.twitch.tv/docs/api/reference#get-user-chat-color
|
|
13768
14129
|
*/
|
|
13769
|
-
getUserChatColor: (params: GetUserChatColorParams, options
|
|
14130
|
+
getUserChatColor: (params: GetUserChatColorParams, options?: CallApiOptions['options']) => Promise<{
|
|
13770
14131
|
ok: false;
|
|
13771
14132
|
status: 400 | 401;
|
|
13772
14133
|
data: unknown;
|
|
@@ -13816,7 +14177,7 @@ declare class TwitchApi {
|
|
|
13816
14177
|
*
|
|
13817
14178
|
* @see https://dev.twitch.tv/docs/api/reference#update-user-chat-color
|
|
13818
14179
|
*/
|
|
13819
|
-
updateUserChatColor: (params: UpdateUserChatColorParams, options
|
|
14180
|
+
updateUserChatColor: (params: UpdateUserChatColorParams, options?: CallApiOptions['options']) => Promise<{
|
|
13820
14181
|
ok: true;
|
|
13821
14182
|
status: 204;
|
|
13822
14183
|
data: void;
|
|
@@ -13873,7 +14234,7 @@ declare class TwitchApi {
|
|
|
13873
14234
|
*
|
|
13874
14235
|
* @see https://dev.twitch.tv/docs/api/reference#create-clip
|
|
13875
14236
|
*/
|
|
13876
|
-
createClip: (params: CreateClipParams, options
|
|
14237
|
+
createClip: (params: CreateClipParams, options?: CallApiOptions['options']) => Promise<{
|
|
13877
14238
|
ok: true;
|
|
13878
14239
|
status: 202;
|
|
13879
14240
|
data: {
|
|
@@ -13925,7 +14286,7 @@ declare class TwitchApi {
|
|
|
13925
14286
|
*
|
|
13926
14287
|
* @see https://dev.twitch.tv/docs/api/reference#get-clips
|
|
13927
14288
|
*/
|
|
13928
|
-
getClips: (params
|
|
14289
|
+
getClips: (params?: GetClipsParams | null | undefined, options?: CallApiOptions['options']) => Promise<{
|
|
13929
14290
|
ok: false;
|
|
13930
14291
|
status: 400 | 401 | 404;
|
|
13931
14292
|
data: unknown;
|
|
@@ -13942,7 +14303,37 @@ declare class TwitchApi {
|
|
|
13942
14303
|
creator_id: string;
|
|
13943
14304
|
creator_name: string;
|
|
13944
14305
|
video_id: string;
|
|
13945
|
-
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
|
+
*/
|
|
13946
14337
|
language: string;
|
|
13947
14338
|
title: string;
|
|
13948
14339
|
view_count: number;
|
|
@@ -13954,37 +14345,7 @@ declare class TwitchApi {
|
|
|
13954
14345
|
}[];
|
|
13955
14346
|
pagination?: {
|
|
13956
14347
|
cursor?: string;
|
|
13957
|
-
};
|
|
13958
|
-
* Gets all users that the broadcaster banned or put in a timeout.
|
|
13959
|
-
*
|
|
13960
|
-
* __Authorization:__
|
|
13961
|
-
*
|
|
13962
|
-
* 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.
|
|
13963
|
-
*
|
|
13964
|
-
* __URL:__
|
|
13965
|
-
*
|
|
13966
|
-
* `GET https://api.twitch.tv/helix/moderation/banned`
|
|
13967
|
-
*
|
|
13968
|
-
* __Response Codes:__
|
|
13969
|
-
*
|
|
13970
|
-
* _200 OK_
|
|
13971
|
-
*
|
|
13972
|
-
* Successfully retrieved the list of banned users.
|
|
13973
|
-
*
|
|
13974
|
-
* _400 Bad Request_
|
|
13975
|
-
*
|
|
13976
|
-
* * The _broadcaster\_id_ query parameter is required.
|
|
13977
|
-
*
|
|
13978
|
-
* _401 Unauthorized_
|
|
13979
|
-
*
|
|
13980
|
-
* * The ID in _broadcaster\_id_ must match the user ID in the user access token.
|
|
13981
|
-
* * The Authorization header is required and must contain a user access token.
|
|
13982
|
-
* * The user access token must include the **moderation:read** scope.
|
|
13983
|
-
* * The access token is not valid.
|
|
13984
|
-
* * The client ID specified in the Client-Id header does not match the client ID specified in the access token.
|
|
13985
|
-
*
|
|
13986
|
-
* @see https://dev.twitch.tv/docs/api/reference#get-banned-users
|
|
13987
|
-
*/
|
|
14348
|
+
};
|
|
13988
14349
|
};
|
|
13989
14350
|
}>;
|
|
13990
14351
|
};
|
|
@@ -14012,7 +14373,7 @@ declare class TwitchApi {
|
|
|
14012
14373
|
*
|
|
14013
14374
|
* @see https://dev.twitch.tv/docs/api/reference#get-conduits
|
|
14014
14375
|
*/
|
|
14015
|
-
getConduits: (options
|
|
14376
|
+
getConduits: (options?: CallApiOptions['options']) => Promise<{
|
|
14016
14377
|
ok: false;
|
|
14017
14378
|
status: 401;
|
|
14018
14379
|
data: unknown;
|
|
@@ -14057,7 +14418,7 @@ declare class TwitchApi {
|
|
|
14057
14418
|
*
|
|
14058
14419
|
* @see https://dev.twitch.tv/docs/api/reference#create-conduits
|
|
14059
14420
|
*/
|
|
14060
|
-
createConduits: (body: CreateConduitsBody, options
|
|
14421
|
+
createConduits: (body: CreateConduitsBody, options?: CallApiOptions['options']) => Promise<{
|
|
14061
14422
|
ok: true;
|
|
14062
14423
|
status: 200;
|
|
14063
14424
|
data: {
|
|
@@ -14104,7 +14465,7 @@ declare class TwitchApi {
|
|
|
14104
14465
|
*
|
|
14105
14466
|
* @see https://dev.twitch.tv/docs/api/reference#update-conduits
|
|
14106
14467
|
*/
|
|
14107
|
-
updateConduits: (body: UpdateConduitsBody, options
|
|
14468
|
+
updateConduits: (body: UpdateConduitsBody, options?: CallApiOptions['options']) => Promise<{
|
|
14108
14469
|
ok: false;
|
|
14109
14470
|
status: 400 | 401 | 404;
|
|
14110
14471
|
data: unknown;
|
|
@@ -14150,7 +14511,7 @@ declare class TwitchApi {
|
|
|
14150
14511
|
*
|
|
14151
14512
|
* @see https://dev.twitch.tv/docs/api/reference#delete-conduit
|
|
14152
14513
|
*/
|
|
14153
|
-
deleteConduit: (params: DeleteConduitParams, options
|
|
14514
|
+
deleteConduit: (params: DeleteConduitParams, options?: CallApiOptions['options']) => Promise<{
|
|
14154
14515
|
ok: false;
|
|
14155
14516
|
status: 400 | 401 | 404;
|
|
14156
14517
|
data: unknown;
|
|
@@ -14191,7 +14552,7 @@ declare class TwitchApi {
|
|
|
14191
14552
|
*
|
|
14192
14553
|
* @see https://dev.twitch.tv/docs/api/reference#get-conduit-shards
|
|
14193
14554
|
*/
|
|
14194
|
-
getConduitShards: (params: GetConduitShardsParams, options
|
|
14555
|
+
getConduitShards: (params: GetConduitShardsParams, options?: CallApiOptions['options']) => Promise<{
|
|
14195
14556
|
ok: false;
|
|
14196
14557
|
status: 400 | 401 | 404;
|
|
14197
14558
|
data: unknown;
|
|
@@ -14208,7 +14569,42 @@ declare class TwitchApi {
|
|
|
14208
14569
|
session_id?: string;
|
|
14209
14570
|
connected_at?: string;
|
|
14210
14571
|
disconnected_at?: string;
|
|
14211
|
-
};
|
|
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
|
+
*/
|
|
14212
14608
|
}[];
|
|
14213
14609
|
pagination?: {
|
|
14214
14610
|
cursor?: string;
|
|
@@ -14249,7 +14645,7 @@ declare class TwitchApi {
|
|
|
14249
14645
|
*
|
|
14250
14646
|
* @see https://dev.twitch.tv/docs/api/reference#update-conduit-shards
|
|
14251
14647
|
*/
|
|
14252
|
-
updateConduitShards: (body: UpdateConduitShardsBody, options
|
|
14648
|
+
updateConduitShards: (body: UpdateConduitShardsBody, options?: CallApiOptions['options']) => Promise<{
|
|
14253
14649
|
ok: false;
|
|
14254
14650
|
status: 400 | 401 | 404;
|
|
14255
14651
|
data: unknown;
|
|
@@ -14302,7 +14698,7 @@ declare class TwitchApi {
|
|
|
14302
14698
|
*
|
|
14303
14699
|
* @see https://dev.twitch.tv/docs/api/reference#get-content-classification-labels
|
|
14304
14700
|
*/
|
|
14305
|
-
getContentClassificationLabels: (params
|
|
14701
|
+
getContentClassificationLabels: (params?: GetContentClassificationLabelsParams | null | undefined, options?: CallApiOptions['options']) => Promise<{
|
|
14306
14702
|
ok: true;
|
|
14307
14703
|
status: 200;
|
|
14308
14704
|
data: {
|
|
@@ -14322,6 +14718,8 @@ declare class TwitchApi {
|
|
|
14322
14718
|
/**
|
|
14323
14719
|
* Gets an organization’s list of entitlements that have been granted to a game, a user, or both.
|
|
14324
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
|
+
*
|
|
14325
14723
|
* The following table identifies the request parameters that you may specify based on the type of access token used.
|
|
14326
14724
|
*
|
|
14327
14725
|
* | Access token type | Parameter | Description |
|
|
@@ -14372,7 +14770,7 @@ declare class TwitchApi {
|
|
|
14372
14770
|
*
|
|
14373
14771
|
* @see https://dev.twitch.tv/docs/api/reference#get-drops-entitlements
|
|
14374
14772
|
*/
|
|
14375
|
-
getDropsEntitlements: (params
|
|
14773
|
+
getDropsEntitlements: (params?: GetDropsEntitlementsParams | null | undefined, options?: CallApiOptions['options']) => Promise<{
|
|
14376
14774
|
ok: false;
|
|
14377
14775
|
status: 400 | 401 | 403 | 500;
|
|
14378
14776
|
data: unknown;
|
|
@@ -14435,7 +14833,7 @@ declare class TwitchApi {
|
|
|
14435
14833
|
*
|
|
14436
14834
|
* @see https://dev.twitch.tv/docs/api/reference#update-drops-entitlements
|
|
14437
14835
|
*/
|
|
14438
|
-
updateDropsEntitlements: (body
|
|
14836
|
+
updateDropsEntitlements: (body?: UpdateDropsEntitlementsBody | null | undefined, options?: CallApiOptions['options']) => Promise<{
|
|
14439
14837
|
ok: false;
|
|
14440
14838
|
status: 400 | 401 | 500;
|
|
14441
14839
|
data: unknown;
|
|
@@ -14488,7 +14886,7 @@ declare class TwitchApi {
|
|
|
14488
14886
|
*
|
|
14489
14887
|
* @see https://dev.twitch.tv/docs/api/reference#get-extension-configuration-segment
|
|
14490
14888
|
*/
|
|
14491
|
-
getExtensionConfigurationSegment: (params: GetExtensionConfigurationSegmentParams, options
|
|
14889
|
+
getExtensionConfigurationSegment: (params: GetExtensionConfigurationSegmentParams, options?: CallApiOptions['options']) => Promise<{
|
|
14492
14890
|
ok: false;
|
|
14493
14891
|
status: 400 | 401 | 429;
|
|
14494
14892
|
data: unknown;
|
|
@@ -14535,7 +14933,7 @@ declare class TwitchApi {
|
|
|
14535
14933
|
*
|
|
14536
14934
|
* @see https://dev.twitch.tv/docs/api/reference#set-extension-configuration-segment
|
|
14537
14935
|
*/
|
|
14538
|
-
setExtensionConfigurationSegment: (body: SetExtensionConfigurationSegmentBody, options
|
|
14936
|
+
setExtensionConfigurationSegment: (body: SetExtensionConfigurationSegmentBody, options?: CallApiOptions['options']) => Promise<{
|
|
14539
14937
|
ok: true;
|
|
14540
14938
|
status: 204;
|
|
14541
14939
|
data: void;
|
|
@@ -14576,7 +14974,7 @@ declare class TwitchApi {
|
|
|
14576
14974
|
*
|
|
14577
14975
|
* @see https://dev.twitch.tv/docs/api/reference#set-extension-required-configuration
|
|
14578
14976
|
*/
|
|
14579
|
-
setExtensionRequiredConfiguration: (params: SetExtensionRequiredConfigurationParams, body: SetExtensionRequiredConfigurationBody, options
|
|
14977
|
+
setExtensionRequiredConfiguration: (params: SetExtensionRequiredConfigurationParams, body: SetExtensionRequiredConfigurationBody, options?: CallApiOptions['options']) => Promise<{
|
|
14580
14978
|
ok: true;
|
|
14581
14979
|
status: 204;
|
|
14582
14980
|
data: void;
|
|
@@ -14654,7 +15052,7 @@ declare class TwitchApi {
|
|
|
14654
15052
|
*
|
|
14655
15053
|
* @see https://dev.twitch.tv/docs/api/reference#send-extension-pubsub-message
|
|
14656
15054
|
*/
|
|
14657
|
-
sendExtensionPubSubMessage: (body: SendExtensionPubSubMessageBody, options
|
|
15055
|
+
sendExtensionPubSubMessage: (body: SendExtensionPubSubMessageBody, options?: CallApiOptions['options']) => Promise<{
|
|
14658
15056
|
ok: true;
|
|
14659
15057
|
status: 204;
|
|
14660
15058
|
data: void;
|
|
@@ -14699,7 +15097,7 @@ declare class TwitchApi {
|
|
|
14699
15097
|
*
|
|
14700
15098
|
* @see https://dev.twitch.tv/docs/api/reference#get-extension-live-channels
|
|
14701
15099
|
*/
|
|
14702
|
-
getExtensionLiveChannels: (params: GetExtensionLiveChannelsParams, options
|
|
15100
|
+
getExtensionLiveChannels: (params: GetExtensionLiveChannelsParams, options?: CallApiOptions['options']) => Promise<{
|
|
14703
15101
|
ok: false;
|
|
14704
15102
|
status: 400 | 401 | 404;
|
|
14705
15103
|
data: unknown;
|
|
@@ -14746,7 +15144,7 @@ declare class TwitchApi {
|
|
|
14746
15144
|
*
|
|
14747
15145
|
* @see https://dev.twitch.tv/docs/api/reference#get-extension-secrets
|
|
14748
15146
|
*/
|
|
14749
|
-
getExtensionSecrets: (options
|
|
15147
|
+
getExtensionSecrets: (options?: CallApiOptions['options']) => Promise<{
|
|
14750
15148
|
ok: false;
|
|
14751
15149
|
status: 400 | 401;
|
|
14752
15150
|
data: unknown;
|
|
@@ -14794,7 +15192,7 @@ declare class TwitchApi {
|
|
|
14794
15192
|
*
|
|
14795
15193
|
* @see https://dev.twitch.tv/docs/api/reference#create-extension-secret
|
|
14796
15194
|
*/
|
|
14797
|
-
createExtensionSecret: (params: CreateExtensionSecretParams, options
|
|
15195
|
+
createExtensionSecret: (params: CreateExtensionSecretParams, options?: CallApiOptions['options']) => Promise<{
|
|
14798
15196
|
ok: false;
|
|
14799
15197
|
status: 400 | 401;
|
|
14800
15198
|
data: unknown;
|
|
@@ -14848,7 +15246,7 @@ declare class TwitchApi {
|
|
|
14848
15246
|
*
|
|
14849
15247
|
* @see https://dev.twitch.tv/docs/api/reference#send-extension-chat-message
|
|
14850
15248
|
*/
|
|
14851
|
-
sendExtensionChatMessage: (params: SendExtensionChatMessageParams, body: SendExtensionChatMessageBody, options
|
|
15249
|
+
sendExtensionChatMessage: (params: SendExtensionChatMessageParams, body: SendExtensionChatMessageBody, options?: CallApiOptions['options']) => Promise<{
|
|
14852
15250
|
ok: true;
|
|
14853
15251
|
status: 204;
|
|
14854
15252
|
data: void;
|
|
@@ -14891,7 +15289,7 @@ declare class TwitchApi {
|
|
|
14891
15289
|
*
|
|
14892
15290
|
* @see https://dev.twitch.tv/docs/api/reference#get-extensions
|
|
14893
15291
|
*/
|
|
14894
|
-
getExtensions: (params: GetExtensionsParams, options
|
|
15292
|
+
getExtensions: (params: GetExtensionsParams, options?: CallApiOptions['options']) => Promise<{
|
|
14895
15293
|
ok: false;
|
|
14896
15294
|
status: 400 | 401 | 404;
|
|
14897
15295
|
data: unknown;
|
|
@@ -14989,7 +15387,7 @@ declare class TwitchApi {
|
|
|
14989
15387
|
*
|
|
14990
15388
|
* @see https://dev.twitch.tv/docs/api/reference#get-released-extensions
|
|
14991
15389
|
*/
|
|
14992
|
-
getReleasedExtensions: (params: GetReleasedExtensionsParams, options
|
|
15390
|
+
getReleasedExtensions: (params: GetReleasedExtensionsParams, options?: CallApiOptions['options']) => Promise<{
|
|
14993
15391
|
ok: false;
|
|
14994
15392
|
status: 400 | 401 | 404;
|
|
14995
15393
|
data: unknown;
|
|
@@ -15083,7 +15481,7 @@ declare class TwitchApi {
|
|
|
15083
15481
|
*
|
|
15084
15482
|
* @see https://dev.twitch.tv/docs/api/reference#get-extension-bits-products
|
|
15085
15483
|
*/
|
|
15086
|
-
getExtensionBitsProducts: (params
|
|
15484
|
+
getExtensionBitsProducts: (params?: GetExtensionBitsProductsParams | null | undefined, options?: CallApiOptions['options']) => Promise<{
|
|
15087
15485
|
ok: false;
|
|
15088
15486
|
status: 400 | 401;
|
|
15089
15487
|
data: unknown;
|
|
@@ -15140,7 +15538,7 @@ declare class TwitchApi {
|
|
|
15140
15538
|
*
|
|
15141
15539
|
* @see https://dev.twitch.tv/docs/api/reference#update-extension-bits-product
|
|
15142
15540
|
*/
|
|
15143
|
-
updateExtensionBitsProduct: (body: UpdateExtensionBitsProductBody, options
|
|
15541
|
+
updateExtensionBitsProduct: (body: UpdateExtensionBitsProductBody, options?: CallApiOptions['options']) => Promise<{
|
|
15144
15542
|
ok: false;
|
|
15145
15543
|
status: 400 | 401;
|
|
15146
15544
|
data: unknown;
|
|
@@ -15219,14 +15617,14 @@ declare class TwitchApi {
|
|
|
15219
15617
|
*
|
|
15220
15618
|
* @see https://dev.twitch.tv/docs/api/reference#create-eventsub-subscription
|
|
15221
15619
|
*/
|
|
15222
|
-
createEventSubSubscription: (body: CreateEventSubSubscriptionBody, options
|
|
15620
|
+
createEventSubSubscription: (body: CreateEventSubSubscriptionBody, options?: CallApiOptions['options']) => Promise<{
|
|
15223
15621
|
ok: true;
|
|
15224
15622
|
status: 202;
|
|
15225
15623
|
data: {
|
|
15226
15624
|
data: {
|
|
15227
15625
|
id: string;
|
|
15228
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";
|
|
15229
|
-
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";
|
|
15230
15628
|
version: string;
|
|
15231
15629
|
condition: Record<string, never>;
|
|
15232
15630
|
created_at: string;
|
|
@@ -15283,7 +15681,7 @@ declare class TwitchApi {
|
|
|
15283
15681
|
*
|
|
15284
15682
|
* @see https://dev.twitch.tv/docs/api/reference#delete-eventsub-subscription
|
|
15285
15683
|
*/
|
|
15286
|
-
deleteEventSubSubscription: (params: DeleteEventSubSubscriptionParams, options
|
|
15684
|
+
deleteEventSubSubscription: (params: DeleteEventSubSubscriptionParams, options?: CallApiOptions['options']) => Promise<{
|
|
15287
15685
|
ok: false;
|
|
15288
15686
|
status: 400 | 401 | 404;
|
|
15289
15687
|
data: unknown;
|
|
@@ -15297,7 +15695,7 @@ declare class TwitchApi {
|
|
|
15297
15695
|
*
|
|
15298
15696
|
* __Authorization:__
|
|
15299
15697
|
*
|
|
15300
|
-
* 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.
|
|
15301
15699
|
*
|
|
15302
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.
|
|
15303
15701
|
*
|
|
@@ -15330,7 +15728,7 @@ declare class TwitchApi {
|
|
|
15330
15728
|
*
|
|
15331
15729
|
* @see https://dev.twitch.tv/docs/api/reference#get-eventsub-subscriptions
|
|
15332
15730
|
*/
|
|
15333
|
-
getEventSubSubscriptions: (params
|
|
15731
|
+
getEventSubSubscriptions: (params?: GetEventSubSubscriptionsParams | null | undefined, options?: CallApiOptions['options']) => Promise<{
|
|
15334
15732
|
ok: false;
|
|
15335
15733
|
status: 400 | 401;
|
|
15336
15734
|
data: unknown;
|
|
@@ -15341,7 +15739,7 @@ declare class TwitchApi {
|
|
|
15341
15739
|
data: {
|
|
15342
15740
|
id: string;
|
|
15343
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";
|
|
15344
|
-
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";
|
|
15345
15743
|
version: string;
|
|
15346
15744
|
condition: Record<string, never>;
|
|
15347
15745
|
created_at: string;
|
|
@@ -15394,7 +15792,7 @@ declare class TwitchApi {
|
|
|
15394
15792
|
*
|
|
15395
15793
|
* @see https://dev.twitch.tv/docs/api/reference#get-top-games
|
|
15396
15794
|
*/
|
|
15397
|
-
getTopGames: (params
|
|
15795
|
+
getTopGames: (params?: GetTopGamesParams | null | undefined, options?: CallApiOptions['options']) => Promise<{
|
|
15398
15796
|
ok: false;
|
|
15399
15797
|
status: 400 | 401;
|
|
15400
15798
|
data: unknown;
|
|
@@ -15445,7 +15843,7 @@ declare class TwitchApi {
|
|
|
15445
15843
|
*
|
|
15446
15844
|
* @see https://dev.twitch.tv/docs/api/reference#get-games
|
|
15447
15845
|
*/
|
|
15448
|
-
getGames: (params
|
|
15846
|
+
getGames: (params?: GetGamesParams | null | undefined, options?: CallApiOptions['options']) => Promise<{
|
|
15449
15847
|
ok: false;
|
|
15450
15848
|
status: 400 | 401;
|
|
15451
15849
|
data: unknown;
|
|
@@ -15496,7 +15894,7 @@ declare class TwitchApi {
|
|
|
15496
15894
|
*
|
|
15497
15895
|
* @see https://dev.twitch.tv/docs/api/reference#get-creator-goals
|
|
15498
15896
|
*/
|
|
15499
|
-
getCreatorGoals: (params: GetCreatorGoalsParams, options
|
|
15897
|
+
getCreatorGoals: (params: GetCreatorGoalsParams, options?: CallApiOptions['options']) => Promise<{
|
|
15500
15898
|
ok: false;
|
|
15501
15899
|
status: 400 | 401;
|
|
15502
15900
|
data: unknown;
|
|
@@ -15546,7 +15944,7 @@ declare class TwitchApi {
|
|
|
15546
15944
|
*
|
|
15547
15945
|
* @see https://dev.twitch.tv/docs/api/reference#get-channel-guest-star-settings
|
|
15548
15946
|
*/
|
|
15549
|
-
getChannelGuestStarSettings: (params: GetChannelGuestStarSettingsParams, options
|
|
15947
|
+
getChannelGuestStarSettings: (params: GetChannelGuestStarSettingsParams, options?: CallApiOptions['options']) => Promise<{
|
|
15550
15948
|
ok: true;
|
|
15551
15949
|
status: 200;
|
|
15552
15950
|
data: {
|
|
@@ -15587,7 +15985,7 @@ declare class TwitchApi {
|
|
|
15587
15985
|
*
|
|
15588
15986
|
* @see https://dev.twitch.tv/docs/api/reference#update-channel-guest-star-settings
|
|
15589
15987
|
*/
|
|
15590
|
-
updateChannelGuestStarSettings: (params: UpdateChannelGuestStarSettingsParams, body
|
|
15988
|
+
updateChannelGuestStarSettings: (params: UpdateChannelGuestStarSettingsParams, body?: UpdateChannelGuestStarSettingsBody | null | undefined, options?: CallApiOptions['options']) => Promise<{
|
|
15591
15989
|
ok: true;
|
|
15592
15990
|
status: 204;
|
|
15593
15991
|
data: void;
|
|
@@ -15623,7 +16021,7 @@ declare class TwitchApi {
|
|
|
15623
16021
|
*
|
|
15624
16022
|
* @see https://dev.twitch.tv/docs/api/reference#get-guest-star-session
|
|
15625
16023
|
*/
|
|
15626
|
-
getGuestStarSession: (params: GetGuestStarSessionParams, options
|
|
16024
|
+
getGuestStarSession: (params: GetGuestStarSessionParams, options?: CallApiOptions['options']) => Promise<{
|
|
15627
16025
|
ok: false;
|
|
15628
16026
|
status: 400 | 401;
|
|
15629
16027
|
data: unknown;
|
|
@@ -15633,59 +16031,25 @@ declare class TwitchApi {
|
|
|
15633
16031
|
data: {
|
|
15634
16032
|
data: {
|
|
15635
16033
|
id: string;
|
|
15636
|
-
guests:
|
|
15637
|
-
|
|
15638
|
-
|
|
15639
|
-
|
|
15640
|
-
|
|
15641
|
-
|
|
15642
|
-
|
|
15643
|
-
|
|
15644
|
-
|
|
15645
|
-
|
|
15646
|
-
|
|
15647
|
-
|
|
15648
|
-
|
|
15649
|
-
|
|
15650
|
-
|
|
15651
|
-
|
|
15652
|
-
|
|
15653
|
-
|
|
15654
|
-
|
|
15655
|
-
* **NOTE**: For recurring segments, removing a segment removes all segments in the recurring schedule.
|
|
15656
|
-
*
|
|
15657
|
-
* __Authorization:__
|
|
15658
|
-
*
|
|
15659
|
-
* Requires a [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens) that includes the **channel:manage:schedule** scope.
|
|
15660
|
-
*
|
|
15661
|
-
* __URL:__
|
|
15662
|
-
*
|
|
15663
|
-
* `DELETE https://api.twitch.tv/helix/schedule/segment`
|
|
15664
|
-
*
|
|
15665
|
-
* __Response Codes:__
|
|
15666
|
-
*
|
|
15667
|
-
* _204 No Content_
|
|
15668
|
-
*
|
|
15669
|
-
* Successfully removed the broadcast segment.
|
|
15670
|
-
*
|
|
15671
|
-
* _400 Bad Request_
|
|
15672
|
-
*
|
|
15673
|
-
* * The _broadcaster\_id_ query parameter is required.
|
|
15674
|
-
* * The ID in the _broadcaster\_id_ query parameter is not valid.
|
|
15675
|
-
* * The _id_ query parameter is required.
|
|
15676
|
-
* * The ID in the _id_ query parameter is not valid.
|
|
15677
|
-
*
|
|
15678
|
-
* _401 Unauthorized_
|
|
15679
|
-
*
|
|
15680
|
-
* * The ID in the _broadcaster\_id_ query parameter must match the user ID in the user access token.
|
|
15681
|
-
* * The Authorization header is required and must contain a user access token.
|
|
15682
|
-
* * The user access token must include the **channel:manage:schedule** scope.
|
|
15683
|
-
* * The access token is not valid.
|
|
15684
|
-
* * The ID in the Client-Id header must match the client ID in the OAuth token.
|
|
15685
|
-
*
|
|
15686
|
-
* @see https://dev.twitch.tv/docs/api/reference#delete-channel-stream-schedule-segment
|
|
15687
|
-
*/
|
|
15688
|
-
};
|
|
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
|
+
}[];
|
|
15689
16053
|
}[];
|
|
15690
16054
|
};
|
|
15691
16055
|
}>;
|
|
@@ -15720,7 +16084,7 @@ declare class TwitchApi {
|
|
|
15720
16084
|
*
|
|
15721
16085
|
* @see https://dev.twitch.tv/docs/api/reference#create-guest-star-session
|
|
15722
16086
|
*/
|
|
15723
|
-
createGuestStarSession: (params: CreateGuestStarSessionParams, options
|
|
16087
|
+
createGuestStarSession: (params: CreateGuestStarSessionParams, options?: CallApiOptions['options']) => Promise<{
|
|
15724
16088
|
ok: false;
|
|
15725
16089
|
status: 400 | 401 | 403;
|
|
15726
16090
|
data: unknown;
|
|
@@ -15730,59 +16094,25 @@ declare class TwitchApi {
|
|
|
15730
16094
|
data: {
|
|
15731
16095
|
data: {
|
|
15732
16096
|
id: string;
|
|
15733
|
-
guests:
|
|
15734
|
-
|
|
15735
|
-
|
|
15736
|
-
|
|
15737
|
-
|
|
15738
|
-
|
|
15739
|
-
|
|
15740
|
-
|
|
15741
|
-
|
|
15742
|
-
|
|
15743
|
-
|
|
15744
|
-
|
|
15745
|
-
|
|
15746
|
-
|
|
15747
|
-
|
|
15748
|
-
|
|
15749
|
-
|
|
15750
|
-
|
|
15751
|
-
|
|
15752
|
-
* **NOTE**: For recurring segments, removing a segment removes all segments in the recurring schedule.
|
|
15753
|
-
*
|
|
15754
|
-
* __Authorization:__
|
|
15755
|
-
*
|
|
15756
|
-
* Requires a [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens) that includes the **channel:manage:schedule** scope.
|
|
15757
|
-
*
|
|
15758
|
-
* __URL:__
|
|
15759
|
-
*
|
|
15760
|
-
* `DELETE https://api.twitch.tv/helix/schedule/segment`
|
|
15761
|
-
*
|
|
15762
|
-
* __Response Codes:__
|
|
15763
|
-
*
|
|
15764
|
-
* _204 No Content_
|
|
15765
|
-
*
|
|
15766
|
-
* Successfully removed the broadcast segment.
|
|
15767
|
-
*
|
|
15768
|
-
* _400 Bad Request_
|
|
15769
|
-
*
|
|
15770
|
-
* * The _broadcaster\_id_ query parameter is required.
|
|
15771
|
-
* * The ID in the _broadcaster\_id_ query parameter is not valid.
|
|
15772
|
-
* * The _id_ query parameter is required.
|
|
15773
|
-
* * The ID in the _id_ query parameter is not valid.
|
|
15774
|
-
*
|
|
15775
|
-
* _401 Unauthorized_
|
|
15776
|
-
*
|
|
15777
|
-
* * The ID in the _broadcaster\_id_ query parameter must match the user ID in the user access token.
|
|
15778
|
-
* * The Authorization header is required and must contain a user access token.
|
|
15779
|
-
* * The user access token must include the **channel:manage:schedule** scope.
|
|
15780
|
-
* * The access token is not valid.
|
|
15781
|
-
* * The ID in the Client-Id header must match the client ID in the OAuth token.
|
|
15782
|
-
*
|
|
15783
|
-
* @see https://dev.twitch.tv/docs/api/reference#delete-channel-stream-schedule-segment
|
|
15784
|
-
*/
|
|
15785
|
-
};
|
|
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
|
+
}[];
|
|
15786
16116
|
}[];
|
|
15787
16117
|
};
|
|
15788
16118
|
}>;
|
|
@@ -15814,7 +16144,7 @@ declare class TwitchApi {
|
|
|
15814
16144
|
*
|
|
15815
16145
|
* @see https://dev.twitch.tv/docs/api/reference#end-guest-star-session
|
|
15816
16146
|
*/
|
|
15817
|
-
endGuestStarSession: (params: EndGuestStarSessionParams, options
|
|
16147
|
+
endGuestStarSession: (params: EndGuestStarSessionParams, options?: CallApiOptions['options']) => Promise<{
|
|
15818
16148
|
ok: true;
|
|
15819
16149
|
status: 204;
|
|
15820
16150
|
data: void;
|
|
@@ -15846,7 +16176,7 @@ declare class TwitchApi {
|
|
|
15846
16176
|
*
|
|
15847
16177
|
* @see https://dev.twitch.tv/docs/api/reference#get-guest-star-invites
|
|
15848
16178
|
*/
|
|
15849
|
-
getGuestStarInvites: (params: GetGuestStarInvitesParams, options
|
|
16179
|
+
getGuestStarInvites: (params: GetGuestStarInvitesParams, options?: CallApiOptions['options']) => Promise<{
|
|
15850
16180
|
ok: false;
|
|
15851
16181
|
status: 400;
|
|
15852
16182
|
data: unknown;
|
|
@@ -15896,7 +16226,7 @@ declare class TwitchApi {
|
|
|
15896
16226
|
*
|
|
15897
16227
|
* @see https://dev.twitch.tv/docs/api/reference#send-guest-star-invite
|
|
15898
16228
|
*/
|
|
15899
|
-
sendGuestStarInvite: (params: SendGuestStarInviteParams, options
|
|
16229
|
+
sendGuestStarInvite: (params: SendGuestStarInviteParams, options?: CallApiOptions['options']) => Promise<{
|
|
15900
16230
|
ok: true;
|
|
15901
16231
|
status: 204;
|
|
15902
16232
|
data: void;
|
|
@@ -15934,7 +16264,7 @@ declare class TwitchApi {
|
|
|
15934
16264
|
*
|
|
15935
16265
|
* @see https://dev.twitch.tv/docs/api/reference#delete-guest-star-invite
|
|
15936
16266
|
*/
|
|
15937
|
-
deleteGuestStarInvite: (params: DeleteGuestStarInviteParams, options
|
|
16267
|
+
deleteGuestStarInvite: (params: DeleteGuestStarInviteParams, options?: CallApiOptions['options']) => Promise<{
|
|
15938
16268
|
ok: true;
|
|
15939
16269
|
status: 204;
|
|
15940
16270
|
data: void;
|
|
@@ -15982,7 +16312,7 @@ declare class TwitchApi {
|
|
|
15982
16312
|
*
|
|
15983
16313
|
* @see https://dev.twitch.tv/docs/api/reference#assign-guest-star-slot
|
|
15984
16314
|
*/
|
|
15985
|
-
assignGuestStarSlot: (params: AssignGuestStarSlotParams, options
|
|
16315
|
+
assignGuestStarSlot: (params: AssignGuestStarSlotParams, options?: CallApiOptions['options']) => Promise<{
|
|
15986
16316
|
ok: false;
|
|
15987
16317
|
status: 400 | 401 | 403;
|
|
15988
16318
|
data: unknown;
|
|
@@ -16017,7 +16347,7 @@ declare class TwitchApi {
|
|
|
16017
16347
|
*
|
|
16018
16348
|
* @see https://dev.twitch.tv/docs/api/reference#update-guest-star-slot
|
|
16019
16349
|
*/
|
|
16020
|
-
updateGuestStarSlot: (params: UpdateGuestStarSlotParams, options
|
|
16350
|
+
updateGuestStarSlot: (params: UpdateGuestStarSlotParams, options?: CallApiOptions['options']) => Promise<{
|
|
16021
16351
|
ok: true;
|
|
16022
16352
|
status: 204;
|
|
16023
16353
|
data: void;
|
|
@@ -16062,7 +16392,7 @@ declare class TwitchApi {
|
|
|
16062
16392
|
*
|
|
16063
16393
|
* @see https://dev.twitch.tv/docs/api/reference#delete-guest-star-slot
|
|
16064
16394
|
*/
|
|
16065
|
-
deleteGuestStarSlot: (params: DeleteGuestStarSlotParams, options
|
|
16395
|
+
deleteGuestStarSlot: (params: DeleteGuestStarSlotParams, options?: CallApiOptions['options']) => Promise<{
|
|
16066
16396
|
ok: true;
|
|
16067
16397
|
status: 204;
|
|
16068
16398
|
data: void;
|
|
@@ -16103,7 +16433,7 @@ declare class TwitchApi {
|
|
|
16103
16433
|
*
|
|
16104
16434
|
* @see https://dev.twitch.tv/docs/api/reference#update-guest-star-slot-settings
|
|
16105
16435
|
*/
|
|
16106
|
-
updateGuestStarSlotSettings: (params: UpdateGuestStarSlotSettingsParams, options
|
|
16436
|
+
updateGuestStarSlotSettings: (params: UpdateGuestStarSlotSettingsParams, options?: CallApiOptions['options']) => Promise<{
|
|
16107
16437
|
ok: true;
|
|
16108
16438
|
status: 204;
|
|
16109
16439
|
data: void;
|
|
@@ -16143,7 +16473,7 @@ declare class TwitchApi {
|
|
|
16143
16473
|
*
|
|
16144
16474
|
* @see https://dev.twitch.tv/docs/api/reference#get-hype-train-events
|
|
16145
16475
|
*/
|
|
16146
|
-
getHypeTrainEvents: (params: GetHypeTrainEventsParams, options
|
|
16476
|
+
getHypeTrainEvents: (params: GetHypeTrainEventsParams, options?: CallApiOptions['options']) => Promise<{
|
|
16147
16477
|
ok: false;
|
|
16148
16478
|
status: 401;
|
|
16149
16479
|
data: unknown;
|
|
@@ -16164,7 +16494,41 @@ declare class TwitchApi {
|
|
|
16164
16494
|
id: string;
|
|
16165
16495
|
last_contribution: {
|
|
16166
16496
|
total: number;
|
|
16167
|
-
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
|
+
*/
|
|
16168
16532
|
user: string;
|
|
16169
16533
|
};
|
|
16170
16534
|
level: number;
|
|
@@ -16238,7 +16602,7 @@ declare class TwitchApi {
|
|
|
16238
16602
|
*
|
|
16239
16603
|
* @see https://dev.twitch.tv/docs/api/reference#check-automod-status
|
|
16240
16604
|
*/
|
|
16241
|
-
checkAutoModStatus: (params: CheckAutoModStatusParams, body: CheckAutoModStatusBody, options
|
|
16605
|
+
checkAutoModStatus: (params: CheckAutoModStatusParams, body: CheckAutoModStatusBody, options?: CallApiOptions['options']) => Promise<{
|
|
16242
16606
|
ok: false;
|
|
16243
16607
|
status: 400 | 401 | 403 | 429;
|
|
16244
16608
|
data: unknown;
|
|
@@ -16296,7 +16660,7 @@ declare class TwitchApi {
|
|
|
16296
16660
|
*
|
|
16297
16661
|
* @see https://dev.twitch.tv/docs/api/reference#manage-held-automod-messages
|
|
16298
16662
|
*/
|
|
16299
|
-
manageHeldAutoModMessages: (body: ManageHeldAutoModMessagesBody, options
|
|
16663
|
+
manageHeldAutoModMessages: (body: ManageHeldAutoModMessagesBody, options?: CallApiOptions['options']) => Promise<{
|
|
16300
16664
|
ok: true;
|
|
16301
16665
|
status: 204;
|
|
16302
16666
|
data: void;
|
|
@@ -16341,7 +16705,7 @@ declare class TwitchApi {
|
|
|
16341
16705
|
*
|
|
16342
16706
|
* @see https://dev.twitch.tv/docs/api/reference#get-automod-settings
|
|
16343
16707
|
*/
|
|
16344
|
-
getAutoModSettings: (params: GetAutoModSettingsParams, options
|
|
16708
|
+
getAutoModSettings: (params: GetAutoModSettingsParams, options?: CallApiOptions['options']) => Promise<{
|
|
16345
16709
|
ok: false;
|
|
16346
16710
|
status: 400 | 401 | 403;
|
|
16347
16711
|
data: unknown;
|
|
@@ -16416,7 +16780,7 @@ declare class TwitchApi {
|
|
|
16416
16780
|
*
|
|
16417
16781
|
* @see https://dev.twitch.tv/docs/api/reference#update-automod-settings
|
|
16418
16782
|
*/
|
|
16419
|
-
updateAutoModSettings: (params: UpdateAutoModSettingsParams, body
|
|
16783
|
+
updateAutoModSettings: (params: UpdateAutoModSettingsParams, body?: UpdateAutoModSettingsBody | null | undefined, options?: CallApiOptions['options']) => Promise<{
|
|
16420
16784
|
ok: false;
|
|
16421
16785
|
status: 400 | 401 | 403;
|
|
16422
16786
|
data: unknown;
|
|
@@ -16470,7 +16834,7 @@ declare class TwitchApi {
|
|
|
16470
16834
|
*
|
|
16471
16835
|
* @see https://dev.twitch.tv/docs/api/reference#get-banned-users
|
|
16472
16836
|
*/
|
|
16473
|
-
getBannedUsers: (params: GetBannedUsersParams, options
|
|
16837
|
+
getBannedUsers: (params: GetBannedUsersParams, options?: CallApiOptions['options']) => Promise<{
|
|
16474
16838
|
ok: false;
|
|
16475
16839
|
status: 400 | 401;
|
|
16476
16840
|
data: unknown;
|
|
@@ -16550,7 +16914,7 @@ declare class TwitchApi {
|
|
|
16550
16914
|
*
|
|
16551
16915
|
* @see https://dev.twitch.tv/docs/api/reference#ban-user
|
|
16552
16916
|
*/
|
|
16553
|
-
banUser: (params: BanUserParams, body: BanUserBody, options
|
|
16917
|
+
banUser: (params: BanUserParams, body: BanUserBody, options?: CallApiOptions['options']) => Promise<{
|
|
16554
16918
|
ok: false;
|
|
16555
16919
|
status: 400 | 401 | 403 | 409 | 429;
|
|
16556
16920
|
data: unknown;
|
|
@@ -16615,7 +16979,7 @@ declare class TwitchApi {
|
|
|
16615
16979
|
*
|
|
16616
16980
|
* @see https://dev.twitch.tv/docs/api/reference#unban-user
|
|
16617
16981
|
*/
|
|
16618
|
-
unbanUser: (params: UnbanUserParams, options
|
|
16982
|
+
unbanUser: (params: UnbanUserParams, options?: CallApiOptions['options']) => Promise<{
|
|
16619
16983
|
ok: true;
|
|
16620
16984
|
status: 204;
|
|
16621
16985
|
data: void;
|
|
@@ -16624,6 +16988,141 @@ declare class TwitchApi {
|
|
|
16624
16988
|
status: 400 | 401 | 403 | 409 | 429;
|
|
16625
16989
|
data: unknown;
|
|
16626
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
|
+
}>;
|
|
16627
17126
|
/**
|
|
16628
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.
|
|
16629
17128
|
*
|
|
@@ -16660,7 +17159,7 @@ declare class TwitchApi {
|
|
|
16660
17159
|
*
|
|
16661
17160
|
* @see https://dev.twitch.tv/docs/api/reference#get-blocked-terms
|
|
16662
17161
|
*/
|
|
16663
|
-
getBlockedTerms: (params: GetBlockedTermsParams, options
|
|
17162
|
+
getBlockedTerms: (params: GetBlockedTermsParams, options?: CallApiOptions['options']) => Promise<{
|
|
16664
17163
|
ok: false;
|
|
16665
17164
|
status: 400 | 401 | 403;
|
|
16666
17165
|
data: unknown;
|
|
@@ -16720,7 +17219,7 @@ declare class TwitchApi {
|
|
|
16720
17219
|
*
|
|
16721
17220
|
* @see https://dev.twitch.tv/docs/api/reference#add-blocked-term
|
|
16722
17221
|
*/
|
|
16723
|
-
addBlockedTerm: (params: AddBlockedTermParams, body: AddBlockedTermBody, options
|
|
17222
|
+
addBlockedTerm: (params: AddBlockedTermParams, body: AddBlockedTermBody, options?: CallApiOptions['options']) => Promise<{
|
|
16724
17223
|
ok: false;
|
|
16725
17224
|
status: 400 | 401 | 403;
|
|
16726
17225
|
data: unknown;
|
|
@@ -16776,7 +17275,7 @@ declare class TwitchApi {
|
|
|
16776
17275
|
*
|
|
16777
17276
|
* @see https://dev.twitch.tv/docs/api/reference#remove-blocked-term
|
|
16778
17277
|
*/
|
|
16779
|
-
removeBlockedTerm: (params: RemoveBlockedTermParams, options
|
|
17278
|
+
removeBlockedTerm: (params: RemoveBlockedTermParams, options?: CallApiOptions['options']) => Promise<{
|
|
16780
17279
|
ok: false;
|
|
16781
17280
|
status: 400 | 401 | 403;
|
|
16782
17281
|
data: unknown;
|
|
@@ -16825,7 +17324,7 @@ declare class TwitchApi {
|
|
|
16825
17324
|
*
|
|
16826
17325
|
* @see https://dev.twitch.tv/docs/api/reference#delete-chat-messages
|
|
16827
17326
|
*/
|
|
16828
|
-
deleteChatMessages: (params: DeleteChatMessagesParams, options
|
|
17327
|
+
deleteChatMessages: (params: DeleteChatMessagesParams, options?: CallApiOptions['options']) => Promise<{
|
|
16829
17328
|
ok: true;
|
|
16830
17329
|
status: 204;
|
|
16831
17330
|
data: void;
|
|
@@ -16835,7 +17334,7 @@ declare class TwitchApi {
|
|
|
16835
17334
|
data: unknown;
|
|
16836
17335
|
}>;
|
|
16837
17336
|
/**
|
|
16838
|
-
*
|
|
17337
|
+
* Gets a list of channels that the specified user has moderator privileges in.
|
|
16839
17338
|
*
|
|
16840
17339
|
* __Authorization:__
|
|
16841
17340
|
*
|
|
@@ -16860,7 +17359,7 @@ declare class TwitchApi {
|
|
|
16860
17359
|
*
|
|
16861
17360
|
* @see https://dev.twitch.tv/docs/api/reference#get-moderated-channels
|
|
16862
17361
|
*/
|
|
16863
|
-
getModeratedChannels: (params: GetModeratedChannelsParams, options
|
|
17362
|
+
getModeratedChannels: (params: GetModeratedChannelsParams, options?: CallApiOptions['options']) => Promise<{
|
|
16864
17363
|
ok: false;
|
|
16865
17364
|
status: 400 | 401 | 500;
|
|
16866
17365
|
data: unknown;
|
|
@@ -16909,7 +17408,7 @@ declare class TwitchApi {
|
|
|
16909
17408
|
*
|
|
16910
17409
|
* @see https://dev.twitch.tv/docs/api/reference#get-moderators
|
|
16911
17410
|
*/
|
|
16912
|
-
getModerators: (params: GetModeratorsParams, options
|
|
17411
|
+
getModerators: (params: GetModeratorsParams, options?: CallApiOptions['options']) => Promise<{
|
|
16913
17412
|
ok: false;
|
|
16914
17413
|
status: 400 | 401;
|
|
16915
17414
|
data: unknown;
|
|
@@ -16971,7 +17470,7 @@ declare class TwitchApi {
|
|
|
16971
17470
|
*
|
|
16972
17471
|
* @see https://dev.twitch.tv/docs/api/reference#add-channel-moderator
|
|
16973
17472
|
*/
|
|
16974
|
-
addChannelModerator: (params: AddChannelModeratorParams, options
|
|
17473
|
+
addChannelModerator: (params: AddChannelModeratorParams, options?: CallApiOptions['options']) => Promise<{
|
|
16975
17474
|
ok: true;
|
|
16976
17475
|
status: 204;
|
|
16977
17476
|
data: void;
|
|
@@ -17019,7 +17518,7 @@ declare class TwitchApi {
|
|
|
17019
17518
|
*
|
|
17020
17519
|
* @see https://dev.twitch.tv/docs/api/reference#remove-channel-moderator
|
|
17021
17520
|
*/
|
|
17022
|
-
removeChannelModerator: (params: RemoveChannelModeratorParams, options
|
|
17521
|
+
removeChannelModerator: (params: RemoveChannelModeratorParams, options?: CallApiOptions['options']) => Promise<{
|
|
17023
17522
|
ok: true;
|
|
17024
17523
|
status: 204;
|
|
17025
17524
|
data: void;
|
|
@@ -17061,7 +17560,7 @@ declare class TwitchApi {
|
|
|
17061
17560
|
*
|
|
17062
17561
|
* @see https://dev.twitch.tv/docs/api/reference#get-vips
|
|
17063
17562
|
*/
|
|
17064
|
-
getVIPs: (params: GetVIPsParams, options
|
|
17563
|
+
getVIPs: (params: GetVIPsParams, options?: CallApiOptions['options']) => Promise<{
|
|
17065
17564
|
ok: false;
|
|
17066
17565
|
status: 400 | 401;
|
|
17067
17566
|
data: unknown;
|
|
@@ -17140,7 +17639,7 @@ declare class TwitchApi {
|
|
|
17140
17639
|
*
|
|
17141
17640
|
* @see https://dev.twitch.tv/docs/api/reference#add-channel-vip
|
|
17142
17641
|
*/
|
|
17143
|
-
addChannelVIP: (params: AddChannelVIPParams, options
|
|
17642
|
+
addChannelVIP: (params: AddChannelVIPParams, options?: CallApiOptions['options']) => Promise<{
|
|
17144
17643
|
ok: true;
|
|
17145
17644
|
status: 204;
|
|
17146
17645
|
data: void;
|
|
@@ -17202,7 +17701,7 @@ declare class TwitchApi {
|
|
|
17202
17701
|
*
|
|
17203
17702
|
* @see https://dev.twitch.tv/docs/api/reference#remove-channel-vip
|
|
17204
17703
|
*/
|
|
17205
|
-
removeChannelVIP: (params: RemoveChannelVIPParams, options
|
|
17704
|
+
removeChannelVIP: (params: RemoveChannelVIPParams, options?: CallApiOptions['options']) => Promise<{
|
|
17206
17705
|
ok: true;
|
|
17207
17706
|
status: 204;
|
|
17208
17707
|
data: void;
|
|
@@ -17251,7 +17750,7 @@ declare class TwitchApi {
|
|
|
17251
17750
|
*
|
|
17252
17751
|
* @see https://dev.twitch.tv/docs/api/reference#update-shield-mode-status
|
|
17253
17752
|
*/
|
|
17254
|
-
updateShieldModeStatus: (params: UpdateShieldModeStatusParams, body: UpdateShieldModeStatusBody, options
|
|
17753
|
+
updateShieldModeStatus: (params: UpdateShieldModeStatusParams, body: UpdateShieldModeStatusBody, options?: CallApiOptions['options']) => Promise<{
|
|
17255
17754
|
ok: false;
|
|
17256
17755
|
status: 400 | 401 | 403;
|
|
17257
17756
|
data: unknown;
|
|
@@ -17306,7 +17805,7 @@ declare class TwitchApi {
|
|
|
17306
17805
|
*
|
|
17307
17806
|
* @see https://dev.twitch.tv/docs/api/reference#get-shield-mode-status
|
|
17308
17807
|
*/
|
|
17309
|
-
getShieldModeStatus: (params: GetShieldModeStatusParams, options
|
|
17808
|
+
getShieldModeStatus: (params: GetShieldModeStatusParams, options?: CallApiOptions['options']) => Promise<{
|
|
17310
17809
|
ok: false;
|
|
17311
17810
|
status: 400 | 401 | 403;
|
|
17312
17811
|
data: unknown;
|
|
@@ -17318,7 +17817,38 @@ declare class TwitchApi {
|
|
|
17318
17817
|
is_active: boolean;
|
|
17319
17818
|
moderator_id: string;
|
|
17320
17819
|
moderator_login: string;
|
|
17321
|
-
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
|
+
*/
|
|
17322
17852
|
last_activated_at: string;
|
|
17323
17853
|
}[];
|
|
17324
17854
|
};
|
|
@@ -17342,7 +17872,7 @@ declare class TwitchApi {
|
|
|
17342
17872
|
*
|
|
17343
17873
|
* _200 OK_
|
|
17344
17874
|
*
|
|
17345
|
-
* Successfully retrieved the broadcaster
|
|
17875
|
+
* Successfully retrieved the broadcaster's polls.
|
|
17346
17876
|
*
|
|
17347
17877
|
* _400 Bad Request_
|
|
17348
17878
|
*
|
|
@@ -17362,7 +17892,7 @@ declare class TwitchApi {
|
|
|
17362
17892
|
*
|
|
17363
17893
|
* @see https://dev.twitch.tv/docs/api/reference#get-polls
|
|
17364
17894
|
*/
|
|
17365
|
-
getPolls: (params: GetPollsParams, options
|
|
17895
|
+
getPolls: (params: GetPollsParams, options?: CallApiOptions['options']) => Promise<{
|
|
17366
17896
|
ok: false;
|
|
17367
17897
|
status: 400 | 401 | 404;
|
|
17368
17898
|
data: unknown;
|
|
@@ -17441,7 +17971,7 @@ declare class TwitchApi {
|
|
|
17441
17971
|
*
|
|
17442
17972
|
* @see https://dev.twitch.tv/docs/api/reference#create-poll
|
|
17443
17973
|
*/
|
|
17444
|
-
createPoll: (body: CreatePollBody, options
|
|
17974
|
+
createPoll: (body: CreatePollBody, options?: CallApiOptions['options']) => Promise<{
|
|
17445
17975
|
ok: false;
|
|
17446
17976
|
status: 400 | 401;
|
|
17447
17977
|
data: unknown;
|
|
@@ -17508,7 +18038,7 @@ declare class TwitchApi {
|
|
|
17508
18038
|
*
|
|
17509
18039
|
* @see https://dev.twitch.tv/docs/api/reference#end-poll
|
|
17510
18040
|
*/
|
|
17511
|
-
endPoll: (body: EndPollBody, options
|
|
18041
|
+
endPoll: (body: EndPollBody, options?: CallApiOptions['options']) => Promise<{
|
|
17512
18042
|
ok: false;
|
|
17513
18043
|
status: 400 | 401;
|
|
17514
18044
|
data: unknown;
|
|
@@ -17573,7 +18103,7 @@ declare class TwitchApi {
|
|
|
17573
18103
|
*
|
|
17574
18104
|
* @see https://dev.twitch.tv/docs/api/reference#get-predictions
|
|
17575
18105
|
*/
|
|
17576
|
-
getPredictions: (params: GetPredictionsParams, options
|
|
18106
|
+
getPredictions: (params: GetPredictionsParams, options?: CallApiOptions['options']) => Promise<{
|
|
17577
18107
|
ok: false;
|
|
17578
18108
|
status: 400 | 401;
|
|
17579
18109
|
data: unknown;
|
|
@@ -17657,7 +18187,7 @@ declare class TwitchApi {
|
|
|
17657
18187
|
*
|
|
17658
18188
|
* @see https://dev.twitch.tv/docs/api/reference#create-prediction
|
|
17659
18189
|
*/
|
|
17660
|
-
createPrediction: (body: CreatePredictionBody, options
|
|
18190
|
+
createPrediction: (body: CreatePredictionBody, options?: CallApiOptions['options']) => Promise<{
|
|
17661
18191
|
ok: false;
|
|
17662
18192
|
status: 400 | 401 | 429;
|
|
17663
18193
|
data: unknown;
|
|
@@ -17736,7 +18266,7 @@ declare class TwitchApi {
|
|
|
17736
18266
|
*
|
|
17737
18267
|
* @see https://dev.twitch.tv/docs/api/reference#end-prediction
|
|
17738
18268
|
*/
|
|
17739
|
-
endPrediction: (body: EndPredictionBody, options
|
|
18269
|
+
endPrediction: (body: EndPredictionBody, options?: CallApiOptions['options']) => Promise<{
|
|
17740
18270
|
ok: false;
|
|
17741
18271
|
status: 400 | 401 | 404;
|
|
17742
18272
|
data: unknown;
|
|
@@ -17831,7 +18361,7 @@ declare class TwitchApi {
|
|
|
17831
18361
|
*
|
|
17832
18362
|
* @see https://dev.twitch.tv/docs/api/reference#start-a-raid
|
|
17833
18363
|
*/
|
|
17834
|
-
startRaid: (params
|
|
18364
|
+
startRaid: (params?: StartRaidParams | null | undefined, options?: CallApiOptions['options']) => Promise<{
|
|
17835
18365
|
ok: true;
|
|
17836
18366
|
status: 200;
|
|
17837
18367
|
data: {
|
|
@@ -17888,7 +18418,7 @@ declare class TwitchApi {
|
|
|
17888
18418
|
*
|
|
17889
18419
|
* @see https://dev.twitch.tv/docs/api/reference#cancel-a-raid
|
|
17890
18420
|
*/
|
|
17891
|
-
cancelRaid: (params: CancelRaidParams, options
|
|
18421
|
+
cancelRaid: (params: CancelRaidParams, options?: CallApiOptions['options']) => Promise<{
|
|
17892
18422
|
ok: false;
|
|
17893
18423
|
status: 400 | 401 | 404 | 429;
|
|
17894
18424
|
data: unknown;
|
|
@@ -17939,7 +18469,7 @@ declare class TwitchApi {
|
|
|
17939
18469
|
*
|
|
17940
18470
|
* @see https://dev.twitch.tv/docs/api/reference#get-channel-stream-schedule
|
|
17941
18471
|
*/
|
|
17942
|
-
getChannelStreamSchedule: (params: GetChannelStreamScheduleParams, options
|
|
18472
|
+
getChannelStreamSchedule: (params: GetChannelStreamScheduleParams, options?: CallApiOptions['options']) => Promise<{
|
|
17943
18473
|
ok: false;
|
|
17944
18474
|
status: 400 | 401 | 403 | 404;
|
|
17945
18475
|
data: unknown;
|
|
@@ -18003,7 +18533,7 @@ declare class TwitchApi {
|
|
|
18003
18533
|
*
|
|
18004
18534
|
* @see https://dev.twitch.tv/docs/api/reference#get-channel-icalendar
|
|
18005
18535
|
*/
|
|
18006
|
-
getChannelICalendar: (params: GetChannelICalendarParams, options
|
|
18536
|
+
getChannelICalendar: (params: GetChannelICalendarParams, options?: CallApiOptions['options']) => Promise<{
|
|
18007
18537
|
ok: false;
|
|
18008
18538
|
status: 400;
|
|
18009
18539
|
data: unknown;
|
|
@@ -18051,7 +18581,7 @@ declare class TwitchApi {
|
|
|
18051
18581
|
*
|
|
18052
18582
|
* @see https://dev.twitch.tv/docs/api/reference#update-channel-stream-schedule
|
|
18053
18583
|
*/
|
|
18054
|
-
updateChannelStreamSchedule: (params: UpdateChannelStreamScheduleParams, options
|
|
18584
|
+
updateChannelStreamSchedule: (params: UpdateChannelStreamScheduleParams, options?: CallApiOptions['options']) => Promise<{
|
|
18055
18585
|
ok: false;
|
|
18056
18586
|
status: 400 | 401 | 404;
|
|
18057
18587
|
data: unknown;
|
|
@@ -18101,7 +18631,7 @@ declare class TwitchApi {
|
|
|
18101
18631
|
*
|
|
18102
18632
|
* @see https://dev.twitch.tv/docs/api/reference#create-channel-stream-schedule-segment
|
|
18103
18633
|
*/
|
|
18104
|
-
createChannelStreamScheduleSegment: (params: CreateChannelStreamScheduleSegmentParams, body: CreateChannelStreamScheduleSegmentBody, options
|
|
18634
|
+
createChannelStreamScheduleSegment: (params: CreateChannelStreamScheduleSegmentParams, body: CreateChannelStreamScheduleSegmentBody, options?: CallApiOptions['options']) => Promise<{
|
|
18105
18635
|
ok: false;
|
|
18106
18636
|
status: 400 | 401 | 403;
|
|
18107
18637
|
data: unknown;
|
|
@@ -18177,7 +18707,7 @@ declare class TwitchApi {
|
|
|
18177
18707
|
*
|
|
18178
18708
|
* @see https://dev.twitch.tv/docs/api/reference#update-channel-stream-schedule-segment
|
|
18179
18709
|
*/
|
|
18180
|
-
updateChannelStreamScheduleSegment: (params: UpdateChannelStreamScheduleSegmentParams, body
|
|
18710
|
+
updateChannelStreamScheduleSegment: (params: UpdateChannelStreamScheduleSegmentParams, body?: UpdateChannelStreamScheduleSegmentBody | null | undefined, options?: CallApiOptions['options']) => Promise<{
|
|
18181
18711
|
ok: false;
|
|
18182
18712
|
status: 400 | 401 | 404;
|
|
18183
18713
|
data: unknown;
|
|
@@ -18244,7 +18774,7 @@ declare class TwitchApi {
|
|
|
18244
18774
|
*
|
|
18245
18775
|
* @see https://dev.twitch.tv/docs/api/reference#delete-channel-stream-schedule-segment
|
|
18246
18776
|
*/
|
|
18247
|
-
deleteChannelStreamScheduleSegment: (params: DeleteChannelStreamScheduleSegmentParams, options
|
|
18777
|
+
deleteChannelStreamScheduleSegment: (params: DeleteChannelStreamScheduleSegmentParams, options?: CallApiOptions['options']) => Promise<{
|
|
18248
18778
|
ok: true;
|
|
18249
18779
|
status: 204;
|
|
18250
18780
|
data: void;
|
|
@@ -18286,7 +18816,7 @@ declare class TwitchApi {
|
|
|
18286
18816
|
*
|
|
18287
18817
|
* @see https://dev.twitch.tv/docs/api/reference#search-categories
|
|
18288
18818
|
*/
|
|
18289
|
-
searchCategories: (params: SearchCategoriesParams, options
|
|
18819
|
+
searchCategories: (params: SearchCategoriesParams, options?: CallApiOptions['options']) => Promise<{
|
|
18290
18820
|
ok: false;
|
|
18291
18821
|
status: 400 | 401;
|
|
18292
18822
|
data: unknown;
|
|
@@ -18336,7 +18866,7 @@ declare class TwitchApi {
|
|
|
18336
18866
|
*
|
|
18337
18867
|
* @see https://dev.twitch.tv/docs/api/reference#search-channels
|
|
18338
18868
|
*/
|
|
18339
|
-
searchChannels: (params: SearchChannelsParams, options
|
|
18869
|
+
searchChannels: (params: SearchChannelsParams, options?: CallApiOptions['options']) => Promise<{
|
|
18340
18870
|
ok: false;
|
|
18341
18871
|
status: 400 | 401;
|
|
18342
18872
|
data: unknown;
|
|
@@ -18394,7 +18924,7 @@ declare class TwitchApi {
|
|
|
18394
18924
|
*
|
|
18395
18925
|
* @see https://dev.twitch.tv/docs/api/reference#get-stream-key
|
|
18396
18926
|
*/
|
|
18397
|
-
getStreamKey: (params: GetStreamKeyParams, options
|
|
18927
|
+
getStreamKey: (params: GetStreamKeyParams, options?: CallApiOptions['options']) => Promise<{
|
|
18398
18928
|
ok: false;
|
|
18399
18929
|
status: 400 | 401;
|
|
18400
18930
|
data: unknown;
|
|
@@ -18436,7 +18966,7 @@ declare class TwitchApi {
|
|
|
18436
18966
|
*
|
|
18437
18967
|
* @see https://dev.twitch.tv/docs/api/reference#get-streams
|
|
18438
18968
|
*/
|
|
18439
|
-
getStreams: (params
|
|
18969
|
+
getStreams: (params?: GetStreamsParams | null | undefined, options?: CallApiOptions['options']) => Promise<{
|
|
18440
18970
|
ok: false;
|
|
18441
18971
|
status: 400 | 401;
|
|
18442
18972
|
data: unknown;
|
|
@@ -18497,7 +19027,7 @@ declare class TwitchApi {
|
|
|
18497
19027
|
*
|
|
18498
19028
|
* @see https://dev.twitch.tv/docs/api/reference#get-followed-streams
|
|
18499
19029
|
*/
|
|
18500
|
-
getFollowedStreams: (params: GetFollowedStreamsParams, options
|
|
19030
|
+
getFollowedStreams: (params: GetFollowedStreamsParams, options?: CallApiOptions['options']) => Promise<{
|
|
18501
19031
|
ok: false;
|
|
18502
19032
|
status: 400 | 401;
|
|
18503
19033
|
data: unknown;
|
|
@@ -18575,7 +19105,7 @@ declare class TwitchApi {
|
|
|
18575
19105
|
*
|
|
18576
19106
|
* @see https://dev.twitch.tv/docs/api/reference#create-stream-marker
|
|
18577
19107
|
*/
|
|
18578
|
-
createStreamMarker: (body: CreateStreamMarkerBody, options
|
|
19108
|
+
createStreamMarker: (body: CreateStreamMarkerBody, options?: CallApiOptions['options']) => Promise<{
|
|
18579
19109
|
ok: false;
|
|
18580
19110
|
status: 400 | 401 | 403 | 404;
|
|
18581
19111
|
data: unknown;
|
|
@@ -18629,7 +19159,7 @@ declare class TwitchApi {
|
|
|
18629
19159
|
*
|
|
18630
19160
|
* @see https://dev.twitch.tv/docs/api/reference#get-stream-markers
|
|
18631
19161
|
*/
|
|
18632
|
-
getStreamMarkers: (params
|
|
19162
|
+
getStreamMarkers: (params?: GetStreamMarkersParams | null | undefined, options?: CallApiOptions['options']) => Promise<{
|
|
18633
19163
|
ok: false;
|
|
18634
19164
|
status: 400 | 401 | 403 | 404;
|
|
18635
19165
|
data: unknown;
|
|
@@ -18691,7 +19221,7 @@ declare class TwitchApi {
|
|
|
18691
19221
|
*
|
|
18692
19222
|
* @see https://dev.twitch.tv/docs/api/reference#get-broadcaster-subscriptions
|
|
18693
19223
|
*/
|
|
18694
|
-
getBroadcasterSubscriptions: (params: GetBroadcasterSubscriptionsParams, options
|
|
19224
|
+
getBroadcasterSubscriptions: (params: GetBroadcasterSubscriptionsParams, options?: CallApiOptions['options']) => Promise<{
|
|
18695
19225
|
ok: false;
|
|
18696
19226
|
status: 400 | 401;
|
|
18697
19227
|
data: unknown;
|
|
@@ -18758,7 +19288,7 @@ declare class TwitchApi {
|
|
|
18758
19288
|
*
|
|
18759
19289
|
* @see https://dev.twitch.tv/docs/api/reference#check-user-subscription
|
|
18760
19290
|
*/
|
|
18761
|
-
checkUserSubscription: (params: CheckUserSubscriptionParams, options
|
|
19291
|
+
checkUserSubscription: (params: CheckUserSubscriptionParams, options?: CallApiOptions['options']) => Promise<{
|
|
18762
19292
|
ok: false;
|
|
18763
19293
|
status: 400 | 401 | 404;
|
|
18764
19294
|
data: unknown;
|
|
@@ -18812,7 +19342,7 @@ declare class TwitchApi {
|
|
|
18812
19342
|
*
|
|
18813
19343
|
* @see https://dev.twitch.tv/docs/api/reference#get-all-stream-tags
|
|
18814
19344
|
*/
|
|
18815
|
-
getAllStreamTags: (params
|
|
19345
|
+
getAllStreamTags: (params?: GetAllStreamTagsParams | null | undefined, options?: CallApiOptions['options']) => Promise<{
|
|
18816
19346
|
ok: false;
|
|
18817
19347
|
status: 400 | 401;
|
|
18818
19348
|
data: unknown;
|
|
@@ -18867,7 +19397,7 @@ declare class TwitchApi {
|
|
|
18867
19397
|
*
|
|
18868
19398
|
* @see https://dev.twitch.tv/docs/api/reference#get-stream-tags
|
|
18869
19399
|
*/
|
|
18870
|
-
getStreamTags: (params: GetStreamTagsParams, options
|
|
19400
|
+
getStreamTags: (params: GetStreamTagsParams, options?: CallApiOptions['options']) => Promise<{
|
|
18871
19401
|
ok: false;
|
|
18872
19402
|
status: 400 | 401;
|
|
18873
19403
|
data: unknown;
|
|
@@ -18922,7 +19452,7 @@ declare class TwitchApi {
|
|
|
18922
19452
|
*
|
|
18923
19453
|
* @see https://dev.twitch.tv/docs/api/reference#get-channel-teams
|
|
18924
19454
|
*/
|
|
18925
|
-
getChannelTeams: (params: GetChannelTeamsParams, options
|
|
19455
|
+
getChannelTeams: (params: GetChannelTeamsParams, options?: CallApiOptions['options']) => Promise<{
|
|
18926
19456
|
ok: false;
|
|
18927
19457
|
status: 400 | 401 | 404;
|
|
18928
19458
|
data: unknown;
|
|
@@ -18961,7 +19491,7 @@ declare class TwitchApi {
|
|
|
18961
19491
|
*
|
|
18962
19492
|
* _200 OK_
|
|
18963
19493
|
*
|
|
18964
|
-
* Successfully retrieved the team
|
|
19494
|
+
* Successfully retrieved the team's information.
|
|
18965
19495
|
*
|
|
18966
19496
|
* _400 Bad Request_
|
|
18967
19497
|
*
|
|
@@ -18981,7 +19511,7 @@ declare class TwitchApi {
|
|
|
18981
19511
|
*
|
|
18982
19512
|
* @see https://dev.twitch.tv/docs/api/reference#get-teams
|
|
18983
19513
|
*/
|
|
18984
|
-
getTeams: (params
|
|
19514
|
+
getTeams: (params?: GetTeamsParams | null | undefined, options?: CallApiOptions['options']) => Promise<{
|
|
18985
19515
|
ok: false;
|
|
18986
19516
|
status: 400 | 401 | 404;
|
|
18987
19517
|
data: unknown;
|
|
@@ -19030,7 +19560,7 @@ declare class TwitchApi {
|
|
|
19030
19560
|
*
|
|
19031
19561
|
* _200 OK_
|
|
19032
19562
|
*
|
|
19033
|
-
* Successfully retrieved the specified users
|
|
19563
|
+
* Successfully retrieved the specified users' information.
|
|
19034
19564
|
*
|
|
19035
19565
|
* _400 Bad Request_
|
|
19036
19566
|
*
|
|
@@ -19045,7 +19575,7 @@ declare class TwitchApi {
|
|
|
19045
19575
|
*
|
|
19046
19576
|
* @see https://dev.twitch.tv/docs/api/reference#get-users
|
|
19047
19577
|
*/
|
|
19048
|
-
getUsers: (params
|
|
19578
|
+
getUsers: (params?: GetUsersParams | null | undefined, options?: CallApiOptions['options']) => Promise<{
|
|
19049
19579
|
ok: false;
|
|
19050
19580
|
status: 400 | 401;
|
|
19051
19581
|
data: unknown;
|
|
@@ -19085,7 +19615,7 @@ declare class TwitchApi {
|
|
|
19085
19615
|
*
|
|
19086
19616
|
* _200 OK_
|
|
19087
19617
|
*
|
|
19088
|
-
* Successfully updated the specified user
|
|
19618
|
+
* Successfully updated the specified user's information.
|
|
19089
19619
|
*
|
|
19090
19620
|
* _400 Bad Request_
|
|
19091
19621
|
*
|
|
@@ -19100,7 +19630,7 @@ declare class TwitchApi {
|
|
|
19100
19630
|
*
|
|
19101
19631
|
* @see https://dev.twitch.tv/docs/api/reference#update-user
|
|
19102
19632
|
*/
|
|
19103
|
-
updateUser: (params
|
|
19633
|
+
updateUser: (params?: UpdateUserParams | null | undefined, options?: CallApiOptions['options']) => Promise<{
|
|
19104
19634
|
ok: false;
|
|
19105
19635
|
status: 400 | 401;
|
|
19106
19636
|
data: unknown;
|
|
@@ -19138,7 +19668,7 @@ declare class TwitchApi {
|
|
|
19138
19668
|
*
|
|
19139
19669
|
* _200 OK_
|
|
19140
19670
|
*
|
|
19141
|
-
* Successfully retrieved the broadcaster
|
|
19671
|
+
* Successfully retrieved the broadcaster's list of blocked users.
|
|
19142
19672
|
*
|
|
19143
19673
|
* _400 Bad Request_
|
|
19144
19674
|
*
|
|
@@ -19154,7 +19684,7 @@ declare class TwitchApi {
|
|
|
19154
19684
|
*
|
|
19155
19685
|
* @see https://dev.twitch.tv/docs/api/reference#get-user-block-list
|
|
19156
19686
|
*/
|
|
19157
|
-
getUserBlockList: (params: GetUserBlockListParams, options
|
|
19687
|
+
getUserBlockList: (params: GetUserBlockListParams, options?: CallApiOptions['options']) => Promise<{
|
|
19158
19688
|
ok: false;
|
|
19159
19689
|
status: 400 | 401;
|
|
19160
19690
|
data: unknown;
|
|
@@ -19204,7 +19734,7 @@ declare class TwitchApi {
|
|
|
19204
19734
|
*
|
|
19205
19735
|
* @see https://dev.twitch.tv/docs/api/reference#block-user
|
|
19206
19736
|
*/
|
|
19207
|
-
blockUser: (params: BlockUserParams, options
|
|
19737
|
+
blockUser: (params: BlockUserParams, options?: CallApiOptions['options']) => Promise<{
|
|
19208
19738
|
ok: true;
|
|
19209
19739
|
status: 204;
|
|
19210
19740
|
data: void;
|
|
@@ -19243,7 +19773,7 @@ declare class TwitchApi {
|
|
|
19243
19773
|
*
|
|
19244
19774
|
* @see https://dev.twitch.tv/docs/api/reference#unblock-user
|
|
19245
19775
|
*/
|
|
19246
|
-
unblockUser: (params: UnblockUserParams, options
|
|
19776
|
+
unblockUser: (params: UnblockUserParams, options?: CallApiOptions['options']) => Promise<{
|
|
19247
19777
|
ok: true;
|
|
19248
19778
|
status: 204;
|
|
19249
19779
|
data: void;
|
|
@@ -19267,7 +19797,7 @@ declare class TwitchApi {
|
|
|
19267
19797
|
*
|
|
19268
19798
|
* _200 OK_
|
|
19269
19799
|
*
|
|
19270
|
-
* Successfully retrieved the user
|
|
19800
|
+
* Successfully retrieved the user's installed extensions.
|
|
19271
19801
|
*
|
|
19272
19802
|
* _401 Unauthorized_
|
|
19273
19803
|
*
|
|
@@ -19278,7 +19808,7 @@ declare class TwitchApi {
|
|
|
19278
19808
|
*
|
|
19279
19809
|
* @see https://dev.twitch.tv/docs/api/reference#get-user-extensions
|
|
19280
19810
|
*/
|
|
19281
|
-
getUserExtensions: (options
|
|
19811
|
+
getUserExtensions: (options?: CallApiOptions['options']) => Promise<{
|
|
19282
19812
|
ok: false;
|
|
19283
19813
|
status: 401;
|
|
19284
19814
|
data: unknown;
|
|
@@ -19312,7 +19842,7 @@ declare class TwitchApi {
|
|
|
19312
19842
|
*
|
|
19313
19843
|
* _200 OK_
|
|
19314
19844
|
*
|
|
19315
|
-
* Successfully retrieved the user
|
|
19845
|
+
* Successfully retrieved the user's active extensions.
|
|
19316
19846
|
*
|
|
19317
19847
|
* _400 Bad Request_
|
|
19318
19848
|
*
|
|
@@ -19326,7 +19856,7 @@ declare class TwitchApi {
|
|
|
19326
19856
|
*
|
|
19327
19857
|
* @see https://dev.twitch.tv/docs/api/reference#get-user-active-extensions
|
|
19328
19858
|
*/
|
|
19329
|
-
getUserActiveExtensions: (params
|
|
19859
|
+
getUserActiveExtensions: (params?: GetUserActiveExtensionsParams | null | undefined, options?: CallApiOptions['options']) => Promise<{
|
|
19330
19860
|
ok: false;
|
|
19331
19861
|
status: 400 | 401;
|
|
19332
19862
|
data: unknown;
|
|
@@ -19400,7 +19930,7 @@ declare class TwitchApi {
|
|
|
19400
19930
|
*
|
|
19401
19931
|
* @see https://dev.twitch.tv/docs/api/reference#update-user-extensions
|
|
19402
19932
|
*/
|
|
19403
|
-
updateUserExtensions: (body: UpdateUserExtensionsBody, options
|
|
19933
|
+
updateUserExtensions: (body: UpdateUserExtensionsBody, options?: CallApiOptions['options']) => Promise<{
|
|
19404
19934
|
ok: false;
|
|
19405
19935
|
status: 400 | 401 | 404;
|
|
19406
19936
|
data: unknown;
|
|
@@ -19482,7 +20012,7 @@ declare class TwitchApi {
|
|
|
19482
20012
|
*
|
|
19483
20013
|
* @see https://dev.twitch.tv/docs/api/reference#get-videos
|
|
19484
20014
|
*/
|
|
19485
|
-
getVideos: (params
|
|
20015
|
+
getVideos: (params?: GetVideosParams | null | undefined, options?: CallApiOptions['options']) => Promise<{
|
|
19486
20016
|
ok: false;
|
|
19487
20017
|
status: 400 | 401 | 404;
|
|
19488
20018
|
data: unknown;
|
|
@@ -19549,7 +20079,7 @@ declare class TwitchApi {
|
|
|
19549
20079
|
*
|
|
19550
20080
|
* @see https://dev.twitch.tv/docs/api/reference#delete-videos
|
|
19551
20081
|
*/
|
|
19552
|
-
deleteVideos: (params: DeleteVideosParams, options
|
|
20082
|
+
deleteVideos: (params: DeleteVideosParams, options?: CallApiOptions['options']) => Promise<{
|
|
19553
20083
|
ok: false;
|
|
19554
20084
|
status: 400 | 401;
|
|
19555
20085
|
data: unknown;
|
|
@@ -19618,7 +20148,7 @@ declare class TwitchApi {
|
|
|
19618
20148
|
*
|
|
19619
20149
|
* @see https://dev.twitch.tv/docs/api/reference#send-whisper
|
|
19620
20150
|
*/
|
|
19621
|
-
sendWhisper: (params: SendWhisperParams, body: SendWhisperBody, options
|
|
20151
|
+
sendWhisper: (params: SendWhisperParams, body: SendWhisperBody, options?: CallApiOptions['options']) => Promise<{
|
|
19622
20152
|
ok: true;
|
|
19623
20153
|
status: 204;
|
|
19624
20154
|
data: void;
|
|
@@ -19630,4 +20160,4 @@ declare class TwitchApi {
|
|
|
19630
20160
|
};
|
|
19631
20161
|
}
|
|
19632
20162
|
|
|
19633
|
-
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 };
|