@scoreboardmax/api-types 1.0.22-next.2 → 1.0.22-next.20

package/dist/index.cjs

@@ -7,7 +7,7 @@
  *
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WrestlingStyle = exports.WrestlingPeriod = exports.WrestlingOvertimeType = exports.WrestlingMeetType = exports.WebsocketOperation = exports.WebsocketMessageType = exports.TemplateUseCase = exports.SoccerPeriod = exports.SoccerPenaltyCardType = exports.SoccerGamePeriods = exports.ScoreboardType = exports.ScoreboardCode = exports.PlanId = exports.OAuthProvider = exports.MetaMessageType = exports.MagicLinkType = exports.FootballPeriod = exports.FileType = exports.ExtraTimeLabel = exports.EventAction = exports.ErrorCode = exports.DownAndDistanceDisplay = 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;
+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;
 };
@@ -131,6 +131,13 @@ var ContentType;
     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";
@@ -211,6 +218,14 @@ var 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";
@@ -267,12 +282,20 @@ var TemplateUseCase;
     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["SubscriptionConfirmation"] = "subscriptionConfirmation";
     WebsocketMessageType["Info"] = "info";
     WebsocketMessageType["Meta"] = "meta";
 })(WebsocketMessageType || (exports.WebsocketMessageType = WebsocketMessageType = {}));
