ts-twitch-api 0.2.5 → 0.2.7

package/dist/index.cjs

@@ -1545,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.
@@ -1567,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_
      *
@@ -1764,6 +1770,52 @@ var TwitchApi = class {
       path: "/clips",
       params,
       options
+    }),
+    /**
+     * 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).
+     *
+     * **Rate Limits**: Limited to 100 requests per minute.
+     *
+     * __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 `editor:manage:clips` or `channel:manage:clips` scope.
+     *
+     * __URL:__
+     *
+     * `GET https://api.twitch.tv/helix/clips/downloads`
+     *
+     * __Response Codes:__
+     *
+     * _200 OK_
+     *
+     * Successfully retrieved the clip download URL(s).
+     *
+     * _400 Bad Request_
+     *
+     * The ID in the broadcaster\_id, editor\_id, or clip\_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 or app access token.
+     * * The access token must include the editor:manage:clips or channel:manage:clips scope
+     * * The access token is not valid
+     * * The client ID specified in the Client-Id header does not match the client ID specified in the access token.
+     *
+     * _403 Forbidden_
+     *
+     * The user is not an editor for the specified broadcaster.
+     *
+     * _500 Internal Server Error_
+     *
+     * Internal Server Error.
+     *
+     * @see https://dev.twitch.tv/docs/api/reference#get-clips-download
+     */
+    getClipsDownload: (params, options = {}) => this.callApi({
+      path: "/clips/downloads",
+      params,
+      options
     })
   };
   conduits = {
@@ -2040,7 +2092,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:__
      *
@@ -2092,7 +2144,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:__
      *
@@ -2743,7 +2795,7 @@ var TwitchApi = class {
      *
      * __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:__
      *
@@ -3319,6 +3371,8 @@ var TwitchApi = class {
   };
   hypeTrain = {
     /**
+     * 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).
+     *
      * Gets information about the broadcaster’s current or most recent Hype Train event.
      *
      * 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)).
@@ -3351,6 +3405,45 @@ var TwitchApi = class {
       path: "/hypetrain/events",
       params,
       options
+    }),
+    /**
+     * NEW 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 = {
@@ -5710,6 +5803,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({
@@ -5718,6 +5815,47 @@ var TwitchApi = class {
       params,
       options
     }),
+    /**
+     * NEW Gets the authorization scopes that the specified user(s) have granted the application.
+     *
+     * __Authorization:__
+     *
+     * Requires an [app access token](https://dev.twitch.tv/docs/authentication#app-access-tokens).
+     *
+     * __URL:__
+     *
+     * `GET https://api.twitch.tv/helix/authorization/users`
+     *
+     * __Response Codes:__
+     *
+     * _200 OK_
+     *
+     * Successfully retrieved user authorization.
+     *
+     * _400 Bad Request_
+     *
+     * Request is malformed - invalid parameters or missing parameters.
+     *
+     * _401 Unauthorized_
+     *
+     * * The access token is not valid.
+     * * Authorization header is required and must specify an app access token.
+     *
+     * _403 Forbidden_
+     *
+     * The client-id in the header must match the client ID in the access token.
+     *
+     * _500 Internal Server Error_
+     *
+     * Internal Server Error.
+     *
+     * @see https://dev.twitch.tv/docs/api/reference#get-authorization-by-user
+     */
+    getAuthorizationByUser: (params, options = {}) => this.callApi({
+      path: "/authorization/users",
+      params,
+      options
+    }),
     /**
      * 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)
      *