ts-twitch-api 0.2.8 → 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,
@@ -3128,7 +3128,7 @@ var TwitchApi = class {
      *
      * __Response Codes:__
      *
-     * _204 No Content_
+     * _200 OK_
      *
      * _400 Bad Request_
      *
@@ -4529,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:__
      *
@@ -4586,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 = {
@@ -4916,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,
@@ -4965,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.8",
+  "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"
   }
 }