@scoreboardmax/api-types 1.0.48 → 1.0.50

package/dist/index.cjs

@@ -7,7 +7,7 @@
  *
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ErrorCode = exports.WrestlingStyle = exports.WrestlingPeriod = exports.WrestlingOvertimeType = exports.WrestlingMeetType = exports.WebsocketOperation = exports.MetaMessageType = exports.WebsocketMessageType = exports.VolleyballSet = exports.isWrestlingData = exports.isVolleyballData = exports.isSoccerData = exports.isFootballData = exports.isBasketballData = exports.isBaseballData = exports.BaseballInningSegment = exports.TemplateUseCase = exports.ScoreboardType = exports.SoccerGamePeriods = exports.SoccerPeriod = exports.SoccerPenaltyCardType = exports.ScoreboardCode = exports.OAuthProvider = exports.OAuthAction = exports.MagicLinkType = exports.FootballPeriod = exports.TalkingPointFocus = exports.FileType = exports.ContentType = exports.ExtraTimeLabel = exports.EventAction = exports.TalkingPointEnergy = exports.DownAndDistanceDisplay = exports.DisplayConnectionStatus = exports.ClockType = exports.BasketballTimeoutAllocation = exports.BasketballGamePeriods = exports.BasketballPeriod = exports.PlanId = exports.AuthType = exports.AppType = exports.ApiResource = exports.ApiAction = void 0;
+exports.ErrorCode = exports.WrestlingStyle = exports.WrestlingPeriod = exports.WrestlingOvertimeType = exports.WrestlingMeetType = exports.WebsocketOperation = exports.MetaMessageType = exports.WebsocketMessageType = exports.VolleyballSet = exports.isWrestlingData = exports.isVolleyballData = exports.isSoccerData = exports.isFootballData = exports.isBasketballData = exports.isBaseballData = exports.BaseballInningSegment = exports.TemplateUseCase = exports.ScoreboardType = exports.SoccerGamePeriods = exports.SoccerPeriod = exports.SoccerPenaltyCardType = exports.ScoreboardCode = exports.OAuthProvider = exports.OAuthAction = exports.MagicLinkType = exports.FootballPeriod = exports.TalkingPointFocus = exports.FileType = exports.ContentType = exports.ExtraTimeLabel = exports.EventAction = exports.AppEntitlementRequirement = exports.TalkingPointEnergy = exports.DownAndDistanceDisplay = exports.DisplayConnectionStatus = exports.ClockType = exports.BasketballTimeoutAllocation = exports.BasketballGamePeriods = exports.BasketballPeriod = exports.PlanId = exports.AuthType = exports.AppType = exports.AppEntitlementType = exports.AppEntitlementGrantedBy = exports.ApiResource = exports.ApiAction = void 0;
 /**
  * API action identifiers
  */
@@ -62,7 +62,25 @@ var ApiResource;
     ApiResource["PresetList"] = "presetList";
     ApiResource["Game"] = "game";
     ApiResource["GameList"] = "gameList";
+    ApiResource["Template"] = "template";
+    ApiResource["TemplateList"] = "templateList";
 })(ApiResource || (exports.ApiResource = ApiResource = {}));
+/**
+ * App entitlement grant source
+ */
+var AppEntitlementGrantedBy;
+(function (AppEntitlementGrantedBy) {
+    AppEntitlementGrantedBy["Payment"] = "payment";
+    AppEntitlementGrantedBy["Promotion"] = "promotion";
+    AppEntitlementGrantedBy["Admin"] = "admin";
+})(AppEntitlementGrantedBy || (exports.AppEntitlementGrantedBy = AppEntitlementGrantedBy = {}));
+/**
+ * App entitlement type
+ */
+var AppEntitlementType;
+(function (AppEntitlementType) {
+    AppEntitlementType["Template"] = "template";
+})(AppEntitlementType || (exports.AppEntitlementType = AppEntitlementType = {}));
 /**
  * App type identifiers
  */
@@ -157,6 +175,15 @@ var TalkingPointEnergy;
     TalkingPointEnergy["Standard"] = "standard";
     TalkingPointEnergy["Hype"] = "hype";
 })(TalkingPointEnergy || (exports.TalkingPointEnergy = TalkingPointEnergy = {}));
+/**
+ * Entitlement requirement for access control
+ */
+var AppEntitlementRequirement;
+(function (AppEntitlementRequirement) {
+    AppEntitlementRequirement["None"] = "none";
+    AppEntitlementRequirement["AccountSubscription"] = "accountSubscription";
+    AppEntitlementRequirement["Payment"] = "payment";
+})(AppEntitlementRequirement || (exports.AppEntitlementRequirement = AppEntitlementRequirement = {}));
 /**
  * Event action identifiers
  */

