@twurple/api - npm Package Compare versions

Comparing version 5.0.0-pre.17 to 5.0.0

lib/api/helix/channelPoints/HelixCustomRewardRedemption.d.ts

@@ -98,6 +98,2 @@ import { DataObject } from '@twurple/common';
     /**
-     * Retrieves more info about the reward that was redeemed.
-     */
-    getReward(): Promise<HelixCustomReward>;
-    /**
      * The title of the reward that was redeemed.
@@ -114,3 +110,13 @@ */
     get rewardCost(): number;
+    /**
+     * Retrieves more info about the reward that was redeemed.
+     */
+    getReward(): Promise<HelixCustomReward>;
+    /**
+     * Updates the redemption's status.
+     *
+     * @param newStatus The status the redemption should have.
+     */
+    updateStatus(newStatus: HelixCustomRewardRedemptionTargetStatus): Promise<HelixCustomRewardRedemption>;
 }
 //# sourceMappingURL=HelixCustomRewardRedemption.d.ts.map

lib/api/helix/channelPoints/HelixCustomRewardRedemption.js

@@ -101,8 +101,2 @@ "use strict";
     /**
-     * Retrieves more info about the reward that was redeemed.
-     */
-    async getReward() {
-        return (await this._client.channelPoints.getCustomRewardById(this[common_1.rawDataSymbol].broadcaster_id, this[common_1.rawDataSymbol].reward.id));
-    }
-    /**
      * The title of the reward that was redeemed.
@@ -125,2 +119,17 @@ */
     }
+    /**
+     * Retrieves more info about the reward that was redeemed.
+     */
+    async getReward() {
+        return (await this._client.channelPoints.getCustomRewardById(this[common_1.rawDataSymbol].broadcaster_id, this[common_1.rawDataSymbol].reward.id));
+    }
+    /**
+     * Updates the redemption's status.
+     *
+     * @param newStatus The status the redemption should have.
+     */
+    async updateStatus(newStatus) {
+        const result = await this._client.channelPoints.updateRedemptionStatusByIds(this[common_1.rawDataSymbol].broadcaster_id, this[common_1.rawDataSymbol].reward.id, [this[common_1.rawDataSymbol].id], newStatus);
+        return result[0];
+    }
 };
