@victorycode/sdk 0.0.0-stage → 1.0.0

package/docs/PeriodScoreDto.md

@@ -0,0 +1,40 @@
+
+# PeriodScoreDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`period` | number
+`type` | string
+`name` | string
+`score` | number
+
+## Example
+
+```typescript
+import type { PeriodScoreDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "period": null,
+  "type": null,
+  "name": null,
+  "score": null,
+} satisfies PeriodScoreDto
+
+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 PeriodScoreDto
+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/PlayAttributesListDto.md

@@ -0,0 +1,48 @@
+
+# PlayAttributesListDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`period` | string
+`possessionTeamId` | string
+`down` | number
+`distance` | number
+`lineOfScrimmage` | [LineOfScrimmageDto](LineOfScrimmageDto.md)
+`offensivePersonnel` | string
+`defensivePersonnel` | string
+
+## Example
+
+```typescript
+import type { PlayAttributesListDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": Pass,
+  "period": 1,
+  "possessionTeamId": team-id,
+  "down": 1,
+  "distance": 10,
+  "lineOfScrimmage": null,
+  "offensivePersonnel": 12,
+  "defensivePersonnel": 4-2-5,
+} satisfies PlayAttributesListDto
+
+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 PlayAttributesListDto
+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/PlayClipListDetailsDto.md

@@ -0,0 +1,50 @@
+
+# PlayClipListDetailsDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`startTime` | string
+`endTime` | string
+`duration` | string
+`urlOriginal` | string
+`urlAnalyzed` | string
+`urlThumbnail` | string
+`analyzedVideoOriginalJson` | string
+`analyzedVideoRawJson` | string
+`analyzedVideoSummary` | string
+
+## Example
+
+```typescript
+import type { PlayClipListDetailsDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "startTime": 00:01:23,
+  "endTime": 00:01:33,
+  "duration": 00:00:10,
+  "urlOriginal": https://example.com/original.mp4,
+  "urlAnalyzed": https://example.com/analyzed.mp4,
+  "urlThumbnail": https://example.com/thumbnail.jpg,
+  "analyzedVideoOriginalJson": https://example.com/original.json,
+  "analyzedVideoRawJson": https://example.com/raw.json,
+  "analyzedVideoSummary": https://example.com/summary.url,
+} satisfies PlayClipListDetailsDto
+
+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 PlayClipListDetailsDto
+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/PlayClipListItemDto.md

@@ -0,0 +1,42 @@
+
+# PlayClipListItemDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`playId` | string
+`playNumber` | number
+`clip` | [PlayClipListDetailsDto](PlayClipListDetailsDto.md)
+`attributes` | [PlayAttributesListDto](PlayAttributesListDto.md)
+`events` | Array<object>
+
+## Example
+
+```typescript
+import type { PlayClipListItemDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "playId": play-id,
+  "playNumber": 1,
+  "clip": null,
+  "attributes": null,
+  "events": [],
+} satisfies PlayClipListItemDto
+
+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 PlayClipListItemDto
+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/PlaysEventsApi.md

