@twurple/api - npm Package Compare versions

Comparing version 7.0.2 to 7.0.3

lib/client/BaseApiClient.d.ts

@@ -14,2 +14,3 @@ import { type Response } from '@d-fischer/cross-fetch';
 import { HelixClipApi } from '../endpoints/clip/HelixClipApi';
+import { HelixContentClassificationLabelApi } from '../endpoints/contentClassificationLabels/HelixContentClassificationLabelApi';
 import { HelixEntitlementApi } from '../endpoints/entitlements/HelixEntitlementApi';
@@ -84,2 +85,6 @@ import { HelixEventSubApi } from '../endpoints/eventSub/HelixEventSubApi';
     /**
+     * The Helix content classification label API methods.
+     */
+    get contentClassificationLabels(): HelixContentClassificationLabelApi;
+    /**
      * The Helix entitlement API methods.
@@ -86,0 +91,0 @@ */

lib/client/BaseApiClient.js

@@ -19,2 +19,3 @@ "use strict";
 const HelixClipApi_1 = require("../endpoints/clip/HelixClipApi");
+const HelixContentClassificationLabelApi_1 = require("../endpoints/contentClassificationLabels/HelixContentClassificationLabelApi");
 const HelixEntitlementApi_1 = require("../endpoints/entitlements/HelixEntitlementApi");
@@ -171,2 +172,8 @@ const HelixEventSubApi_1 = require("../endpoints/eventSub/HelixEventSubApi");
     /**
+     * The Helix content classification label API methods.
+     */
+    get contentClassificationLabels() {
+        return new HelixContentClassificationLabelApi_1.HelixContentClassificationLabelApi(this);
+    }
+    /**
      * The Helix entitlement API methods.
@@ -388,2 +395,5 @@ */
     (0, cache_decorators_1.CachedGetter)()
+], BaseApiClient.prototype, "contentClassificationLabels", null);
+tslib_1.__decorate([
+    (0, cache_decorators_1.CachedGetter)()
 ], BaseApiClient.prototype, "entitlements", null);
@@ -390,0 +400,0 @@ tslib_1.__decorate([

lib/endpoints/channel/HelixChannel.d.ts

@@ -55,3 +55,11 @@ import { DataObject } from '@twurple/common';
     get tags(): string[];
+    /**
+     * The content classification labels applied to the channel.
+     */
+    get contentClassificationLabels(): string[];
+    /**
+     * Whether the channel currently displays branded content (as specified by the broadcaster).
+     */
+    get isBrandedContent(): boolean;
 }
 //# sourceMappingURL=HelixChannel.d.ts.map

lib/endpoints/channel/HelixChannel.js

@@ -86,2 +86,14 @@ "use strict";
     }
+    /**
+     * The content classification labels applied to the channel.
+     */
+    get contentClassificationLabels() {
+        return this[common_1.rawDataSymbol].content_classification_labels;
+    }
+    /**
+     * Whether the channel currently displays branded content (as specified by the broadcaster).
+     */
+    get isBrandedContent() {
+        return this[common_1.rawDataSymbol].is_branded_content;
+    }
 };
