@scoreboardmax/api-types 1.0.31 → 1.0.34

package/dist/index.cjs

@@ -47,6 +47,8 @@ var ApiResource;
     ApiResource["AccountList"] = "accountList";
     ApiResource["App"] = "app";
     ApiResource["AppList"] = "appList";
+    ApiResource["Archive"] = "archive";
+    ApiResource["ArchiveList"] = "archiveList";
     ApiResource["File"] = "file";
     ApiResource["FileList"] = "fileList";
     ApiResource["Auth"] = "auth";

package/dist/index.d.ts

@@ -24,6 +24,8 @@ export declare enum ApiResource {
     AccountList = "accountList",
     App = "app",
     AppList = "appList",
+    Archive = "archive",
+    ArchiveList = "archiveList",
     File = "file",
     FileList = "fileList",
     Auth = "auth",
@@ -272,6 +274,12 @@ export declare enum WrestlingStyle {
     Greco = "greco",
     Folkstyle = "folkstyle"
 }
+export interface AccountListResponse {
+    url: string;
+    uri: string;
+    pageNext: string | null;
+    data: AccountResponse[];
+}
 export interface AccountRequest {
     name: string | null;
     logoFilename: string | null;
@@ -329,6 +337,7 @@ export interface Auth {
     userId?: string;
     type: AuthType;
     isAdmin: boolean;
+    isAssumed?: boolean;
     description?: string | null;
     permissions: Permissions;
     dateCreated: string;
@@ -1168,7 +1177,7 @@ export interface UserListResponse {
     url: string;
     uri: string;
     pageNext: string | null;
-    data: UserResponse[] | UserResponseAdmin[];
+    data: UserResponse[];
 }
 export interface UserRequest {
     email: string;
@@ -1190,10 +1199,6 @@ export interface UserResponse {
     dateModified: string;
     dateLastActivity: string | null;
 }
-export interface UserResponseAdmin extends UserResponse {
-    isOwner: boolean;
-    isAdmin: boolean;
-}
 export interface UserUpdateRequest {
     name?: string;
     permissions?: Permissions;

package/dist/index.mjs

@@ -38,6 +38,8 @@ export var ApiResource;
     ApiResource["AccountList"] = "accountList";
     ApiResource["App"] = "app";
     ApiResource["AppList"] = "appList";
+    ApiResource["Archive"] = "archive";
+    ApiResource["ArchiveList"] = "archiveList";
     ApiResource["File"] = "file";
     ApiResource["FileList"] = "fileList";
     ApiResource["Auth"] = "auth";

package/dist/internal.cjs

@@ -0,0 +1,335 @@
+"use strict";
+/**
+ * ScoreboardMax API Types - Internal
+ *
+ * This file contains ALL type definitions including admin-only types.
+ * These types are automatically generated from the ScoreboardMax API source code.
+ *
+ * Note: Admin types are only used in administrative applications and models with
+ * these interfaces will not be returned by the API to non-admin users.
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WrestlingStyle = exports.WrestlingPeriod = exports.WrestlingOvertimeType = exports.WrestlingMeetType = exports.WebsocketOperation = exports.WebsocketMessageType = exports.VolleyballSet = exports.TemplateUseCase = exports.SoccerPeriod = exports.SoccerPenaltyCardType = exports.SoccerGamePeriods = exports.ScoreboardType = exports.ScoreboardCode = exports.PlanId = exports.OAuthProvider = exports.OAuthAction = exports.MetaMessageType = exports.MagicLinkType = exports.FootballPeriod = exports.FileType = exports.ExtraTimeLabel = exports.EventAction = exports.ErrorCode = exports.DownAndDistanceDisplay = exports.DisplayConnectionStatus = exports.ContentType = exports.ClockType = exports.BasketballTimeoutAllocation = exports.BasketballPeriod = exports.BasketballGamePeriods = exports.BaseballInningSegment = exports.AuthType = exports.AppType = exports.ApiResource = exports.ApiAction = exports.isWrestlingData = exports.isVolleyballData = exports.isSoccerData = exports.isFootballData = exports.isBasketballData = exports.isBaseballData = void 0;
+const isBaseballData = (data) => {
+    return data.type === ScoreboardType.Baseball;
+};
+exports.isBaseballData = isBaseballData;
+const isBasketballData = (data) => {
+    return data.type === ScoreboardType.Basketball;
+};
+exports.isBasketballData = isBasketballData;
+const isFootballData = (data) => {
+    return data.type === ScoreboardType.Football;
+};
+exports.isFootballData = isFootballData;
+const isSoccerData = (data) => {
+    return data.type === ScoreboardType.Soccer;
+};
+exports.isSoccerData = isSoccerData;
+const isVolleyballData = (data) => {
+    return data.type === ScoreboardType.Volleyball;
+};
+exports.isVolleyballData = isVolleyballData;
+const isWrestlingData = (data) => {
+    return data.type === ScoreboardType.Wrestling;
+};
+exports.isWrestlingData = isWrestlingData;
+var ApiAction;
+(function (ApiAction) {
+    ApiAction["Create"] = "create";
+    ApiAction["Read"] = "read";
+    ApiAction["Update"] = "update";
+    ApiAction["Delete"] = "delete";
+    ApiAction["All"] = "*";
+})(ApiAction || (exports.ApiAction = ApiAction = {}));
+var ApiResource;
+(function (ApiResource) {
+    ApiResource["All"] = "*";
+    ApiResource["Account"] = "account";
+    ApiResource["AccountList"] = "accountList";
+    ApiResource["App"] = "app";
+    ApiResource["AppList"] = "appList";
+    ApiResource["Archive"] = "archive";
+    ApiResource["ArchiveList"] = "archiveList";
+    ApiResource["File"] = "file";
+    ApiResource["FileList"] = "fileList";
+    ApiResource["Auth"] = "auth";
+    ApiResource["AuthList"] = "authList";
+    ApiResource["Clock"] = "clock";
+    ApiResource["ClockList"] = "clockList";
+    ApiResource["Player"] = "player";
+    ApiResource["PlayerList"] = "playerList";
+    ApiResource["Roster"] = "roster";
+    ApiResource["RosterList"] = "rosterList";
+    ApiResource["Scoreboard"] = "scoreboard";
+    ApiResource["ScoreboardList"] = "scoreboardList";
+    ApiResource["Sponsor"] = "sponsor";
+    ApiResource["SponsorList"] = "sponsorList";
+    ApiResource["Team"] = "team";
+    ApiResource["TeamList"] = "teamList";
+    ApiResource["Upload"] = "upload";
+    ApiResource["UploadList"] = "uploadList";
+    ApiResource["User"] = "user";
+    ApiResource["UserList"] = "userList";
+    ApiResource["UserCredentials"] = "userCredentials";
+    ApiResource["UserCredentialsList"] = "userCredentialsList";
+    ApiResource["Overlay"] = "overlay";
+    ApiResource["OverlayList"] = "overlayList";
+    ApiResource["Preset"] = "preset";
+    ApiResource["PresetList"] = "presetList";
+})(ApiResource || (exports.ApiResource = ApiResource = {}));
+var AppType;
+(function (AppType) {
+    AppType["Template"] = "template";
+})(AppType || (exports.AppType = AppType = {}));
+var AuthType;
+(function (AuthType) {
+    AuthType["Session"] = "session";
+    AuthType["Api"] = "api";
+    AuthType["Guest"] = "guest";
+    AuthType["ScoreboardView"] = "scoreboardView";
+})(AuthType || (exports.AuthType = AuthType = {}));
+var BaseballInningSegment;
+(function (BaseballInningSegment) {
+    BaseballInningSegment["Top"] = "top";
+    BaseballInningSegment["Middle"] = "middle";
+    BaseballInningSegment["Bottom"] = "bottom";
+    BaseballInningSegment["End"] = "end";
+})(BaseballInningSegment || (exports.BaseballInningSegment = BaseballInningSegment = {}));
+var BasketballGamePeriods;
+(function (BasketballGamePeriods) {
+    BasketballGamePeriods["Quarters"] = "quarters";
+    BasketballGamePeriods["Halves"] = "halves";
+})(BasketballGamePeriods || (exports.BasketballGamePeriods = BasketballGamePeriods = {}));
+var BasketballPeriod;
+(function (BasketballPeriod) {
+    BasketballPeriod["Pre"] = "pregame";
+    BasketballPeriod["First"] = "1";
+    BasketballPeriod["Second"] = "2";
+    BasketballPeriod["Half"] = "half";
+    BasketballPeriod["Third"] = "3";
+    BasketballPeriod["Fourth"] = "4";
+    BasketballPeriod["Overtime"] = "overtime";
+})(BasketballPeriod || (exports.BasketballPeriod = BasketballPeriod = {}));
+var BasketballTimeoutAllocation;
+(function (BasketballTimeoutAllocation) {
+    BasketballTimeoutAllocation["PerGame"] = "perGame";
+    BasketballTimeoutAllocation["PerHalf"] = "perHalf";
+})(BasketballTimeoutAllocation || (exports.BasketballTimeoutAllocation = BasketballTimeoutAllocation = {}));
+var ClockType;
+(function (ClockType) {
+    ClockType["Game"] = "game";
+    ClockType["Play"] = "play";
+    ClockType["Shot"] = "shot";
+    ClockType["Pitch"] = "pitch";
+    ClockType["Period"] = "period";
+})(ClockType || (exports.ClockType = ClockType = {}));
+var ContentType;
+(function (ContentType) {
+    ContentType["Png"] = "image/png";
+    ContentType["Jpg"] = "image/jpeg";
+    ContentType["Gif"] = "image/gif";
+    ContentType["Webp"] = "image/webp";
+    ContentType["Avif"] = "image/avif";
+    ContentType["Csv"] = "text/csv";
+    ContentType["Xlsx"] = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
+    ContentType["Zip"] = "application/zip";
+})(ContentType || (exports.ContentType = ContentType = {}));
+var DisplayConnectionStatus;
+(function (DisplayConnectionStatus) {
+    DisplayConnectionStatus["New"] = "new";
+    DisplayConnectionStatus["Connected"] = "connected";
+    DisplayConnectionStatus["Sent"] = "sent";
+    DisplayConnectionStatus["Completed"] = "completed";
+})(DisplayConnectionStatus || (exports.DisplayConnectionStatus = DisplayConnectionStatus = {}));
+var DownAndDistanceDisplay;
+(function (DownAndDistanceDisplay) {
+    DownAndDistanceDisplay["Both"] = "both";
+    DownAndDistanceDisplay["DownOnly"] = "downOnly";
+    DownAndDistanceDisplay["None"] = "none";
+})(DownAndDistanceDisplay || (exports.DownAndDistanceDisplay = DownAndDistanceDisplay = {}));
+var ErrorCode;
+(function (ErrorCode) {
+    ErrorCode["ForbiddenSelfPermissionsChange"] = "ForbiddenSelfPermissionsChange";
+    ErrorCode["InsufficientAdminPermissions"] = "InsufficientAdminPermissions";
+    ErrorCode["InsufficientItemPermissions"] = "InsufficientItemPermissions";
+    ErrorCode["InsufficientResourcePermissions"] = "InsufficientResourcePermissions";
+    ErrorCode["InsufficientResourceItemPermissions"] = "InsufficientResourceItemPermissions";
+    ErrorCode["InvalidAuthType"] = "InvalidAuthType";
+    ErrorCode["InvalidColorFormat"] = "InvalidColorFormat";
+    ErrorCode["InvalidDate"] = "InvalidDate";
+    ErrorCode["InvalidInput"] = "InvalidInput";
+    ErrorCode["InvalidRequest"] = "InvalidRequest";
+    ErrorCode["InvalidPermissionGrant"] = "InvalidPermissionGrant";
+    ErrorCode["InvalidSignIn"] = "InvalidSignIn";
+    ErrorCode["InvalidAccountSignIn"] = "InvalidAccountSignIn";
+    ErrorCode["InvalidToken"] = "InvalidToken";
+    ErrorCode["AccountLimitExceeded"] = "AccountLimitExceeded";
+    ErrorCode["AccountStorageExceeded"] = "AccountStorageExceeded";
+    ErrorCode["ActiveScoreboardsExceeded"] = "ActiveScoreboardsExceeded";
+    ErrorCode["AccountFeatureNotEnabled"] = "AccountFeatureNotEnabled";
+    ErrorCode["AppNotEnabled"] = "AppNotEnabled";
+    ErrorCode["ImageProcessingError"] = "ImageProcessingError";
+    ErrorCode["RemoteServerError"] = "RemoteServerError";
+    ErrorCode["RemoteServerTimeout"] = "RemoteServerTimeout";
+    ErrorCode["RequestLimitExceeded"] = "RequestLimitExceeded";
+    ErrorCode["ResourceNotFound"] = "ResourceNotFound";
+    ErrorCode["UserCredentialsInUse"] = "UserCredentialsInUse";
+    ErrorCode["AccountEmailInUse"] = "AccountEmailInUse";
+    ErrorCode["IncompatibleState"] = "IncompatibleState";
+    ErrorCode["VersionConflict"] = "VersionConflict";
+    ErrorCode["UnspecifiedError"] = "UnspecifiedError";
+})(ErrorCode || (exports.ErrorCode = ErrorCode = {}));
+var EventAction;
+(function (EventAction) {
+    EventAction["Created"] = "created";
+    EventAction["Updated"] = "updated";
+    EventAction["Deleted"] = "deleted";
+    EventAction["Read"] = "read";
+})(EventAction || (exports.EventAction = EventAction = {}));
+var ExtraTimeLabel;
+(function (ExtraTimeLabel) {
+    ExtraTimeLabel["ExtraTime"] = "ET";
+    ExtraTimeLabel["Overtime"] = "OT";
+})(ExtraTimeLabel || (exports.ExtraTimeLabel = ExtraTimeLabel = {}));
+var FileType;
+(function (FileType) {
+    FileType["TeamLogo"] = "teamLogo";
+    FileType["AccountLogo"] = "accountLogo";
+    FileType["PlayerPhoto"] = "playerPhoto";
+    FileType["SponsorLogo"] = "sponsorLogo";
+    FileType["Temporary"] = "temporary";
+})(FileType || (exports.FileType = FileType = {}));
+var FootballPeriod;
+(function (FootballPeriod) {
+    FootballPeriod["Pre"] = "pregame";
+    FootballPeriod["First"] = "1";
+    FootballPeriod["Second"] = "2";
+    FootballPeriod["Half"] = "half";
+    FootballPeriod["Third"] = "3";
+    FootballPeriod["Fourth"] = "4";
+    FootballPeriod["Overtime"] = "overtime";
+})(FootballPeriod || (exports.FootballPeriod = FootballPeriod = {}));
+var MagicLinkType;
+(function (MagicLinkType) {
+    MagicLinkType["SignIn"] = "signIn";
+    MagicLinkType["ScoreboardGuest"] = "scoreboardGuest";
+    MagicLinkType["UserInvite"] = "userInvite";
+    MagicLinkType["ScoreboardView"] = "scoreboardView";
+})(MagicLinkType || (exports.MagicLinkType = MagicLinkType = {}));
+var MetaMessageType;
+(function (MetaMessageType) {
+    MetaMessageType["ScoreboardReset"] = "scoreboardReset";
+    MetaMessageType["ScoreboardRefresh"] = "scoreboardRefresh";
+})(MetaMessageType || (exports.MetaMessageType = MetaMessageType = {}));
+var OAuthAction;
+(function (OAuthAction) {
+    OAuthAction["NewUserCreated"] = "new_user_created";
+    OAuthAction["ExistingUserSignedIn"] = "existing_user_signed_in";
+    OAuthAction["ProviderLinkedAndSignedIn"] = "provider_linked_and_signed_in";
+    OAuthAction["RequiresUserDecision"] = "requires_user_decision";
+    OAuthAction["NewAccountForExistingUser"] = "new_account_for_existing_user";
+})(OAuthAction || (exports.OAuthAction = OAuthAction = {}));
+var OAuthProvider;
+(function (OAuthProvider) {
+    OAuthProvider["Google"] = "google";
+})(OAuthProvider || (exports.OAuthProvider = OAuthProvider = {}));
+var PlanId;
+(function (PlanId) {
+    PlanId["Basic"] = "basic";
+    PlanId["Plus"] = "plus";
+    PlanId["Pro"] = "pro";
+})(PlanId || (exports.PlanId = PlanId = {}));
+var ScoreboardCode;
+(function (ScoreboardCode) {
+    ScoreboardCode["Football"] = "fb";
+    ScoreboardCode["Basketball"] = "bb";
+    ScoreboardCode["Volleyball"] = "vb";
+    ScoreboardCode["Soccer"] = "sc";
+    ScoreboardCode["Baseball"] = "ba";
+    ScoreboardCode["Wrestling"] = "wr";
+})(ScoreboardCode || (exports.ScoreboardCode = ScoreboardCode = {}));
+var ScoreboardType;
+(function (ScoreboardType) {
+    ScoreboardType["Baseball"] = "baseball";
+    ScoreboardType["Basketball"] = "basketball";
+    ScoreboardType["Football"] = "football";
+    ScoreboardType["Soccer"] = "soccer";
+    ScoreboardType["Volleyball"] = "volleyball";
+    ScoreboardType["Wrestling"] = "wrestling";
+})(ScoreboardType || (exports.ScoreboardType = ScoreboardType = {}));
+var SoccerGamePeriods;
+(function (SoccerGamePeriods) {
+    SoccerGamePeriods["Quarters"] = "quarters";
+    SoccerGamePeriods["Halves"] = "halves";
+})(SoccerGamePeriods || (exports.SoccerGamePeriods = SoccerGamePeriods = {}));
+var SoccerPenaltyCardType;
+(function (SoccerPenaltyCardType) {
+    SoccerPenaltyCardType["Yellow"] = "yellow";
+    SoccerPenaltyCardType["Red"] = "red";
+})(SoccerPenaltyCardType || (exports.SoccerPenaltyCardType = SoccerPenaltyCardType = {}));
+var SoccerPeriod;
+(function (SoccerPeriod) {
+    SoccerPeriod["Pre"] = "pregame";
+    SoccerPeriod["First"] = "1";
+    SoccerPeriod["Second"] = "2";
+    SoccerPeriod["Half"] = "half";
+    SoccerPeriod["Third"] = "3";
+    SoccerPeriod["Fourth"] = "4";
+    SoccerPeriod["ExtraTime1"] = "ET 1";
+    SoccerPeriod["ExtraTime2"] = "ET 2";
+    SoccerPeriod["Shootout"] = "shootout";
+})(SoccerPeriod || (exports.SoccerPeriod = SoccerPeriod = {}));
+var TemplateUseCase;
+(function (TemplateUseCase) {
+    TemplateUseCase["Embed"] = "embed";
+    TemplateUseCase["Display"] = "display";
+    TemplateUseCase["Direct"] = "direct";
+})(TemplateUseCase || (exports.TemplateUseCase = TemplateUseCase = {}));
+var VolleyballSet;
+(function (VolleyballSet) {
+    VolleyballSet["Pre"] = "pregame";
+    VolleyballSet["First"] = "1";
+    VolleyballSet["Second"] = "2";
+    VolleyballSet["Third"] = "3";
+    VolleyballSet["Fourth"] = "4";
+    VolleyballSet["Fifth"] = "5";
+})(VolleyballSet || (exports.VolleyballSet = VolleyballSet = {}));
+var WebsocketMessageType;
+(function (WebsocketMessageType) {
+    WebsocketMessageType["Event"] = "event";
+    WebsocketMessageType["Heartbeat"] = "heartbeat";
+    WebsocketMessageType["ConnectionConfirmation"] = "connectionConfirmation";
+    WebsocketMessageType["Info"] = "info";
+    WebsocketMessageType["Meta"] = "meta";
+})(WebsocketMessageType || (exports.WebsocketMessageType = WebsocketMessageType = {}));
+var WebsocketOperation;
+(function (WebsocketOperation) {
+    WebsocketOperation["SendHeartbeat"] = "sendHeartbeat";
+    WebsocketOperation["GetConnectionId"] = "getConnectionId";
+})(WebsocketOperation || (exports.WebsocketOperation = WebsocketOperation = {}));
+var WrestlingMeetType;
+(function (WrestlingMeetType) {
+    WrestlingMeetType["Dual"] = "dual";
+    WrestlingMeetType["Tournament"] = "tournament";
+})(WrestlingMeetType || (exports.WrestlingMeetType = WrestlingMeetType = {}));
+var WrestlingOvertimeType;
+(function (WrestlingOvertimeType) {
+    WrestlingOvertimeType["SuddenVictory"] = "sv";
+    WrestlingOvertimeType["TieBreaker"] = "tb";
+    WrestlingOvertimeType["UltimateTieBreaker"] = "utb";
+})(WrestlingOvertimeType || (exports.WrestlingOvertimeType = WrestlingOvertimeType = {}));
+var WrestlingPeriod;
+(function (WrestlingPeriod) {
+    WrestlingPeriod["First"] = "1";
+    WrestlingPeriod["Second"] = "2";
+    WrestlingPeriod["Third"] = "3";
+    WrestlingPeriod["Overtime"] = "overtime";
+})(WrestlingPeriod || (exports.WrestlingPeriod = WrestlingPeriod = {}));
+var WrestlingStyle;
+(function (WrestlingStyle) {
+    WrestlingStyle["Freestyle"] = "freestyle";
+    WrestlingStyle["Greco"] = "greco";
+    WrestlingStyle["Folkstyle"] = "folkstyle";
+})(WrestlingStyle || (exports.WrestlingStyle = WrestlingStyle = {}));