ts-twitch-api 0.2.6 → 0.2.7
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 +90 -1
- package/dist/index.d.cts +248 -27
- package/dist/index.d.ts +248 -27
- package/dist/index.js +90 -1
- package/package.json +4 -4
package/dist/index.cjs
CHANGED
|
@@ -1770,6 +1770,52 @@ var TwitchApi = class {
|
|
|
1770
1770
|
path: "/clips",
|
|
1771
1771
|
params,
|
|
1772
1772
|
options
|
|
1773
|
+
}),
|
|
1774
|
+
/**
|
|
1775
|
+
* NEW Provides URLs to download the video file(s) for the specified clips. For information about clips, see [How to use clips](https://help.twitch.tv/s/article/how-to-use-clips).
|
|
1776
|
+
*
|
|
1777
|
+
* **Rate Limits**: Limited to 100 requests per minute.
|
|
1778
|
+
*
|
|
1779
|
+
* __Authorization:__
|
|
1780
|
+
*
|
|
1781
|
+
* Requires an [app access token](https://dev.twitch.tv/docs/authentication#app-access-tokens) or [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens) that includes the `editor:manage:clips` or `channel:manage:clips` scope.
|
|
1782
|
+
*
|
|
1783
|
+
* __URL:__
|
|
1784
|
+
*
|
|
1785
|
+
* `GET https://api.twitch.tv/helix/clips/downloads`
|
|
1786
|
+
*
|
|
1787
|
+
* __Response Codes:__
|
|
1788
|
+
*
|
|
1789
|
+
* _200 OK_
|
|
1790
|
+
*
|
|
1791
|
+
* Successfully retrieved the clip download URL(s).
|
|
1792
|
+
*
|
|
1793
|
+
* _400 Bad Request_
|
|
1794
|
+
*
|
|
1795
|
+
* The ID in the broadcaster\_id, editor\_id, or clip\_id query parameter is not valid.
|
|
1796
|
+
*
|
|
1797
|
+
* _401 Unauthorized_
|
|
1798
|
+
*
|
|
1799
|
+
* * The OAuth token is not valid.
|
|
1800
|
+
* * The Authorization header is required and must contain a user access token or app access token.
|
|
1801
|
+
* * The access token must include the editor:manage:clips or channel:manage:clips scope
|
|
1802
|
+
* * The access token is not valid
|
|
1803
|
+
* * The client ID specified in the Client-Id header does not match the client ID specified in the access token.
|
|
1804
|
+
*
|
|
1805
|
+
* _403 Forbidden_
|
|
1806
|
+
*
|
|
1807
|
+
* The user is not an editor for the specified broadcaster.
|
|
1808
|
+
*
|
|
1809
|
+
* _500 Internal Server Error_
|
|
1810
|
+
*
|
|
1811
|
+
* Internal Server Error.
|
|
1812
|
+
*
|
|
1813
|
+
* @see https://dev.twitch.tv/docs/api/reference#get-clips-download
|
|
1814
|
+
*/
|
|
1815
|
+
getClipsDownload: (params, options = {}) => this.callApi({
|
|
1816
|
+
path: "/clips/downloads",
|
|
1817
|
+
params,
|
|
1818
|
+
options
|
|
1773
1819
|
})
|
|
1774
1820
|
};
|
|
1775
1821
|
conduits = {
|
|
@@ -3325,6 +3371,8 @@ var TwitchApi = class {
|
|
|
3325
3371
|
};
|
|
3326
3372
|
hypeTrain = {
|
|
3327
3373
|
/**
|
|
3374
|
+
* DEPRECATED Scheduled for removal on December 4, 2025\. Use “Get Hype Train Status” instead. See [announcement](https://discuss.dev.twitch.com/t/legacy-get-hype-train-events-api-and-eventsub-hype-train-v1-subscription-types-deprecation-and-withdrawal-timeline/64299).
|
|
3375
|
+
*
|
|
3328
3376
|
* Gets information about the broadcaster’s current or most recent Hype Train event.
|
|
3329
3377
|
*
|
|
3330
3378
|
* Instead of polling for events, consider [subscribing](https://dev.twitch.tv/docs/eventsub/manage-subscriptions) to Hype Train events ([Begin](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelhype%5Ftrainbegin), [Progress](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelhype%5Ftrainprogress), [End](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelhype%5Ftrainend)).
|
|
@@ -3359,7 +3407,7 @@ var TwitchApi = class {
|
|
|
3359
3407
|
options
|
|
3360
3408
|
}),
|
|
3361
3409
|
/**
|
|
3362
|
-
*
|
|
3410
|
+
* NEW Get the status of a Hype Train for the specified broadcaster.
|
|
3363
3411
|
*
|
|
3364
3412
|
* __Authorization:__
|
|
3365
3413
|
*
|
|
@@ -5767,6 +5815,47 @@ var TwitchApi = class {
|
|
|
5767
5815
|
params,
|
|
5768
5816
|
options
|
|
5769
5817
|
}),
|
|
5818
|
+
/**
|
|
5819
|
+
* NEW Gets the authorization scopes that the specified user(s) have granted the application.
|
|
5820
|
+
*
|
|
5821
|
+
* __Authorization:__
|
|
5822
|
+
*
|
|
5823
|
+
* Requires an [app access token](https://dev.twitch.tv/docs/authentication#app-access-tokens).
|
|
5824
|
+
*
|
|
5825
|
+
* __URL:__
|
|
5826
|
+
*
|
|
5827
|
+
* `GET https://api.twitch.tv/helix/authorization/users`
|
|
5828
|
+
*
|
|
5829
|
+
* __Response Codes:__
|
|
5830
|
+
*
|
|
5831
|
+
* _200 OK_
|
|
5832
|
+
*
|
|
5833
|
+
* Successfully retrieved user authorization.
|
|
5834
|
+
*
|
|
5835
|
+
* _400 Bad Request_
|
|
5836
|
+
*
|
|
5837
|
+
* Request is malformed - invalid parameters or missing parameters.
|
|
5838
|
+
*
|
|
5839
|
+
* _401 Unauthorized_
|
|
5840
|
+
*
|
|
5841
|
+
* * The access token is not valid.
|
|
5842
|
+
* * Authorization header is required and must specify an app access token.
|
|
5843
|
+
*
|
|
5844
|
+
* _403 Forbidden_
|
|
5845
|
+
*
|
|
5846
|
+
* The client-id in the header must match the client ID in the access token.
|
|
5847
|
+
*
|
|
5848
|
+
* _500 Internal Server Error_
|
|
5849
|
+
*
|
|
5850
|
+
* Internal Server Error.
|
|
5851
|
+
*
|
|
5852
|
+
* @see https://dev.twitch.tv/docs/api/reference#get-authorization-by-user
|
|
5853
|
+
*/
|
|
5854
|
+
getAuthorizationByUser: (params, options = {}) => this.callApi({
|
|
5855
|
+
path: "/authorization/users",
|
|
5856
|
+
params,
|
|
5857
|
+
options
|
|
5858
|
+
}),
|
|
5770
5859
|
/**
|
|
5771
5860
|
* 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)
|
|
5772
5861
|
*
|
package/dist/index.d.cts
CHANGED
|
@@ -1340,7 +1340,7 @@ interface components {
|
|
|
1340
1340
|
*
|
|
1341
1341
|
* If this parameter is not set, the default value when using an App Access Token is `false`. On May 19, 2025 the default value for this parameter will be updated to `true`, and chat messages sent using an App Access Token will only be shared with the source channel by default. If you prefer to send a chat message to both channels in a shared chat session, make sure this parameter is explicitly set to `false` in your API request before May 19.
|
|
1342
1342
|
*/
|
|
1343
|
-
for_source_only?:
|
|
1343
|
+
for_source_only?: boolean;
|
|
1344
1344
|
};
|
|
1345
1345
|
SendChatMessageResponse: {
|
|
1346
1346
|
data: {
|
|
@@ -1442,6 +1442,17 @@ interface components {
|
|
|
1442
1442
|
cursor?: string;
|
|
1443
1443
|
};
|
|
1444
1444
|
};
|
|
1445
|
+
GetClipsDownloadResponse: {
|
|
1446
|
+
/** @description List of clips and their download URLs. */
|
|
1447
|
+
data: {
|
|
1448
|
+
/** @description An ID that uniquely identifies the clip. */
|
|
1449
|
+
clip_id: string;
|
|
1450
|
+
/** @description The landscape URL to download the clip. This field is `null` if the URL is not available. */
|
|
1451
|
+
landscape_download_url: string;
|
|
1452
|
+
/** @description The portrait URL to download the clip. This field is `null` if the URL is not available. */
|
|
1453
|
+
portrait_download_url: string;
|
|
1454
|
+
}[];
|
|
1455
|
+
};
|
|
1445
1456
|
GetConduitsResponse: {
|
|
1446
1457
|
/** @description List of information about the client’s conduits. */
|
|
1447
1458
|
data: {
|
|
@@ -3719,27 +3730,28 @@ interface components {
|
|
|
3719
3730
|
/** @description The user’s login name. */
|
|
3720
3731
|
user_login: string;
|
|
3721
3732
|
/** @description A list of videos that contain markers. The list contains a single video. */
|
|
3722
|
-
videos:
|
|
3723
|
-
|
|
3724
|
-
|
|
3725
|
-
|
|
3726
|
-
|
|
3727
|
-
|
|
3728
|
-
|
|
3729
|
-
|
|
3730
|
-
|
|
3731
|
-
|
|
3732
|
-
|
|
3733
|
-
|
|
3734
|
-
|
|
3735
|
-
|
|
3736
|
-
|
|
3737
|
-
|
|
3738
|
-
|
|
3739
|
-
|
|
3740
|
-
|
|
3741
|
-
|
|
3742
|
-
|
|
3733
|
+
videos: {
|
|
3734
|
+
/** @description An ID that identifies this video. */
|
|
3735
|
+
video_id: string;
|
|
3736
|
+
/** @description The list of markers in this video. The list in ascending order by when the marker was created. */
|
|
3737
|
+
markers: {
|
|
3738
|
+
/** @description An ID that identifies this marker. */
|
|
3739
|
+
id: string;
|
|
3740
|
+
/**
|
|
3741
|
+
* Format: date-time
|
|
3742
|
+
* @description The UTC date and time (in RFC3339 format) of when the user created the marker.
|
|
3743
|
+
*/
|
|
3744
|
+
created_at: string;
|
|
3745
|
+
/** @description The description that the user gave the marker to help them remember why they marked the location. Is an empty string if the user didn’t provide one. */
|
|
3746
|
+
description: string;
|
|
3747
|
+
/**
|
|
3748
|
+
* Format: int32
|
|
3749
|
+
* @description The relative offset (in seconds) of the marker from the beginning of the stream.
|
|
3750
|
+
*/
|
|
3751
|
+
position_seconds: number;
|
|
3752
|
+
/** @description A URL that opens the video in Twitch Highlighter. */
|
|
3753
|
+
url: string;
|
|
3754
|
+
}[];
|
|
3743
3755
|
}[];
|
|
3744
3756
|
};
|
|
3745
3757
|
GetStreamMarkersResponse: {
|
|
@@ -3995,6 +4007,19 @@ interface components {
|
|
|
3995
4007
|
/** @description A list contains the single user that you updated. */
|
|
3996
4008
|
data: components["schemas"]["User"][];
|
|
3997
4009
|
};
|
|
4010
|
+
GetAuthorizationByUserResponse: {
|
|
4011
|
+
/** @description List of users and their authorized scopes. */
|
|
4012
|
+
data: {
|
|
4013
|
+
/** @description The user’s ID. */
|
|
4014
|
+
user_id: string;
|
|
4015
|
+
/** @description The user’s display name. */
|
|
4016
|
+
user_name: string;
|
|
4017
|
+
/** @description The user’s login name. */
|
|
4018
|
+
user_login: string;
|
|
4019
|
+
/** @description An array of all the scopes the user has granted to the client ID. */
|
|
4020
|
+
scopes: string[];
|
|
4021
|
+
}[];
|
|
4022
|
+
};
|
|
3998
4023
|
UserBlockList: {
|
|
3999
4024
|
/** @description An ID that identifies the blocked user. */
|
|
4000
4025
|
user_id: string;
|
|
@@ -6413,6 +6438,58 @@ interface operations {
|
|
|
6413
6438
|
};
|
|
6414
6439
|
};
|
|
6415
6440
|
};
|
|
6441
|
+
/**
|
|
6442
|
+
* NEW Provides URLs to download the video file(s) for the specified clips.
|
|
6443
|
+
* @description NEW Provides URLs to download the video file(s) for the specified clips. For information about clips, see [How to use clips](https://help.twitch.tv/s/article/how-to-use-clips).
|
|
6444
|
+
*
|
|
6445
|
+
* **Rate Limits**: Limited to 100 requests per minute.
|
|
6446
|
+
*
|
|
6447
|
+
* __Authorization:__
|
|
6448
|
+
*
|
|
6449
|
+
* Requires an [app access token](https://dev.twitch.tv/docs/authentication#app-access-tokens) or [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens) that includes the `editor:manage:clips` or `channel:manage:clips` scope.
|
|
6450
|
+
*/
|
|
6451
|
+
"get-clips-download": {
|
|
6452
|
+
parameters: {
|
|
6453
|
+
query: {
|
|
6454
|
+
/** @description The User ID of the editor for the channel you want to download a clip for. If using the broadcaster’s auth token, this is the same as `broadcaster_id`. This must match the `user_id` in the user access token. */
|
|
6455
|
+
editor_id: string;
|
|
6456
|
+
/** @description The ID of the broadcaster you want to download clips for. */
|
|
6457
|
+
broadcaster_id: string;
|
|
6458
|
+
/** @description The ID that identifies the clip you want to download. Include this parameter for each clip you want to download, up to a maximum of 10 clips. For example, `clip_id=SleepyGiftedPeppermintNerfRedBlaster-KbkBXYt3lOk3jy8-&clip_id=WimpyAltruisticKleeKeyboardCat-EiY5yMrEwZ4i4gwC`. */
|
|
6459
|
+
clip_id: string[];
|
|
6460
|
+
};
|
|
6461
|
+
};
|
|
6462
|
+
responses: {
|
|
6463
|
+
/** @description Successfully retrieved the clip download URL(s). */
|
|
6464
|
+
200: {
|
|
6465
|
+
content: {
|
|
6466
|
+
"application/json": components["schemas"]["GetClipsDownloadResponse"];
|
|
6467
|
+
};
|
|
6468
|
+
};
|
|
6469
|
+
/** @description The ID in the broadcaster\_id, editor\_id, or clip\_id query parameter is not valid. */
|
|
6470
|
+
400: {
|
|
6471
|
+
content: never;
|
|
6472
|
+
};
|
|
6473
|
+
/**
|
|
6474
|
+
* @description * The OAuth token is not valid.
|
|
6475
|
+
* * The Authorization header is required and must contain a user access token or app access token.
|
|
6476
|
+
* * The access token must include the editor:manage:clips or channel:manage:clips scope
|
|
6477
|
+
* * The access token is not valid
|
|
6478
|
+
* * The client ID specified in the Client-Id header does not match the client ID specified in the access token.
|
|
6479
|
+
*/
|
|
6480
|
+
401: {
|
|
6481
|
+
content: never;
|
|
6482
|
+
};
|
|
6483
|
+
/** @description The user is not an editor for the specified broadcaster. */
|
|
6484
|
+
403: {
|
|
6485
|
+
content: never;
|
|
6486
|
+
};
|
|
6487
|
+
/** @description Internal Server Error. */
|
|
6488
|
+
500: {
|
|
6489
|
+
content: never;
|
|
6490
|
+
};
|
|
6491
|
+
};
|
|
6492
|
+
};
|
|
6416
6493
|
/**
|
|
6417
6494
|
* NEW Gets the conduits for a client ID.
|
|
6418
6495
|
* @description NEW Gets the [conduits](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/) for a client ID.
|
|
@@ -8427,8 +8504,11 @@ interface operations {
|
|
|
8427
8504
|
};
|
|
8428
8505
|
};
|
|
8429
8506
|
/**
|
|
8507
|
+
* DEPRECATED Gets information about the broadcaster’s current or most recent Hype Train event.
|
|
8508
|
+
* @deprecated
|
|
8509
|
+
* @description DEPRECATED Scheduled for removal on December 4, 2025\. Use “Get Hype Train Status” instead. See [announcement](https://discuss.dev.twitch.com/t/legacy-get-hype-train-events-api-and-eventsub-hype-train-v1-subscription-types-deprecation-and-withdrawal-timeline/64299).
|
|
8510
|
+
*
|
|
8430
8511
|
* Gets information about the broadcaster’s current or most recent Hype Train event.
|
|
8431
|
-
* @description Gets information about the broadcaster’s current or most recent Hype Train event.
|
|
8432
8512
|
*
|
|
8433
8513
|
* Instead of polling for events, consider [subscribing](https://dev.twitch.tv/docs/eventsub/manage-subscriptions) to Hype Train events ([Begin](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelhype%5Ftrainbegin), [Progress](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelhype%5Ftrainprogress), [End](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelhype%5Ftrainend)).
|
|
8434
8514
|
*
|
|
@@ -8467,8 +8547,8 @@ interface operations {
|
|
|
8467
8547
|
};
|
|
8468
8548
|
};
|
|
8469
8549
|
/**
|
|
8470
|
-
*
|
|
8471
|
-
* @description
|
|
8550
|
+
* NEW Gets the status of a Hype Train for the specified broadcaster.
|
|
8551
|
+
* @description NEW Get the status of a Hype Train for the specified broadcaster.
|
|
8472
8552
|
*
|
|
8473
8553
|
* __Authorization:__
|
|
8474
8554
|
*
|
|
@@ -11422,6 +11502,49 @@ interface operations {
|
|
|
11422
11502
|
};
|
|
11423
11503
|
};
|
|
11424
11504
|
};
|
|
11505
|
+
/**
|
|
11506
|
+
* NEW Gets the authorization scopes that the specified user has granted the application.
|
|
11507
|
+
* @description NEW Gets the authorization scopes that the specified user(s) have granted the application.
|
|
11508
|
+
*
|
|
11509
|
+
* __Authorization:__
|
|
11510
|
+
*
|
|
11511
|
+
* Requires an [app access token](https://dev.twitch.tv/docs/authentication#app-access-tokens).
|
|
11512
|
+
*/
|
|
11513
|
+
"get-authorization-by-user": {
|
|
11514
|
+
parameters: {
|
|
11515
|
+
query: {
|
|
11516
|
+
/** @description The ID of the user(s) you want to check authorization for. To specify more than one user, include the user\_id parameter for each user to get. For example, `user_id=1234&user_id=5678`. The maximum number of IDs you may specify is 10. */
|
|
11517
|
+
user_id: string[];
|
|
11518
|
+
};
|
|
11519
|
+
};
|
|
11520
|
+
responses: {
|
|
11521
|
+
/** @description Successfully retrieved user authorization. */
|
|
11522
|
+
200: {
|
|
11523
|
+
content: {
|
|
11524
|
+
"application/json": components["schemas"]["GetAuthorizationByUserResponse"];
|
|
11525
|
+
};
|
|
11526
|
+
};
|
|
11527
|
+
/** @description Request is malformed - invalid parameters or missing parameters. */
|
|
11528
|
+
400: {
|
|
11529
|
+
content: never;
|
|
11530
|
+
};
|
|
11531
|
+
/**
|
|
11532
|
+
* @description * The access token is not valid.
|
|
11533
|
+
* * Authorization header is required and must specify an app access token.
|
|
11534
|
+
*/
|
|
11535
|
+
401: {
|
|
11536
|
+
content: never;
|
|
11537
|
+
};
|
|
11538
|
+
/** @description The client-id in the header must match the client ID in the access token. */
|
|
11539
|
+
403: {
|
|
11540
|
+
content: never;
|
|
11541
|
+
};
|
|
11542
|
+
/** @description Internal Server Error. */
|
|
11543
|
+
500: {
|
|
11544
|
+
content: never;
|
|
11545
|
+
};
|
|
11546
|
+
};
|
|
11547
|
+
};
|
|
11425
11548
|
/**
|
|
11426
11549
|
* Gets the list of users that the broadcaster has blocked.
|
|
11427
11550
|
* @description 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)
|
|
@@ -12003,6 +12126,7 @@ type GetUserChatColorParams = ParamsSchema<'get-user-chat-color'>;
|
|
|
12003
12126
|
type UpdateUserChatColorParams = ParamsSchema<'update-user-chat-color'>;
|
|
12004
12127
|
type CreateClipParams = ParamsSchema<'create-clip'>;
|
|
12005
12128
|
type GetClipsParams = ParamsSchema<'get-clips'>;
|
|
12129
|
+
type GetClipsDownloadParams = ParamsSchema<'get-clips-download'>;
|
|
12006
12130
|
type DeleteConduitParams = ParamsSchema<'delete-conduit'>;
|
|
12007
12131
|
type GetConduitShardsParams = ParamsSchema<'get-conduit-shards'>;
|
|
12008
12132
|
type GetContentClassificationLabelsParams = ParamsSchema<'get-content-classification-labels'>;
|
|
@@ -12080,6 +12204,7 @@ type GetChannelTeamsParams = ParamsSchema<'get-channel-teams'>;
|
|
|
12080
12204
|
type GetTeamsParams = ParamsSchema<'get-teams'>;
|
|
12081
12205
|
type GetUsersParams = ParamsSchema<'get-users'>;
|
|
12082
12206
|
type UpdateUserParams = ParamsSchema<'update-user'>;
|
|
12207
|
+
type GetAuthorizationByUserParams = ParamsSchema<'get-authorization-by-user'>;
|
|
12083
12208
|
type GetUserBlockListParams = ParamsSchema<'get-user-block-list'>;
|
|
12084
12209
|
type BlockUserParams = ParamsSchema<'block-user'>;
|
|
12085
12210
|
type UnblockUserParams = ParamsSchema<'unblock-user'>;
|
|
@@ -12151,6 +12276,7 @@ type GetUserChatColorResponse = Schema<'GetUserChatColorResponse'>;
|
|
|
12151
12276
|
type CreateClipResponse = Schema<'CreateClipResponse'>;
|
|
12152
12277
|
type Clip = Schema<'Clip'>;
|
|
12153
12278
|
type GetClipsResponse = Schema<'GetClipsResponse'>;
|
|
12279
|
+
type GetClipsDownloadResponse = Schema<'GetClipsDownloadResponse'>;
|
|
12154
12280
|
type GetConduitsResponse = Schema<'GetConduitsResponse'>;
|
|
12155
12281
|
type CreateConduitsBody = Schema<'CreateConduitsBody'>;
|
|
12156
12282
|
type CreateConduitsResponse = Schema<'CreateConduitsResponse'>;
|
|
@@ -12281,6 +12407,7 @@ type GetTeamsResponse = Schema<'GetTeamsResponse'>;
|
|
|
12281
12407
|
type User = Schema<'User'>;
|
|
12282
12408
|
type GetUsersResponse = Schema<'GetUsersResponse'>;
|
|
12283
12409
|
type UpdateUserResponse = Schema<'UpdateUserResponse'>;
|
|
12410
|
+
type GetAuthorizationByUserResponse = Schema<'GetAuthorizationByUserResponse'>;
|
|
12284
12411
|
type UserBlockList = Schema<'UserBlockList'>;
|
|
12285
12412
|
type GetUserBlockListResponse = Schema<'GetUserBlockListResponse'>;
|
|
12286
12413
|
type UserExtension = Schema<'UserExtension'>;
|
|
@@ -14006,6 +14133,54 @@ declare class TwitchApi {
|
|
|
14006
14133
|
cursor?: string;
|
|
14007
14134
|
};
|
|
14008
14135
|
}, 200, 400 | 401 | 404>;
|
|
14136
|
+
/**
|
|
14137
|
+
* NEW Provides URLs to download the video file(s) for the specified clips. For information about clips, see [How to use clips](https://help.twitch.tv/s/article/how-to-use-clips).
|
|
14138
|
+
*
|
|
14139
|
+
* **Rate Limits**: Limited to 100 requests per minute.
|
|
14140
|
+
*
|
|
14141
|
+
* __Authorization:__
|
|
14142
|
+
*
|
|
14143
|
+
* Requires an [app access token](https://dev.twitch.tv/docs/authentication#app-access-tokens) or [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens) that includes the `editor:manage:clips` or `channel:manage:clips` scope.
|
|
14144
|
+
*
|
|
14145
|
+
* __URL:__
|
|
14146
|
+
*
|
|
14147
|
+
* `GET https://api.twitch.tv/helix/clips/downloads`
|
|
14148
|
+
*
|
|
14149
|
+
* __Response Codes:__
|
|
14150
|
+
*
|
|
14151
|
+
* _200 OK_
|
|
14152
|
+
*
|
|
14153
|
+
* Successfully retrieved the clip download URL(s).
|
|
14154
|
+
*
|
|
14155
|
+
* _400 Bad Request_
|
|
14156
|
+
*
|
|
14157
|
+
* The ID in the broadcaster\_id, editor\_id, or clip\_id query parameter is not valid.
|
|
14158
|
+
*
|
|
14159
|
+
* _401 Unauthorized_
|
|
14160
|
+
*
|
|
14161
|
+
* * The OAuth token is not valid.
|
|
14162
|
+
* * The Authorization header is required and must contain a user access token or app access token.
|
|
14163
|
+
* * The access token must include the editor:manage:clips or channel:manage:clips scope
|
|
14164
|
+
* * The access token is not valid
|
|
14165
|
+
* * The client ID specified in the Client-Id header does not match the client ID specified in the access token.
|
|
14166
|
+
*
|
|
14167
|
+
* _403 Forbidden_
|
|
14168
|
+
*
|
|
14169
|
+
* The user is not an editor for the specified broadcaster.
|
|
14170
|
+
*
|
|
14171
|
+
* _500 Internal Server Error_
|
|
14172
|
+
*
|
|
14173
|
+
* Internal Server Error.
|
|
14174
|
+
*
|
|
14175
|
+
* @see https://dev.twitch.tv/docs/api/reference#get-clips-download
|
|
14176
|
+
*/
|
|
14177
|
+
getClipsDownload: (params: GetClipsDownloadParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14178
|
+
data: {
|
|
14179
|
+
clip_id: string;
|
|
14180
|
+
landscape_download_url: string;
|
|
14181
|
+
portrait_download_url: string;
|
|
14182
|
+
}[];
|
|
14183
|
+
}, 200, 400 | 401 | 403 | 500>;
|
|
14009
14184
|
};
|
|
14010
14185
|
conduits: {
|
|
14011
14186
|
/**
|
|
@@ -15488,6 +15663,8 @@ declare class TwitchApi {
|
|
|
15488
15663
|
};
|
|
15489
15664
|
hypeTrain: {
|
|
15490
15665
|
/**
|
|
15666
|
+
* DEPRECATED Scheduled for removal on December 4, 2025\. Use “Get Hype Train Status” instead. See [announcement](https://discuss.dev.twitch.com/t/legacy-get-hype-train-events-api-and-eventsub-hype-train-v1-subscription-types-deprecation-and-withdrawal-timeline/64299).
|
|
15667
|
+
*
|
|
15491
15668
|
* Gets information about the broadcaster’s current or most recent Hype Train event.
|
|
15492
15669
|
*
|
|
15493
15670
|
* Instead of polling for events, consider [subscribing](https://dev.twitch.tv/docs/eventsub/manage-subscriptions) to Hype Train events ([Begin](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelhype%5Ftrainbegin), [Progress](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelhype%5Ftrainprogress), [End](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelhype%5Ftrainend)).
|
|
@@ -15523,7 +15700,7 @@ declare class TwitchApi {
|
|
|
15523
15700
|
};
|
|
15524
15701
|
}, 200, 401>;
|
|
15525
15702
|
/**
|
|
15526
|
-
*
|
|
15703
|
+
* NEW Get the status of a Hype Train for the specified broadcaster.
|
|
15527
15704
|
*
|
|
15528
15705
|
* __Authorization:__
|
|
15529
15706
|
*
|
|
@@ -17943,6 +18120,50 @@ declare class TwitchApi {
|
|
|
17943
18120
|
updateUser: (params?: UpdateUserParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17944
18121
|
data: components["schemas"]["User"][];
|
|
17945
18122
|
}, 200, 400 | 401 | 429>;
|
|
18123
|
+
/**
|
|
18124
|
+
* NEW Gets the authorization scopes that the specified user(s) have granted the application.
|
|
18125
|
+
*
|
|
18126
|
+
* __Authorization:__
|
|
18127
|
+
*
|
|
18128
|
+
* Requires an [app access token](https://dev.twitch.tv/docs/authentication#app-access-tokens).
|
|
18129
|
+
*
|
|
18130
|
+
* __URL:__
|
|
18131
|
+
*
|
|
18132
|
+
* `GET https://api.twitch.tv/helix/authorization/users`
|
|
18133
|
+
*
|
|
18134
|
+
* __Response Codes:__
|
|
18135
|
+
*
|
|
18136
|
+
* _200 OK_
|
|
18137
|
+
*
|
|
18138
|
+
* Successfully retrieved user authorization.
|
|
18139
|
+
*
|
|
18140
|
+
* _400 Bad Request_
|
|
18141
|
+
*
|
|
18142
|
+
* Request is malformed - invalid parameters or missing parameters.
|
|
18143
|
+
*
|
|
18144
|
+
* _401 Unauthorized_
|
|
18145
|
+
*
|
|
18146
|
+
* * The access token is not valid.
|
|
18147
|
+
* * Authorization header is required and must specify an app access token.
|
|
18148
|
+
*
|
|
18149
|
+
* _403 Forbidden_
|
|
18150
|
+
*
|
|
18151
|
+
* The client-id in the header must match the client ID in the access token.
|
|
18152
|
+
*
|
|
18153
|
+
* _500 Internal Server Error_
|
|
18154
|
+
*
|
|
18155
|
+
* Internal Server Error.
|
|
18156
|
+
*
|
|
18157
|
+
* @see https://dev.twitch.tv/docs/api/reference#get-authorization-by-user
|
|
18158
|
+
*/
|
|
18159
|
+
getAuthorizationByUser: (params: GetAuthorizationByUserParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
18160
|
+
data: {
|
|
18161
|
+
user_id: string;
|
|
18162
|
+
user_name: string;
|
|
18163
|
+
user_login: string;
|
|
18164
|
+
scopes: string[];
|
|
18165
|
+
}[];
|
|
18166
|
+
}, 200, 400 | 401 | 403 | 500>;
|
|
17946
18167
|
/**
|
|
17947
18168
|
* 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)
|
|
17948
18169
|
*
|
|
@@ -18316,4 +18537,4 @@ declare class TwitchApi {
|
|
|
18316
18537
|
};
|
|
18317
18538
|
}
|
|
18318
18539
|
|
|
18319
|
-
export { type AddBlockedTermBody, type AddBlockedTermParams, type AddBlockedTermResponse, type AddChannelModeratorParams, type AddChannelVIPParams, type ApiResponse, type AssignGuestStarSlotParams, type AutoModSettings, type AutoModStatus, type BanUserBody, type BanUserParams, type BanUserResponse, type BannedUser, type BitsLeaderboard, type BlockUserParams, type BlockedTerm, type BroadcasterSubscription, type CancelRaidParams, type Category, type Channel, type ChannelEditor, type ChannelEmote, type ChannelInformation, type ChannelStreamScheduleSegment, type ChannelTeam, type CharityCampaign, type CharityCampaignDonation, type ChatBadge, type ChatSettings, type ChatSettingsUpdated, type Chatter, type CheckAutoModStatusBody, type CheckAutoModStatusParams, type CheckAutoModStatusResponse, type CheckUserSubscriptionParams, type CheckUserSubscriptionResponse, type Cheermote, type CheermoteImageFormat, type CheermoteImageTheme, type CheermoteImages, type Clip, type ContentClassificationLabel, type CreateChannelStreamScheduleSegmentBody, type CreateChannelStreamScheduleSegmentParams, type CreateChannelStreamScheduleSegmentResponse, type CreateClipParams, type CreateClipResponse, type CreateConduitsBody, type CreateConduitsResponse, type CreateCustomRewardsBody, type CreateCustomRewardsParams, type CreateCustomRewardsResponse, type CreateEventSubSubscriptionBody, type CreateEventSubSubscriptionResponse, type CreateExtensionSecretParams, type CreateExtensionSecretResponse, type CreateGuestStarSessionParams, type CreateGuestStarSessionResponse, type CreatePollBody, type CreatePollResponse, type CreatePredictionBody, type CreatePredictionResponse, type CreateStreamMarkerBody, type CreateStreamMarkerResponse, type CreatorGoal, type CustomReward, type CustomRewardRedemption, type DeleteChannelStreamScheduleSegmentParams, type DeleteChatMessagesParams, type DeleteConduitParams, type DeleteCustomRewardParams, type DeleteEventSubSubscriptionParams, type DeleteGuestStarInviteParams, type DeleteGuestStarSlotParams, type DeleteVideosParams, type DeleteVideosResponse, type DropsEntitlement, type DropsEntitlementUpdated, type Emote, type EndGuestStarSessionParams, type EndGuestStarSessionResponse, type EndPollBody, type EndPollResponse, type EndPredictionBody, type EndPredictionResponse, type EventSubSubscription, type Extension, type ExtensionAnalytics, type ExtensionBitsProduct, type ExtensionConfigurationSegment, type ExtensionIconUrls, type ExtensionLiveChannel, type ExtensionSecret, type ExtensionTransaction, type Game, type GameAnalytics, type GetAdScheduleParams, type GetAdScheduleResponse, type GetAllStreamTagsParams, type GetAllStreamTagsResponse, type GetAutoModSettingsParams, type GetAutoModSettingsResponse, type GetBannedUsersParams, type GetBannedUsersResponse, type GetBitsLeaderboardParams, type GetBitsLeaderboardResponse, type GetBlockedTermsParams, type GetBlockedTermsResponse, type GetBroadcasterSubscriptionsParams, type GetBroadcasterSubscriptionsResponse, type GetChannelChatBadgesParams, type GetChannelChatBadgesResponse, type GetChannelEditorsParams, type GetChannelEditorsResponse, type GetChannelEmotesParams, type GetChannelEmotesResponse, type GetChannelFollowersParams, type GetChannelFollowersResponse, type GetChannelGuestStarSettingsParams, type GetChannelGuestStarSettingsResponse, type GetChannelICalendarParams, type GetChannelInformationParams, type GetChannelInformationResponse, type GetChannelStreamScheduleParams, type GetChannelStreamScheduleResponse, type GetChannelTeamsParams, type GetChannelTeamsResponse, type GetCharityCampaignDonationsParams, type GetCharityCampaignDonationsResponse, type GetCharityCampaignParams, type GetCharityCampaignResponse, type GetChatSettingsParams, type GetChatSettingsResponse, type GetChattersParams, type GetChattersResponse, type GetCheermotesParams, type GetCheermotesResponse, type GetClipsParams, type GetClipsResponse, type GetConduitShardsParams, type GetConduitShardsResponse, type GetConduitsResponse, type GetContentClassificationLabelsParams, type GetContentClassificationLabelsResponse, type GetCreatorGoalsParams, type GetCreatorGoalsResponse, type GetCustomRewardParams, type GetCustomRewardRedemptionParams, type GetCustomRewardRedemptionResponse, type GetCustomRewardResponse, type GetDropsEntitlementsParams, type GetDropsEntitlementsResponse, type GetEmoteSetsParams, type GetEmoteSetsResponse, type GetEventSubSubscriptionsParams, type GetEventSubSubscriptionsResponse, type GetExtensionAnalyticsParams, type GetExtensionAnalyticsResponse, type GetExtensionBitsProductsParams, type GetExtensionBitsProductsResponse, type GetExtensionConfigurationSegmentParams, type GetExtensionConfigurationSegmentResponse, type GetExtensionLiveChannelsParams, type GetExtensionLiveChannelsResponse, type GetExtensionSecretsResponse, type GetExtensionTransactionsParams, type GetExtensionTransactionsResponse, type GetExtensionsParams, type GetExtensionsResponse, type GetFollowedChannelsParams, type GetFollowedChannelsResponse, type GetFollowedStreamsParams, type GetFollowedStreamsResponse, type GetGameAnalyticsParams, type GetGameAnalyticsResponse, type GetGamesParams, type GetGamesResponse, type GetGlobalChatBadgesResponse, type GetGlobalEmotesResponse, type GetGuestStarInvitesParams, type GetGuestStarInvitesResponse, type GetGuestStarSessionParams, type GetGuestStarSessionResponse, type GetHypeTrainEventsParams, type GetHypeTrainEventsResponse, type GetHypeTrainStatusParams, type GetHypeTrainStatusResponse, type GetModeratedChannelsParams, type GetModeratedChannelsResponse, type GetModeratorsParams, type GetModeratorsResponse, type GetPollsParams, type GetPollsResponse, type GetPredictionsParams, type GetPredictionsResponse, type GetReleasedExtensionsParams, type GetReleasedExtensionsResponse, type GetSharedChatSessionParams, type GetSharedChatSessionResponse, type GetShieldModeStatusParams, type GetShieldModeStatusResponse, type GetStreamKeyParams, type GetStreamKeyResponse, type GetStreamMarkersParams, type GetStreamMarkersResponse, type GetStreamTagsParams, type GetStreamTagsResponse, type GetStreamsParams, type GetStreamsResponse, type GetTeamsParams, type GetTeamsResponse, type GetTopGamesParams, type GetTopGamesResponse, type GetUnbanRequestsParams, type GetUnbanRequestsResponse, type GetUserActiveExtensionsParams, type GetUserActiveExtensionsResponse, type GetUserBlockListParams, type GetUserBlockListResponse, type GetUserChatColorParams, type GetUserChatColorResponse, type GetUserEmotesParams, type GetUserEmotesResponse, type GetUserExtensionsResponse, type GetUsersParams, type GetUsersResponse, type GetVIPsParams, type GetVIPsResponse, type GetVideosParams, type GetVideosResponse, type GlobalEmote, type Guest, type GuestStarInvite, type GuestStarSession, type HypeTrainEvent, type ManageHeldAutoModMessagesBody, type ModifyChannelInformationBody, type ModifyChannelInformationParams, type Poll, type Prediction, type PredictionOutcome, type RemoveBlockedTermParams, type RemoveChannelModeratorParams, type RemoveChannelVIPParams, type ResolveUnbanRequestsParams, type ResolveUnbanRequestsResponse, type SearchCategoriesParams, type SearchCategoriesResponse, type SearchChannelsParams, type SearchChannelsResponse, type SendChatAnnouncementBody, type SendChatAnnouncementParams, type SendChatMessageBody, type SendChatMessageResponse, type SendExtensionChatMessageBody, type SendExtensionChatMessageParams, type SendExtensionPubSubMessageBody, type SendGuestStarInviteParams, type SendShoutoutParams, type SendWhisperBody, type SendWhisperParams, type SetExtensionConfigurationSegmentBody, type SetExtensionRequiredConfigurationBody, type SetExtensionRequiredConfigurationParams, type SnoozeNextAdParams, type SnoozeNextAdResponse, type StartCommercialBody, type StartCommercialResponse, type StartRaidParams, type StartRaidResponse, type Stream, type StreamMarkerCreated, type StreamMarkers, type StreamTag, type Team, TwitchApi, type TwitchApiOptions, type UnbanUserParams, type UnblockUserParams, type UpdateAutoModSettingsBody, type UpdateAutoModSettingsParams, type UpdateAutoModSettingsResponse, type UpdateChannelGuestStarSettingsBody, type UpdateChannelGuestStarSettingsParams, type UpdateChannelStreamScheduleParams, type UpdateChannelStreamScheduleSegmentBody, type UpdateChannelStreamScheduleSegmentParams, type UpdateChannelStreamScheduleSegmentResponse, type UpdateChatSettingsBody, type UpdateChatSettingsParams, type UpdateChatSettingsResponse, type UpdateConduitShardsBody, type UpdateConduitShardsResponse, type UpdateConduitsBody, type UpdateConduitsResponse, type UpdateCustomRewardBody, type UpdateCustomRewardParams, type UpdateCustomRewardResponse, type UpdateDropsEntitlementsBody, type UpdateDropsEntitlementsResponse, type UpdateExtensionBitsProductBody, type UpdateExtensionBitsProductResponse, type UpdateGuestStarSlotParams, type UpdateGuestStarSlotSettingsParams, type UpdateRedemptionStatusBody, type UpdateRedemptionStatusParams, type UpdateRedemptionStatusResponse, type UpdateShieldModeStatusBody, type UpdateShieldModeStatusParams, type UpdateShieldModeStatusResponse, type UpdateUserChatColorParams, type UpdateUserExtensionsBody, type UpdateUserExtensionsResponse, type UpdateUserParams, type UpdateUserResponse, type User, type UserBlockList, type UserChatColor, type UserExtension, type UserExtensionComponent, type UserExtensionComponentUpdate, type UserExtensionOverlay, type UserExtensionOverlayUpdate, type UserExtensionPanel, type UserExtensionPanelUpdate, type UserModerator, type UserSubscription, type UserVip, type Video, type WarnChatUserBody, type WarnChatUserParams, type WarnChatUserResponse };
|
|
18540
|
+
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 GetAuthorizationByUserParams, type GetAuthorizationByUserResponse, 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 GetClipsDownloadParams, type GetClipsDownloadResponse, type GetClipsParams, type GetClipsResponse, type GetConduitShardsParams, type GetConduitShardsResponse, type GetConduitsResponse, type GetContentClassificationLabelsParams, type GetContentClassificationLabelsResponse, type GetCreatorGoalsParams, type GetCreatorGoalsResponse, type GetCustomRewardParams, type GetCustomRewardRedemptionParams, type GetCustomRewardRedemptionResponse, type GetCustomRewardResponse, type GetDropsEntitlementsParams, type GetDropsEntitlementsResponse, type GetEmoteSetsParams, type GetEmoteSetsResponse, type GetEventSubSubscriptionsParams, type GetEventSubSubscriptionsResponse, type GetExtensionAnalyticsParams, type GetExtensionAnalyticsResponse, type GetExtensionBitsProductsParams, type GetExtensionBitsProductsResponse, type GetExtensionConfigurationSegmentParams, type GetExtensionConfigurationSegmentResponse, type GetExtensionLiveChannelsParams, type GetExtensionLiveChannelsResponse, type GetExtensionSecretsResponse, type GetExtensionTransactionsParams, type GetExtensionTransactionsResponse, type GetExtensionsParams, type GetExtensionsResponse, type GetFollowedChannelsParams, type GetFollowedChannelsResponse, type GetFollowedStreamsParams, type GetFollowedStreamsResponse, type GetGameAnalyticsParams, type GetGameAnalyticsResponse, type GetGamesParams, type GetGamesResponse, type GetGlobalChatBadgesResponse, type GetGlobalEmotesResponse, type GetGuestStarInvitesParams, type GetGuestStarInvitesResponse, type GetGuestStarSessionParams, type GetGuestStarSessionResponse, type GetHypeTrainEventsParams, type GetHypeTrainEventsResponse, type GetHypeTrainStatusParams, type GetHypeTrainStatusResponse, type GetModeratedChannelsParams, type GetModeratedChannelsResponse, type GetModeratorsParams, type GetModeratorsResponse, type GetPollsParams, type GetPollsResponse, type GetPredictionsParams, type GetPredictionsResponse, type GetReleasedExtensionsParams, type GetReleasedExtensionsResponse, type GetSharedChatSessionParams, type GetSharedChatSessionResponse, type GetShieldModeStatusParams, type GetShieldModeStatusResponse, type GetStreamKeyParams, type GetStreamKeyResponse, type GetStreamMarkersParams, type GetStreamMarkersResponse, type GetStreamTagsParams, type GetStreamTagsResponse, type GetStreamsParams, type GetStreamsResponse, type GetTeamsParams, type GetTeamsResponse, type GetTopGamesParams, type GetTopGamesResponse, type GetUnbanRequestsParams, type GetUnbanRequestsResponse, type GetUserActiveExtensionsParams, type GetUserActiveExtensionsResponse, type GetUserBlockListParams, type GetUserBlockListResponse, type GetUserChatColorParams, type GetUserChatColorResponse, type GetUserEmotesParams, type GetUserEmotesResponse, type GetUserExtensionsResponse, type GetUsersParams, type GetUsersResponse, type GetVIPsParams, type GetVIPsResponse, type GetVideosParams, type GetVideosResponse, type GlobalEmote, type Guest, type GuestStarInvite, type GuestStarSession, type HypeTrainEvent, type ManageHeldAutoModMessagesBody, type ModifyChannelInformationBody, type ModifyChannelInformationParams, type Poll, type Prediction, type PredictionOutcome, type RemoveBlockedTermParams, type RemoveChannelModeratorParams, type RemoveChannelVIPParams, type ResolveUnbanRequestsParams, type ResolveUnbanRequestsResponse, type SearchCategoriesParams, type SearchCategoriesResponse, type SearchChannelsParams, type SearchChannelsResponse, type SendChatAnnouncementBody, type SendChatAnnouncementParams, type SendChatMessageBody, type SendChatMessageResponse, type SendExtensionChatMessageBody, type SendExtensionChatMessageParams, type SendExtensionPubSubMessageBody, type SendGuestStarInviteParams, type SendShoutoutParams, type SendWhisperBody, type SendWhisperParams, type SetExtensionConfigurationSegmentBody, type SetExtensionRequiredConfigurationBody, type SetExtensionRequiredConfigurationParams, type SnoozeNextAdParams, type SnoozeNextAdResponse, type StartCommercialBody, type StartCommercialResponse, type StartRaidParams, type StartRaidResponse, type Stream, type StreamMarkerCreated, type StreamMarkers, type StreamTag, type Team, TwitchApi, type TwitchApiOptions, type UnbanUserParams, type UnblockUserParams, type UpdateAutoModSettingsBody, type UpdateAutoModSettingsParams, type UpdateAutoModSettingsResponse, type UpdateChannelGuestStarSettingsBody, type UpdateChannelGuestStarSettingsParams, type UpdateChannelStreamScheduleParams, type UpdateChannelStreamScheduleSegmentBody, type UpdateChannelStreamScheduleSegmentParams, type UpdateChannelStreamScheduleSegmentResponse, type UpdateChatSettingsBody, type UpdateChatSettingsParams, type UpdateChatSettingsResponse, type UpdateConduitShardsBody, type UpdateConduitShardsResponse, type UpdateConduitsBody, type UpdateConduitsResponse, type UpdateCustomRewardBody, type UpdateCustomRewardParams, type UpdateCustomRewardResponse, type UpdateDropsEntitlementsBody, type UpdateDropsEntitlementsResponse, type UpdateExtensionBitsProductBody, type UpdateExtensionBitsProductResponse, type UpdateGuestStarSlotParams, type UpdateGuestStarSlotSettingsParams, type UpdateRedemptionStatusBody, type UpdateRedemptionStatusParams, type UpdateRedemptionStatusResponse, type UpdateShieldModeStatusBody, type UpdateShieldModeStatusParams, type UpdateShieldModeStatusResponse, type UpdateUserChatColorParams, type UpdateUserExtensionsBody, type UpdateUserExtensionsResponse, type UpdateUserParams, type UpdateUserResponse, type User, type UserBlockList, type UserChatColor, type UserExtension, type UserExtensionComponent, type UserExtensionComponentUpdate, type UserExtensionOverlay, type UserExtensionOverlayUpdate, type UserExtensionPanel, type UserExtensionPanelUpdate, type UserModerator, type UserSubscription, type UserVip, type Video, type WarnChatUserBody, type WarnChatUserParams, type WarnChatUserResponse };
|
package/dist/index.d.ts
CHANGED
|
@@ -1340,7 +1340,7 @@ interface components {
|
|
|
1340
1340
|
*
|
|
1341
1341
|
* If this parameter is not set, the default value when using an App Access Token is `false`. On May 19, 2025 the default value for this parameter will be updated to `true`, and chat messages sent using an App Access Token will only be shared with the source channel by default. If you prefer to send a chat message to both channels in a shared chat session, make sure this parameter is explicitly set to `false` in your API request before May 19.
|
|
1342
1342
|
*/
|
|
1343
|
-
for_source_only?:
|
|
1343
|
+
for_source_only?: boolean;
|
|
1344
1344
|
};
|
|
1345
1345
|
SendChatMessageResponse: {
|
|
1346
1346
|
data: {
|
|
@@ -1442,6 +1442,17 @@ interface components {
|
|
|
1442
1442
|
cursor?: string;
|
|
1443
1443
|
};
|
|
1444
1444
|
};
|
|
1445
|
+
GetClipsDownloadResponse: {
|
|
1446
|
+
/** @description List of clips and their download URLs. */
|
|
1447
|
+
data: {
|
|
1448
|
+
/** @description An ID that uniquely identifies the clip. */
|
|
1449
|
+
clip_id: string;
|
|
1450
|
+
/** @description The landscape URL to download the clip. This field is `null` if the URL is not available. */
|
|
1451
|
+
landscape_download_url: string;
|
|
1452
|
+
/** @description The portrait URL to download the clip. This field is `null` if the URL is not available. */
|
|
1453
|
+
portrait_download_url: string;
|
|
1454
|
+
}[];
|
|
1455
|
+
};
|
|
1445
1456
|
GetConduitsResponse: {
|
|
1446
1457
|
/** @description List of information about the client’s conduits. */
|
|
1447
1458
|
data: {
|
|
@@ -3719,27 +3730,28 @@ interface components {
|
|
|
3719
3730
|
/** @description The user’s login name. */
|
|
3720
3731
|
user_login: string;
|
|
3721
3732
|
/** @description A list of videos that contain markers. The list contains a single video. */
|
|
3722
|
-
videos:
|
|
3723
|
-
|
|
3724
|
-
|
|
3725
|
-
|
|
3726
|
-
|
|
3727
|
-
|
|
3728
|
-
|
|
3729
|
-
|
|
3730
|
-
|
|
3731
|
-
|
|
3732
|
-
|
|
3733
|
-
|
|
3734
|
-
|
|
3735
|
-
|
|
3736
|
-
|
|
3737
|
-
|
|
3738
|
-
|
|
3739
|
-
|
|
3740
|
-
|
|
3741
|
-
|
|
3742
|
-
|
|
3733
|
+
videos: {
|
|
3734
|
+
/** @description An ID that identifies this video. */
|
|
3735
|
+
video_id: string;
|
|
3736
|
+
/** @description The list of markers in this video. The list in ascending order by when the marker was created. */
|
|
3737
|
+
markers: {
|
|
3738
|
+
/** @description An ID that identifies this marker. */
|
|
3739
|
+
id: string;
|
|
3740
|
+
/**
|
|
3741
|
+
* Format: date-time
|
|
3742
|
+
* @description The UTC date and time (in RFC3339 format) of when the user created the marker.
|
|
3743
|
+
*/
|
|
3744
|
+
created_at: string;
|
|
3745
|
+
/** @description The description that the user gave the marker to help them remember why they marked the location. Is an empty string if the user didn’t provide one. */
|
|
3746
|
+
description: string;
|
|
3747
|
+
/**
|
|
3748
|
+
* Format: int32
|
|
3749
|
+
* @description The relative offset (in seconds) of the marker from the beginning of the stream.
|
|
3750
|
+
*/
|
|
3751
|
+
position_seconds: number;
|
|
3752
|
+
/** @description A URL that opens the video in Twitch Highlighter. */
|
|
3753
|
+
url: string;
|
|
3754
|
+
}[];
|
|
3743
3755
|
}[];
|
|
3744
3756
|
};
|
|
3745
3757
|
GetStreamMarkersResponse: {
|
|
@@ -3995,6 +4007,19 @@ interface components {
|
|
|
3995
4007
|
/** @description A list contains the single user that you updated. */
|
|
3996
4008
|
data: components["schemas"]["User"][];
|
|
3997
4009
|
};
|
|
4010
|
+
GetAuthorizationByUserResponse: {
|
|
4011
|
+
/** @description List of users and their authorized scopes. */
|
|
4012
|
+
data: {
|
|
4013
|
+
/** @description The user’s ID. */
|
|
4014
|
+
user_id: string;
|
|
4015
|
+
/** @description The user’s display name. */
|
|
4016
|
+
user_name: string;
|
|
4017
|
+
/** @description The user’s login name. */
|
|
4018
|
+
user_login: string;
|
|
4019
|
+
/** @description An array of all the scopes the user has granted to the client ID. */
|
|
4020
|
+
scopes: string[];
|
|
4021
|
+
}[];
|
|
4022
|
+
};
|
|
3998
4023
|
UserBlockList: {
|
|
3999
4024
|
/** @description An ID that identifies the blocked user. */
|
|
4000
4025
|
user_id: string;
|
|
@@ -6413,6 +6438,58 @@ interface operations {
|
|
|
6413
6438
|
};
|
|
6414
6439
|
};
|
|
6415
6440
|
};
|
|
6441
|
+
/**
|
|
6442
|
+
* NEW Provides URLs to download the video file(s) for the specified clips.
|
|
6443
|
+
* @description NEW Provides URLs to download the video file(s) for the specified clips. For information about clips, see [How to use clips](https://help.twitch.tv/s/article/how-to-use-clips).
|
|
6444
|
+
*
|
|
6445
|
+
* **Rate Limits**: Limited to 100 requests per minute.
|
|
6446
|
+
*
|
|
6447
|
+
* __Authorization:__
|
|
6448
|
+
*
|
|
6449
|
+
* Requires an [app access token](https://dev.twitch.tv/docs/authentication#app-access-tokens) or [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens) that includes the `editor:manage:clips` or `channel:manage:clips` scope.
|
|
6450
|
+
*/
|
|
6451
|
+
"get-clips-download": {
|
|
6452
|
+
parameters: {
|
|
6453
|
+
query: {
|
|
6454
|
+
/** @description The User ID of the editor for the channel you want to download a clip for. If using the broadcaster’s auth token, this is the same as `broadcaster_id`. This must match the `user_id` in the user access token. */
|
|
6455
|
+
editor_id: string;
|
|
6456
|
+
/** @description The ID of the broadcaster you want to download clips for. */
|
|
6457
|
+
broadcaster_id: string;
|
|
6458
|
+
/** @description The ID that identifies the clip you want to download. Include this parameter for each clip you want to download, up to a maximum of 10 clips. For example, `clip_id=SleepyGiftedPeppermintNerfRedBlaster-KbkBXYt3lOk3jy8-&clip_id=WimpyAltruisticKleeKeyboardCat-EiY5yMrEwZ4i4gwC`. */
|
|
6459
|
+
clip_id: string[];
|
|
6460
|
+
};
|
|
6461
|
+
};
|
|
6462
|
+
responses: {
|
|
6463
|
+
/** @description Successfully retrieved the clip download URL(s). */
|
|
6464
|
+
200: {
|
|
6465
|
+
content: {
|
|
6466
|
+
"application/json": components["schemas"]["GetClipsDownloadResponse"];
|
|
6467
|
+
};
|
|
6468
|
+
};
|
|
6469
|
+
/** @description The ID in the broadcaster\_id, editor\_id, or clip\_id query parameter is not valid. */
|
|
6470
|
+
400: {
|
|
6471
|
+
content: never;
|
|
6472
|
+
};
|
|
6473
|
+
/**
|
|
6474
|
+
* @description * The OAuth token is not valid.
|
|
6475
|
+
* * The Authorization header is required and must contain a user access token or app access token.
|
|
6476
|
+
* * The access token must include the editor:manage:clips or channel:manage:clips scope
|
|
6477
|
+
* * The access token is not valid
|
|
6478
|
+
* * The client ID specified in the Client-Id header does not match the client ID specified in the access token.
|
|
6479
|
+
*/
|
|
6480
|
+
401: {
|
|
6481
|
+
content: never;
|
|
6482
|
+
};
|
|
6483
|
+
/** @description The user is not an editor for the specified broadcaster. */
|
|
6484
|
+
403: {
|
|
6485
|
+
content: never;
|
|
6486
|
+
};
|
|
6487
|
+
/** @description Internal Server Error. */
|
|
6488
|
+
500: {
|
|
6489
|
+
content: never;
|
|
6490
|
+
};
|
|
6491
|
+
};
|
|
6492
|
+
};
|
|
6416
6493
|
/**
|
|
6417
6494
|
* NEW Gets the conduits for a client ID.
|
|
6418
6495
|
* @description NEW Gets the [conduits](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/) for a client ID.
|
|
@@ -8427,8 +8504,11 @@ interface operations {
|
|
|
8427
8504
|
};
|
|
8428
8505
|
};
|
|
8429
8506
|
/**
|
|
8507
|
+
* DEPRECATED Gets information about the broadcaster’s current or most recent Hype Train event.
|
|
8508
|
+
* @deprecated
|
|
8509
|
+
* @description DEPRECATED Scheduled for removal on December 4, 2025\. Use “Get Hype Train Status” instead. See [announcement](https://discuss.dev.twitch.com/t/legacy-get-hype-train-events-api-and-eventsub-hype-train-v1-subscription-types-deprecation-and-withdrawal-timeline/64299).
|
|
8510
|
+
*
|
|
8430
8511
|
* Gets information about the broadcaster’s current or most recent Hype Train event.
|
|
8431
|
-
* @description Gets information about the broadcaster’s current or most recent Hype Train event.
|
|
8432
8512
|
*
|
|
8433
8513
|
* Instead of polling for events, consider [subscribing](https://dev.twitch.tv/docs/eventsub/manage-subscriptions) to Hype Train events ([Begin](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelhype%5Ftrainbegin), [Progress](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelhype%5Ftrainprogress), [End](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelhype%5Ftrainend)).
|
|
8434
8514
|
*
|
|
@@ -8467,8 +8547,8 @@ interface operations {
|
|
|
8467
8547
|
};
|
|
8468
8548
|
};
|
|
8469
8549
|
/**
|
|
8470
|
-
*
|
|
8471
|
-
* @description
|
|
8550
|
+
* NEW Gets the status of a Hype Train for the specified broadcaster.
|
|
8551
|
+
* @description NEW Get the status of a Hype Train for the specified broadcaster.
|
|
8472
8552
|
*
|
|
8473
8553
|
* __Authorization:__
|
|
8474
8554
|
*
|
|
@@ -11422,6 +11502,49 @@ interface operations {
|
|
|
11422
11502
|
};
|
|
11423
11503
|
};
|
|
11424
11504
|
};
|
|
11505
|
+
/**
|
|
11506
|
+
* NEW Gets the authorization scopes that the specified user has granted the application.
|
|
11507
|
+
* @description NEW Gets the authorization scopes that the specified user(s) have granted the application.
|
|
11508
|
+
*
|
|
11509
|
+
* __Authorization:__
|
|
11510
|
+
*
|
|
11511
|
+
* Requires an [app access token](https://dev.twitch.tv/docs/authentication#app-access-tokens).
|
|
11512
|
+
*/
|
|
11513
|
+
"get-authorization-by-user": {
|
|
11514
|
+
parameters: {
|
|
11515
|
+
query: {
|
|
11516
|
+
/** @description The ID of the user(s) you want to check authorization for. To specify more than one user, include the user\_id parameter for each user to get. For example, `user_id=1234&user_id=5678`. The maximum number of IDs you may specify is 10. */
|
|
11517
|
+
user_id: string[];
|
|
11518
|
+
};
|
|
11519
|
+
};
|
|
11520
|
+
responses: {
|
|
11521
|
+
/** @description Successfully retrieved user authorization. */
|
|
11522
|
+
200: {
|
|
11523
|
+
content: {
|
|
11524
|
+
"application/json": components["schemas"]["GetAuthorizationByUserResponse"];
|
|
11525
|
+
};
|
|
11526
|
+
};
|
|
11527
|
+
/** @description Request is malformed - invalid parameters or missing parameters. */
|
|
11528
|
+
400: {
|
|
11529
|
+
content: never;
|
|
11530
|
+
};
|
|
11531
|
+
/**
|
|
11532
|
+
* @description * The access token is not valid.
|
|
11533
|
+
* * Authorization header is required and must specify an app access token.
|
|
11534
|
+
*/
|
|
11535
|
+
401: {
|
|
11536
|
+
content: never;
|
|
11537
|
+
};
|
|
11538
|
+
/** @description The client-id in the header must match the client ID in the access token. */
|
|
11539
|
+
403: {
|
|
11540
|
+
content: never;
|
|
11541
|
+
};
|
|
11542
|
+
/** @description Internal Server Error. */
|
|
11543
|
+
500: {
|
|
11544
|
+
content: never;
|
|
11545
|
+
};
|
|
11546
|
+
};
|
|
11547
|
+
};
|
|
11425
11548
|
/**
|
|
11426
11549
|
* Gets the list of users that the broadcaster has blocked.
|
|
11427
11550
|
* @description 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)
|
|
@@ -12003,6 +12126,7 @@ type GetUserChatColorParams = ParamsSchema<'get-user-chat-color'>;
|
|
|
12003
12126
|
type UpdateUserChatColorParams = ParamsSchema<'update-user-chat-color'>;
|
|
12004
12127
|
type CreateClipParams = ParamsSchema<'create-clip'>;
|
|
12005
12128
|
type GetClipsParams = ParamsSchema<'get-clips'>;
|
|
12129
|
+
type GetClipsDownloadParams = ParamsSchema<'get-clips-download'>;
|
|
12006
12130
|
type DeleteConduitParams = ParamsSchema<'delete-conduit'>;
|
|
12007
12131
|
type GetConduitShardsParams = ParamsSchema<'get-conduit-shards'>;
|
|
12008
12132
|
type GetContentClassificationLabelsParams = ParamsSchema<'get-content-classification-labels'>;
|
|
@@ -12080,6 +12204,7 @@ type GetChannelTeamsParams = ParamsSchema<'get-channel-teams'>;
|
|
|
12080
12204
|
type GetTeamsParams = ParamsSchema<'get-teams'>;
|
|
12081
12205
|
type GetUsersParams = ParamsSchema<'get-users'>;
|
|
12082
12206
|
type UpdateUserParams = ParamsSchema<'update-user'>;
|
|
12207
|
+
type GetAuthorizationByUserParams = ParamsSchema<'get-authorization-by-user'>;
|
|
12083
12208
|
type GetUserBlockListParams = ParamsSchema<'get-user-block-list'>;
|
|
12084
12209
|
type BlockUserParams = ParamsSchema<'block-user'>;
|
|
12085
12210
|
type UnblockUserParams = ParamsSchema<'unblock-user'>;
|
|
@@ -12151,6 +12276,7 @@ type GetUserChatColorResponse = Schema<'GetUserChatColorResponse'>;
|
|
|
12151
12276
|
type CreateClipResponse = Schema<'CreateClipResponse'>;
|
|
12152
12277
|
type Clip = Schema<'Clip'>;
|
|
12153
12278
|
type GetClipsResponse = Schema<'GetClipsResponse'>;
|
|
12279
|
+
type GetClipsDownloadResponse = Schema<'GetClipsDownloadResponse'>;
|
|
12154
12280
|
type GetConduitsResponse = Schema<'GetConduitsResponse'>;
|
|
12155
12281
|
type CreateConduitsBody = Schema<'CreateConduitsBody'>;
|
|
12156
12282
|
type CreateConduitsResponse = Schema<'CreateConduitsResponse'>;
|
|
@@ -12281,6 +12407,7 @@ type GetTeamsResponse = Schema<'GetTeamsResponse'>;
|
|
|
12281
12407
|
type User = Schema<'User'>;
|
|
12282
12408
|
type GetUsersResponse = Schema<'GetUsersResponse'>;
|
|
12283
12409
|
type UpdateUserResponse = Schema<'UpdateUserResponse'>;
|
|
12410
|
+
type GetAuthorizationByUserResponse = Schema<'GetAuthorizationByUserResponse'>;
|
|
12284
12411
|
type UserBlockList = Schema<'UserBlockList'>;
|
|
12285
12412
|
type GetUserBlockListResponse = Schema<'GetUserBlockListResponse'>;
|
|
12286
12413
|
type UserExtension = Schema<'UserExtension'>;
|
|
@@ -14006,6 +14133,54 @@ declare class TwitchApi {
|
|
|
14006
14133
|
cursor?: string;
|
|
14007
14134
|
};
|
|
14008
14135
|
}, 200, 400 | 401 | 404>;
|
|
14136
|
+
/**
|
|
14137
|
+
* NEW Provides URLs to download the video file(s) for the specified clips. For information about clips, see [How to use clips](https://help.twitch.tv/s/article/how-to-use-clips).
|
|
14138
|
+
*
|
|
14139
|
+
* **Rate Limits**: Limited to 100 requests per minute.
|
|
14140
|
+
*
|
|
14141
|
+
* __Authorization:__
|
|
14142
|
+
*
|
|
14143
|
+
* Requires an [app access token](https://dev.twitch.tv/docs/authentication#app-access-tokens) or [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens) that includes the `editor:manage:clips` or `channel:manage:clips` scope.
|
|
14144
|
+
*
|
|
14145
|
+
* __URL:__
|
|
14146
|
+
*
|
|
14147
|
+
* `GET https://api.twitch.tv/helix/clips/downloads`
|
|
14148
|
+
*
|
|
14149
|
+
* __Response Codes:__
|
|
14150
|
+
*
|
|
14151
|
+
* _200 OK_
|
|
14152
|
+
*
|
|
14153
|
+
* Successfully retrieved the clip download URL(s).
|
|
14154
|
+
*
|
|
14155
|
+
* _400 Bad Request_
|
|
14156
|
+
*
|
|
14157
|
+
* The ID in the broadcaster\_id, editor\_id, or clip\_id query parameter is not valid.
|
|
14158
|
+
*
|
|
14159
|
+
* _401 Unauthorized_
|
|
14160
|
+
*
|
|
14161
|
+
* * The OAuth token is not valid.
|
|
14162
|
+
* * The Authorization header is required and must contain a user access token or app access token.
|
|
14163
|
+
* * The access token must include the editor:manage:clips or channel:manage:clips scope
|
|
14164
|
+
* * The access token is not valid
|
|
14165
|
+
* * The client ID specified in the Client-Id header does not match the client ID specified in the access token.
|
|
14166
|
+
*
|
|
14167
|
+
* _403 Forbidden_
|
|
14168
|
+
*
|
|
14169
|
+
* The user is not an editor for the specified broadcaster.
|
|
14170
|
+
*
|
|
14171
|
+
* _500 Internal Server Error_
|
|
14172
|
+
*
|
|
14173
|
+
* Internal Server Error.
|
|
14174
|
+
*
|
|
14175
|
+
* @see https://dev.twitch.tv/docs/api/reference#get-clips-download
|
|
14176
|
+
*/
|
|
14177
|
+
getClipsDownload: (params: GetClipsDownloadParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
14178
|
+
data: {
|
|
14179
|
+
clip_id: string;
|
|
14180
|
+
landscape_download_url: string;
|
|
14181
|
+
portrait_download_url: string;
|
|
14182
|
+
}[];
|
|
14183
|
+
}, 200, 400 | 401 | 403 | 500>;
|
|
14009
14184
|
};
|
|
14010
14185
|
conduits: {
|
|
14011
14186
|
/**
|
|
@@ -15488,6 +15663,8 @@ declare class TwitchApi {
|
|
|
15488
15663
|
};
|
|
15489
15664
|
hypeTrain: {
|
|
15490
15665
|
/**
|
|
15666
|
+
* DEPRECATED Scheduled for removal on December 4, 2025\. Use “Get Hype Train Status” instead. See [announcement](https://discuss.dev.twitch.com/t/legacy-get-hype-train-events-api-and-eventsub-hype-train-v1-subscription-types-deprecation-and-withdrawal-timeline/64299).
|
|
15667
|
+
*
|
|
15491
15668
|
* Gets information about the broadcaster’s current or most recent Hype Train event.
|
|
15492
15669
|
*
|
|
15493
15670
|
* Instead of polling for events, consider [subscribing](https://dev.twitch.tv/docs/eventsub/manage-subscriptions) to Hype Train events ([Begin](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelhype%5Ftrainbegin), [Progress](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelhype%5Ftrainprogress), [End](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelhype%5Ftrainend)).
|
|
@@ -15523,7 +15700,7 @@ declare class TwitchApi {
|
|
|
15523
15700
|
};
|
|
15524
15701
|
}, 200, 401>;
|
|
15525
15702
|
/**
|
|
15526
|
-
*
|
|
15703
|
+
* NEW Get the status of a Hype Train for the specified broadcaster.
|
|
15527
15704
|
*
|
|
15528
15705
|
* __Authorization:__
|
|
15529
15706
|
*
|
|
@@ -17943,6 +18120,50 @@ declare class TwitchApi {
|
|
|
17943
18120
|
updateUser: (params?: UpdateUserParams | null | undefined, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
17944
18121
|
data: components["schemas"]["User"][];
|
|
17945
18122
|
}, 200, 400 | 401 | 429>;
|
|
18123
|
+
/**
|
|
18124
|
+
* NEW Gets the authorization scopes that the specified user(s) have granted the application.
|
|
18125
|
+
*
|
|
18126
|
+
* __Authorization:__
|
|
18127
|
+
*
|
|
18128
|
+
* Requires an [app access token](https://dev.twitch.tv/docs/authentication#app-access-tokens).
|
|
18129
|
+
*
|
|
18130
|
+
* __URL:__
|
|
18131
|
+
*
|
|
18132
|
+
* `GET https://api.twitch.tv/helix/authorization/users`
|
|
18133
|
+
*
|
|
18134
|
+
* __Response Codes:__
|
|
18135
|
+
*
|
|
18136
|
+
* _200 OK_
|
|
18137
|
+
*
|
|
18138
|
+
* Successfully retrieved user authorization.
|
|
18139
|
+
*
|
|
18140
|
+
* _400 Bad Request_
|
|
18141
|
+
*
|
|
18142
|
+
* Request is malformed - invalid parameters or missing parameters.
|
|
18143
|
+
*
|
|
18144
|
+
* _401 Unauthorized_
|
|
18145
|
+
*
|
|
18146
|
+
* * The access token is not valid.
|
|
18147
|
+
* * Authorization header is required and must specify an app access token.
|
|
18148
|
+
*
|
|
18149
|
+
* _403 Forbidden_
|
|
18150
|
+
*
|
|
18151
|
+
* The client-id in the header must match the client ID in the access token.
|
|
18152
|
+
*
|
|
18153
|
+
* _500 Internal Server Error_
|
|
18154
|
+
*
|
|
18155
|
+
* Internal Server Error.
|
|
18156
|
+
*
|
|
18157
|
+
* @see https://dev.twitch.tv/docs/api/reference#get-authorization-by-user
|
|
18158
|
+
*/
|
|
18159
|
+
getAuthorizationByUser: (params: GetAuthorizationByUserParams, options?: CallApiOptions["options"]) => ApiResponse<{
|
|
18160
|
+
data: {
|
|
18161
|
+
user_id: string;
|
|
18162
|
+
user_name: string;
|
|
18163
|
+
user_login: string;
|
|
18164
|
+
scopes: string[];
|
|
18165
|
+
}[];
|
|
18166
|
+
}, 200, 400 | 401 | 403 | 500>;
|
|
17946
18167
|
/**
|
|
17947
18168
|
* 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)
|
|
17948
18169
|
*
|
|
@@ -18316,4 +18537,4 @@ declare class TwitchApi {
|
|
|
18316
18537
|
};
|
|
18317
18538
|
}
|
|
18318
18539
|
|
|
18319
|
-
export { type AddBlockedTermBody, type AddBlockedTermParams, type AddBlockedTermResponse, type AddChannelModeratorParams, type AddChannelVIPParams, type ApiResponse, type AssignGuestStarSlotParams, type AutoModSettings, type AutoModStatus, type BanUserBody, type BanUserParams, type BanUserResponse, type BannedUser, type BitsLeaderboard, type BlockUserParams, type BlockedTerm, type BroadcasterSubscription, type CancelRaidParams, type Category, type Channel, type ChannelEditor, type ChannelEmote, type ChannelInformation, type ChannelStreamScheduleSegment, type ChannelTeam, type CharityCampaign, type CharityCampaignDonation, type ChatBadge, type ChatSettings, type ChatSettingsUpdated, type Chatter, type CheckAutoModStatusBody, type CheckAutoModStatusParams, type CheckAutoModStatusResponse, type CheckUserSubscriptionParams, type CheckUserSubscriptionResponse, type Cheermote, type CheermoteImageFormat, type CheermoteImageTheme, type CheermoteImages, type Clip, type ContentClassificationLabel, type CreateChannelStreamScheduleSegmentBody, type CreateChannelStreamScheduleSegmentParams, type CreateChannelStreamScheduleSegmentResponse, type CreateClipParams, type CreateClipResponse, type CreateConduitsBody, type CreateConduitsResponse, type CreateCustomRewardsBody, type CreateCustomRewardsParams, type CreateCustomRewardsResponse, type CreateEventSubSubscriptionBody, type CreateEventSubSubscriptionResponse, type CreateExtensionSecretParams, type CreateExtensionSecretResponse, type CreateGuestStarSessionParams, type CreateGuestStarSessionResponse, type CreatePollBody, type CreatePollResponse, type CreatePredictionBody, type CreatePredictionResponse, type CreateStreamMarkerBody, type CreateStreamMarkerResponse, type CreatorGoal, type CustomReward, type CustomRewardRedemption, type DeleteChannelStreamScheduleSegmentParams, type DeleteChatMessagesParams, type DeleteConduitParams, type DeleteCustomRewardParams, type DeleteEventSubSubscriptionParams, type DeleteGuestStarInviteParams, type DeleteGuestStarSlotParams, type DeleteVideosParams, type DeleteVideosResponse, type DropsEntitlement, type DropsEntitlementUpdated, type Emote, type EndGuestStarSessionParams, type EndGuestStarSessionResponse, type EndPollBody, type EndPollResponse, type EndPredictionBody, type EndPredictionResponse, type EventSubSubscription, type Extension, type ExtensionAnalytics, type ExtensionBitsProduct, type ExtensionConfigurationSegment, type ExtensionIconUrls, type ExtensionLiveChannel, type ExtensionSecret, type ExtensionTransaction, type Game, type GameAnalytics, type GetAdScheduleParams, type GetAdScheduleResponse, type GetAllStreamTagsParams, type GetAllStreamTagsResponse, type GetAutoModSettingsParams, type GetAutoModSettingsResponse, type GetBannedUsersParams, type GetBannedUsersResponse, type GetBitsLeaderboardParams, type GetBitsLeaderboardResponse, type GetBlockedTermsParams, type GetBlockedTermsResponse, type GetBroadcasterSubscriptionsParams, type GetBroadcasterSubscriptionsResponse, type GetChannelChatBadgesParams, type GetChannelChatBadgesResponse, type GetChannelEditorsParams, type GetChannelEditorsResponse, type GetChannelEmotesParams, type GetChannelEmotesResponse, type GetChannelFollowersParams, type GetChannelFollowersResponse, type GetChannelGuestStarSettingsParams, type GetChannelGuestStarSettingsResponse, type GetChannelICalendarParams, type GetChannelInformationParams, type GetChannelInformationResponse, type GetChannelStreamScheduleParams, type GetChannelStreamScheduleResponse, type GetChannelTeamsParams, type GetChannelTeamsResponse, type GetCharityCampaignDonationsParams, type GetCharityCampaignDonationsResponse, type GetCharityCampaignParams, type GetCharityCampaignResponse, type GetChatSettingsParams, type GetChatSettingsResponse, type GetChattersParams, type GetChattersResponse, type GetCheermotesParams, type GetCheermotesResponse, type GetClipsParams, type GetClipsResponse, type GetConduitShardsParams, type GetConduitShardsResponse, type GetConduitsResponse, type GetContentClassificationLabelsParams, type GetContentClassificationLabelsResponse, type GetCreatorGoalsParams, type GetCreatorGoalsResponse, type GetCustomRewardParams, type GetCustomRewardRedemptionParams, type GetCustomRewardRedemptionResponse, type GetCustomRewardResponse, type GetDropsEntitlementsParams, type GetDropsEntitlementsResponse, type GetEmoteSetsParams, type GetEmoteSetsResponse, type GetEventSubSubscriptionsParams, type GetEventSubSubscriptionsResponse, type GetExtensionAnalyticsParams, type GetExtensionAnalyticsResponse, type GetExtensionBitsProductsParams, type GetExtensionBitsProductsResponse, type GetExtensionConfigurationSegmentParams, type GetExtensionConfigurationSegmentResponse, type GetExtensionLiveChannelsParams, type GetExtensionLiveChannelsResponse, type GetExtensionSecretsResponse, type GetExtensionTransactionsParams, type GetExtensionTransactionsResponse, type GetExtensionsParams, type GetExtensionsResponse, type GetFollowedChannelsParams, type GetFollowedChannelsResponse, type GetFollowedStreamsParams, type GetFollowedStreamsResponse, type GetGameAnalyticsParams, type GetGameAnalyticsResponse, type GetGamesParams, type GetGamesResponse, type GetGlobalChatBadgesResponse, type GetGlobalEmotesResponse, type GetGuestStarInvitesParams, type GetGuestStarInvitesResponse, type GetGuestStarSessionParams, type GetGuestStarSessionResponse, type GetHypeTrainEventsParams, type GetHypeTrainEventsResponse, type GetHypeTrainStatusParams, type GetHypeTrainStatusResponse, type GetModeratedChannelsParams, type GetModeratedChannelsResponse, type GetModeratorsParams, type GetModeratorsResponse, type GetPollsParams, type GetPollsResponse, type GetPredictionsParams, type GetPredictionsResponse, type GetReleasedExtensionsParams, type GetReleasedExtensionsResponse, type GetSharedChatSessionParams, type GetSharedChatSessionResponse, type GetShieldModeStatusParams, type GetShieldModeStatusResponse, type GetStreamKeyParams, type GetStreamKeyResponse, type GetStreamMarkersParams, type GetStreamMarkersResponse, type GetStreamTagsParams, type GetStreamTagsResponse, type GetStreamsParams, type GetStreamsResponse, type GetTeamsParams, type GetTeamsResponse, type GetTopGamesParams, type GetTopGamesResponse, type GetUnbanRequestsParams, type GetUnbanRequestsResponse, type GetUserActiveExtensionsParams, type GetUserActiveExtensionsResponse, type GetUserBlockListParams, type GetUserBlockListResponse, type GetUserChatColorParams, type GetUserChatColorResponse, type GetUserEmotesParams, type GetUserEmotesResponse, type GetUserExtensionsResponse, type GetUsersParams, type GetUsersResponse, type GetVIPsParams, type GetVIPsResponse, type GetVideosParams, type GetVideosResponse, type GlobalEmote, type Guest, type GuestStarInvite, type GuestStarSession, type HypeTrainEvent, type ManageHeldAutoModMessagesBody, type ModifyChannelInformationBody, type ModifyChannelInformationParams, type Poll, type Prediction, type PredictionOutcome, type RemoveBlockedTermParams, type RemoveChannelModeratorParams, type RemoveChannelVIPParams, type ResolveUnbanRequestsParams, type ResolveUnbanRequestsResponse, type SearchCategoriesParams, type SearchCategoriesResponse, type SearchChannelsParams, type SearchChannelsResponse, type SendChatAnnouncementBody, type SendChatAnnouncementParams, type SendChatMessageBody, type SendChatMessageResponse, type SendExtensionChatMessageBody, type SendExtensionChatMessageParams, type SendExtensionPubSubMessageBody, type SendGuestStarInviteParams, type SendShoutoutParams, type SendWhisperBody, type SendWhisperParams, type SetExtensionConfigurationSegmentBody, type SetExtensionRequiredConfigurationBody, type SetExtensionRequiredConfigurationParams, type SnoozeNextAdParams, type SnoozeNextAdResponse, type StartCommercialBody, type StartCommercialResponse, type StartRaidParams, type StartRaidResponse, type Stream, type StreamMarkerCreated, type StreamMarkers, type StreamTag, type Team, TwitchApi, type TwitchApiOptions, type UnbanUserParams, type UnblockUserParams, type UpdateAutoModSettingsBody, type UpdateAutoModSettingsParams, type UpdateAutoModSettingsResponse, type UpdateChannelGuestStarSettingsBody, type UpdateChannelGuestStarSettingsParams, type UpdateChannelStreamScheduleParams, type UpdateChannelStreamScheduleSegmentBody, type UpdateChannelStreamScheduleSegmentParams, type UpdateChannelStreamScheduleSegmentResponse, type UpdateChatSettingsBody, type UpdateChatSettingsParams, type UpdateChatSettingsResponse, type UpdateConduitShardsBody, type UpdateConduitShardsResponse, type UpdateConduitsBody, type UpdateConduitsResponse, type UpdateCustomRewardBody, type UpdateCustomRewardParams, type UpdateCustomRewardResponse, type UpdateDropsEntitlementsBody, type UpdateDropsEntitlementsResponse, type UpdateExtensionBitsProductBody, type UpdateExtensionBitsProductResponse, type UpdateGuestStarSlotParams, type UpdateGuestStarSlotSettingsParams, type UpdateRedemptionStatusBody, type UpdateRedemptionStatusParams, type UpdateRedemptionStatusResponse, type UpdateShieldModeStatusBody, type UpdateShieldModeStatusParams, type UpdateShieldModeStatusResponse, type UpdateUserChatColorParams, type UpdateUserExtensionsBody, type UpdateUserExtensionsResponse, type UpdateUserParams, type UpdateUserResponse, type User, type UserBlockList, type UserChatColor, type UserExtension, type UserExtensionComponent, type UserExtensionComponentUpdate, type UserExtensionOverlay, type UserExtensionOverlayUpdate, type UserExtensionPanel, type UserExtensionPanelUpdate, type UserModerator, type UserSubscription, type UserVip, type Video, type WarnChatUserBody, type WarnChatUserParams, type WarnChatUserResponse };
|
|
18540
|
+
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 GetAuthorizationByUserParams, type GetAuthorizationByUserResponse, 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 GetClipsDownloadParams, type GetClipsDownloadResponse, type GetClipsParams, type GetClipsResponse, type GetConduitShardsParams, type GetConduitShardsResponse, type GetConduitsResponse, type GetContentClassificationLabelsParams, type GetContentClassificationLabelsResponse, type GetCreatorGoalsParams, type GetCreatorGoalsResponse, type GetCustomRewardParams, type GetCustomRewardRedemptionParams, type GetCustomRewardRedemptionResponse, type GetCustomRewardResponse, type GetDropsEntitlementsParams, type GetDropsEntitlementsResponse, type GetEmoteSetsParams, type GetEmoteSetsResponse, type GetEventSubSubscriptionsParams, type GetEventSubSubscriptionsResponse, type GetExtensionAnalyticsParams, type GetExtensionAnalyticsResponse, type GetExtensionBitsProductsParams, type GetExtensionBitsProductsResponse, type GetExtensionConfigurationSegmentParams, type GetExtensionConfigurationSegmentResponse, type GetExtensionLiveChannelsParams, type GetExtensionLiveChannelsResponse, type GetExtensionSecretsResponse, type GetExtensionTransactionsParams, type GetExtensionTransactionsResponse, type GetExtensionsParams, type GetExtensionsResponse, type GetFollowedChannelsParams, type GetFollowedChannelsResponse, type GetFollowedStreamsParams, type GetFollowedStreamsResponse, type GetGameAnalyticsParams, type GetGameAnalyticsResponse, type GetGamesParams, type GetGamesResponse, type GetGlobalChatBadgesResponse, type GetGlobalEmotesResponse, type GetGuestStarInvitesParams, type GetGuestStarInvitesResponse, type GetGuestStarSessionParams, type GetGuestStarSessionResponse, type GetHypeTrainEventsParams, type GetHypeTrainEventsResponse, type GetHypeTrainStatusParams, type GetHypeTrainStatusResponse, type GetModeratedChannelsParams, type GetModeratedChannelsResponse, type GetModeratorsParams, type GetModeratorsResponse, type GetPollsParams, type GetPollsResponse, type GetPredictionsParams, type GetPredictionsResponse, type GetReleasedExtensionsParams, type GetReleasedExtensionsResponse, type GetSharedChatSessionParams, type GetSharedChatSessionResponse, type GetShieldModeStatusParams, type GetShieldModeStatusResponse, type GetStreamKeyParams, type GetStreamKeyResponse, type GetStreamMarkersParams, type GetStreamMarkersResponse, type GetStreamTagsParams, type GetStreamTagsResponse, type GetStreamsParams, type GetStreamsResponse, type GetTeamsParams, type GetTeamsResponse, type GetTopGamesParams, type GetTopGamesResponse, type GetUnbanRequestsParams, type GetUnbanRequestsResponse, type GetUserActiveExtensionsParams, type GetUserActiveExtensionsResponse, type GetUserBlockListParams, type GetUserBlockListResponse, type GetUserChatColorParams, type GetUserChatColorResponse, type GetUserEmotesParams, type GetUserEmotesResponse, type GetUserExtensionsResponse, type GetUsersParams, type GetUsersResponse, type GetVIPsParams, type GetVIPsResponse, type GetVideosParams, type GetVideosResponse, type GlobalEmote, type Guest, type GuestStarInvite, type GuestStarSession, type HypeTrainEvent, type ManageHeldAutoModMessagesBody, type ModifyChannelInformationBody, type ModifyChannelInformationParams, type Poll, type Prediction, type PredictionOutcome, type RemoveBlockedTermParams, type RemoveChannelModeratorParams, type RemoveChannelVIPParams, type ResolveUnbanRequestsParams, type ResolveUnbanRequestsResponse, type SearchCategoriesParams, type SearchCategoriesResponse, type SearchChannelsParams, type SearchChannelsResponse, type SendChatAnnouncementBody, type SendChatAnnouncementParams, type SendChatMessageBody, type SendChatMessageResponse, type SendExtensionChatMessageBody, type SendExtensionChatMessageParams, type SendExtensionPubSubMessageBody, type SendGuestStarInviteParams, type SendShoutoutParams, type SendWhisperBody, type SendWhisperParams, type SetExtensionConfigurationSegmentBody, type SetExtensionRequiredConfigurationBody, type SetExtensionRequiredConfigurationParams, type SnoozeNextAdParams, type SnoozeNextAdResponse, type StartCommercialBody, type StartCommercialResponse, type StartRaidParams, type StartRaidResponse, type Stream, type StreamMarkerCreated, type StreamMarkers, type StreamTag, type Team, TwitchApi, type TwitchApiOptions, type UnbanUserParams, type UnblockUserParams, type UpdateAutoModSettingsBody, type UpdateAutoModSettingsParams, type UpdateAutoModSettingsResponse, type UpdateChannelGuestStarSettingsBody, type UpdateChannelGuestStarSettingsParams, type UpdateChannelStreamScheduleParams, type UpdateChannelStreamScheduleSegmentBody, type UpdateChannelStreamScheduleSegmentParams, type UpdateChannelStreamScheduleSegmentResponse, type UpdateChatSettingsBody, type UpdateChatSettingsParams, type UpdateChatSettingsResponse, type UpdateConduitShardsBody, type UpdateConduitShardsResponse, type UpdateConduitsBody, type UpdateConduitsResponse, type UpdateCustomRewardBody, type UpdateCustomRewardParams, type UpdateCustomRewardResponse, type UpdateDropsEntitlementsBody, type UpdateDropsEntitlementsResponse, type UpdateExtensionBitsProductBody, type UpdateExtensionBitsProductResponse, type UpdateGuestStarSlotParams, type UpdateGuestStarSlotSettingsParams, type UpdateRedemptionStatusBody, type UpdateRedemptionStatusParams, type UpdateRedemptionStatusResponse, type UpdateShieldModeStatusBody, type UpdateShieldModeStatusParams, type UpdateShieldModeStatusResponse, type UpdateUserChatColorParams, type UpdateUserExtensionsBody, type UpdateUserExtensionsResponse, type UpdateUserParams, type UpdateUserResponse, type User, type UserBlockList, type UserChatColor, type UserExtension, type UserExtensionComponent, type UserExtensionComponentUpdate, type UserExtensionOverlay, type UserExtensionOverlayUpdate, type UserExtensionPanel, type UserExtensionPanelUpdate, type UserModerator, type UserSubscription, type UserVip, type Video, type WarnChatUserBody, type WarnChatUserParams, type WarnChatUserResponse };
|
package/dist/index.js
CHANGED
|
@@ -1744,6 +1744,52 @@ var TwitchApi = class {
|
|
|
1744
1744
|
path: "/clips",
|
|
1745
1745
|
params,
|
|
1746
1746
|
options
|
|
1747
|
+
}),
|
|
1748
|
+
/**
|
|
1749
|
+
* NEW Provides URLs to download the video file(s) for the specified clips. For information about clips, see [How to use clips](https://help.twitch.tv/s/article/how-to-use-clips).
|
|
1750
|
+
*
|
|
1751
|
+
* **Rate Limits**: Limited to 100 requests per minute.
|
|
1752
|
+
*
|
|
1753
|
+
* __Authorization:__
|
|
1754
|
+
*
|
|
1755
|
+
* Requires an [app access token](https://dev.twitch.tv/docs/authentication#app-access-tokens) or [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens) that includes the `editor:manage:clips` or `channel:manage:clips` scope.
|
|
1756
|
+
*
|
|
1757
|
+
* __URL:__
|
|
1758
|
+
*
|
|
1759
|
+
* `GET https://api.twitch.tv/helix/clips/downloads`
|
|
1760
|
+
*
|
|
1761
|
+
* __Response Codes:__
|
|
1762
|
+
*
|
|
1763
|
+
* _200 OK_
|
|
1764
|
+
*
|
|
1765
|
+
* Successfully retrieved the clip download URL(s).
|
|
1766
|
+
*
|
|
1767
|
+
* _400 Bad Request_
|
|
1768
|
+
*
|
|
1769
|
+
* The ID in the broadcaster\_id, editor\_id, or clip\_id query parameter is not valid.
|
|
1770
|
+
*
|
|
1771
|
+
* _401 Unauthorized_
|
|
1772
|
+
*
|
|
1773
|
+
* * The OAuth token is not valid.
|
|
1774
|
+
* * The Authorization header is required and must contain a user access token or app access token.
|
|
1775
|
+
* * The access token must include the editor:manage:clips or channel:manage:clips scope
|
|
1776
|
+
* * The access token is not valid
|
|
1777
|
+
* * The client ID specified in the Client-Id header does not match the client ID specified in the access token.
|
|
1778
|
+
*
|
|
1779
|
+
* _403 Forbidden_
|
|
1780
|
+
*
|
|
1781
|
+
* The user is not an editor for the specified broadcaster.
|
|
1782
|
+
*
|
|
1783
|
+
* _500 Internal Server Error_
|
|
1784
|
+
*
|
|
1785
|
+
* Internal Server Error.
|
|
1786
|
+
*
|
|
1787
|
+
* @see https://dev.twitch.tv/docs/api/reference#get-clips-download
|
|
1788
|
+
*/
|
|
1789
|
+
getClipsDownload: (params, options = {}) => this.callApi({
|
|
1790
|
+
path: "/clips/downloads",
|
|
1791
|
+
params,
|
|
1792
|
+
options
|
|
1747
1793
|
})
|
|
1748
1794
|
};
|
|
1749
1795
|
conduits = {
|
|
@@ -3299,6 +3345,8 @@ var TwitchApi = class {
|
|
|
3299
3345
|
};
|
|
3300
3346
|
hypeTrain = {
|
|
3301
3347
|
/**
|
|
3348
|
+
* DEPRECATED Scheduled for removal on December 4, 2025\. Use “Get Hype Train Status” instead. See [announcement](https://discuss.dev.twitch.com/t/legacy-get-hype-train-events-api-and-eventsub-hype-train-v1-subscription-types-deprecation-and-withdrawal-timeline/64299).
|
|
3349
|
+
*
|
|
3302
3350
|
* Gets information about the broadcaster’s current or most recent Hype Train event.
|
|
3303
3351
|
*
|
|
3304
3352
|
* Instead of polling for events, consider [subscribing](https://dev.twitch.tv/docs/eventsub/manage-subscriptions) to Hype Train events ([Begin](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelhype%5Ftrainbegin), [Progress](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelhype%5Ftrainprogress), [End](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelhype%5Ftrainend)).
|
|
@@ -3333,7 +3381,7 @@ var TwitchApi = class {
|
|
|
3333
3381
|
options
|
|
3334
3382
|
}),
|
|
3335
3383
|
/**
|
|
3336
|
-
*
|
|
3384
|
+
* NEW Get the status of a Hype Train for the specified broadcaster.
|
|
3337
3385
|
*
|
|
3338
3386
|
* __Authorization:__
|
|
3339
3387
|
*
|
|
@@ -5741,6 +5789,47 @@ var TwitchApi = class {
|
|
|
5741
5789
|
params,
|
|
5742
5790
|
options
|
|
5743
5791
|
}),
|
|
5792
|
+
/**
|
|
5793
|
+
* NEW Gets the authorization scopes that the specified user(s) have granted the application.
|
|
5794
|
+
*
|
|
5795
|
+
* __Authorization:__
|
|
5796
|
+
*
|
|
5797
|
+
* Requires an [app access token](https://dev.twitch.tv/docs/authentication#app-access-tokens).
|
|
5798
|
+
*
|
|
5799
|
+
* __URL:__
|
|
5800
|
+
*
|
|
5801
|
+
* `GET https://api.twitch.tv/helix/authorization/users`
|
|
5802
|
+
*
|
|
5803
|
+
* __Response Codes:__
|
|
5804
|
+
*
|
|
5805
|
+
* _200 OK_
|
|
5806
|
+
*
|
|
5807
|
+
* Successfully retrieved user authorization.
|
|
5808
|
+
*
|
|
5809
|
+
* _400 Bad Request_
|
|
5810
|
+
*
|
|
5811
|
+
* Request is malformed - invalid parameters or missing parameters.
|
|
5812
|
+
*
|
|
5813
|
+
* _401 Unauthorized_
|
|
5814
|
+
*
|
|
5815
|
+
* * The access token is not valid.
|
|
5816
|
+
* * Authorization header is required and must specify an app access token.
|
|
5817
|
+
*
|
|
5818
|
+
* _403 Forbidden_
|
|
5819
|
+
*
|
|
5820
|
+
* The client-id in the header must match the client ID in the access token.
|
|
5821
|
+
*
|
|
5822
|
+
* _500 Internal Server Error_
|
|
5823
|
+
*
|
|
5824
|
+
* Internal Server Error.
|
|
5825
|
+
*
|
|
5826
|
+
* @see https://dev.twitch.tv/docs/api/reference#get-authorization-by-user
|
|
5827
|
+
*/
|
|
5828
|
+
getAuthorizationByUser: (params, options = {}) => this.callApi({
|
|
5829
|
+
path: "/authorization/users",
|
|
5830
|
+
params,
|
|
5831
|
+
options
|
|
5832
|
+
}),
|
|
5744
5833
|
/**
|
|
5745
5834
|
* 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)
|
|
5746
5835
|
*
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "ts-twitch-api",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.7",
|
|
4
4
|
"description": "Very simple TwitchApi class and TypeScript interfaces for all Twitch API endpoints",
|
|
5
5
|
"author": "DmitryScaletta",
|
|
6
6
|
"license": "MIT",
|
|
@@ -29,9 +29,9 @@
|
|
|
29
29
|
],
|
|
30
30
|
"type": "module",
|
|
31
31
|
"devDependencies": {
|
|
32
|
-
"@types/node": "^24.
|
|
33
|
-
"tsup": "
|
|
34
|
-
"typescript": "^5.9.
|
|
32
|
+
"@types/node": "^24.10.1",
|
|
33
|
+
"tsup": "8.5.1",
|
|
34
|
+
"typescript": "^5.9.3"
|
|
35
35
|
},
|
|
36
36
|
"scripts": {
|
|
37
37
|
"build": "pnpm build:src && tsup",
|