@scoreboardmax/api-types 1.0.34-next.15 → 1.0.34-next.16

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.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.FileType = exports.ContentType = exports.ExtraTimeLabel = exports.EventAction = exports.DownAndDistanceDisplay = exports.DisplayConnectionStatus = exports.ClockType = exports.BasketballTimeoutAllocation = exports.BasketballGamePeriods = exports.BasketballPeriod = exports.PlanId = exports.AuthType = exports.AppType = exports.ApiResource = exports.ApiAction = void 0;
10
+ 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;
11
11
  /**
12
12
  * API action identifiers
13
13
  */
@@ -148,6 +148,14 @@ var DownAndDistanceDisplay;
148
148
  DownAndDistanceDisplay["DownOnly"] = "downOnly";
149
149
  DownAndDistanceDisplay["None"] = "none";
150
150
  })(DownAndDistanceDisplay || (exports.DownAndDistanceDisplay = DownAndDistanceDisplay = {}));
151
+ /**
152
+ * Energy level for talking points generation
153
+ */
154
+ var TalkingPointEnergy;
155
+ (function (TalkingPointEnergy) {
156
+ TalkingPointEnergy["Standard"] = "standard";
157
+ TalkingPointEnergy["Hype"] = "hype";
158
+ })(TalkingPointEnergy || (exports.TalkingPointEnergy = TalkingPointEnergy = {}));
151
159
  /**
152
160
  * Event action identifiers
153
161
  */
@@ -192,6 +200,15 @@ var FileType;
192
200
  FileType["InsightLogo"] = "insightLogo";
193
201
  FileType["Temporary"] = "temporary";
194
202
  })(FileType || (exports.FileType = FileType = {}));
203
+ /**
204
+ * Focus area for talking points generation
205
+ */
206
+ var TalkingPointFocus;
207
+ (function (TalkingPointFocus) {
208
+ TalkingPointFocus["Story"] = "story";
209
+ TalkingPointFocus["Balanced"] = "balanced";
210
+ TalkingPointFocus["Stats"] = "stats";
211
+ })(TalkingPointFocus || (exports.TalkingPointFocus = TalkingPointFocus = {}));
195
212
  /**
196
213
  * Football period identifiers
197
214
  */
package/dist/index.d.ts CHANGED
@@ -31,6 +31,15 @@ export interface AccountResponse {
31
31
  subscriptionId: string | null;
32
32
  token?: string;
33
33
  }
34
+ /**
35
+ * AI-generated talking points for a game
36
+ */
37
+ export interface TalkingPointsResponse {
38
+ /** Each element is a discrete talking point */
39
+ content: string[];
40
+ /** When the talking points were generated (ISO 8601) */
41
+ dateCreated: string;
42
+ }
34
43
  /**
35
44
  * API action identifiers
36
45
  */
@@ -208,6 +217,16 @@ export interface BaseInput {
208
217
  description?: string;
209
218
  default: any;
210
219
  }
220
+ /**
221
+ * Base insight team response shared across sports
222
+ */
223
+ export interface InsightTeamBaseResponse {
224
+ name: string;
225
+ abbreviation: string;
226
+ color: string;
227
+ logoUrl: string | null;
228
+ reference: string;
229
+ }
211
230
  /**
212
231
  * Base settings shared across sports
213
232
  */
