@victorycode/sdk 0.0.0-stage → 1.0.0

package/docs/InitiateMultipartUploadDto.md

@@ -0,0 +1,38 @@
+
+# InitiateMultipartUploadDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`filename` | string
+`mimetype` | string
+`gameId` | string
+
+## Example
+
+```typescript
+import type { InitiateMultipartUploadDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "filename": game-video.mp4,
+  "mimetype": video/mp4,
+  "gameId": 64c8882b9b1df9b17324aabe,
+} satisfies InitiateMultipartUploadDto
+
+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 InitiateMultipartUploadDto
+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/InitiateMultipartUploadResponse.md

@@ -0,0 +1,34 @@
+
+# InitiateMultipartUploadResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`uploadId` | string
+
+## Example
+
+```typescript
+import type { InitiateMultipartUploadResponse } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "uploadId": s3-upload-id,
+} satisfies InitiateMultipartUploadResponse
+
+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 InitiateMultipartUploadResponse
+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/InitiateMultipartUploadResponseDto.md

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

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

@@ -0,0 +1,44 @@
+
+# InterceptionStatsDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`playerName` | string
+`jerseyNumber` | number
+`playerId` | string
+`interceptions` | number
+`yards` | number
+`touchdowns` | number
+
+## Example
+
+```typescript
+import type { InterceptionStatsDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "playerName": Darius Slay,
+  "jerseyNumber": 2,
+  "playerId": db2,
+  "interceptions": 1,
+  "yards": 16,
+  "touchdowns": 0,
+} satisfies InterceptionStatsDto
+
+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 InterceptionStatsDto
+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/InterceptionTotalsDto.md

@@ -0,0 +1,38 @@
+
+# InterceptionTotalsDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`interceptions` | number
+`yards` | number
+`touchdowns` | number
+
+## Example
+
+```typescript
+import type { InterceptionTotalsDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "interceptions": 1,
+  "yards": 16,
+  "touchdowns": 0,
+} satisfies InterceptionTotalsDto
+
+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 InterceptionTotalsDto
+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/KickingSectionDto.md

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

@@ -0,0 +1,52 @@
+
+# KickingStatsDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`playerName` | string
+`jerseyNumber` | number
+`playerId` | string
+`fieldGoalsAttempted` | number
+`fieldGoalsMade` | number
+`fieldGoalPct` | number
+`longFieldGoal` | number
+`extraPointsAttempted` | number
+`extraPointsMade` | number
+`totalPoints` | number
+
+## Example
+
+```typescript
+import type { KickingStatsDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "playerName": Evan McPherson,
+  "jerseyNumber": 2,
+  "playerId": k2,
+  "fieldGoalsAttempted": 1,
+  "fieldGoalsMade": 1,
+  "fieldGoalPct": 100,
+  "longFieldGoal": 45,
+  "extraPointsAttempted": 1,
+  "extraPointsMade": 1,
+  "totalPoints": 4,
+} satisfies KickingStatsDto
+
+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 KickingStatsDto
+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/KickingTotalsDto.md

@@ -0,0 +1,46 @@
+
+# KickingTotalsDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`fieldGoalsAttempted` | number
+`fieldGoalsMade` | number
+`fieldGoalPct` | number
+`longFieldGoal` | number
+`extraPointsAttempted` | number
+`extraPointsMade` | number
+`totalPoints` | number
+
+## Example
+
+```typescript
+import type { KickingTotalsDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "fieldGoalsAttempted": 1,
+  "fieldGoalsMade": 1,
+  "fieldGoalPct": 100,
+  "longFieldGoal": 45,
+  "extraPointsAttempted": 1,
+  "extraPointsMade": 1,
+  "totalPoints": 4,
+} satisfies KickingTotalsDto
+
+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 KickingTotalsDto
+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/LineOfScrimmageDto.md