package/dist/index.d.ts

@@ -91,7 +91,9 @@ export declare enum ApiResource {
     Preset = "preset",
     PresetList = "presetList",
     Game = "game",
-    GameList = "gameList"
+    GameList = "gameList",
+    Template = "template",
+    TemplateList = "templateList"
 }
 /**
  * App creation/update request
@@ -115,6 +117,38 @@ export interface AppResponse {
     accountId: string;
     dateCreated: string;
 }
+/**
+ * App entitlement details response
+ */
+export interface AppEntitlementResponse {
+    object: string;
+    url: string;
+    uri: string;
+    accountId: string;
+    appEntitlementId: string;
+    type: AppEntitlementType;
+    appId: string;
+    key: string;
+    grantedBy: AppEntitlementGrantedBy;
+    grantedAt: string;
+    dateExpires?: string;
+    dateCreated: string;
+    dateModified: string;
+}
+/**
+ * App entitlement grant source
+ */
+export declare enum AppEntitlementGrantedBy {
+    Payment = "payment",
+    Promotion = "promotion",
+    Admin = "admin"
+}
+/**
+ * App entitlement type
+ */
+export declare enum AppEntitlementType {
+    Template = "template"
+}
 /**
  * App input field definition
  */
@@ -716,6 +750,14 @@ export declare enum TalkingPointEnergy {
     Standard = "standard",
     Hype = "hype"
 }
+/**
+ * Entitlement requirement for access control
+ */
+export declare enum AppEntitlementRequirement {
+    None = "none",
+    AccountSubscription = "accountSubscription",
+    Payment = "payment"
+}
 /**
  * Event action identifiers
  */
@@ -1063,6 +1105,15 @@ export interface ScoreboardActivationListResponse {
     pageNext: string | null;
     data: ScoreboardActivationResponse[];
 }
+/**
+ * Paginated list of app entitlements
+ */
+export interface AppEntitlementListResponse {
+    url: string;
+    uri: string;
+    pageNext: string | null;
+    data: AppEntitlementResponse[];
+}
 /**
  * Paginated list of apps
  */
@@ -1160,6 +1211,15 @@ export interface TeamListResponse {
     pageNext: string | null;
     data: TeamResponse[];
 }
+/**
+ * Paginated list of templates
+ */
+export interface TemplateListResponse {
+    url: string;
+    uri: string;
+    pageNext: string | null;
+    data: TemplateResponse[];
+}
 /**
  * Paginated list of users
  */
@@ -1381,7 +1441,6 @@ export interface ScoreboardRequest {
     type: ScoreboardType;
     version: number;
     data: BasketballDataRequest | FootballDataRequest | VolleyballDataRequest | SoccerDataRequest | BaseballDataRequest | WrestlingDataRequest;
-    templates?: TemplateSelection[];
 }
 /**
  * Scoreboard details response
@@ -1719,27 +1778,69 @@ export interface TeamResponse {
     dateCreated: string;
     dateModified: string;
 }
+/**
+ * Template details response
+ */
+export interface TemplateResponse {
+    object: string;
+    url: string;
+    uri: string;
+    appId: string;
+    key: string;
+    version: string;
+    path: string;
+    name: string;
+    scoreboardType: string;
+    useCases: TemplateUseCase[];
+    description?: string;
+    previewImageUrls?: string[];
+    settings?: Record<string, InputDefinition>;
+    accountId: string;
+    latest: boolean;
+    published: boolean;
+    appEntitlementRequirement: AppEntitlementRequirement;
+    entitled?: boolean;
+    dateCreated: string;
+    dateModified: string;
+}
 /**
  * Template layout definition
  */
 export interface TemplateDefinition {
+    key: string;
     path: string;
     name: string;
     scoreboardType: string;
     useCases: TemplateUseCase[];
-    thumbnail?: string;
+    description?: string;
+    previewImages?: string[];
     settings?: Record<string, InputDefinition>;
 }
 /**
  * Template selection configuration
  */
 export interface TemplateSelection {
-    path: string;
+    key: string;
     appId: string;
     useCase: TemplateUseCase;
     version?: string;
     settings?: Record<string, string | number | boolean | null>;
 }
+/**
+ * Template selection request for updating scoreboard templates
+ */
+export interface TemplateSelectionRequest extends TemplateSelection {
+}
+/**
+ * Template selection response for scoreboard template updates
+ */
+export interface TemplateSelectionResponse extends TemplateSelection {
+}
+/**
+ * Template update request
+ */
+export interface TemplateRequest {
+}
 /**
  * Template use case categories
  */

