ts-twitch-api 0.2.6 → 0.2.8

package/dist/index.cjs

@@ -1677,7 +1677,7 @@ var TwitchApi = class {
     /**
      * Creates a clip from the broadcaster’s stream.
      *
-     * This API captures up to 90 seconds of the broadcaster’s stream. The 90 seconds spans the point in the stream from when you called the API. For example, if you call the API at the 4:00 minute mark, the API captures from approximately the 3:35 mark to approximately the 4:05 minute mark. Twitch tries its best to capture 90 seconds of the stream, but the actual length may be less. This may occur if you begin capturing the clip near the beginning or end of the stream.
+     * This API captures up to 90 seconds of the broadcaster’s stream. The 90 seconds spans the point in the stream from when you called the API. For example, if you call the API at the 4:00 minute mark, the API captures from approximately the 2:35 mark to approximately the 4:05 minute mark. Twitch tries its best to capture 90 seconds of the stream, but the actual length may be less. This may occur if you begin capturing the clip near the beginning or end of the stream.
      *
      * By default, Twitch publishes up to the last 30 seconds of the 90 seconds window and provides a default title for the clip. To specify the title and the portion of the 90 seconds window that’s used for the clip, use the URL in the response’s `edit_url` field. You can specify a clip that’s from 5 seconds to 60 seconds in length. The URL is valid for up to 24 hours or until the clip is published, whichever comes first.
      *
@@ -1701,6 +1701,8 @@ var TwitchApi = class {
      *
      * * The _broadcaster\_id_ query parameter is required.
      * * The ID in the _broadcaster\_id_ query parameter was not found.
+     * * The category is not clippable.
+     * * The title did not pass AutoMod checks.
      *
      * _401 Unauthorized_
      *
@@ -1713,6 +1715,7 @@ var TwitchApi = class {
      *
      * * The broadcaster has restricted the ability to capture clips to followers and/or subscribers only.
      * * The specified broadcaster has not enabled clips on their channel.
+     * * The user is banned or timed out from the broadcaster’s channel.
      *
      * _404 Not Found_
      *
@@ -1770,6 +1773,112 @@ var TwitchApi = class {
       path: "/clips",
       params,
       options
+    }),
+    /**
+     * BETA Creates a clip from a broadcaster’s VOD on behalf of the broadcaster or an editor of the channel. Since a live stream is actively creating a VOD, this endpoint can also be used to create a clip from earlier in the current stream.
+     *
+     * The duration of a clip can be from 5 seconds to 60 seconds in length, with a default of 30 seconds if not specified.
+     *
+     * `vod_offset` indicates where the clip will end. In other words, the clip will start at (`vod_offset` \- `duration`) and end at `vod_offset`. This means that the value of `vod_offset` must greater than or equal to the value of `duration`.
+     *
+     * The URL in the response’s `edit_url` field allows you to edit the clip’s title, feature the clip, create a portrait version of the clip, download the clip media, and share the clip directly to social platforms.
+     *
+     * __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:__
+     *
+     * `POST https://api.twitch.tv/helix/videos/clips`
+     *
+     * __Response Codes:__
+     *
+     * _202 Accepted_
+     *
+     * Successfully started the clip process.
+     *
+     * _400 Bad Request_
+     *
+     * * Validation errors: Invalid source type, missing required fields.
+     * * The broadcaster\_id query parameter is required.
+     * * The ID in the broadcaster\_id query parameter was not found.
+     * * The category is not clippable.
+     * * The title did not pass AutoMod checks.
+     * * Broadcaster is banned.
+     *
+     * _401 Unauthorized_
+     *
+     * * The Authorization header is required and must specify user access token.
+     * * The user access token must include the **editor:manage:clips** or **channel:manage:clips** scope.
+     * * The OAuth token is not valid.
+     * * The ID in the Client-Id header must match the Client ID in the OAuth token.
+     *
+     * _403 Forbidden_
+     *
+     * * The broadcaster has restricted the ability to capture clips to followers and/or subscribers only.
+     * * The specified broadcaster has not enabled clips on their channel.
+     * * The user defined by the _editor\_id_ is not authorized to create Clips.
+     * * The user is banned or timed out from the broadcaster's channel.
+     *
+     * _404 Not Found_
+     *
+     * * The broadcaster in the _broadcaster\_id_ query parameter must be broadcasting live.
+     * * The VOD is not found..
+     * * The _broadcaster\_id_ or the _editor\_id_ does not exist.
+     *
+     * @see https://dev.twitch.tv/docs/api/reference#create-clip-from-vod
+     */
+    createClipFromVOD: (params, options = {}) => this.callApi({
+      path: "/videos/clips",
+      method: "POST",
+      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 = {
@@ -3325,6 +3434,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)).
@@ -3359,7 +3470,7 @@ var TwitchApi = class {
       options
     }),
     /**
-     * BETA Get the status of a Hype Train for the specified broadcaster.
+     * NEW Get the status of a Hype Train for the specified broadcaster.
      *
      * __Authorization:__
      *
@@ -5767,6 +5878,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)
      *