@@ -410,11 +429,7 @@ export interface BasketballSettings extends ScoreboardSettingsBase {
410
429
  /**
411
430
  * Basketball insight team statistics
412
431
  */
413
- export interface BasketballInsightTeamResponse {
414
- name: string;
415
- abbreviation: string;
416
- color: string;
417
- logoUrl: string | null;
432
+ export interface BasketballInsightTeamResponse extends InsightTeamBaseResponse {
418
433
  score: number;
419
434
  }
420
435
  /**
@@ -695,6 +710,13 @@ export declare enum DownAndDistanceDisplay {
695
710
  DownOnly = "downOnly",
696
711
  None = "none"
697
712
  }
713
+ /**
714
+ * Energy level for talking points generation
715
+ */
716
+ export declare enum TalkingPointEnergy {
717
+ Standard = "standard",
718
+ Hype = "hype"
719
+ }
698
720
  /**
699
721
  * Event action identifiers
700
722
  */
@@ -784,6 +806,14 @@ export declare enum FileType {
784
806
  InsightLogo = "insightLogo",
785
807
  Temporary = "temporary"
786
808
  }
809
+ /**
810
+ * Focus area for talking points generation
811
+ */
812
+ export declare enum TalkingPointFocus {
813
+ Story = "story",
814
+ Balanced = "balanced",
815
+ Stats = "stats"
816
+ }
787
817
  /**
788
818
  * Football game data request
789
819
  */
@@ -893,6 +923,7 @@ export interface InsightResponse {
893
923
  dateGameEnd?: string;
894
924
  qualityScore: number;
895
925
  data: BasketballInsightResponse;
926
+ talkingPoints: TalkingPointsResponse[];
896
927
  }
897
928
  /**
898
929
  * Game record response
@@ -1207,6 +1238,19 @@ export interface PlayerSummaryResponse {
1207
1238
  imageMediumUrl: string | null;
1208
1239
  reference: string;
1209
1240
  }
1241
+ /**
1242
+ * Preferences for tuning AI-generated talking points
1243
+ */
1244
+ export interface TalkingPointPreferencesRequest {
1245
+ /** Browser locale code (e.g., "en-US", "es-MX"). When set, talking points are generated in this language. */
1246
+ language?: string;
1247
+ /** Team reference from the insight document. When set, commentary is framed from that team's perspective. */
1248
+ teamPerspective?: string;
1249
+ /** Energy level: "standard" for neutral commentary, "hype" for excited, emphatic language. */
1250
+ energy?: TalkingPointEnergy;
1251
+ /** Focus area: "story" for narrative, "balanced" for even coverage, "stats" for statistical analysis. */
1252
+ focus?: TalkingPointFocus;
1253
+ }
1210
1254
  /**
1211
1255
  * Preset creation/update request
1212
1256
  */
package/dist/index.mjs CHANGED
@@ -145,6 +145,14 @@ export var DownAndDistanceDisplay;
145
145
  DownAndDistanceDisplay["DownOnly"] = "downOnly";
146
146
  DownAndDistanceDisplay["None"] = "none";
147
147
  })(DownAndDistanceDisplay || (DownAndDistanceDisplay = {}));
148
+ /**
149
+ * Energy level for talking points generation
150
+ */
151
+ export var TalkingPointEnergy;
152
+ (function (TalkingPointEnergy) {
153
+ TalkingPointEnergy["Standard"] = "standard";
154
+ TalkingPointEnergy["Hype"] = "hype";
155
+ })(TalkingPointEnergy || (TalkingPointEnergy = {}));
148
156
  /**
149
157
  * Event action identifiers
150
158
  */
@@ -189,6 +197,15 @@ export var FileType;
189
197
  FileType["InsightLogo"] = "insightLogo";
190
198
  FileType["Temporary"] = "temporary";
191
199
  })(FileType || (FileType = {}));
200
+ /**
201
+ * Focus area for talking points generation
202
+ */
203
+ export var TalkingPointFocus;
204
+ (function (TalkingPointFocus) {
205
+ TalkingPointFocus["Story"] = "story";
206
+ TalkingPointFocus["Balanced"] = "balanced";
207
+ TalkingPointFocus["Stats"] = "stats";
208
+ })(TalkingPointFocus || (TalkingPointFocus = {}));
192
209
  /**
193
210
  * Football period identifiers
194
211
  */
package/dist/internal.cjs CHANGED
@@ -10,7 +10,7 @@
10
10
  *
11
11
  */
12
12
  Object.defineProperty(exports, "__esModule", { value: true });
