@victorycode/sdk 0.0.0-stage → 1.0.0

package/docs/RushingDto.md

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

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

@@ -0,0 +1,48 @@
+
+# RushingStatsDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`playerName` | string
+`jerseyNumber` | number
+`playerId` | string
+`carries` | number
+`yards` | number
+`avg` | number
+`touchdowns` | number
+`_long` | number
+
+## Example
+
+```typescript
+import type { RushingStatsDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "playerName": Saquon Barkley,
+  "jerseyNumber": 26,
+  "playerId": rb26,
+  "carries": 25,
+  "yards": 119,
+  "avg": 4.8,
+  "touchdowns": 0,
+  "_long": 17,
+} satisfies RushingStatsDto
+
+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 RushingStatsDto
+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/RushingTotalsDto.md

@@ -0,0 +1,42 @@
+
+# RushingTotalsDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`carries` | number
+`yards` | number
+`avg` | number
+`touchdowns` | number
+`_long` | number
+
+## Example
+
+```typescript
+import type { RushingTotalsDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "carries": 25,
+  "yards": 119,
+  "avg": 4.8,
+  "touchdowns": 0,
+  "_long": 17,
+} satisfies RushingTotalsDto
+
+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 RushingTotalsDto
+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/ScoringPlayPlayerInvolvedDto.md

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

@@ -0,0 +1,36 @@
+
+# ScoringSummaryProTeamDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`teamId` | string
+`teamName` | string
+
+## Example
+
+```typescript
+import type { ScoringSummaryProTeamDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "teamId": null,
+  "teamName": null,
+} satisfies ScoringSummaryProTeamDto
+
+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 ScoringSummaryProTeamDto
+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/SingleClassificationResponseDto.md

@@ -0,0 +1,36 @@
+
+# SingleClassificationResponseDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+`data` | [Classification](Classification.md)
+
+## Example
+
+```typescript
+import type { SingleClassificationResponseDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": Operation successful,
+  "data": null,
+} satisfies SingleClassificationResponseDto
+
+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 SingleClassificationResponseDto
+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/SingleMascotResponseDto.md

@@ -0,0 +1,36 @@
+
+# SingleMascotResponseDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+`data` | [MascotResponseDto](MascotResponseDto.md)
+
+## Example
+
+```typescript
+import type { SingleMascotResponseDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": Operation successful,
+  "data": null,
+} satisfies SingleMascotResponseDto
+
+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 SingleMascotResponseDto
+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/SingleTeamResponseDto.md

@@ -0,0 +1,36 @@
+
+# SingleTeamResponseDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+`data` | [CreateTeamResponseDto](CreateTeamResponseDto.md)
+
+## Example
+
+```typescript
+import type { SingleTeamResponseDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": Operation successful,
+  "data": null,
+} satisfies SingleTeamResponseDto
+
+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 SingleTeamResponseDto
+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/SingleVenueResponseDto.md

@@ -0,0 +1,36 @@
+
+# SingleVenueResponseDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+`data` | [Venue](Venue.md)
+
+## Example
+
+```typescript
+import type { SingleVenueResponseDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": Operation successful,
+  "data": null,
+} satisfies SingleVenueResponseDto
+
+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 SingleVenueResponseDto
+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/SingleVideoResponseDto.md

@@ -0,0 +1,36 @@
+
+# SingleVideoResponseDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+`data` | [VideoListItemDto](VideoListItemDto.md)
+
+## Example
+
+```typescript
+import type { SingleVideoResponseDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": Operation successful,
+  "data": null,
+} satisfies SingleVideoResponseDto
+
+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 SingleVideoResponseDto
+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/TeamBasicInfoDto.md

@@ -0,0 +1,42 @@
+
+# TeamBasicInfoDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`teamId` | string
+`name` | string
+`shortName` | string
+`mascot` | string
+`classification` | string
+
+## Example
+
+```typescript
+import type { TeamBasicInfoDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "teamId": team-id,
+  "name": Red Wolves,
+  "shortName": RW,
+  "mascot": Wolf,
+  "classification": VARSITY,
+} satisfies TeamBasicInfoDto
+
+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 TeamBasicInfoDto
+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/TeamBoxScoreDto.md

@@ -0,0 +1,52 @@
+
+# TeamBoxScoreDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`teamId` | string
+`teamName` | string
+`logoUrl` | string
+`passing` | [PassingSectionDto](PassingSectionDto.md)
+`rushing` | [RushingSectionDto](RushingSectionDto.md)
+`receiving` | [ReceivingSectionDto](ReceivingSectionDto.md)
+`fumbles` | [FumbleSectionDto](FumbleSectionDto.md)
+`defense` | [DefenseSectionDto](DefenseSectionDto.md)
+`kicking` | [KickingSectionDto](KickingSectionDto.md)
+`interceptions` | [InterceptionSectionDto](InterceptionSectionDto.md)
+
+## Example
+
+```typescript
+import type { TeamBoxScoreDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "teamId": 69e60993e0ce1105d162eff3,
+  "teamName": Philadelphia Eagles,
+  "logoUrl": https://cdn.example.com/logos/phi.png,
+  "passing": null,
+  "rushing": null,
+  "receiving": null,
+  "fumbles": null,
+  "defense": null,
+  "kicking": null,
+  "interceptions": null,
+} satisfies TeamBoxScoreDto
+
+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 TeamBoxScoreDto
+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/TeamScoreDto.md

@@ -0,0 +1,48 @@
+
+# TeamScoreDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`teamId` | string
+`sourceId` | string
+`name` | string
+`shortName` | string
+`mascot` | string
+`classification` | string
+`totalScore` | number
+`periodScores` | [Array<PeriodScoreDto>](PeriodScoreDto.md)
+
+## Example
+
+```typescript
+import type { TeamScoreDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "teamId": null,
+  "sourceId": null,
+  "name": null,
+  "shortName": null,
+  "mascot": null,
+  "classification": null,
+  "totalScore": null,
+  "periodScores": null,
+} satisfies TeamScoreDto
+
+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 TeamScoreDto
+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/TeamStatsDto.md

@@ -0,0 +1,56 @@
+
+# TeamStatsDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`teamId` | string
+`sourceId` | string
+`name` | string
+`shortName` | string
+`mascot` | string
+`classification` | string
+`downEfficiency` | [Array<DownEfficiencyDto>](DownEfficiencyDto.md)
+`offense` | [OffenseDto](OffenseDto.md)
+`passing` | [PassingDto](PassingDto.md)
+`rushing` | [RushingDto](RushingDto.md)
+`redZone` | [RedZoneDto](RedZoneDto.md)
+`turnovers` | [TurnoversDto](TurnoversDto.md)
+
+## Example
+
+```typescript
+import type { TeamStatsDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "teamId": null,
+  "sourceId": null,
+  "name": null,
+  "shortName": null,
+  "mascot": null,
+  "classification": null,
+  "downEfficiency": null,
+  "offense": null,
+  "passing": null,
+  "rushing": null,
+  "redZone": null,
+  "turnovers": null,
+} satisfies TeamStatsDto
+
+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 TeamStatsDto
+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)
+
+