ts-twitch-api 0.2.3 → 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 +266 -157
- package/dist/index.d.cts +987 -3241
- package/dist/index.d.ts +987 -3241
- package/dist/index.js +263 -154
- package/package.json +9 -10
package/dist/index.js
CHANGED
|
@@ -108,7 +108,7 @@ var TwitchApi = class {
|
|
|
108
108
|
*
|
|
109
109
|
* @see https://dev.twitch.tv/docs/api/reference#start-commercial
|
|
110
110
|
*/
|
|
111
|
-
startCommercial:
|
|
111
|
+
startCommercial: (body, options = {}) => this.callApi({
|
|
112
112
|
path: "/channels/commercial",
|
|
113
113
|
method: "POST",
|
|
114
114
|
body,
|
|
@@ -139,7 +139,7 @@ var TwitchApi = class {
|
|
|
139
139
|
*
|
|
140
140
|
* @see https://dev.twitch.tv/docs/api/reference#get-ad-schedule
|
|
141
141
|
*/
|
|
142
|
-
getAdSchedule:
|
|
142
|
+
getAdSchedule: (params, options = {}) => this.callApi({
|
|
143
143
|
path: "/channels/ads",
|
|
144
144
|
params,
|
|
145
145
|
options
|
|
@@ -175,7 +175,7 @@ var TwitchApi = class {
|
|
|
175
175
|
*
|
|
176
176
|
* @see https://dev.twitch.tv/docs/api/reference#snooze-next-ad
|
|
177
177
|
*/
|
|
178
|
-
snoozeNextAd:
|
|
178
|
+
snoozeNextAd: (params, options = {}) => this.callApi({
|
|
179
179
|
path: "/channels/ads/schedule/snooze",
|
|
180
180
|
method: "POST",
|
|
181
181
|
params,
|
|
@@ -222,7 +222,7 @@ var TwitchApi = class {
|
|
|
222
222
|
*
|
|
223
223
|
* @see https://dev.twitch.tv/docs/api/reference#get-extension-analytics
|
|
224
224
|
*/
|
|
225
|
-
getExtensionAnalytics:
|
|
225
|
+
getExtensionAnalytics: (params = null, options = {}) => this.callApi({
|
|
226
226
|
path: "/analytics/extensions",
|
|
227
227
|
params,
|
|
228
228
|
options
|
|
@@ -266,7 +266,7 @@ var TwitchApi = class {
|
|
|
266
266
|
*
|
|
267
267
|
* @see https://dev.twitch.tv/docs/api/reference#get-game-analytics
|
|
268
268
|
*/
|
|
269
|
-
getGameAnalytics:
|
|
269
|
+
getGameAnalytics: (params = null, options = {}) => this.callApi({
|
|
270
270
|
path: "/analytics/games",
|
|
271
271
|
params,
|
|
272
272
|
options
|
|
@@ -307,7 +307,7 @@ var TwitchApi = class {
|
|
|
307
307
|
*
|
|
308
308
|
* @see https://dev.twitch.tv/docs/api/reference#get-bits-leaderboard
|
|
309
309
|
*/
|
|
310
|
-
getBitsLeaderboard:
|
|
310
|
+
getBitsLeaderboard: (params = null, options = {}) => this.callApi({
|
|
311
311
|
path: "/bits/leaderboard",
|
|
312
312
|
params,
|
|
313
313
|
options
|
|
@@ -336,7 +336,7 @@ var TwitchApi = class {
|
|
|
336
336
|
*
|
|
337
337
|
* @see https://dev.twitch.tv/docs/api/reference#get-cheermotes
|
|
338
338
|
*/
|
|
339
|
-
getCheermotes:
|
|
339
|
+
getCheermotes: (params = null, options = {}) => this.callApi({
|
|
340
340
|
path: "/bits/cheermotes",
|
|
341
341
|
params,
|
|
342
342
|
options
|
|
@@ -377,7 +377,7 @@ var TwitchApi = class {
|
|
|
377
377
|
*
|
|
378
378
|
* @see https://dev.twitch.tv/docs/api/reference#get-extension-transactions
|
|
379
379
|
*/
|
|
380
|
-
getExtensionTransactions:
|
|
380
|
+
getExtensionTransactions: (params, options = {}) => this.callApi({
|
|
381
381
|
path: "/extensions/transactions",
|
|
382
382
|
params,
|
|
383
383
|
options
|
|
@@ -421,7 +421,7 @@ var TwitchApi = class {
|
|
|
421
421
|
*
|
|
422
422
|
* @see https://dev.twitch.tv/docs/api/reference#get-channel-information
|
|
423
423
|
*/
|
|
424
|
-
getChannelInformation:
|
|
424
|
+
getChannelInformation: (params, options = {}) => this.callApi({
|
|
425
425
|
path: "/channels",
|
|
426
426
|
params,
|
|
427
427
|
options
|
|
@@ -483,7 +483,7 @@ var TwitchApi = class {
|
|
|
483
483
|
*
|
|
484
484
|
* @see https://dev.twitch.tv/docs/api/reference#modify-channel-information
|
|
485
485
|
*/
|
|
486
|
-
modifyChannelInformation:
|
|
486
|
+
modifyChannelInformation: (params, body = null, options = {}) => this.callApi({
|
|
487
487
|
path: "/channels",
|
|
488
488
|
method: "PATCH",
|
|
489
489
|
params,
|
|
@@ -521,7 +521,7 @@ var TwitchApi = class {
|
|
|
521
521
|
*
|
|
522
522
|
* @see https://dev.twitch.tv/docs/api/reference#get-channel-editors
|
|
523
523
|
*/
|
|
524
|
-
getChannelEditors:
|
|
524
|
+
getChannelEditors: (params, options = {}) => this.callApi({
|
|
525
525
|
path: "/channels/editors",
|
|
526
526
|
params,
|
|
527
527
|
options
|
|
@@ -563,7 +563,7 @@ var TwitchApi = class {
|
|
|
563
563
|
*
|
|
564
564
|
* @see https://dev.twitch.tv/docs/api/reference#get-followed-channels
|
|
565
565
|
*/
|
|
566
|
-
getFollowedChannels:
|
|
566
|
+
getFollowedChannels: (params, options = {}) => this.callApi({
|
|
567
567
|
path: "/channels/followed",
|
|
568
568
|
params,
|
|
569
569
|
options
|
|
@@ -608,7 +608,7 @@ var TwitchApi = class {
|
|
|
608
608
|
*
|
|
609
609
|
* @see https://dev.twitch.tv/docs/api/reference#get-channel-followers
|
|
610
610
|
*/
|
|
611
|
-
getChannelFollowers:
|
|
611
|
+
getChannelFollowers: (params, options = {}) => this.callApi({
|
|
612
612
|
path: "/channels/followers",
|
|
613
613
|
params,
|
|
614
614
|
options
|
|
@@ -661,7 +661,7 @@ var TwitchApi = class {
|
|
|
661
661
|
*
|
|
662
662
|
* @see https://dev.twitch.tv/docs/api/reference#create-custom-rewards
|
|
663
663
|
*/
|
|
664
|
-
createCustomRewards:
|
|
664
|
+
createCustomRewards: (params, body, options = {}) => this.callApi({
|
|
665
665
|
path: "/channel_points/custom_rewards",
|
|
666
666
|
method: "POST",
|
|
667
667
|
params,
|
|
@@ -712,7 +712,7 @@ var TwitchApi = class {
|
|
|
712
712
|
*
|
|
713
713
|
* @see https://dev.twitch.tv/docs/api/reference#delete-custom-reward
|
|
714
714
|
*/
|
|
715
|
-
deleteCustomReward:
|
|
715
|
+
deleteCustomReward: (params, options = {}) => this.callApi({
|
|
716
716
|
path: "/channel_points/custom_rewards",
|
|
717
717
|
method: "DELETE",
|
|
718
718
|
params,
|
|
@@ -761,7 +761,7 @@ var TwitchApi = class {
|
|
|
761
761
|
*
|
|
762
762
|
* @see https://dev.twitch.tv/docs/api/reference#get-custom-reward
|
|
763
763
|
*/
|
|
764
|
-
getCustomReward:
|
|
764
|
+
getCustomReward: (params, options = {}) => this.callApi({
|
|
765
765
|
path: "/channel_points/custom_rewards",
|
|
766
766
|
params,
|
|
767
767
|
options
|
|
@@ -771,7 +771,7 @@ var TwitchApi = class {
|
|
|
771
771
|
*
|
|
772
772
|
* __Authorization:__
|
|
773
773
|
*
|
|
774
|
-
* Requires a [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens) that includes the **channel:manage:redemptions** scope.
|
|
774
|
+
* Requires a [user access token](https://dev.twitch.tv/docs/api/authentication#user-access-tokens) that includes the **channel:manage:redemptions** scope.
|
|
775
775
|
*
|
|
776
776
|
* __Request Body:__
|
|
777
777
|
*
|
|
@@ -789,6 +789,7 @@ var TwitchApi = class {
|
|
|
789
789
|
*
|
|
790
790
|
* _400 Bad Request_
|
|
791
791
|
*
|
|
792
|
+
* ul>
|
|
792
793
|
* * The _broadcaster\_id_ query parameter is required.
|
|
793
794
|
* * The _id_ query parameter is required.
|
|
794
795
|
* * The `title` must contain a minimum of 1 character and a maximum of 45 characters.
|
|
@@ -819,7 +820,7 @@ var TwitchApi = class {
|
|
|
819
820
|
*
|
|
820
821
|
* @see https://dev.twitch.tv/docs/api/reference#update-custom-reward
|
|
821
822
|
*/
|
|
822
|
-
updateCustomReward:
|
|
823
|
+
updateCustomReward: (params, body = null, options = {}) => this.callApi({
|
|
823
824
|
path: "/channel_points/custom_rewards",
|
|
824
825
|
method: "PATCH",
|
|
825
826
|
params,
|
|
@@ -871,7 +872,7 @@ var TwitchApi = class {
|
|
|
871
872
|
*
|
|
872
873
|
* @see https://dev.twitch.tv/docs/api/reference#get-custom-reward-redemption
|
|
873
874
|
*/
|
|
874
|
-
getCustomRewardRedemption:
|
|
875
|
+
getCustomRewardRedemption: (params, options = {}) => this.callApi({
|
|
875
876
|
path: "/channel_points/custom_rewards/redemptions",
|
|
876
877
|
params,
|
|
877
878
|
options
|
|
@@ -921,7 +922,7 @@ var TwitchApi = class {
|
|
|
921
922
|
*
|
|
922
923
|
* @see https://dev.twitch.tv/docs/api/reference#update-redemption-status
|
|
923
924
|
*/
|
|
924
|
-
updateRedemptionStatus:
|
|
925
|
+
updateRedemptionStatus: (params, body, options = {}) => this.callApi({
|
|
925
926
|
path: "/channel_points/custom_rewards/redemptions",
|
|
926
927
|
method: "PATCH",
|
|
927
928
|
params,
|
|
@@ -968,7 +969,7 @@ var TwitchApi = class {
|
|
|
968
969
|
*
|
|
969
970
|
* @see https://dev.twitch.tv/docs/api/reference#get-charity-campaign
|
|
970
971
|
*/
|
|
971
|
-
getCharityCampaign:
|
|
972
|
+
getCharityCampaign: (params, options = {}) => this.callApi({
|
|
972
973
|
path: "/charity/campaigns",
|
|
973
974
|
params,
|
|
974
975
|
options
|
|
@@ -1011,7 +1012,7 @@ var TwitchApi = class {
|
|
|
1011
1012
|
*
|
|
1012
1013
|
* @see https://dev.twitch.tv/docs/api/reference#get-charity-campaign-donations
|
|
1013
1014
|
*/
|
|
1014
|
-
getCharityCampaignDonations:
|
|
1015
|
+
getCharityCampaignDonations: (params, options = {}) => this.callApi({
|
|
1015
1016
|
path: "/charity/donations",
|
|
1016
1017
|
params,
|
|
1017
1018
|
options
|
|
@@ -1060,7 +1061,7 @@ var TwitchApi = class {
|
|
|
1060
1061
|
*
|
|
1061
1062
|
* @see https://dev.twitch.tv/docs/api/reference#get-chatters
|
|
1062
1063
|
*/
|
|
1063
|
-
getChatters:
|
|
1064
|
+
getChatters: (params, options = {}) => this.callApi({
|
|
1064
1065
|
path: "/chat/chatters",
|
|
1065
1066
|
params,
|
|
1066
1067
|
options
|
|
@@ -1098,7 +1099,7 @@ var TwitchApi = class {
|
|
|
1098
1099
|
*
|
|
1099
1100
|
* @see https://dev.twitch.tv/docs/api/reference#get-channel-emotes
|
|
1100
1101
|
*/
|
|
1101
|
-
getChannelEmotes:
|
|
1102
|
+
getChannelEmotes: (params, options = {}) => this.callApi({
|
|
1102
1103
|
path: "/chat/emotes",
|
|
1103
1104
|
params,
|
|
1104
1105
|
options
|
|
@@ -1134,7 +1135,7 @@ var TwitchApi = class {
|
|
|
1134
1135
|
*
|
|
1135
1136
|
* @see https://dev.twitch.tv/docs/api/reference#get-global-emotes
|
|
1136
1137
|
*/
|
|
1137
|
-
getGlobalEmotes:
|
|
1138
|
+
getGlobalEmotes: (options = {}) => this.callApi({
|
|
1138
1139
|
path: "/chat/emotes/global",
|
|
1139
1140
|
options
|
|
1140
1141
|
}),
|
|
@@ -1172,7 +1173,7 @@ var TwitchApi = class {
|
|
|
1172
1173
|
*
|
|
1173
1174
|
* @see https://dev.twitch.tv/docs/api/reference#get-emote-sets
|
|
1174
1175
|
*/
|
|
1175
|
-
getEmoteSets:
|
|
1176
|
+
getEmoteSets: (params, options = {}) => this.callApi({
|
|
1176
1177
|
path: "/chat/emotes/set",
|
|
1177
1178
|
params,
|
|
1178
1179
|
options
|
|
@@ -1206,7 +1207,7 @@ var TwitchApi = class {
|
|
|
1206
1207
|
*
|
|
1207
1208
|
* @see https://dev.twitch.tv/docs/api/reference#get-channel-chat-badges
|
|
1208
1209
|
*/
|
|
1209
|
-
getChannelChatBadges:
|
|
1210
|
+
getChannelChatBadges: (params, options = {}) => this.callApi({
|
|
1210
1211
|
path: "/chat/badges",
|
|
1211
1212
|
params,
|
|
1212
1213
|
options
|
|
@@ -1240,7 +1241,7 @@ var TwitchApi = class {
|
|
|
1240
1241
|
*
|
|
1241
1242
|
* @see https://dev.twitch.tv/docs/api/reference#get-global-chat-badges
|
|
1242
1243
|
*/
|
|
1243
|
-
getGlobalChatBadges:
|
|
1244
|
+
getGlobalChatBadges: (options = {}) => this.callApi({
|
|
1244
1245
|
path: "/chat/badges/global",
|
|
1245
1246
|
options
|
|
1246
1247
|
}),
|
|
@@ -1275,7 +1276,7 @@ var TwitchApi = class {
|
|
|
1275
1276
|
*
|
|
1276
1277
|
* @see https://dev.twitch.tv/docs/api/reference#get-chat-settings
|
|
1277
1278
|
*/
|
|
1278
|
-
getChatSettings:
|
|
1279
|
+
getChatSettings: (params, options = {}) => this.callApi({
|
|
1279
1280
|
path: "/chat/settings",
|
|
1280
1281
|
params,
|
|
1281
1282
|
options
|
|
@@ -1329,7 +1330,7 @@ var TwitchApi = class {
|
|
|
1329
1330
|
*
|
|
1330
1331
|
* @see https://dev.twitch.tv/docs/api/reference#update-chat-settings
|
|
1331
1332
|
*/
|
|
1332
|
-
updateChatSettings:
|
|
1333
|
+
updateChatSettings: (params, body = null, options = {}) => this.callApi({
|
|
1333
1334
|
path: "/chat/settings",
|
|
1334
1335
|
method: "PATCH",
|
|
1335
1336
|
params,
|
|
@@ -1337,7 +1338,44 @@ var TwitchApi = class {
|
|
|
1337
1338
|
options
|
|
1338
1339
|
}),
|
|
1339
1340
|
/**
|
|
1340
|
-
*
|
|
1341
|
+
* NEW Retrieves the active shared chat session for a channel.
|
|
1342
|
+
*
|
|
1343
|
+
* __Authorization:__
|
|
1344
|
+
*
|
|
1345
|
+
* 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).
|
|
1346
|
+
*
|
|
1347
|
+
* __URL:__
|
|
1348
|
+
*
|
|
1349
|
+
* `GET https://api.twitch.tv/helix/shared_chat/session`
|
|
1350
|
+
*
|
|
1351
|
+
* __Response Codes:__
|
|
1352
|
+
*
|
|
1353
|
+
* _200 OK_
|
|
1354
|
+
*
|
|
1355
|
+
* Successfully retrieved the shared chat session. Returns an empty array if the broadcaster\_id in the request isn’t in a shared chat session.
|
|
1356
|
+
*
|
|
1357
|
+
* _400 Bad Request_
|
|
1358
|
+
*
|
|
1359
|
+
* The ID in the `broadcaster_id` query parameter is not valid.
|
|
1360
|
+
*
|
|
1361
|
+
* _401 Unauthorized_
|
|
1362
|
+
*
|
|
1363
|
+
* * The OAuth token is not valid.
|
|
1364
|
+
* * The Authorization header is required and must contain a user access token.
|
|
1365
|
+
*
|
|
1366
|
+
* _500 Internal Server Error_
|
|
1367
|
+
*
|
|
1368
|
+
* Internal Server Error.
|
|
1369
|
+
*
|
|
1370
|
+
* @see https://dev.twitch.tv/docs/api/reference#get-shared-chat-session
|
|
1371
|
+
*/
|
|
1372
|
+
getSharedChatSession: (params, options = {}) => this.callApi({
|
|
1373
|
+
path: "/shared_chat/session",
|
|
1374
|
+
params,
|
|
1375
|
+
options
|
|
1376
|
+
}),
|
|
1377
|
+
/**
|
|
1378
|
+
* NEW Retrieves emotes available to the user across all channels.
|
|
1341
1379
|
*
|
|
1342
1380
|
* __Authorization:__
|
|
1343
1381
|
*
|
|
@@ -1369,7 +1407,7 @@ var TwitchApi = class {
|
|
|
1369
1407
|
*
|
|
1370
1408
|
* @see https://dev.twitch.tv/docs/api/reference#get-user-emotes
|
|
1371
1409
|
*/
|
|
1372
|
-
getUserEmotes:
|
|
1410
|
+
getUserEmotes: (params, options = {}) => this.callApi({
|
|
1373
1411
|
path: "/chat/emotes/user",
|
|
1374
1412
|
params,
|
|
1375
1413
|
options
|
|
@@ -1377,6 +1415,8 @@ var TwitchApi = class {
|
|
|
1377
1415
|
/**
|
|
1378
1416
|
* Sends an announcement to the broadcaster’s chat room.
|
|
1379
1417
|
*
|
|
1418
|
+
* **Rate Limits**: One announcement may be sent every 2 seconds.
|
|
1419
|
+
*
|
|
1380
1420
|
* __Authorization:__
|
|
1381
1421
|
*
|
|
1382
1422
|
* Requires a [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens) that includes the **moderator:manage:announcements** scope.
|
|
@@ -1405,9 +1445,13 @@ var TwitchApi = class {
|
|
|
1405
1445
|
* * The OAuth token is not valid.
|
|
1406
1446
|
* * The client ID specified in the Client-Id header does not match the client ID specified in the OAuth token.
|
|
1407
1447
|
*
|
|
1448
|
+
* _429 Too Many Requests_
|
|
1449
|
+
*
|
|
1450
|
+
* The sender has exceeded the number of announcements they may send to this **broadcaster\_id** within a given window.
|
|
1451
|
+
*
|
|
1408
1452
|
* @see https://dev.twitch.tv/docs/api/reference#send-chat-announcement
|
|
1409
1453
|
*/
|
|
1410
|
-
sendChatAnnouncement:
|
|
1454
|
+
sendChatAnnouncement: (params, body, options = {}) => this.callApi({
|
|
1411
1455
|
path: "/chat/announcements",
|
|
1412
1456
|
method: "POST",
|
|
1413
1457
|
params,
|
|
@@ -1419,7 +1463,7 @@ var TwitchApi = class {
|
|
|
1419
1463
|
*
|
|
1420
1464
|
* 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)
|
|
1421
1465
|
*
|
|
1422
|
-
* **Rate Limits
|
|
1466
|
+
* **Rate Limits**: The broadcaster may send a Shoutout once every 2 minutes. They may send the same broadcaster a Shoutout once every 60 minutes.
|
|
1423
1467
|
*
|
|
1424
1468
|
* 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.
|
|
1425
1469
|
*
|
|
@@ -1466,7 +1510,7 @@ var TwitchApi = class {
|
|
|
1466
1510
|
*
|
|
1467
1511
|
* @see https://dev.twitch.tv/docs/api/reference#send-a-shoutout
|
|
1468
1512
|
*/
|
|
1469
|
-
sendShoutout:
|
|
1513
|
+
sendShoutout: (params, options = {}) => this.callApi({
|
|
1470
1514
|
path: "/chat/shoutouts",
|
|
1471
1515
|
method: "POST",
|
|
1472
1516
|
params,
|
|
@@ -1516,7 +1560,7 @@ var TwitchApi = class {
|
|
|
1516
1560
|
*
|
|
1517
1561
|
* @see https://dev.twitch.tv/docs/api/reference#send-chat-message
|
|
1518
1562
|
*/
|
|
1519
|
-
sendChatMessage:
|
|
1563
|
+
sendChatMessage: (body, options = {}) => this.callApi({
|
|
1520
1564
|
path: "/chat/messages",
|
|
1521
1565
|
method: "POST",
|
|
1522
1566
|
body,
|
|
@@ -1551,7 +1595,7 @@ var TwitchApi = class {
|
|
|
1551
1595
|
*
|
|
1552
1596
|
* @see https://dev.twitch.tv/docs/api/reference#get-user-chat-color
|
|
1553
1597
|
*/
|
|
1554
|
-
getUserChatColor:
|
|
1598
|
+
getUserChatColor: (params, options = {}) => this.callApi({
|
|
1555
1599
|
path: "/chat/color",
|
|
1556
1600
|
params,
|
|
1557
1601
|
options
|
|
@@ -1590,7 +1634,7 @@ var TwitchApi = class {
|
|
|
1590
1634
|
*
|
|
1591
1635
|
* @see https://dev.twitch.tv/docs/api/reference#update-user-chat-color
|
|
1592
1636
|
*/
|
|
1593
|
-
updateUserChatColor:
|
|
1637
|
+
updateUserChatColor: (params, options = {}) => this.callApi({
|
|
1594
1638
|
path: "/chat/color",
|
|
1595
1639
|
method: "PUT",
|
|
1596
1640
|
params,
|
|
@@ -1644,7 +1688,7 @@ var TwitchApi = class {
|
|
|
1644
1688
|
*
|
|
1645
1689
|
* @see https://dev.twitch.tv/docs/api/reference#create-clip
|
|
1646
1690
|
*/
|
|
1647
|
-
createClip:
|
|
1691
|
+
createClip: (params, options = {}) => this.callApi({
|
|
1648
1692
|
path: "/clips",
|
|
1649
1693
|
method: "POST",
|
|
1650
1694
|
params,
|
|
@@ -1653,6 +1697,8 @@ var TwitchApi = class {
|
|
|
1653
1697
|
/**
|
|
1654
1698
|
* 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).
|
|
1655
1699
|
*
|
|
1700
|
+
* 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.
|
|
1701
|
+
*
|
|
1656
1702
|
* __Authorization:__
|
|
1657
1703
|
*
|
|
1658
1704
|
* 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).
|
|
@@ -1688,7 +1734,7 @@ var TwitchApi = class {
|
|
|
1688
1734
|
*
|
|
1689
1735
|
* @see https://dev.twitch.tv/docs/api/reference#get-clips
|
|
1690
1736
|
*/
|
|
1691
|
-
getClips:
|
|
1737
|
+
getClips: (params = null, options = {}) => this.callApi({
|
|
1692
1738
|
path: "/clips",
|
|
1693
1739
|
params,
|
|
1694
1740
|
options
|
|
@@ -1696,7 +1742,7 @@ var TwitchApi = class {
|
|
|
1696
1742
|
};
|
|
1697
1743
|
conduits = {
|
|
1698
1744
|
/**
|
|
1699
|
-
* NEW Gets the [conduits](https://dev.twitch.tv/docs/eventsub/handling-conduit-events) for a client ID.
|
|
1745
|
+
* NEW Gets the [conduits](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/) for a client ID.
|
|
1700
1746
|
*
|
|
1701
1747
|
* __Authorization:__
|
|
1702
1748
|
*
|
|
@@ -1718,12 +1764,12 @@ var TwitchApi = class {
|
|
|
1718
1764
|
*
|
|
1719
1765
|
* @see https://dev.twitch.tv/docs/api/reference#get-conduits
|
|
1720
1766
|
*/
|
|
1721
|
-
getConduits:
|
|
1767
|
+
getConduits: (options = {}) => this.callApi({
|
|
1722
1768
|
path: "/eventsub/conduits",
|
|
1723
1769
|
options
|
|
1724
1770
|
}),
|
|
1725
1771
|
/**
|
|
1726
|
-
* NEW Creates a new [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events).
|
|
1772
|
+
* NEW Creates a new [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/).
|
|
1727
1773
|
*
|
|
1728
1774
|
* __Authorization:__
|
|
1729
1775
|
*
|
|
@@ -1753,14 +1799,14 @@ var TwitchApi = class {
|
|
|
1753
1799
|
*
|
|
1754
1800
|
* @see https://dev.twitch.tv/docs/api/reference#create-conduits
|
|
1755
1801
|
*/
|
|
1756
|
-
createConduits:
|
|
1802
|
+
createConduits: (body, options = {}) => this.callApi({
|
|
1757
1803
|
path: "/eventsub/conduits",
|
|
1758
1804
|
method: "POST",
|
|
1759
1805
|
body,
|
|
1760
1806
|
options
|
|
1761
1807
|
}),
|
|
1762
1808
|
/**
|
|
1763
|
-
* 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.
|
|
1809
|
+
* 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.
|
|
1764
1810
|
*
|
|
1765
1811
|
* __Authorization:__
|
|
1766
1812
|
*
|
|
@@ -1792,14 +1838,14 @@ var TwitchApi = class {
|
|
|
1792
1838
|
*
|
|
1793
1839
|
* @see https://dev.twitch.tv/docs/api/reference#update-conduits
|
|
1794
1840
|
*/
|
|
1795
|
-
updateConduits:
|
|
1841
|
+
updateConduits: (body, options = {}) => this.callApi({
|
|
1796
1842
|
path: "/eventsub/conduits",
|
|
1797
1843
|
method: "PATCH",
|
|
1798
1844
|
body,
|
|
1799
1845
|
options
|
|
1800
1846
|
}),
|
|
1801
1847
|
/**
|
|
1802
|
-
* 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).
|
|
1848
|
+
* 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).
|
|
1803
1849
|
*
|
|
1804
1850
|
* __Authorization:__
|
|
1805
1851
|
*
|
|
@@ -1830,14 +1876,14 @@ var TwitchApi = class {
|
|
|
1830
1876
|
*
|
|
1831
1877
|
* @see https://dev.twitch.tv/docs/api/reference#delete-conduit
|
|
1832
1878
|
*/
|
|
1833
|
-
deleteConduit:
|
|
1879
|
+
deleteConduit: (params, options = {}) => this.callApi({
|
|
1834
1880
|
path: "/eventsub/conduits",
|
|
1835
1881
|
method: "DELETE",
|
|
1836
1882
|
params,
|
|
1837
1883
|
options
|
|
1838
1884
|
}),
|
|
1839
1885
|
/**
|
|
1840
|
-
* NEW Gets a lists of all shards for a [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events).
|
|
1886
|
+
* NEW Gets a lists of all shards for a [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/).
|
|
1841
1887
|
*
|
|
1842
1888
|
* __Authorization:__
|
|
1843
1889
|
*
|
|
@@ -1868,13 +1914,13 @@ var TwitchApi = class {
|
|
|
1868
1914
|
*
|
|
1869
1915
|
* @see https://dev.twitch.tv/docs/api/reference#get-conduit-shards
|
|
1870
1916
|
*/
|
|
1871
|
-
getConduitShards:
|
|
1917
|
+
getConduitShards: (params, options = {}) => this.callApi({
|
|
1872
1918
|
path: "/eventsub/conduits/shards",
|
|
1873
1919
|
params,
|
|
1874
1920
|
options
|
|
1875
1921
|
}),
|
|
1876
1922
|
/**
|
|
1877
|
-
* NEW Updates shard(s) for a [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events).
|
|
1923
|
+
* NEW Updates shard(s) for a [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/).
|
|
1878
1924
|
*
|
|
1879
1925
|
* **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.
|
|
1880
1926
|
*
|
|
@@ -1907,7 +1953,7 @@ var TwitchApi = class {
|
|
|
1907
1953
|
*
|
|
1908
1954
|
* @see https://dev.twitch.tv/docs/api/reference#update-conduit-shards
|
|
1909
1955
|
*/
|
|
1910
|
-
updateConduitShards:
|
|
1956
|
+
updateConduitShards: (body, options = {}) => this.callApi({
|
|
1911
1957
|
path: "/eventsub/conduits/shards",
|
|
1912
1958
|
method: "PATCH",
|
|
1913
1959
|
body,
|
|
@@ -1940,7 +1986,7 @@ var TwitchApi = class {
|
|
|
1940
1986
|
*
|
|
1941
1987
|
* @see https://dev.twitch.tv/docs/api/reference#get-content-classification-labels
|
|
1942
1988
|
*/
|
|
1943
|
-
getContentClassificationLabels:
|
|
1989
|
+
getContentClassificationLabels: (params = null, options = {}) => this.callApi({
|
|
1944
1990
|
path: "/content_classification_labels",
|
|
1945
1991
|
params,
|
|
1946
1992
|
options
|
|
@@ -2002,7 +2048,7 @@ var TwitchApi = class {
|
|
|
2002
2048
|
*
|
|
2003
2049
|
* @see https://dev.twitch.tv/docs/api/reference#get-drops-entitlements
|
|
2004
2050
|
*/
|
|
2005
|
-
getDropsEntitlements:
|
|
2051
|
+
getDropsEntitlements: (params = null, options = {}) => this.callApi({
|
|
2006
2052
|
path: "/entitlements/drops",
|
|
2007
2053
|
params,
|
|
2008
2054
|
options
|
|
@@ -2048,7 +2094,7 @@ var TwitchApi = class {
|
|
|
2048
2094
|
*
|
|
2049
2095
|
* @see https://dev.twitch.tv/docs/api/reference#update-drops-entitlements
|
|
2050
2096
|
*/
|
|
2051
|
-
updateDropsEntitlements:
|
|
2097
|
+
updateDropsEntitlements: (body = null, options = {}) => this.callApi({
|
|
2052
2098
|
path: "/entitlements/drops",
|
|
2053
2099
|
method: "PATCH",
|
|
2054
2100
|
body,
|
|
@@ -2093,7 +2139,7 @@ var TwitchApi = class {
|
|
|
2093
2139
|
*
|
|
2094
2140
|
* @see https://dev.twitch.tv/docs/api/reference#get-extension-configuration-segment
|
|
2095
2141
|
*/
|
|
2096
|
-
getExtensionConfigurationSegment:
|
|
2142
|
+
getExtensionConfigurationSegment: (params, options = {}) => this.callApi({
|
|
2097
2143
|
path: "/extensions/configurations",
|
|
2098
2144
|
params,
|
|
2099
2145
|
options
|
|
@@ -2129,7 +2175,7 @@ var TwitchApi = class {
|
|
|
2129
2175
|
*
|
|
2130
2176
|
* @see https://dev.twitch.tv/docs/api/reference#set-extension-configuration-segment
|
|
2131
2177
|
*/
|
|
2132
|
-
setExtensionConfigurationSegment:
|
|
2178
|
+
setExtensionConfigurationSegment: (body, options = {}) => this.callApi({
|
|
2133
2179
|
path: "/extensions/configurations",
|
|
2134
2180
|
method: "PUT",
|
|
2135
2181
|
body,
|
|
@@ -2167,7 +2213,7 @@ var TwitchApi = class {
|
|
|
2167
2213
|
*
|
|
2168
2214
|
* @see https://dev.twitch.tv/docs/api/reference#set-extension-required-configuration
|
|
2169
2215
|
*/
|
|
2170
|
-
setExtensionRequiredConfiguration:
|
|
2216
|
+
setExtensionRequiredConfiguration: (params, body, options = {}) => this.callApi({
|
|
2171
2217
|
path: "/extensions/required_configuration",
|
|
2172
2218
|
method: "PUT",
|
|
2173
2219
|
params,
|
|
@@ -2243,7 +2289,7 @@ var TwitchApi = class {
|
|
|
2243
2289
|
*
|
|
2244
2290
|
* @see https://dev.twitch.tv/docs/api/reference#send-extension-pubsub-message
|
|
2245
2291
|
*/
|
|
2246
|
-
sendExtensionPubSubMessage:
|
|
2292
|
+
sendExtensionPubSubMessage: (body, options = {}) => this.callApi({
|
|
2247
2293
|
path: "/extensions/pubsub",
|
|
2248
2294
|
method: "POST",
|
|
2249
2295
|
body,
|
|
@@ -2285,7 +2331,7 @@ var TwitchApi = class {
|
|
|
2285
2331
|
*
|
|
2286
2332
|
* @see https://dev.twitch.tv/docs/api/reference#get-extension-live-channels
|
|
2287
2333
|
*/
|
|
2288
|
-
getExtensionLiveChannels:
|
|
2334
|
+
getExtensionLiveChannels: (params, options = {}) => this.callApi({
|
|
2289
2335
|
path: "/extensions/live",
|
|
2290
2336
|
params,
|
|
2291
2337
|
options
|
|
@@ -2319,7 +2365,7 @@ var TwitchApi = class {
|
|
|
2319
2365
|
*
|
|
2320
2366
|
* @see https://dev.twitch.tv/docs/api/reference#get-extension-secrets
|
|
2321
2367
|
*/
|
|
2322
|
-
getExtensionSecrets:
|
|
2368
|
+
getExtensionSecrets: (options = {}) => this.callApi({
|
|
2323
2369
|
path: "/extensions/jwt/secrets",
|
|
2324
2370
|
options
|
|
2325
2371
|
}),
|
|
@@ -2353,7 +2399,7 @@ var TwitchApi = class {
|
|
|
2353
2399
|
*
|
|
2354
2400
|
* @see https://dev.twitch.tv/docs/api/reference#create-extension-secret
|
|
2355
2401
|
*/
|
|
2356
|
-
createExtensionSecret:
|
|
2402
|
+
createExtensionSecret: (params, options = {}) => this.callApi({
|
|
2357
2403
|
path: "/extensions/jwt/secrets",
|
|
2358
2404
|
method: "POST",
|
|
2359
2405
|
params,
|
|
@@ -2395,7 +2441,7 @@ var TwitchApi = class {
|
|
|
2395
2441
|
*
|
|
2396
2442
|
* @see https://dev.twitch.tv/docs/api/reference#send-extension-chat-message
|
|
2397
2443
|
*/
|
|
2398
|
-
sendExtensionChatMessage:
|
|
2444
|
+
sendExtensionChatMessage: (params, body, options = {}) => this.callApi({
|
|
2399
2445
|
path: "/extensions/chat",
|
|
2400
2446
|
method: "POST",
|
|
2401
2447
|
params,
|
|
@@ -2436,7 +2482,7 @@ var TwitchApi = class {
|
|
|
2436
2482
|
*
|
|
2437
2483
|
* @see https://dev.twitch.tv/docs/api/reference#get-extensions
|
|
2438
2484
|
*/
|
|
2439
|
-
getExtensions:
|
|
2485
|
+
getExtensions: (params, options = {}) => this.callApi({
|
|
2440
2486
|
path: "/extensions",
|
|
2441
2487
|
params,
|
|
2442
2488
|
options
|
|
@@ -2474,7 +2520,7 @@ var TwitchApi = class {
|
|
|
2474
2520
|
*
|
|
2475
2521
|
* @see https://dev.twitch.tv/docs/api/reference#get-released-extensions
|
|
2476
2522
|
*/
|
|
2477
|
-
getReleasedExtensions:
|
|
2523
|
+
getReleasedExtensions: (params, options = {}) => this.callApi({
|
|
2478
2524
|
path: "/extensions/released",
|
|
2479
2525
|
params,
|
|
2480
2526
|
options
|
|
@@ -2508,7 +2554,7 @@ var TwitchApi = class {
|
|
|
2508
2554
|
*
|
|
2509
2555
|
* @see https://dev.twitch.tv/docs/api/reference#get-extension-bits-products
|
|
2510
2556
|
*/
|
|
2511
|
-
getExtensionBitsProducts:
|
|
2557
|
+
getExtensionBitsProducts: (params = null, options = {}) => this.callApi({
|
|
2512
2558
|
path: "/bits/extensions",
|
|
2513
2559
|
params,
|
|
2514
2560
|
options
|
|
@@ -2549,7 +2595,7 @@ var TwitchApi = class {
|
|
|
2549
2595
|
*
|
|
2550
2596
|
* @see https://dev.twitch.tv/docs/api/reference#update-extension-bits-product
|
|
2551
2597
|
*/
|
|
2552
|
-
updateExtensionBitsProduct:
|
|
2598
|
+
updateExtensionBitsProduct: (body, options = {}) => this.callApi({
|
|
2553
2599
|
path: "/bits/extensions",
|
|
2554
2600
|
method: "PUT",
|
|
2555
2601
|
body,
|
|
@@ -2566,7 +2612,7 @@ var TwitchApi = class {
|
|
|
2566
2612
|
*
|
|
2567
2613
|
* 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.
|
|
2568
2614
|
*
|
|
2569
|
-
* 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.
|
|
2615
|
+
* 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.
|
|
2570
2616
|
*
|
|
2571
2617
|
* __URL:__
|
|
2572
2618
|
*
|
|
@@ -2613,7 +2659,7 @@ var TwitchApi = class {
|
|
|
2613
2659
|
*
|
|
2614
2660
|
* @see https://dev.twitch.tv/docs/api/reference#create-eventsub-subscription
|
|
2615
2661
|
*/
|
|
2616
|
-
createEventSubSubscription:
|
|
2662
|
+
createEventSubSubscription: (body, options = {}) => this.callApi({
|
|
2617
2663
|
path: "/eventsub/subscriptions",
|
|
2618
2664
|
method: "POST",
|
|
2619
2665
|
body,
|
|
@@ -2654,7 +2700,7 @@ var TwitchApi = class {
|
|
|
2654
2700
|
*
|
|
2655
2701
|
* @see https://dev.twitch.tv/docs/api/reference#delete-eventsub-subscription
|
|
2656
2702
|
*/
|
|
2657
|
-
deleteEventSubSubscription:
|
|
2703
|
+
deleteEventSubSubscription: (params, options = {}) => this.callApi({
|
|
2658
2704
|
path: "/eventsub/subscriptions",
|
|
2659
2705
|
method: "DELETE",
|
|
2660
2706
|
params,
|
|
@@ -2665,7 +2711,7 @@ var TwitchApi = class {
|
|
|
2665
2711
|
*
|
|
2666
2712
|
* __Authorization:__
|
|
2667
2713
|
*
|
|
2668
|
-
* 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.
|
|
2714
|
+
* 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.
|
|
2669
2715
|
*
|
|
2670
2716
|
* 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.
|
|
2671
2717
|
*
|
|
@@ -2698,7 +2744,7 @@ var TwitchApi = class {
|
|
|
2698
2744
|
*
|
|
2699
2745
|
* @see https://dev.twitch.tv/docs/api/reference#get-eventsub-subscriptions
|
|
2700
2746
|
*/
|
|
2701
|
-
getEventSubSubscriptions:
|
|
2747
|
+
getEventSubSubscriptions: (params = null, options = {}) => this.callApi({
|
|
2702
2748
|
path: "/eventsub/subscriptions",
|
|
2703
2749
|
params,
|
|
2704
2750
|
options
|
|
@@ -2735,7 +2781,7 @@ var TwitchApi = class {
|
|
|
2735
2781
|
*
|
|
2736
2782
|
* @see https://dev.twitch.tv/docs/api/reference#get-top-games
|
|
2737
2783
|
*/
|
|
2738
|
-
getTopGames:
|
|
2784
|
+
getTopGames: (params = null, options = {}) => this.callApi({
|
|
2739
2785
|
path: "/games/top",
|
|
2740
2786
|
params,
|
|
2741
2787
|
options
|
|
@@ -2772,7 +2818,7 @@ var TwitchApi = class {
|
|
|
2772
2818
|
*
|
|
2773
2819
|
* @see https://dev.twitch.tv/docs/api/reference#get-games
|
|
2774
2820
|
*/
|
|
2775
|
-
getGames:
|
|
2821
|
+
getGames: (params = null, options = {}) => this.callApi({
|
|
2776
2822
|
path: "/games",
|
|
2777
2823
|
params,
|
|
2778
2824
|
options
|
|
@@ -2812,7 +2858,7 @@ var TwitchApi = class {
|
|
|
2812
2858
|
*
|
|
2813
2859
|
* @see https://dev.twitch.tv/docs/api/reference#get-creator-goals
|
|
2814
2860
|
*/
|
|
2815
|
-
getCreatorGoals:
|
|
2861
|
+
getCreatorGoals: (params, options = {}) => this.callApi({
|
|
2816
2862
|
path: "/goals",
|
|
2817
2863
|
params,
|
|
2818
2864
|
options
|
|
@@ -2846,7 +2892,7 @@ var TwitchApi = class {
|
|
|
2846
2892
|
*
|
|
2847
2893
|
* @see https://dev.twitch.tv/docs/api/reference#get-channel-guest-star-settings
|
|
2848
2894
|
*/
|
|
2849
|
-
getChannelGuestStarSettings:
|
|
2895
|
+
getChannelGuestStarSettings: (params, options = {}) => this.callApi({
|
|
2850
2896
|
path: "/guest_star/channel_settings",
|
|
2851
2897
|
params,
|
|
2852
2898
|
options
|
|
@@ -2877,7 +2923,7 @@ var TwitchApi = class {
|
|
|
2877
2923
|
*
|
|
2878
2924
|
* @see https://dev.twitch.tv/docs/api/reference#update-channel-guest-star-settings
|
|
2879
2925
|
*/
|
|
2880
|
-
updateChannelGuestStarSettings:
|
|
2926
|
+
updateChannelGuestStarSettings: (params, body = null, options = {}) => this.callApi({
|
|
2881
2927
|
path: "/guest_star/channel_settings",
|
|
2882
2928
|
method: "PUT",
|
|
2883
2929
|
params,
|
|
@@ -2911,7 +2957,7 @@ var TwitchApi = class {
|
|
|
2911
2957
|
*
|
|
2912
2958
|
* @see https://dev.twitch.tv/docs/api/reference#get-guest-star-session
|
|
2913
2959
|
*/
|
|
2914
|
-
getGuestStarSession:
|
|
2960
|
+
getGuestStarSession: (params, options = {}) => this.callApi({
|
|
2915
2961
|
path: "/guest_star/session",
|
|
2916
2962
|
params,
|
|
2917
2963
|
options
|
|
@@ -2947,7 +2993,7 @@ var TwitchApi = class {
|
|
|
2947
2993
|
*
|
|
2948
2994
|
* @see https://dev.twitch.tv/docs/api/reference#create-guest-star-session
|
|
2949
2995
|
*/
|
|
2950
|
-
createGuestStarSession:
|
|
2996
|
+
createGuestStarSession: (params, options = {}) => this.callApi({
|
|
2951
2997
|
path: "/guest_star/session",
|
|
2952
2998
|
method: "POST",
|
|
2953
2999
|
params,
|
|
@@ -2981,7 +3027,7 @@ var TwitchApi = class {
|
|
|
2981
3027
|
*
|
|
2982
3028
|
* @see https://dev.twitch.tv/docs/api/reference#end-guest-star-session
|
|
2983
3029
|
*/
|
|
2984
|
-
endGuestStarSession:
|
|
3030
|
+
endGuestStarSession: (params, options = {}) => this.callApi({
|
|
2985
3031
|
path: "/guest_star/session",
|
|
2986
3032
|
method: "DELETE",
|
|
2987
3033
|
params,
|
|
@@ -3010,7 +3056,7 @@ var TwitchApi = class {
|
|
|
3010
3056
|
*
|
|
3011
3057
|
* @see https://dev.twitch.tv/docs/api/reference#get-guest-star-invites
|
|
3012
3058
|
*/
|
|
3013
|
-
getGuestStarInvites:
|
|
3059
|
+
getGuestStarInvites: (params, options = {}) => this.callApi({
|
|
3014
3060
|
path: "/guest_star/invites",
|
|
3015
3061
|
params,
|
|
3016
3062
|
options
|
|
@@ -3046,7 +3092,7 @@ var TwitchApi = class {
|
|
|
3046
3092
|
*
|
|
3047
3093
|
* @see https://dev.twitch.tv/docs/api/reference#send-guest-star-invite
|
|
3048
3094
|
*/
|
|
3049
|
-
sendGuestStarInvite:
|
|
3095
|
+
sendGuestStarInvite: (params, options = {}) => this.callApi({
|
|
3050
3096
|
path: "/guest_star/invites",
|
|
3051
3097
|
method: "POST",
|
|
3052
3098
|
params,
|
|
@@ -3081,7 +3127,7 @@ var TwitchApi = class {
|
|
|
3081
3127
|
*
|
|
3082
3128
|
* @see https://dev.twitch.tv/docs/api/reference#delete-guest-star-invite
|
|
3083
3129
|
*/
|
|
3084
|
-
deleteGuestStarInvite:
|
|
3130
|
+
deleteGuestStarInvite: (params, options = {}) => this.callApi({
|
|
3085
3131
|
path: "/guest_star/invites",
|
|
3086
3132
|
method: "DELETE",
|
|
3087
3133
|
params,
|
|
@@ -3126,7 +3172,7 @@ var TwitchApi = class {
|
|
|
3126
3172
|
*
|
|
3127
3173
|
* @see https://dev.twitch.tv/docs/api/reference#assign-guest-star-slot
|
|
3128
3174
|
*/
|
|
3129
|
-
assignGuestStarSlot:
|
|
3175
|
+
assignGuestStarSlot: (params, options = {}) => this.callApi({
|
|
3130
3176
|
path: "/guest_star/slot",
|
|
3131
3177
|
method: "POST",
|
|
3132
3178
|
params,
|
|
@@ -3158,7 +3204,7 @@ var TwitchApi = class {
|
|
|
3158
3204
|
*
|
|
3159
3205
|
* @see https://dev.twitch.tv/docs/api/reference#update-guest-star-slot
|
|
3160
3206
|
*/
|
|
3161
|
-
updateGuestStarSlot:
|
|
3207
|
+
updateGuestStarSlot: (params, options = {}) => this.callApi({
|
|
3162
3208
|
path: "/guest_star/slot",
|
|
3163
3209
|
method: "PATCH",
|
|
3164
3210
|
params,
|
|
@@ -3200,7 +3246,7 @@ var TwitchApi = class {
|
|
|
3200
3246
|
*
|
|
3201
3247
|
* @see https://dev.twitch.tv/docs/api/reference#delete-guest-star-slot
|
|
3202
3248
|
*/
|
|
3203
|
-
deleteGuestStarSlot:
|
|
3249
|
+
deleteGuestStarSlot: (params, options = {}) => this.callApi({
|
|
3204
3250
|
path: "/guest_star/slot",
|
|
3205
3251
|
method: "DELETE",
|
|
3206
3252
|
params,
|
|
@@ -3238,7 +3284,7 @@ var TwitchApi = class {
|
|
|
3238
3284
|
*
|
|
3239
3285
|
* @see https://dev.twitch.tv/docs/api/reference#update-guest-star-slot-settings
|
|
3240
3286
|
*/
|
|
3241
|
-
updateGuestStarSlotSettings:
|
|
3287
|
+
updateGuestStarSlotSettings: (params, options = {}) => this.callApi({
|
|
3242
3288
|
path: "/guest_star/slot_settings",
|
|
3243
3289
|
method: "PATCH",
|
|
3244
3290
|
params,
|
|
@@ -3275,7 +3321,7 @@ var TwitchApi = class {
|
|
|
3275
3321
|
*
|
|
3276
3322
|
* @see https://dev.twitch.tv/docs/api/reference#get-hype-train-events
|
|
3277
3323
|
*/
|
|
3278
|
-
getHypeTrainEvents:
|
|
3324
|
+
getHypeTrainEvents: (params, options = {}) => this.callApi({
|
|
3279
3325
|
path: "/hypetrain/events",
|
|
3280
3326
|
params,
|
|
3281
3327
|
options
|
|
@@ -3336,7 +3382,7 @@ var TwitchApi = class {
|
|
|
3336
3382
|
*
|
|
3337
3383
|
* @see https://dev.twitch.tv/docs/api/reference#check-automod-status
|
|
3338
3384
|
*/
|
|
3339
|
-
checkAutoModStatus:
|
|
3385
|
+
checkAutoModStatus: (params, body, options = {}) => this.callApi({
|
|
3340
3386
|
path: "/moderation/enforcements/status",
|
|
3341
3387
|
method: "POST",
|
|
3342
3388
|
params,
|
|
@@ -3387,7 +3433,7 @@ var TwitchApi = class {
|
|
|
3387
3433
|
*
|
|
3388
3434
|
* @see https://dev.twitch.tv/docs/api/reference#manage-held-automod-messages
|
|
3389
3435
|
*/
|
|
3390
|
-
manageHeldAutoModMessages:
|
|
3436
|
+
manageHeldAutoModMessages: (body, options = {}) => this.callApi({
|
|
3391
3437
|
path: "/moderation/automod/message",
|
|
3392
3438
|
method: "POST",
|
|
3393
3439
|
body,
|
|
@@ -3429,7 +3475,7 @@ var TwitchApi = class {
|
|
|
3429
3475
|
*
|
|
3430
3476
|
* @see https://dev.twitch.tv/docs/api/reference#get-automod-settings
|
|
3431
3477
|
*/
|
|
3432
|
-
getAutoModSettings:
|
|
3478
|
+
getAutoModSettings: (params, options = {}) => this.callApi({
|
|
3433
3479
|
path: "/moderation/automod/settings",
|
|
3434
3480
|
params,
|
|
3435
3481
|
options
|
|
@@ -3486,7 +3532,7 @@ var TwitchApi = class {
|
|
|
3486
3532
|
*
|
|
3487
3533
|
* @see https://dev.twitch.tv/docs/api/reference#update-automod-settings
|
|
3488
3534
|
*/
|
|
3489
|
-
updateAutoModSettings:
|
|
3535
|
+
updateAutoModSettings: (params, body = null, options = {}) => this.callApi({
|
|
3490
3536
|
path: "/moderation/automod/settings",
|
|
3491
3537
|
method: "PUT",
|
|
3492
3538
|
params,
|
|
@@ -3524,7 +3570,7 @@ var TwitchApi = class {
|
|
|
3524
3570
|
*
|
|
3525
3571
|
* @see https://dev.twitch.tv/docs/api/reference#get-banned-users
|
|
3526
3572
|
*/
|
|
3527
|
-
getBannedUsers:
|
|
3573
|
+
getBannedUsers: (params, options = {}) => this.callApi({
|
|
3528
3574
|
path: "/moderation/banned",
|
|
3529
3575
|
params,
|
|
3530
3576
|
options
|
|
@@ -3585,7 +3631,7 @@ var TwitchApi = class {
|
|
|
3585
3631
|
*
|
|
3586
3632
|
* @see https://dev.twitch.tv/docs/api/reference#ban-user
|
|
3587
3633
|
*/
|
|
3588
|
-
banUser:
|
|
3634
|
+
banUser: (params, body, options = {}) => this.callApi({
|
|
3589
3635
|
path: "/moderation/bans",
|
|
3590
3636
|
method: "POST",
|
|
3591
3637
|
params,
|
|
@@ -3640,14 +3686,14 @@ var TwitchApi = class {
|
|
|
3640
3686
|
*
|
|
3641
3687
|
* @see https://dev.twitch.tv/docs/api/reference#unban-user
|
|
3642
3688
|
*/
|
|
3643
|
-
unbanUser:
|
|
3689
|
+
unbanUser: (params, options = {}) => this.callApi({
|
|
3644
3690
|
path: "/moderation/bans",
|
|
3645
3691
|
method: "DELETE",
|
|
3646
3692
|
params,
|
|
3647
3693
|
options
|
|
3648
3694
|
}),
|
|
3649
3695
|
/**
|
|
3650
|
-
*
|
|
3696
|
+
* NEW Gets a list of unban requests for a broadcaster’s channel.
|
|
3651
3697
|
*
|
|
3652
3698
|
* __Authorization:__
|
|
3653
3699
|
*
|
|
@@ -3682,18 +3728,18 @@ var TwitchApi = class {
|
|
|
3682
3728
|
*
|
|
3683
3729
|
* @see https://dev.twitch.tv/docs/api/reference#get-unban-requests
|
|
3684
3730
|
*/
|
|
3685
|
-
getUnbanRequests:
|
|
3731
|
+
getUnbanRequests: (params, options = {}) => this.callApi({
|
|
3686
3732
|
path: "/moderation/unban_requests",
|
|
3687
3733
|
params,
|
|
3688
3734
|
options
|
|
3689
3735
|
}),
|
|
3690
3736
|
/**
|
|
3691
|
-
*
|
|
3737
|
+
* NEW Resolves an unban request by approving or denying it.
|
|
3692
3738
|
*
|
|
3693
3739
|
* __Authorization:__
|
|
3694
3740
|
*
|
|
3695
3741
|
* * Requires a user access token that includes the **moderator:manage:unban\_requests** scope.
|
|
3696
|
-
* * Query parameter `moderator_id` must match the `user_id` in the
|
|
3742
|
+
* * Query parameter `moderator_id` must match the `user_id` in the[user access token](https://dev.twitch.tv/docs/authentication/#user-access-tokens).
|
|
3697
3743
|
*
|
|
3698
3744
|
* __URL:__
|
|
3699
3745
|
*
|
|
@@ -3729,7 +3775,7 @@ var TwitchApi = class {
|
|
|
3729
3775
|
*
|
|
3730
3776
|
* @see https://dev.twitch.tv/docs/api/reference#resolve-unban-requests
|
|
3731
3777
|
*/
|
|
3732
|
-
resolveUnbanRequests:
|
|
3778
|
+
resolveUnbanRequests: (params, options = {}) => this.callApi({
|
|
3733
3779
|
path: "/moderation/unban_requests",
|
|
3734
3780
|
method: "PATCH",
|
|
3735
3781
|
params,
|
|
@@ -3771,7 +3817,7 @@ var TwitchApi = class {
|
|
|
3771
3817
|
*
|
|
3772
3818
|
* @see https://dev.twitch.tv/docs/api/reference#get-blocked-terms
|
|
3773
3819
|
*/
|
|
3774
|
-
getBlockedTerms:
|
|
3820
|
+
getBlockedTerms: (params, options = {}) => this.callApi({
|
|
3775
3821
|
path: "/moderation/blocked_terms",
|
|
3776
3822
|
params,
|
|
3777
3823
|
options
|
|
@@ -3814,7 +3860,7 @@ var TwitchApi = class {
|
|
|
3814
3860
|
*
|
|
3815
3861
|
* @see https://dev.twitch.tv/docs/api/reference#add-blocked-term
|
|
3816
3862
|
*/
|
|
3817
|
-
addBlockedTerm:
|
|
3863
|
+
addBlockedTerm: (params, body, options = {}) => this.callApi({
|
|
3818
3864
|
path: "/moderation/blocked_terms",
|
|
3819
3865
|
method: "POST",
|
|
3820
3866
|
params,
|
|
@@ -3858,7 +3904,7 @@ var TwitchApi = class {
|
|
|
3858
3904
|
*
|
|
3859
3905
|
* @see https://dev.twitch.tv/docs/api/reference#remove-blocked-term
|
|
3860
3906
|
*/
|
|
3861
|
-
removeBlockedTerm:
|
|
3907
|
+
removeBlockedTerm: (params, options = {}) => this.callApi({
|
|
3862
3908
|
path: "/moderation/blocked_terms",
|
|
3863
3909
|
method: "DELETE",
|
|
3864
3910
|
params,
|
|
@@ -3904,7 +3950,7 @@ var TwitchApi = class {
|
|
|
3904
3950
|
*
|
|
3905
3951
|
* @see https://dev.twitch.tv/docs/api/reference#delete-chat-messages
|
|
3906
3952
|
*/
|
|
3907
|
-
deleteChatMessages:
|
|
3953
|
+
deleteChatMessages: (params, options = {}) => this.callApi({
|
|
3908
3954
|
path: "/moderation/chat",
|
|
3909
3955
|
method: "DELETE",
|
|
3910
3956
|
params,
|
|
@@ -3936,7 +3982,7 @@ var TwitchApi = class {
|
|
|
3936
3982
|
*
|
|
3937
3983
|
* @see https://dev.twitch.tv/docs/api/reference#get-moderated-channels
|
|
3938
3984
|
*/
|
|
3939
|
-
getModeratedChannels:
|
|
3985
|
+
getModeratedChannels: (params, options = {}) => this.callApi({
|
|
3940
3986
|
path: "/moderation/channels",
|
|
3941
3987
|
params,
|
|
3942
3988
|
options
|
|
@@ -3972,7 +4018,7 @@ var TwitchApi = class {
|
|
|
3972
4018
|
*
|
|
3973
4019
|
* @see https://dev.twitch.tv/docs/api/reference#get-moderators
|
|
3974
4020
|
*/
|
|
3975
|
-
getModerators:
|
|
4021
|
+
getModerators: (params, options = {}) => this.callApi({
|
|
3976
4022
|
path: "/moderation/moderators",
|
|
3977
4023
|
params,
|
|
3978
4024
|
options
|
|
@@ -4021,7 +4067,7 @@ var TwitchApi = class {
|
|
|
4021
4067
|
*
|
|
4022
4068
|
* @see https://dev.twitch.tv/docs/api/reference#add-channel-moderator
|
|
4023
4069
|
*/
|
|
4024
|
-
addChannelModerator:
|
|
4070
|
+
addChannelModerator: (params, options = {}) => this.callApi({
|
|
4025
4071
|
path: "/moderation/moderators",
|
|
4026
4072
|
method: "POST",
|
|
4027
4073
|
params,
|
|
@@ -4066,7 +4112,7 @@ var TwitchApi = class {
|
|
|
4066
4112
|
*
|
|
4067
4113
|
* @see https://dev.twitch.tv/docs/api/reference#remove-channel-moderator
|
|
4068
4114
|
*/
|
|
4069
|
-
removeChannelModerator:
|
|
4115
|
+
removeChannelModerator: (params, options = {}) => this.callApi({
|
|
4070
4116
|
path: "/moderation/moderators",
|
|
4071
4117
|
method: "DELETE",
|
|
4072
4118
|
params,
|
|
@@ -4105,7 +4151,7 @@ var TwitchApi = class {
|
|
|
4105
4151
|
*
|
|
4106
4152
|
* @see https://dev.twitch.tv/docs/api/reference#get-vips
|
|
4107
4153
|
*/
|
|
4108
|
-
getVIPs:
|
|
4154
|
+
getVIPs: (params, options = {}) => this.callApi({
|
|
4109
4155
|
path: "/channels/vips",
|
|
4110
4156
|
params,
|
|
4111
4157
|
options
|
|
@@ -4171,7 +4217,7 @@ var TwitchApi = class {
|
|
|
4171
4217
|
*
|
|
4172
4218
|
* @see https://dev.twitch.tv/docs/api/reference#add-channel-vip
|
|
4173
4219
|
*/
|
|
4174
|
-
addChannelVIP:
|
|
4220
|
+
addChannelVIP: (params, options = {}) => this.callApi({
|
|
4175
4221
|
path: "/channels/vips",
|
|
4176
4222
|
method: "POST",
|
|
4177
4223
|
params,
|
|
@@ -4230,7 +4276,7 @@ var TwitchApi = class {
|
|
|
4230
4276
|
*
|
|
4231
4277
|
* @see https://dev.twitch.tv/docs/api/reference#remove-channel-vip
|
|
4232
4278
|
*/
|
|
4233
|
-
removeChannelVIP:
|
|
4279
|
+
removeChannelVIP: (params, options = {}) => this.callApi({
|
|
4234
4280
|
path: "/channels/vips",
|
|
4235
4281
|
method: "DELETE",
|
|
4236
4282
|
params,
|
|
@@ -4276,7 +4322,7 @@ var TwitchApi = class {
|
|
|
4276
4322
|
*
|
|
4277
4323
|
* @see https://dev.twitch.tv/docs/api/reference#update-shield-mode-status
|
|
4278
4324
|
*/
|
|
4279
|
-
updateShieldModeStatus:
|
|
4325
|
+
updateShieldModeStatus: (params, body, options = {}) => this.callApi({
|
|
4280
4326
|
path: "/moderation/shield_mode",
|
|
4281
4327
|
method: "PUT",
|
|
4282
4328
|
params,
|
|
@@ -4321,10 +4367,69 @@ var TwitchApi = class {
|
|
|
4321
4367
|
*
|
|
4322
4368
|
* @see https://dev.twitch.tv/docs/api/reference#get-shield-mode-status
|
|
4323
4369
|
*/
|
|
4324
|
-
getShieldModeStatus:
|
|
4370
|
+
getShieldModeStatus: (params, options = {}) => this.callApi({
|
|
4325
4371
|
path: "/moderation/shield_mode",
|
|
4326
4372
|
params,
|
|
4327
4373
|
options
|
|
4374
|
+
}),
|
|
4375
|
+
/**
|
|
4376
|
+
* NEW Warns a user in the specified broadcaster’s chat room, preventing them from chat interaction until the warning is acknowledged. New warnings can be issued to a user when they already have a warning in the channel (new warning will replace old warning).
|
|
4377
|
+
*
|
|
4378
|
+
* __Authorization:__
|
|
4379
|
+
*
|
|
4380
|
+
* Requires a user access token that includes the **moderator:manage:warnings** scope. Query parameter `moderator_id` must match the `user_id` in the [user access token](https://dev.twitch.tv/docs/authentication/#user-access-tokens).
|
|
4381
|
+
*
|
|
4382
|
+
* __URL:__
|
|
4383
|
+
*
|
|
4384
|
+
* `POST https://api.twitch.tv/helix/moderation/warnings`
|
|
4385
|
+
*
|
|
4386
|
+
* __Response Codes:__
|
|
4387
|
+
*
|
|
4388
|
+
* _200 OK_
|
|
4389
|
+
*
|
|
4390
|
+
* Successfully warn a user.
|
|
4391
|
+
*
|
|
4392
|
+
* _400 Bad Request_
|
|
4393
|
+
*
|
|
4394
|
+
* * The _broadcaster\_id_ query parameter is required.
|
|
4395
|
+
* * The _moderator\_id_ query parameter is required.
|
|
4396
|
+
* * The _user\_id_ query parameter is required.
|
|
4397
|
+
* * The _reason_ query parameter is required.
|
|
4398
|
+
* * The text in the _reason_ field is too long.
|
|
4399
|
+
* * The user specified in the _user\_id_ may not be warned.
|
|
4400
|
+
*
|
|
4401
|
+
* _401 Unauthorized_
|
|
4402
|
+
*
|
|
4403
|
+
* * The ID in _moderator\_id_ must match the user ID in the user access token.
|
|
4404
|
+
* * The Authorization header is required and must contain a user access token.
|
|
4405
|
+
* * The user access token must include the **moderator:manage:warnings** scope.
|
|
4406
|
+
* * The access token is not valid.
|
|
4407
|
+
* * The client ID specified in the Client-Id header does not match the client ID specified in the access token.
|
|
4408
|
+
*
|
|
4409
|
+
* _403 Forbidden_
|
|
4410
|
+
*
|
|
4411
|
+
* The user in _moderator\_id_ is not one of the broadcaster’s moderators.
|
|
4412
|
+
*
|
|
4413
|
+
* _409 Conflict_
|
|
4414
|
+
*
|
|
4415
|
+
* You may not update the user’s warning state while someone else is updating the state. For example, someone else is currently warning the user or the user is acknowledging an existing warning. Please retry your request.
|
|
4416
|
+
*
|
|
4417
|
+
* _429 Too Many Requests_
|
|
4418
|
+
*
|
|
4419
|
+
* The app has exceeded the number of requests it may make per minute for this broadcaster.
|
|
4420
|
+
*
|
|
4421
|
+
* _500 Internal Server Error_
|
|
4422
|
+
*
|
|
4423
|
+
* Internal Server Error.
|
|
4424
|
+
*
|
|
4425
|
+
* @see https://dev.twitch.tv/docs/api/reference#warn-chat-user
|
|
4426
|
+
*/
|
|
4427
|
+
warnChatUser: (params, body, options = {}) => this.callApi({
|
|
4428
|
+
path: "/moderation/warnings",
|
|
4429
|
+
method: "POST",
|
|
4430
|
+
params,
|
|
4431
|
+
body,
|
|
4432
|
+
options
|
|
4328
4433
|
})
|
|
4329
4434
|
};
|
|
4330
4435
|
polls = {
|
|
@@ -4365,7 +4470,7 @@ var TwitchApi = class {
|
|
|
4365
4470
|
*
|
|
4366
4471
|
* @see https://dev.twitch.tv/docs/api/reference#get-polls
|
|
4367
4472
|
*/
|
|
4368
|
-
getPolls:
|
|
4473
|
+
getPolls: (params, options = {}) => this.callApi({
|
|
4369
4474
|
path: "/polls",
|
|
4370
4475
|
params,
|
|
4371
4476
|
options
|
|
@@ -4414,7 +4519,7 @@ var TwitchApi = class {
|
|
|
4414
4519
|
*
|
|
4415
4520
|
* @see https://dev.twitch.tv/docs/api/reference#create-poll
|
|
4416
4521
|
*/
|
|
4417
|
-
createPoll:
|
|
4522
|
+
createPoll: (body, options = {}) => this.callApi({
|
|
4418
4523
|
path: "/polls",
|
|
4419
4524
|
method: "POST",
|
|
4420
4525
|
body,
|
|
@@ -4455,7 +4560,7 @@ var TwitchApi = class {
|
|
|
4455
4560
|
*
|
|
4456
4561
|
* @see https://dev.twitch.tv/docs/api/reference#end-poll
|
|
4457
4562
|
*/
|
|
4458
|
-
endPoll:
|
|
4563
|
+
endPoll: (body, options = {}) => this.callApi({
|
|
4459
4564
|
path: "/polls",
|
|
4460
4565
|
method: "PATCH",
|
|
4461
4566
|
body,
|
|
@@ -4494,7 +4599,7 @@ var TwitchApi = class {
|
|
|
4494
4599
|
*
|
|
4495
4600
|
* @see https://dev.twitch.tv/docs/api/reference#get-predictions
|
|
4496
4601
|
*/
|
|
4497
|
-
getPredictions:
|
|
4602
|
+
getPredictions: (params, options = {}) => this.callApi({
|
|
4498
4603
|
path: "/predictions",
|
|
4499
4604
|
params,
|
|
4500
4605
|
options
|
|
@@ -4543,7 +4648,7 @@ var TwitchApi = class {
|
|
|
4543
4648
|
*
|
|
4544
4649
|
* @see https://dev.twitch.tv/docs/api/reference#create-prediction
|
|
4545
4650
|
*/
|
|
4546
|
-
createPrediction:
|
|
4651
|
+
createPrediction: (body, options = {}) => this.callApi({
|
|
4547
4652
|
path: "/predictions",
|
|
4548
4653
|
method: "POST",
|
|
4549
4654
|
body,
|
|
@@ -4591,7 +4696,7 @@ var TwitchApi = class {
|
|
|
4591
4696
|
*
|
|
4592
4697
|
* @see https://dev.twitch.tv/docs/api/reference#end-prediction
|
|
4593
4698
|
*/
|
|
4594
|
-
endPrediction:
|
|
4699
|
+
endPrediction: (body, options = {}) => this.callApi({
|
|
4595
4700
|
path: "/predictions",
|
|
4596
4701
|
method: "PATCH",
|
|
4597
4702
|
body,
|
|
@@ -4655,7 +4760,7 @@ var TwitchApi = class {
|
|
|
4655
4760
|
*
|
|
4656
4761
|
* @see https://dev.twitch.tv/docs/api/reference#start-a-raid
|
|
4657
4762
|
*/
|
|
4658
|
-
startRaid:
|
|
4763
|
+
startRaid: (params = null, options = {}) => this.callApi({
|
|
4659
4764
|
path: "/raids",
|
|
4660
4765
|
method: "POST",
|
|
4661
4766
|
params,
|
|
@@ -4704,7 +4809,7 @@ var TwitchApi = class {
|
|
|
4704
4809
|
*
|
|
4705
4810
|
* @see https://dev.twitch.tv/docs/api/reference#cancel-a-raid
|
|
4706
4811
|
*/
|
|
4707
|
-
cancelRaid:
|
|
4812
|
+
cancelRaid: (params, options = {}) => this.callApi({
|
|
4708
4813
|
path: "/raids",
|
|
4709
4814
|
method: "DELETE",
|
|
4710
4815
|
params,
|
|
@@ -4752,7 +4857,7 @@ var TwitchApi = class {
|
|
|
4752
4857
|
*
|
|
4753
4858
|
* @see https://dev.twitch.tv/docs/api/reference#get-channel-stream-schedule
|
|
4754
4859
|
*/
|
|
4755
|
-
getChannelStreamSchedule:
|
|
4860
|
+
getChannelStreamSchedule: (params, options = {}) => this.callApi({
|
|
4756
4861
|
path: "/schedule",
|
|
4757
4862
|
params,
|
|
4758
4863
|
options
|
|
@@ -4787,7 +4892,7 @@ var TwitchApi = class {
|
|
|
4787
4892
|
*
|
|
4788
4893
|
* @see https://dev.twitch.tv/docs/api/reference#get-channel-icalendar
|
|
4789
4894
|
*/
|
|
4790
|
-
getChannelICalendar:
|
|
4895
|
+
getChannelICalendar: (params, options = {}) => this.callApi({
|
|
4791
4896
|
path: "/schedule/icalendar",
|
|
4792
4897
|
params,
|
|
4793
4898
|
options
|
|
@@ -4831,7 +4936,7 @@ var TwitchApi = class {
|
|
|
4831
4936
|
*
|
|
4832
4937
|
* @see https://dev.twitch.tv/docs/api/reference#update-channel-stream-schedule
|
|
4833
4938
|
*/
|
|
4834
|
-
updateChannelStreamSchedule:
|
|
4939
|
+
updateChannelStreamSchedule: (params, options = {}) => this.callApi({
|
|
4835
4940
|
path: "/schedule/settings",
|
|
4836
4941
|
method: "PATCH",
|
|
4837
4942
|
params,
|
|
@@ -4878,7 +4983,7 @@ var TwitchApi = class {
|
|
|
4878
4983
|
*
|
|
4879
4984
|
* @see https://dev.twitch.tv/docs/api/reference#create-channel-stream-schedule-segment
|
|
4880
4985
|
*/
|
|
4881
|
-
createChannelStreamScheduleSegment:
|
|
4986
|
+
createChannelStreamScheduleSegment: (params, body, options = {}) => this.callApi({
|
|
4882
4987
|
path: "/schedule/segment",
|
|
4883
4988
|
method: "POST",
|
|
4884
4989
|
params,
|
|
@@ -4930,7 +5035,7 @@ var TwitchApi = class {
|
|
|
4930
5035
|
*
|
|
4931
5036
|
* @see https://dev.twitch.tv/docs/api/reference#update-channel-stream-schedule-segment
|
|
4932
5037
|
*/
|
|
4933
|
-
updateChannelStreamScheduleSegment:
|
|
5038
|
+
updateChannelStreamScheduleSegment: (params, body = null, options = {}) => this.callApi({
|
|
4934
5039
|
path: "/schedule/segment",
|
|
4935
5040
|
method: "PATCH",
|
|
4936
5041
|
params,
|
|
@@ -4973,7 +5078,7 @@ var TwitchApi = class {
|
|
|
4973
5078
|
*
|
|
4974
5079
|
* @see https://dev.twitch.tv/docs/api/reference#delete-channel-stream-schedule-segment
|
|
4975
5080
|
*/
|
|
4976
|
-
deleteChannelStreamScheduleSegment:
|
|
5081
|
+
deleteChannelStreamScheduleSegment: (params, options = {}) => this.callApi({
|
|
4977
5082
|
path: "/schedule/segment",
|
|
4978
5083
|
method: "DELETE",
|
|
4979
5084
|
params,
|
|
@@ -5012,7 +5117,7 @@ var TwitchApi = class {
|
|
|
5012
5117
|
*
|
|
5013
5118
|
* @see https://dev.twitch.tv/docs/api/reference#search-categories
|
|
5014
5119
|
*/
|
|
5015
|
-
searchCategories:
|
|
5120
|
+
searchCategories: (params, options = {}) => this.callApi({
|
|
5016
5121
|
path: "/search/categories",
|
|
5017
5122
|
params,
|
|
5018
5123
|
options
|
|
@@ -5052,7 +5157,7 @@ var TwitchApi = class {
|
|
|
5052
5157
|
*
|
|
5053
5158
|
* @see https://dev.twitch.tv/docs/api/reference#search-channels
|
|
5054
5159
|
*/
|
|
5055
|
-
searchChannels:
|
|
5160
|
+
searchChannels: (params, options = {}) => this.callApi({
|
|
5056
5161
|
path: "/search/channels",
|
|
5057
5162
|
params,
|
|
5058
5163
|
options
|
|
@@ -5089,9 +5194,13 @@ var TwitchApi = class {
|
|
|
5089
5194
|
* * The access token is not valid.
|
|
5090
5195
|
* * The client ID specified in the Client-Id header must match the client ID specified in the access token.
|
|
5091
5196
|
*
|
|
5197
|
+
* _403 Forbidden_
|
|
5198
|
+
*
|
|
5199
|
+
* The user must complete additional steps in order to stream. Present the user with the returned error message.
|
|
5200
|
+
*
|
|
5092
5201
|
* @see https://dev.twitch.tv/docs/api/reference#get-stream-key
|
|
5093
5202
|
*/
|
|
5094
|
-
getStreamKey:
|
|
5203
|
+
getStreamKey: (params, options = {}) => this.callApi({
|
|
5095
5204
|
path: "/streams/key",
|
|
5096
5205
|
params,
|
|
5097
5206
|
options
|
|
@@ -5125,7 +5234,7 @@ var TwitchApi = class {
|
|
|
5125
5234
|
*
|
|
5126
5235
|
* @see https://dev.twitch.tv/docs/api/reference#get-streams
|
|
5127
5236
|
*/
|
|
5128
|
-
getStreams:
|
|
5237
|
+
getStreams: (params = null, options = {}) => this.callApi({
|
|
5129
5238
|
path: "/streams",
|
|
5130
5239
|
params,
|
|
5131
5240
|
options
|
|
@@ -5161,7 +5270,7 @@ var TwitchApi = class {
|
|
|
5161
5270
|
*
|
|
5162
5271
|
* @see https://dev.twitch.tv/docs/api/reference#get-followed-streams
|
|
5163
5272
|
*/
|
|
5164
|
-
getFollowedStreams:
|
|
5273
|
+
getFollowedStreams: (params, options = {}) => this.callApi({
|
|
5165
5274
|
path: "/streams/followed",
|
|
5166
5275
|
params,
|
|
5167
5276
|
options
|
|
@@ -5214,7 +5323,7 @@ var TwitchApi = class {
|
|
|
5214
5323
|
*
|
|
5215
5324
|
* @see https://dev.twitch.tv/docs/api/reference#create-stream-marker
|
|
5216
5325
|
*/
|
|
5217
|
-
createStreamMarker:
|
|
5326
|
+
createStreamMarker: (body, options = {}) => this.callApi({
|
|
5218
5327
|
path: "/streams/markers",
|
|
5219
5328
|
method: "POST",
|
|
5220
5329
|
body,
|
|
@@ -5258,7 +5367,7 @@ var TwitchApi = class {
|
|
|
5258
5367
|
*
|
|
5259
5368
|
* @see https://dev.twitch.tv/docs/api/reference#get-stream-markers
|
|
5260
5369
|
*/
|
|
5261
|
-
getStreamMarkers:
|
|
5370
|
+
getStreamMarkers: (params = null, options = {}) => this.callApi({
|
|
5262
5371
|
path: "/streams/markers",
|
|
5263
5372
|
params,
|
|
5264
5373
|
options
|
|
@@ -5298,7 +5407,7 @@ var TwitchApi = class {
|
|
|
5298
5407
|
*
|
|
5299
5408
|
* @see https://dev.twitch.tv/docs/api/reference#get-broadcaster-subscriptions
|
|
5300
5409
|
*/
|
|
5301
|
-
getBroadcasterSubscriptions:
|
|
5410
|
+
getBroadcasterSubscriptions: (params, options = {}) => this.callApi({
|
|
5302
5411
|
path: "/subscriptions",
|
|
5303
5412
|
params,
|
|
5304
5413
|
options
|
|
@@ -5341,7 +5450,7 @@ var TwitchApi = class {
|
|
|
5341
5450
|
*
|
|
5342
5451
|
* @see https://dev.twitch.tv/docs/api/reference#check-user-subscription
|
|
5343
5452
|
*/
|
|
5344
|
-
checkUserSubscription:
|
|
5453
|
+
checkUserSubscription: (params, options = {}) => this.callApi({
|
|
5345
5454
|
path: "/subscriptions/user",
|
|
5346
5455
|
params,
|
|
5347
5456
|
options
|
|
@@ -5380,7 +5489,7 @@ var TwitchApi = class {
|
|
|
5380
5489
|
*
|
|
5381
5490
|
* @see https://dev.twitch.tv/docs/api/reference#get-all-stream-tags
|
|
5382
5491
|
*/
|
|
5383
|
-
getAllStreamTags:
|
|
5492
|
+
getAllStreamTags: (params = null, options = {}) => this.callApi({
|
|
5384
5493
|
path: "/tags/streams",
|
|
5385
5494
|
params,
|
|
5386
5495
|
options
|
|
@@ -5417,7 +5526,7 @@ var TwitchApi = class {
|
|
|
5417
5526
|
*
|
|
5418
5527
|
* @see https://dev.twitch.tv/docs/api/reference#get-stream-tags
|
|
5419
5528
|
*/
|
|
5420
|
-
getStreamTags:
|
|
5529
|
+
getStreamTags: (params, options = {}) => this.callApi({
|
|
5421
5530
|
path: "/streams/tags",
|
|
5422
5531
|
params,
|
|
5423
5532
|
options
|
|
@@ -5457,7 +5566,7 @@ var TwitchApi = class {
|
|
|
5457
5566
|
*
|
|
5458
5567
|
* @see https://dev.twitch.tv/docs/api/reference#get-channel-teams
|
|
5459
5568
|
*/
|
|
5460
|
-
getChannelTeams:
|
|
5569
|
+
getChannelTeams: (params, options = {}) => this.callApi({
|
|
5461
5570
|
path: "/teams/channel",
|
|
5462
5571
|
params,
|
|
5463
5572
|
options
|
|
@@ -5497,7 +5606,7 @@ var TwitchApi = class {
|
|
|
5497
5606
|
*
|
|
5498
5607
|
* @see https://dev.twitch.tv/docs/api/reference#get-teams
|
|
5499
5608
|
*/
|
|
5500
|
-
getTeams:
|
|
5609
|
+
getTeams: (params = null, options = {}) => this.callApi({
|
|
5501
5610
|
path: "/teams",
|
|
5502
5611
|
params,
|
|
5503
5612
|
options
|
|
@@ -5525,12 +5634,12 @@ var TwitchApi = class {
|
|
|
5525
5634
|
*
|
|
5526
5635
|
* _200 OK_
|
|
5527
5636
|
*
|
|
5528
|
-
* Successfully retrieved the specified users
|
|
5637
|
+
* Successfully retrieved the specified users’ information.
|
|
5529
5638
|
*
|
|
5530
5639
|
* _400 Bad Request_
|
|
5531
5640
|
*
|
|
5532
|
-
* * The
|
|
5533
|
-
* * The request exceeded the maximum allowed number of
|
|
5641
|
+
* * The \*id\* or \*login\* query parameter is required unless the request uses a user access token.
|
|
5642
|
+
* * The request exceeded the maximum allowed number of \*id\* and/or \*login\* query parameters.
|
|
5534
5643
|
*
|
|
5535
5644
|
* _401 Unauthorized_
|
|
5536
5645
|
*
|
|
@@ -5540,7 +5649,7 @@ var TwitchApi = class {
|
|
|
5540
5649
|
*
|
|
5541
5650
|
* @see https://dev.twitch.tv/docs/api/reference#get-users
|
|
5542
5651
|
*/
|
|
5543
|
-
getUsers:
|
|
5652
|
+
getUsers: (params = null, options = {}) => this.callApi({
|
|
5544
5653
|
path: "/users",
|
|
5545
5654
|
params,
|
|
5546
5655
|
options
|
|
@@ -5577,7 +5686,7 @@ var TwitchApi = class {
|
|
|
5577
5686
|
*
|
|
5578
5687
|
* @see https://dev.twitch.tv/docs/api/reference#update-user
|
|
5579
5688
|
*/
|
|
5580
|
-
updateUser:
|
|
5689
|
+
updateUser: (params = null, options = {}) => this.callApi({
|
|
5581
5690
|
path: "/users",
|
|
5582
5691
|
method: "PUT",
|
|
5583
5692
|
params,
|
|
@@ -5614,7 +5723,7 @@ var TwitchApi = class {
|
|
|
5614
5723
|
*
|
|
5615
5724
|
* @see https://dev.twitch.tv/docs/api/reference#get-user-block-list
|
|
5616
5725
|
*/
|
|
5617
|
-
getUserBlockList:
|
|
5726
|
+
getUserBlockList: (params, options = {}) => this.callApi({
|
|
5618
5727
|
path: "/users/blocks",
|
|
5619
5728
|
params,
|
|
5620
5729
|
options
|
|
@@ -5654,7 +5763,7 @@ var TwitchApi = class {
|
|
|
5654
5763
|
*
|
|
5655
5764
|
* @see https://dev.twitch.tv/docs/api/reference#block-user
|
|
5656
5765
|
*/
|
|
5657
|
-
blockUser:
|
|
5766
|
+
blockUser: (params, options = {}) => this.callApi({
|
|
5658
5767
|
path: "/users/blocks",
|
|
5659
5768
|
method: "PUT",
|
|
5660
5769
|
params,
|
|
@@ -5690,7 +5799,7 @@ var TwitchApi = class {
|
|
|
5690
5799
|
*
|
|
5691
5800
|
* @see https://dev.twitch.tv/docs/api/reference#unblock-user
|
|
5692
5801
|
*/
|
|
5693
|
-
unblockUser:
|
|
5802
|
+
unblockUser: (params, options = {}) => this.callApi({
|
|
5694
5803
|
path: "/users/blocks",
|
|
5695
5804
|
method: "DELETE",
|
|
5696
5805
|
params,
|
|
@@ -5722,7 +5831,7 @@ var TwitchApi = class {
|
|
|
5722
5831
|
*
|
|
5723
5832
|
* @see https://dev.twitch.tv/docs/api/reference#get-user-extensions
|
|
5724
5833
|
*/
|
|
5725
|
-
getUserExtensions:
|
|
5834
|
+
getUserExtensions: (options = {}) => this.callApi({
|
|
5726
5835
|
path: "/users/extensions/list",
|
|
5727
5836
|
options
|
|
5728
5837
|
}),
|
|
@@ -5757,7 +5866,7 @@ var TwitchApi = class {
|
|
|
5757
5866
|
*
|
|
5758
5867
|
* @see https://dev.twitch.tv/docs/api/reference#get-user-active-extensions
|
|
5759
5868
|
*/
|
|
5760
|
-
getUserActiveExtensions:
|
|
5869
|
+
getUserActiveExtensions: (params = null, options = {}) => this.callApi({
|
|
5761
5870
|
path: "/users/extensions",
|
|
5762
5871
|
params,
|
|
5763
5872
|
options
|
|
@@ -5798,7 +5907,7 @@ var TwitchApi = class {
|
|
|
5798
5907
|
*
|
|
5799
5908
|
* @see https://dev.twitch.tv/docs/api/reference#update-user-extensions
|
|
5800
5909
|
*/
|
|
5801
|
-
updateUserExtensions:
|
|
5910
|
+
updateUserExtensions: (body, options = {}) => this.callApi({
|
|
5802
5911
|
path: "/users/extensions",
|
|
5803
5912
|
method: "PUT",
|
|
5804
5913
|
body,
|
|
@@ -5848,7 +5957,7 @@ var TwitchApi = class {
|
|
|
5848
5957
|
*
|
|
5849
5958
|
* @see https://dev.twitch.tv/docs/api/reference#get-videos
|
|
5850
5959
|
*/
|
|
5851
|
-
getVideos:
|
|
5960
|
+
getVideos: (params = null, options = {}) => this.callApi({
|
|
5852
5961
|
path: "/videos",
|
|
5853
5962
|
params,
|
|
5854
5963
|
options
|
|
@@ -5885,7 +5994,7 @@ var TwitchApi = class {
|
|
|
5885
5994
|
*
|
|
5886
5995
|
* @see https://dev.twitch.tv/docs/api/reference#delete-videos
|
|
5887
5996
|
*/
|
|
5888
|
-
deleteVideos:
|
|
5997
|
+
deleteVideos: (params, options = {}) => this.callApi({
|
|
5889
5998
|
path: "/videos",
|
|
5890
5999
|
method: "DELETE",
|
|
5891
6000
|
params,
|
|
@@ -5949,7 +6058,7 @@ var TwitchApi = class {
|
|
|
5949
6058
|
*
|
|
5950
6059
|
* @see https://dev.twitch.tv/docs/api/reference#send-whisper
|
|
5951
6060
|
*/
|
|
5952
|
-
sendWhisper:
|
|
6061
|
+
sendWhisper: (params, body, options = {}) => this.callApi({
|
|
5953
6062
|
path: "/whispers",
|
|
5954
6063
|
method: "POST",
|
|
5955
6064
|
params,
|