@victorycode/sdk 0.0.0-stage → 1.0.0

package/docs/FumbleStatsDto.md

@@ -0,0 +1,44 @@
+
+# FumbleStatsDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`playerName` | string
+`jerseyNumber` | number
+`playerId` | string
+`fumbles` | number
+`lost` | number
+`recovered` | number
+
+## Example
+
+```typescript
+import type { FumbleStatsDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "playerName": Josh Jacobs,
+  "jerseyNumber": 8,
+  "playerId": rb26,
+  "fumbles": 1,
+  "lost": 0,
+  "recovered": 0,
+} satisfies FumbleStatsDto
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FumbleStatsDto
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/FumbleTotalsDto.md

@@ -0,0 +1,38 @@
+
+# FumbleTotalsDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`fumbles` | number
+`lost` | number
+`recovered` | number
+
+## Example
+
+```typescript
+import type { FumbleTotalsDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "fumbles": 1,
+  "lost": 0,
+  "recovered": 0,
+} satisfies FumbleTotalsDto
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FumbleTotalsDto
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GameAllPlayListItemDto.md

@@ -0,0 +1,44 @@
+
+# GameAllPlayListItemDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`playId` | string
+`playNumber` | number
+`clip` | [PlayClipListDetailsDto](PlayClipListDetailsDto.md)
+`attributes` | [PlayAttributesListDto](PlayAttributesListDto.md)
+`events` | Array<object>
+`videoId` | string
+
+## Example
+
+```typescript
+import type { GameAllPlayListItemDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "playId": play-id,
+  "playNumber": 1,
+  "clip": null,
+  "attributes": null,
+  "events": [],
+  "videoId": video-id,
+} satisfies GameAllPlayListItemDto
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GameAllPlayListItemDto
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GameBoxScoreMetaDto.md

@@ -0,0 +1,50 @@
+
+# GameBoxScoreMetaDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`gameId` | string
+`gameTitle` | string
+`videoId` | string
+`viewType` | string
+`homeTeam` | string
+`awayTeam` | string
+`homeScore` | number
+`awayScore` | number
+`generatedAt` | string
+
+## Example
+
+```typescript
+import type { GameBoxScoreMetaDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "gameId": 69e726ec40948bc7f421f3ba,
+  "gameTitle": Green Bay Packers vs Philadelphia Eagles,
+  "videoId": 69e726ec40948bc7f421f3ba,
+  "viewType": All-22 Sideline,
+  "homeTeam": Green Bay Packers,
+  "awayTeam": Philadelphia Eagles,
+  "homeScore": 20,
+  "awayScore": 34,
+  "generatedAt": 2025-07-14T10:30:00.000Z,
+} satisfies GameBoxScoreMetaDto
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GameBoxScoreMetaDto
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GameBoxScoreResponseDto.md

@@ -0,0 +1,36 @@
+
+# GameBoxScoreResponseDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`meta` | [GameBoxScoreMetaDto](GameBoxScoreMetaDto.md)
+`teams` | [GameBoxScoreTeamsDto](GameBoxScoreTeamsDto.md)
+
+## Example
+
+```typescript
+import type { GameBoxScoreResponseDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "meta": null,
+  "teams": null,
+} satisfies GameBoxScoreResponseDto
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GameBoxScoreResponseDto
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GameBoxScoreTeamsDto.md

@@ -0,0 +1,36 @@
+
+# GameBoxScoreTeamsDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`home` | [TeamBoxScoreDto](TeamBoxScoreDto.md)
+`away` | [TeamBoxScoreDto](TeamBoxScoreDto.md)
+
+## Example
+
+```typescript
+import type { GameBoxScoreTeamsDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "home": null,
+  "away": null,
+} satisfies GameBoxScoreTeamsDto
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GameBoxScoreTeamsDto
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GameDetailsResponse.md

