@scoreboardmax/api-types 1.0.24 → 1.0.26

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.cjs CHANGED
@@ -7,7 +7,7 @@
7
7
  *
8
8
  */
9
9
  Object.defineProperty(exports, "__esModule", { value: true });
10
- 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.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;
10
+ 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.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;
11
11
  const isBaseballData = (data) => {
12
12
  return data.type === ScoreboardType.Baseball;
13
13
  };
@@ -137,6 +137,38 @@ var DownAndDistanceDisplay;
137
137
  DownAndDistanceDisplay["DownOnly"] = "downOnly";
138
138
  DownAndDistanceDisplay["None"] = "none";
139
139
  })(DownAndDistanceDisplay || (exports.DownAndDistanceDisplay = DownAndDistanceDisplay = {}));
140
+ var ErrorCode;
141
+ (function (ErrorCode) {
142
+ ErrorCode["ForbiddenSelfPermissionsChange"] = "ForbiddenSelfPermissionsChange";
143
+ ErrorCode["InsufficientAdminPermissions"] = "InsufficientAdminPermissions";
144
+ ErrorCode["InsufficientItemPermissions"] = "InsufficientItemPermissions";
145
+ ErrorCode["InsufficientResourcePermissions"] = "InsufficientResourcePermissions";
146
+ ErrorCode["InsufficientResourceItemPermissions"] = "InsufficientResourceItemPermissions";
147
+ ErrorCode["InvalidAuthType"] = "InvalidAuthType";
148
+ ErrorCode["InvalidColorFormat"] = "InvalidColorFormat";
149
+ ErrorCode["InvalidDate"] = "InvalidDate";
150
+ ErrorCode["InvalidInput"] = "InvalidInput";
151
+ ErrorCode["InvalidRequest"] = "InvalidRequest";
152
+ ErrorCode["InvalidPermissionGrant"] = "InvalidPermissionGrant";
153
+ ErrorCode["InvalidSignIn"] = "InvalidSignIn";
154
+ ErrorCode["InvalidAccountSignIn"] = "InvalidAccountSignIn";
155
+ ErrorCode["InvalidToken"] = "InvalidToken";
156
+ ErrorCode["AccountLimitExceeded"] = "AccountLimitExceeded";
157
+ ErrorCode["AccountStorageExceeded"] = "AccountStorageExceeded";
158
+ ErrorCode["ActiveScoreboardsExceeded"] = "ActiveScoreboardsExceeded";
159
+ ErrorCode["AccountFeatureNotEnabled"] = "AccountFeatureNotEnabled";
160
+ ErrorCode["AppNotEnabled"] = "AppNotEnabled";
161
+ ErrorCode["ImageProcessingError"] = "ImageProcessingError";
162
+ ErrorCode["RemoteServerError"] = "RemoteServerError";
163
+ ErrorCode["RemoteServerTimeout"] = "RemoteServerTimeout";
164
+ ErrorCode["RequestLimitExceeded"] = "RequestLimitExceeded";
165
+ ErrorCode["ResourceNotFound"] = "ResourceNotFound";
166
+ ErrorCode["UserCredentialsInUse"] = "UserCredentialsInUse";
167
+ ErrorCode["AccountEmailInUse"] = "AccountEmailInUse";
168
+ ErrorCode["IncompatibleState"] = "IncompatibleState";
169
+ ErrorCode["VersionConflict"] = "VersionConflict";
170
+ ErrorCode["UnspecifiedError"] = "UnspecifiedError";
171
+ })(ErrorCode || (exports.ErrorCode = ErrorCode = {}));
140
172
  var EventAction;
141
173
  (function (EventAction) {
142
174
  EventAction["Created"] = "created";
@@ -235,6 +267,15 @@ var TemplateUseCase;
235
267
  TemplateUseCase["Display"] = "display";
236
268
  TemplateUseCase["Direct"] = "direct";
237
269
  })(TemplateUseCase || (exports.TemplateUseCase = TemplateUseCase = {}));
270
+ var VolleyballSet;
271
+ (function (VolleyballSet) {
272
+ VolleyballSet["Pre"] = "pregame";
273
+ VolleyballSet["First"] = "1";
274
+ VolleyballSet["Second"] = "2";
275
+ VolleyballSet["Third"] = "3";
276
+ VolleyballSet["Fourth"] = "4";
277
+ VolleyballSet["Fifth"] = "5";
278
+ })(VolleyballSet || (exports.VolleyballSet = VolleyballSet = {}));
238
279
  var WebsocketMessageType;