@@ -0,0 +1,36 @@
+
+# LineOfScrimmageDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`sideOfField` | string
+`yardLine` | number
+
+## Example
+
+```typescript
+import type { LineOfScrimmageDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "sideOfField": OWN,
+  "yardLine": 25,
+} satisfies LineOfScrimmageDto
+
+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 LineOfScrimmageDto
+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/ListClassificationPaginatedResponseDto.md

@@ -0,0 +1,40 @@
+
+# ListClassificationPaginatedResponseDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`total` | number
+`limit` | number
+`offset` | number
+`data` | [Array<Classification>](Classification.md)
+
+## Example
+
+```typescript
+import type { ListClassificationPaginatedResponseDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "total": 150,
+  "limit": 20,
+  "offset": 100,
+  "data": null,
+} satisfies ListClassificationPaginatedResponseDto
+
+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 ListClassificationPaginatedResponseDto
+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/ListGameAllPlaysResponseDto.md

@@ -0,0 +1,42 @@
+
+# ListGameAllPlaysResponseDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`total` | number
+`limit` | number
+`offset` | number
+`gameId` | string
+`data` | [Array<GameAllPlayListItemDto>](GameAllPlayListItemDto.md)
+
+## Example
+
+```typescript
+import type { ListGameAllPlaysResponseDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "total": 150,
+  "limit": 20,
+  "offset": 100,
+  "gameId": game-id,
+  "data": null,
+} satisfies ListGameAllPlaysResponseDto
+
+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 ListGameAllPlaysResponseDto
+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/ListGamesPaginatedResponseDto.md

@@ -0,0 +1,40 @@
+
+# ListGamesPaginatedResponseDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`total` | number
+`limit` | number
+`offset` | number
+`data` | [Array<GameDetailsResponse>](GameDetailsResponse.md)
+
+## Example
+
+```typescript
+import type { ListGamesPaginatedResponseDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "total": 150,
+  "limit": 20,
+  "offset": 100,
+  "data": null,
+} satisfies ListGamesPaginatedResponseDto
+
+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 ListGamesPaginatedResponseDto
+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/ListMascotPaginatedResponseDto.md

@@ -0,0 +1,40 @@
+
+# ListMascotPaginatedResponseDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`total` | number
+`limit` | number
+`offset` | number
+`data` | [Array<MascotResponseDto>](MascotResponseDto.md)
+
+## Example
+
+```typescript
+import type { ListMascotPaginatedResponseDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "total": 150,
+  "limit": 20,
+  "offset": 100,
+  "data": null,
+} satisfies ListMascotPaginatedResponseDto
+
+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 ListMascotPaginatedResponseDto
+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/ListPlayClipsResponseDto.md

@@ -0,0 +1,44 @@
+
+# ListPlayClipsResponseDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`total` | number
+`limit` | number
+`offset` | number
+`gameId` | string
+`videoId` | string
+`data` | [Array<PlayClipListItemDto>](PlayClipListItemDto.md)
+
+## Example
+
+```typescript
+import type { ListPlayClipsResponseDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "total": 150,
+  "limit": 20,
+  "offset": 100,
+  "gameId": game-id,
+  "videoId": video-id,
+  "data": null,
+} satisfies ListPlayClipsResponseDto
+
+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 ListPlayClipsResponseDto
+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/ListTeamPaginatedResponseDto.md

@@ -0,0 +1,40 @@
+
+# ListTeamPaginatedResponseDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`total` | number
+`limit` | number
+`offset` | number
+`data` | [Array<FetchTeamResponseDto>](FetchTeamResponseDto.md)
+
+## Example
+
+```typescript
+import type { ListTeamPaginatedResponseDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "total": 150,
+  "limit": 20,
+  "offset": 100,
+  "data": null,
+} satisfies ListTeamPaginatedResponseDto
+
+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 ListTeamPaginatedResponseDto
+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/ListVenuePaginatedResponseDto.md

@@ -0,0 +1,40 @@
+
+# ListVenuePaginatedResponseDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`total` | number
+`limit` | number
+`offset` | number
+`data` | [Array<Venue>](Venue.md)
+
+## Example
+
+```typescript
+import type { ListVenuePaginatedResponseDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "total": 150,
+  "limit": 20,
+  "offset": 100,
+  "data": null,
+} satisfies ListVenuePaginatedResponseDto
+
+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 ListVenuePaginatedResponseDto
+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)
+
+