package/dist/index.mjs

@@ -59,7 +59,25 @@ export var ApiResource;
     ApiResource["PresetList"] = "presetList";
     ApiResource["Game"] = "game";
     ApiResource["GameList"] = "gameList";
+    ApiResource["Template"] = "template";
+    ApiResource["TemplateList"] = "templateList";
 })(ApiResource || (ApiResource = {}));
+/**
+ * App entitlement grant source
+ */
+export var AppEntitlementGrantedBy;
+(function (AppEntitlementGrantedBy) {
+    AppEntitlementGrantedBy["Payment"] = "payment";
+    AppEntitlementGrantedBy["Promotion"] = "promotion";
+    AppEntitlementGrantedBy["Admin"] = "admin";
+})(AppEntitlementGrantedBy || (AppEntitlementGrantedBy = {}));
+/**
+ * App entitlement type
+ */
+export var AppEntitlementType;
+(function (AppEntitlementType) {
+    AppEntitlementType["Template"] = "template";
+})(AppEntitlementType || (AppEntitlementType = {}));
 /**
  * App type identifiers
  */
@@ -154,6 +172,15 @@ export var TalkingPointEnergy;
     TalkingPointEnergy["Standard"] = "standard";
     TalkingPointEnergy["Hype"] = "hype";
 })(TalkingPointEnergy || (TalkingPointEnergy = {}));
+/**
+ * Entitlement requirement for access control
+ */
+export var AppEntitlementRequirement;
+(function (AppEntitlementRequirement) {
+    AppEntitlementRequirement["None"] = "none";
+    AppEntitlementRequirement["AccountSubscription"] = "accountSubscription";
+    AppEntitlementRequirement["Payment"] = "payment";
+})(AppEntitlementRequirement || (AppEntitlementRequirement = {}));
 /**
  * Event action identifiers
  */

package/dist/internal.cjs

@@ -10,7 +10,7 @@
  *
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ErrorCode = exports.WrestlingStyle = exports.WrestlingPeriod = exports.WrestlingOvertimeType = exports.WrestlingMeetType = exports.WebsocketOperation = exports.MetaMessageType = exports.WebsocketMessageType = exports.VolleyballSet = exports.isWrestlingData = exports.isVolleyballData = exports.isSoccerData = exports.isFootballData = exports.isBasketballData = exports.isBaseballData = exports.isUserResponseAdmin = exports.isUserListResponseAdmin = exports.isAuthResponseAdmin = exports.isAccountResponseAdmin = exports.BaseballInningSegment = exports.TemplateUseCase = exports.ScoreboardType = exports.SoccerGamePeriods = exports.SoccerPeriod = exports.SoccerPenaltyCardType = exports.ScoreboardCode = exports.OAuthProvider = exports.OAuthAction = exports.MagicLinkType = exports.FootballPeriod = exports.TalkingPointFocus = exports.FileType = exports.ContentType = exports.ExtraTimeLabel = exports.EventAction = exports.TalkingPointEnergy = exports.DownAndDistanceDisplay = exports.DisplayConnectionStatus = exports.ClockType = exports.BasketballTimeoutAllocation = exports.BasketballGamePeriods = exports.BasketballPeriod = exports.PlanId = exports.AuthType = exports.AppType = exports.ApiResource = exports.ApiAction = void 0;
+exports.ErrorCode = exports.WrestlingStyle = exports.WrestlingPeriod = exports.WrestlingOvertimeType = exports.WrestlingMeetType = exports.WebsocketOperation = exports.MetaMessageType = exports.WebsocketMessageType = exports.VolleyballSet = exports.isWrestlingData = exports.isVolleyballData = exports.isSoccerData = exports.isFootballData = exports.isBasketballData = exports.isBaseballData = exports.isUserResponseAdmin = exports.isUserListResponseAdmin = exports.isAuthResponseAdmin = exports.isAccountResponseAdmin = exports.BaseballInningSegment = exports.TemplateUseCase = exports.ScoreboardType = exports.SoccerGamePeriods = exports.SoccerPeriod = exports.SoccerPenaltyCardType = exports.ScoreboardCode = exports.OAuthProvider = exports.OAuthAction = exports.MagicLinkType = exports.FootballPeriod = exports.TalkingPointFocus = exports.FileType = exports.ContentType = exports.ExtraTimeLabel = exports.EventAction = exports.AppEntitlementRequirement = exports.TalkingPointEnergy = exports.DownAndDistanceDisplay = exports.DisplayConnectionStatus = exports.ClockType = exports.BasketballTimeoutAllocation = exports.BasketballGamePeriods = exports.BasketballPeriod = exports.PlanId = exports.AuthType = exports.AppType = exports.AppEntitlementType = exports.AppEntitlementGrantedBy = exports.ApiResource = exports.ApiAction = void 0;
 /**
  * API action identifiers
  */