13
- 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.FileType = exports.ContentType = exports.ExtraTimeLabel = exports.EventAction = exports.DownAndDistanceDisplay = exports.DisplayConnectionStatus = exports.ClockType = exports.BasketballTimeoutAllocation = exports.BasketballGamePeriods = exports.BasketballPeriod = exports.PlanId = exports.AuthType = exports.AppType = exports.ApiResource = exports.ApiAction = void 0;
13
+ 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;
14
14
  /**
15
15
  * API action identifiers
16
16
  */
@@ -151,6 +151,14 @@ var DownAndDistanceDisplay;
151
151
  DownAndDistanceDisplay["DownOnly"] = "downOnly";
152
152
  DownAndDistanceDisplay["None"] = "none";
153
153
  })(DownAndDistanceDisplay || (exports.DownAndDistanceDisplay = DownAndDistanceDisplay = {}));
154
+ /**
155
+ * Energy level for talking points generation
156
+ */
157
+ var TalkingPointEnergy;
158
+ (function (TalkingPointEnergy) {
159
+ TalkingPointEnergy["Standard"] = "standard";
160
+ TalkingPointEnergy["Hype"] = "hype";
161
+ })(TalkingPointEnergy || (exports.TalkingPointEnergy = TalkingPointEnergy = {}));
154
162
  /**
155
163
  * Event action identifiers
156
164
  */
@@ -195,6 +203,15 @@ var FileType;
195
203
  FileType["InsightLogo"] = "insightLogo";
196
204
  FileType["Temporary"] = "temporary";
197
205
  })(FileType || (exports.FileType = FileType = {}));
206
+ /**
207
+ * Focus area for talking points generation
208
+ */
209
+ var TalkingPointFocus;
210
+ (function (TalkingPointFocus) {
211
+ TalkingPointFocus["Story"] = "story";
212
+ TalkingPointFocus["Balanced"] = "balanced";
213
+ TalkingPointFocus["Stats"] = "stats";
214
+ })(TalkingPointFocus || (exports.TalkingPointFocus = TalkingPointFocus = {}));
198
215
  /**
199
216
  * Football period identifiers
200
217
  */
@@ -41,6 +41,15 @@ export interface AccountResponseAdmin extends AccountResponse {
41
41
  paymentProvider: string | null;
42
42
  paymentProviderCustomerId: string | null;
43
43
  }
44
+ /**
45
+ * AI-generated talking points for a game
46
+ */
47
+ export interface TalkingPointsResponse {
48
+ /** Each element is a discrete talking point */
49
+ content: string[];
50
+ /** When the talking points were generated (ISO 8601) */
51
+ dateCreated: string;
52
+ }
44
53
  /**
45
54
  * API action identifiers
46
55
  */
@@ -231,6 +240,16 @@ export interface BaseInput {
231
240
  description?: string;
232
241
  default: any;
233
242
  }
243
+ /**
244
+ * Base insight team response shared across sports
245
+ */
246
+ export interface InsightTeamBaseResponse {
247
+ name: string;
248
+ abbreviation: string;
249
+ color: string;
250
+ logoUrl: string | null;
251
+ reference: string;
252
+ }
234
253
  /**
235
254
  * Base settings shared across sports
236
255
  */