@@ -0,0 +1,275 @@
+# PlaysEventsApi
+
+All URIs are relative to *https://sandbox.api.tactixai.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getPlayById**](PlaysEventsApi.md#getplaybyid) | **GET** /api/v1/client/plays/{playId} | Get the single Play Clip |
+| [**getPlaysOfGame**](PlaysEventsApi.md#getplaysofgame) | **GET** /api/v1/client/game/{gameId}/plays | Get a list of all plays for a game |
+| [**getPlaysOfVideo**](PlaysEventsApi.md#getplaysofvideo) | **GET** /api/v1/client/videos/{videoId}/plays | Get a list of play clips for a video |
+
+
+
+## getPlayById
+
+> PlayClipListItemDto getPlayById(playId)
+
+Get the single Play Clip
+
+Retrieves the complete metadata for a single play clip by its unique ID.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PlaysEventsApi,
+} from '@victorycode/sdk';
+import type { GetPlayByIdRequest } 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 PlaysEventsApi(config);
+
+  const body = {
+    // string
+    playId: playId_example,
+  } satisfies GetPlayByIdRequest;
+
+  try {
+    const data = await api.getPlayById(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **playId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**PlayClipListItemDto**](PlayClipListItemDto.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 play clip details |  -  |
+| **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)
+
+
+## getPlaysOfGame
+
+> ListGameAllPlaysResponseDto getPlaysOfGame(gameId, limit, offset, search, down, distanceZone, playType)
+
+Get a list of all plays for a game
+
+Retrieves a paginated list of all plays for a given game. The results can be filtered by various play attributes.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PlaysEventsApi,
+} from '@victorycode/sdk';
+import type { GetPlaysOfGameRequest } 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 PlaysEventsApi(config);
+
+  const body = {
+    // string
+    gameId: gameId_example,
+    // number | The number of results to return per page. (optional)
+    limit: 8.14,
+    // number | The number of results to skip for pagination. (optional)
+    offset: 8.14,
+    // string (optional)
+    search: search_example,
+    // '1' | '2' | '3' | '4' | Filter by down number (optional)
+    down: 1,
+    // 'SHORT' | 'MEDIUM' | 'LONG' | 'X_LONG' | Filter by distance zone (yards to go) (optional)
+    distanceZone: LONG,
+    // 'RUN' | 'PASS' | 'FIELD_GOAL' | 'KICKOFF' | 'PUNT' | 'EXTRA_POINT' | 'TWO_POINT_CONVERSION' | 'NO_PLAY' | 'UNIDENTIFIABLE' | Filter by analyzed play type (optional)
+    playType: PASS,
+  } satisfies GetPlaysOfGameRequest;
+
+  try {
+    const data = await api.getPlaysOfGame(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **gameId** | `string` |  | [Defaults to `undefined`] |
+| **limit** | `number` | The number of results to return per page. | [Optional] [Defaults to `50`] |
+| **offset** | `number` | The number of results to skip for pagination. | [Optional] [Defaults to `0`] |
+| **search** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **down** | `1`, `2`, `3`, `4` | Filter by down number | [Optional] [Defaults to `undefined`] [Enum: 1, 2, 3, 4] |
+| **distanceZone** | `SHORT`, `MEDIUM`, `LONG`, `X_LONG` | Filter by distance zone (yards to go) | [Optional] [Defaults to `undefined`] [Enum: SHORT, MEDIUM, LONG, X_LONG] |
+| **playType** | `RUN`, `PASS`, `FIELD_GOAL`, `KICKOFF`, `PUNT`, `EXTRA_POINT`, `TWO_POINT_CONVERSION`, `NO_PLAY`, `UNIDENTIFIABLE` | Filter by analyzed play type | [Optional] [Defaults to `undefined`] [Enum: RUN, PASS, FIELD_GOAL, KICKOFF, PUNT, EXTRA_POINT, TWO_POINT_CONVERSION, NO_PLAY, UNIDENTIFIABLE] |
+
+### Return type
+
+[**ListGameAllPlaysResponseDto**](ListGameAllPlaysResponseDto.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 paginated list of plays. |  -  |
+| **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)
+
+
+## getPlaysOfVideo
+
+> ListPlayClipsResponseDto getPlaysOfVideo(videoId, limit, offset, search, down, distanceZone, playType)
+
+Get a list of play clips for a video
+
+Retrieves a paginated list of all play clips for a given video. The results can be filtered by various play attributes.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PlaysEventsApi,
+} from '@victorycode/sdk';
+import type { GetPlaysOfVideoRequest } 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 PlaysEventsApi(config);
+
+  const body = {
+    // string
+    videoId: videoId_example,
+    // number | The number of results to return per page. (optional)
+    limit: 8.14,
+    // number | The number of results to skip for pagination. (optional)
+    offset: 8.14,
+    // string (optional)
+    search: search_example,
+    // '1' | '2' | '3' | '4' | Filter by down number (optional)
+    down: 1,
+    // 'SHORT' | 'MEDIUM' | 'LONG' | 'X_LONG' | Filter by distance zone (yards to go) (optional)
+    distanceZone: LONG,
+    // 'RUN' | 'PASS' | 'FIELD_GOAL' | 'KICKOFF' | 'PUNT' | 'EXTRA_POINT' | 'TWO_POINT_CONVERSION' | 'NO_PLAY' | 'UNIDENTIFIABLE' | Filter by analyzed play type (optional)
+    playType: PASS,
+  } satisfies GetPlaysOfVideoRequest;
+
+  try {
+    const data = await api.getPlaysOfVideo(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`] |
+| **limit** | `number` | The number of results to return per page. | [Optional] [Defaults to `50`] |
+| **offset** | `number` | The number of results to skip for pagination. | [Optional] [Defaults to `0`] |
+| **search** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **down** | `1`, `2`, `3`, `4` | Filter by down number | [Optional] [Defaults to `undefined`] [Enum: 1, 2, 3, 4] |
+| **distanceZone** | `SHORT`, `MEDIUM`, `LONG`, `X_LONG` | Filter by distance zone (yards to go) | [Optional] [Defaults to `undefined`] [Enum: SHORT, MEDIUM, LONG, X_LONG] |
+| **playType** | `RUN`, `PASS`, `FIELD_GOAL`, `KICKOFF`, `PUNT`, `EXTRA_POINT`, `TWO_POINT_CONVERSION`, `NO_PLAY`, `UNIDENTIFIABLE` | Filter by analyzed play type | [Optional] [Defaults to `undefined`] [Enum: RUN, PASS, FIELD_GOAL, KICKOFF, PUNT, EXTRA_POINT, TWO_POINT_CONVERSION, NO_PLAY, UNIDENTIFIABLE] |
+
+### Return type
+
+[**ListPlayClipsResponseDto**](ListPlayClipsResponseDto.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 paginated list of plays. |  -  |
+| **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)
+

package/docs/ProScoringPlayDto.md

@@ -0,0 +1,68 @@
+
+# ProScoringPlayDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`driveNumber` | number
+`drivePlaysCount` | number
+`driveYards` | number
+`driveTimeOfPossession` | string
+`playId` | string
+`teamId` | string
+`team` | [ScoringSummaryProTeamDto](ScoringSummaryProTeamDto.md)
+`period` | number
+`gameClock` | string
+`scoringType` | string
+`scoringMethod` | string
+`tryType` | string
+`tryMethod` | string
+`scoringYardage` | number
+`playersInvolved` | [Array<ScoringPlayPlayerInvolvedDto>](ScoringPlayPlayerInvolvedDto.md)
+`awayTeamScore` | number
+`homeTeamScore` | number
+`scoringText` | string
+
+## Example
+
+```typescript
+import type { ProScoringPlayDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "driveNumber": null,
+  "drivePlaysCount": null,
+  "driveYards": null,
+  "driveTimeOfPossession": null,
+  "playId": null,
+  "teamId": null,
+  "team": null,
+  "period": null,
+  "gameClock": null,
+  "scoringType": null,
+  "scoringMethod": null,
+  "tryType": null,
+  "tryMethod": null,
+  "scoringYardage": null,
+  "playersInvolved": null,
+  "awayTeamScore": null,
+  "homeTeamScore": null,
+  "scoringText": null,
+} satisfies ProScoringPlayDto
+
+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 ProScoringPlayDto
+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/ReceivingSectionDto.md

@@ -0,0 +1,36 @@
+
+# ReceivingSectionDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`players` | [Array<ReceivingStatsDto>](ReceivingStatsDto.md)
+`totals` | [ReceivingTotalsDto](ReceivingTotalsDto.md)
+
+## Example
+
+```typescript
+import type { ReceivingSectionDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "players": null,
+  "totals": null,
+} satisfies ReceivingSectionDto
+
+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 ReceivingSectionDto
+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/ReceivingStatsDto.md

@@ -0,0 +1,50 @@
+
+# ReceivingStatsDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`playerName` | string
+`jerseyNumber` | number
+`playerId` | string
+`receptions` | number
+`yards` | number
+`avg` | number
+`touchdowns` | number
+`_long` | number
+`targets` | number
+
+## Example
+
+```typescript
+import type { ReceivingStatsDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "playerName": DeVonta Smith,
+  "jerseyNumber": 6,
+  "playerId": wr6,
+  "receptions": 4,
+  "yards": 55,
+  "avg": 13.8,
+  "touchdowns": 0,
+  "_long": 28,
+  "targets": 4,
+} satisfies ReceivingStatsDto
+
+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 ReceivingStatsDto
+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/ReceivingTotalsDto.md

@@ -0,0 +1,44 @@
+
+# ReceivingTotalsDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`receptions` | number
+`yards` | number
+`avg` | number
+`touchdowns` | number
+`_long` | number
+`targets` | number
+
+## Example
+
+```typescript
+import type { ReceivingTotalsDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "receptions": 4,
+  "yards": 55,
+  "avg": 13.8,
+  "touchdowns": 0,
+  "_long": 28,
+  "targets": 4,
+} satisfies ReceivingTotalsDto
+
+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 ReceivingTotalsDto
+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/RedZoneDto.md

@@ -0,0 +1,36 @@
+
+# RedZoneDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`scores` | number
+`attempts` | number
+
+## Example
+
+```typescript
+import type { RedZoneDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "scores": null,
+  "attempts": null,
+} satisfies RedZoneDto
+
+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 RedZoneDto
+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)
+
+