@@ -65,7 +65,25 @@ var ApiResource;
     ApiResource["PresetList"] = "presetList";
     ApiResource["Game"] = "game";
     ApiResource["GameList"] = "gameList";
+    ApiResource["Template"] = "template";
+    ApiResource["TemplateList"] = "templateList";
 })(ApiResource || (exports.ApiResource = ApiResource = {}));
+/**
+ * App entitlement grant source
+ */
+var AppEntitlementGrantedBy;
+(function (AppEntitlementGrantedBy) {
+    AppEntitlementGrantedBy["Payment"] = "payment";
+    AppEntitlementGrantedBy["Promotion"] = "promotion";
+    AppEntitlementGrantedBy["Admin"] = "admin";
+})(AppEntitlementGrantedBy || (exports.AppEntitlementGrantedBy = AppEntitlementGrantedBy = {}));
+/**
+ * App entitlement type
+ */
+var AppEntitlementType;
+(function (AppEntitlementType) {
+    AppEntitlementType["Template"] = "template";
+})(AppEntitlementType || (exports.AppEntitlementType = AppEntitlementType = {}));
 /**
  * App type identifiers
  */
@@ -160,6 +178,15 @@ var TalkingPointEnergy;
     TalkingPointEnergy["Standard"] = "standard";
     TalkingPointEnergy["Hype"] = "hype";
 })(TalkingPointEnergy || (exports.TalkingPointEnergy = TalkingPointEnergy = {}));
+/**
+ * Entitlement requirement for access control
+ */
+var AppEntitlementRequirement;
+(function (AppEntitlementRequirement) {
+    AppEntitlementRequirement["None"] = "none";
+    AppEntitlementRequirement["AccountSubscription"] = "accountSubscription";
+    AppEntitlementRequirement["Payment"] = "payment";
+})(AppEntitlementRequirement || (exports.AppEntitlementRequirement = AppEntitlementRequirement = {}));
 /**
  * Event action identifiers
  */

package/dist/internal.d.ts

@@ -101,7 +101,9 @@ export declare enum ApiResource {
     Preset = "preset",
     PresetList = "presetList",
     Game = "game",
-    GameList = "gameList"
+    GameList = "gameList",
+    Template = "template",
+    TemplateList = "templateList"
 }
 /**
  * App creation/update request
@@ -125,6 +127,38 @@ export interface AppResponse {
     accountId: string;
     dateCreated: string;
 }
+/**
+ * App entitlement details response
+ */
+export interface AppEntitlementResponse {
+    object: string;
+    url: string;
+    uri: string;
+    accountId: string;
+    appEntitlementId: string;
+    type: AppEntitlementType;
+    appId: string;
+    key: string;
+    grantedBy: AppEntitlementGrantedBy;
+    grantedAt: string;
+    dateExpires?: string;
+    dateCreated: string;
+    dateModified: string;
+}
+/**
+ * App entitlement grant source
+ */
+export declare enum AppEntitlementGrantedBy {
+    Payment = "payment",
+    Promotion = "promotion",
+    Admin = "admin"
+}
+/**
+ * App entitlement type
+ */
+export declare enum AppEntitlementType {
+    Template = "template"
+}
 /**
  * App input field definition
  */
@@ -739,6 +773,14 @@ export declare enum TalkingPointEnergy {
     Standard = "standard",
     Hype = "hype"
 }
+/**
+ * Entitlement requirement for access control
+ */
+export declare enum AppEntitlementRequirement {
+    None = "none",
+    AccountSubscription = "accountSubscription",
+    Payment = "payment"
+}
 /**
  * Event action identifiers
  */
@@ -1086,6 +1128,15 @@ export interface ScoreboardActivationListResponse {
     pageNext: string | null;
     data: ScoreboardActivationResponse[];
 }
+/**
+ * Paginated list of app entitlements
+ */
+export interface AppEntitlementListResponse {
+    url: string;
+    uri: string;
+    pageNext: string | null;
+    data: AppEntitlementResponse[];
+}
 /**
  * Paginated list of apps
  */
@@ -1183,6 +1234,15 @@ export interface TeamListResponse {
     pageNext: string | null;
     data: TeamResponse[];
 }