@@ -88,0 +100,0 @@ tslib_1.__decorate([

lib/endpoints/clip/HelixClip.d.ts

@@ -6,2 +6,5 @@ import { DataObject } from '@twurple/common';
 import type { HelixVideo } from '../video/HelixVideo';
+/**
+ * A clip from a Twitch stream.
+ */
 export declare class HelixClip extends DataObject<HelixClipData> {
@@ -91,3 +94,7 @@ /**
     get vodOffset(): number | null;
+    /**
+     * Whether the clip is featured.
+     */
+    get isFeatured(): boolean;
 }
 //# sourceMappingURL=HelixClip.d.ts.map

lib/endpoints/clip/HelixClip.js

@@ -7,2 +7,5 @@ "use strict";
 const common_1 = require("@twurple/common");
+/**
+ * A clip from a Twitch stream.
+ */
 let HelixClip = class HelixClip extends common_1.DataObject {
@@ -139,2 +142,8 @@ /** @internal */
     }
+    /**
+     * Whether the clip is featured.
+     */
+    get isFeatured() {
+        return this[common_1.rawDataSymbol].is_featured;
+    }
 };
@@ -141,0 +150,0 @@ tslib_1.__decorate([

lib/index.d.ts

@@ -39,2 +39,4 @@ export { ApiClient } from './client/ApiClient';
 export type { HelixPaginatedClipFilter, HelixClipFilter, HelixClipCreateParams } from './interfaces/endpoints/clip.input';
+export { HelixContentClassificationLabelApi } from './endpoints/contentClassificationLabels/HelixContentClassificationLabelApi';
+export { HelixContentClassificationLabel } from './endpoints/contentClassificationLabels/HelixContentClassificationLabel';
 export { HelixEntitlementApi } from './endpoints/entitlements/HelixEntitlementApi';
@@ -41,0 +43,0 @@ export { HelixDropsEntitlement } from './endpoints/entitlements/HelixDropsEntitlement';

lib/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.HelixShieldModeStatus = exports.HelixBlockedTerm = exports.HelixBanUser = exports.HelixModerator = exports.HelixBan = exports.HelixModerationApi = exports.HelixHypeTrainEvent = exports.HelixHypeTrainContribution = exports.HelixHypeTrainApi = exports.HelixGoal = exports.HelixGoalApi = exports.HelixGame = exports.HelixGameApi = exports.HelixExtensionTransaction = exports.HelixExtensionBitsProduct = exports.HelixExtensionsApi = exports.HelixPaginatedEventSubSubscriptionsRequest = exports.HelixEventSubSubscription = exports.HelixEventSubApi = exports.HelixDropsEntitlement = exports.HelixEntitlementApi = exports.HelixClip = exports.HelixClipApi = exports.HelixPrivilegedChatSettings = exports.HelixEmoteFromSet = exports.HelixChannelEmote = exports.HelixEmote = exports.HelixChatChatter = exports.HelixChatSettings = exports.HelixChatBadgeVersion = exports.HelixChatBadgeSet = exports.HelixChatApi = exports.HelixCharityCampaignAmount = exports.HelixCharityCampaignDonation = exports.HelixCharityCampaign = exports.HelixCharityApi = exports.HelixCustomRewardRedemption = exports.HelixCustomReward = exports.HelixChannelPointsApi = exports.HelixChannelReference = exports.HelixFollowedChannel = exports.HelixChannelFollower = exports.HelixChannelEditor = exports.HelixChannel = exports.HelixChannelApi = exports.HelixCheermoteList = exports.HelixBitsLeaderboardEntry = exports.HelixBitsLeaderboard = exports.HelixBitsApi = exports.ApiClient = void 0;
-exports.HellFreezesOverError = exports.HelixExtension = exports.extractUserName = exports.extractUserId = exports.HelixPaginatedRequestWithTotal = exports.HelixPaginatedRequest = exports.ApiReportedRequest = exports.StreamNotLiveError = exports.ConfigError = exports.HelixWhisperApi = 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.HelixUserSubscription = exports.HelixSubscription = exports.HelixSubscriptionApi = exports.HelixPaginatedSubscriptionsRequest = exports.HelixStreamMarkerWithVideo = exports.HelixStreamMarker = exports.HelixStream = exports.HelixStreamApi = exports.HelixChannelSearchResult = exports.HelixSearchApi = exports.HelixPaginatedScheduleSegmentRequest = exports.HelixScheduleSegment = exports.HelixSchedule = exports.HelixScheduleApi = exports.HelixUserRelation = exports.HelixRaid = exports.HelixRaidApi = exports.HelixPredictor = exports.HelixPredictionOutcome = exports.HelixPrediction = exports.HelixPredictionApi = exports.HelixPollChoice = exports.HelixPoll = exports.HelixPollApi = void 0;
+exports.HelixBanUser = exports.HelixModerator = exports.HelixBan = exports.HelixModerationApi = exports.HelixHypeTrainEvent = exports.HelixHypeTrainContribution = exports.HelixHypeTrainApi = exports.HelixGoal = exports.HelixGoalApi = exports.HelixGame = exports.HelixGameApi = exports.HelixExtensionTransaction = exports.HelixExtensionBitsProduct = exports.HelixExtensionsApi = exports.HelixPaginatedEventSubSubscriptionsRequest = exports.HelixEventSubSubscription = exports.HelixEventSubApi = exports.HelixDropsEntitlement = exports.HelixEntitlementApi = exports.HelixContentClassificationLabel = exports.HelixContentClassificationLabelApi = exports.HelixClip = exports.HelixClipApi = exports.HelixPrivilegedChatSettings = exports.HelixEmoteFromSet = exports.HelixChannelEmote = exports.HelixEmote = exports.HelixChatChatter = exports.HelixChatSettings = exports.HelixChatBadgeVersion = exports.HelixChatBadgeSet = exports.HelixChatApi = exports.HelixCharityCampaignAmount = exports.HelixCharityCampaignDonation = exports.HelixCharityCampaign = exports.HelixCharityApi = exports.HelixCustomRewardRedemption = exports.HelixCustomReward = exports.HelixChannelPointsApi = exports.HelixChannelReference = exports.HelixFollowedChannel = exports.HelixChannelFollower = exports.HelixChannelEditor = exports.HelixChannel = exports.HelixChannelApi = exports.HelixCheermoteList = exports.HelixBitsLeaderboardEntry = exports.HelixBitsLeaderboard = exports.HelixBitsApi = exports.ApiClient = void 0;
+exports.HellFreezesOverError = exports.HelixExtension = exports.extractUserName = exports.extractUserId = exports.HelixPaginatedRequestWithTotal = exports.HelixPaginatedRequest = exports.ApiReportedRequest = exports.StreamNotLiveError = exports.ConfigError = exports.HelixWhisperApi = 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.HelixUserSubscription = exports.HelixSubscription = exports.HelixSubscriptionApi = exports.HelixPaginatedSubscriptionsRequest = exports.HelixStreamMarkerWithVideo = exports.HelixStreamMarker = exports.HelixStream = exports.HelixStreamApi = exports.HelixChannelSearchResult = exports.HelixSearchApi = exports.HelixPaginatedScheduleSegmentRequest = exports.HelixScheduleSegment = exports.HelixSchedule = exports.HelixScheduleApi = exports.HelixUserRelation = exports.HelixRaid = exports.HelixRaidApi = exports.HelixPredictor = exports.HelixPredictionOutcome = exports.HelixPrediction = exports.HelixPredictionApi = exports.HelixPollChoice = exports.HelixPoll = exports.HelixPollApi = exports.HelixShieldModeStatus = exports.HelixBlockedTerm = void 0;
 var ApiClient_1 = require("./client/ApiClient");
@@ -63,2 +63,6 @@ Object.defineProperty(exports, "ApiClient", { enumerable: true, get: function () { return ApiClient_1.ApiClient; } });
 Object.defineProperty(exports, "HelixClip", { enumerable: true, get: function () { return HelixClip_1.HelixClip; } });
+var HelixContentClassificationLabelApi_1 = require("./endpoints/contentClassificationLabels/HelixContentClassificationLabelApi");
+Object.defineProperty(exports, "HelixContentClassificationLabelApi", { enumerable: true, get: function () { return HelixContentClassificationLabelApi_1.HelixContentClassificationLabelApi; } });
+var HelixContentClassificationLabel_1 = require("./endpoints/contentClassificationLabels/HelixContentClassificationLabel");
+Object.defineProperty(exports, "HelixContentClassificationLabel", { enumerable: true, get: function () { return HelixContentClassificationLabel_1.HelixContentClassificationLabel; } });
 var HelixEntitlementApi_1 = require("./endpoints/entitlements/HelixEntitlementApi");
@@ -65,0 +69,0 @@ Object.defineProperty(exports, "HelixEntitlementApi", { enumerable: true, get: function () { return HelixEntitlementApi_1.HelixEntitlementApi; } });

lib/interfaces/endpoints/channel.external.d.ts

@@ -12,2 +12,4 @@ /** @private */
     tags: string[];
+    content_classification_labels: string[];
+    is_branded_content: boolean;
 }
@@ -14,0 +16,0 @@ /** @private */

lib/interfaces/endpoints/channel.external.js

@@ -14,3 +14,5 @@ "use strict";
         delay: (_a = data.delay) === null || _a === void 0 ? void 0 : _a.toString(),
-        tags: data.tags
+        tags: data.tags,
+        content_classification_labels: data.contentClassificationLabels,
+        is_branded_content: data.isBrandedContent
     };
@@ -17,0 +19,0 @@ }