@@ -0,0 +1,46 @@
+
+# GameDetailsResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`gameName` | string
+`dateTime` | Date
+`gameId` | string
+`sourceId` | string
+`venue` | string
+`homeTeam` | [TeamBasicInfoDto](TeamBasicInfoDto.md)
+`awayTeam` | [TeamBasicInfoDto](TeamBasicInfoDto.md)
+
+## Example
+
+```typescript
+import type { GameDetailsResponse } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "gameName": Final Game,
+  "dateTime": 2026-03-10T10:30Z,
+  "gameId": game-id,
+  "sourceId": Game#20260310,
+  "venue": Revolutionary Field,
+  "homeTeam": null,
+  "awayTeam": null,
+} satisfies GameDetailsResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GameDetailsResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GameRecapApi.md

@@ -0,0 +1,393 @@
+# GameRecapApi
+
+All URIs are relative to *https://sandbox.api.tactixai.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getGameRecapGameBoxScore**](GameRecapApi.md#getgamerecapgameboxscore) | **GET** /api/v1/client/game-recap/{videoId}/game-box-score | Get the Game Recap Game Box Score for a specific Game. |
+| [**getGameRecapScore**](GameRecapApi.md#getgamerecapscore) | **GET** /api/v1/client/game-recap/{videoId}/score | Get the Game Recap Score for a specific Game. |
+| [**getGameRecapScoringSummary**](GameRecapApi.md#getgamerecapscoringsummary) | **GET** /api/v1/client/game-recap/{videoId}/scoring-summary | Get the Game Recap Scoring Summary for a specific Game. |
+| [**getGameRecapScoringSummaryPro**](GameRecapApi.md#getgamerecapscoringsummarypro) | **GET** /api/v1/client/game-recap/{videoId}/scoring-summary-pro | Get the Game Recap Scoring Summary Pro for a specific Game. |
+| [**getGameRecapTeamStats**](GameRecapApi.md#getgamerecapteamstats) | **GET** /api/v1/client/game-recap/{videoId}/team-stats | Get the Game Recap Team Stats for a specific Game. |
+
+
+
+## getGameRecapGameBoxScore
+
+> GameBoxScoreResponseDto getGameRecapGameBoxScore(videoId)
+
+Get the Game Recap Game Box Score for a specific Game.
+
+Retrieves full game box score stats for both teams and players for a specific game.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  GameRecapApi,
+} from '@victorycode/sdk';
+import type { GetGameRecapGameBoxScoreRequest } from '@victorycode/sdk';
+
+async function example() {
+  console.log("🚀 Testing @victorycode/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: Client-App-Token
+    accessToken: "YOUR BEARER TOKEN",
+    // To configure API key authorization: Client-App-Id
+    apiKey: "YOUR API KEY",
+  });
+  const api = new GameRecapApi(config);
+
+  const body = {
+    // string
+    videoId: videoId_example,
+  } satisfies GetGameRecapGameBoxScoreRequest;
+
+  try {
+    const data = await api.getGameRecapGameBoxScore(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **videoId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GameBoxScoreResponseDto**](GameBoxScoreResponseDto.md)
+
+### Authorization
+
+[Client-App-Token](../README.md#Client-App-Token), [Client-App-Id](../README.md#Client-App-Id)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful retrieval of the Game Recap Game Box Score |  -  |
+| **400** | Bad Request |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | Not Found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getGameRecapScore
+
+> GameScoreResponse getGameRecapScore(videoId)
+
+Get the Game Recap Score for a specific Game.
+
+Retrieves the final score and the score breakdown by quarter and overtime periods for both the home and away teams.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  GameRecapApi,
+} from '@victorycode/sdk';
+import type { GetGameRecapScoreRequest } from '@victorycode/sdk';
+
+async function example() {
+  console.log("🚀 Testing @victorycode/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: Client-App-Token
+    accessToken: "YOUR BEARER TOKEN",
+    // To configure API key authorization: Client-App-Id
+    apiKey: "YOUR API KEY",
+  });
+  const api = new GameRecapApi(config);
+
+  const body = {
+    // string
+    videoId: videoId_example,
+  } satisfies GetGameRecapScoreRequest;
+
+  try {
+    const data = await api.getGameRecapScore(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **videoId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GameScoreResponse**](GameScoreResponse.md)
+
+### Authorization
+
+[Client-App-Token](../README.md#Client-App-Token), [Client-App-Id](../README.md#Client-App-Id)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful retrieval of the Game Recap Score. |  -  |
+| **400** | Bad Request |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | Not Found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getGameRecapScoringSummary
+
+> GameRecapScoringSummaryResponse getGameRecapScoringSummary(videoId)
+
+Get the Game Recap Scoring Summary for a specific Game.
+
+Retrieves a chronological list of all scoring plays for a specific game, including details about the play, the drive, and the resulting score.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  GameRecapApi,
+} from '@victorycode/sdk';
+import type { GetGameRecapScoringSummaryRequest } from '@victorycode/sdk';
+
+async function example() {
+  console.log("🚀 Testing @victorycode/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: Client-App-Token
+    accessToken: "YOUR BEARER TOKEN",
+    // To configure API key authorization: Client-App-Id
+    apiKey: "YOUR API KEY",
+  });
+  const api = new GameRecapApi(config);
+
+  const body = {
+    // string
+    videoId: videoId_example,
+  } satisfies GetGameRecapScoringSummaryRequest;
+
+  try {
+    const data = await api.getGameRecapScoringSummary(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **videoId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GameRecapScoringSummaryResponse**](GameRecapScoringSummaryResponse.md)
+
+### Authorization
+
+[Client-App-Token](../README.md#Client-App-Token), [Client-App-Id](../README.md#Client-App-Id)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful retrieval of the Game Recap Scoring Summary |  -  |
+| **400** | Bad Request |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | Not Found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getGameRecapScoringSummaryPro
+
+> GameRecapScoringSummaryProResponse getGameRecapScoringSummaryPro(videoId)
+
+Get the Game Recap Scoring Summary Pro for a specific Game.
+
+Retrieves the full pro scoring summary for a specific game with drive context and players involved for each scoring play.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  GameRecapApi,
+} from '@victorycode/sdk';
+import type { GetGameRecapScoringSummaryProRequest } from '@victorycode/sdk';
+
+async function example() {
+  console.log("🚀 Testing @victorycode/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: Client-App-Token
+    accessToken: "YOUR BEARER TOKEN",
+    // To configure API key authorization: Client-App-Id
+    apiKey: "YOUR API KEY",
+  });
+  const api = new GameRecapApi(config);
+
+  const body = {
+    // string
+    videoId: videoId_example,
+  } satisfies GetGameRecapScoringSummaryProRequest;
+
+  try {
+    const data = await api.getGameRecapScoringSummaryPro(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **videoId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GameRecapScoringSummaryProResponse**](GameRecapScoringSummaryProResponse.md)
+
+### Authorization
+
+[Client-App-Token](../README.md#Client-App-Token), [Client-App-Id](../README.md#Client-App-Id)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful retrieval of the Game Recap Scoring Summary Pro |  -  |
+| **400** | Bad Request |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | Not Found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getGameRecapTeamStats
+
+> GameRecapTeamStatsResponse getGameRecapTeamStats(videoId)
+
+Get the Game Recap Team Stats for a specific Game.
+
+Retrieves a detailed statistical breakdown for both the home and away teams, covering offense, defense, and special teams performance.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  GameRecapApi,
+} from '@victorycode/sdk';
+import type { GetGameRecapTeamStatsRequest } from '@victorycode/sdk';
+
+async function example() {
+  console.log("🚀 Testing @victorycode/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: Client-App-Token
+    accessToken: "YOUR BEARER TOKEN",
+    // To configure API key authorization: Client-App-Id
+    apiKey: "YOUR API KEY",
+  });
+  const api = new GameRecapApi(config);
+
+  const body = {
+    // string
+    videoId: videoId_example,
+  } satisfies GetGameRecapTeamStatsRequest;
+
+  try {
+    const data = await api.getGameRecapTeamStats(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **videoId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**GameRecapTeamStatsResponse**](GameRecapTeamStatsResponse.md)
+
+### Authorization
+
+[Client-App-Token](../README.md#Client-App-Token), [Client-App-Id](../README.md#Client-App-Id)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | a detailed statistical breakdown for both teams |  -  |
+| **400** | Bad Request |  -  |
+| **401** | Unauthorized |  -  |
+| **404** | Not Found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+