ts-twitch-api 0.2.4 → 0.2.5
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 +62 -13
- package/dist/index.d.cts +423 -1440
- package/dist/index.d.ts +423 -1440
- package/dist/index.js +59 -10
- package/package.json +5 -6
package/dist/index.d.cts
CHANGED
|
@@ -374,8 +374,9 @@ interface components {
|
|
|
374
374
|
/** @description List of labels that should be set as the Channel’s CCLs. */
|
|
375
375
|
content_classification_labels?: ({
|
|
376
376
|
/**
|
|
377
|
-
* @description ID of the [Content Classification Labels](https://
|
|
377
|
+
* @description ID of the [Content Classification Labels](https://help.twitch.tv/s/article/content-classification-labels) that must be added/removed from the channel. Can be one of the following values:
|
|
378
378
|
*
|
|
379
|
+
* * DebatedSocialIssuesAndPolitics
|
|
379
380
|
* * DrugsIntoxication
|
|
380
381
|
* * SexualThemes
|
|
381
382
|
* * ViolentGraphic
|
|
@@ -383,7 +384,7 @@ interface components {
|
|
|
383
384
|
* * ProfanityVulgarity
|
|
384
385
|
* @enum {string}
|
|
385
386
|
*/
|
|
386
|
-
id: "DrugsIntoxication" | "SexualThemes" | "ViolentGraphic" | "Gambling" | "ProfanityVulgarity";
|
|
387
|
+
id: "DebatedSocialIssuesAndPolitics" | "DrugsIntoxication" | "SexualThemes" | "ViolentGraphic" | "Gambling" | "ProfanityVulgarity";
|
|
387
388
|
/** @description Boolean flag indicating whether the label should be enabled (true) or disabled for the channel. */
|
|
388
389
|
is_enabled: boolean;
|
|
389
390
|
})[];
|
|
@@ -643,6 +644,11 @@ interface components {
|
|
|
643
644
|
GetCustomRewardRedemptionResponse: {
|
|
644
645
|
/** @description The list of redemptions for the specified reward. The list is empty if there are no redemptions that match the redemption criteria. */
|
|
645
646
|
data: components["schemas"]["CustomRewardRedemption"][];
|
|
647
|
+
/** @description Contains the information used to page through the list of results. The object is empty if there are no more pages left to page through.[Read More](https://dev.twitch.tv/docs/api/guide#pagination) */
|
|
648
|
+
pagination?: {
|
|
649
|
+
/** @description The cursor used to get the next page of results. Use the cursor to set the request’s _after_ query parameter. */
|
|
650
|
+
cursor?: string;
|
|
651
|
+
};
|
|
646
652
|
};
|
|
647
653
|
UpdateCustomRewardBody: {
|
|
648
654
|
/** @description The reward’s title. The title may contain a maximum of 45 characters and it must be unique amongst all of the broadcaster’s custom rewards. */
|
|
@@ -1085,6 +1091,29 @@ interface components {
|
|
|
1085
1091
|
/** @description The list of chat settings. The list contains a single object with all the settings. */
|
|
1086
1092
|
data: components["schemas"]["ChatSettings"][];
|
|
1087
1093
|
};
|
|
1094
|
+
GetSharedChatSessionResponse: {
|
|
1095
|
+
data: {
|
|
1096
|
+
/** @description The unique identifier for the shared chat session. */
|
|
1097
|
+
session_id: string;
|
|
1098
|
+
/** @description The User ID of the host channel. */
|
|
1099
|
+
host_broadcaster_id: string;
|
|
1100
|
+
/** @description The list of participants in the session. */
|
|
1101
|
+
participants: {
|
|
1102
|
+
/** @description The User ID of the participant channel. */
|
|
1103
|
+
broadcaster_id: string;
|
|
1104
|
+
}[];
|
|
1105
|
+
/**
|
|
1106
|
+
* Format: date-time
|
|
1107
|
+
* @description The UTC date and time (in RFC3339 format) for when the session was created.
|
|
1108
|
+
*/
|
|
1109
|
+
created_at: string;
|
|
1110
|
+
/**
|
|
1111
|
+
* Format: date-time
|
|
1112
|
+
* @description The UTC date and time (in RFC3339 format) for when the session was last updated.
|
|
1113
|
+
*/
|
|
1114
|
+
updated_at: string;
|
|
1115
|
+
}[];
|
|
1116
|
+
};
|
|
1088
1117
|
GetUserEmotesResponse: {
|
|
1089
1118
|
data: ({
|
|
1090
1119
|
/** @description An ID that uniquely identifies this emote. */
|
|
@@ -1350,7 +1379,7 @@ interface components {
|
|
|
1350
1379
|
id: string;
|
|
1351
1380
|
/** @description A URL to the clip. */
|
|
1352
1381
|
url: string;
|
|
1353
|
-
/** @description A URL that you can use in an iframe to embed the clip (see [Embedding Video and Clips](https://dev.twitch.tv/docs/embed/video-and-clips)). */
|
|
1382
|
+
/** @description A URL that you can use in an iframe to embed the clip (see [Embedding Video and Clips](https://dev.twitch.tv/docs/embed/video-and-clips/)). */
|
|
1354
1383
|
embed_url: string;
|
|
1355
1384
|
/** @description An ID that identifies the broadcaster that the video was clipped from. */
|
|
1356
1385
|
broadcaster_id: string;
|
|
@@ -2031,7 +2060,7 @@ interface components {
|
|
|
2031
2060
|
* @description The type of subscription to create. For a list of subscriptions that you can create, see [Subscription Types](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#subscription-types). Set this field to the value in the **Name** column of the Subscription Types table.
|
|
2032
2061
|
* @enum {string}
|
|
2033
2062
|
*/
|
|
2034
|
-
type: "automod.message.hold" | "automod.message.update" | "automod.settings.update" | "automod.terms.update" | "channel.update" | "channel.follow" | "channel.ad_break.begin" | "channel.chat.clear" | "channel.chat.clear_user_messages" | "channel.chat.message" | "channel.chat.message_delete" | "channel.chat.notification" | "channel.chat_settings.update" | "channel.chat.user_message_hold" | "channel.chat.user_message_update" | "channel.subscribe" | "channel.subscription.end" | "channel.subscription.gift" | "channel.subscription.message" | "channel.cheer" | "channel.raid" | "channel.ban" | "channel.unban" | "channel.unban_request.create" | "channel.unban_request.resolve" | "channel.moderate" | "channel.moderator.add" | "channel.moderator.remove" | "channel.guest_star_session.begin" | "channel.guest_star_session.end" | "channel.guest_star_guest.update" | "channel.guest_star_settings.update" | "channel.channel_points_automatic_reward_redemption.add" | "channel.channel_points_custom_reward.add" | "channel.channel_points_custom_reward.update" | "channel.channel_points_custom_reward.remove" | "channel.channel_points_custom_reward_redemption.add" | "channel.channel_points_custom_reward_redemption.update" | "channel.poll.begin" | "channel.poll.progress" | "channel.poll.end" | "channel.prediction.begin" | "channel.prediction.progress" | "channel.prediction.lock" | "channel.prediction.end" | "channel.suspicious_user.message" | "channel.suspicious_user.update" | "channel.vip.add" | "channel.vip.remove" | "channel.warning.acknowledge" | "channel.warning.send" | "channel.charity_campaign.donate" | "channel.charity_campaign.start" | "channel.charity_campaign.progress" | "channel.charity_campaign.stop" | "conduit.shard.disabled" | "drop.entitlement.grant" | "extension.bits_transaction.create" | "channel.goal.begin" | "channel.goal.progress" | "channel.goal.end" | "channel.hype_train.begin" | "channel.hype_train.progress" | "channel.hype_train.end" | "channel.shield_mode.begin" | "channel.shield_mode.end" | "channel.shoutout.create" | "channel.shoutout.receive" | "stream.online" | "stream.offline" | "user.authorization.grant" | "user.authorization.revoke" | "user.update" | "user.whisper.message";
|
|
2063
|
+
type: "automod.message.hold" | "automod.message.update" | "automod.settings.update" | "automod.terms.update" | "channel.bits.use" | "channel.update" | "channel.follow" | "channel.ad_break.begin" | "channel.chat.clear" | "channel.chat.clear_user_messages" | "channel.chat.message" | "channel.chat.message_delete" | "channel.chat.notification" | "channel.chat_settings.update" | "channel.chat.user_message_hold" | "channel.chat.user_message_update" | "channel.shared_chat.begin" | "channel.shared_chat.update" | "channel.shared_chat.end" | "channel.subscribe" | "channel.subscription.end" | "channel.subscription.gift" | "channel.subscription.message" | "channel.cheer" | "channel.raid" | "channel.ban" | "channel.unban" | "channel.unban_request.create" | "channel.unban_request.resolve" | "channel.moderate" | "channel.moderator.add" | "channel.moderator.remove" | "channel.guest_star_session.begin" | "channel.guest_star_session.end" | "channel.guest_star_guest.update" | "channel.guest_star_settings.update" | "channel.channel_points_automatic_reward_redemption.add" | "channel.channel_points_custom_reward.add" | "channel.channel_points_custom_reward.update" | "channel.channel_points_custom_reward.remove" | "channel.channel_points_custom_reward_redemption.add" | "channel.channel_points_custom_reward_redemption.update" | "channel.poll.begin" | "channel.poll.progress" | "channel.poll.end" | "channel.prediction.begin" | "channel.prediction.progress" | "channel.prediction.lock" | "channel.prediction.end" | "channel.suspicious_user.message" | "channel.suspicious_user.update" | "channel.vip.add" | "channel.vip.remove" | "channel.warning.acknowledge" | "channel.warning.send" | "channel.charity_campaign.donate" | "channel.charity_campaign.start" | "channel.charity_campaign.progress" | "channel.charity_campaign.stop" | "conduit.shard.disabled" | "drop.entitlement.grant" | "extension.bits_transaction.create" | "channel.goal.begin" | "channel.goal.progress" | "channel.goal.end" | "channel.hype_train.begin" | "channel.hype_train.progress" | "channel.hype_train.end" | "channel.shield_mode.begin" | "channel.shield_mode.end" | "channel.shoutout.create" | "channel.shoutout.receive" | "stream.online" | "stream.offline" | "user.authorization.grant" | "user.authorization.revoke" | "user.update" | "user.whisper.message";
|
|
2035
2064
|
/** @description The version number that identifies the definition of the subscription type that you want the response to use. */
|
|
2036
2065
|
version: string;
|
|
2037
2066
|
/** @description A JSON object that contains the parameter values that are specific to the specified subscription type. For the object’s required and optional fields, see the subscription type’s documentation. */
|
|
@@ -2090,7 +2119,7 @@ interface components {
|
|
|
2090
2119
|
* @description The subscription's type. See [Subscription Types](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#subscription-types).
|
|
2091
2120
|
* @enum {string}
|
|
2092
2121
|
*/
|
|
2093
|
-
type: "automod.message.hold" | "automod.message.update" | "automod.settings.update" | "automod.terms.update" | "channel.update" | "channel.follow" | "channel.ad_break.begin" | "channel.chat.clear" | "channel.chat.clear_user_messages" | "channel.chat.message" | "channel.chat.message_delete" | "channel.chat.notification" | "channel.chat_settings.update" | "channel.chat.user_message_hold" | "channel.chat.user_message_update" | "channel.subscribe" | "channel.subscription.end" | "channel.subscription.gift" | "channel.subscription.message" | "channel.cheer" | "channel.raid" | "channel.ban" | "channel.unban" | "channel.unban_request.create" | "channel.unban_request.resolve" | "channel.moderate" | "channel.moderator.add" | "channel.moderator.remove" | "channel.guest_star_session.begin" | "channel.guest_star_session.end" | "channel.guest_star_guest.update" | "channel.guest_star_settings.update" | "channel.channel_points_automatic_reward_redemption.add" | "channel.channel_points_custom_reward.add" | "channel.channel_points_custom_reward.update" | "channel.channel_points_custom_reward.remove" | "channel.channel_points_custom_reward_redemption.add" | "channel.channel_points_custom_reward_redemption.update" | "channel.poll.begin" | "channel.poll.progress" | "channel.poll.end" | "channel.prediction.begin" | "channel.prediction.progress" | "channel.prediction.lock" | "channel.prediction.end" | "channel.suspicious_user.message" | "channel.suspicious_user.update" | "channel.vip.add" | "channel.vip.remove" | "channel.warning.acknowledge" | "channel.warning.send" | "channel.charity_campaign.donate" | "channel.charity_campaign.start" | "channel.charity_campaign.progress" | "channel.charity_campaign.stop" | "conduit.shard.disabled" | "drop.entitlement.grant" | "extension.bits_transaction.create" | "channel.goal.begin" | "channel.goal.progress" | "channel.goal.end" | "channel.hype_train.begin" | "channel.hype_train.progress" | "channel.hype_train.end" | "channel.shield_mode.begin" | "channel.shield_mode.end" | "channel.shoutout.create" | "channel.shoutout.receive" | "stream.online" | "stream.offline" | "user.authorization.grant" | "user.authorization.revoke" | "user.update" | "user.whisper.message";
|
|
2122
|
+
type: "automod.message.hold" | "automod.message.update" | "automod.settings.update" | "automod.terms.update" | "channel.bits.use" | "channel.update" | "channel.follow" | "channel.ad_break.begin" | "channel.chat.clear" | "channel.chat.clear_user_messages" | "channel.chat.message" | "channel.chat.message_delete" | "channel.chat.notification" | "channel.chat_settings.update" | "channel.chat.user_message_hold" | "channel.chat.user_message_update" | "channel.shared_chat.begin" | "channel.shared_chat.update" | "channel.shared_chat.end" | "channel.subscribe" | "channel.subscription.end" | "channel.subscription.gift" | "channel.subscription.message" | "channel.cheer" | "channel.raid" | "channel.ban" | "channel.unban" | "channel.unban_request.create" | "channel.unban_request.resolve" | "channel.moderate" | "channel.moderator.add" | "channel.moderator.remove" | "channel.guest_star_session.begin" | "channel.guest_star_session.end" | "channel.guest_star_guest.update" | "channel.guest_star_settings.update" | "channel.channel_points_automatic_reward_redemption.add" | "channel.channel_points_custom_reward.add" | "channel.channel_points_custom_reward.update" | "channel.channel_points_custom_reward.remove" | "channel.channel_points_custom_reward_redemption.add" | "channel.channel_points_custom_reward_redemption.update" | "channel.poll.begin" | "channel.poll.progress" | "channel.poll.end" | "channel.prediction.begin" | "channel.prediction.progress" | "channel.prediction.lock" | "channel.prediction.end" | "channel.suspicious_user.message" | "channel.suspicious_user.update" | "channel.vip.add" | "channel.vip.remove" | "channel.warning.acknowledge" | "channel.warning.send" | "channel.charity_campaign.donate" | "channel.charity_campaign.start" | "channel.charity_campaign.progress" | "channel.charity_campaign.stop" | "conduit.shard.disabled" | "drop.entitlement.grant" | "extension.bits_transaction.create" | "channel.goal.begin" | "channel.goal.progress" | "channel.goal.end" | "channel.hype_train.begin" | "channel.hype_train.progress" | "channel.hype_train.end" | "channel.shield_mode.begin" | "channel.shield_mode.end" | "channel.shoutout.create" | "channel.shoutout.receive" | "stream.online" | "stream.offline" | "user.authorization.grant" | "user.authorization.revoke" | "user.update" | "user.whisper.message";
|
|
2094
2123
|
/** @description The version number that identifies this definition of the subscription's data. */
|
|
2095
2124
|
version: string;
|
|
2096
2125
|
/** @description The subscription's parameter values. This is a string-encoded JSON object whose contents are determined by the subscription type. */
|
|
@@ -3405,6 +3434,11 @@ interface components {
|
|
|
3405
3434
|
SearchCategoriesResponse: {
|
|
3406
3435
|
/** @description The list of games or categories that match the query. The list is empty if there are no matches. */
|
|
3407
3436
|
data: components["schemas"]["Category"][];
|
|
3437
|
+
/** @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) */
|
|
3438
|
+
pagination?: {
|
|
3439
|
+
/** @description The cursor used to get the next page of results. Use the cursor to set the request’s _after_ query parameter. */
|
|
3440
|
+
cursor?: string;
|
|
3441
|
+
};
|
|
3408
3442
|
};
|
|
3409
3443
|
Channel: {
|
|
3410
3444
|
/** @description The ISO 639-1 two-letter language code of the language used by the broadcaster. For example, _en_ for English. If the broadcaster uses a language not in the list of [supported stream languages](https://help.twitch.tv/s/article/languages-on-twitch#streamlang), the value is _other_. */
|
|
@@ -3443,6 +3477,11 @@ interface components {
|
|
|
3443
3477
|
SearchChannelsResponse: {
|
|
3444
3478
|
/** @description The list of channels that match the query. The list is empty if there are no matches. */
|
|
3445
3479
|
data: components["schemas"]["Channel"][];
|
|
3480
|
+
/** @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) */
|
|
3481
|
+
pagination?: {
|
|
3482
|
+
/** @description The cursor used to get the next page of results. Use the cursor to set the request’s _after_ query parameter. */
|
|
3483
|
+
cursor?: string;
|
|
3484
|
+
};
|
|
3446
3485
|
};
|
|
3447
3486
|
GetStreamKeyResponse: {
|
|
3448
3487
|
/** @description A list that contains the channel’s stream key. */
|
|
@@ -3840,6 +3879,11 @@ interface components {
|
|
|
3840
3879
|
GetUserBlockListResponse: {
|
|
3841
3880
|
/** @description The list of blocked users. The list is in descending order by when the user was blocked. */
|
|
3842
3881
|
data: components["schemas"]["UserBlockList"][];
|
|
3882
|
+
/** @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) */
|
|
3883
|
+
pagination?: {
|
|
3884
|
+
/** @description The cursor used to get the next page of results. Use the cursor to set the request’s _after_ query parameter. */
|
|
3885
|
+
cursor?: string;
|
|
3886
|
+
};
|
|
3843
3887
|
};
|
|
3844
3888
|
UserExtension: {
|
|
3845
3889
|
/** @description An ID that identifies the extension. */
|
|
@@ -5698,6 +5742,45 @@ interface operations {
|
|
|
5698
5742
|
};
|
|
5699
5743
|
};
|
|
5700
5744
|
};
|
|
5745
|
+
/**
|
|
5746
|
+
* NEW Retrieves the active shared chat session for a channel.
|
|
5747
|
+
* @description NEW Retrieves the active shared chat session for a channel.
|
|
5748
|
+
*
|
|
5749
|
+
* __Authorization:__
|
|
5750
|
+
*
|
|
5751
|
+
* Requires an [app access token](https://dev.twitch.tv/docs/cli/token-command/#app-access-token) or [user access token](https://dev.twitch.tv/docs/authentication/#user-access-tokens).
|
|
5752
|
+
*/
|
|
5753
|
+
"get-shared-chat-session": {
|
|
5754
|
+
parameters: {
|
|
5755
|
+
query: {
|
|
5756
|
+
/** @description The User ID of the channel broadcaster. */
|
|
5757
|
+
broadcaster_id: string;
|
|
5758
|
+
};
|
|
5759
|
+
};
|
|
5760
|
+
responses: {
|
|
5761
|
+
/** @description Successfully retrieved the shared chat session. Returns an empty array if the broadcaster\_id in the request isn’t in a shared chat session. */
|
|
5762
|
+
200: {
|
|
5763
|
+
content: {
|
|
5764
|
+
"application/json": components["schemas"]["GetSharedChatSessionResponse"];
|
|
5765
|
+
};
|
|
5766
|
+
};
|
|
5767
|
+
/** @description The ID in the `broadcaster_id` query parameter is not valid. */
|
|
5768
|
+
400: {
|
|
5769
|
+
content: never;
|
|
5770
|
+
};
|
|
5771
|
+
/**
|
|
5772
|
+
* @description * The OAuth token is not valid.
|
|
5773
|
+
* * The Authorization header is required and must contain a user access token.
|
|
5774
|
+
*/
|
|
5775
|
+
401: {
|
|
5776
|
+
content: never;
|
|
5777
|
+
};
|
|
5778
|
+
/** @description Internal Server Error. */
|
|
5779
|
+
500: {
|
|
5780
|
+
content: never;
|
|
5781
|
+
};
|
|
5782
|
+
};
|
|
5783
|
+
};
|
|
5701
5784
|
/**
|
|
5702
5785
|
* NEW Retrieves emotes available to the user across all channels.
|
|
5703
5786
|
* @description NEW Retrieves emotes available to the user across all channels.
|
|
@@ -5752,6 +5835,8 @@ interface operations {
|
|
|
5752
5835
|
* Sends an announcement to the broadcaster’s chat room.
|
|
5753
5836
|
* @description Sends an announcement to the broadcaster’s chat room.
|
|
5754
5837
|
*
|
|
5838
|
+
* **Rate Limits**: One announcement may be sent every 2 seconds.
|
|
5839
|
+
*
|
|
5755
5840
|
* __Authorization:__
|
|
5756
5841
|
*
|
|
5757
5842
|
* Requires a [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens) that includes the **moderator:manage:announcements** scope.
|
|
@@ -5809,6 +5894,10 @@ interface operations {
|
|
|
5809
5894
|
401: {
|
|
5810
5895
|
content: never;
|
|
5811
5896
|
};
|
|
5897
|
+
/** @description The sender has exceeded the number of announcements they may send to this **broadcaster\_id** within a given window. */
|
|
5898
|
+
429: {
|
|
5899
|
+
content: never;
|
|
5900
|
+
};
|
|
5812
5901
|
};
|
|
5813
5902
|
};
|
|
5814
5903
|
/**
|
|
@@ -5817,7 +5906,7 @@ interface operations {
|
|
|
5817
5906
|
*
|
|
5818
5907
|
* Twitch’s Shoutout feature is a great way for you to show support for other broadcasters and help them grow. Viewers who do not follow the other broadcaster will see a pop-up Follow button in your chat that they can click to follow the other broadcaster. [Learn More](https://help.twitch.tv/s/article/shoutouts)
|
|
5819
5908
|
*
|
|
5820
|
-
* **Rate Limits
|
|
5909
|
+
* **Rate Limits**: The broadcaster may send a Shoutout once every 2 minutes. They may send the same broadcaster a Shoutout once every 60 minutes.
|
|
5821
5910
|
*
|
|
5822
5911
|
* To receive notifications when a Shoutout is sent or received, subscribe to the [channel.shoutout.create](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelshoutoutcreate) and [channel.shoutout.receive](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelshoutoutreceive) subscription types. The **channel.shoutout.create** event includes cooldown periods that indicate when the broadcaster may send another Shoutout without exceeding the endpoint’s rate limit.
|
|
5823
5912
|
*
|
|
@@ -6071,6 +6160,8 @@ interface operations {
|
|
|
6071
6160
|
* Gets one or more video clips.
|
|
6072
6161
|
* @description Gets one or more video clips that were captured from streams. For information about clips, see [How to use clips](https://help.twitch.tv/s/article/how-to-use-clips).
|
|
6073
6162
|
*
|
|
6163
|
+
* When using pagination for clips, note that the maximum number of results returned over multiple requests will be approximately 1,000\. If additional results are necessary, paginate over different query parameters such as multiple `started_at` and `ended_at` timeframes to refine the search.
|
|
6164
|
+
*
|
|
6074
6165
|
* __Authorization:__
|
|
6075
6166
|
*
|
|
6076
6167
|
* Requires an [app access token](https://dev.twitch.tv/docs/authentication#app-access-tokens) or [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens).
|
|
@@ -6191,7 +6282,7 @@ interface operations {
|
|
|
6191
6282
|
};
|
|
6192
6283
|
/**
|
|
6193
6284
|
* NEW Gets the conduits for a client ID.
|
|
6194
|
-
* @description NEW Gets the [conduits](https://dev.twitch.tv/docs/eventsub/handling-conduit-events) for a client ID.
|
|
6285
|
+
* @description NEW Gets the [conduits](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/) for a client ID.
|
|
6195
6286
|
*
|
|
6196
6287
|
* __Authorization:__
|
|
6197
6288
|
*
|
|
@@ -6213,7 +6304,7 @@ interface operations {
|
|
|
6213
6304
|
};
|
|
6214
6305
|
/**
|
|
6215
6306
|
* NEW Creates a new conduit.
|
|
6216
|
-
* @description NEW Creates a new [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events).
|
|
6307
|
+
* @description NEW Creates a new [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/).
|
|
6217
6308
|
*
|
|
6218
6309
|
* __Authorization:__
|
|
6219
6310
|
*
|
|
@@ -6248,7 +6339,7 @@ interface operations {
|
|
|
6248
6339
|
};
|
|
6249
6340
|
/**
|
|
6250
6341
|
* NEW Deletes a specified conduit.
|
|
6251
|
-
* @description NEW Deletes a specified [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/). Note that it may take some time for Eventsub subscriptions on a deleted [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events) to show as disabled when calling [Get Eventsub Subscriptions](https://dev.twitch.tv/docs/api/reference/#get-eventsub-subscriptions).
|
|
6342
|
+
* @description NEW Deletes a specified [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/). Note that it may take some time for Eventsub subscriptions on a deleted [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/) to show as disabled when calling [Get Eventsub Subscriptions](https://dev.twitch.tv/docs/api/reference/#get-eventsub-subscriptions).
|
|
6252
6343
|
*
|
|
6253
6344
|
* __Authorization:__
|
|
6254
6345
|
*
|
|
@@ -6297,7 +6388,7 @@ interface operations {
|
|
|
6297
6388
|
};
|
|
6298
6389
|
/**
|
|
6299
6390
|
* NEW Updates a conduit’s shard count.
|
|
6300
|
-
* @description NEW Updates a [conduit’s](https://dev.twitch.tv/docs/eventsub/handling-conduit-events) shard count. To delete shards, update the count to a lower number, and the shards above the count will be deleted. For example, if the existing shard count is 100, by resetting shard count to 50, shards 50-99 are disabled.
|
|
6391
|
+
* @description NEW Updates a [conduit’s](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/) shard count. To delete shards, update the count to a lower number, and the shards above the count will be deleted. For example, if the existing shard count is 100, by resetting shard count to 50, shards 50-99 are disabled.
|
|
6301
6392
|
*
|
|
6302
6393
|
* __Authorization:__
|
|
6303
6394
|
*
|
|
@@ -6338,7 +6429,7 @@ interface operations {
|
|
|
6338
6429
|
};
|
|
6339
6430
|
/**
|
|
6340
6431
|
* NEW Gets a lists of all shards for a conduit.
|
|
6341
|
-
* @description NEW Gets a lists of all shards for a [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events).
|
|
6432
|
+
* @description NEW Gets a lists of all shards for a [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/).
|
|
6342
6433
|
*
|
|
6343
6434
|
* __Authorization:__
|
|
6344
6435
|
*
|
|
@@ -6381,7 +6472,7 @@ interface operations {
|
|
|
6381
6472
|
};
|
|
6382
6473
|
/**
|
|
6383
6474
|
* NEW Updates shard(s) for a conduit.
|
|
6384
|
-
* @description NEW Updates shard(s) for a [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events).
|
|
6475
|
+
* @description NEW Updates shard(s) for a [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/).
|
|
6385
6476
|
*
|
|
6386
6477
|
* **NOTE:** Shard IDs are indexed starting at 0, so a conduit with a `shard_count` of 5 will have shards with IDs 0 through 4.
|
|
6387
6478
|
*
|
|
@@ -6867,7 +6958,7 @@ interface operations {
|
|
|
6867
6958
|
query: {
|
|
6868
6959
|
/** @description The ID of the extension to get. Returns the list of broadcasters that are live and that have installed or activated this extension. */
|
|
6869
6960
|
extension_id: string;
|
|
6870
|
-
/** @description The maximum number of items
|
|
6961
|
+
/** @description The specific maximum number of items per page in the response. The actual number returned may be less than this limit. [Read More](https://dev.twitch.tv/docs/api/guide#pagination) */
|
|
6871
6962
|
first?: number;
|
|
6872
6963
|
/** @description The cursor used to get the next page of results. The `pagination` field in the response contains the cursor’s value. [Read More](https://dev.twitch.tv/docs/api/guide#pagination) */
|
|
6873
6964
|
after?: string;
|
|
@@ -7209,7 +7300,7 @@ interface operations {
|
|
|
7209
7300
|
*
|
|
7210
7301
|
* __Authorization:__
|
|
7211
7302
|
*
|
|
7212
|
-
* If you use [Webhooks](https://dev.twitch.tv/docs/eventsub/handling-webhook-events) or [Conduits](https://dev.twitch.tv/docs/eventsub/handling-conduit-events) to receive events, the request must specify an app access token. The request will fail if you use a user access token.
|
|
7303
|
+
* If you use [Webhooks](https://dev.twitch.tv/docs/eventsub/handling-webhook-events) or [Conduits](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/) to receive events, the request must specify an app access token. The request will fail if you use a user access token.
|
|
7213
7304
|
*
|
|
7214
7305
|
* If you use [WebSockets to receive events](https://dev.twitch.tv/docs/eventsub/handling-websocket-events), the request must specify a user access token. The request will fail if you use an app access token. The token may include any scopes.
|
|
7215
7306
|
*
|
|
@@ -7244,7 +7335,7 @@ interface operations {
|
|
|
7244
7335
|
*/
|
|
7245
7336
|
status?: "enabled" | "webhook_callback_verification_pending" | "webhook_callback_verification_failed" | "notification_failures_exceeded" | "authorization_revoked" | "moderator_removed" | "user_removed" | "chat_user_banned" | "version_removed" | "beta_maintenance" | "websocket_disconnected" | "websocket_failed_ping_pong" | "websocket_received_inbound_traffic" | "websocket_connection_unused" | "websocket_internal_error" | "websocket_network_timeout" | "websocket_network_error" | "websocket_failed_to_reconnect";
|
|
7246
7337
|
/** @description Filter subscriptions by subscription type. For a list of subscription types, see [Subscription Types](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#subscription-types). */
|
|
7247
|
-
type?: "automod.message.hold" | "automod.message.update" | "automod.settings.update" | "automod.terms.update" | "channel.update" | "channel.follow" | "channel.ad_break.begin" | "channel.chat.clear" | "channel.chat.clear_user_messages" | "channel.chat.message" | "channel.chat.message_delete" | "channel.chat.notification" | "channel.chat_settings.update" | "channel.chat.user_message_hold" | "channel.chat.user_message_update" | "channel.subscribe" | "channel.subscription.end" | "channel.subscription.gift" | "channel.subscription.message" | "channel.cheer" | "channel.raid" | "channel.ban" | "channel.unban" | "channel.unban_request.create" | "channel.unban_request.resolve" | "channel.moderate" | "channel.moderator.add" | "channel.moderator.remove" | "channel.guest_star_session.begin" | "channel.guest_star_session.end" | "channel.guest_star_guest.update" | "channel.guest_star_settings.update" | "channel.channel_points_automatic_reward_redemption.add" | "channel.channel_points_custom_reward.add" | "channel.channel_points_custom_reward.update" | "channel.channel_points_custom_reward.remove" | "channel.channel_points_custom_reward_redemption.add" | "channel.channel_points_custom_reward_redemption.update" | "channel.poll.begin" | "channel.poll.progress" | "channel.poll.end" | "channel.prediction.begin" | "channel.prediction.progress" | "channel.prediction.lock" | "channel.prediction.end" | "channel.suspicious_user.message" | "channel.suspicious_user.update" | "channel.vip.add" | "channel.vip.remove" | "channel.warning.acknowledge" | "channel.warning.send" | "channel.charity_campaign.donate" | "channel.charity_campaign.start" | "channel.charity_campaign.progress" | "channel.charity_campaign.stop" | "conduit.shard.disabled" | "drop.entitlement.grant" | "extension.bits_transaction.create" | "channel.goal.begin" | "channel.goal.progress" | "channel.goal.end" | "channel.hype_train.begin" | "channel.hype_train.progress" | "channel.hype_train.end" | "channel.shield_mode.begin" | "channel.shield_mode.end" | "channel.shoutout.create" | "channel.shoutout.receive" | "stream.online" | "stream.offline" | "user.authorization.grant" | "user.authorization.revoke" | "user.update" | "user.whisper.message";
|
|
7338
|
+
type?: "automod.message.hold" | "automod.message.update" | "automod.settings.update" | "automod.terms.update" | "channel.bits.use" | "channel.update" | "channel.follow" | "channel.ad_break.begin" | "channel.chat.clear" | "channel.chat.clear_user_messages" | "channel.chat.message" | "channel.chat.message_delete" | "channel.chat.notification" | "channel.chat_settings.update" | "channel.chat.user_message_hold" | "channel.chat.user_message_update" | "channel.shared_chat.begin" | "channel.shared_chat.update" | "channel.shared_chat.end" | "channel.subscribe" | "channel.subscription.end" | "channel.subscription.gift" | "channel.subscription.message" | "channel.cheer" | "channel.raid" | "channel.ban" | "channel.unban" | "channel.unban_request.create" | "channel.unban_request.resolve" | "channel.moderate" | "channel.moderator.add" | "channel.moderator.remove" | "channel.guest_star_session.begin" | "channel.guest_star_session.end" | "channel.guest_star_guest.update" | "channel.guest_star_settings.update" | "channel.channel_points_automatic_reward_redemption.add" | "channel.channel_points_custom_reward.add" | "channel.channel_points_custom_reward.update" | "channel.channel_points_custom_reward.remove" | "channel.channel_points_custom_reward_redemption.add" | "channel.channel_points_custom_reward_redemption.update" | "channel.poll.begin" | "channel.poll.progress" | "channel.poll.end" | "channel.prediction.begin" | "channel.prediction.progress" | "channel.prediction.lock" | "channel.prediction.end" | "channel.suspicious_user.message" | "channel.suspicious_user.update" | "channel.vip.add" | "channel.vip.remove" | "channel.warning.acknowledge" | "channel.warning.send" | "channel.charity_campaign.donate" | "channel.charity_campaign.start" | "channel.charity_campaign.progress" | "channel.charity_campaign.stop" | "conduit.shard.disabled" | "drop.entitlement.grant" | "extension.bits_transaction.create" | "channel.goal.begin" | "channel.goal.progress" | "channel.goal.end" | "channel.hype_train.begin" | "channel.hype_train.progress" | "channel.hype_train.end" | "channel.shield_mode.begin" | "channel.shield_mode.end" | "channel.shoutout.create" | "channel.shoutout.receive" | "stream.online" | "stream.offline" | "user.authorization.grant" | "user.authorization.revoke" | "user.update" | "user.whisper.message";
|
|
7248
7339
|
/** @description Filter subscriptions by user ID. The response contains subscriptions where this ID matches a user ID that you specified in the **Condition** object when you [created the subscription](https://dev.twitch.tv/docs/api/reference#create-eventsub-subscription). */
|
|
7249
7340
|
user_id?: string;
|
|
7250
7341
|
/** @description The cursor used to get the next page of results. The `pagination` object in the response contains the cursor's value. */
|
|
@@ -7287,7 +7378,7 @@ interface operations {
|
|
|
7287
7378
|
*
|
|
7288
7379
|
* If you use [WebSockets to receive events](https://dev.twitch.tv/docs/eventsub/handling-websocket-events), the request must specify a user access token. The request will fail if you use an app access token. If the subscription type requires user authorization, the token must include the required scope. However, if the subscription type doesn’t include user authorization, the token may include any scopes or no scopes.
|
|
7289
7380
|
*
|
|
7290
|
-
* If you use [Conduits](https://dev.twitch.tv/docs/eventsub/handling-conduit-events) to receive events, the request must specify an app access token. The request will fail if you use a user access token.
|
|
7381
|
+
* If you use [Conduits](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/) to receive events, the request must specify an app access token. The request will fail if you use a user access token.
|
|
7291
7382
|
*/
|
|
7292
7383
|
"create-eventsub-subscription": {
|
|
7293
7384
|
requestBody?: {
|
|
@@ -8759,7 +8850,7 @@ interface operations {
|
|
|
8759
8850
|
*
|
|
8760
8851
|
* __Authorization:__
|
|
8761
8852
|
*
|
|
8762
|
-
* * Requires a user access token that includes the **moderator:manage:unban
|
|
8853
|
+
* * Requires a user access token that includes the **moderator:manage:unban\_requests** scope.
|
|
8763
8854
|
* * Query parameter `moderator_id` must match the `user_id` in the[user access token](https://dev.twitch.tv/docs/authentication/#user-access-tokens).
|
|
8764
8855
|
*/
|
|
8765
8856
|
"resolve-unban-requests": {
|
|
@@ -10562,6 +10653,10 @@ interface operations {
|
|
|
10562
10653
|
401: {
|
|
10563
10654
|
content: never;
|
|
10564
10655
|
};
|
|
10656
|
+
/** @description The user must complete additional steps in order to stream. Present the user with the returned error message. */
|
|
10657
|
+
403: {
|
|
10658
|
+
content: never;
|
|
10659
|
+
};
|
|
10565
10660
|
};
|
|
10566
10661
|
};
|
|
10567
10662
|
/**
|
|
@@ -11720,6 +11815,7 @@ type GetEmoteSetsParams = ParamsSchema<'get-emote-sets'>;
|
|
|
11720
11815
|
type GetChannelChatBadgesParams = ParamsSchema<'get-channel-chat-badges'>;
|
|
11721
11816
|
type GetChatSettingsParams = ParamsSchema<'get-chat-settings'>;
|
|
11722
11817
|
type UpdateChatSettingsParams = ParamsSchema<'update-chat-settings'>;
|
|
11818
|
+
type GetSharedChatSessionParams = ParamsSchema<'get-shared-chat-session'>;
|
|
11723
11819
|
type GetUserEmotesParams = ParamsSchema<'get-user-emotes'>;
|
|
11724
11820
|
type SendChatAnnouncementParams = ParamsSchema<'send-chat-announcement'>;
|
|
11725
11821
|
type SendShoutoutParams = ParamsSchema<'send-a-shoutout'>;
|
|
@@ -11861,6 +11957,7 @@ type GetChannelChatBadgesResponse = Schema<'GetChannelChatBadgesResponse'>;
|
|
|
11861
11957
|
type GetGlobalChatBadgesResponse = Schema<'GetGlobalChatBadgesResponse'>;
|
|
11862
11958
|
type ChatSettings = Schema<'ChatSettings'>;
|
|
11863
11959
|
type GetChatSettingsResponse = Schema<'GetChatSettingsResponse'>;
|
|
11960
|
+
type GetSharedChatSessionResponse = Schema<'GetSharedChatSessionResponse'>;
|
|
11864
11961
|
type GetUserEmotesResponse = Schema<'GetUserEmotesResponse'>;
|
|
11865
11962
|
type UpdateChatSettingsBody = Schema<'UpdateChatSettingsBody'>;
|
|
11866
11963
|
type ChatSettingsUpdated = Schema<'ChatSettingsUpdated'>;
|
|
@@ -12099,7 +12196,7 @@ declare class TwitchApi {
|
|
|
12099
12196
|
*
|
|
12100
12197
|
* @see https://dev.twitch.tv/docs/api/reference#start-commercial
|
|
12101
12198
|
*/
|
|
12102
|
-
startCommercial: (body: StartCommercialBody, options?: CallApiOptions[
|
|
12199
|
+
startCommercial: (body: StartCommercialBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
12103
12200
|
data: {
|
|
12104
12201
|
length: number;
|
|
12105
12202
|
message: string;
|
|
@@ -12131,7 +12228,7 @@ declare class TwitchApi {
|
|
|
12131
12228
|
*
|
|
12132
12229
|
* @see https://dev.twitch.tv/docs/api/reference#get-ad-schedule
|
|
12133
12230
|
*/
|
|
12134
|
-
getAdSchedule: (params: GetAdScheduleParams, options?: CallApiOptions[
|
|
12231
|
+
getAdSchedule: (params: GetAdScheduleParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
12135
12232
|
data: {
|
|
12136
12233
|
snooze_count: number;
|
|
12137
12234
|
snooze_refresh_at: string;
|
|
@@ -12172,7 +12269,7 @@ declare class TwitchApi {
|
|
|
12172
12269
|
*
|
|
12173
12270
|
* @see https://dev.twitch.tv/docs/api/reference#snooze-next-ad
|
|
12174
12271
|
*/
|
|
12175
|
-
snoozeNextAd: (params: SnoozeNextAdParams, options?: CallApiOptions[
|
|
12272
|
+
snoozeNextAd: (params: SnoozeNextAdParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
12176
12273
|
data: {
|
|
12177
12274
|
snooze_count: number;
|
|
12178
12275
|
snooze_refresh_at: string;
|
|
@@ -12220,16 +12317,8 @@ declare class TwitchApi {
|
|
|
12220
12317
|
*
|
|
12221
12318
|
* @see https://dev.twitch.tv/docs/api/reference#get-extension-analytics
|
|
12222
12319
|
*/
|
|
12223
|
-
getExtensionAnalytics: (params?: GetExtensionAnalyticsParams | null | undefined, options?: CallApiOptions[
|
|
12224
|
-
data:
|
|
12225
|
-
extension_id: string;
|
|
12226
|
-
URL: string;
|
|
12227
|
-
type: string;
|
|
12228
|
-
date_range: {
|
|
12229
|
-
started_at: string;
|
|
12230
|
-
ended_at: string;
|
|
12231
|
-
};
|
|
12232
|
-
}[];
|
|
12320
|
+
getExtensionAnalytics: (params?: GetExtensionAnalyticsParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
12321
|
+
data: components["schemas"]["ExtensionAnalytics"][];
|
|
12233
12322
|
pagination?: {
|
|
12234
12323
|
cursor?: string;
|
|
12235
12324
|
};
|
|
@@ -12273,16 +12362,8 @@ declare class TwitchApi {
|
|
|
12273
12362
|
*
|
|
12274
12363
|
* @see https://dev.twitch.tv/docs/api/reference#get-game-analytics
|
|
12275
12364
|
*/
|
|
12276
|
-
getGameAnalytics: (params?: GetGameAnalyticsParams | null | undefined, options?: CallApiOptions[
|
|
12277
|
-
data:
|
|
12278
|
-
game_id: string;
|
|
12279
|
-
URL: string;
|
|
12280
|
-
type: string;
|
|
12281
|
-
date_range: {
|
|
12282
|
-
started_at: string;
|
|
12283
|
-
ended_at: string;
|
|
12284
|
-
};
|
|
12285
|
-
}[];
|
|
12365
|
+
getGameAnalytics: (params?: GetGameAnalyticsParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
12366
|
+
data: components["schemas"]["GameAnalytics"][];
|
|
12286
12367
|
pagination?: {
|
|
12287
12368
|
cursor?: string;
|
|
12288
12369
|
};
|
|
@@ -12323,14 +12404,8 @@ declare class TwitchApi {
|
|
|
12323
12404
|
*
|
|
12324
12405
|
* @see https://dev.twitch.tv/docs/api/reference#get-bits-leaderboard
|
|
12325
12406
|
*/
|
|
12326
|
-
getBitsLeaderboard: (params?: GetBitsLeaderboardParams | null | undefined, options?: CallApiOptions[
|
|
12327
|
-
data:
|
|
12328
|
-
user_id: string;
|
|
12329
|
-
user_login: string;
|
|
12330
|
-
user_name: string;
|
|
12331
|
-
rank: number;
|
|
12332
|
-
score: number;
|
|
12333
|
-
}[];
|
|
12407
|
+
getBitsLeaderboard: (params?: GetBitsLeaderboardParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
12408
|
+
data: components["schemas"]["BitsLeaderboard"][];
|
|
12334
12409
|
date_range: {
|
|
12335
12410
|
started_at: string;
|
|
12336
12411
|
ended_at: string;
|
|
@@ -12361,55 +12436,8 @@ declare class TwitchApi {
|
|
|
12361
12436
|
*
|
|
12362
12437
|
* @see https://dev.twitch.tv/docs/api/reference#get-cheermotes
|
|
12363
12438
|
*/
|
|
12364
|
-
getCheermotes: (params?: GetCheermotesParams | null | undefined, options?: CallApiOptions[
|
|
12365
|
-
data:
|
|
12366
|
-
prefix: string;
|
|
12367
|
-
tiers: {
|
|
12368
|
-
min_bits: number;
|
|
12369
|
-
id: "1" | "100" | "500" | "1000" | "5000" | "10000" | "100000";
|
|
12370
|
-
color: string;
|
|
12371
|
-
images: {
|
|
12372
|
-
light?: {
|
|
12373
|
-
animated?: {
|
|
12374
|
-
1?: string;
|
|
12375
|
-
2?: string;
|
|
12376
|
-
3?: string;
|
|
12377
|
-
4?: string;
|
|
12378
|
-
"1.5"?: string;
|
|
12379
|
-
};
|
|
12380
|
-
static?: {
|
|
12381
|
-
1?: string;
|
|
12382
|
-
2?: string;
|
|
12383
|
-
3?: string;
|
|
12384
|
-
4?: string;
|
|
12385
|
-
"1.5"?: string;
|
|
12386
|
-
};
|
|
12387
|
-
};
|
|
12388
|
-
dark?: {
|
|
12389
|
-
animated?: {
|
|
12390
|
-
1?: string;
|
|
12391
|
-
2?: string;
|
|
12392
|
-
3?: string;
|
|
12393
|
-
4?: string;
|
|
12394
|
-
"1.5"?: string;
|
|
12395
|
-
};
|
|
12396
|
-
static?: {
|
|
12397
|
-
1?: string;
|
|
12398
|
-
2?: string;
|
|
12399
|
-
3?: string;
|
|
12400
|
-
4?: string;
|
|
12401
|
-
"1.5"?: string;
|
|
12402
|
-
};
|
|
12403
|
-
};
|
|
12404
|
-
};
|
|
12405
|
-
can_cheer: boolean;
|
|
12406
|
-
show_in_bits_card: boolean;
|
|
12407
|
-
}[];
|
|
12408
|
-
type: "global_first_party" | "global_third_party" | "channel_custom" | "display_only" | "sponsored";
|
|
12409
|
-
order: number;
|
|
12410
|
-
last_updated: string;
|
|
12411
|
-
is_charitable: boolean;
|
|
12412
|
-
}[];
|
|
12439
|
+
getCheermotes: (params?: GetCheermotesParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
12440
|
+
data: components["schemas"]["Cheermote"][];
|
|
12413
12441
|
}, 200, 401>;
|
|
12414
12442
|
/**
|
|
12415
12443
|
* Gets an extension’s list of transactions. A transaction records the exchange of a currency (for example, Bits) for a digital product.
|
|
@@ -12447,60 +12475,8 @@ declare class TwitchApi {
|
|
|
12447
12475
|
*
|
|
12448
12476
|
* @see https://dev.twitch.tv/docs/api/reference#get-extension-transactions
|
|
12449
12477
|
*/
|
|
12450
|
-
getExtensionTransactions: (params: GetExtensionTransactionsParams, options?: CallApiOptions[
|
|
12451
|
-
data:
|
|
12452
|
-
id: string;
|
|
12453
|
-
timestamp: string;
|
|
12454
|
-
broadcaster_id: string;
|
|
12455
|
-
broadcaster_login: string;
|
|
12456
|
-
broadcaster_name: string;
|
|
12457
|
-
user_id: string;
|
|
12458
|
-
user_login: string;
|
|
12459
|
-
user_name: string;
|
|
12460
|
-
product_type: "BITS_IN_EXTENSION";
|
|
12461
|
-
product_data: {
|
|
12462
|
-
sku: string;
|
|
12463
|
-
domain: string;
|
|
12464
|
-
cost: {
|
|
12465
|
-
amount: number;
|
|
12466
|
-
type: "bits";
|
|
12467
|
-
};
|
|
12468
|
-
inDevelopment: boolean;
|
|
12469
|
-
displayName: string; /**
|
|
12470
|
-
* Updates a configuration segment. The segment is limited to 5 KB. Extensions that are active on a channel do not receive the updated configuration.
|
|
12471
|
-
*
|
|
12472
|
-
* **Rate Limits**: You may update the configuration a maximum of 20 times per minute.
|
|
12473
|
-
*
|
|
12474
|
-
* __Authorization:__
|
|
12475
|
-
*
|
|
12476
|
-
* Requires a signed JSON Web Token (JWT) created by an Extension Backend Service (EBS). For signing requirements, see [Signing the JWT](https://dev.twitch.tv/docs/extensions/building/#signing-the-jwt). The signed JWT must include the `role`, `user_id`, and `exp` fields (see [JWT Schema](https://dev.twitch.tv/docs/extensions/reference/#jwt-schema)). The `role` field must be set to _external_.
|
|
12477
|
-
*
|
|
12478
|
-
* __URL:__
|
|
12479
|
-
*
|
|
12480
|
-
* `PUT https://api.twitch.tv/helix/extensions/configurations`
|
|
12481
|
-
*
|
|
12482
|
-
* __Response Codes:__
|
|
12483
|
-
*
|
|
12484
|
-
* _204 No Content_
|
|
12485
|
-
*
|
|
12486
|
-
* Successfully updated the configuration.
|
|
12487
|
-
*
|
|
12488
|
-
* _400 Bad Request_
|
|
12489
|
-
*
|
|
12490
|
-
* * The `broadcaster_id` field is required if `segment` is set to developer or broadcaster.
|
|
12491
|
-
*
|
|
12492
|
-
* _401 Unauthorized_
|
|
12493
|
-
*
|
|
12494
|
-
* * The Authorization header is required and must specify a JWT token.
|
|
12495
|
-
* * The JWT token is not valid.
|
|
12496
|
-
* * The Client-Id header is required.
|
|
12497
|
-
*
|
|
12498
|
-
* @see https://dev.twitch.tv/docs/api/reference#set-extension-configuration-segment
|
|
12499
|
-
*/
|
|
12500
|
-
expiration: string;
|
|
12501
|
-
broadcast: boolean;
|
|
12502
|
-
};
|
|
12503
|
-
}[];
|
|
12478
|
+
getExtensionTransactions: (params: GetExtensionTransactionsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
12479
|
+
data: components["schemas"]["ExtensionTransaction"][];
|
|
12504
12480
|
pagination?: {
|
|
12505
12481
|
cursor?: string;
|
|
12506
12482
|
};
|
|
@@ -12544,20 +12520,8 @@ declare class TwitchApi {
|
|
|
12544
12520
|
*
|
|
12545
12521
|
* @see https://dev.twitch.tv/docs/api/reference#get-channel-information
|
|
12546
12522
|
*/
|
|
12547
|
-
getChannelInformation: (params: GetChannelInformationParams, options?: CallApiOptions[
|
|
12548
|
-
data:
|
|
12549
|
-
broadcaster_id: string;
|
|
12550
|
-
broadcaster_login: string;
|
|
12551
|
-
broadcaster_name: string;
|
|
12552
|
-
broadcaster_language: string;
|
|
12553
|
-
game_name: string;
|
|
12554
|
-
game_id: string;
|
|
12555
|
-
title: string;
|
|
12556
|
-
delay: number;
|
|
12557
|
-
tags: string[];
|
|
12558
|
-
content_classification_labels: string[];
|
|
12559
|
-
is_branded_content: boolean;
|
|
12560
|
-
}[];
|
|
12523
|
+
getChannelInformation: (params: GetChannelInformationParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
12524
|
+
data: components["schemas"]["ChannelInformation"][];
|
|
12561
12525
|
}, 200, 400 | 401 | 429 | 500>;
|
|
12562
12526
|
/**
|
|
12563
12527
|
* Updates a channel’s properties.
|
|
@@ -12616,7 +12580,7 @@ declare class TwitchApi {
|
|
|
12616
12580
|
*
|
|
12617
12581
|
* @see https://dev.twitch.tv/docs/api/reference#modify-channel-information
|
|
12618
12582
|
*/
|
|
12619
|
-
modifyChannelInformation: (params: ModifyChannelInformationParams, body?: ModifyChannelInformationBody | null | undefined, options?: CallApiOptions[
|
|
12583
|
+
modifyChannelInformation: (params: ModifyChannelInformationParams, body?: ModifyChannelInformationBody | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 403 | 409 | 500>;
|
|
12620
12584
|
/**
|
|
12621
12585
|
* Gets the broadcaster’s list editors.
|
|
12622
12586
|
*
|
|
@@ -12648,12 +12612,8 @@ declare class TwitchApi {
|
|
|
12648
12612
|
*
|
|
12649
12613
|
* @see https://dev.twitch.tv/docs/api/reference#get-channel-editors
|
|
12650
12614
|
*/
|
|
12651
|
-
getChannelEditors: (params: GetChannelEditorsParams, options?: CallApiOptions[
|
|
12652
|
-
data:
|
|
12653
|
-
user_id: string;
|
|
12654
|
-
user_name: string;
|
|
12655
|
-
created_at: string;
|
|
12656
|
-
}[];
|
|
12615
|
+
getChannelEditors: (params: GetChannelEditorsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
12616
|
+
data: components["schemas"]["ChannelEditor"][];
|
|
12657
12617
|
}, 200, 400 | 401>;
|
|
12658
12618
|
/**
|
|
12659
12619
|
* Gets a list of broadcasters that the specified user follows. You can also use this endpoint to see whether a user follows a specific broadcaster.
|
|
@@ -12692,7 +12652,7 @@ declare class TwitchApi {
|
|
|
12692
12652
|
*
|
|
12693
12653
|
* @see https://dev.twitch.tv/docs/api/reference#get-followed-channels
|
|
12694
12654
|
*/
|
|
12695
|
-
getFollowedChannels: (params: GetFollowedChannelsParams, options?: CallApiOptions[
|
|
12655
|
+
getFollowedChannels: (params: GetFollowedChannelsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
12696
12656
|
data: {
|
|
12697
12657
|
broadcaster_id: string;
|
|
12698
12658
|
broadcaster_login: string;
|
|
@@ -12744,7 +12704,7 @@ declare class TwitchApi {
|
|
|
12744
12704
|
*
|
|
12745
12705
|
* @see https://dev.twitch.tv/docs/api/reference#get-channel-followers
|
|
12746
12706
|
*/
|
|
12747
|
-
getChannelFollowers: (params: GetChannelFollowersParams, options?: CallApiOptions[
|
|
12707
|
+
getChannelFollowers: (params: GetChannelFollowersParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
12748
12708
|
data: {
|
|
12749
12709
|
followed_at: string;
|
|
12750
12710
|
user_id: string;
|
|
@@ -12804,46 +12764,8 @@ declare class TwitchApi {
|
|
|
12804
12764
|
*
|
|
12805
12765
|
* @see https://dev.twitch.tv/docs/api/reference#create-custom-rewards
|
|
12806
12766
|
*/
|
|
12807
|
-
createCustomRewards: (params: CreateCustomRewardsParams, body: CreateCustomRewardsBody, options?: CallApiOptions[
|
|
12808
|
-
data:
|
|
12809
|
-
broadcaster_id: string;
|
|
12810
|
-
broadcaster_login: string;
|
|
12811
|
-
broadcaster_name: string;
|
|
12812
|
-
id: string;
|
|
12813
|
-
title: string;
|
|
12814
|
-
prompt: string;
|
|
12815
|
-
cost: number;
|
|
12816
|
-
image: {
|
|
12817
|
-
url_1x: string;
|
|
12818
|
-
url_2x: string;
|
|
12819
|
-
url_4x: string;
|
|
12820
|
-
};
|
|
12821
|
-
default_image: {
|
|
12822
|
-
url_1x: string;
|
|
12823
|
-
url_2x: string;
|
|
12824
|
-
url_4x: string;
|
|
12825
|
-
};
|
|
12826
|
-
background_color: string;
|
|
12827
|
-
is_enabled: boolean;
|
|
12828
|
-
is_user_input_required: boolean;
|
|
12829
|
-
max_per_stream_setting: {
|
|
12830
|
-
is_enabled: boolean;
|
|
12831
|
-
max_per_stream: number;
|
|
12832
|
-
};
|
|
12833
|
-
max_per_user_per_stream_setting: {
|
|
12834
|
-
is_enabled: boolean;
|
|
12835
|
-
max_per_user_per_stream: number;
|
|
12836
|
-
};
|
|
12837
|
-
global_cooldown_setting: {
|
|
12838
|
-
is_enabled: boolean;
|
|
12839
|
-
global_cooldown_seconds: number;
|
|
12840
|
-
};
|
|
12841
|
-
is_paused: boolean;
|
|
12842
|
-
is_in_stock: boolean;
|
|
12843
|
-
should_redemptions_skip_request_queue: boolean;
|
|
12844
|
-
redemptions_redeemed_current_stream: number | null;
|
|
12845
|
-
cooldown_expires_at: string | null;
|
|
12846
|
-
}[];
|
|
12767
|
+
createCustomRewards: (params: CreateCustomRewardsParams, body: CreateCustomRewardsBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
12768
|
+
data: components["schemas"]["CustomReward"][];
|
|
12847
12769
|
}, 200, 400 | 401 | 403 | 500>;
|
|
12848
12770
|
/**
|
|
12849
12771
|
* Deletes a custom reward that the broadcaster created.
|
|
@@ -12889,7 +12811,7 @@ declare class TwitchApi {
|
|
|
12889
12811
|
*
|
|
12890
12812
|
* @see https://dev.twitch.tv/docs/api/reference#delete-custom-reward
|
|
12891
12813
|
*/
|
|
12892
|
-
deleteCustomReward: (params: DeleteCustomRewardParams, options?: CallApiOptions[
|
|
12814
|
+
deleteCustomReward: (params: DeleteCustomRewardParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 403 | 404 | 500>;
|
|
12893
12815
|
/**
|
|
12894
12816
|
* Gets a list of custom rewards that the specified broadcaster created.
|
|
12895
12817
|
*
|
|
@@ -12933,46 +12855,8 @@ declare class TwitchApi {
|
|
|
12933
12855
|
*
|
|
12934
12856
|
* @see https://dev.twitch.tv/docs/api/reference#get-custom-reward
|
|
12935
12857
|
*/
|
|
12936
|
-
getCustomReward: (params: GetCustomRewardParams, options?: CallApiOptions[
|
|
12937
|
-
data:
|
|
12938
|
-
broadcaster_id: string;
|
|
12939
|
-
broadcaster_login: string;
|
|
12940
|
-
broadcaster_name: string;
|
|
12941
|
-
id: string;
|
|
12942
|
-
title: string;
|
|
12943
|
-
prompt: string;
|
|
12944
|
-
cost: number;
|
|
12945
|
-
image: {
|
|
12946
|
-
url_1x: string;
|
|
12947
|
-
url_2x: string;
|
|
12948
|
-
url_4x: string;
|
|
12949
|
-
};
|
|
12950
|
-
default_image: {
|
|
12951
|
-
url_1x: string;
|
|
12952
|
-
url_2x: string;
|
|
12953
|
-
url_4x: string;
|
|
12954
|
-
};
|
|
12955
|
-
background_color: string;
|
|
12956
|
-
is_enabled: boolean;
|
|
12957
|
-
is_user_input_required: boolean;
|
|
12958
|
-
max_per_stream_setting: {
|
|
12959
|
-
is_enabled: boolean;
|
|
12960
|
-
max_per_stream: number;
|
|
12961
|
-
};
|
|
12962
|
-
max_per_user_per_stream_setting: {
|
|
12963
|
-
is_enabled: boolean;
|
|
12964
|
-
max_per_user_per_stream: number;
|
|
12965
|
-
};
|
|
12966
|
-
global_cooldown_setting: {
|
|
12967
|
-
is_enabled: boolean;
|
|
12968
|
-
global_cooldown_seconds: number;
|
|
12969
|
-
};
|
|
12970
|
-
is_paused: boolean;
|
|
12971
|
-
is_in_stock: boolean;
|
|
12972
|
-
should_redemptions_skip_request_queue: boolean;
|
|
12973
|
-
redemptions_redeemed_current_stream: number | null;
|
|
12974
|
-
cooldown_expires_at: string | null;
|
|
12975
|
-
}[];
|
|
12858
|
+
getCustomReward: (params: GetCustomRewardParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
12859
|
+
data: components["schemas"]["CustomReward"][];
|
|
12976
12860
|
}, 200, 400 | 401 | 403 | 404 | 500>;
|
|
12977
12861
|
/**
|
|
12978
12862
|
* Updates a custom reward. The app used to create the reward is the only app that may update the reward.
|
|
@@ -13028,46 +12912,8 @@ declare class TwitchApi {
|
|
|
13028
12912
|
*
|
|
13029
12913
|
* @see https://dev.twitch.tv/docs/api/reference#update-custom-reward
|
|
13030
12914
|
*/
|
|
13031
|
-
updateCustomReward: (params: UpdateCustomRewardParams, body?: UpdateCustomRewardBody | null | undefined, options?: CallApiOptions[
|
|
13032
|
-
data:
|
|
13033
|
-
broadcaster_id: string;
|
|
13034
|
-
broadcaster_login: string;
|
|
13035
|
-
broadcaster_name: string;
|
|
13036
|
-
id: string;
|
|
13037
|
-
title: string;
|
|
13038
|
-
prompt: string;
|
|
13039
|
-
cost: number;
|
|
13040
|
-
image: {
|
|
13041
|
-
url_1x: string;
|
|
13042
|
-
url_2x: string;
|
|
13043
|
-
url_4x: string;
|
|
13044
|
-
};
|
|
13045
|
-
default_image: {
|
|
13046
|
-
url_1x: string;
|
|
13047
|
-
url_2x: string;
|
|
13048
|
-
url_4x: string;
|
|
13049
|
-
};
|
|
13050
|
-
background_color: string;
|
|
13051
|
-
is_enabled: boolean;
|
|
13052
|
-
is_user_input_required: boolean;
|
|
13053
|
-
max_per_stream_setting: {
|
|
13054
|
-
is_enabled: boolean;
|
|
13055
|
-
max_per_stream: number;
|
|
13056
|
-
};
|
|
13057
|
-
max_per_user_per_stream_setting: {
|
|
13058
|
-
is_enabled: boolean;
|
|
13059
|
-
max_per_user_per_stream: number;
|
|
13060
|
-
};
|
|
13061
|
-
global_cooldown_setting: {
|
|
13062
|
-
is_enabled: boolean;
|
|
13063
|
-
global_cooldown_seconds: number;
|
|
13064
|
-
};
|
|
13065
|
-
is_paused: boolean;
|
|
13066
|
-
is_in_stock: boolean;
|
|
13067
|
-
should_redemptions_skip_request_queue: boolean;
|
|
13068
|
-
redemptions_redeemed_current_stream: number | null;
|
|
13069
|
-
cooldown_expires_at: string | null;
|
|
13070
|
-
}[];
|
|
12915
|
+
updateCustomReward: (params: UpdateCustomRewardParams, body?: UpdateCustomRewardBody | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
12916
|
+
data: components["schemas"]["CustomReward"][];
|
|
13071
12917
|
}, 200, 400 | 401 | 403 | 404 | 500>;
|
|
13072
12918
|
/**
|
|
13073
12919
|
* Gets a list of redemptions for the specified custom reward. The app used to create the reward is the only app that may get the redemptions.
|
|
@@ -13114,25 +12960,11 @@ declare class TwitchApi {
|
|
|
13114
12960
|
*
|
|
13115
12961
|
* @see https://dev.twitch.tv/docs/api/reference#get-custom-reward-redemption
|
|
13116
12962
|
*/
|
|
13117
|
-
getCustomRewardRedemption: (params: GetCustomRewardRedemptionParams, options?: CallApiOptions[
|
|
13118
|
-
data:
|
|
13119
|
-
|
|
13120
|
-
|
|
13121
|
-
|
|
13122
|
-
id: string;
|
|
13123
|
-
user_id: string;
|
|
13124
|
-
user_name: string;
|
|
13125
|
-
user_login: string;
|
|
13126
|
-
reward: {
|
|
13127
|
-
id: string;
|
|
13128
|
-
title: string;
|
|
13129
|
-
prompt: string;
|
|
13130
|
-
cost: number;
|
|
13131
|
-
};
|
|
13132
|
-
user_input: string;
|
|
13133
|
-
status: "CANCELED" | "FULFILLED" | "UNFULFILLED";
|
|
13134
|
-
redeemed_at: string;
|
|
13135
|
-
}[];
|
|
12963
|
+
getCustomRewardRedemption: (params: GetCustomRewardRedemptionParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
12964
|
+
data: components["schemas"]["CustomRewardRedemption"][];
|
|
12965
|
+
pagination?: {
|
|
12966
|
+
cursor?: string;
|
|
12967
|
+
};
|
|
13136
12968
|
}, 200, 400 | 401 | 403 | 404 | 500>;
|
|
13137
12969
|
/**
|
|
13138
12970
|
* Updates a redemption’s status. You may update a redemption only if its status is UNFULFILLED. The app used to create the reward is the only app that may update the redemption.
|
|
@@ -13179,25 +13011,8 @@ declare class TwitchApi {
|
|
|
13179
13011
|
*
|
|
13180
13012
|
* @see https://dev.twitch.tv/docs/api/reference#update-redemption-status
|
|
13181
13013
|
*/
|
|
13182
|
-
updateRedemptionStatus: (params: UpdateRedemptionStatusParams, body: UpdateRedemptionStatusBody, options?: CallApiOptions[
|
|
13183
|
-
data:
|
|
13184
|
-
broadcaster_id: string;
|
|
13185
|
-
broadcaster_login: string;
|
|
13186
|
-
broadcaster_name: string;
|
|
13187
|
-
id: string;
|
|
13188
|
-
user_id: string;
|
|
13189
|
-
user_name: string;
|
|
13190
|
-
user_login: string;
|
|
13191
|
-
reward: {
|
|
13192
|
-
id: string;
|
|
13193
|
-
title: string;
|
|
13194
|
-
prompt: string;
|
|
13195
|
-
cost: number;
|
|
13196
|
-
};
|
|
13197
|
-
user_input: string;
|
|
13198
|
-
status: "CANCELED" | "FULFILLED" | "UNFULFILLED";
|
|
13199
|
-
redeemed_at: string;
|
|
13200
|
-
}[];
|
|
13014
|
+
updateRedemptionStatus: (params: UpdateRedemptionStatusParams, body: UpdateRedemptionStatusBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
13015
|
+
data: components["schemas"]["CustomRewardRedemption"][];
|
|
13201
13016
|
}, 200, 400 | 401 | 403 | 404 | 500>;
|
|
13202
13017
|
};
|
|
13203
13018
|
charity: {
|
|
@@ -13239,27 +13054,8 @@ declare class TwitchApi {
|
|
|
13239
13054
|
*
|
|
13240
13055
|
* @see https://dev.twitch.tv/docs/api/reference#get-charity-campaign
|
|
13241
13056
|
*/
|
|
13242
|
-
getCharityCampaign: (params: GetCharityCampaignParams, options?: CallApiOptions[
|
|
13243
|
-
data:
|
|
13244
|
-
id: string;
|
|
13245
|
-
broadcaster_id: string;
|
|
13246
|
-
broadcaster_login: string;
|
|
13247
|
-
broadcaster_name: string;
|
|
13248
|
-
charity_name: string;
|
|
13249
|
-
charity_description: string;
|
|
13250
|
-
charity_logo: string;
|
|
13251
|
-
charity_website: string;
|
|
13252
|
-
current_amount: {
|
|
13253
|
-
value: number;
|
|
13254
|
-
decimal_places: number;
|
|
13255
|
-
currency: string;
|
|
13256
|
-
};
|
|
13257
|
-
target_amount: {
|
|
13258
|
-
value: number;
|
|
13259
|
-
decimal_places: number;
|
|
13260
|
-
currency: string;
|
|
13261
|
-
};
|
|
13262
|
-
}[];
|
|
13057
|
+
getCharityCampaign: (params: GetCharityCampaignParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
13058
|
+
data: components["schemas"]["CharityCampaign"][];
|
|
13263
13059
|
}, 200, 400 | 401 | 403>;
|
|
13264
13060
|
/**
|
|
13265
13061
|
* Gets the list of donations that users have made to the broadcaster’s active charity campaign.
|
|
@@ -13299,19 +13095,8 @@ declare class TwitchApi {
|
|
|
13299
13095
|
*
|
|
13300
13096
|
* @see https://dev.twitch.tv/docs/api/reference#get-charity-campaign-donations
|
|
13301
13097
|
*/
|
|
13302
|
-
getCharityCampaignDonations: (params: GetCharityCampaignDonationsParams, options?: CallApiOptions[
|
|
13303
|
-
data:
|
|
13304
|
-
id: string;
|
|
13305
|
-
campaign_id: string;
|
|
13306
|
-
user_id: string;
|
|
13307
|
-
user_login: string;
|
|
13308
|
-
user_name: string;
|
|
13309
|
-
amount: {
|
|
13310
|
-
value: number;
|
|
13311
|
-
decimal_places: number;
|
|
13312
|
-
currency: string;
|
|
13313
|
-
};
|
|
13314
|
-
}[];
|
|
13098
|
+
getCharityCampaignDonations: (params: GetCharityCampaignDonationsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
13099
|
+
data: components["schemas"]["CharityCampaignDonation"][];
|
|
13315
13100
|
pagination?: {
|
|
13316
13101
|
cursor?: string;
|
|
13317
13102
|
};
|
|
@@ -13360,12 +13145,8 @@ declare class TwitchApi {
|
|
|
13360
13145
|
*
|
|
13361
13146
|
* @see https://dev.twitch.tv/docs/api/reference#get-chatters
|
|
13362
13147
|
*/
|
|
13363
|
-
getChatters: (params: GetChattersParams, options?: CallApiOptions[
|
|
13364
|
-
data:
|
|
13365
|
-
user_id: string;
|
|
13366
|
-
user_login: string;
|
|
13367
|
-
user_name: string;
|
|
13368
|
-
}[];
|
|
13148
|
+
getChatters: (params: GetChattersParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
13149
|
+
data: components["schemas"]["Chatter"][];
|
|
13369
13150
|
pagination?: {
|
|
13370
13151
|
cursor?: string;
|
|
13371
13152
|
};
|
|
@@ -13404,22 +13185,8 @@ declare class TwitchApi {
|
|
|
13404
13185
|
*
|
|
13405
13186
|
* @see https://dev.twitch.tv/docs/api/reference#get-channel-emotes
|
|
13406
13187
|
*/
|
|
13407
|
-
getChannelEmotes: (params: GetChannelEmotesParams, options?: CallApiOptions[
|
|
13408
|
-
data:
|
|
13409
|
-
id: string;
|
|
13410
|
-
name: string;
|
|
13411
|
-
images: {
|
|
13412
|
-
url_1x: string;
|
|
13413
|
-
url_2x: string;
|
|
13414
|
-
url_4x: string;
|
|
13415
|
-
};
|
|
13416
|
-
tier: string;
|
|
13417
|
-
emote_type: "bitstier" | "follower" | "subscriptions";
|
|
13418
|
-
emote_set_id: string;
|
|
13419
|
-
format: ("animated" | "static")[];
|
|
13420
|
-
scale: ("1.0" | "2.0" | "3.0")[];
|
|
13421
|
-
theme_mode: ("dark" | "light")[];
|
|
13422
|
-
}[];
|
|
13188
|
+
getChannelEmotes: (params: GetChannelEmotesParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
13189
|
+
data: components["schemas"]["ChannelEmote"][];
|
|
13423
13190
|
template: string;
|
|
13424
13191
|
}, 200, 400 | 401>;
|
|
13425
13192
|
/**
|
|
@@ -13453,19 +13220,8 @@ declare class TwitchApi {
|
|
|
13453
13220
|
*
|
|
13454
13221
|
* @see https://dev.twitch.tv/docs/api/reference#get-global-emotes
|
|
13455
13222
|
*/
|
|
13456
|
-
getGlobalEmotes: (options?: CallApiOptions[
|
|
13457
|
-
data:
|
|
13458
|
-
id: string;
|
|
13459
|
-
name: string;
|
|
13460
|
-
images: {
|
|
13461
|
-
url_1x: string;
|
|
13462
|
-
url_2x: string;
|
|
13463
|
-
url_4x: string;
|
|
13464
|
-
};
|
|
13465
|
-
format: ("animated" | "static")[];
|
|
13466
|
-
scale: ("1.0" | "2.0" | "3.0")[];
|
|
13467
|
-
theme_mode: ("dark" | "light")[];
|
|
13468
|
-
}[];
|
|
13223
|
+
getGlobalEmotes: (options?: CallApiOptions["options"]) => ApiResponse<{
|
|
13224
|
+
data: components["schemas"]["GlobalEmote"][];
|
|
13469
13225
|
template: string;
|
|
13470
13226
|
}, 200, 401>;
|
|
13471
13227
|
/**
|
|
@@ -13502,22 +13258,8 @@ declare class TwitchApi {
|
|
|
13502
13258
|
*
|
|
13503
13259
|
* @see https://dev.twitch.tv/docs/api/reference#get-emote-sets
|
|
13504
13260
|
*/
|
|
13505
|
-
getEmoteSets: (params: GetEmoteSetsParams, options?: CallApiOptions[
|
|
13506
|
-
data:
|
|
13507
|
-
id: string;
|
|
13508
|
-
name: string;
|
|
13509
|
-
images: {
|
|
13510
|
-
url_1x: string;
|
|
13511
|
-
url_2x: string;
|
|
13512
|
-
url_4x: string;
|
|
13513
|
-
};
|
|
13514
|
-
emote_type: "bitstier" | "follower" | "subscriptions";
|
|
13515
|
-
emote_set_id: string;
|
|
13516
|
-
owner_id: string;
|
|
13517
|
-
format: ("animated" | "static")[];
|
|
13518
|
-
scale: ("1.0" | "2.0" | "3.0")[];
|
|
13519
|
-
theme_mode: ("dark" | "light")[];
|
|
13520
|
-
}[];
|
|
13261
|
+
getEmoteSets: (params: GetEmoteSetsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
13262
|
+
data: components["schemas"]["Emote"][];
|
|
13521
13263
|
template: string;
|
|
13522
13264
|
}, 200, 400 | 401>;
|
|
13523
13265
|
/**
|
|
@@ -13549,20 +13291,8 @@ declare class TwitchApi {
|
|
|
13549
13291
|
*
|
|
13550
13292
|
* @see https://dev.twitch.tv/docs/api/reference#get-channel-chat-badges
|
|
13551
13293
|
*/
|
|
13552
|
-
getChannelChatBadges: (params: GetChannelChatBadgesParams, options?: CallApiOptions[
|
|
13553
|
-
data:
|
|
13554
|
-
set_id: string;
|
|
13555
|
-
versions: {
|
|
13556
|
-
id: string;
|
|
13557
|
-
image_url_1x: string;
|
|
13558
|
-
image_url_2x: string;
|
|
13559
|
-
image_url_4x: string;
|
|
13560
|
-
title: string;
|
|
13561
|
-
description: string;
|
|
13562
|
-
click_action: string;
|
|
13563
|
-
click_url: string;
|
|
13564
|
-
}[];
|
|
13565
|
-
}[];
|
|
13294
|
+
getChannelChatBadges: (params: GetChannelChatBadgesParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
13295
|
+
data: components["schemas"]["ChatBadge"][];
|
|
13566
13296
|
}, 200, 400 | 401>;
|
|
13567
13297
|
/**
|
|
13568
13298
|
* Gets Twitch’s list of chat badges, which users may use in any channel’s chat room. For information about chat badges, see [Twitch Chat Badges Guide](https://help.twitch.tv/s/article/twitch-chat-badges-guide).
|
|
@@ -13593,20 +13323,8 @@ declare class TwitchApi {
|
|
|
13593
13323
|
*
|
|
13594
13324
|
* @see https://dev.twitch.tv/docs/api/reference#get-global-chat-badges
|
|
13595
13325
|
*/
|
|
13596
|
-
getGlobalChatBadges: (options?: CallApiOptions[
|
|
13597
|
-
data:
|
|
13598
|
-
set_id: string;
|
|
13599
|
-
versions: {
|
|
13600
|
-
id: string;
|
|
13601
|
-
image_url_1x: string;
|
|
13602
|
-
image_url_2x: string;
|
|
13603
|
-
image_url_4x: string;
|
|
13604
|
-
title: string;
|
|
13605
|
-
description: string;
|
|
13606
|
-
click_action: string;
|
|
13607
|
-
click_url: string;
|
|
13608
|
-
}[];
|
|
13609
|
-
}[];
|
|
13326
|
+
getGlobalChatBadges: (options?: CallApiOptions["options"]) => ApiResponse<{
|
|
13327
|
+
data: components["schemas"]["ChatBadge"][];
|
|
13610
13328
|
}, 200, 401>;
|
|
13611
13329
|
/**
|
|
13612
13330
|
* Gets the broadcaster’s chat settings.
|
|
@@ -13639,20 +13357,8 @@ declare class TwitchApi {
|
|
|
13639
13357
|
*
|
|
13640
13358
|
* @see https://dev.twitch.tv/docs/api/reference#get-chat-settings
|
|
13641
13359
|
*/
|
|
13642
|
-
getChatSettings: (params: GetChatSettingsParams, options?: CallApiOptions[
|
|
13643
|
-
data:
|
|
13644
|
-
broadcaster_id: string;
|
|
13645
|
-
emote_mode: boolean;
|
|
13646
|
-
follower_mode: boolean;
|
|
13647
|
-
follower_mode_duration: number | null;
|
|
13648
|
-
moderator_id?: string;
|
|
13649
|
-
non_moderator_chat_delay?: boolean;
|
|
13650
|
-
non_moderator_chat_delay_duration?: number | null;
|
|
13651
|
-
slow_mode: boolean;
|
|
13652
|
-
slow_mode_wait_time: number | null;
|
|
13653
|
-
subscriber_mode: boolean;
|
|
13654
|
-
unique_chat_mode: boolean;
|
|
13655
|
-
}[];
|
|
13360
|
+
getChatSettings: (params: GetChatSettingsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
13361
|
+
data: components["schemas"]["ChatSettings"][];
|
|
13656
13362
|
}, 200, 400 | 401>;
|
|
13657
13363
|
/**
|
|
13658
13364
|
* Updates the broadcaster’s chat settings.
|
|
@@ -13703,21 +13409,52 @@ declare class TwitchApi {
|
|
|
13703
13409
|
*
|
|
13704
13410
|
* @see https://dev.twitch.tv/docs/api/reference#update-chat-settings
|
|
13705
13411
|
*/
|
|
13706
|
-
updateChatSettings: (params: UpdateChatSettingsParams, body?: UpdateChatSettingsBody | null | undefined, options?: CallApiOptions[
|
|
13412
|
+
updateChatSettings: (params: UpdateChatSettingsParams, body?: UpdateChatSettingsBody | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
13413
|
+
data: components["schemas"]["ChatSettingsUpdated"][];
|
|
13414
|
+
}, 200, 400 | 401 | 403>;
|
|
13415
|
+
/**
|
|
13416
|
+
* NEW Retrieves the active shared chat session for a channel.
|
|
13417
|
+
*
|
|
13418
|
+
* __Authorization:__
|
|
13419
|
+
*
|
|
13420
|
+
* Requires an [app access token](https://dev.twitch.tv/docs/cli/token-command/#app-access-token) or [user access token](https://dev.twitch.tv/docs/authentication/#user-access-tokens).
|
|
13421
|
+
*
|
|
13422
|
+
* __URL:__
|
|
13423
|
+
*
|
|
13424
|
+
* `GET https://api.twitch.tv/helix/shared_chat/session`
|
|
13425
|
+
*
|
|
13426
|
+
* __Response Codes:__
|
|
13427
|
+
*
|
|
13428
|
+
* _200 OK_
|
|
13429
|
+
*
|
|
13430
|
+
* Successfully retrieved the shared chat session. Returns an empty array if the broadcaster\_id in the request isn’t in a shared chat session.
|
|
13431
|
+
*
|
|
13432
|
+
* _400 Bad Request_
|
|
13433
|
+
*
|
|
13434
|
+
* The ID in the `broadcaster_id` query parameter is not valid.
|
|
13435
|
+
*
|
|
13436
|
+
* _401 Unauthorized_
|
|
13437
|
+
*
|
|
13438
|
+
* * The OAuth token is not valid.
|
|
13439
|
+
* * The Authorization header is required and must contain a user access token.
|
|
13440
|
+
*
|
|
13441
|
+
* _500 Internal Server Error_
|
|
13442
|
+
*
|
|
13443
|
+
* Internal Server Error.
|
|
13444
|
+
*
|
|
13445
|
+
* @see https://dev.twitch.tv/docs/api/reference#get-shared-chat-session
|
|
13446
|
+
*/
|
|
13447
|
+
getSharedChatSession: (params: GetSharedChatSessionParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
13707
13448
|
data: {
|
|
13708
|
-
|
|
13709
|
-
|
|
13710
|
-
|
|
13711
|
-
|
|
13712
|
-
|
|
13713
|
-
|
|
13714
|
-
|
|
13715
|
-
slow_mode: boolean;
|
|
13716
|
-
slow_mode_wait_time: number | null;
|
|
13717
|
-
subscriber_mode: boolean;
|
|
13718
|
-
unique_chat_mode: boolean;
|
|
13449
|
+
session_id: string;
|
|
13450
|
+
host_broadcaster_id: string;
|
|
13451
|
+
participants: {
|
|
13452
|
+
broadcaster_id: string;
|
|
13453
|
+
}[];
|
|
13454
|
+
created_at: string;
|
|
13455
|
+
updated_at: string;
|
|
13719
13456
|
}[];
|
|
13720
|
-
}, 200, 400 | 401 |
|
|
13457
|
+
}, 200, 400 | 401 | 500>;
|
|
13721
13458
|
/**
|
|
13722
13459
|
* NEW Retrieves emotes available to the user across all channels.
|
|
13723
13460
|
*
|
|
@@ -13751,17 +13488,17 @@ declare class TwitchApi {
|
|
|
13751
13488
|
*
|
|
13752
13489
|
* @see https://dev.twitch.tv/docs/api/reference#get-user-emotes
|
|
13753
13490
|
*/
|
|
13754
|
-
getUserEmotes: (params: GetUserEmotesParams, options?: CallApiOptions[
|
|
13755
|
-
data: {
|
|
13491
|
+
getUserEmotes: (params: GetUserEmotesParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
13492
|
+
data: ({
|
|
13756
13493
|
id: string;
|
|
13757
13494
|
name: string;
|
|
13758
|
-
emote_type: "
|
|
13495
|
+
emote_type: "none" | "bitstier" | "follower" | "subscriptions" | "channelpoints" | "rewards" | "hypetrain" | "prime" | "turbo" | "smilies" | "globals" | "owl2019" | "twofactor" | "limitedtime";
|
|
13759
13496
|
emote_set_id: string;
|
|
13760
13497
|
owner_id: string;
|
|
13761
13498
|
format: string[];
|
|
13762
13499
|
scale: string[];
|
|
13763
13500
|
theme_mode: string[];
|
|
13764
|
-
}[];
|
|
13501
|
+
})[];
|
|
13765
13502
|
template: string;
|
|
13766
13503
|
pagination?: {
|
|
13767
13504
|
cursor?: string;
|
|
@@ -13770,6 +13507,8 @@ declare class TwitchApi {
|
|
|
13770
13507
|
/**
|
|
13771
13508
|
* Sends an announcement to the broadcaster’s chat room.
|
|
13772
13509
|
*
|
|
13510
|
+
* **Rate Limits**: One announcement may be sent every 2 seconds.
|
|
13511
|
+
*
|
|
13773
13512
|
* __Authorization:__
|
|
13774
13513
|
*
|
|
13775
13514
|
* Requires a [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens) that includes the **moderator:manage:announcements** scope.
|
|
@@ -13798,15 +13537,19 @@ declare class TwitchApi {
|
|
|
13798
13537
|
* * The OAuth token is not valid.
|
|
13799
13538
|
* * The client ID specified in the Client-Id header does not match the client ID specified in the OAuth token.
|
|
13800
13539
|
*
|
|
13540
|
+
* _429 Too Many Requests_
|
|
13541
|
+
*
|
|
13542
|
+
* The sender has exceeded the number of announcements they may send to this **broadcaster\_id** within a given window.
|
|
13543
|
+
*
|
|
13801
13544
|
* @see https://dev.twitch.tv/docs/api/reference#send-chat-announcement
|
|
13802
13545
|
*/
|
|
13803
|
-
sendChatAnnouncement: (params: SendChatAnnouncementParams, body: SendChatAnnouncementBody, options?: CallApiOptions[
|
|
13546
|
+
sendChatAnnouncement: (params: SendChatAnnouncementParams, body: SendChatAnnouncementBody, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 429>;
|
|
13804
13547
|
/**
|
|
13805
13548
|
* Sends a Shoutout to the specified broadcaster. Typically, you send Shoutouts when you or one of your moderators notice another broadcaster in your chat, the other broadcaster is coming up in conversation, or after they raid your broadcast.
|
|
13806
13549
|
*
|
|
13807
13550
|
* Twitch’s Shoutout feature is a great way for you to show support for other broadcasters and help them grow. Viewers who do not follow the other broadcaster will see a pop-up Follow button in your chat that they can click to follow the other broadcaster. [Learn More](https://help.twitch.tv/s/article/shoutouts)
|
|
13808
13551
|
*
|
|
13809
|
-
* **Rate Limits
|
|
13552
|
+
* **Rate Limits**: The broadcaster may send a Shoutout once every 2 minutes. They may send the same broadcaster a Shoutout once every 60 minutes.
|
|
13810
13553
|
*
|
|
13811
13554
|
* To receive notifications when a Shoutout is sent or received, subscribe to the [channel.shoutout.create](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelshoutoutcreate) and [channel.shoutout.receive](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelshoutoutreceive) subscription types. The **channel.shoutout.create** event includes cooldown periods that indicate when the broadcaster may send another Shoutout without exceeding the endpoint’s rate limit.
|
|
13812
13555
|
*
|
|
@@ -13853,7 +13596,7 @@ declare class TwitchApi {
|
|
|
13853
13596
|
*
|
|
13854
13597
|
* @see https://dev.twitch.tv/docs/api/reference#send-a-shoutout
|
|
13855
13598
|
*/
|
|
13856
|
-
sendShoutout: (params: SendShoutoutParams, options?: CallApiOptions[
|
|
13599
|
+
sendShoutout: (params: SendShoutoutParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 403 | 429>;
|
|
13857
13600
|
/**
|
|
13858
13601
|
* NEW Sends a message to the broadcaster’s chat room.
|
|
13859
13602
|
*
|
|
@@ -13898,7 +13641,7 @@ declare class TwitchApi {
|
|
|
13898
13641
|
*
|
|
13899
13642
|
* @see https://dev.twitch.tv/docs/api/reference#send-chat-message
|
|
13900
13643
|
*/
|
|
13901
|
-
sendChatMessage: (body: SendChatMessageBody, options?: CallApiOptions[
|
|
13644
|
+
sendChatMessage: (body: SendChatMessageBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
13902
13645
|
data: {
|
|
13903
13646
|
message_id: string;
|
|
13904
13647
|
is_sent: boolean;
|
|
@@ -13937,13 +13680,8 @@ declare class TwitchApi {
|
|
|
13937
13680
|
*
|
|
13938
13681
|
* @see https://dev.twitch.tv/docs/api/reference#get-user-chat-color
|
|
13939
13682
|
*/
|
|
13940
|
-
getUserChatColor: (params: GetUserChatColorParams, options?: CallApiOptions[
|
|
13941
|
-
data:
|
|
13942
|
-
user_id: string;
|
|
13943
|
-
user_login: string;
|
|
13944
|
-
user_name: string;
|
|
13945
|
-
color: string;
|
|
13946
|
-
}[];
|
|
13683
|
+
getUserChatColor: (params: GetUserChatColorParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
13684
|
+
data: components["schemas"]["UserChatColor"][];
|
|
13947
13685
|
}, 200, 400 | 401>;
|
|
13948
13686
|
/**
|
|
13949
13687
|
* Updates the color used for the user’s name in chat.
|
|
@@ -13979,7 +13717,7 @@ declare class TwitchApi {
|
|
|
13979
13717
|
*
|
|
13980
13718
|
* @see https://dev.twitch.tv/docs/api/reference#update-user-chat-color
|
|
13981
13719
|
*/
|
|
13982
|
-
updateUserChatColor: (params: UpdateUserChatColorParams, options?: CallApiOptions[
|
|
13720
|
+
updateUserChatColor: (params: UpdateUserChatColorParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401>;
|
|
13983
13721
|
};
|
|
13984
13722
|
clips: {
|
|
13985
13723
|
/**
|
|
@@ -14028,7 +13766,7 @@ declare class TwitchApi {
|
|
|
14028
13766
|
*
|
|
14029
13767
|
* @see https://dev.twitch.tv/docs/api/reference#create-clip
|
|
14030
13768
|
*/
|
|
14031
|
-
createClip: (params: CreateClipParams, options?: CallApiOptions[
|
|
13769
|
+
createClip: (params: CreateClipParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14032
13770
|
data: {
|
|
14033
13771
|
edit_url: string;
|
|
14034
13772
|
id: string;
|
|
@@ -14037,6 +13775,8 @@ declare class TwitchApi {
|
|
|
14037
13775
|
/**
|
|
14038
13776
|
* Gets one or more video clips that were captured from streams. For information about clips, see [How to use clips](https://help.twitch.tv/s/article/how-to-use-clips).
|
|
14039
13777
|
*
|
|
13778
|
+
* When using pagination for clips, note that the maximum number of results returned over multiple requests will be approximately 1,000\. If additional results are necessary, paginate over different query parameters such as multiple `started_at` and `ended_at` timeframes to refine the search.
|
|
13779
|
+
*
|
|
14040
13780
|
* __Authorization:__
|
|
14041
13781
|
*
|
|
14042
13782
|
* Requires an [app access token](https://dev.twitch.tv/docs/authentication#app-access-tokens) or [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens).
|
|
@@ -14072,26 +13812,8 @@ declare class TwitchApi {
|
|
|
14072
13812
|
*
|
|
14073
13813
|
* @see https://dev.twitch.tv/docs/api/reference#get-clips
|
|
14074
13814
|
*/
|
|
14075
|
-
getClips: (params?: GetClipsParams | null | undefined, options?: CallApiOptions[
|
|
14076
|
-
data:
|
|
14077
|
-
id: string;
|
|
14078
|
-
url: string;
|
|
14079
|
-
embed_url: string;
|
|
14080
|
-
broadcaster_id: string;
|
|
14081
|
-
broadcaster_name: string;
|
|
14082
|
-
creator_id: string;
|
|
14083
|
-
creator_name: string;
|
|
14084
|
-
video_id: string;
|
|
14085
|
-
game_id: string;
|
|
14086
|
-
language: string;
|
|
14087
|
-
title: string;
|
|
14088
|
-
view_count: number;
|
|
14089
|
-
created_at: string;
|
|
14090
|
-
thumbnail_url: string;
|
|
14091
|
-
duration: number;
|
|
14092
|
-
vod_offset: number | null;
|
|
14093
|
-
is_featured: boolean;
|
|
14094
|
-
}[];
|
|
13815
|
+
getClips: (params?: GetClipsParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
13816
|
+
data: components["schemas"]["Clip"][];
|
|
14095
13817
|
pagination?: {
|
|
14096
13818
|
cursor?: string;
|
|
14097
13819
|
};
|
|
@@ -14099,7 +13821,7 @@ declare class TwitchApi {
|
|
|
14099
13821
|
};
|
|
14100
13822
|
conduits: {
|
|
14101
13823
|
/**
|
|
14102
|
-
* NEW Gets the [conduits](https://dev.twitch.tv/docs/eventsub/handling-conduit-events) for a client ID.
|
|
13824
|
+
* NEW Gets the [conduits](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/) for a client ID.
|
|
14103
13825
|
*
|
|
14104
13826
|
* __Authorization:__
|
|
14105
13827
|
*
|
|
@@ -14121,14 +13843,14 @@ declare class TwitchApi {
|
|
|
14121
13843
|
*
|
|
14122
13844
|
* @see https://dev.twitch.tv/docs/api/reference#get-conduits
|
|
14123
13845
|
*/
|
|
14124
|
-
getConduits: (options?: CallApiOptions[
|
|
13846
|
+
getConduits: (options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14125
13847
|
data: {
|
|
14126
13848
|
id: string;
|
|
14127
13849
|
shard_count: number;
|
|
14128
13850
|
}[];
|
|
14129
13851
|
}, 200, 401>;
|
|
14130
13852
|
/**
|
|
14131
|
-
* NEW Creates a new [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events).
|
|
13853
|
+
* NEW Creates a new [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/).
|
|
14132
13854
|
*
|
|
14133
13855
|
* __Authorization:__
|
|
14134
13856
|
*
|
|
@@ -14158,14 +13880,14 @@ declare class TwitchApi {
|
|
|
14158
13880
|
*
|
|
14159
13881
|
* @see https://dev.twitch.tv/docs/api/reference#create-conduits
|
|
14160
13882
|
*/
|
|
14161
|
-
createConduits: (body: CreateConduitsBody, options?: CallApiOptions[
|
|
13883
|
+
createConduits: (body: CreateConduitsBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14162
13884
|
data: {
|
|
14163
13885
|
id: string;
|
|
14164
13886
|
shard_count: number;
|
|
14165
13887
|
}[];
|
|
14166
13888
|
}, 200, 400 | 401 | 429>;
|
|
14167
13889
|
/**
|
|
14168
|
-
* NEW Updates a [conduit’s](https://dev.twitch.tv/docs/eventsub/handling-conduit-events) shard count. To delete shards, update the count to a lower number, and the shards above the count will be deleted. For example, if the existing shard count is 100, by resetting shard count to 50, shards 50-99 are disabled.
|
|
13890
|
+
* NEW Updates a [conduit’s](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/) shard count. To delete shards, update the count to a lower number, and the shards above the count will be deleted. For example, if the existing shard count is 100, by resetting shard count to 50, shards 50-99 are disabled.
|
|
14169
13891
|
*
|
|
14170
13892
|
* __Authorization:__
|
|
14171
13893
|
*
|
|
@@ -14197,14 +13919,14 @@ declare class TwitchApi {
|
|
|
14197
13919
|
*
|
|
14198
13920
|
* @see https://dev.twitch.tv/docs/api/reference#update-conduits
|
|
14199
13921
|
*/
|
|
14200
|
-
updateConduits: (body: UpdateConduitsBody, options?: CallApiOptions[
|
|
13922
|
+
updateConduits: (body: UpdateConduitsBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14201
13923
|
data: {
|
|
14202
13924
|
id: string;
|
|
14203
13925
|
shard_count: number;
|
|
14204
13926
|
}[];
|
|
14205
13927
|
}, 200, 400 | 401 | 404>;
|
|
14206
13928
|
/**
|
|
14207
|
-
* NEW Deletes a specified [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/). Note that it may take some time for Eventsub subscriptions on a deleted [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events) to show as disabled when calling [Get Eventsub Subscriptions](https://dev.twitch.tv/docs/api/reference/#get-eventsub-subscriptions).
|
|
13929
|
+
* NEW Deletes a specified [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/). Note that it may take some time for Eventsub subscriptions on a deleted [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/) to show as disabled when calling [Get Eventsub Subscriptions](https://dev.twitch.tv/docs/api/reference/#get-eventsub-subscriptions).
|
|
14208
13930
|
*
|
|
14209
13931
|
* __Authorization:__
|
|
14210
13932
|
*
|
|
@@ -14235,9 +13957,9 @@ declare class TwitchApi {
|
|
|
14235
13957
|
*
|
|
14236
13958
|
* @see https://dev.twitch.tv/docs/api/reference#delete-conduit
|
|
14237
13959
|
*/
|
|
14238
|
-
deleteConduit: (params: DeleteConduitParams, options?: CallApiOptions[
|
|
13960
|
+
deleteConduit: (params: DeleteConduitParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 404>;
|
|
14239
13961
|
/**
|
|
14240
|
-
* NEW Gets a lists of all shards for a [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events).
|
|
13962
|
+
* NEW Gets a lists of all shards for a [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/).
|
|
14241
13963
|
*
|
|
14242
13964
|
* __Authorization:__
|
|
14243
13965
|
*
|
|
@@ -14268,8 +13990,8 @@ declare class TwitchApi {
|
|
|
14268
13990
|
*
|
|
14269
13991
|
* @see https://dev.twitch.tv/docs/api/reference#get-conduit-shards
|
|
14270
13992
|
*/
|
|
14271
|
-
getConduitShards: (params: GetConduitShardsParams, options?: CallApiOptions[
|
|
14272
|
-
data: {
|
|
13993
|
+
getConduitShards: (params: GetConduitShardsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
13994
|
+
data: ({
|
|
14273
13995
|
id: string;
|
|
14274
13996
|
status: "enabled" | "webhook_callback_verification_pending" | "webhook_callback_verification_failed" | "notification_failures_exceeded" | "websocket_disconnected" | "websocket_failed_ping_pong" | "websocket_received_inbound_traffic" | "websocket_internal_error" | "websocket_network_timeout" | "websocket_network_error" | "websocket_failed_to_reconnect";
|
|
14275
13997
|
transport: {
|
|
@@ -14279,13 +14001,13 @@ declare class TwitchApi {
|
|
|
14279
14001
|
connected_at?: string;
|
|
14280
14002
|
disconnected_at?: string;
|
|
14281
14003
|
};
|
|
14282
|
-
}[];
|
|
14004
|
+
})[];
|
|
14283
14005
|
pagination?: {
|
|
14284
14006
|
cursor?: string;
|
|
14285
14007
|
};
|
|
14286
14008
|
}, 200, 400 | 401 | 404>;
|
|
14287
14009
|
/**
|
|
14288
|
-
* NEW Updates shard(s) for a [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events).
|
|
14010
|
+
* NEW Updates shard(s) for a [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/).
|
|
14289
14011
|
*
|
|
14290
14012
|
* **NOTE:** Shard IDs are indexed starting at 0, so a conduit with a `shard_count` of 5 will have shards with IDs 0 through 4.
|
|
14291
14013
|
*
|
|
@@ -14318,8 +14040,8 @@ declare class TwitchApi {
|
|
|
14318
14040
|
*
|
|
14319
14041
|
* @see https://dev.twitch.tv/docs/api/reference#update-conduit-shards
|
|
14320
14042
|
*/
|
|
14321
|
-
updateConduitShards: (body: UpdateConduitShardsBody, options?: CallApiOptions[
|
|
14322
|
-
data: {
|
|
14043
|
+
updateConduitShards: (body: UpdateConduitShardsBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14044
|
+
data: ({
|
|
14323
14045
|
id: string;
|
|
14324
14046
|
status: "enabled" | "webhook_callback_verification_pending" | "webhook_callback_verification_failed" | "notification_failures_exceeded" | "websocket_disconnected" | "websocket_failed_ping_pong" | "websocket_received_inbound_traffic" | "websocket_internal_error" | "websocket_network_timeout" | "websocket_network_error" | "websocket_failed_to_reconnect";
|
|
14325
14047
|
transport: {
|
|
@@ -14329,7 +14051,7 @@ declare class TwitchApi {
|
|
|
14329
14051
|
connected_at?: string;
|
|
14330
14052
|
disconnected_at?: string;
|
|
14331
14053
|
};
|
|
14332
|
-
}[];
|
|
14054
|
+
})[];
|
|
14333
14055
|
errors: {
|
|
14334
14056
|
id: string;
|
|
14335
14057
|
message: string;
|
|
@@ -14363,12 +14085,8 @@ declare class TwitchApi {
|
|
|
14363
14085
|
*
|
|
14364
14086
|
* @see https://dev.twitch.tv/docs/api/reference#get-content-classification-labels
|
|
14365
14087
|
*/
|
|
14366
|
-
getContentClassificationLabels: (params?: GetContentClassificationLabelsParams | null | undefined, options?: CallApiOptions[
|
|
14367
|
-
data:
|
|
14368
|
-
id: string;
|
|
14369
|
-
description: string;
|
|
14370
|
-
name: string;
|
|
14371
|
-
}[];
|
|
14088
|
+
getContentClassificationLabels: (params?: GetContentClassificationLabelsParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14089
|
+
data: components["schemas"]["ContentClassificationLabel"][];
|
|
14372
14090
|
}, 200, 400 | 401 | 500>;
|
|
14373
14091
|
};
|
|
14374
14092
|
entitlements: {
|
|
@@ -14427,16 +14145,8 @@ declare class TwitchApi {
|
|
|
14427
14145
|
*
|
|
14428
14146
|
* @see https://dev.twitch.tv/docs/api/reference#get-drops-entitlements
|
|
14429
14147
|
*/
|
|
14430
|
-
getDropsEntitlements: (params?: GetDropsEntitlementsParams | null | undefined, options?: CallApiOptions[
|
|
14431
|
-
data:
|
|
14432
|
-
id: string;
|
|
14433
|
-
benefit_id: string;
|
|
14434
|
-
timestamp: string;
|
|
14435
|
-
user_id: string;
|
|
14436
|
-
game_id: string;
|
|
14437
|
-
fulfillment_status: "FULFILLED" | "CLAIMED";
|
|
14438
|
-
last_updated: string;
|
|
14439
|
-
}[];
|
|
14148
|
+
getDropsEntitlements: (params?: GetDropsEntitlementsParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14149
|
+
data: components["schemas"]["DropsEntitlement"][];
|
|
14440
14150
|
pagination?: {
|
|
14441
14151
|
cursor?: string;
|
|
14442
14152
|
};
|
|
@@ -14482,11 +14192,8 @@ declare class TwitchApi {
|
|
|
14482
14192
|
*
|
|
14483
14193
|
* @see https://dev.twitch.tv/docs/api/reference#update-drops-entitlements
|
|
14484
14194
|
*/
|
|
14485
|
-
updateDropsEntitlements: (body?: UpdateDropsEntitlementsBody | null | undefined, options?: CallApiOptions[
|
|
14486
|
-
data:
|
|
14487
|
-
status: "INVALID_ID" | "NOT_FOUND" | "SUCCESS" | "UNAUTHORIZED" | "UPDATE_FAILED";
|
|
14488
|
-
ids: string[];
|
|
14489
|
-
}[];
|
|
14195
|
+
updateDropsEntitlements: (body?: UpdateDropsEntitlementsBody | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14196
|
+
data: components["schemas"]["DropsEntitlementUpdated"][];
|
|
14490
14197
|
}, 200, 400 | 401 | 500>;
|
|
14491
14198
|
};
|
|
14492
14199
|
extensions: {
|
|
@@ -14527,13 +14234,8 @@ declare class TwitchApi {
|
|
|
14527
14234
|
*
|
|
14528
14235
|
* @see https://dev.twitch.tv/docs/api/reference#get-extension-configuration-segment
|
|
14529
14236
|
*/
|
|
14530
|
-
getExtensionConfigurationSegment: (params: GetExtensionConfigurationSegmentParams, options?: CallApiOptions[
|
|
14531
|
-
data:
|
|
14532
|
-
segment: "broadcaster" | "developer" | "global";
|
|
14533
|
-
broadcaster_id?: string;
|
|
14534
|
-
content: string;
|
|
14535
|
-
version: string;
|
|
14536
|
-
}[];
|
|
14237
|
+
getExtensionConfigurationSegment: (params: GetExtensionConfigurationSegmentParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14238
|
+
data: components["schemas"]["ExtensionConfigurationSegment"][];
|
|
14537
14239
|
}, 200, 400 | 401 | 429>;
|
|
14538
14240
|
/**
|
|
14539
14241
|
* Updates a configuration segment. The segment is limited to 5 KB. Extensions that are active on a channel do not receive the updated configuration.
|
|
@@ -14566,7 +14268,7 @@ declare class TwitchApi {
|
|
|
14566
14268
|
*
|
|
14567
14269
|
* @see https://dev.twitch.tv/docs/api/reference#set-extension-configuration-segment
|
|
14568
14270
|
*/
|
|
14569
|
-
setExtensionConfigurationSegment: (body: SetExtensionConfigurationSegmentBody, options?: CallApiOptions[
|
|
14271
|
+
setExtensionConfigurationSegment: (body: SetExtensionConfigurationSegmentBody, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401>;
|
|
14570
14272
|
/**
|
|
14571
14273
|
* Updates the extension’s required\_configuration string. Use this endpoint if your extension requires the broadcaster to configure the extension before activating it (to require configuration, you must select **Custom/My Own Service** in Extension [Capabilities](https://dev.twitch.tv/docs/extensions/life-cycle/#capabilities)). For more information, see [Required Configurations](https://dev.twitch.tv/docs/extensions/building#required-configurations) and [Setting Required Configuration](https://dev.twitch.tv/docs/extensions/building#setting-required-configuration-with-the-configuration-service-optional).
|
|
14572
14274
|
*
|
|
@@ -14599,7 +14301,7 @@ declare class TwitchApi {
|
|
|
14599
14301
|
*
|
|
14600
14302
|
* @see https://dev.twitch.tv/docs/api/reference#set-extension-required-configuration
|
|
14601
14303
|
*/
|
|
14602
|
-
setExtensionRequiredConfiguration: (params: SetExtensionRequiredConfigurationParams, body: SetExtensionRequiredConfigurationBody, options?: CallApiOptions[
|
|
14304
|
+
setExtensionRequiredConfiguration: (params: SetExtensionRequiredConfigurationParams, body: SetExtensionRequiredConfigurationBody, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401>;
|
|
14603
14305
|
/**
|
|
14604
14306
|
* Sends a message to one or more viewers. You can send messages to a specific channel or to all channels where your extension is active. This endpoint uses the same mechanism as the [send](https://dev.twitch.tv/docs/extensions/reference#send) JavaScript helper function used to send messages.
|
|
14605
14307
|
*
|
|
@@ -14669,7 +14371,7 @@ declare class TwitchApi {
|
|
|
14669
14371
|
*
|
|
14670
14372
|
* @see https://dev.twitch.tv/docs/api/reference#send-extension-pubsub-message
|
|
14671
14373
|
*/
|
|
14672
|
-
sendExtensionPubSubMessage: (body: SendExtensionPubSubMessageBody, options?: CallApiOptions[
|
|
14374
|
+
sendExtensionPubSubMessage: (body: SendExtensionPubSubMessageBody, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 422>;
|
|
14673
14375
|
/**
|
|
14674
14376
|
* Gets a list of broadcasters that are streaming live and have installed or activated the extension.
|
|
14675
14377
|
*
|
|
@@ -14706,14 +14408,8 @@ declare class TwitchApi {
|
|
|
14706
14408
|
*
|
|
14707
14409
|
* @see https://dev.twitch.tv/docs/api/reference#get-extension-live-channels
|
|
14708
14410
|
*/
|
|
14709
|
-
getExtensionLiveChannels: (params: GetExtensionLiveChannelsParams, options?: CallApiOptions[
|
|
14710
|
-
data:
|
|
14711
|
-
broadcaster_id: string;
|
|
14712
|
-
broadcaster_name: string;
|
|
14713
|
-
game_name: string;
|
|
14714
|
-
game_id: string;
|
|
14715
|
-
title: string;
|
|
14716
|
-
}[];
|
|
14411
|
+
getExtensionLiveChannels: (params: GetExtensionLiveChannelsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14412
|
+
data: components["schemas"]["ExtensionLiveChannel"][];
|
|
14717
14413
|
pagination?: string;
|
|
14718
14414
|
}, 200, 400 | 401 | 404>;
|
|
14719
14415
|
/**
|
|
@@ -14745,15 +14441,8 @@ declare class TwitchApi {
|
|
|
14745
14441
|
*
|
|
14746
14442
|
* @see https://dev.twitch.tv/docs/api/reference#get-extension-secrets
|
|
14747
14443
|
*/
|
|
14748
|
-
getExtensionSecrets: (options?: CallApiOptions[
|
|
14749
|
-
data:
|
|
14750
|
-
format_version: number;
|
|
14751
|
-
secrets: {
|
|
14752
|
-
content: string;
|
|
14753
|
-
active_at: string;
|
|
14754
|
-
expires_at: string;
|
|
14755
|
-
}[];
|
|
14756
|
-
}[];
|
|
14444
|
+
getExtensionSecrets: (options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14445
|
+
data: components["schemas"]["ExtensionSecret"][];
|
|
14757
14446
|
}, 200, 400 | 401>;
|
|
14758
14447
|
/**
|
|
14759
14448
|
* Creates a shared secret used to sign and verify JWT tokens. Creating a new secret removes the current secrets from service. Use this function only when you are ready to use the new secret it returns.
|
|
@@ -14785,15 +14474,8 @@ declare class TwitchApi {
|
|
|
14785
14474
|
*
|
|
14786
14475
|
* @see https://dev.twitch.tv/docs/api/reference#create-extension-secret
|
|
14787
14476
|
*/
|
|
14788
|
-
createExtensionSecret: (params: CreateExtensionSecretParams, options?: CallApiOptions[
|
|
14789
|
-
data:
|
|
14790
|
-
format_version: number;
|
|
14791
|
-
secrets: {
|
|
14792
|
-
content: string;
|
|
14793
|
-
active_at: string;
|
|
14794
|
-
expires_at: string;
|
|
14795
|
-
}[];
|
|
14796
|
-
}[];
|
|
14477
|
+
createExtensionSecret: (params: CreateExtensionSecretParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14478
|
+
data: components["schemas"]["ExtensionSecret"][];
|
|
14797
14479
|
}, 200, 400 | 401>;
|
|
14798
14480
|
/**
|
|
14799
14481
|
* Sends a message to the specified broadcaster’s chat room. The extension’s name is used as the username for the message in the chat room. To send a chat message, your extension must enable **Chat Capabilities** (under your extension’s **Capabilities** tab).
|
|
@@ -14831,7 +14513,7 @@ declare class TwitchApi {
|
|
|
14831
14513
|
*
|
|
14832
14514
|
* @see https://dev.twitch.tv/docs/api/reference#send-extension-chat-message
|
|
14833
14515
|
*/
|
|
14834
|
-
sendExtensionChatMessage: (params: SendExtensionChatMessageParams, body: SendExtensionChatMessageBody, options?: CallApiOptions[
|
|
14516
|
+
sendExtensionChatMessage: (params: SendExtensionChatMessageParams, body: SendExtensionChatMessageBody, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401>;
|
|
14835
14517
|
/**
|
|
14836
14518
|
* Gets information about an extension.
|
|
14837
14519
|
*
|
|
@@ -14866,62 +14548,8 @@ declare class TwitchApi {
|
|
|
14866
14548
|
*
|
|
14867
14549
|
* @see https://dev.twitch.tv/docs/api/reference#get-extensions
|
|
14868
14550
|
*/
|
|
14869
|
-
getExtensions: (params: GetExtensionsParams, options?: CallApiOptions[
|
|
14870
|
-
data:
|
|
14871
|
-
author_name: string;
|
|
14872
|
-
bits_enabled: boolean;
|
|
14873
|
-
can_install: boolean;
|
|
14874
|
-
configuration_location: "none" | "hosted" | "custom";
|
|
14875
|
-
description: string;
|
|
14876
|
-
eula_tos_url: string;
|
|
14877
|
-
has_chat_support: boolean;
|
|
14878
|
-
icon_url: string;
|
|
14879
|
-
icon_urls: {
|
|
14880
|
-
"100x100"?: string;
|
|
14881
|
-
"24x24"?: string;
|
|
14882
|
-
"300x200"?: string;
|
|
14883
|
-
};
|
|
14884
|
-
id: string;
|
|
14885
|
-
name: string;
|
|
14886
|
-
privacy_policy_url: string;
|
|
14887
|
-
request_identity_link: boolean;
|
|
14888
|
-
screenshot_urls: string[];
|
|
14889
|
-
state: "Approved" | "AssetsUploaded" | "Deleted" | "Deprecated" | "InReview" | "InTest" | "PendingAction" | "Rejected" | "Released";
|
|
14890
|
-
subscriptions_support_level: "none" | "optional";
|
|
14891
|
-
summary: string;
|
|
14892
|
-
support_email: string;
|
|
14893
|
-
version: string;
|
|
14894
|
-
viewer_summary: string;
|
|
14895
|
-
views: {
|
|
14896
|
-
mobile: {
|
|
14897
|
-
viewer_url: string;
|
|
14898
|
-
};
|
|
14899
|
-
panel: {
|
|
14900
|
-
viewer_url: string;
|
|
14901
|
-
height: number;
|
|
14902
|
-
can_link_external_content: boolean;
|
|
14903
|
-
};
|
|
14904
|
-
video_overlay: {
|
|
14905
|
-
viewer_url: string;
|
|
14906
|
-
can_link_external_content: boolean;
|
|
14907
|
-
};
|
|
14908
|
-
component: {
|
|
14909
|
-
viewer_url: string;
|
|
14910
|
-
aspect_ratio_x: number;
|
|
14911
|
-
aspect_ratio_y: number;
|
|
14912
|
-
autoscale: boolean;
|
|
14913
|
-
scale_pixels: number;
|
|
14914
|
-
target_height: number;
|
|
14915
|
-
can_link_external_content: boolean;
|
|
14916
|
-
};
|
|
14917
|
-
config: {
|
|
14918
|
-
viewer_url: string;
|
|
14919
|
-
can_link_external_content: boolean;
|
|
14920
|
-
};
|
|
14921
|
-
};
|
|
14922
|
-
allowlisted_config_urls: string[];
|
|
14923
|
-
allowlisted_panel_urls: string[];
|
|
14924
|
-
}[];
|
|
14551
|
+
getExtensions: (params: GetExtensionsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14552
|
+
data: components["schemas"]["Extension"][];
|
|
14925
14553
|
}, 200, 400 | 401 | 404>;
|
|
14926
14554
|
/**
|
|
14927
14555
|
* Gets information about a released extension. Returns the extension if its `state` is Released.
|
|
@@ -14956,62 +14584,8 @@ declare class TwitchApi {
|
|
|
14956
14584
|
*
|
|
14957
14585
|
* @see https://dev.twitch.tv/docs/api/reference#get-released-extensions
|
|
14958
14586
|
*/
|
|
14959
|
-
getReleasedExtensions: (params: GetReleasedExtensionsParams, options?: CallApiOptions[
|
|
14960
|
-
data:
|
|
14961
|
-
author_name: string;
|
|
14962
|
-
bits_enabled: boolean;
|
|
14963
|
-
can_install: boolean;
|
|
14964
|
-
configuration_location: "none" | "hosted" | "custom";
|
|
14965
|
-
description: string;
|
|
14966
|
-
eula_tos_url: string;
|
|
14967
|
-
has_chat_support: boolean;
|
|
14968
|
-
icon_url: string;
|
|
14969
|
-
icon_urls: {
|
|
14970
|
-
"100x100"?: string;
|
|
14971
|
-
"24x24"?: string;
|
|
14972
|
-
"300x200"?: string;
|
|
14973
|
-
};
|
|
14974
|
-
id: string;
|
|
14975
|
-
name: string;
|
|
14976
|
-
privacy_policy_url: string;
|
|
14977
|
-
request_identity_link: boolean;
|
|
14978
|
-
screenshot_urls: string[];
|
|
14979
|
-
state: "Approved" | "AssetsUploaded" | "Deleted" | "Deprecated" | "InReview" | "InTest" | "PendingAction" | "Rejected" | "Released";
|
|
14980
|
-
subscriptions_support_level: "none" | "optional";
|
|
14981
|
-
summary: string;
|
|
14982
|
-
support_email: string;
|
|
14983
|
-
version: string;
|
|
14984
|
-
viewer_summary: string;
|
|
14985
|
-
views: {
|
|
14986
|
-
mobile: {
|
|
14987
|
-
viewer_url: string;
|
|
14988
|
-
};
|
|
14989
|
-
panel: {
|
|
14990
|
-
viewer_url: string;
|
|
14991
|
-
height: number;
|
|
14992
|
-
can_link_external_content: boolean;
|
|
14993
|
-
};
|
|
14994
|
-
video_overlay: {
|
|
14995
|
-
viewer_url: string;
|
|
14996
|
-
can_link_external_content: boolean;
|
|
14997
|
-
};
|
|
14998
|
-
component: {
|
|
14999
|
-
viewer_url: string;
|
|
15000
|
-
aspect_ratio_x: number;
|
|
15001
|
-
aspect_ratio_y: number;
|
|
15002
|
-
autoscale: boolean;
|
|
15003
|
-
scale_pixels: number;
|
|
15004
|
-
target_height: number;
|
|
15005
|
-
can_link_external_content: boolean;
|
|
15006
|
-
};
|
|
15007
|
-
config: {
|
|
15008
|
-
viewer_url: string;
|
|
15009
|
-
can_link_external_content: boolean;
|
|
15010
|
-
};
|
|
15011
|
-
};
|
|
15012
|
-
allowlisted_config_urls: string[];
|
|
15013
|
-
allowlisted_panel_urls: string[];
|
|
15014
|
-
}[];
|
|
14587
|
+
getReleasedExtensions: (params: GetReleasedExtensionsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14588
|
+
data: components["schemas"]["Extension"][];
|
|
15015
14589
|
}, 200, 400 | 401 | 404>;
|
|
15016
14590
|
/**
|
|
15017
14591
|
* Gets the list of Bits products that belongs to the extension. The client ID in the app access token identifies the extension.
|
|
@@ -15042,18 +14616,8 @@ declare class TwitchApi {
|
|
|
15042
14616
|
*
|
|
15043
14617
|
* @see https://dev.twitch.tv/docs/api/reference#get-extension-bits-products
|
|
15044
14618
|
*/
|
|
15045
|
-
getExtensionBitsProducts: (params?: GetExtensionBitsProductsParams | null | undefined, options?: CallApiOptions[
|
|
15046
|
-
data:
|
|
15047
|
-
sku: string;
|
|
15048
|
-
cost: {
|
|
15049
|
-
amount: number;
|
|
15050
|
-
type: "bits";
|
|
15051
|
-
};
|
|
15052
|
-
in_development: boolean;
|
|
15053
|
-
display_name: string;
|
|
15054
|
-
expiration: string;
|
|
15055
|
-
is_broadcast: boolean;
|
|
15056
|
-
}[];
|
|
14619
|
+
getExtensionBitsProducts: (params?: GetExtensionBitsProductsParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14620
|
+
data: components["schemas"]["ExtensionBitsProduct"][];
|
|
15057
14621
|
}, 200, 400 | 401>;
|
|
15058
14622
|
/**
|
|
15059
14623
|
* Adds or updates a Bits product that the extension created. If the SKU doesn’t exist, the product is added. You may update all fields except the `sku` field.
|
|
@@ -15091,18 +14655,8 @@ declare class TwitchApi {
|
|
|
15091
14655
|
*
|
|
15092
14656
|
* @see https://dev.twitch.tv/docs/api/reference#update-extension-bits-product
|
|
15093
14657
|
*/
|
|
15094
|
-
updateExtensionBitsProduct: (body: UpdateExtensionBitsProductBody, options?: CallApiOptions[
|
|
15095
|
-
data:
|
|
15096
|
-
sku: string;
|
|
15097
|
-
cost: {
|
|
15098
|
-
amount: number;
|
|
15099
|
-
type: "bits";
|
|
15100
|
-
};
|
|
15101
|
-
in_development: boolean;
|
|
15102
|
-
display_name: string;
|
|
15103
|
-
expiration: string;
|
|
15104
|
-
is_broadcast: boolean;
|
|
15105
|
-
}[];
|
|
14658
|
+
updateExtensionBitsProduct: (body: UpdateExtensionBitsProductBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14659
|
+
data: components["schemas"]["ExtensionBitsProduct"][];
|
|
15106
14660
|
}, 200, 400 | 401>;
|
|
15107
14661
|
};
|
|
15108
14662
|
eventSub: {
|
|
@@ -15115,7 +14669,7 @@ declare class TwitchApi {
|
|
|
15115
14669
|
*
|
|
15116
14670
|
* If you use [WebSockets to receive events](https://dev.twitch.tv/docs/eventsub/handling-websocket-events), the request must specify a user access token. The request will fail if you use an app access token. If the subscription type requires user authorization, the token must include the required scope. However, if the subscription type doesn’t include user authorization, the token may include any scopes or no scopes.
|
|
15117
14671
|
*
|
|
15118
|
-
* If you use [Conduits](https://dev.twitch.tv/docs/eventsub/handling-conduit-events) to receive events, the request must specify an app access token. The request will fail if you use a user access token.
|
|
14672
|
+
* If you use [Conduits](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/) to receive events, the request must specify an app access token. The request will fail if you use a user access token.
|
|
15119
14673
|
*
|
|
15120
14674
|
* __URL:__
|
|
15121
14675
|
*
|
|
@@ -15162,23 +14716,8 @@ declare class TwitchApi {
|
|
|
15162
14716
|
*
|
|
15163
14717
|
* @see https://dev.twitch.tv/docs/api/reference#create-eventsub-subscription
|
|
15164
14718
|
*/
|
|
15165
|
-
createEventSubSubscription: (body: CreateEventSubSubscriptionBody, options?: CallApiOptions[
|
|
15166
|
-
data:
|
|
15167
|
-
id: string;
|
|
15168
|
-
status: "enabled" | "webhook_callback_verification_pending" | "webhook_callback_verification_failed" | "notification_failures_exceeded" | "websocket_disconnected" | "websocket_failed_ping_pong" | "websocket_received_inbound_traffic" | "websocket_internal_error" | "websocket_network_timeout" | "websocket_network_error" | "authorization_revoked" | "moderator_removed" | "user_removed" | "version_removed" | "beta_maintenance" | "websocket_connection_unused";
|
|
15169
|
-
type: "automod.message.hold" | "automod.message.update" | "automod.settings.update" | "automod.terms.update" | "channel.update" | "channel.follow" | "channel.ad_break.begin" | "channel.chat.clear" | "channel.chat.clear_user_messages" | "channel.chat.message" | "channel.chat.message_delete" | "channel.chat.notification" | "channel.chat_settings.update" | "channel.chat.user_message_hold" | "channel.chat.user_message_update" | "channel.subscribe" | "channel.subscription.end" | "channel.subscription.gift" | "channel.subscription.message" | "channel.cheer" | "channel.raid" | "channel.ban" | "channel.unban" | "channel.unban_request.create" | "channel.unban_request.resolve" | "channel.moderate" | "channel.moderator.add" | "channel.moderator.remove" | "channel.guest_star_session.begin" | "channel.guest_star_session.end" | "channel.guest_star_guest.update" | "channel.guest_star_settings.update" | "channel.channel_points_automatic_reward_redemption.add" | "channel.channel_points_custom_reward.add" | "channel.channel_points_custom_reward.update" | "channel.channel_points_custom_reward.remove" | "channel.channel_points_custom_reward_redemption.add" | "channel.channel_points_custom_reward_redemption.update" | "channel.poll.begin" | "channel.poll.progress" | "channel.poll.end" | "channel.prediction.begin" | "channel.prediction.progress" | "channel.prediction.lock" | "channel.prediction.end" | "channel.suspicious_user.message" | "channel.suspicious_user.update" | "channel.vip.add" | "channel.vip.remove" | "channel.warning.acknowledge" | "channel.warning.send" | "channel.charity_campaign.donate" | "channel.charity_campaign.start" | "channel.charity_campaign.progress" | "channel.charity_campaign.stop" | "conduit.shard.disabled" | "drop.entitlement.grant" | "extension.bits_transaction.create" | "channel.goal.begin" | "channel.goal.progress" | "channel.goal.end" | "channel.hype_train.begin" | "channel.hype_train.progress" | "channel.hype_train.end" | "channel.shield_mode.begin" | "channel.shield_mode.end" | "channel.shoutout.create" | "channel.shoutout.receive" | "stream.online" | "stream.offline" | "user.authorization.grant" | "user.authorization.revoke" | "user.update" | "user.whisper.message";
|
|
15170
|
-
version: string;
|
|
15171
|
-
condition: Record<string, never>;
|
|
15172
|
-
created_at: string;
|
|
15173
|
-
transport: {
|
|
15174
|
-
method: "webhook" | "websocket";
|
|
15175
|
-
callback?: string;
|
|
15176
|
-
session_id?: string;
|
|
15177
|
-
connected_at?: string;
|
|
15178
|
-
disconnected_at?: string;
|
|
15179
|
-
};
|
|
15180
|
-
cost: number;
|
|
15181
|
-
}[];
|
|
14719
|
+
createEventSubSubscription: (body: CreateEventSubSubscriptionBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14720
|
+
data: components["schemas"]["EventSubSubscription"][];
|
|
15182
14721
|
total: number;
|
|
15183
14722
|
total_cost: number;
|
|
15184
14723
|
max_total_cost: number;
|
|
@@ -15218,13 +14757,13 @@ declare class TwitchApi {
|
|
|
15218
14757
|
*
|
|
15219
14758
|
* @see https://dev.twitch.tv/docs/api/reference#delete-eventsub-subscription
|
|
15220
14759
|
*/
|
|
15221
|
-
deleteEventSubSubscription: (params: DeleteEventSubSubscriptionParams, options?: CallApiOptions[
|
|
14760
|
+
deleteEventSubSubscription: (params: DeleteEventSubSubscriptionParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 404>;
|
|
15222
14761
|
/**
|
|
15223
14762
|
* Gets a list of EventSub subscriptions that the client in the access token created.
|
|
15224
14763
|
*
|
|
15225
14764
|
* __Authorization:__
|
|
15226
14765
|
*
|
|
15227
|
-
* If you use [Webhooks](https://dev.twitch.tv/docs/eventsub/handling-webhook-events) or [Conduits](https://dev.twitch.tv/docs/eventsub/handling-conduit-events) to receive events, the request must specify an app access token. The request will fail if you use a user access token.
|
|
14766
|
+
* If you use [Webhooks](https://dev.twitch.tv/docs/eventsub/handling-webhook-events) or [Conduits](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/) to receive events, the request must specify an app access token. The request will fail if you use a user access token.
|
|
15228
14767
|
*
|
|
15229
14768
|
* If you use [WebSockets to receive events](https://dev.twitch.tv/docs/eventsub/handling-websocket-events), the request must specify a user access token. The request will fail if you use an app access token. The token may include any scopes.
|
|
15230
14769
|
*
|
|
@@ -15257,23 +14796,8 @@ declare class TwitchApi {
|
|
|
15257
14796
|
*
|
|
15258
14797
|
* @see https://dev.twitch.tv/docs/api/reference#get-eventsub-subscriptions
|
|
15259
14798
|
*/
|
|
15260
|
-
getEventSubSubscriptions: (params?: GetEventSubSubscriptionsParams | null | undefined, options?: CallApiOptions[
|
|
15261
|
-
data:
|
|
15262
|
-
id: string;
|
|
15263
|
-
status: "enabled" | "webhook_callback_verification_pending" | "webhook_callback_verification_failed" | "notification_failures_exceeded" | "websocket_disconnected" | "websocket_failed_ping_pong" | "websocket_received_inbound_traffic" | "websocket_internal_error" | "websocket_network_timeout" | "websocket_network_error" | "authorization_revoked" | "moderator_removed" | "user_removed" | "version_removed" | "beta_maintenance" | "websocket_connection_unused";
|
|
15264
|
-
type: "automod.message.hold" | "automod.message.update" | "automod.settings.update" | "automod.terms.update" | "channel.update" | "channel.follow" | "channel.ad_break.begin" | "channel.chat.clear" | "channel.chat.clear_user_messages" | "channel.chat.message" | "channel.chat.message_delete" | "channel.chat.notification" | "channel.chat_settings.update" | "channel.chat.user_message_hold" | "channel.chat.user_message_update" | "channel.subscribe" | "channel.subscription.end" | "channel.subscription.gift" | "channel.subscription.message" | "channel.cheer" | "channel.raid" | "channel.ban" | "channel.unban" | "channel.unban_request.create" | "channel.unban_request.resolve" | "channel.moderate" | "channel.moderator.add" | "channel.moderator.remove" | "channel.guest_star_session.begin" | "channel.guest_star_session.end" | "channel.guest_star_guest.update" | "channel.guest_star_settings.update" | "channel.channel_points_automatic_reward_redemption.add" | "channel.channel_points_custom_reward.add" | "channel.channel_points_custom_reward.update" | "channel.channel_points_custom_reward.remove" | "channel.channel_points_custom_reward_redemption.add" | "channel.channel_points_custom_reward_redemption.update" | "channel.poll.begin" | "channel.poll.progress" | "channel.poll.end" | "channel.prediction.begin" | "channel.prediction.progress" | "channel.prediction.lock" | "channel.prediction.end" | "channel.suspicious_user.message" | "channel.suspicious_user.update" | "channel.vip.add" | "channel.vip.remove" | "channel.warning.acknowledge" | "channel.warning.send" | "channel.charity_campaign.donate" | "channel.charity_campaign.start" | "channel.charity_campaign.progress" | "channel.charity_campaign.stop" | "conduit.shard.disabled" | "drop.entitlement.grant" | "extension.bits_transaction.create" | "channel.goal.begin" | "channel.goal.progress" | "channel.goal.end" | "channel.hype_train.begin" | "channel.hype_train.progress" | "channel.hype_train.end" | "channel.shield_mode.begin" | "channel.shield_mode.end" | "channel.shoutout.create" | "channel.shoutout.receive" | "stream.online" | "stream.offline" | "user.authorization.grant" | "user.authorization.revoke" | "user.update" | "user.whisper.message";
|
|
15265
|
-
version: string;
|
|
15266
|
-
condition: Record<string, never>;
|
|
15267
|
-
created_at: string;
|
|
15268
|
-
transport: {
|
|
15269
|
-
method: "webhook" | "websocket";
|
|
15270
|
-
callback?: string;
|
|
15271
|
-
session_id?: string;
|
|
15272
|
-
connected_at?: string;
|
|
15273
|
-
disconnected_at?: string;
|
|
15274
|
-
};
|
|
15275
|
-
cost: number;
|
|
15276
|
-
}[];
|
|
14799
|
+
getEventSubSubscriptions: (params?: GetEventSubSubscriptionsParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14800
|
+
data: components["schemas"]["EventSubSubscription"][];
|
|
15277
14801
|
total: number;
|
|
15278
14802
|
total_cost: number;
|
|
15279
14803
|
max_total_cost: number;
|
|
@@ -15313,13 +14837,8 @@ declare class TwitchApi {
|
|
|
15313
14837
|
*
|
|
15314
14838
|
* @see https://dev.twitch.tv/docs/api/reference#get-top-games
|
|
15315
14839
|
*/
|
|
15316
|
-
getTopGames: (params?: GetTopGamesParams | null | undefined, options?: CallApiOptions[
|
|
15317
|
-
data:
|
|
15318
|
-
id: string;
|
|
15319
|
-
name: string;
|
|
15320
|
-
box_art_url: string;
|
|
15321
|
-
igdb_id: string;
|
|
15322
|
-
}[];
|
|
14840
|
+
getTopGames: (params?: GetTopGamesParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14841
|
+
data: components["schemas"]["Game"][];
|
|
15323
14842
|
pagination?: {
|
|
15324
14843
|
cursor?: string;
|
|
15325
14844
|
};
|
|
@@ -15356,13 +14875,8 @@ declare class TwitchApi {
|
|
|
15356
14875
|
*
|
|
15357
14876
|
* @see https://dev.twitch.tv/docs/api/reference#get-games
|
|
15358
14877
|
*/
|
|
15359
|
-
getGames: (params?: GetGamesParams | null | undefined, options?: CallApiOptions[
|
|
15360
|
-
data:
|
|
15361
|
-
id: string;
|
|
15362
|
-
name: string;
|
|
15363
|
-
box_art_url: string;
|
|
15364
|
-
igdb_id: string;
|
|
15365
|
-
}[];
|
|
14878
|
+
getGames: (params?: GetGamesParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14879
|
+
data: components["schemas"]["Game"][];
|
|
15366
14880
|
}, 200, 400 | 401>;
|
|
15367
14881
|
};
|
|
15368
14882
|
goals: {
|
|
@@ -15399,18 +14913,8 @@ declare class TwitchApi {
|
|
|
15399
14913
|
*
|
|
15400
14914
|
* @see https://dev.twitch.tv/docs/api/reference#get-creator-goals
|
|
15401
14915
|
*/
|
|
15402
|
-
getCreatorGoals: (params: GetCreatorGoalsParams, options?: CallApiOptions[
|
|
15403
|
-
data:
|
|
15404
|
-
id: string;
|
|
15405
|
-
broadcaster_id: string;
|
|
15406
|
-
broadcaster_name: string;
|
|
15407
|
-
broadcaster_login: string;
|
|
15408
|
-
type: "follower" | "subscription" | "subscription_count" | "new_subscription" | "new_subscription_count";
|
|
15409
|
-
description: string;
|
|
15410
|
-
current_amount: number;
|
|
15411
|
-
target_amount: number;
|
|
15412
|
-
created_at: string;
|
|
15413
|
-
}[];
|
|
14916
|
+
getCreatorGoals: (params: GetCreatorGoalsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14917
|
+
data: components["schemas"]["CreatorGoal"][];
|
|
15414
14918
|
}, 200, 400 | 401>;
|
|
15415
14919
|
};
|
|
15416
14920
|
guestStar: {
|
|
@@ -15441,7 +14945,7 @@ declare class TwitchApi {
|
|
|
15441
14945
|
*
|
|
15442
14946
|
* @see https://dev.twitch.tv/docs/api/reference#get-channel-guest-star-settings
|
|
15443
14947
|
*/
|
|
15444
|
-
getChannelGuestStarSettings: (params: GetChannelGuestStarSettingsParams, options?: CallApiOptions[
|
|
14948
|
+
getChannelGuestStarSettings: (params: GetChannelGuestStarSettingsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
15445
14949
|
is_moderator_send_live_enabled: boolean;
|
|
15446
14950
|
slot_count: number;
|
|
15447
14951
|
is_browser_source_audio_enabled: boolean;
|
|
@@ -15474,7 +14978,7 @@ declare class TwitchApi {
|
|
|
15474
14978
|
*
|
|
15475
14979
|
* @see https://dev.twitch.tv/docs/api/reference#update-channel-guest-star-settings
|
|
15476
14980
|
*/
|
|
15477
|
-
updateChannelGuestStarSettings: (params: UpdateChannelGuestStarSettingsParams, body?: UpdateChannelGuestStarSettingsBody | null | undefined, options?: CallApiOptions[
|
|
14981
|
+
updateChannelGuestStarSettings: (params: UpdateChannelGuestStarSettingsParams, body?: UpdateChannelGuestStarSettingsBody | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400>;
|
|
15478
14982
|
/**
|
|
15479
14983
|
* BETA Gets information about an ongoing Guest Star session for a particular channel.
|
|
15480
14984
|
*
|
|
@@ -15502,29 +15006,8 @@ declare class TwitchApi {
|
|
|
15502
15006
|
*
|
|
15503
15007
|
* @see https://dev.twitch.tv/docs/api/reference#get-guest-star-session
|
|
15504
15008
|
*/
|
|
15505
|
-
getGuestStarSession: (params: GetGuestStarSessionParams, options?: CallApiOptions[
|
|
15506
|
-
data:
|
|
15507
|
-
id: string;
|
|
15508
|
-
guests: {
|
|
15509
|
-
slot_id: string;
|
|
15510
|
-
is_live: boolean;
|
|
15511
|
-
user_id: string;
|
|
15512
|
-
user_display_name: string;
|
|
15513
|
-
user_login: string;
|
|
15514
|
-
volume: number;
|
|
15515
|
-
assigned_at: string;
|
|
15516
|
-
audio_settings: {
|
|
15517
|
-
is_host_enabled: boolean;
|
|
15518
|
-
is_guest_enabled: boolean;
|
|
15519
|
-
is_available: boolean;
|
|
15520
|
-
};
|
|
15521
|
-
video_settings: {
|
|
15522
|
-
is_host_enabled: boolean;
|
|
15523
|
-
is_guest_enabled: boolean;
|
|
15524
|
-
is_available: boolean;
|
|
15525
|
-
};
|
|
15526
|
-
}[];
|
|
15527
|
-
}[];
|
|
15009
|
+
getGuestStarSession: (params: GetGuestStarSessionParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
15010
|
+
data: components["schemas"]["GuestStarSession"][];
|
|
15528
15011
|
}, 200, 400 | 401>;
|
|
15529
15012
|
/**
|
|
15530
15013
|
* BETA Programmatically creates a Guest Star session on behalf of the broadcaster. Requires the broadcaster to be present in the call interface, or the call will be ended automatically.
|
|
@@ -15557,29 +15040,8 @@ declare class TwitchApi {
|
|
|
15557
15040
|
*
|
|
15558
15041
|
* @see https://dev.twitch.tv/docs/api/reference#create-guest-star-session
|
|
15559
15042
|
*/
|
|
15560
|
-
createGuestStarSession: (params: CreateGuestStarSessionParams, options?: CallApiOptions[
|
|
15561
|
-
data:
|
|
15562
|
-
id: string;
|
|
15563
|
-
guests: {
|
|
15564
|
-
slot_id: string;
|
|
15565
|
-
is_live: boolean;
|
|
15566
|
-
user_id: string;
|
|
15567
|
-
user_display_name: string;
|
|
15568
|
-
user_login: string;
|
|
15569
|
-
volume: number;
|
|
15570
|
-
assigned_at: string;
|
|
15571
|
-
audio_settings: {
|
|
15572
|
-
is_host_enabled: boolean;
|
|
15573
|
-
is_guest_enabled: boolean;
|
|
15574
|
-
is_available: boolean;
|
|
15575
|
-
};
|
|
15576
|
-
video_settings: {
|
|
15577
|
-
is_host_enabled: boolean;
|
|
15578
|
-
is_guest_enabled: boolean;
|
|
15579
|
-
is_available: boolean;
|
|
15580
|
-
};
|
|
15581
|
-
}[];
|
|
15582
|
-
}[];
|
|
15043
|
+
createGuestStarSession: (params: CreateGuestStarSessionParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
15044
|
+
data: components["schemas"]["GuestStarSession"][];
|
|
15583
15045
|
}, 200, 400 | 401 | 403>;
|
|
15584
15046
|
/**
|
|
15585
15047
|
* BETA Programmatically ends a Guest Star session on behalf of the broadcaster. Performs the same action as if the host clicked the “End Call” button in the Guest Star UI.
|
|
@@ -15609,7 +15071,7 @@ declare class TwitchApi {
|
|
|
15609
15071
|
*
|
|
15610
15072
|
* @see https://dev.twitch.tv/docs/api/reference#end-guest-star-session
|
|
15611
15073
|
*/
|
|
15612
|
-
endGuestStarSession: (params: EndGuestStarSessionParams, options?: CallApiOptions[
|
|
15074
|
+
endGuestStarSession: (params: EndGuestStarSessionParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 403>;
|
|
15613
15075
|
/**
|
|
15614
15076
|
* BETA Provides the caller with a list of pending invites to a Guest Star session, including the invitee’s ready status while joining the waiting room.
|
|
15615
15077
|
*
|
|
@@ -15633,16 +15095,8 @@ declare class TwitchApi {
|
|
|
15633
15095
|
*
|
|
15634
15096
|
* @see https://dev.twitch.tv/docs/api/reference#get-guest-star-invites
|
|
15635
15097
|
*/
|
|
15636
|
-
getGuestStarInvites: (params: GetGuestStarInvitesParams, options?: CallApiOptions[
|
|
15637
|
-
data:
|
|
15638
|
-
user_id: string;
|
|
15639
|
-
invited_at: string;
|
|
15640
|
-
status: string;
|
|
15641
|
-
is_video_enabled: boolean;
|
|
15642
|
-
is_audio_enabled: boolean;
|
|
15643
|
-
is_video_available: boolean;
|
|
15644
|
-
is_audio_available: boolean;
|
|
15645
|
-
}[];
|
|
15098
|
+
getGuestStarInvites: (params: GetGuestStarInvitesParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
15099
|
+
data: components["schemas"]["GuestStarInvite"][];
|
|
15646
15100
|
}, 200, 400>;
|
|
15647
15101
|
/**
|
|
15648
15102
|
* BETA Sends an invite to a specified guest on behalf of the broadcaster for a Guest Star session in progress.
|
|
@@ -15675,7 +15129,7 @@ declare class TwitchApi {
|
|
|
15675
15129
|
*
|
|
15676
15130
|
* @see https://dev.twitch.tv/docs/api/reference#send-guest-star-invite
|
|
15677
15131
|
*/
|
|
15678
|
-
sendGuestStarInvite: (params: SendGuestStarInviteParams, options?: CallApiOptions[
|
|
15132
|
+
sendGuestStarInvite: (params: SendGuestStarInviteParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 403>;
|
|
15679
15133
|
/**
|
|
15680
15134
|
* BETA Revokes a previously sent invite for a Guest Star session.
|
|
15681
15135
|
*
|
|
@@ -15705,7 +15159,7 @@ declare class TwitchApi {
|
|
|
15705
15159
|
*
|
|
15706
15160
|
* @see https://dev.twitch.tv/docs/api/reference#delete-guest-star-invite
|
|
15707
15161
|
*/
|
|
15708
|
-
deleteGuestStarInvite: (params: DeleteGuestStarInviteParams, options?: CallApiOptions[
|
|
15162
|
+
deleteGuestStarInvite: (params: DeleteGuestStarInviteParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 404>;
|
|
15709
15163
|
/**
|
|
15710
15164
|
* BETA Allows a previously invited user to be assigned a slot within the active Guest Star session, once that guest has indicated they are ready to join.
|
|
15711
15165
|
*
|
|
@@ -15745,7 +15199,7 @@ declare class TwitchApi {
|
|
|
15745
15199
|
*
|
|
15746
15200
|
* @see https://dev.twitch.tv/docs/api/reference#assign-guest-star-slot
|
|
15747
15201
|
*/
|
|
15748
|
-
assignGuestStarSlot: (params: AssignGuestStarSlotParams, options?: CallApiOptions[
|
|
15202
|
+
assignGuestStarSlot: (params: AssignGuestStarSlotParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 403>;
|
|
15749
15203
|
/**
|
|
15750
15204
|
* BETA Allows a user to update the assigned slot for a particular user within the active Guest Star session.
|
|
15751
15205
|
*
|
|
@@ -15772,7 +15226,7 @@ declare class TwitchApi {
|
|
|
15772
15226
|
*
|
|
15773
15227
|
* @see https://dev.twitch.tv/docs/api/reference#update-guest-star-slot
|
|
15774
15228
|
*/
|
|
15775
|
-
updateGuestStarSlot: (params: UpdateGuestStarSlotParams, options?: CallApiOptions[
|
|
15229
|
+
updateGuestStarSlot: (params: UpdateGuestStarSlotParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400>;
|
|
15776
15230
|
/**
|
|
15777
15231
|
* BETA Allows a caller to remove a slot assignment from a user participating in an active Guest Star session. This revokes their access to the session immediately and disables their access to publish or subscribe to media within the session.
|
|
15778
15232
|
*
|
|
@@ -15809,7 +15263,7 @@ declare class TwitchApi {
|
|
|
15809
15263
|
*
|
|
15810
15264
|
* @see https://dev.twitch.tv/docs/api/reference#delete-guest-star-slot
|
|
15811
15265
|
*/
|
|
15812
|
-
deleteGuestStarSlot: (params: DeleteGuestStarSlotParams, options?: CallApiOptions[
|
|
15266
|
+
deleteGuestStarSlot: (params: DeleteGuestStarSlotParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 403 | 404>;
|
|
15813
15267
|
/**
|
|
15814
15268
|
* BETA Allows a user to update slot settings for a particular guest within a Guest Star session, such as allowing the user to share audio or video within the call as a host. These settings will be broadcasted to all subscribers which control their view of the guest in that slot. One or more of the optional parameters to this API can be specified at any time.
|
|
15815
15269
|
*
|
|
@@ -15842,7 +15296,7 @@ declare class TwitchApi {
|
|
|
15842
15296
|
*
|
|
15843
15297
|
* @see https://dev.twitch.tv/docs/api/reference#update-guest-star-slot-settings
|
|
15844
15298
|
*/
|
|
15845
|
-
updateGuestStarSlotSettings: (params: UpdateGuestStarSlotSettingsParams, options?: CallApiOptions[
|
|
15299
|
+
updateGuestStarSlotSettings: (params: UpdateGuestStarSlotSettingsParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 403>;
|
|
15846
15300
|
};
|
|
15847
15301
|
hypeTrain: {
|
|
15848
15302
|
/**
|
|
@@ -15874,33 +15328,8 @@ declare class TwitchApi {
|
|
|
15874
15328
|
*
|
|
15875
15329
|
* @see https://dev.twitch.tv/docs/api/reference#get-hype-train-events
|
|
15876
15330
|
*/
|
|
15877
|
-
getHypeTrainEvents: (params: GetHypeTrainEventsParams, options?: CallApiOptions[
|
|
15878
|
-
data:
|
|
15879
|
-
id: string;
|
|
15880
|
-
event_type: string;
|
|
15881
|
-
event_timestamp: string;
|
|
15882
|
-
version: string;
|
|
15883
|
-
event_data: {
|
|
15884
|
-
broadcaster_id: string;
|
|
15885
|
-
cooldown_end_time: string;
|
|
15886
|
-
expires_at: string;
|
|
15887
|
-
goal: number;
|
|
15888
|
-
id: string;
|
|
15889
|
-
last_contribution: {
|
|
15890
|
-
total: number;
|
|
15891
|
-
type: "BITS" | "SUBS" | "OTHER";
|
|
15892
|
-
user: string;
|
|
15893
|
-
};
|
|
15894
|
-
level: number;
|
|
15895
|
-
started_at: string;
|
|
15896
|
-
top_contributions: {
|
|
15897
|
-
total: number;
|
|
15898
|
-
type: "BITS" | "SUBS" | "OTHER";
|
|
15899
|
-
user: string;
|
|
15900
|
-
}[];
|
|
15901
|
-
total: number;
|
|
15902
|
-
};
|
|
15903
|
-
}[];
|
|
15331
|
+
getHypeTrainEvents: (params: GetHypeTrainEventsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
15332
|
+
data: components["schemas"]["HypeTrainEvent"][];
|
|
15904
15333
|
pagination?: {
|
|
15905
15334
|
cursor?: string;
|
|
15906
15335
|
};
|
|
@@ -15961,11 +15390,8 @@ declare class TwitchApi {
|
|
|
15961
15390
|
*
|
|
15962
15391
|
* @see https://dev.twitch.tv/docs/api/reference#check-automod-status
|
|
15963
15392
|
*/
|
|
15964
|
-
checkAutoModStatus: (params: CheckAutoModStatusParams, body: CheckAutoModStatusBody, options?: CallApiOptions[
|
|
15965
|
-
data:
|
|
15966
|
-
msg_id: string;
|
|
15967
|
-
is_permitted: boolean;
|
|
15968
|
-
}[];
|
|
15393
|
+
checkAutoModStatus: (params: CheckAutoModStatusParams, body: CheckAutoModStatusBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
15394
|
+
data: components["schemas"]["AutoModStatus"][];
|
|
15969
15395
|
}, 200, 400 | 401 | 403 | 429>;
|
|
15970
15396
|
/**
|
|
15971
15397
|
* Allow or deny the message that AutoMod flagged for review. For information about AutoMod, see [How to Use AutoMod](https://help.twitch.tv/s/article/how-to-use-automod).
|
|
@@ -16011,7 +15437,7 @@ declare class TwitchApi {
|
|
|
16011
15437
|
*
|
|
16012
15438
|
* @see https://dev.twitch.tv/docs/api/reference#manage-held-automod-messages
|
|
16013
15439
|
*/
|
|
16014
|
-
manageHeldAutoModMessages: (body: ManageHeldAutoModMessagesBody, options?: CallApiOptions[
|
|
15440
|
+
manageHeldAutoModMessages: (body: ManageHeldAutoModMessagesBody, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 403 | 404>;
|
|
16015
15441
|
/**
|
|
16016
15442
|
* Gets the broadcaster’s AutoMod settings. The settings are used to automatically block inappropriate or harassing messages from appearing in the broadcaster’s chat room.
|
|
16017
15443
|
*
|
|
@@ -16048,20 +15474,8 @@ declare class TwitchApi {
|
|
|
16048
15474
|
*
|
|
16049
15475
|
* @see https://dev.twitch.tv/docs/api/reference#get-automod-settings
|
|
16050
15476
|
*/
|
|
16051
|
-
getAutoModSettings: (params: GetAutoModSettingsParams, options?: CallApiOptions[
|
|
16052
|
-
data:
|
|
16053
|
-
broadcaster_id: string;
|
|
16054
|
-
moderator_id: string;
|
|
16055
|
-
overall_level: number | null;
|
|
16056
|
-
disability: number;
|
|
16057
|
-
aggression: number;
|
|
16058
|
-
sexuality_sex_or_gender: number;
|
|
16059
|
-
misogyny: number;
|
|
16060
|
-
bullying: number;
|
|
16061
|
-
swearing: number;
|
|
16062
|
-
race_ethnicity_or_religion: number;
|
|
16063
|
-
sex_based_terms: number;
|
|
16064
|
-
}[];
|
|
15477
|
+
getAutoModSettings: (params: GetAutoModSettingsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
15478
|
+
data: components["schemas"]["AutoModSettings"][];
|
|
16065
15479
|
}, 200, 400 | 401 | 403>;
|
|
16066
15480
|
/**
|
|
16067
15481
|
* Updates the broadcaster’s AutoMod settings. The settings are used to automatically block inappropriate or harassing messages from appearing in the broadcaster’s chat room.
|
|
@@ -16115,20 +15529,8 @@ declare class TwitchApi {
|
|
|
16115
15529
|
*
|
|
16116
15530
|
* @see https://dev.twitch.tv/docs/api/reference#update-automod-settings
|
|
16117
15531
|
*/
|
|
16118
|
-
updateAutoModSettings: (params: UpdateAutoModSettingsParams, body?: UpdateAutoModSettingsBody | null | undefined, options?: CallApiOptions[
|
|
16119
|
-
data:
|
|
16120
|
-
broadcaster_id: string;
|
|
16121
|
-
moderator_id: string;
|
|
16122
|
-
overall_level: number | null;
|
|
16123
|
-
disability: number;
|
|
16124
|
-
aggression: number;
|
|
16125
|
-
sexuality_sex_or_gender: number;
|
|
16126
|
-
misogyny: number;
|
|
16127
|
-
bullying: number;
|
|
16128
|
-
swearing: number;
|
|
16129
|
-
race_ethnicity_or_religion: number;
|
|
16130
|
-
sex_based_terms: number;
|
|
16131
|
-
}[];
|
|
15532
|
+
updateAutoModSettings: (params: UpdateAutoModSettingsParams, body?: UpdateAutoModSettingsBody | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
15533
|
+
data: components["schemas"]["AutoModSettings"][];
|
|
16132
15534
|
}, 200, 400 | 401 | 403>;
|
|
16133
15535
|
/**
|
|
16134
15536
|
* Gets all users that the broadcaster banned or put in a timeout.
|
|
@@ -16161,18 +15563,8 @@ declare class TwitchApi {
|
|
|
16161
15563
|
*
|
|
16162
15564
|
* @see https://dev.twitch.tv/docs/api/reference#get-banned-users
|
|
16163
15565
|
*/
|
|
16164
|
-
getBannedUsers: (params: GetBannedUsersParams, options?: CallApiOptions[
|
|
16165
|
-
data:
|
|
16166
|
-
user_id: string;
|
|
16167
|
-
user_login: string;
|
|
16168
|
-
user_name: string;
|
|
16169
|
-
expires_at: string;
|
|
16170
|
-
created_at: string;
|
|
16171
|
-
reason: string;
|
|
16172
|
-
moderator_id: string;
|
|
16173
|
-
moderator_login: string;
|
|
16174
|
-
moderator_name: string;
|
|
16175
|
-
}[];
|
|
15566
|
+
getBannedUsers: (params: GetBannedUsersParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
15567
|
+
data: components["schemas"]["BannedUser"][];
|
|
16176
15568
|
pagination?: {
|
|
16177
15569
|
cursor?: string;
|
|
16178
15570
|
};
|
|
@@ -16233,14 +15625,14 @@ declare class TwitchApi {
|
|
|
16233
15625
|
*
|
|
16234
15626
|
* @see https://dev.twitch.tv/docs/api/reference#ban-user
|
|
16235
15627
|
*/
|
|
16236
|
-
banUser: (params: BanUserParams, body: BanUserBody, options?: CallApiOptions[
|
|
16237
|
-
data: {
|
|
15628
|
+
banUser: (params: BanUserParams, body: BanUserBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
15629
|
+
data: ({
|
|
16238
15630
|
broadcaster_id: string;
|
|
16239
15631
|
moderator_id: string;
|
|
16240
15632
|
user_id: string;
|
|
16241
15633
|
created_at: string;
|
|
16242
15634
|
end_time: string | null;
|
|
16243
|
-
}[];
|
|
15635
|
+
})[];
|
|
16244
15636
|
}, 200, 400 | 401 | 403 | 409 | 429>;
|
|
16245
15637
|
/**
|
|
16246
15638
|
* Removes the ban or timeout that was placed on the specified user.
|
|
@@ -16290,7 +15682,7 @@ declare class TwitchApi {
|
|
|
16290
15682
|
*
|
|
16291
15683
|
* @see https://dev.twitch.tv/docs/api/reference#unban-user
|
|
16292
15684
|
*/
|
|
16293
|
-
unbanUser: (params: UnbanUserParams, options?: CallApiOptions[
|
|
15685
|
+
unbanUser: (params: UnbanUserParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 403 | 409 | 429>;
|
|
16294
15686
|
/**
|
|
16295
15687
|
* NEW Gets a list of unban requests for a broadcaster’s channel.
|
|
16296
15688
|
*
|
|
@@ -16327,7 +15719,7 @@ declare class TwitchApi {
|
|
|
16327
15719
|
*
|
|
16328
15720
|
* @see https://dev.twitch.tv/docs/api/reference#get-unban-requests
|
|
16329
15721
|
*/
|
|
16330
|
-
getUnbanRequests: (params: GetUnbanRequestsParams, options?: CallApiOptions[
|
|
15722
|
+
getUnbanRequests: (params: GetUnbanRequestsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
16331
15723
|
data: {
|
|
16332
15724
|
id: string;
|
|
16333
15725
|
broadcaster_id: string;
|
|
@@ -16354,7 +15746,7 @@ declare class TwitchApi {
|
|
|
16354
15746
|
*
|
|
16355
15747
|
* __Authorization:__
|
|
16356
15748
|
*
|
|
16357
|
-
* * Requires a user access token that includes the **moderator:manage:unban
|
|
15749
|
+
* * Requires a user access token that includes the **moderator:manage:unban\_requests** scope.
|
|
16358
15750
|
* * Query parameter `moderator_id` must match the `user_id` in the[user access token](https://dev.twitch.tv/docs/authentication/#user-access-tokens).
|
|
16359
15751
|
*
|
|
16360
15752
|
* __URL:__
|
|
@@ -16391,7 +15783,7 @@ declare class TwitchApi {
|
|
|
16391
15783
|
*
|
|
16392
15784
|
* @see https://dev.twitch.tv/docs/api/reference#resolve-unban-requests
|
|
16393
15785
|
*/
|
|
16394
|
-
resolveUnbanRequests: (params: ResolveUnbanRequestsParams, options?: CallApiOptions[
|
|
15786
|
+
resolveUnbanRequests: (params: ResolveUnbanRequestsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
16395
15787
|
data: {
|
|
16396
15788
|
id: string;
|
|
16397
15789
|
broadcaster_id: string;
|
|
@@ -16446,16 +15838,8 @@ declare class TwitchApi {
|
|
|
16446
15838
|
*
|
|
16447
15839
|
* @see https://dev.twitch.tv/docs/api/reference#get-blocked-terms
|
|
16448
15840
|
*/
|
|
16449
|
-
getBlockedTerms: (params: GetBlockedTermsParams, options?: CallApiOptions[
|
|
16450
|
-
data:
|
|
16451
|
-
broadcaster_id: string;
|
|
16452
|
-
moderator_id: string;
|
|
16453
|
-
id: string;
|
|
16454
|
-
text: string;
|
|
16455
|
-
created_at: string;
|
|
16456
|
-
updated_at: string;
|
|
16457
|
-
expires_at: string | null;
|
|
16458
|
-
}[];
|
|
15841
|
+
getBlockedTerms: (params: GetBlockedTermsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
15842
|
+
data: components["schemas"]["BlockedTerm"][];
|
|
16459
15843
|
pagination?: {
|
|
16460
15844
|
cursor?: string;
|
|
16461
15845
|
};
|
|
@@ -16498,16 +15882,8 @@ declare class TwitchApi {
|
|
|
16498
15882
|
*
|
|
16499
15883
|
* @see https://dev.twitch.tv/docs/api/reference#add-blocked-term
|
|
16500
15884
|
*/
|
|
16501
|
-
addBlockedTerm: (params: AddBlockedTermParams, body: AddBlockedTermBody, options?: CallApiOptions[
|
|
16502
|
-
data:
|
|
16503
|
-
broadcaster_id: string;
|
|
16504
|
-
moderator_id: string;
|
|
16505
|
-
id: string;
|
|
16506
|
-
text: string;
|
|
16507
|
-
created_at: string;
|
|
16508
|
-
updated_at: string;
|
|
16509
|
-
expires_at: string | null;
|
|
16510
|
-
}[];
|
|
15885
|
+
addBlockedTerm: (params: AddBlockedTermParams, body: AddBlockedTermBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
15886
|
+
data: components["schemas"]["BlockedTerm"][];
|
|
16511
15887
|
}, 200, 400 | 401 | 403>;
|
|
16512
15888
|
/**
|
|
16513
15889
|
* Removes the word or phrase from the broadcaster’s list of blocked terms.
|
|
@@ -16546,7 +15922,7 @@ declare class TwitchApi {
|
|
|
16546
15922
|
*
|
|
16547
15923
|
* @see https://dev.twitch.tv/docs/api/reference#remove-blocked-term
|
|
16548
15924
|
*/
|
|
16549
|
-
removeBlockedTerm: (params: RemoveBlockedTermParams, options?: CallApiOptions[
|
|
15925
|
+
removeBlockedTerm: (params: RemoveBlockedTermParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 403>;
|
|
16550
15926
|
/**
|
|
16551
15927
|
* Removes a single chat message or all chat messages from the broadcaster’s chat room.
|
|
16552
15928
|
*
|
|
@@ -16587,7 +15963,7 @@ declare class TwitchApi {
|
|
|
16587
15963
|
*
|
|
16588
15964
|
* @see https://dev.twitch.tv/docs/api/reference#delete-chat-messages
|
|
16589
15965
|
*/
|
|
16590
|
-
deleteChatMessages: (params: DeleteChatMessagesParams, options?: CallApiOptions[
|
|
15966
|
+
deleteChatMessages: (params: DeleteChatMessagesParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 403 | 404>;
|
|
16591
15967
|
/**
|
|
16592
15968
|
* Gets a list of channels that the specified user has moderator privileges in.
|
|
16593
15969
|
*
|
|
@@ -16614,7 +15990,7 @@ declare class TwitchApi {
|
|
|
16614
15990
|
*
|
|
16615
15991
|
* @see https://dev.twitch.tv/docs/api/reference#get-moderated-channels
|
|
16616
15992
|
*/
|
|
16617
|
-
getModeratedChannels: (params: GetModeratedChannelsParams, options?: CallApiOptions[
|
|
15993
|
+
getModeratedChannels: (params: GetModeratedChannelsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
16618
15994
|
data: {
|
|
16619
15995
|
broadcaster_id: string;
|
|
16620
15996
|
broadcaster_login: string;
|
|
@@ -16655,12 +16031,8 @@ declare class TwitchApi {
|
|
|
16655
16031
|
*
|
|
16656
16032
|
* @see https://dev.twitch.tv/docs/api/reference#get-moderators
|
|
16657
16033
|
*/
|
|
16658
|
-
getModerators: (params: GetModeratorsParams, options?: CallApiOptions[
|
|
16659
|
-
data:
|
|
16660
|
-
user_id: string;
|
|
16661
|
-
user_login: string;
|
|
16662
|
-
user_name: string;
|
|
16663
|
-
}[];
|
|
16034
|
+
getModerators: (params: GetModeratorsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
16035
|
+
data: components["schemas"]["UserModerator"][];
|
|
16664
16036
|
pagination?: {
|
|
16665
16037
|
cursor?: string;
|
|
16666
16038
|
};
|
|
@@ -16709,7 +16081,7 @@ declare class TwitchApi {
|
|
|
16709
16081
|
*
|
|
16710
16082
|
* @see https://dev.twitch.tv/docs/api/reference#add-channel-moderator
|
|
16711
16083
|
*/
|
|
16712
|
-
addChannelModerator: (params: AddChannelModeratorParams, options?: CallApiOptions[
|
|
16084
|
+
addChannelModerator: (params: AddChannelModeratorParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 422 | 429>;
|
|
16713
16085
|
/**
|
|
16714
16086
|
* Removes a moderator from the broadcaster’s chat room.
|
|
16715
16087
|
*
|
|
@@ -16749,7 +16121,7 @@ declare class TwitchApi {
|
|
|
16749
16121
|
*
|
|
16750
16122
|
* @see https://dev.twitch.tv/docs/api/reference#remove-channel-moderator
|
|
16751
16123
|
*/
|
|
16752
|
-
removeChannelModerator: (params: RemoveChannelModeratorParams, options?: CallApiOptions[
|
|
16124
|
+
removeChannelModerator: (params: RemoveChannelModeratorParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 429>;
|
|
16753
16125
|
/**
|
|
16754
16126
|
* Gets a list of the broadcaster’s VIPs.
|
|
16755
16127
|
*
|
|
@@ -16783,12 +16155,8 @@ declare class TwitchApi {
|
|
|
16783
16155
|
*
|
|
16784
16156
|
* @see https://dev.twitch.tv/docs/api/reference#get-vips
|
|
16785
16157
|
*/
|
|
16786
|
-
getVIPs: (params: GetVIPsParams, options?: CallApiOptions[
|
|
16787
|
-
data:
|
|
16788
|
-
user_id: string;
|
|
16789
|
-
user_name: string;
|
|
16790
|
-
user_login: string;
|
|
16791
|
-
}[];
|
|
16158
|
+
getVIPs: (params: GetVIPsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
16159
|
+
data: components["schemas"]["UserVip"][];
|
|
16792
16160
|
pagination?: {
|
|
16793
16161
|
cursor?: string;
|
|
16794
16162
|
};
|
|
@@ -16854,7 +16222,7 @@ declare class TwitchApi {
|
|
|
16854
16222
|
*
|
|
16855
16223
|
* @see https://dev.twitch.tv/docs/api/reference#add-channel-vip
|
|
16856
16224
|
*/
|
|
16857
|
-
addChannelVIP: (params: AddChannelVIPParams, options?: CallApiOptions[
|
|
16225
|
+
addChannelVIP: (params: AddChannelVIPParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 403 | 404 | 409 | 422 | 425 | 429>;
|
|
16858
16226
|
/**
|
|
16859
16227
|
* Removes the specified user as a VIP in the broadcaster’s channel.
|
|
16860
16228
|
*
|
|
@@ -16908,7 +16276,7 @@ declare class TwitchApi {
|
|
|
16908
16276
|
*
|
|
16909
16277
|
* @see https://dev.twitch.tv/docs/api/reference#remove-channel-vip
|
|
16910
16278
|
*/
|
|
16911
|
-
removeChannelVIP: (params: RemoveChannelVIPParams, options?: CallApiOptions[
|
|
16279
|
+
removeChannelVIP: (params: RemoveChannelVIPParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 403 | 404 | 422 | 429>;
|
|
16912
16280
|
/**
|
|
16913
16281
|
* Activates or deactivates the broadcaster’s Shield Mode.
|
|
16914
16282
|
*
|
|
@@ -16949,7 +16317,7 @@ declare class TwitchApi {
|
|
|
16949
16317
|
*
|
|
16950
16318
|
* @see https://dev.twitch.tv/docs/api/reference#update-shield-mode-status
|
|
16951
16319
|
*/
|
|
16952
|
-
updateShieldModeStatus: (params: UpdateShieldModeStatusParams, body: UpdateShieldModeStatusBody, options?: CallApiOptions[
|
|
16320
|
+
updateShieldModeStatus: (params: UpdateShieldModeStatusParams, body: UpdateShieldModeStatusBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
16953
16321
|
data: {
|
|
16954
16322
|
is_active: boolean;
|
|
16955
16323
|
moderator_id: string;
|
|
@@ -16996,7 +16364,7 @@ declare class TwitchApi {
|
|
|
16996
16364
|
*
|
|
16997
16365
|
* @see https://dev.twitch.tv/docs/api/reference#get-shield-mode-status
|
|
16998
16366
|
*/
|
|
16999
|
-
getShieldModeStatus: (params: GetShieldModeStatusParams, options?: CallApiOptions[
|
|
16367
|
+
getShieldModeStatus: (params: GetShieldModeStatusParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17000
16368
|
data: {
|
|
17001
16369
|
is_active: boolean;
|
|
17002
16370
|
moderator_id: string;
|
|
@@ -17057,7 +16425,7 @@ declare class TwitchApi {
|
|
|
17057
16425
|
*
|
|
17058
16426
|
* @see https://dev.twitch.tv/docs/api/reference#warn-chat-user
|
|
17059
16427
|
*/
|
|
17060
|
-
warnChatUser: (params: WarnChatUserParams, body: WarnChatUserBody, options?: CallApiOptions[
|
|
16428
|
+
warnChatUser: (params: WarnChatUserParams, body: WarnChatUserBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17061
16429
|
data: {
|
|
17062
16430
|
broadcaster_id: string;
|
|
17063
16431
|
user_id: string;
|
|
@@ -17104,29 +16472,8 @@ declare class TwitchApi {
|
|
|
17104
16472
|
*
|
|
17105
16473
|
* @see https://dev.twitch.tv/docs/api/reference#get-polls
|
|
17106
16474
|
*/
|
|
17107
|
-
getPolls: (params: GetPollsParams, options?: CallApiOptions[
|
|
17108
|
-
data:
|
|
17109
|
-
id: string;
|
|
17110
|
-
broadcaster_id: string;
|
|
17111
|
-
broadcaster_name: string;
|
|
17112
|
-
broadcaster_login: string;
|
|
17113
|
-
title: string;
|
|
17114
|
-
choices: {
|
|
17115
|
-
id: string;
|
|
17116
|
-
title: string;
|
|
17117
|
-
votes: number;
|
|
17118
|
-
channel_points_votes: number;
|
|
17119
|
-
bits_votes: number;
|
|
17120
|
-
}[];
|
|
17121
|
-
bits_voting_enabled: boolean;
|
|
17122
|
-
bits_per_vote: number;
|
|
17123
|
-
channel_points_voting_enabled: boolean;
|
|
17124
|
-
channel_points_per_vote: number;
|
|
17125
|
-
status: "ACTIVE" | "COMPLETED" | "TERMINATED" | "ARCHIVED" | "MODERATED" | "INVALID";
|
|
17126
|
-
duration: number;
|
|
17127
|
-
started_at: string;
|
|
17128
|
-
ended_at: string | null;
|
|
17129
|
-
}[];
|
|
16475
|
+
getPolls: (params: GetPollsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
16476
|
+
data: components["schemas"]["Poll"][];
|
|
17130
16477
|
pagination?: {
|
|
17131
16478
|
cursor?: string;
|
|
17132
16479
|
};
|
|
@@ -17175,29 +16522,8 @@ declare class TwitchApi {
|
|
|
17175
16522
|
*
|
|
17176
16523
|
* @see https://dev.twitch.tv/docs/api/reference#create-poll
|
|
17177
16524
|
*/
|
|
17178
|
-
createPoll: (body: CreatePollBody, options?: CallApiOptions[
|
|
17179
|
-
data:
|
|
17180
|
-
id: string;
|
|
17181
|
-
broadcaster_id: string;
|
|
17182
|
-
broadcaster_name: string;
|
|
17183
|
-
broadcaster_login: string;
|
|
17184
|
-
title: string;
|
|
17185
|
-
choices: {
|
|
17186
|
-
id: string;
|
|
17187
|
-
title: string;
|
|
17188
|
-
votes: number;
|
|
17189
|
-
channel_points_votes: number;
|
|
17190
|
-
bits_votes: number;
|
|
17191
|
-
}[];
|
|
17192
|
-
bits_voting_enabled: boolean;
|
|
17193
|
-
bits_per_vote: number;
|
|
17194
|
-
channel_points_voting_enabled: boolean;
|
|
17195
|
-
channel_points_per_vote: number;
|
|
17196
|
-
status: "ACTIVE" | "COMPLETED" | "TERMINATED" | "ARCHIVED" | "MODERATED" | "INVALID";
|
|
17197
|
-
duration: number;
|
|
17198
|
-
started_at: string;
|
|
17199
|
-
ended_at: string | null;
|
|
17200
|
-
}[];
|
|
16525
|
+
createPoll: (body: CreatePollBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
16526
|
+
data: components["schemas"]["Poll"][];
|
|
17201
16527
|
}, 200, 400 | 401>;
|
|
17202
16528
|
/**
|
|
17203
16529
|
* Ends an active poll. You have the option to end it or end it and archive it.
|
|
@@ -17234,29 +16560,8 @@ declare class TwitchApi {
|
|
|
17234
16560
|
*
|
|
17235
16561
|
* @see https://dev.twitch.tv/docs/api/reference#end-poll
|
|
17236
16562
|
*/
|
|
17237
|
-
endPoll: (body: EndPollBody, options?: CallApiOptions[
|
|
17238
|
-
data:
|
|
17239
|
-
id: string;
|
|
17240
|
-
broadcaster_id: string;
|
|
17241
|
-
broadcaster_name: string;
|
|
17242
|
-
broadcaster_login: string;
|
|
17243
|
-
title: string;
|
|
17244
|
-
choices: {
|
|
17245
|
-
id: string;
|
|
17246
|
-
title: string;
|
|
17247
|
-
votes: number;
|
|
17248
|
-
channel_points_votes: number;
|
|
17249
|
-
bits_votes: number;
|
|
17250
|
-
}[];
|
|
17251
|
-
bits_voting_enabled: boolean;
|
|
17252
|
-
bits_per_vote: number;
|
|
17253
|
-
channel_points_voting_enabled: boolean;
|
|
17254
|
-
channel_points_per_vote: number;
|
|
17255
|
-
status: "ACTIVE" | "COMPLETED" | "TERMINATED" | "ARCHIVED" | "MODERATED" | "INVALID";
|
|
17256
|
-
duration: number;
|
|
17257
|
-
started_at: string;
|
|
17258
|
-
ended_at: string | null;
|
|
17259
|
-
}[];
|
|
16563
|
+
endPoll: (body: EndPollBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
16564
|
+
data: components["schemas"]["Poll"][];
|
|
17260
16565
|
}, 200, 400 | 401>;
|
|
17261
16566
|
};
|
|
17262
16567
|
predictions: {
|
|
@@ -17291,34 +16596,8 @@ declare class TwitchApi {
|
|
|
17291
16596
|
*
|
|
17292
16597
|
* @see https://dev.twitch.tv/docs/api/reference#get-predictions
|
|
17293
16598
|
*/
|
|
17294
|
-
getPredictions: (params: GetPredictionsParams, options?: CallApiOptions[
|
|
17295
|
-
data:
|
|
17296
|
-
id: string;
|
|
17297
|
-
broadcaster_id: string;
|
|
17298
|
-
broadcaster_name: string;
|
|
17299
|
-
broadcaster_login: string;
|
|
17300
|
-
title: string;
|
|
17301
|
-
winning_outcome_id: string | null;
|
|
17302
|
-
outcomes: {
|
|
17303
|
-
id: string;
|
|
17304
|
-
title: string;
|
|
17305
|
-
users: number;
|
|
17306
|
-
channel_points: number;
|
|
17307
|
-
top_predictors: {
|
|
17308
|
-
user_id: string;
|
|
17309
|
-
user_name: string;
|
|
17310
|
-
user_login: string;
|
|
17311
|
-
channel_points_used: number;
|
|
17312
|
-
channel_points_won: number;
|
|
17313
|
-
}[] | null;
|
|
17314
|
-
color: "BLUE" | "PINK";
|
|
17315
|
-
}[];
|
|
17316
|
-
prediction_window: number;
|
|
17317
|
-
status: "CANCELED" | "ACTIVE" | "LOCKED" | "RESOLVED";
|
|
17318
|
-
created_at: string;
|
|
17319
|
-
ended_at: string | null;
|
|
17320
|
-
locked_at: string | null;
|
|
17321
|
-
}[];
|
|
16599
|
+
getPredictions: (params: GetPredictionsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
16600
|
+
data: components["schemas"]["Prediction"][];
|
|
17322
16601
|
pagination?: {
|
|
17323
16602
|
cursor?: string;
|
|
17324
16603
|
};
|
|
@@ -17367,34 +16646,8 @@ declare class TwitchApi {
|
|
|
17367
16646
|
*
|
|
17368
16647
|
* @see https://dev.twitch.tv/docs/api/reference#create-prediction
|
|
17369
16648
|
*/
|
|
17370
|
-
createPrediction: (body: CreatePredictionBody, options?: CallApiOptions[
|
|
17371
|
-
data:
|
|
17372
|
-
id: string;
|
|
17373
|
-
broadcaster_id: string;
|
|
17374
|
-
broadcaster_name: string;
|
|
17375
|
-
broadcaster_login: string;
|
|
17376
|
-
title: string;
|
|
17377
|
-
winning_outcome_id: string | null;
|
|
17378
|
-
outcomes: {
|
|
17379
|
-
id: string;
|
|
17380
|
-
title: string;
|
|
17381
|
-
users: number;
|
|
17382
|
-
channel_points: number;
|
|
17383
|
-
top_predictors: {
|
|
17384
|
-
user_id: string;
|
|
17385
|
-
user_name: string;
|
|
17386
|
-
user_login: string;
|
|
17387
|
-
channel_points_used: number;
|
|
17388
|
-
channel_points_won: number;
|
|
17389
|
-
}[] | null;
|
|
17390
|
-
color: "BLUE" | "PINK";
|
|
17391
|
-
}[];
|
|
17392
|
-
prediction_window: number;
|
|
17393
|
-
status: "CANCELED" | "ACTIVE" | "LOCKED" | "RESOLVED";
|
|
17394
|
-
created_at: string;
|
|
17395
|
-
ended_at: string | null;
|
|
17396
|
-
locked_at: string | null;
|
|
17397
|
-
}[];
|
|
16649
|
+
createPrediction: (body: CreatePredictionBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
16650
|
+
data: components["schemas"]["Prediction"][];
|
|
17398
16651
|
}, 200, 400 | 401 | 429>;
|
|
17399
16652
|
/**
|
|
17400
16653
|
* Locks, resolves, or cancels a Channel Points Prediction.
|
|
@@ -17438,34 +16691,8 @@ declare class TwitchApi {
|
|
|
17438
16691
|
*
|
|
17439
16692
|
* @see https://dev.twitch.tv/docs/api/reference#end-prediction
|
|
17440
16693
|
*/
|
|
17441
|
-
endPrediction: (body: EndPredictionBody, options?: CallApiOptions[
|
|
17442
|
-
data:
|
|
17443
|
-
id: string;
|
|
17444
|
-
broadcaster_id: string;
|
|
17445
|
-
broadcaster_name: string;
|
|
17446
|
-
broadcaster_login: string;
|
|
17447
|
-
title: string;
|
|
17448
|
-
winning_outcome_id: string | null;
|
|
17449
|
-
outcomes: {
|
|
17450
|
-
id: string;
|
|
17451
|
-
title: string;
|
|
17452
|
-
users: number;
|
|
17453
|
-
channel_points: number;
|
|
17454
|
-
top_predictors: {
|
|
17455
|
-
user_id: string;
|
|
17456
|
-
user_name: string;
|
|
17457
|
-
user_login: string;
|
|
17458
|
-
channel_points_used: number;
|
|
17459
|
-
channel_points_won: number;
|
|
17460
|
-
}[] | null;
|
|
17461
|
-
color: "BLUE" | "PINK";
|
|
17462
|
-
}[];
|
|
17463
|
-
prediction_window: number;
|
|
17464
|
-
status: "CANCELED" | "ACTIVE" | "LOCKED" | "RESOLVED";
|
|
17465
|
-
created_at: string;
|
|
17466
|
-
ended_at: string | null;
|
|
17467
|
-
locked_at: string | null;
|
|
17468
|
-
}[];
|
|
16694
|
+
endPrediction: (body: EndPredictionBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
16695
|
+
data: components["schemas"]["Prediction"][];
|
|
17469
16696
|
}, 200, 400 | 401 | 404>;
|
|
17470
16697
|
};
|
|
17471
16698
|
raids: {
|
|
@@ -17525,7 +16752,7 @@ declare class TwitchApi {
|
|
|
17525
16752
|
*
|
|
17526
16753
|
* @see https://dev.twitch.tv/docs/api/reference#start-a-raid
|
|
17527
16754
|
*/
|
|
17528
|
-
startRaid: (params?: StartRaidParams | null | undefined, options?: CallApiOptions[
|
|
16755
|
+
startRaid: (params?: StartRaidParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17529
16756
|
data: {
|
|
17530
16757
|
created_at: string;
|
|
17531
16758
|
is_mature: boolean;
|
|
@@ -17574,7 +16801,7 @@ declare class TwitchApi {
|
|
|
17574
16801
|
*
|
|
17575
16802
|
* @see https://dev.twitch.tv/docs/api/reference#cancel-a-raid
|
|
17576
16803
|
*/
|
|
17577
|
-
cancelRaid: (params: CancelRaidParams, options?: CallApiOptions[
|
|
16804
|
+
cancelRaid: (params: CancelRaidParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 404 | 429>;
|
|
17578
16805
|
};
|
|
17579
16806
|
schedule: {
|
|
17580
16807
|
/**
|
|
@@ -17617,20 +16844,9 @@ declare class TwitchApi {
|
|
|
17617
16844
|
*
|
|
17618
16845
|
* @see https://dev.twitch.tv/docs/api/reference#get-channel-stream-schedule
|
|
17619
16846
|
*/
|
|
17620
|
-
getChannelStreamSchedule: (params: GetChannelStreamScheduleParams, options?: CallApiOptions[
|
|
16847
|
+
getChannelStreamSchedule: (params: GetChannelStreamScheduleParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17621
16848
|
data: {
|
|
17622
|
-
segments:
|
|
17623
|
-
id: string;
|
|
17624
|
-
start_time: string;
|
|
17625
|
-
end_time: string;
|
|
17626
|
-
title: string;
|
|
17627
|
-
canceled_until: string | null;
|
|
17628
|
-
category: {
|
|
17629
|
-
id: string;
|
|
17630
|
-
name: string;
|
|
17631
|
-
};
|
|
17632
|
-
is_recurring: boolean;
|
|
17633
|
-
}[];
|
|
16849
|
+
segments: components["schemas"]["ChannelStreamScheduleSegment"][];
|
|
17634
16850
|
broadcaster_id: string;
|
|
17635
16851
|
broadcaster_name: string;
|
|
17636
16852
|
broadcaster_login: string;
|
|
@@ -17673,7 +16889,7 @@ declare class TwitchApi {
|
|
|
17673
16889
|
*
|
|
17674
16890
|
* @see https://dev.twitch.tv/docs/api/reference#get-channel-icalendar
|
|
17675
16891
|
*/
|
|
17676
|
-
getChannelICalendar: (params: GetChannelICalendarParams, options?: CallApiOptions[
|
|
16892
|
+
getChannelICalendar: (params: GetChannelICalendarParams, options?: CallApiOptions["options"]) => ApiResponse<string, 200, 400>;
|
|
17677
16893
|
/**
|
|
17678
16894
|
* Updates the broadcaster’s schedule settings, such as scheduling a vacation.
|
|
17679
16895
|
*
|
|
@@ -17713,7 +16929,7 @@ declare class TwitchApi {
|
|
|
17713
16929
|
*
|
|
17714
16930
|
* @see https://dev.twitch.tv/docs/api/reference#update-channel-stream-schedule
|
|
17715
16931
|
*/
|
|
17716
|
-
updateChannelStreamSchedule: (params: UpdateChannelStreamScheduleParams, options?: CallApiOptions[
|
|
16932
|
+
updateChannelStreamSchedule: (params: UpdateChannelStreamScheduleParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 404>;
|
|
17717
16933
|
/**
|
|
17718
16934
|
* Adds a single or recurring broadcast to the broadcaster’s streaming schedule. For information about scheduling broadcasts, see [Stream Schedule](https://help.twitch.tv/s/article/channel-page-setup#Schedule).
|
|
17719
16935
|
*
|
|
@@ -17755,20 +16971,9 @@ declare class TwitchApi {
|
|
|
17755
16971
|
*
|
|
17756
16972
|
* @see https://dev.twitch.tv/docs/api/reference#create-channel-stream-schedule-segment
|
|
17757
16973
|
*/
|
|
17758
|
-
createChannelStreamScheduleSegment: (params: CreateChannelStreamScheduleSegmentParams, body: CreateChannelStreamScheduleSegmentBody, options?: CallApiOptions[
|
|
16974
|
+
createChannelStreamScheduleSegment: (params: CreateChannelStreamScheduleSegmentParams, body: CreateChannelStreamScheduleSegmentBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17759
16975
|
data: {
|
|
17760
|
-
segments:
|
|
17761
|
-
id: string;
|
|
17762
|
-
start_time: string;
|
|
17763
|
-
end_time: string;
|
|
17764
|
-
title: string;
|
|
17765
|
-
canceled_until: string | null;
|
|
17766
|
-
category: {
|
|
17767
|
-
id: string;
|
|
17768
|
-
name: string;
|
|
17769
|
-
};
|
|
17770
|
-
is_recurring: boolean;
|
|
17771
|
-
}[];
|
|
16976
|
+
segments: components["schemas"]["ChannelStreamScheduleSegment"][];
|
|
17772
16977
|
broadcaster_id: string;
|
|
17773
16978
|
broadcaster_name: string;
|
|
17774
16979
|
broadcaster_login: string;
|
|
@@ -17823,20 +17028,9 @@ declare class TwitchApi {
|
|
|
17823
17028
|
*
|
|
17824
17029
|
* @see https://dev.twitch.tv/docs/api/reference#update-channel-stream-schedule-segment
|
|
17825
17030
|
*/
|
|
17826
|
-
updateChannelStreamScheduleSegment: (params: UpdateChannelStreamScheduleSegmentParams, body?: UpdateChannelStreamScheduleSegmentBody | null | undefined, options?: CallApiOptions[
|
|
17031
|
+
updateChannelStreamScheduleSegment: (params: UpdateChannelStreamScheduleSegmentParams, body?: UpdateChannelStreamScheduleSegmentBody | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17827
17032
|
data: {
|
|
17828
|
-
segments:
|
|
17829
|
-
id: string;
|
|
17830
|
-
start_time: string;
|
|
17831
|
-
end_time: string;
|
|
17832
|
-
title: string;
|
|
17833
|
-
canceled_until: string | null;
|
|
17834
|
-
category: {
|
|
17835
|
-
id: string;
|
|
17836
|
-
name: string;
|
|
17837
|
-
};
|
|
17838
|
-
is_recurring: boolean;
|
|
17839
|
-
}[];
|
|
17033
|
+
segments: components["schemas"]["ChannelStreamScheduleSegment"][];
|
|
17840
17034
|
broadcaster_id: string;
|
|
17841
17035
|
broadcaster_name: string;
|
|
17842
17036
|
broadcaster_login: string;
|
|
@@ -17882,7 +17076,7 @@ declare class TwitchApi {
|
|
|
17882
17076
|
*
|
|
17883
17077
|
* @see https://dev.twitch.tv/docs/api/reference#delete-channel-stream-schedule-segment
|
|
17884
17078
|
*/
|
|
17885
|
-
deleteChannelStreamScheduleSegment: (params: DeleteChannelStreamScheduleSegmentParams, options?: CallApiOptions[
|
|
17079
|
+
deleteChannelStreamScheduleSegment: (params: DeleteChannelStreamScheduleSegmentParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401>;
|
|
17886
17080
|
};
|
|
17887
17081
|
search: {
|
|
17888
17082
|
/**
|
|
@@ -17916,12 +17110,11 @@ declare class TwitchApi {
|
|
|
17916
17110
|
*
|
|
17917
17111
|
* @see https://dev.twitch.tv/docs/api/reference#search-categories
|
|
17918
17112
|
*/
|
|
17919
|
-
searchCategories: (params: SearchCategoriesParams, options?: CallApiOptions[
|
|
17920
|
-
data:
|
|
17921
|
-
|
|
17922
|
-
|
|
17923
|
-
|
|
17924
|
-
}[];
|
|
17113
|
+
searchCategories: (params: SearchCategoriesParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17114
|
+
data: components["schemas"]["Category"][];
|
|
17115
|
+
pagination?: {
|
|
17116
|
+
cursor?: string;
|
|
17117
|
+
};
|
|
17925
17118
|
}, 200, 400 | 401>;
|
|
17926
17119
|
/**
|
|
17927
17120
|
* Gets the channels that match the specified query and have streamed content within the past 6 months.
|
|
@@ -17958,21 +17151,11 @@ declare class TwitchApi {
|
|
|
17958
17151
|
*
|
|
17959
17152
|
* @see https://dev.twitch.tv/docs/api/reference#search-channels
|
|
17960
17153
|
*/
|
|
17961
|
-
searchChannels: (params: SearchChannelsParams, options?: CallApiOptions[
|
|
17962
|
-
data:
|
|
17963
|
-
|
|
17964
|
-
|
|
17965
|
-
|
|
17966
|
-
game_id: string;
|
|
17967
|
-
game_name: string;
|
|
17968
|
-
id: string;
|
|
17969
|
-
is_live: boolean;
|
|
17970
|
-
tag_ids: string[];
|
|
17971
|
-
tags: string[];
|
|
17972
|
-
thumbnail_url: string;
|
|
17973
|
-
title: string;
|
|
17974
|
-
started_at: string;
|
|
17975
|
-
}[];
|
|
17154
|
+
searchChannels: (params: SearchChannelsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17155
|
+
data: components["schemas"]["Channel"][];
|
|
17156
|
+
pagination?: {
|
|
17157
|
+
cursor?: string;
|
|
17158
|
+
};
|
|
17976
17159
|
}, 200, 400 | 401>;
|
|
17977
17160
|
};
|
|
17978
17161
|
streams: {
|
|
@@ -18006,13 +17189,17 @@ declare class TwitchApi {
|
|
|
18006
17189
|
* * The access token is not valid.
|
|
18007
17190
|
* * The client ID specified in the Client-Id header must match the client ID specified in the access token.
|
|
18008
17191
|
*
|
|
17192
|
+
* _403 Forbidden_
|
|
17193
|
+
*
|
|
17194
|
+
* The user must complete additional steps in order to stream. Present the user with the returned error message.
|
|
17195
|
+
*
|
|
18009
17196
|
* @see https://dev.twitch.tv/docs/api/reference#get-stream-key
|
|
18010
17197
|
*/
|
|
18011
|
-
getStreamKey: (params: GetStreamKeyParams, options?: CallApiOptions[
|
|
17198
|
+
getStreamKey: (params: GetStreamKeyParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
18012
17199
|
data: {
|
|
18013
17200
|
stream_key: string;
|
|
18014
17201
|
}[];
|
|
18015
|
-
}, 200, 400 | 401>;
|
|
17202
|
+
}, 200, 400 | 401 | 403>;
|
|
18016
17203
|
/**
|
|
18017
17204
|
* Gets a list of all streams. The list is in descending order by the number of viewers watching the stream. Because viewers come and go during a stream, it’s possible to find duplicate or missing streams in the list as you page through the results.
|
|
18018
17205
|
*
|
|
@@ -18042,24 +17229,8 @@ declare class TwitchApi {
|
|
|
18042
17229
|
*
|
|
18043
17230
|
* @see https://dev.twitch.tv/docs/api/reference#get-streams
|
|
18044
17231
|
*/
|
|
18045
|
-
getStreams: (params?: GetStreamsParams | null | undefined, options?: CallApiOptions[
|
|
18046
|
-
data:
|
|
18047
|
-
id: string;
|
|
18048
|
-
user_id: string;
|
|
18049
|
-
user_login: string;
|
|
18050
|
-
user_name: string;
|
|
18051
|
-
game_id: string;
|
|
18052
|
-
game_name: string;
|
|
18053
|
-
type: "live";
|
|
18054
|
-
title: string;
|
|
18055
|
-
viewer_count: number;
|
|
18056
|
-
started_at: string;
|
|
18057
|
-
language: string;
|
|
18058
|
-
thumbnail_url: string;
|
|
18059
|
-
tag_ids: string[];
|
|
18060
|
-
tags: string[];
|
|
18061
|
-
is_mature: boolean;
|
|
18062
|
-
}[];
|
|
17232
|
+
getStreams: (params?: GetStreamsParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17233
|
+
data: components["schemas"]["Stream"][];
|
|
18063
17234
|
pagination?: {
|
|
18064
17235
|
cursor?: string;
|
|
18065
17236
|
};
|
|
@@ -18095,24 +17266,8 @@ declare class TwitchApi {
|
|
|
18095
17266
|
*
|
|
18096
17267
|
* @see https://dev.twitch.tv/docs/api/reference#get-followed-streams
|
|
18097
17268
|
*/
|
|
18098
|
-
getFollowedStreams: (params: GetFollowedStreamsParams, options?: CallApiOptions[
|
|
18099
|
-
data:
|
|
18100
|
-
id: string;
|
|
18101
|
-
user_id: string;
|
|
18102
|
-
user_login: string;
|
|
18103
|
-
user_name: string;
|
|
18104
|
-
game_id: string;
|
|
18105
|
-
game_name: string;
|
|
18106
|
-
type: "live";
|
|
18107
|
-
title: string;
|
|
18108
|
-
viewer_count: number;
|
|
18109
|
-
started_at: string;
|
|
18110
|
-
language: string;
|
|
18111
|
-
thumbnail_url: string;
|
|
18112
|
-
tag_ids: string[];
|
|
18113
|
-
tags: string[];
|
|
18114
|
-
is_mature: boolean;
|
|
18115
|
-
}[];
|
|
17269
|
+
getFollowedStreams: (params: GetFollowedStreamsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17270
|
+
data: components["schemas"]["Stream"][];
|
|
18116
17271
|
pagination?: {
|
|
18117
17272
|
cursor?: string;
|
|
18118
17273
|
};
|
|
@@ -18165,13 +17320,8 @@ declare class TwitchApi {
|
|
|
18165
17320
|
*
|
|
18166
17321
|
* @see https://dev.twitch.tv/docs/api/reference#create-stream-marker
|
|
18167
17322
|
*/
|
|
18168
|
-
createStreamMarker: (body: CreateStreamMarkerBody, options?: CallApiOptions[
|
|
18169
|
-
data:
|
|
18170
|
-
id: string;
|
|
18171
|
-
created_at: string;
|
|
18172
|
-
position_seconds: number;
|
|
18173
|
-
description: string;
|
|
18174
|
-
}[];
|
|
17323
|
+
createStreamMarker: (body: CreateStreamMarkerBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17324
|
+
data: components["schemas"]["StreamMarkerCreated"][];
|
|
18175
17325
|
}, 200, 400 | 401 | 403 | 404>;
|
|
18176
17326
|
/**
|
|
18177
17327
|
* Gets a list of markers from the user’s most recent stream or from the specified VOD/video. A marker is an arbitrary point in a live stream that the broadcaster or editor marked, so they can return to that spot later to create video highlights (see Video Producer, Highlights in the Twitch UX).
|
|
@@ -18211,21 +17361,8 @@ declare class TwitchApi {
|
|
|
18211
17361
|
*
|
|
18212
17362
|
* @see https://dev.twitch.tv/docs/api/reference#get-stream-markers
|
|
18213
17363
|
*/
|
|
18214
|
-
getStreamMarkers: (params?: GetStreamMarkersParams | null | undefined, options?: CallApiOptions[
|
|
18215
|
-
data:
|
|
18216
|
-
user_id: string;
|
|
18217
|
-
user_name: string;
|
|
18218
|
-
user_login: string;
|
|
18219
|
-
videos: Record<string, never>[];
|
|
18220
|
-
video_id: string;
|
|
18221
|
-
markers: {
|
|
18222
|
-
id: string;
|
|
18223
|
-
created_at: string;
|
|
18224
|
-
description: string;
|
|
18225
|
-
position_seconds: number;
|
|
18226
|
-
url: string;
|
|
18227
|
-
}[];
|
|
18228
|
-
}[];
|
|
17364
|
+
getStreamMarkers: (params?: GetStreamMarkersParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17365
|
+
data: components["schemas"]["StreamMarkers"][];
|
|
18229
17366
|
pagination?: {
|
|
18230
17367
|
cursor?: string;
|
|
18231
17368
|
};
|
|
@@ -18265,21 +17402,8 @@ declare class TwitchApi {
|
|
|
18265
17402
|
*
|
|
18266
17403
|
* @see https://dev.twitch.tv/docs/api/reference#get-broadcaster-subscriptions
|
|
18267
17404
|
*/
|
|
18268
|
-
getBroadcasterSubscriptions: (params: GetBroadcasterSubscriptionsParams, options?: CallApiOptions[
|
|
18269
|
-
data:
|
|
18270
|
-
broadcaster_id: string;
|
|
18271
|
-
broadcaster_login: string;
|
|
18272
|
-
broadcaster_name: string;
|
|
18273
|
-
gifter_id: string;
|
|
18274
|
-
gifter_login: string;
|
|
18275
|
-
gifter_name: string;
|
|
18276
|
-
is_gift: boolean;
|
|
18277
|
-
plan_name: string;
|
|
18278
|
-
tier: "1000" | "2000" | "3000";
|
|
18279
|
-
user_id: string;
|
|
18280
|
-
user_name: string;
|
|
18281
|
-
user_login: string;
|
|
18282
|
-
}[];
|
|
17405
|
+
getBroadcasterSubscriptions: (params: GetBroadcasterSubscriptionsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17406
|
+
data: components["schemas"]["BroadcasterSubscription"][];
|
|
18283
17407
|
pagination?: {
|
|
18284
17408
|
cursor?: string;
|
|
18285
17409
|
};
|
|
@@ -18324,17 +17448,8 @@ declare class TwitchApi {
|
|
|
18324
17448
|
*
|
|
18325
17449
|
* @see https://dev.twitch.tv/docs/api/reference#check-user-subscription
|
|
18326
17450
|
*/
|
|
18327
|
-
checkUserSubscription: (params: CheckUserSubscriptionParams, options?: CallApiOptions[
|
|
18328
|
-
data:
|
|
18329
|
-
broadcaster_id: string;
|
|
18330
|
-
broadcaster_login: string;
|
|
18331
|
-
broadcaster_name: string;
|
|
18332
|
-
gifter_id?: string;
|
|
18333
|
-
gifter_login?: string;
|
|
18334
|
-
gifter_name?: string;
|
|
18335
|
-
is_gift: boolean;
|
|
18336
|
-
tier: "1000" | "2000" | "3000";
|
|
18337
|
-
}[];
|
|
17451
|
+
checkUserSubscription: (params: CheckUserSubscriptionParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17452
|
+
data: components["schemas"]["UserSubscription"][];
|
|
18338
17453
|
}, 200, 400 | 401 | 404>;
|
|
18339
17454
|
};
|
|
18340
17455
|
tags: {
|
|
@@ -18370,17 +17485,8 @@ declare class TwitchApi {
|
|
|
18370
17485
|
*
|
|
18371
17486
|
* @see https://dev.twitch.tv/docs/api/reference#get-all-stream-tags
|
|
18372
17487
|
*/
|
|
18373
|
-
getAllStreamTags: (params?: GetAllStreamTagsParams | null | undefined, options?: CallApiOptions[
|
|
18374
|
-
data:
|
|
18375
|
-
tag_id: string;
|
|
18376
|
-
is_auto: boolean;
|
|
18377
|
-
localization_names: {
|
|
18378
|
-
[key: string]: string;
|
|
18379
|
-
};
|
|
18380
|
-
localization_descriptions: {
|
|
18381
|
-
[key: string]: string;
|
|
18382
|
-
};
|
|
18383
|
-
}[];
|
|
17488
|
+
getAllStreamTags: (params?: GetAllStreamTagsParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17489
|
+
data: components["schemas"]["StreamTag"][];
|
|
18384
17490
|
pagination?: {
|
|
18385
17491
|
cursor?: string;
|
|
18386
17492
|
};
|
|
@@ -18417,17 +17523,8 @@ declare class TwitchApi {
|
|
|
18417
17523
|
*
|
|
18418
17524
|
* @see https://dev.twitch.tv/docs/api/reference#get-stream-tags
|
|
18419
17525
|
*/
|
|
18420
|
-
getStreamTags: (params: GetStreamTagsParams, options?: CallApiOptions[
|
|
18421
|
-
data:
|
|
18422
|
-
tag_id: string;
|
|
18423
|
-
is_auto: boolean;
|
|
18424
|
-
localization_names: {
|
|
18425
|
-
[key: string]: string;
|
|
18426
|
-
};
|
|
18427
|
-
localization_descriptions: {
|
|
18428
|
-
[key: string]: string;
|
|
18429
|
-
};
|
|
18430
|
-
}[];
|
|
17526
|
+
getStreamTags: (params: GetStreamTagsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17527
|
+
data: components["schemas"]["StreamTag"][];
|
|
18431
17528
|
}, 200, 400 | 401>;
|
|
18432
17529
|
};
|
|
18433
17530
|
teams: {
|
|
@@ -18464,21 +17561,8 @@ declare class TwitchApi {
|
|
|
18464
17561
|
*
|
|
18465
17562
|
* @see https://dev.twitch.tv/docs/api/reference#get-channel-teams
|
|
18466
17563
|
*/
|
|
18467
|
-
getChannelTeams: (params: GetChannelTeamsParams, options?: CallApiOptions[
|
|
18468
|
-
data:
|
|
18469
|
-
broadcaster_id: string;
|
|
18470
|
-
broadcaster_login: string;
|
|
18471
|
-
broadcaster_name: string;
|
|
18472
|
-
background_image_url: string;
|
|
18473
|
-
banner: string;
|
|
18474
|
-
created_at: string;
|
|
18475
|
-
updated_at: string;
|
|
18476
|
-
info: string;
|
|
18477
|
-
thumbnail_url: string;
|
|
18478
|
-
team_name: string;
|
|
18479
|
-
team_display_name: string;
|
|
18480
|
-
id: string;
|
|
18481
|
-
}[];
|
|
17564
|
+
getChannelTeams: (params: GetChannelTeamsParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17565
|
+
data: components["schemas"]["ChannelTeam"][];
|
|
18482
17566
|
}, 200, 400 | 401 | 404>;
|
|
18483
17567
|
/**
|
|
18484
17568
|
* Gets information about the specified Twitch team. [Read More](https://help.twitch.tv/s/article/twitch-teams)
|
|
@@ -18515,23 +17599,8 @@ declare class TwitchApi {
|
|
|
18515
17599
|
*
|
|
18516
17600
|
* @see https://dev.twitch.tv/docs/api/reference#get-teams
|
|
18517
17601
|
*/
|
|
18518
|
-
getTeams: (params?: GetTeamsParams | null | undefined, options?: CallApiOptions[
|
|
18519
|
-
data:
|
|
18520
|
-
users: {
|
|
18521
|
-
user_id: string;
|
|
18522
|
-
user_login: string;
|
|
18523
|
-
user_name: string;
|
|
18524
|
-
}[];
|
|
18525
|
-
background_image_url: string;
|
|
18526
|
-
banner: string;
|
|
18527
|
-
created_at: string;
|
|
18528
|
-
updated_at: string;
|
|
18529
|
-
info: string;
|
|
18530
|
-
thumbnail_url: string;
|
|
18531
|
-
team_name: string;
|
|
18532
|
-
team_display_name: string;
|
|
18533
|
-
id: string;
|
|
18534
|
-
}[];
|
|
17602
|
+
getTeams: (params?: GetTeamsParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17603
|
+
data: components["schemas"]["Team"][];
|
|
18535
17604
|
}, 200, 400 | 401 | 404>;
|
|
18536
17605
|
};
|
|
18537
17606
|
users: {
|
|
@@ -18571,20 +17640,8 @@ declare class TwitchApi {
|
|
|
18571
17640
|
*
|
|
18572
17641
|
* @see https://dev.twitch.tv/docs/api/reference#get-users
|
|
18573
17642
|
*/
|
|
18574
|
-
getUsers: (params?: GetUsersParams | null | undefined, options?: CallApiOptions[
|
|
18575
|
-
data:
|
|
18576
|
-
id: string;
|
|
18577
|
-
login: string;
|
|
18578
|
-
display_name: string;
|
|
18579
|
-
type: "" | "admin" | "global_mod" | "staff";
|
|
18580
|
-
broadcaster_type: "" | "affiliate" | "partner";
|
|
18581
|
-
description: string;
|
|
18582
|
-
profile_image_url: string;
|
|
18583
|
-
offline_image_url: string;
|
|
18584
|
-
view_count: number;
|
|
18585
|
-
email?: string;
|
|
18586
|
-
created_at: string;
|
|
18587
|
-
}[];
|
|
17643
|
+
getUsers: (params?: GetUsersParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17644
|
+
data: components["schemas"]["User"][];
|
|
18588
17645
|
}, 200, 400 | 401>;
|
|
18589
17646
|
/**
|
|
18590
17647
|
* Updates the specified user’s information. The user ID in the OAuth token identifies the user whose information you want to update.
|
|
@@ -18618,20 +17675,8 @@ declare class TwitchApi {
|
|
|
18618
17675
|
*
|
|
18619
17676
|
* @see https://dev.twitch.tv/docs/api/reference#update-user
|
|
18620
17677
|
*/
|
|
18621
|
-
updateUser: (params?: UpdateUserParams | null | undefined, options?: CallApiOptions[
|
|
18622
|
-
data:
|
|
18623
|
-
id: string;
|
|
18624
|
-
login: string;
|
|
18625
|
-
display_name: string;
|
|
18626
|
-
type: "" | "admin" | "global_mod" | "staff";
|
|
18627
|
-
broadcaster_type: "" | "affiliate" | "partner";
|
|
18628
|
-
description: string;
|
|
18629
|
-
profile_image_url: string;
|
|
18630
|
-
offline_image_url: string;
|
|
18631
|
-
view_count: number;
|
|
18632
|
-
email?: string;
|
|
18633
|
-
created_at: string;
|
|
18634
|
-
}[];
|
|
17678
|
+
updateUser: (params?: UpdateUserParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17679
|
+
data: components["schemas"]["User"][];
|
|
18635
17680
|
}, 200, 400 | 401>;
|
|
18636
17681
|
/**
|
|
18637
17682
|
* Gets the list of users that the broadcaster has blocked. [Read More](https://help.twitch.tv/s/article/how-to-manage-harassment-in-chat?language=en%5FUS#BlockWhispersandMessagesfromStrangers)
|
|
@@ -18664,12 +17709,11 @@ declare class TwitchApi {
|
|
|
18664
17709
|
*
|
|
18665
17710
|
* @see https://dev.twitch.tv/docs/api/reference#get-user-block-list
|
|
18666
17711
|
*/
|
|
18667
|
-
getUserBlockList: (params: GetUserBlockListParams, options?: CallApiOptions[
|
|
18668
|
-
data:
|
|
18669
|
-
|
|
18670
|
-
|
|
18671
|
-
|
|
18672
|
-
}[];
|
|
17712
|
+
getUserBlockList: (params: GetUserBlockListParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17713
|
+
data: components["schemas"]["UserBlockList"][];
|
|
17714
|
+
pagination?: {
|
|
17715
|
+
cursor?: string;
|
|
17716
|
+
};
|
|
18673
17717
|
}, 200, 400 | 401>;
|
|
18674
17718
|
/**
|
|
18675
17719
|
* Blocks the specified user from interacting with or having contact with the broadcaster. The user ID in the OAuth token identifies the broadcaster who is blocking the user.
|
|
@@ -18706,7 +17750,7 @@ declare class TwitchApi {
|
|
|
18706
17750
|
*
|
|
18707
17751
|
* @see https://dev.twitch.tv/docs/api/reference#block-user
|
|
18708
17752
|
*/
|
|
18709
|
-
blockUser: (params: BlockUserParams, options?: CallApiOptions[
|
|
17753
|
+
blockUser: (params: BlockUserParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401>;
|
|
18710
17754
|
/**
|
|
18711
17755
|
* Removes the user from the broadcaster’s list of blocked users. The user ID in the OAuth token identifies the broadcaster who’s removing the block.
|
|
18712
17756
|
*
|
|
@@ -18737,7 +17781,7 @@ declare class TwitchApi {
|
|
|
18737
17781
|
*
|
|
18738
17782
|
* @see https://dev.twitch.tv/docs/api/reference#unblock-user
|
|
18739
17783
|
*/
|
|
18740
|
-
unblockUser: (params: UnblockUserParams, options?: CallApiOptions[
|
|
17784
|
+
unblockUser: (params: UnblockUserParams, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401>;
|
|
18741
17785
|
/**
|
|
18742
17786
|
* Gets a list of all extensions (both active and inactive) that the broadcaster has installed. The user ID in the access token identifies the broadcaster.
|
|
18743
17787
|
*
|
|
@@ -18764,14 +17808,8 @@ declare class TwitchApi {
|
|
|
18764
17808
|
*
|
|
18765
17809
|
* @see https://dev.twitch.tv/docs/api/reference#get-user-extensions
|
|
18766
17810
|
*/
|
|
18767
|
-
getUserExtensions: (options?: CallApiOptions[
|
|
18768
|
-
data:
|
|
18769
|
-
id: string;
|
|
18770
|
-
version: string;
|
|
18771
|
-
name: string;
|
|
18772
|
-
can_activate: boolean;
|
|
18773
|
-
type: ("component" | "mobile" | "overlay" | "panel")[];
|
|
18774
|
-
}[];
|
|
17811
|
+
getUserExtensions: (options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17812
|
+
data: components["schemas"]["UserExtension"][];
|
|
18775
17813
|
}, 200, 401>;
|
|
18776
17814
|
/**
|
|
18777
17815
|
* Gets the active extensions that the broadcaster has installed for each configuration.
|
|
@@ -18804,33 +17842,16 @@ declare class TwitchApi {
|
|
|
18804
17842
|
*
|
|
18805
17843
|
* @see https://dev.twitch.tv/docs/api/reference#get-user-active-extensions
|
|
18806
17844
|
*/
|
|
18807
|
-
getUserActiveExtensions: (params?: GetUserActiveExtensionsParams | null | undefined, options?: CallApiOptions[
|
|
17845
|
+
getUserActiveExtensions: (params?: GetUserActiveExtensionsParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
18808
17846
|
data?: {
|
|
18809
17847
|
panel?: {
|
|
18810
|
-
[key: string]:
|
|
18811
|
-
active: boolean;
|
|
18812
|
-
id?: string;
|
|
18813
|
-
version?: string;
|
|
18814
|
-
name?: string;
|
|
18815
|
-
};
|
|
17848
|
+
[key: string]: components["schemas"]["UserExtensionPanel"];
|
|
18816
17849
|
};
|
|
18817
17850
|
overlay?: {
|
|
18818
|
-
[key: string]:
|
|
18819
|
-
active: boolean;
|
|
18820
|
-
id?: string;
|
|
18821
|
-
version?: string;
|
|
18822
|
-
name?: string;
|
|
18823
|
-
};
|
|
17851
|
+
[key: string]: components["schemas"]["UserExtensionOverlay"];
|
|
18824
17852
|
};
|
|
18825
17853
|
component?: {
|
|
18826
|
-
[key: string]:
|
|
18827
|
-
active: boolean;
|
|
18828
|
-
id?: string;
|
|
18829
|
-
version?: string;
|
|
18830
|
-
name?: string;
|
|
18831
|
-
x?: number;
|
|
18832
|
-
y?: number;
|
|
18833
|
-
};
|
|
17854
|
+
[key: string]: components["schemas"]["UserExtensionComponent"];
|
|
18834
17855
|
};
|
|
18835
17856
|
};
|
|
18836
17857
|
}, 200, 400 | 401>;
|
|
@@ -18870,33 +17891,16 @@ declare class TwitchApi {
|
|
|
18870
17891
|
*
|
|
18871
17892
|
* @see https://dev.twitch.tv/docs/api/reference#update-user-extensions
|
|
18872
17893
|
*/
|
|
18873
|
-
updateUserExtensions: (body: UpdateUserExtensionsBody, options?: CallApiOptions[
|
|
17894
|
+
updateUserExtensions: (body: UpdateUserExtensionsBody, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
18874
17895
|
data: {
|
|
18875
17896
|
panel: {
|
|
18876
|
-
[key: string]:
|
|
18877
|
-
active: boolean;
|
|
18878
|
-
id?: string;
|
|
18879
|
-
version?: string;
|
|
18880
|
-
name?: string;
|
|
18881
|
-
};
|
|
17897
|
+
[key: string]: components["schemas"]["UserExtensionPanel"];
|
|
18882
17898
|
};
|
|
18883
17899
|
overlay: {
|
|
18884
|
-
[key: string]:
|
|
18885
|
-
active: boolean;
|
|
18886
|
-
id?: string;
|
|
18887
|
-
version?: string;
|
|
18888
|
-
name?: string;
|
|
18889
|
-
};
|
|
17900
|
+
[key: string]: components["schemas"]["UserExtensionOverlay"];
|
|
18890
17901
|
};
|
|
18891
17902
|
component: {
|
|
18892
|
-
[key: string]:
|
|
18893
|
-
active: boolean;
|
|
18894
|
-
id?: string;
|
|
18895
|
-
version?: string;
|
|
18896
|
-
name?: string;
|
|
18897
|
-
x?: number;
|
|
18898
|
-
y?: number;
|
|
18899
|
-
};
|
|
17903
|
+
[key: string]: components["schemas"]["UserExtensionComponent"];
|
|
18900
17904
|
};
|
|
18901
17905
|
};
|
|
18902
17906
|
}, 200, 400 | 401 | 404>;
|
|
@@ -18944,29 +17948,8 @@ declare class TwitchApi {
|
|
|
18944
17948
|
*
|
|
18945
17949
|
* @see https://dev.twitch.tv/docs/api/reference#get-videos
|
|
18946
17950
|
*/
|
|
18947
|
-
getVideos: (params?: GetVideosParams | null | undefined, options?: CallApiOptions[
|
|
18948
|
-
data:
|
|
18949
|
-
id: string;
|
|
18950
|
-
stream_id: string | null;
|
|
18951
|
-
user_id: string;
|
|
18952
|
-
user_login: string;
|
|
18953
|
-
user_name: string;
|
|
18954
|
-
title: string;
|
|
18955
|
-
description: string;
|
|
18956
|
-
created_at: string;
|
|
18957
|
-
published_at: string;
|
|
18958
|
-
url: string;
|
|
18959
|
-
thumbnail_url: string;
|
|
18960
|
-
viewable: string;
|
|
18961
|
-
view_count: number;
|
|
18962
|
-
language: string;
|
|
18963
|
-
type: "archive" | "highlight" | "upload";
|
|
18964
|
-
duration: string;
|
|
18965
|
-
muted_segments: {
|
|
18966
|
-
duration: number;
|
|
18967
|
-
offset: number;
|
|
18968
|
-
}[] | null;
|
|
18969
|
-
}[];
|
|
17951
|
+
getVideos: (params?: GetVideosParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17952
|
+
data: components["schemas"]["Video"][];
|
|
18970
17953
|
pagination?: {
|
|
18971
17954
|
cursor?: string;
|
|
18972
17955
|
};
|
|
@@ -19003,7 +17986,7 @@ declare class TwitchApi {
|
|
|
19003
17986
|
*
|
|
19004
17987
|
* @see https://dev.twitch.tv/docs/api/reference#delete-videos
|
|
19005
17988
|
*/
|
|
19006
|
-
deleteVideos: (params: DeleteVideosParams, options?: CallApiOptions[
|
|
17989
|
+
deleteVideos: (params: DeleteVideosParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
19007
17990
|
data: string[];
|
|
19008
17991
|
}, 200, 400 | 401>;
|
|
19009
17992
|
};
|
|
@@ -19064,8 +18047,8 @@ declare class TwitchApi {
|
|
|
19064
18047
|
*
|
|
19065
18048
|
* @see https://dev.twitch.tv/docs/api/reference#send-whisper
|
|
19066
18049
|
*/
|
|
19067
|
-
sendWhisper: (params: SendWhisperParams, body: SendWhisperBody, options?: CallApiOptions[
|
|
18050
|
+
sendWhisper: (params: SendWhisperParams, body: SendWhisperBody, options?: CallApiOptions["options"]) => ApiResponse<void, 204, 400 | 401 | 403 | 404 | 429>;
|
|
19068
18051
|
};
|
|
19069
18052
|
}
|
|
19070
18053
|
|
|
19071
|
-
export { type AddBlockedTermBody, type AddBlockedTermParams, type AddBlockedTermResponse, type AddChannelModeratorParams, type AddChannelVIPParams, type ApiResponse, type AssignGuestStarSlotParams, type AutoModSettings, type AutoModStatus, type BanUserBody, type BanUserParams, type BanUserResponse, type BannedUser, type BitsLeaderboard, type BlockUserParams, type BlockedTerm, type BroadcasterSubscription, type CancelRaidParams, type Category, type Channel, type ChannelEditor, type ChannelEmote, type ChannelInformation, type ChannelStreamScheduleSegment, type ChannelTeam, type CharityCampaign, type CharityCampaignDonation, type ChatBadge, type ChatSettings, type ChatSettingsUpdated, type Chatter, type CheckAutoModStatusBody, type CheckAutoModStatusParams, type CheckAutoModStatusResponse, type CheckUserSubscriptionParams, type CheckUserSubscriptionResponse, type Cheermote, type CheermoteImageFormat, type CheermoteImageTheme, type CheermoteImages, type Clip, type ContentClassificationLabel, type CreateChannelStreamScheduleSegmentBody, type CreateChannelStreamScheduleSegmentParams, type CreateChannelStreamScheduleSegmentResponse, type CreateClipParams, type CreateClipResponse, type CreateConduitsBody, type CreateConduitsResponse, type CreateCustomRewardsBody, type CreateCustomRewardsParams, type CreateCustomRewardsResponse, type CreateEventSubSubscriptionBody, type CreateEventSubSubscriptionResponse, type CreateExtensionSecretParams, type CreateExtensionSecretResponse, type CreateGuestStarSessionParams, type CreateGuestStarSessionResponse, type CreatePollBody, type CreatePollResponse, type CreatePredictionBody, type CreatePredictionResponse, type CreateStreamMarkerBody, type CreateStreamMarkerResponse, type CreatorGoal, type CustomReward, type CustomRewardRedemption, type DeleteChannelStreamScheduleSegmentParams, type DeleteChatMessagesParams, type DeleteConduitParams, type DeleteCustomRewardParams, type DeleteEventSubSubscriptionParams, type DeleteGuestStarInviteParams, type DeleteGuestStarSlotParams, type DeleteVideosParams, type DeleteVideosResponse, type DropsEntitlement, type DropsEntitlementUpdated, type Emote, type EndGuestStarSessionParams, type EndGuestStarSessionResponse, type EndPollBody, type EndPollResponse, type EndPredictionBody, type EndPredictionResponse, type EventSubSubscription, type Extension, type ExtensionAnalytics, type ExtensionBitsProduct, type ExtensionConfigurationSegment, type ExtensionIconUrls, type ExtensionLiveChannel, type ExtensionSecret, type ExtensionTransaction, type Game, type GameAnalytics, type GetAdScheduleParams, type GetAdScheduleResponse, type GetAllStreamTagsParams, type GetAllStreamTagsResponse, type GetAutoModSettingsParams, type GetAutoModSettingsResponse, type GetBannedUsersParams, type GetBannedUsersResponse, type GetBitsLeaderboardParams, type GetBitsLeaderboardResponse, type GetBlockedTermsParams, type GetBlockedTermsResponse, type GetBroadcasterSubscriptionsParams, type GetBroadcasterSubscriptionsResponse, type GetChannelChatBadgesParams, type GetChannelChatBadgesResponse, type GetChannelEditorsParams, type GetChannelEditorsResponse, type GetChannelEmotesParams, type GetChannelEmotesResponse, type GetChannelFollowersParams, type GetChannelFollowersResponse, type GetChannelGuestStarSettingsParams, type GetChannelGuestStarSettingsResponse, type GetChannelICalendarParams, type GetChannelInformationParams, type GetChannelInformationResponse, type GetChannelStreamScheduleParams, type GetChannelStreamScheduleResponse, type GetChannelTeamsParams, type GetChannelTeamsResponse, type GetCharityCampaignDonationsParams, type GetCharityCampaignDonationsResponse, type GetCharityCampaignParams, type GetCharityCampaignResponse, type GetChatSettingsParams, type GetChatSettingsResponse, type GetChattersParams, type GetChattersResponse, type GetCheermotesParams, type GetCheermotesResponse, type GetClipsParams, type GetClipsResponse, type GetConduitShardsParams, type GetConduitShardsResponse, type GetConduitsResponse, type GetContentClassificationLabelsParams, type GetContentClassificationLabelsResponse, type GetCreatorGoalsParams, type GetCreatorGoalsResponse, type GetCustomRewardParams, type GetCustomRewardRedemptionParams, type GetCustomRewardRedemptionResponse, type GetCustomRewardResponse, type GetDropsEntitlementsParams, type GetDropsEntitlementsResponse, type GetEmoteSetsParams, type GetEmoteSetsResponse, type GetEventSubSubscriptionsParams, type GetEventSubSubscriptionsResponse, type GetExtensionAnalyticsParams, type GetExtensionAnalyticsResponse, type GetExtensionBitsProductsParams, type GetExtensionBitsProductsResponse, type GetExtensionConfigurationSegmentParams, type GetExtensionConfigurationSegmentResponse, type GetExtensionLiveChannelsParams, type GetExtensionLiveChannelsResponse, type GetExtensionSecretsResponse, type GetExtensionTransactionsParams, type GetExtensionTransactionsResponse, type GetExtensionsParams, type GetExtensionsResponse, type GetFollowedChannelsParams, type GetFollowedChannelsResponse, type GetFollowedStreamsParams, type GetFollowedStreamsResponse, type GetGameAnalyticsParams, type GetGameAnalyticsResponse, type GetGamesParams, type GetGamesResponse, type GetGlobalChatBadgesResponse, type GetGlobalEmotesResponse, type GetGuestStarInvitesParams, type GetGuestStarInvitesResponse, type GetGuestStarSessionParams, type GetGuestStarSessionResponse, type GetHypeTrainEventsParams, type GetHypeTrainEventsResponse, type GetModeratedChannelsParams, type GetModeratedChannelsResponse, type GetModeratorsParams, type GetModeratorsResponse, type GetPollsParams, type GetPollsResponse, type GetPredictionsParams, type GetPredictionsResponse, type GetReleasedExtensionsParams, type GetReleasedExtensionsResponse, type GetShieldModeStatusParams, type GetShieldModeStatusResponse, type GetStreamKeyParams, type GetStreamKeyResponse, type GetStreamMarkersParams, type GetStreamMarkersResponse, type GetStreamTagsParams, type GetStreamTagsResponse, type GetStreamsParams, type GetStreamsResponse, type GetTeamsParams, type GetTeamsResponse, type GetTopGamesParams, type GetTopGamesResponse, type GetUnbanRequestsParams, type GetUnbanRequestsResponse, type GetUserActiveExtensionsParams, type GetUserActiveExtensionsResponse, type GetUserBlockListParams, type GetUserBlockListResponse, type GetUserChatColorParams, type GetUserChatColorResponse, type GetUserEmotesParams, type GetUserEmotesResponse, type GetUserExtensionsResponse, type GetUsersParams, type GetUsersResponse, type GetVIPsParams, type GetVIPsResponse, type GetVideosParams, type GetVideosResponse, type GlobalEmote, type Guest, type GuestStarInvite, type GuestStarSession, type HypeTrainEvent, type ManageHeldAutoModMessagesBody, type ModifyChannelInformationBody, type ModifyChannelInformationParams, type Poll, type Prediction, type PredictionOutcome, type RemoveBlockedTermParams, type RemoveChannelModeratorParams, type RemoveChannelVIPParams, type ResolveUnbanRequestsParams, type ResolveUnbanRequestsResponse, type SearchCategoriesParams, type SearchCategoriesResponse, type SearchChannelsParams, type SearchChannelsResponse, type SendChatAnnouncementBody, type SendChatAnnouncementParams, type SendChatMessageBody, type SendChatMessageResponse, type SendExtensionChatMessageBody, type SendExtensionChatMessageParams, type SendExtensionPubSubMessageBody, type SendGuestStarInviteParams, type SendShoutoutParams, type SendWhisperBody, type SendWhisperParams, type SetExtensionConfigurationSegmentBody, type SetExtensionRequiredConfigurationBody, type SetExtensionRequiredConfigurationParams, type SnoozeNextAdParams, type SnoozeNextAdResponse, type StartCommercialBody, type StartCommercialResponse, type StartRaidParams, type StartRaidResponse, type Stream, type StreamMarkerCreated, type StreamMarkers, type StreamTag, type Team, TwitchApi, type TwitchApiOptions, type UnbanUserParams, type UnblockUserParams, type UpdateAutoModSettingsBody, type UpdateAutoModSettingsParams, type UpdateAutoModSettingsResponse, type UpdateChannelGuestStarSettingsBody, type UpdateChannelGuestStarSettingsParams, type UpdateChannelStreamScheduleParams, type UpdateChannelStreamScheduleSegmentBody, type UpdateChannelStreamScheduleSegmentParams, type UpdateChannelStreamScheduleSegmentResponse, type UpdateChatSettingsBody, type UpdateChatSettingsParams, type UpdateChatSettingsResponse, type UpdateConduitShardsBody, type UpdateConduitShardsResponse, type UpdateConduitsBody, type UpdateConduitsResponse, type UpdateCustomRewardBody, type UpdateCustomRewardParams, type UpdateCustomRewardResponse, type UpdateDropsEntitlementsBody, type UpdateDropsEntitlementsResponse, type UpdateExtensionBitsProductBody, type UpdateExtensionBitsProductResponse, type UpdateGuestStarSlotParams, type UpdateGuestStarSlotSettingsParams, type UpdateRedemptionStatusBody, type UpdateRedemptionStatusParams, type UpdateRedemptionStatusResponse, type UpdateShieldModeStatusBody, type UpdateShieldModeStatusParams, type UpdateShieldModeStatusResponse, type UpdateUserChatColorParams, type UpdateUserExtensionsBody, type UpdateUserExtensionsResponse, type UpdateUserParams, type UpdateUserResponse, type User, type UserBlockList, type UserChatColor, type UserExtension, type UserExtensionComponent, type UserExtensionComponentUpdate, type UserExtensionOverlay, type UserExtensionOverlayUpdate, type UserExtensionPanel, type UserExtensionPanelUpdate, type UserModerator, type UserSubscription, type UserVip, type Video, type WarnChatUserBody, type WarnChatUserParams, type WarnChatUserResponse };
|
|
18054
|
+
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 GetSharedChatSessionParams, type GetSharedChatSessionResponse, type GetShieldModeStatusParams, type GetShieldModeStatusResponse, type GetStreamKeyParams, type GetStreamKeyResponse, type GetStreamMarkersParams, type GetStreamMarkersResponse, type GetStreamTagsParams, type GetStreamTagsResponse, type GetStreamsParams, type GetStreamsResponse, type GetTeamsParams, type GetTeamsResponse, type GetTopGamesParams, type GetTopGamesResponse, type GetUnbanRequestsParams, type GetUnbanRequestsResponse, type GetUserActiveExtensionsParams, type GetUserActiveExtensionsResponse, type GetUserBlockListParams, type GetUserBlockListResponse, type GetUserChatColorParams, type GetUserChatColorResponse, type GetUserEmotesParams, type GetUserEmotesResponse, type GetUserExtensionsResponse, type GetUsersParams, type GetUsersResponse, type GetVIPsParams, type GetVIPsResponse, type GetVideosParams, type GetVideosResponse, type GlobalEmote, type Guest, type GuestStarInvite, type GuestStarSession, type HypeTrainEvent, type ManageHeldAutoModMessagesBody, type ModifyChannelInformationBody, type ModifyChannelInformationParams, type Poll, type Prediction, type PredictionOutcome, type RemoveBlockedTermParams, type RemoveChannelModeratorParams, type RemoveChannelVIPParams, type ResolveUnbanRequestsParams, type ResolveUnbanRequestsResponse, type SearchCategoriesParams, type SearchCategoriesResponse, type SearchChannelsParams, type SearchChannelsResponse, type SendChatAnnouncementBody, type SendChatAnnouncementParams, type SendChatMessageBody, type SendChatMessageResponse, type SendExtensionChatMessageBody, type SendExtensionChatMessageParams, type SendExtensionPubSubMessageBody, type SendGuestStarInviteParams, type SendShoutoutParams, type SendWhisperBody, type SendWhisperParams, type SetExtensionConfigurationSegmentBody, type SetExtensionRequiredConfigurationBody, type SetExtensionRequiredConfigurationParams, type SnoozeNextAdParams, type SnoozeNextAdResponse, type StartCommercialBody, type StartCommercialResponse, type StartRaidParams, type StartRaidResponse, type Stream, type StreamMarkerCreated, type StreamMarkers, type StreamTag, type Team, TwitchApi, type TwitchApiOptions, type UnbanUserParams, type UnblockUserParams, type UpdateAutoModSettingsBody, type UpdateAutoModSettingsParams, type UpdateAutoModSettingsResponse, type UpdateChannelGuestStarSettingsBody, type UpdateChannelGuestStarSettingsParams, type UpdateChannelStreamScheduleParams, type UpdateChannelStreamScheduleSegmentBody, type UpdateChannelStreamScheduleSegmentParams, type UpdateChannelStreamScheduleSegmentResponse, type UpdateChatSettingsBody, type UpdateChatSettingsParams, type UpdateChatSettingsResponse, type UpdateConduitShardsBody, type UpdateConduitShardsResponse, type UpdateConduitsBody, type UpdateConduitsResponse, type UpdateCustomRewardBody, type UpdateCustomRewardParams, type UpdateCustomRewardResponse, type UpdateDropsEntitlementsBody, type UpdateDropsEntitlementsResponse, type UpdateExtensionBitsProductBody, type UpdateExtensionBitsProductResponse, type UpdateGuestStarSlotParams, type UpdateGuestStarSlotSettingsParams, type UpdateRedemptionStatusBody, type UpdateRedemptionStatusParams, type UpdateRedemptionStatusResponse, type UpdateShieldModeStatusBody, type UpdateShieldModeStatusParams, type UpdateShieldModeStatusResponse, type UpdateUserChatColorParams, type UpdateUserExtensionsBody, type UpdateUserExtensionsResponse, type UpdateUserParams, type UpdateUserResponse, type User, type UserBlockList, type UserChatColor, type UserExtension, type UserExtensionComponent, type UserExtensionComponentUpdate, type UserExtensionOverlay, type UserExtensionOverlayUpdate, type UserExtensionPanel, type UserExtensionPanelUpdate, type UserModerator, type UserSubscription, type UserVip, type Video, type WarnChatUserBody, type WarnChatUserParams, type WarnChatUserResponse };
|