ts-twitch-api 0.2.7 → 0.3.0

package/dist/index.js

@@ -1510,7 +1510,7 @@ var TwitchApi = class {
      *
      * @see https://dev.twitch.tv/docs/api/reference#send-a-shoutout
      */
-    sendShoutout: (params, options = {}) => this.callApi({
+    sendAShoutout: (params, options = {}) => this.callApi({
       path: "/chat/shoutouts",
       method: "POST",
       params,
@@ -1651,7 +1651,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.
      *
@@ -1675,6 +1675,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_
      *
@@ -1687,6 +1689,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_
      *
@@ -1745,6 +1748,66 @@ var TwitchApi = class {
       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).
      *
@@ -3065,7 +3128,7 @@ var TwitchApi = class {
      *
      * __Response Codes:__
      *
-     * _204 No Content_
+     * _200 OK_
      *
      * _400 Bad Request_
      *
@@ -4466,7 +4529,7 @@ var TwitchApi = class {
       options
     }),
     /**
-     * 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).
+     * 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).
      *
      * __Authorization:__
      *
@@ -4523,6 +4586,92 @@ var TwitchApi = class {
       params,
       body,
       options
+    }),
+    /**
+     * BETA Adds a suspicious user status to a chatter on the broadcaster’s channel.
+     *
+     * __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 **moderator:manage:suspicious\_users** scope.
+     *
+     * __URL:__
+     *
+     * `POST https://api.twitch.tv/helix/moderation/suspicious_users`
+     *
+     * __Response Codes:__
+     *
+     * _200 OK_
+     *
+     * Successfully applied a suspicious user status.
+     *
+     * _400 Bad Request_
+     *
+     * * Validation errors: Missing required fields.
+     * * The ID in the broadcaster\_id query parameter was not found.
+     * * The status specified was invalid. Must either be ACTIVE\_MONITORING or RESTRICTED
+     * * The status update is not allowed for this user.
+     *
+     * _401 Unauthorized_
+     *
+     * * The Authorization header is required and must specify user access token.
+     * * The user access token must include the **moderator:manage:suspicious\_users** 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 user in the moderator\_id query parameter is not one of the broadcaster's moderators.
+     *
+     * @see https://dev.twitch.tv/docs/api/reference#add-suspicious-status-to-chat-user
+     */
+    addSuspiciousStatusToChatUser: (params, body, options = {}) => this.callApi({
+      path: "/moderation/suspicious_users",
+      method: "POST",
+      params,
+      body,
+      options
+    }),
+    /**
+     * BETA Remove a suspicious user status from a chatter on broadcaster’s channel.
+     *
+     * __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 **moderator:manage:suspicious\_users** scope.
+     *
+     * __URL:__
+     *
+     * `DELETE https://api.twitch.tv/helix/moderation/suspicious_users`
+     *
+     * __Response Codes:__
+     *
+     * _200 OK_
+     *
+     * Successfully removed a suspicious user status.
+     *
+     * _400 Bad Request_
+     *
+     * * Validation errors: Missing required fields.
+     * * The ID in the broadcaster\_id query parameter was not found.
+     * * The status update is not allowed for this user.
+     *
+     * _401 Unauthorized_
+     *
+     * * The Authorization header is required and must specify user access token.
+     * * The user access token must include the **moderator:manage:suspicious\_users** 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 user in the moderator\_id query parameter is not one of the broadcaster's moderators.
+     *
+     * @see https://dev.twitch.tv/docs/api/reference#remove-suspicious-status-from-chat-user
+     */
+    removeSuspiciousStatusFromChatUser: (params, options = {}) => this.callApi({
+      path: "/moderation/suspicious_users",
+      method: "DELETE",
+      params,
+      options
     })
   };
   polls = {
@@ -4853,7 +5002,7 @@ var TwitchApi = class {
      *
      * @see https://dev.twitch.tv/docs/api/reference#start-a-raid
      */
-    startRaid: (params = null, options = {}) => this.callApi({
+    startARaid: (params = null, options = {}) => this.callApi({
       path: "/raids",
       method: "POST",
       params,
@@ -4902,7 +5051,7 @@ var TwitchApi = class {
      *
      * @see https://dev.twitch.tv/docs/api/reference#cancel-a-raid
      */
-    cancelRaid: (params, options = {}) => this.callApi({
+    cancelARaid: (params, options = {}) => this.callApi({
       path: "/raids",
       method: "DELETE",
       params,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-twitch-api",
-  "version": "0.2.7",
+  "version": "0.3.0",
   "description": "Very simple TwitchApi class and TypeScript interfaces for all Twitch API endpoints",
   "author": "DmitryScaletta",
   "license": "MIT",
@@ -36,6 +36,6 @@
   "scripts": {
     "build": "pnpm build:src && tsup",
     "build:src": "node ./scripts/build.ts",
-    "gen": "pnpm dlx openapi-typescript@6 https://github.com/DmitryScaletta/twitch-api-swagger/raw/main/openapi.json --output twitch-api.generated.ts"
+    "gen": "pnpx openapi-typescript@6 https://github.com/DmitryScaletta/twitch-api-swagger/raw/main/openapi.json --output twitch-api.generated.ts"
   }
 }