+/**
+ * Paginated list of templates
+ */
+export interface TemplateListResponse {
+    url: string;
+    uri: string;
+    pageNext: string | null;
+    data: TemplateResponse[];
+}
 /**
  * Paginated list of users
  */
@@ -1404,7 +1464,6 @@ export interface ScoreboardRequest {
     type: ScoreboardType;
     version: number;
     data: BasketballDataRequest | FootballDataRequest | VolleyballDataRequest | SoccerDataRequest | BaseballDataRequest | WrestlingDataRequest;
-    templates?: TemplateSelection[];
 }
 /**
  * Scoreboard details response
@@ -1742,27 +1801,76 @@ export interface TeamResponse {
     dateCreated: string;
     dateModified: string;
 }
+/**
+ * Template details response
+ */
+export interface TemplateResponse {
+    object: string;
+    url: string;
+    uri: string;
+    appId: string;
+    key: string;
+    version: string;
+    path: string;
+    name: string;
+    scoreboardType: string;
+    useCases: TemplateUseCase[];
+    description?: string;
+    previewImageUrls?: string[];
+    settings?: Record<string, InputDefinition>;
+    accountId: string;
+    latest: boolean;
+    published: boolean;
+    appEntitlementRequirement: AppEntitlementRequirement;
+    entitled?: boolean;
+    dateCreated: string;
+    dateModified: string;
+}
 /**
  * Template layout definition
  */
 export interface TemplateDefinition {
+    key: string;
     path: string;
     name: string;
     scoreboardType: string;
     useCases: TemplateUseCase[];
-    thumbnail?: string;
+    description?: string;
+    previewImages?: string[];
     settings?: Record<string, InputDefinition>;
 }
 /**
  * Template selection configuration
  */
 export interface TemplateSelection {
-    path: string;
+    key: string;
     appId: string;
     useCase: TemplateUseCase;
     version?: string;
     settings?: Record<string, string | number | boolean | null>;
 }
+/**
+ * Template selection request for updating scoreboard templates
+ */
+export interface TemplateSelectionRequest extends TemplateSelection {
+}
+/**
+ * Template selection response for scoreboard template updates
+ */
+export interface TemplateSelectionResponse extends TemplateSelection {
+}
+/**
+ * Template update request
+ */
+export interface TemplateRequest {
+}
+/**
+ * Template update request with admin fields
+ */
+export interface TemplateRequestAdmin extends TemplateRequest {
+    published?: boolean;
+    appEntitlementRequirement?: AppEntitlementRequirement;
+}
 /**
  * Template use case categories
  */

package/dist/internal.mjs

@@ -62,7 +62,25 @@ export var ApiResource;
     ApiResource["PresetList"] = "presetList";
     ApiResource["Game"] = "game";
     ApiResource["GameList"] = "gameList";
+    ApiResource["Template"] = "template";
+    ApiResource["TemplateList"] = "templateList";
 })(ApiResource || (ApiResource = {}));
+/**
+ * App entitlement grant source
+ */
+export var AppEntitlementGrantedBy;
+(function (AppEntitlementGrantedBy) {
+    AppEntitlementGrantedBy["Payment"] = "payment";
+    AppEntitlementGrantedBy["Promotion"] = "promotion";
+    AppEntitlementGrantedBy["Admin"] = "admin";
+})(AppEntitlementGrantedBy || (AppEntitlementGrantedBy = {}));
+/**
+ * App entitlement type
+ */
+export var AppEntitlementType;
+(function (AppEntitlementType) {
+    AppEntitlementType["Template"] = "template";
+})(AppEntitlementType || (AppEntitlementType = {}));
 /**
  * App type identifiers
  */
@@ -157,6 +175,15 @@ export var TalkingPointEnergy;
     TalkingPointEnergy["Standard"] = "standard";
     TalkingPointEnergy["Hype"] = "hype";
 })(TalkingPointEnergy || (TalkingPointEnergy = {}));
+/**
+ * Entitlement requirement for access control
+ */
+export var AppEntitlementRequirement;
+(function (AppEntitlementRequirement) {
+    AppEntitlementRequirement["None"] = "none";
+    AppEntitlementRequirement["AccountSubscription"] = "accountSubscription";
+    AppEntitlementRequirement["Payment"] = "payment";
+})(AppEntitlementRequirement || (AppEntitlementRequirement = {}));
 /**
  * Event action identifiers
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scoreboardmax/api-types",
-  "version": "1.0.48",
+  "version": "1.0.50",
   "description": "TypeScript definitions for ScoreboardMax API",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",