ts-twitch-api 0.1.3 → 0.1.4
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.d.ts +2 -2
- package/dist/index.js +1 -2
- package/dist/twitch-api.d.ts +40 -36
- package/dist/twitch-api.generated.d.ts +11587 -11579
- package/package.json +3 -3
- package/dist/twitch-api.generated.js +0 -1
package/dist/index.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export
|
|
2
|
-
export * from './twitch-api.
|
|
1
|
+
export { TwitchApi } from './twitch-api';
|
|
2
|
+
export type * from './twitch-api.d.ts';
|
package/dist/index.js
CHANGED
|
@@ -1,2 +1 @@
|
|
|
1
|
-
export
|
|
2
|
-
export * from './twitch-api.generated';
|
|
1
|
+
export { TwitchApi } from './twitch-api';
|
package/dist/twitch-api.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { components, operations } from './twitch-api.generated';
|
|
1
|
+
import type { components, operations } from './twitch-api.generated.d.ts';
|
|
2
2
|
type Schema<T extends keyof components['schemas']> = components['schemas'][T];
|
|
3
3
|
type ParamsSchema<T extends keyof operations> = operations[T] extends {
|
|
4
4
|
parameters: {
|
|
@@ -3505,6 +3505,44 @@ export declare class TwitchApi {
|
|
|
3505
3505
|
ok: true;
|
|
3506
3506
|
status: 200;
|
|
3507
3507
|
data: {
|
|
3508
|
+
/**
|
|
3509
|
+
* Gets the broadcaster’s Shield Mode activation status.
|
|
3510
|
+
*
|
|
3511
|
+
* To receive notification when the broadcaster activates and deactivates Shield Mode, subscribe to the [channel.shield\_mode.begin](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelshield%5Fmodebegin) and [channel.shield\_mode.end](https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelshield%5Fmodeend) subscription types.
|
|
3512
|
+
*
|
|
3513
|
+
* __Authorization:__
|
|
3514
|
+
*
|
|
3515
|
+
* Requires a [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens) that includes the **moderator:read:shield\_mode** or **moderator:manage:shield\_mode** scope.
|
|
3516
|
+
*
|
|
3517
|
+
* __URL:__
|
|
3518
|
+
*
|
|
3519
|
+
* `GET https://api.twitch.tv/helix/moderation/shield_mode`
|
|
3520
|
+
*
|
|
3521
|
+
* __Response Codes:__
|
|
3522
|
+
*
|
|
3523
|
+
* _200 OK_
|
|
3524
|
+
*
|
|
3525
|
+
* Successfully retrieved the broadcaster’s Shield Mode activation status.
|
|
3526
|
+
*
|
|
3527
|
+
* _400 Bad Request_
|
|
3528
|
+
*
|
|
3529
|
+
* * The _broadcaster\_id_ query parameter is required.
|
|
3530
|
+
* * The ID in the _broadcaster\_id_ query parameter is not valid.
|
|
3531
|
+
*
|
|
3532
|
+
* _401 Unauthorized_
|
|
3533
|
+
*
|
|
3534
|
+
* * The ID in _moderator\_id_ must match the user ID in the user access token.
|
|
3535
|
+
* * The Authorization header is required and must contain a user access token.
|
|
3536
|
+
* * The user access token must include the **moderator:read:shield\_mode** or **moderator:manage:shield\_mode** scope.
|
|
3537
|
+
* * The access token is not valid.
|
|
3538
|
+
* * The client ID specified in the Client-Id header does not match the client ID specified in the access token.
|
|
3539
|
+
*
|
|
3540
|
+
* _403 Forbidden_
|
|
3541
|
+
*
|
|
3542
|
+
* * The user in _moderator\_id_ is not one of the broadcaster's moderators.
|
|
3543
|
+
*
|
|
3544
|
+
* @see https://dev.twitch.tv/docs/api/reference#get-shield-mode-status
|
|
3545
|
+
*/
|
|
3508
3546
|
data: {
|
|
3509
3547
|
author_name: string;
|
|
3510
3548
|
bits_enabled: boolean;
|
|
@@ -5853,41 +5891,7 @@ export declare class TwitchApi {
|
|
|
5853
5891
|
data: {
|
|
5854
5892
|
is_active: boolean;
|
|
5855
5893
|
moderator_id: string;
|
|
5856
|
-
moderator_login: string;
|
|
5857
|
-
* Gets information about the specified Twitch team. [Read More](https://help.twitch.tv/s/article/twitch-teams)
|
|
5858
|
-
*
|
|
5859
|
-
* __Authorization:__
|
|
5860
|
-
*
|
|
5861
|
-
* 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).
|
|
5862
|
-
*
|
|
5863
|
-
* __URL:__
|
|
5864
|
-
*
|
|
5865
|
-
* `GET https://api.twitch.tv/helix/teams`
|
|
5866
|
-
*
|
|
5867
|
-
* __Response Codes:__
|
|
5868
|
-
*
|
|
5869
|
-
* _200 OK_
|
|
5870
|
-
*
|
|
5871
|
-
* Successfully retrieved the team’s information.
|
|
5872
|
-
*
|
|
5873
|
-
* _400 Bad Request_
|
|
5874
|
-
*
|
|
5875
|
-
* * The _name_ or _id_ query parameter is required.
|
|
5876
|
-
* * Specify either the _name_ or _id_ query parameter but not both.
|
|
5877
|
-
* * The ID in the _id_ query parameter is not valid.
|
|
5878
|
-
*
|
|
5879
|
-
* _401 Unauthorized_
|
|
5880
|
-
*
|
|
5881
|
-
* * The Authorization header must contain an app access token or user access token.
|
|
5882
|
-
* * The access token is not valid.
|
|
5883
|
-
* * The ID specified in the Client-Id header does not match the client ID specified in the access token.
|
|
5884
|
-
*
|
|
5885
|
-
* _404 Not Found_
|
|
5886
|
-
*
|
|
5887
|
-
* * The specified team was not found.
|
|
5888
|
-
*
|
|
5889
|
-
* @see https://dev.twitch.tv/docs/api/reference#get-teams
|
|
5890
|
-
*/
|
|
5894
|
+
moderator_login: string;
|
|
5891
5895
|
moderator_name: string;
|
|
5892
5896
|
last_activated_at: string;
|
|
5893
5897
|
}[];
|