239
280
  (function (WebsocketMessageType) {
240
281
  WebsocketMessageType["Event"] = "event";
package/dist/index.d.ts CHANGED
@@ -11,37 +11,6 @@ export declare const isFootballData: (data: any) => data is FootballDataResponse
11
11
  export declare const isSoccerData: (data: any) => data is SoccerDataResponse;
12
12
  export declare const isVolleyballData: (data: any) => data is VolleyballDataResponse;
13
13
  export declare const isWrestlingData: (data: any) => data is WrestlingDataResponse;
14
- export declare enum ErrorCode {
15
- ForbiddenSelfPermissionsChange = "ForbiddenSelfPermissionsChange",
16
- InsufficientAdminPermissions = "InsufficientAdminPermissions",
17
- InsufficientItemPermissions = "InsufficientItemPermissions",
18
- InsufficientResourcePermissions = "InsufficientResourcePermissions",
19
- InsufficientResourceItemPermissions = "InsufficientResourceItemPermissions",
20
- InvalidAuthType = "InvalidAuthType",
21
- InvalidColorFormat = "InvalidColorFormat",
22
- InvalidDate = "InvalidDate",
23
- InvalidInput = "InvalidInput",
24
- InvalidRequest = "InvalidRequest",
25
- InvalidPermissionGrant = "InvalidPermissionGrant",
26
- InvalidSignIn = "InvalidSignIn",
27
- InvalidAccountSignIn = "InvalidAccountSignIn",
28
- InvalidToken = "InvalidToken",
29
- AccountLimitExceeded = "AccountLimitExceeded",
30
- AccountStorageExceeded = "AccountStorageExceeded",
31
- ActiveScoreboardsExceeded = "ActiveScoreboardsExceeded",
32
- AccountFeatureNotEnabled = "AccountFeatureNotEnabled",
33
- AppNotEnabled = "AppNotEnabled",
34
- ImageProcessingError = "ImageProcessingError",
35
- RemoteServerError = "RemoteServerError",
36
- RemoteServerTimeout = "RemoteServerTimeout",
37
- RequestLimitExceeded = "RequestLimitExceeded",
38
- ResourceNotFound = "ResourceNotFound",
39
- UserCredentialsInUse = "UserCredentialsInUse",
40
- AccountEmailInUse = "AccountEmailInUse",
41
- IncompatibleState = "IncompatibleState",
42
- VersionConflict = "VersionConflict",
43
- UnspecifiedError = "UnspecifiedError"
44
- }
45
14
  export declare enum ApiAction {
46
15
  Create = "create",
47
16
  Read = "read",
@@ -136,6 +105,37 @@ export declare enum DownAndDistanceDisplay {
136
105
  DownOnly = "downOnly",
137
106
  None = "none"
138
107
  }
108
+ export declare enum ErrorCode {
109
+ ForbiddenSelfPermissionsChange = "ForbiddenSelfPermissionsChange",
110
+ InsufficientAdminPermissions = "InsufficientAdminPermissions",
111
+ InsufficientItemPermissions = "InsufficientItemPermissions",
112
+ InsufficientResourcePermissions = "InsufficientResourcePermissions",
113
+ InsufficientResourceItemPermissions = "InsufficientResourceItemPermissions",
114
+ InvalidAuthType = "InvalidAuthType",
115
+ InvalidColorFormat = "InvalidColorFormat",
116
+ InvalidDate = "InvalidDate",
117
+ InvalidInput = "InvalidInput",
118
+ InvalidRequest = "InvalidRequest",
119
+ InvalidPermissionGrant = "InvalidPermissionGrant",
120
+ InvalidSignIn = "InvalidSignIn",
121
+ InvalidAccountSignIn = "InvalidAccountSignIn",
122
+ InvalidToken = "InvalidToken",
123
+ AccountLimitExceeded = "AccountLimitExceeded",
124
+ AccountStorageExceeded = "AccountStorageExceeded",
125
+ ActiveScoreboardsExceeded = "ActiveScoreboardsExceeded",
126
+ AccountFeatureNotEnabled = "AccountFeatureNotEnabled",
127
+ AppNotEnabled = "AppNotEnabled",
128
+ ImageProcessingError = "ImageProcessingError",
129
+ RemoteServerError = "RemoteServerError",
130
+ RemoteServerTimeout = "RemoteServerTimeout",
131
+ RequestLimitExceeded = "RequestLimitExceeded",
132
+ ResourceNotFound = "ResourceNotFound",
133
+ UserCredentialsInUse = "UserCredentialsInUse",
134
+ AccountEmailInUse = "AccountEmailInUse",
135
+ IncompatibleState = "IncompatibleState",
136
+ VersionConflict = "VersionConflict",
137
+ UnspecifiedError = "UnspecifiedError"
138
+ }
139
139
  export declare enum EventAction {
140
140
  Created = "created",
141
141
  Updated = "updated",
@@ -220,6 +220,14 @@ export declare enum TemplateUseCase {
220
220
  Display = "display",
221
221
  Direct = "direct"
222
222
  }
223
+ export declare enum VolleyballSet {
224
+ Pre = "pregame",
225
+ First = "1",
226
+ Second = "2",
227
+ Third = "3",
228
+ Fourth = "4",
229
+ Fifth = "5"
230
+ }
223
231
  export declare enum WebsocketMessageType {
224
232
  Event = "event",
225
233
  Heartbeat = "heartbeat",
@@ -417,6 +425,7 @@ export interface BaseballSettings extends ScoreboardSettingsBase {
417
425
  showPitchClock: boolean;
418
426
  showPitchClockWhenLow: boolean;
419
427
  enableClockAutomations: boolean;
428
+ innings: number;
420
429
  }
421
430
  export interface BaseballSettingsRequest extends BaseballSettings {
422
431
  }
@@ -493,6 +502,11 @@ export interface CheckoutSessionResponse {
493
502
  sessionId: string;
494
503
  redirectUrl: string;
495
504
  }
505
+ export interface ClientConfigResponse {
506
+ websocketUrl: string;
507
+ signInUrl: string;
508
+ dashboardUrl: string;
509
+ }
496
510
  export interface Clock {
497
511
  clockId: string;
498
512
  scoreboardId: string;
@@ -674,6 +688,10 @@ export interface NumberInput extends BaseInput {
674
688
  export interface OAuthBindingRequest {
675
689
  messageCipher: string;
676
690
  }
691
+ export interface OAuthRequest {
692
+ code: string;
693
+ redirectUri: string;
694
+ }
677
695
  export interface OAuthResponse {
678
696
  auth?: AuthResponse;
679
697
  userCredentials?: UserCredentialsResponse;
@@ -868,6 +886,8 @@ export interface ScoreboardResponse {
868
886
  description: string;
869
887
  controlUrl: string;
870
888
  embedUrl: string;
889
+ displayUrl: string;
890
+ directUrl: string;
871
891
  type: ScoreboardType;
872
892
  data: BasketballDataResponse | FootballDataResponse | VolleyballDataResponse | SoccerDataResponse | BaseballDataResponse | WrestlingDataResponse;
873
893
  accountId: string;
@@ -1145,14 +1165,14 @@ export interface UserUpdateRequest {
1145
1165
  permissions?: Permissions;
1146
1166
  }
1147
1167
  export interface VolleyballDataRequest {
1148
- set: number | null;
1168
+ set: VolleyballSet;
1149
1169
  team1: VolleyballScoreboardTeamRequest;
1150
1170
  team2: VolleyballScoreboardTeamRequest;
1151
1171
  settings?: VolleyballSettingsRequest;
1152
1172
  }
1153
1173
  export interface VolleyballDataResponse {
1154
1174
  type: ScoreboardType;
1155
- set: number | null;
1175
+ set: VolleyballSet;
1156
1176
  team1: VolleyballScoreboardTeamResponse;
1157
1177
  team2: VolleyballScoreboardTeamResponse;
1158
1178
  settings: VolleyballSettingsResponse;
@@ -1201,23 +1221,8 @@ export interface WebsocketMessage {
1201
1221
  message: string;
1202
1222
  data: Event | MetaMessage | WebsocketConnectionIdResponse | null;
1203
1223
  }
1204
- export interface WebsocketScoreboardSubscriptionRequest {
1205
- action: "sendmessage";
1206
- operation: WebsocketOperation.SubscribeScoreboard | WebsocketOperation.UnsubscribeScoreboard;
1207
- scoreboardId: string;
1208
- appId?: string;
1209
- sendInitialData?: boolean;
1210
- token: string;
1211
- }
1212
- export interface WebsocketScoreboardSubscriptionResponse {
1213
- operation: WebsocketOperation.SubscribeScoreboard | WebsocketOperation.UnsubscribeScoreboard;
1214
- scoreboardId: string;
1215
- appId?: string;
1216
- error?: ErrorResponse;
1217
- }
1218
1224
  export interface WebsocketSubscriptionRequest {
1219
1225
  connectionId: string;
1220
- appId?: string;
1221
1226
  sendInitialData?: boolean;
1222
1227
  }
1223
1228
  export interface WebsocketSubscriptionResponse {
@@ -1225,7 +1230,6 @@ export interface WebsocketSubscriptionResponse {
1225
1230
  subscriptionResource: string;
1226
1231
  subscriptionResourceUri: string;
1227
1232
  accountId: string;
1228
- appId?: string;
1229
1233
  }
1230
1234
  export interface WrestlingDataRequest {
1231
1235
  period: WrestlingPeriod;
package/dist/index.mjs CHANGED
@@ -128,6 +128,38 @@ export var DownAndDistanceDisplay;
128
128
  DownAndDistanceDisplay["DownOnly"] = "downOnly";
129
129
  DownAndDistanceDisplay["None"] = "none";
130
130
  })(DownAndDistanceDisplay || (DownAndDistanceDisplay = {}));
131
+ export var ErrorCode;
132
+ (function (ErrorCode) {
133
+ ErrorCode["ForbiddenSelfPermissionsChange"] = "ForbiddenSelfPermissionsChange";
134
+ ErrorCode["InsufficientAdminPermissions"] = "InsufficientAdminPermissions";
135
+ ErrorCode["InsufficientItemPermissions"] = "InsufficientItemPermissions";
136
+ ErrorCode["InsufficientResourcePermissions"] = "InsufficientResourcePermissions";
137
+ ErrorCode["InsufficientResourceItemPermissions"] = "InsufficientResourceItemPermissions";
138
+ ErrorCode["InvalidAuthType"] = "InvalidAuthType";
139
+ ErrorCode["InvalidColorFormat"] = "InvalidColorFormat";
140
+ ErrorCode["InvalidDate"] = "InvalidDate";
141
+ ErrorCode["InvalidInput"] = "InvalidInput";
142
+ ErrorCode["InvalidRequest"] = "InvalidRequest";
143
+ ErrorCode["InvalidPermissionGrant"] = "InvalidPermissionGrant";
144
+ ErrorCode["InvalidSignIn"] = "InvalidSignIn";
145
+ ErrorCode["InvalidAccountSignIn"] = "InvalidAccountSignIn";
146
+ ErrorCode["InvalidToken"] = "InvalidToken";
147
+ ErrorCode["AccountLimitExceeded"] = "AccountLimitExceeded";
148
+ ErrorCode["AccountStorageExceeded"] = "AccountStorageExceeded";
149
+ ErrorCode["ActiveScoreboardsExceeded"] = "ActiveScoreboardsExceeded";
150
+ ErrorCode["AccountFeatureNotEnabled"] = "AccountFeatureNotEnabled";
151
+ ErrorCode["AppNotEnabled"] = "AppNotEnabled";
152
+ ErrorCode["ImageProcessingError"] = "ImageProcessingError";
153
+ ErrorCode["RemoteServerError"] = "RemoteServerError";
154
+ ErrorCode["RemoteServerTimeout"] = "RemoteServerTimeout";
155
+ ErrorCode["RequestLimitExceeded"] = "RequestLimitExceeded";
156
+ ErrorCode["ResourceNotFound"] = "ResourceNotFound";
157
+ ErrorCode["UserCredentialsInUse"] = "UserCredentialsInUse";
158
+ ErrorCode["AccountEmailInUse"] = "AccountEmailInUse";
159
+ ErrorCode["IncompatibleState"] = "IncompatibleState";
160
+ ErrorCode["VersionConflict"] = "VersionConflict";
161
+ ErrorCode["UnspecifiedError"] = "UnspecifiedError";
162
+ })(ErrorCode || (ErrorCode = {}));
131
163
  export var EventAction;
132
164
  (function (EventAction) {
133
165
  EventAction["Created"] = "created";
@@ -226,6 +258,15 @@ export var TemplateUseCase;
226
258
  TemplateUseCase["Display"] = "display";
227
259
  TemplateUseCase["Direct"] = "direct";
228
260
  })(TemplateUseCase || (TemplateUseCase = {}));
261
+ export var VolleyballSet;
262
+ (function (VolleyballSet) {
263
+ VolleyballSet["Pre"] = "pregame";
264
+ VolleyballSet["First"] = "1";
265
+ VolleyballSet["Second"] = "2";
266
+ VolleyballSet["Third"] = "3";
267
+ VolleyballSet["Fourth"] = "4";
268
+ VolleyballSet["Fifth"] = "5";
269
+ })(VolleyballSet || (VolleyballSet = {}));
229
270
  export var WebsocketMessageType;
230
271
  (function (WebsocketMessageType) {
231
272
  WebsocketMessageType["Event"] = "event";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@scoreboardmax/api-types",
3
- "version": "1.0.24",
3
+ "version": "1.0.26",
4
4
  "description": "TypeScript definitions for ScoreboardMax API",
5
5
  "main": "./dist/index.cjs",
6
6
  "module": "./dist/index.mjs",