lib/interfaces/endpoints/channel.input.d.ts

@@ -30,3 +30,11 @@ /**
     tags?: string[];
+    /**
+     * The content classification labels to apply to the channel.
+     */
+    contentClassificationLabels?: string[];
+    /**
+     * Whether the channel currently displays branded content.
+     */
+    isBrandedContent?: boolean;
 }
 //# sourceMappingURL=channel.input.d.ts.map

lib/interfaces/endpoints/clip.external.d.ts

@@ -19,2 +19,3 @@ /** @private */
     vod_offset: number | null;
+    is_featured: boolean;
 }
@@ -21,0 +22,0 @@ /** @private */

lib/interfaces/endpoints/clip.external.js

@@ -15,9 +15,10 @@ "use strict";
 function createClipQuery(params) {
-    const { filterType, ids, startDate, endDate } = params;
+    const { filterType, ids, startDate, endDate, isFeatured } = params;
     return {
         [filterType]: ids,
         started_at: startDate,
-        ended_at: endDate
+        ended_at: endDate,
+        is_featured: isFeatured === null || isFeatured === void 0 ? void 0 : isFeatured.toString()
     };
 }
 exports.createClipQuery = createClipQuery;

lib/interfaces/endpoints/clip.input.d.ts

@@ -16,2 +16,8 @@ import { type UserIdResolvable } from '@twurple/common';
     endDate?: string;
