@scoreboardmax/api-types 1.0.2 → 1.0.4

package/index.d.ts

@@ -4,7 +4,7 @@
  * This file contains type definitions for API consumers.
  * These types are automatically generated from the ScoreboardMax API source code.
  * 
- * @version Generated on 2025-08-08T05:09:09.907Z
+ * @version Generated on 2025-08-08T15:53:31.605Z
  */
 
 export enum ApiAction {
@@ -158,6 +158,13 @@ export enum FootballPeriod {
     Overtime = "overtime",
 }
 
+export enum MagicLinkType {
+    SignIn = "signIn",
+    ScoreboardGuest = "scoreboardGuest",
+    UserInvite = "userInvite",
+    ScoreboardView = "scoreboardView",
+}
+
 export enum MetaMessageType {
     ScoreboardReset = "scoreboardReset",
     ScoreboardRefresh = "scoreboardRefresh",
@@ -262,6 +269,23 @@ export interface AccountResponse {
   token?: string;
 }
 
+export interface Auth {
+  authId: string;
+  mask: string;
+  accountId: string;
+  userId?: string;
+  type: AuthType;
+  isAdmin: boolean;
+  description?: string | null;
+  permissions: Permissions;
+  dateCreated: string;
+  dateModified: string;
+  dateExpires?: string;
+  dateLastUsed?: string;
+  dateLastUserActivityUpdate?: string;
+  ttl?: number;
+}
+
 export interface AuthListResponse {
   url: string;
   uri: string;
@@ -296,6 +320,12 @@ export interface AuthResponse {
   token?: string;
 }
 
+export interface AuthSignInRequest {
+  email: string;
+  password: string;
+  accountId?: string;
+}
+
 export interface BaseballDataRequest {
     inning: number;
     inningSegment: BaseballInningSegment;
@@ -351,6 +381,18 @@ export interface BaseballScoreboardTeamResponse extends ScoreboardTeamBaseRespon
     isHomeTeam: boolean;
 }
 
+export interface BaseballSettings extends ScoreboardSettingsBase {
+    showCount: boolean;
+    showBaseRunners: boolean;
+    showLineScore: boolean;
+    showPitchCount: boolean;
+    showBattingAverage: boolean;
+    pitchClockLength?: number; 
+    showPitchClock: boolean;
+    showPitchClockWhenLow: boolean;
+    enableClockAutomations: boolean;
+}
+
 export interface BaseballSettingsRequest extends BaseballSettings {
 }
 
@@ -390,12 +432,54 @@ export interface BasketballScoreboardTeamResponse extends ScoreboardTeamBaseResp
     doubleBonus: boolean;
 }
 
+export interface BasketballSettings extends ScoreboardSettingsBase {
+    periodLength: number; 
+    shotClockLength?: number; 
+    shotClockSecondaryLength?: number; 
+    halfLength: number; 
+    showGameClock: boolean;
+    showShotClock: boolean;
+    showTimeouts: boolean;
+    gamePeriods: BasketballGamePeriods;
+    timeoutAllocation?: BasketballTimeoutAllocation;
+    timeoutsFirstHalf?: number;
+    timeoutsSecondHalf?: number;
+    timeoutsTotal?: number;
+    showTeamFouls: boolean;
+    hasDoubleBonus: boolean;
+    bonusThreshold?: number;
+    doubleBonusThreshold?: number;
+    enableClockAutomations: boolean;
+    showShotClockWhenLow: boolean;
+}
+
 export interface BasketballSettingsRequest extends BasketballSettings {
 }
 
 export interface BasketballSettingsResponse extends BasketballSettings {
 }
 
+export interface CheckoutSessionRequest {
+    priceId: string;
+    currency: string;
+}
+
+export interface CheckoutSessionResponse {
+    sessionId: string;
+    redirectUrl: string;
+}
+
+export interface Clock {
+    clockId: string;
+    scoreboardId: string;
+    accountId: string;
+    seconds: number | null;
+    running: boolean;
+    ascending: boolean;
+    asOfTimestamp: number;
+    stopAt?: number;
+}
+
 export interface ClockListResponse {
     url: string;
     uri: string;
@@ -429,6 +513,16 @@ export interface DataExtractResponse {
 
 export interface DataRow extends Array<string> { }
 
+export interface Event {
+  eventId: string;
+  accountId: string;
+  dateCreated: string;
+  resource: string;
+  resourceUri: string;
+  subscriptionResourceUri: string;
+  data: object | null;
+}
+
 export interface EventResponse {
   object: string;
   eventId: string;
@@ -497,12 +591,65 @@ export interface FootballScoreboardTeamResponse extends ScoreboardTeamBaseRespon
     possession: boolean;
 }
 
+export interface FootballSettings extends ScoreboardSettingsBase {
+    periodLength: number; 
+    halfLength: number; 
+    playClockLength?: number;
+    playClockSecondaryLength?: number;
+    timeoutsPerHalf?: number;
+    showGameClock: boolean;
+    showPlayClock: boolean;
+    showTimeouts: boolean;
+    showPossession: boolean;
+    downAndDistanceDisplay: DownAndDistanceDisplay;
+    hideFlagAfter: number;
+    clockStopsOnFirstDown: boolean;
+    enableMercyRule: boolean;
+    enableClockAutomations: boolean;
+    showPlayClockWhenLow: boolean;
+}
+
 export interface FootballSettingsRequest extends FootballSettings {
 }
 
 export interface FootballSettingsResponse extends FootballSettings {
 }
 
+export interface MagicLinkScoreboardGuestRequest {
+    scoreboardId: string;
+    expiresInHours: number;
+}
+
+export interface MetaMessage {
+    type: MetaMessageType;
+    accountId: string;
+    subscriptionResource: string;
+    subscriptionResourceUri: string;
+    dateCreated: string;
+    message: string | null;
+}
+
+export interface NewAccountRequest {
+  email: string;
+  password: string;
+  name?: string;
+}
+
+export interface OAuthBindingRequest {
+    messageCipher: string;
+}
+
+export interface OAuthResponse {
+    auth?: AuthResponse;
+    userCredentials?: UserCredentialsResponse;
+    oAuthProvider: OAuthProvider;
+    oAuthProviderId: string;
+    oAuthProviderEmail: string;
+    oAuthProviderName: string;
+    messageCipher?: string;
+    dateNow: string;
+}
+
 export interface OverlayRequest {
     type: "players" | "sponsors";
     data: PlayerSummaryRequest[] | SponsorSummaryRequest[];
@@ -579,6 +726,10 @@ export interface PlayerSummaryResponse {
     imageMediumUrl: string | null;
 }
 
+export interface PortalSessionResponse {
+    redirectUrl: string;
+}
+
 export interface PresetListResponse {
     url: string;
     uri: string;
@@ -750,6 +901,17 @@ export interface SoccerScoreboardTeamResponse extends ScoreboardTeamBaseResponse
     penaltyCard?: SoccerPenaltyCardResponse;
 }
 
+export interface SoccerSettings extends ScoreboardSettingsBase {
+    periodLength: number; 
+    halfLength: number; 
+    extraTimeLength: number; 
+    showGameClock: boolean;
+    gamePeriods: SoccerGamePeriods;
+    extraTimeLabel: ExtraTimeLabel;
+    hasStoppageTime: boolean;
+    hidePenaltyCardAfter: number; 
+}
+
 export interface SoccerSettingsRequest extends SoccerSettings {
 }
 
@@ -806,6 +968,17 @@ export interface SponsorSummaryResponse {
     imageMediumUrl: string | null;
 }
 
+export interface SupportEmailRequest {
+    from: string;
+    subject: string;
+    name: string;
+    body: string;
+}
+
+export interface SupportEmailResponse {
+    dateCreated: string;
+}
+
 export interface TeamListResponse {
   url: string;
   uri: string;
@@ -907,6 +1080,11 @@ export interface UserResponse {
   dateLastActivity: string | null;
 }
 
+export interface UserUpdateRequest {
+  name?: string;
+  permissions?: Permissions;
+}
+
 export interface VolleyballDataRequest {
     set: number | null;
     team1: VolleyballScoreboardTeamRequest;
@@ -940,6 +1118,13 @@ export interface VolleyballScoreboardTeamResponse extends ScoreboardTeamBaseResp
     finalSetScores: (number | null)[];
 }
 
+export interface VolleyballSettings extends ScoreboardSettingsBase {
+    sets: number;
+    timeoutsPerSet?: number;
+    showTimeouts: boolean;
+    showServing: boolean;
+}
+
 export interface VolleyballSettingsRequest extends VolleyballSettings {
 }
 
@@ -956,6 +1141,11 @@ export interface WebsocketConnectionIdResponse {
     dateCreated: string;
 }
 
+export interface WebsocketHeartbeatCommand {
+    action: "sendmessage";
+    operation: WebsocketOperation.SendHeartbeat;
+}
+
 export interface WebsocketMessage {
     type: WebsocketMessageType;
     error: boolean
@@ -1018,6 +1208,22 @@ export interface WrestlingScoreboardTeamResponse extends ScoreboardTeamBaseRespo
     bandColor: "red" | "blue" | "green" | null;
 }
 
+export interface WrestlingSettings extends ScoreboardSettingsBase {
+    style: WrestlingStyle;
+    weightType: "kg" | "lb";
+    meetType: WrestlingMeetType;
+    showPeriodClock: boolean;
+    periodLength: number; 
+    periodCount: number;
+    initialPeriodLength?: number; 
+    suddenVictoryLength?: number; 
+    tieBreakerLength?: number; 
+    ultimateTieBreakerLength?: number; 
+    hasUltimateTieBreaker: boolean;
+    bandColors: Array<"red" | "green" | "blue"> | [];
+    trackTeamScores: boolean;
+}
+
 export interface WrestlingSettingsRequest extends WrestlingSettings {
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scoreboardmax/api-types",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "TypeScript definitions for ScoreboardMax API",
   "main": "index.d.ts",
   "types": "index.d.ts",
@@ -28,7 +28,7 @@
   "bugs": {
     "url": "https://github.com/ScoreboardMax/scoreboardmax-api-types/issues"
   },
-  "homepage": "https://github.com/ScoreboardMax/scoreboardmax-api-types#readme",
+  "homepage": "https://scoreboardmax.com/api/docs",
   "publishConfig": {
     "access": "public"
   }