ts-twitch-api 0.2.4 → 0.2.6

package/dist/index.cjs

@@ -18,11 +18,11 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // index.ts
-var twitch_api_ts_exports = {};
-__export(twitch_api_ts_exports, {
+var index_exports = {};
+__export(index_exports, {
   TwitchApi: () => TwitchApi
 });
-module.exports = __toCommonJS(twitch_api_ts_exports);
+module.exports = __toCommonJS(index_exports);
 
 // twitch-api.ts
 var BASE_URL = "https://api.twitch.tv/helix";
@@ -1363,6 +1363,43 @@ var TwitchApi = class {
       body,
       options
     }),
+    /**
+     * NEW Retrieves the active shared chat session for a channel.
+     *
+     * __Authorization:__
+     *
+     * 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).
+     *
+     * __URL:__
+     *
+     * `GET https://api.twitch.tv/helix/shared_chat/session`
+     *
+     * __Response Codes:__
+     *
+     * _200 OK_
+     *
+     * Successfully retrieved the shared chat session. Returns an empty array if the broadcaster\_id in the request isn’t in a shared chat session.
+     *
+     * _400 Bad Request_
+     *
+     * The ID in the `broadcaster_id` query parameter is not valid.
+     *
+     * _401 Unauthorized_
+     *
+     * * The OAuth token is not valid.
+     * * The Authorization header is required and must contain a user access token.
+     *
+     * _500 Internal Server Error_
+     *
+     * Internal Server Error.
+     *
+     * @see https://dev.twitch.tv/docs/api/reference#get-shared-chat-session
+     */
+    getSharedChatSession: (params, options = {}) => this.callApi({
+      path: "/shared_chat/session",
+      params,
+      options
+    }),
     /**
      * NEW Retrieves emotes available to the user across all channels.
      *
@@ -1404,6 +1441,8 @@ var TwitchApi = class {
     /**
      * Sends an announcement to the broadcaster’s chat room.
      *
+     * **Rate Limits**: One announcement may be sent every 2 seconds.
+     *
      * __Authorization:__
      *
      * Requires a [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens) that includes the **moderator:manage:announcements** scope.
@@ -1432,6 +1471,10 @@ var TwitchApi = class {
      * * The OAuth token is not valid.
      * * The client ID specified in the Client-Id header does not match the client ID specified in the OAuth token.
      *
+     * _429 Too Many Requests_
+     *
+     * The sender has exceeded the number of announcements they may send to this **broadcaster\_id** within a given window.
+     *
      * @see https://dev.twitch.tv/docs/api/reference#send-chat-announcement
      */
     sendChatAnnouncement: (params, body, options = {}) => this.callApi({
@@ -1446,7 +1489,7 @@ var TwitchApi = class {
      *
      * 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)
      *
-     * **Rate Limits** The broadcaster may send a Shoutout once every 2 minutes. They may send the same broadcaster a Shoutout once every 60 minutes.
+     * **Rate Limits**: The broadcaster may send a Shoutout once every 2 minutes. They may send the same broadcaster a Shoutout once every 60 minutes.
      *
      * 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.
      *
@@ -1502,6 +1545,11 @@ var TwitchApi = class {
     /**
      * NEW Sends a message to the broadcaster’s chat room.
      *
+     * **NOTE:** When sending messages to a Shared Chat session, behaviors differ depending on your authentication token type:
+     *
+     * * When using an _App Access Token_, messages will only be sent to the source channel (defined by the `broadcaster_id` parameter) by default starting on May 19, 2025\. Messages can be sent to all channels by using the `for_source_only` parameter and setting it to `false`.
+     * * When using a _User Access Token_, messages will be sent to all channels in the shared chat session, including the source channel. This behavior cannot be changed with this token type.
+     *
      * __Authorization:__
      *
      * 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 `user:write:chat` scope. If app access token used, then additionally requires `user:bot` scope from chatting user, and either `channel:bot` scope from broadcaster or moderator status.
@@ -1524,6 +1572,7 @@ var TwitchApi = class {
      * * The ID in the _sender\_id_ query parameter is not valid.
      * * The _text_ query parameter is required.
      * * The ID in the _reply\_parent\_message\_id_ query parameter is not valid.
+     * * Cannot set \*for\_source\_only\* if User Access Token is used.
      *
      * _401 Unauthorized_
      *
@@ -1680,6 +1729,8 @@ var TwitchApi = class {
     /**
      * 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).
      *
+     * 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.
+     *
      * __Authorization:__
      *
      * 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).
@@ -1723,7 +1774,7 @@ var TwitchApi = class {
   };
   conduits = {
     /**
-     * NEW Gets the [conduits](https://dev.twitch.tv/docs/eventsub/handling-conduit-events) for a client ID.
+     * NEW Gets the [conduits](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/) for a client ID.
      *
      * __Authorization:__
      *
@@ -1750,7 +1801,7 @@ var TwitchApi = class {
       options
     }),
     /**
-     * NEW Creates a new [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events).
+     * NEW Creates a new [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/).
      *
      * __Authorization:__
      *
@@ -1787,7 +1838,7 @@ var TwitchApi = class {
       options
     }),
     /**
-     * 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.
+     * 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.
      *
      * __Authorization:__
      *
@@ -1826,7 +1877,7 @@ var TwitchApi = class {
       options
     }),
     /**
-     * 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).
+     * 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).
      *
      * __Authorization:__
      *
@@ -1864,7 +1915,7 @@ var TwitchApi = class {
       options
     }),
     /**
-     * NEW Gets a lists of all shards for a [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events).
+     * NEW Gets a lists of all shards for a [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/).
      *
      * __Authorization:__
      *
@@ -1901,7 +1952,7 @@ var TwitchApi = class {
       options
     }),
     /**
-     * NEW Updates shard(s) for a [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events).
+     * NEW Updates shard(s) for a [conduit](https://dev.twitch.tv/docs/eventsub/handling-conduit-events/).
      *
      * **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.
      *
@@ -1995,7 +2046,7 @@ var TwitchApi = class {
      *
      * __Authorization:__
      *
-     * Requires an [app access token](https://dev.twitch.tv/docs/authentication#app-access-tokens) or [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens). The client ID in the access token must own the game.
+     * Requires an [app access token](https://dev.twitch.tv/docs/authentication#app-access-tokens) or [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens). The Client ID associated with the access token must be owned by a user who is a member of the [organization](https://dev.twitch.tv/docs/docs/companies/) that holds ownership of the game.
      *
      * __URL:__
      *
@@ -2047,7 +2098,7 @@ var TwitchApi = class {
      *
      * __Authorization:__
      *
-     * Requires an [app access token](https://dev.twitch.tv/docs/authentication#app-access-tokens) or [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens). The client ID in the access token must own the game.
+     * Requires an [app access token](https://dev.twitch.tv/docs/authentication#app-access-tokens) or [user access token](https://dev.twitch.tv/docs/authentication#user-access-tokens). The Client ID associated with the access token must be owned by a user who is a member of the [organization](https://dev.twitch.tv/docs/docs/companies/) that holds ownership of the game.
      *
      * __URL:__
      *
@@ -2593,7 +2644,7 @@ var TwitchApi = class {
      *
      * 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.
      *
-     * 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.
+     * 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.
      *
      * __URL:__
      *
@@ -2692,13 +2743,13 @@ var TwitchApi = class {
      *
      * __Authorization:__
      *
-     * 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.
+     * 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.
      *
      * 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.
      *
      * __Request Query Parameters:__
      *
-     * Use the _status_, _type_, and _user\_id_ query parameters to filter the list of subscriptions that are returned. The filters are mutually exclusive; the request fails if you specify more than one filter.
+     * Use the _status_, _type_, _user\_id_, and _subscription\_id_ query parameters to filter the list of subscriptions that are returned. The filters are mutually exclusive; the request fails if you specify more than one filter.
      *
      * __URL:__
      *
@@ -3306,6 +3357,45 @@ var TwitchApi = class {
       path: "/hypetrain/events",
       params,
       options
+    }),
+    /**
+     * BETA Get the status of a Hype Train for the specified broadcaster.
+     *
+     * __Authorization:__
+     *
+     * * Requires an [user access token](https://dev.twitch.tv/docs/authentication/#user-access-tokens).
+     * * Requires OAuth Scope: `channel:read:hype_train`.
+     * * Requires that `broadcaster_id` and `user_id` match in the User-Access token.
+     *
+     * __URL:__
+     *
+     * `GET https://api.twitch.tv/helix/hypetrain/status`
+     *
+     * __Response Codes:__
+     *
+     * _200 OK_
+     *
+     * Successfully retrieved the status object.
+     *
+     * _400 Bad Request_
+     *
+     * The ID in the `broadcaster_id` query parameter is not valid.
+     *
+     * _401 Unauthorized_
+     *
+     * * The OAuth token is not valid.
+     * * The Authorization header is required and must contain a user access token.
+     *
+     * _500 Internal Server Error_
+     *
+     * Internal Server Error.
+     *
+     * @see https://dev.twitch.tv/docs/api/reference#get-hype-train-status
+     */
+    getHypeTrainStatus: (params, options = {}) => this.callApi({
+      path: "/hypetrain/status",
+      params,
+      options
     })
   };
   moderation = {
@@ -3719,7 +3809,7 @@ var TwitchApi = class {
      *
      * __Authorization:__
      *
-     * * Requires a user access token that includes the **moderator:manage:unban\\\_requests** scope.
+     * * Requires a user access token that includes the **moderator:manage:unban\_requests** scope.
      * * Query parameter `moderator_id` must match the `user_id` in the[user access token](https://dev.twitch.tv/docs/authentication/#user-access-tokens).
      *
      * __URL:__
@@ -5175,6 +5265,10 @@ var TwitchApi = class {
      * * The access token is not valid.
      * * The client ID specified in the Client-Id header must match the client ID specified in the access token.
      *
+     * _403 Forbidden_
+     *
+     * The user must complete additional steps in order to stream. Present the user with the returned error message.
+     *
      * @see https://dev.twitch.tv/docs/api/reference#get-stream-key
      */
     getStreamKey: (params, options = {}) => this.callApi({
@@ -5661,6 +5755,10 @@ var TwitchApi = class {
      * * The access token is not valid.
      * * The ID specified in the Client-Id header does not match the client ID specified in the access token.
      *
+     * _429 Too Many Requests_
+     *
+     * The app exceeded the number of requests that it may make.
+     *
      * @see https://dev.twitch.tv/docs/api/reference#update-user
      */
     updateUser: (params = null, options = {}) => this.callApi({