@@ -433,11 +452,7 @@ export interface BasketballSettings extends ScoreboardSettingsBase {
433
452
  /**
434
453
  * Basketball insight team statistics
435
454
  */
436
- export interface BasketballInsightTeamResponse {
437
- name: string;
438
- abbreviation: string;
439
- color: string;
440
- logoUrl: string | null;
455
+ export interface BasketballInsightTeamResponse extends InsightTeamBaseResponse {
441
456
  score: number;
442
457
  }
443
458
  /**
@@ -718,6 +733,13 @@ export declare enum DownAndDistanceDisplay {
718
733
  DownOnly = "downOnly",
719
734
  None = "none"
720
735
  }
736
+ /**
737
+ * Energy level for talking points generation
738
+ */
739
+ export declare enum TalkingPointEnergy {
740
+ Standard = "standard",
741
+ Hype = "hype"
742
+ }
721
743
  /**
722
744
  * Event action identifiers
723
745
  */
@@ -807,6 +829,14 @@ export declare enum FileType {
807
829
  InsightLogo = "insightLogo",
808
830
  Temporary = "temporary"
809
831
  }
832
+ /**
833
+ * Focus area for talking points generation
834
+ */
835
+ export declare enum TalkingPointFocus {
836
+ Story = "story",
837
+ Balanced = "balanced",
838
+ Stats = "stats"
839
+ }
810
840
  /**
811
841
  * Football game data request
812
842
  */
@@ -916,6 +946,7 @@ export interface InsightResponse {
916
946
  dateGameEnd?: string;
917
947
  qualityScore: number;
918
948
  data: BasketballInsightResponse;
949
+ talkingPoints: TalkingPointsResponse[];
919
950
  }
920
951
  /**
921
952
  * Game record response
@@ -1230,6 +1261,19 @@ export interface PlayerSummaryResponse {
1230
1261
  imageMediumUrl: string | null;
1231
1262
  reference: string;
1232
1263
  }
1264
+ /**
1265
+ * Preferences for tuning AI-generated talking points
1266
+ */
1267
+ export interface TalkingPointPreferencesRequest {
1268
+ /** Browser locale code (e.g., "en-US", "es-MX"). When set, talking points are generated in this language. */
1269
+ language?: string;
1270
+ /** Team reference from the insight document. When set, commentary is framed from that team's perspective. */
1271
+ teamPerspective?: string;
1272
+ /** Energy level: "standard" for neutral commentary, "hype" for excited, emphatic language. */
1273
+ energy?: TalkingPointEnergy;
1274
+ /** Focus area: "story" for narrative, "balanced" for even coverage, "stats" for statistical analysis. */
1275
+ focus?: TalkingPointFocus;
1276
+ }
1233
1277
  /**
1234
1278
  * Preset creation/update request
1235
1279
  */
package/dist/internal.mjs CHANGED
@@ -148,6 +148,14 @@ export var DownAndDistanceDisplay;
148
148
  DownAndDistanceDisplay["DownOnly"] = "downOnly";
149
149
  DownAndDistanceDisplay["None"] = "none";
150
150
  })(DownAndDistanceDisplay || (DownAndDistanceDisplay = {}));
151
+ /**
152
+ * Energy level for talking points generation
153
+ */
154
+ export var TalkingPointEnergy;
155
+ (function (TalkingPointEnergy) {
156
+ TalkingPointEnergy["Standard"] = "standard";
157
+ TalkingPointEnergy["Hype"] = "hype";
158
+ })(TalkingPointEnergy || (TalkingPointEnergy = {}));
151
159
  /**
152
160
  * Event action identifiers
153
161
  */
@@ -192,6 +200,15 @@ export var FileType;
192
200
  FileType["InsightLogo"] = "insightLogo";
193
201
  FileType["Temporary"] = "temporary";
194
202
  })(FileType || (FileType = {}));
203
+ /**
204
+ * Focus area for talking points generation
205
+ */
206
+ export var TalkingPointFocus;
207
+ (function (TalkingPointFocus) {
208
+ TalkingPointFocus["Story"] = "story";
209
+ TalkingPointFocus["Balanced"] = "balanced";
210
+ TalkingPointFocus["Stats"] = "stats";
211
+ })(TalkingPointFocus || (TalkingPointFocus = {}));
195
212
  /**
196
213
  * Football period identifiers
197
214
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@scoreboardmax/api-types",
3
- "version": "1.0.34-next.15",
3
+ "version": "1.0.34-next.16",
4
4
  "description": "TypeScript definitions for ScoreboardMax API",
5
5
  "main": "./dist/index.cjs",
6
6
  "module": "./dist/index.mjs",