ts-twitch-api 0.2.1 → 0.2.3

package/dist/index.js

@@ -47,10 +47,17 @@ var TwitchApi = class {
       options.headers.set("Client-Id", clientId || this._clientId);
     }
     const response = await fetch(url, options);
+    const status = response.status;
+    let data = null;
+    if (status === 200 && path === "/schedule/icalendar") {
+      data = await response.text();
+    } else if (status !== 204) {
+      data = await response.json();
+    }
     return {
       ok: response.ok,
-      status: response.status,
-      data: await response.json()
+      status,
+      data
     };
   }
   ads = {
@@ -1329,6 +1336,44 @@ var TwitchApi = class {
       body,
       options
     }),
+    /**
+     * BETA Retrieves emotes available to the user across all channels.
+     *
+     * __Authorization:__
+     *
+     * * Requires a user access token that includes the **user:read:emotes** scope.
+     * * Query parameter `user_id` must match the `user_id` in the user access token.
+     *
+     * __URL:__
+     *
+     * `GET https://api.twitch.tv/helix/chat/emotes/user`
+     *
+     * __Response Codes:__
+     *
+     * _200 OK_
+     *
+     * Successfully retrieved the emotes.
+     *
+     * _400 Bad Request_
+     *
+     * * The _user\_id_ query parameter is required.
+     * * The ID in the _user\_id_ query parameter is not valid.
+     *
+     * _401 Unauthorized_
+     *
+     * * The ID in _user\_id_ must match the user ID in the user access token.
+     * * The Authorization header is required and must contain a user access token.
+     * * The user access token must include the **user:read:emotes** 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.
+     *
+     * @see https://dev.twitch.tv/docs/api/reference#get-user-emotes
+     */
+    getUserEmotes: async (params, options = {}) => this.callApi({
+      path: "/chat/emotes/user",
+      params,
+      options
+    }),
     /**
      * Sends an announcement to the broadcaster’s chat room.
      *
@@ -1905,6 +1950,8 @@ var TwitchApi = class {
     /**
      * Gets an organization’s list of entitlements that have been granted to a game, a user, or both.
      *
+     * **NOTE:** Entitlements returned in the response body data are not guaranteed to be sorted by any field returned by the API. To retrieve **CLAIMED** or **FULFILLED** entitlements, use the `fulfillment_status` query parameter to filter results. To retrieve entitlements for a specific game, use the `game_id` query parameter to filter results.
+     *
      * The following table identifies the request parameters that you may specify based on the type of access token used.
      *
      * | Access token type | Parameter | Description |
@@ -2618,7 +2665,7 @@ var TwitchApi = class {
      *
      * __Authorization:__
      *
-     * If you use [webhooks to receive events](https://dev.twitch.tv/docs/eventsub/handling-webhook-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.
      *
@@ -3599,6 +3646,95 @@ var TwitchApi = class {
       params,
       options
     }),
+    /**
+     * BETA Gets a list of unban requests for a broadcaster’s channel.
+     *
+     * __Authorization:__
+     *
+     * * Requires a user access token that includes the **moderator:read:unban\_requests** or **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:__
+     *
+     * `GET https://api.twitch.tv/helix/moderation/unban_requests`
+     *
+     * __Response Codes:__
+     *
+     * _200 OK_
+     *
+     * Successfully retrieved the list of unban requests.
+     *
+     * _400 Bad Request_
+     *
+     * * The _broadcaster\_id_ query parameter is required.
+     * * The ID in the _broadcaster\_id_ query parameter is not valid.
+     * * The _moderator\_id_ query parameter is required.
+     * * The ID in the _moderator\_id_ query parameter is not valid.
+     * * The pagination cursor is not valid.
+     *
+     * _401 Unauthorized_
+     *
+     * * The ID in _moderator\_id_ must match the user ID in the user access token.
+     * * The Authorization header is required and must contain a user access token.
+     * * The user access token must include the **moderator:read:unban\_requests** or **moderator:manage:unban\_requests** 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.
+     *
+     * @see https://dev.twitch.tv/docs/api/reference#get-unban-requests
+     */
+    getUnbanRequests: async (params, options = {}) => this.callApi({
+      path: "/moderation/unban_requests",
+      params,
+      options
+    }),
+    /**
+     * BETA Resolves an unban request by approving or denying it.
+     *
+     * __Authorization:__
+     *
+     * * 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:__
+     *
+     * `PATCH https://api.twitch.tv/helix/moderation/unban_requests`
+     *
+     * __Response Codes:__
+     *
+     * _200 OK_
+     *
+     * Successfully resolved the unban request.
+     *
+     * _400 Bad Request_
+     *
+     * * The _broadcaster\_id_ query parameter is required.
+     * * The ID in the _broadcaster\_id_ query parameter is not valid.
+     * * The _moderator\_id_ query parameter is required.
+     * * The ID in the _moderator\_id_ query parameter is not valid.
+     * * The pagination cursor is not valid.
+     * * The broadcaster is not receiving unban requests
+     * * Invalid requested update
+     *
+     * _401 Unauthorized_
+     *
+     * * The ID in _moderator\_id_ must match the user ID in the user access token.
+     * * The Authorization header is required and must contain a user access token.
+     * * The user access token must include the **moderator:manage:unban\_requests** 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.
+     *
+     * _404 Not Found_
+     *
+     * The unban request ID was not found.
+     *
+     * @see https://dev.twitch.tv/docs/api/reference#resolve-unban-requests
+     */
+    resolveUnbanRequests: async (params, options = {}) => this.callApi({
+      path: "/moderation/unban_requests",
+      method: "PATCH",
+      params,
+      options
+    }),
     /**
      * Gets the broadcaster’s list of non-private, blocked words or phrases. These are the terms that the broadcaster or moderator added manually or that were denied by AutoMod.
      *
@@ -4209,7 +4345,7 @@ var TwitchApi = class {
      *
      * _200 OK_
      *
-     * Successfully retrieved the broadcaster’s polls.
+     * Successfully retrieved the broadcaster's polls.
      *
      * _400 Bad Request_
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-twitch-api",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "Very simple TwitchApi class and TypeScript interfaces for all Twitch API endpoints",
   "author": "DmitryScaletta",
   "license": "MIT",
@@ -34,9 +34,9 @@
     "gen": "pnpm dlx openapi-typescript https://github.com/DmitryScaletta/twitch-api-swagger/raw/main/openapi.json --output twitch-api.generated.ts"
   },
   "devDependencies": {
-    "@types/node": "^20.11.2",
-    "tsup": "^8.0.1",
-    "tsx": "^4.7.0",
-    "typescript": "^5.3.3"
+    "@types/node": "^20.11.28",
+    "tsup": "^8.0.2",
+    "tsx": "^4.7.1",
+    "typescript": "^5.4.2"
   }
 }