@@ -280,8 +303,6 @@ var WebsocketOperation;
 (function (WebsocketOperation) {
     WebsocketOperation["SendHeartbeat"] = "sendHeartbeat";
     WebsocketOperation["GetConnectionId"] = "getConnectionId";
-    WebsocketOperation["SubscribeScoreboard"] = "subscribeScoreboard";
-    WebsocketOperation["UnsubscribeScoreboard"] = "unsubscribeScoreboard";
 })(WebsocketOperation || (exports.WebsocketOperation = WebsocketOperation = {}));
 var WrestlingMeetType;
 (function (WrestlingMeetType) {

package/dist/index.d.ts

@@ -100,6 +100,12 @@ export declare enum ContentType {
     Xlsx = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
     Zip = "application/zip"
 }
+export declare enum DisplayConnectionStatus {
+    New = "new",
+    Connected = "connected",
+    Sent = "sent",
+    Completed = "completed"
+}
 export declare enum DownAndDistanceDisplay {
     Both = "both",
     DownOnly = "downOnly",
@@ -172,6 +178,13 @@ export declare enum MetaMessageType {
     ScoreboardReset = "scoreboardReset",
     ScoreboardRefresh = "scoreboardRefresh"
 }
+export declare enum OAuthAction {
+    NewUserCreated = "new_user_created",
+    ExistingUserSignedIn = "existing_user_signed_in",
+    ProviderLinkedAndSignedIn = "provider_linked_and_signed_in",
+    RequiresUserDecision = "requires_user_decision",
+    NewAccountForExistingUser = "new_account_for_existing_user"
+}
 export declare enum OAuthProvider {
     Google = "google"
 }
@@ -220,19 +233,24 @@ export declare enum TemplateUseCase {
     Display = "display",
     Direct = "direct"
 }
+export declare enum VolleyballSet {
+    Pre = "pregame",
+    First = "1",
+    Second = "2",
+    Third = "3",
+    Fourth = "4",
+    Fifth = "5"
+}
 export declare enum WebsocketMessageType {
     Event = "event",
     Heartbeat = "heartbeat",
     ConnectionConfirmation = "connectionConfirmation",
-    SubscriptionConfirmation = "subscriptionConfirmation",
     Info = "info",
     Meta = "meta"
 }
 export declare enum WebsocketOperation {
     SendHeartbeat = "sendHeartbeat",
-    GetConnectionId = "getConnectionId",
-    SubscribeScoreboard = "subscribeScoreboard",
-    UnsubscribeScoreboard = "unsubscribeScoreboard"
+    GetConnectionId = "getConnectionId"
 }
 export declare enum WrestlingMeetType {
     Dual = "dual",
@@ -417,6 +435,7 @@ export interface BaseballSettings extends ScoreboardSettingsBase {
     showPitchClock: boolean;
     showPitchClockWhenLow: boolean;
     enableClockAutomations: boolean;
+    innings: number;
 }
 export interface BaseballSettingsRequest extends BaseballSettings {
 }
@@ -493,6 +512,11 @@ export interface CheckoutSessionResponse {
     sessionId: string;
     redirectUrl: string;
 }
+export interface ClientConfigResponse {
+    websocketUrl: string;
+    signInUrl: string;
+    dashboardUrl: string;
+}
 export interface Clock {
     clockId: string;
     scoreboardId: string;
@@ -535,6 +559,18 @@ export interface DataExtractResponse {
 }
 export interface DataRow extends Array<string> {
 }
+export interface DisplayConnectionCodeRequest {
+    code: string;
+}
+export interface DisplayConnectionResponse {
+    displayConnectionId: string;
+    code: string;
+    status: DisplayConnectionStatus;
+    dateCreated: string;
+    dateModified: string;
+    dateExpires: string;
+    scoreboardUrl?: string;
+}
 export interface ErrorResponse {
     error: boolean;
     code: ErrorCode;
@@ -674,6 +710,10 @@ export interface NumberInput extends BaseInput {
 export interface OAuthBindingRequest {
     messageCipher: string;
 }
+export interface OAuthRequest {
+    code: string;
+    redirectUri: string;
+}
 export interface OAuthResponse {
     auth?: AuthResponse;
     userCredentials?: UserCredentialsResponse;
@@ -683,6 +723,7 @@ export interface OAuthResponse {
     oAuthProviderName: string;
     messageCipher?: string;
     dateNow: string;
+    action: OAuthAction;
 }
 export interface OverlayRequest {
     type: "players" | "sponsors";
@@ -700,6 +741,7 @@ export interface Plan {
     planId: PlanId;
     resetScoreboards: boolean;
     apiAccess: boolean;
+    customizationAccess?: boolean;
     maxScoreboards: number;
     maxActiveScoreboards: number;
     maxConcurrentDevices: number;
@@ -755,6 +797,7 @@ export interface PlayerSummaryRequest {
     number: string | null;
     position: string | null;
     imageFilename: string | null;
+    reference?: string;
 }
 export interface PlayerSummaryResponse {
     playerId: string | null;
@@ -766,6 +809,7 @@ export interface PlayerSummaryResponse {
     imageUrl: string | null;
     imagePreviewUrl: string | null;
     imageMediumUrl: string | null;
+    reference: string;
 }
 export interface PortalSessionResponse {
     redirectUrl: string;
@@ -852,6 +896,14 @@ export interface ScoreboardListResponse {
     pageNext: string | null;
     data: ScoreboardResponse[];
 }
+export interface ScoreboardQrPdfRequest {
+    target: string;
+    use: "control" | "embed" | "display" | "direct";
+    datePrinted: string;
+}
+export interface ScoreboardQrPdfResponse {
+    url: string;
+}
 export interface ScoreboardRequest {
     name: string | null;
     type: ScoreboardType;
@@ -868,6 +920,8 @@ export interface ScoreboardResponse {
     description: string;
     controlUrl: string;
     embedUrl: string;
+    displayUrl: string;
+    directUrl: string;
     type: ScoreboardType;
     data: BasketballDataResponse | FootballDataResponse | VolleyballDataResponse | SoccerDataResponse | BaseballDataResponse | WrestlingDataResponse;
     accountId: string;
@@ -1145,14 +1199,14 @@ export interface UserUpdateRequest {
     permissions?: Permissions;
 }
 export interface VolleyballDataRequest {
-    set: number | null;
+    set: VolleyballSet;
     team1: VolleyballScoreboardTeamRequest;
     team2: VolleyballScoreboardTeamRequest;
     settings?: VolleyballSettingsRequest;
 }
 export interface VolleyballDataResponse {
     type: ScoreboardType;
-    set: number | null;
+    set: VolleyballSet;
     team1: VolleyballScoreboardTeamResponse;
     team2: VolleyballScoreboardTeamResponse;
     settings: VolleyballSettingsResponse;
@@ -1201,23 +1255,8 @@ export interface WebsocketMessage {
     message: string;
     data: Event | MetaMessage | WebsocketConnectionIdResponse | null;
 }
-export interface WebsocketScoreboardSubscriptionRequest {
-    action: "sendmessage";
-    operation: WebsocketOperation.SubscribeScoreboard | WebsocketOperation.UnsubscribeScoreboard;
-    scoreboardId: string;
-    appId?: string;
-    sendInitialData?: boolean;
-    token: string;
-}
-export interface WebsocketScoreboardSubscriptionResponse {
-    operation: WebsocketOperation.SubscribeScoreboard | WebsocketOperation.UnsubscribeScoreboard;
-    scoreboardId: string;
-    appId?: string;
-    error?: ErrorResponse;
-}
 export interface WebsocketSubscriptionRequest {
     connectionId: string;
-    appId?: string;
     sendInitialData?: boolean;
 }
 export interface WebsocketSubscriptionResponse {
@@ -1225,7 +1264,6 @@ export interface WebsocketSubscriptionResponse {
     subscriptionResource: string;
     subscriptionResourceUri: string;
     accountId: string;
-    appId?: string;
 }
 export interface WrestlingDataRequest {
     period: WrestlingPeriod;

package/dist/index.mjs

@@ -122,6 +122,13 @@ export var ContentType;
     ContentType["Xlsx"] = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
     ContentType["Zip"] = "application/zip";
 })(ContentType || (ContentType = {}));
+export var DisplayConnectionStatus;
+(function (DisplayConnectionStatus) {
+    DisplayConnectionStatus["New"] = "new";
+    DisplayConnectionStatus["Connected"] = "connected";
+    DisplayConnectionStatus["Sent"] = "sent";
+    DisplayConnectionStatus["Completed"] = "completed";
+})(DisplayConnectionStatus || (DisplayConnectionStatus = {}));
 export var DownAndDistanceDisplay;
 (function (DownAndDistanceDisplay) {
     DownAndDistanceDisplay["Both"] = "both";
@@ -202,6 +209,14 @@ export var MetaMessageType;
     MetaMessageType["ScoreboardReset"] = "scoreboardReset";
     MetaMessageType["ScoreboardRefresh"] = "scoreboardRefresh";
 })(MetaMessageType || (MetaMessageType = {}));
+export 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 || (OAuthAction = {}));
 export var OAuthProvider;
 (function (OAuthProvider) {
     OAuthProvider["Google"] = "google";
@@ -258,12 +273,20 @@ export var TemplateUseCase;
     TemplateUseCase["Display"] = "display";
     TemplateUseCase["Direct"] = "direct";
 })(TemplateUseCase || (TemplateUseCase = {}));
+export var VolleyballSet;
+(function (VolleyballSet) {
+    VolleyballSet["Pre"] = "pregame";
+    VolleyballSet["First"] = "1";
+    VolleyballSet["Second"] = "2";
+    VolleyballSet["Third"] = "3";
+    VolleyballSet["Fourth"] = "4";
+    VolleyballSet["Fifth"] = "5";
+})(VolleyballSet || (VolleyballSet = {}));
 export var WebsocketMessageType;
 (function (WebsocketMessageType) {
     WebsocketMessageType["Event"] = "event";
     WebsocketMessageType["Heartbeat"] = "heartbeat";
     WebsocketMessageType["ConnectionConfirmation"] = "connectionConfirmation";
-    WebsocketMessageType["SubscriptionConfirmation"] = "subscriptionConfirmation";
     WebsocketMessageType["Info"] = "info";
     WebsocketMessageType["Meta"] = "meta";
 })(WebsocketMessageType || (WebsocketMessageType = {}));
@@ -271,8 +294,6 @@ export var WebsocketOperation;
 (function (WebsocketOperation) {
     WebsocketOperation["SendHeartbeat"] = "sendHeartbeat";
     WebsocketOperation["GetConnectionId"] = "getConnectionId";
-    WebsocketOperation["SubscribeScoreboard"] = "subscribeScoreboard";
-    WebsocketOperation["UnsubscribeScoreboard"] = "unsubscribeScoreboard";
 })(WebsocketOperation || (WebsocketOperation = {}));
 export var WrestlingMeetType;
 (function (WrestlingMeetType) {

package/package.json

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