+    /**
+     * The featured flag the results should have.
+     *
+     * If not given, both featured and non-featured clips will be returned.
+     */
+    isFeatured?: boolean;
 }
@@ -18,0 +24,0 @@ /**

package.json

 {
   "name": "@twurple/api",
-  "version": "7.0.2",
+  "version": "7.0.3",
   "publishConfig": {
@@ -43,4 +43,4 @@ "access": "public"
     "@d-fischer/typed-event-emitter": "^3.3.1",
-    "@twurple/api-call": "7.0.2",
-    "@twurple/common": "7.0.2",
+    "@twurple/api-call": "7.0.3",
+    "@twurple/common": "7.0.3",
     "retry": "^0.13.1",
@@ -50,7 +50,7 @@ "tslib": "^2.0.3"
   "devDependencies": {
-    "@twurple/auth": "7.0.2",
+    "@twurple/auth": "7.0.3",
     "@types/retry": "^0.12.2"
   },
   "peerDependencies": {
-    "@twurple/auth": "7.0.2"
+    "@twurple/auth": "7.0.3"
   },
@@ -57,0 +57,0 @@ "files": [

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

Improved metrics

Total package byte prevSize

1078956

increased by1.05%

Number of package files

477

increased by1.92%

Lines of code

29093

increased by1.03%

Dependency changes

• + Added@twurple/api-call@7.0.3(transitive)

• + Added@twurple/auth@7.0.3(transitive)

• + Added@twurple/common@7.0.3(transitive)

• - Removed@twurple/api-call@7.0.2(transitive)

• - Removed@twurple/auth@7.0.2(transitive)

• - Removed@twurple/common@7.0.2(transitive)

• Updated@twurple/api-call@7.0.3

• Updated@twurple/common@7.0.3