@@ -127,0 +136,0 @@ tslib_1.__decorate([

lib/api/helix/extensions/HelixExtensionsApi.d.ts

 import { BaseApi } from '../../BaseApi';
+import type { HelixChannelReferenceData } from '../channel/HelixChannelReference';
 import { HelixChannelReference } from '../channel/HelixChannelReference';
@@ -54,2 +55,8 @@ import { HelixPaginatedRequest } from '../HelixPaginatedRequest';
     /**
+     * Creates a paginator for channels that are currently live and have the given extension installed.
+     *
+     * @param extensionId The ID of the extension.
+     */
+    getLiveChannelsWithExtensionPaginated(extensionId: string): HelixPaginatedRequest<HelixChannelReferenceData, HelixChannelReference>;
+    /**
      * Retrieves an extension's Bits products.
@@ -56,0 +63,0 @@ *

lib/api/helix/extensions/HelixExtensionsApi.js

@@ -63,2 +63,15 @@ "use strict";
     /**
+     * Creates a paginator for channels that are currently live and have the given extension installed.
+     *
+     * @param extensionId The ID of the extension.
+     */
+    getLiveChannelsWithExtensionPaginated(extensionId) {
+        return new HelixPaginatedRequest_1.HelixPaginatedRequest({
+            url: 'extensions/live',
+            query: {
+                extension_id: extensionId
+            }
+        }, this._client, data => new HelixChannelReference_1.HelixChannelReference(data, this._client));
+    }
+    /**
      * Retrieves an extension's Bits products.
@@ -65,0 +78,0 @@ *

lib/index.d.ts

@@ -25,2 +25,3 @@ export { ApiClient } from './ApiClient';
 export { HelixChannelEditor } from './api/helix/channel/HelixChannelEditor';
+export { HelixChannelReference } from './api/helix/channel/HelixChannelReference';
 export { HelixChannelPointsApi } from './api/helix/channelPoints/HelixChannelPointsApi';
@@ -49,2 +50,6 @@ export type { HelixCreateCustomRewardData, HelixUpdateCustomRewardData, HelixCustomRewardRedemptionFilter, HelixPaginatedCustomRewardRedemptionFilter } from './api/helix/channelPoints/HelixChannelPointsApi';
 export type { HelixExtensionTransactionsFilter, HelixExtensionTransactionsPaginatedFilter } from './api/helix/extensions/HelixExtensionsApi';
+export { HelixExtension } from './api/helix/extensions/HelixExtension';
+export type { HelixExtensionSubscriptionsSupportLevel, HelixExtensionState, HelixExtensionIconSize, HelixExtensionConfigurationLocation } from './api/helix/extensions/HelixExtension';
+export { HelixExtensionBitsProduct } from './api/helix/extensions/HelixExtensionBitsProduct';
+export type { HelixExtensionBitsProductUpdatePayload } from './api/helix/extensions/HelixExtensionBitsProduct';
 export { HelixExtensionTransaction } from './api/helix/extensions/HelixExtensionTransaction';
@@ -51,0 +56,0 @@ export type { HelixExtensionTransactionData } from './api/helix/extensions/HelixExtensionTransaction';

lib/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.HelixSchedule = exports.HelixScheduleApi = exports.HelixUserRelation = exports.HelixPredictor = exports.HelixPredictionOutcome = exports.HelixPrediction = exports.HelixPredictionApi = exports.HelixPollChoice = exports.HelixPoll = exports.HelixPollApi = exports.HelixModeratorEvent = exports.HelixModerator = exports.HelixBanEvent = exports.HelixBan = exports.HelixModerationApi = exports.HelixHypeTrainEvent = exports.HelixHypeTrainContribution = exports.HelixHypeTrainApi = exports.HelixGame = exports.HelixGameApi = exports.HelixExtensionTransaction = exports.HelixExtensionsApi = exports.HelixEventSubSubscription = exports.HelixEventSubApi = exports.HelixClip = exports.HelixClipApi = exports.HelixEmoteFromSet = exports.HelixChannelEmote = exports.HelixEmote = exports.HelixChatBadgeVersion = exports.HelixChatBadgeSet = exports.HelixChatApi = exports.HelixCustomRewardRedemption = exports.HelixCustomReward = exports.HelixChannelPointsApi = exports.HelixChannelEditor = exports.HelixChannel = exports.HelixChannelApi = exports.HelixCheermoteList = exports.HelixBitsLeaderboardEntry = exports.HelixBitsLeaderboard = exports.HelixBitsApi = exports.HelixPaginatedRequestWithTotal = exports.HelixPaginatedRequest = exports.HelixApiGroup = exports.ChatBadgeVersion = exports.ChatBadgeSet = exports.ChatBadgeList = exports.BadgesApi = exports.ApiClient = void 0;
-exports.HellFreezesOverError = exports.extractUserName = exports.extractUserId = exports.ChatEmote = exports.StreamNotLiveError = exports.NoSubscriptionProgramError = exports.ConfigError = exports.ChattersList = exports.UnsupportedApi = exports.HelixVideo = exports.HelixVideoApi = exports.HelixUserExtension = exports.HelixInstalledExtensionList = exports.HelixInstalledExtension = exports.HelixBaseExtension = exports.HelixUser = exports.HelixPrivilegedUser = exports.HelixFollow = exports.HelixUserBlock = exports.HelixUserApi = exports.HelixTeamWithUsers = exports.HelixTeam = exports.HelixTeamApi = exports.HelixTag = exports.HelixTagApi = exports.HelixSubscriptionEvent = exports.HelixSubscription = exports.HelixSubscriptionApi = exports.HelixStreamMarkerWithVideo = exports.HelixStreamMarker = exports.HelixStream = exports.HelixStreamApi = exports.HelixChannelSearchResult = exports.HelixSearchApi = exports.HelixPaginatedScheduleSegmentRequest = exports.HelixScheduleSegment = void 0;
+exports.HelixPredictor = exports.HelixPredictionOutcome = exports.HelixPrediction = exports.HelixPredictionApi = exports.HelixPollChoice = exports.HelixPoll = exports.HelixPollApi = exports.HelixModeratorEvent = exports.HelixModerator = exports.HelixBanEvent = exports.HelixBan = exports.HelixModerationApi = exports.HelixHypeTrainEvent = exports.HelixHypeTrainContribution = exports.HelixHypeTrainApi = exports.HelixGame = exports.HelixGameApi = exports.HelixExtensionTransaction = exports.HelixExtensionBitsProduct = exports.HelixExtension = exports.HelixExtensionsApi = exports.HelixEventSubSubscription = exports.HelixEventSubApi = exports.HelixClip = exports.HelixClipApi = exports.HelixEmoteFromSet = exports.HelixChannelEmote = exports.HelixEmote = exports.HelixChatBadgeVersion = exports.HelixChatBadgeSet = exports.HelixChatApi = exports.HelixCustomRewardRedemption = exports.HelixCustomReward = exports.HelixChannelPointsApi = exports.HelixChannelReference = exports.HelixChannelEditor = exports.HelixChannel = exports.HelixChannelApi = exports.HelixCheermoteList = exports.HelixBitsLeaderboardEntry = exports.HelixBitsLeaderboard = exports.HelixBitsApi = exports.HelixPaginatedRequestWithTotal = exports.HelixPaginatedRequest = exports.HelixApiGroup = exports.ChatBadgeVersion = exports.ChatBadgeSet = exports.ChatBadgeList = exports.BadgesApi = exports.ApiClient = void 0;
+exports.HellFreezesOverError = exports.extractUserName = exports.extractUserId = exports.ChatEmote = exports.StreamNotLiveError = exports.NoSubscriptionProgramError = exports.ConfigError = exports.ChattersList = exports.UnsupportedApi = exports.HelixVideo = exports.HelixVideoApi = exports.HelixUserExtension = exports.HelixInstalledExtensionList = exports.HelixInstalledExtension = exports.HelixBaseExtension = exports.HelixUser = exports.HelixPrivilegedUser = exports.HelixFollow = exports.HelixUserBlock = exports.HelixUserApi = exports.HelixTeamWithUsers = exports.HelixTeam = exports.HelixTeamApi = exports.HelixTag = exports.HelixTagApi = exports.HelixSubscriptionEvent = exports.HelixSubscription = exports.HelixSubscriptionApi = exports.HelixStreamMarkerWithVideo = exports.HelixStreamMarker = exports.HelixStream = exports.HelixStreamApi = exports.HelixChannelSearchResult = exports.HelixSearchApi = exports.HelixPaginatedScheduleSegmentRequest = exports.HelixScheduleSegment = exports.HelixSchedule = exports.HelixScheduleApi = exports.HelixUserRelation = void 0;
 var ApiClient_1 = require("./ApiClient");
@@ -35,2 +35,4 @@ Object.defineProperty(exports, "ApiClient", { enumerable: true, get: function () { return ApiClient_1.ApiClient; } });
 Object.defineProperty(exports, "HelixChannelEditor", { enumerable: true, get: function () { return HelixChannelEditor_1.HelixChannelEditor; } });
+var HelixChannelReference_1 = require("./api/helix/channel/HelixChannelReference");
+Object.defineProperty(exports, "HelixChannelReference", { enumerable: true, get: function () { return HelixChannelReference_1.HelixChannelReference; } });
 var HelixChannelPointsApi_1 = require("./api/helix/channelPoints/HelixChannelPointsApi");
@@ -64,2 +66,6 @@ Object.defineProperty(exports, "HelixChannelPointsApi", { enumerable: true, get: function () { return HelixChannelPointsApi_1.HelixChannelPointsApi; } });
 Object.defineProperty(exports, "HelixExtensionsApi", { enumerable: true, get: function () { return HelixExtensionsApi_1.HelixExtensionsApi; } });
+var HelixExtension_1 = require("./api/helix/extensions/HelixExtension");
+Object.defineProperty(exports, "HelixExtension", { enumerable: true, get: function () { return HelixExtension_1.HelixExtension; } });
+var HelixExtensionBitsProduct_1 = require("./api/helix/extensions/HelixExtensionBitsProduct");
+Object.defineProperty(exports, "HelixExtensionBitsProduct", { enumerable: true, get: function () { return HelixExtensionBitsProduct_1.HelixExtensionBitsProduct; } });
 var HelixExtensionTransaction_1 = require("./api/helix/extensions/HelixExtensionTransaction");
@@ -66,0 +72,0 @@ Object.defineProperty(exports, "HelixExtensionTransaction", { enumerable: true, get: function () { return HelixExtensionTransaction_1.HelixExtensionTransaction; } });

package.json

 {
   "name": "@twurple/api",
-  "version": "5.0.0-pre.17",
+  "version": "5.0.0",
   "publishConfig": {
@@ -39,8 +39,8 @@ "access": "public"
     "@d-fischer/shared-utils": "^3.2.0",
-    "@twurple/api-call": "^5.0.0-pre.17",
-    "@twurple/common": "^5.0.0-pre.17",
+    "@twurple/api-call": "^5.0.0",
+    "@twurple/common": "^5.0.0",
     "tslib": "^2.0.3"
   },
   "devDependencies": {
-    "@twurple/auth": "^5.0.0-pre.17"
+    "@twurple/auth": "^5.0.0"
   },
@@ -61,3 +61,3 @@ "peerDependencies": {
   },
-  "gitHead": "520bef27d5081f0ec476f1c95ac60efd27797973"
+  "gitHead": "a065317718bd71dc39557a8624c9d90cceaf371d"
 }

README.md

@@ -1,5 +0,1 @@
-# ⚠ WARNING
-
-This is a future version still in development. For a stable version, check out [the `twitch` package](https://www.npmjs.com/package/twitch).
-
 # Twurple - API
@@ -28,2 +24,2 @@
 
-You can join the [Discord server](https://discord.gg/b9ZqMfz) for support.
+You can join the [Twitch API Libraries Discord Server](https://discord.gg/b9ZqMfz) and ask in `#twurple` for support.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

802601

increased by0.49%

Lines of code

23256

increased by0.31%

Number of low quality alerts

0

decreased by-100%

Worsened metrics

Number of lines in readme file

25

decreased by-13.79%

Dependency changes

• Updated@twurple/api-call@^5.0.0

• Updated@twurple/common@^5.0.0