@victorycode/sdk 0.0.0-stage → 1.0.0

package/docs/CompletedPartDto.md

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

@@ -0,0 +1,36 @@
+
+# ConflictErrorResponseDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | number
+`message` | string
+
+## Example
+
+```typescript
+import type { ConflictErrorResponseDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": 409,
+  "message": Resource already exists,
+} satisfies ConflictErrorResponseDto
+
+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 ConflictErrorResponseDto
+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/Coordinates.md

@@ -0,0 +1,36 @@
+
+# Coordinates
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`latitude` | number
+`longitude` | number
+
+## Example
+
+```typescript
+import type { Coordinates } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "latitude": 39.9008,
+  "longitude": -75.1675,
+} satisfies Coordinates
+
+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 Coordinates
+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/CoordinatesDto.md

@@ -0,0 +1,36 @@
+
+# CoordinatesDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`latitude` | number
+`longitude` | number
+
+## Example
+
+```typescript
+import type { CoordinatesDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "latitude": 39.9008,
+  "longitude": -75.1652,
+} satisfies CoordinatesDto
+
+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 CoordinatesDto
+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/CreateClassificationDto.md

@@ -0,0 +1,36 @@
+
+# CreateClassificationDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`description` | string
+
+## Example
+
+```typescript
+import type { CreateClassificationDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": Vikings,
+  "description": This is classification description,
+} satisfies CreateClassificationDto
+
+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 CreateClassificationDto
+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/CreateMascotDto.md

@@ -0,0 +1,36 @@
+
+# CreateMascotDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`description` | string
+
+## Example
+
+```typescript
+import type { CreateMascotDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": Vikings,
+  "description": This is mascot description,
+} satisfies CreateMascotDto
+
+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 CreateMascotDto
+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/CreateTeamDto.md

@@ -0,0 +1,44 @@
+
+# CreateTeamDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`shortName` | string
+`city` | string
+`state` | string
+`mascots` | Array<string>
+`classification` | string
+
+## Example
+
+```typescript
+import type { CreateTeamDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": Team A,
+  "shortName": LFC,
+  "city": Chicago,
+  "state": California,
+  "mascots": ["64c8882b9b1df9b17324aabc","64c8882b9b1df9b17324aabd"],
+  "classification": 64c8882b9b1df9b17324aabe,
+} satisfies CreateTeamDto
+
+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 CreateTeamDto
+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/CreateTeamResponseDto.md

@@ -0,0 +1,52 @@
+
+# CreateTeamResponseDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`shortName` | string
+`sport` | string
+`mascots` | Array<string>
+`classification` | string
+`city` | string
+`state` | string
+`createdAt` | string
+`updatedAt` | string
+
+## Example
+
+```typescript
+import type { CreateTeamResponseDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": 69c2b97794074e4cb18028a5,
+  "name": Testing Team,
+  "shortName": T Team,
+  "sport": FOOTBALL,
+  "mascots": ["69b14f4a172b65400e92bcf2"],
+  "classification": 69b14f4a172b65400e92bcf2,
+  "city": Kathmandu,
+  "state": Alaska,
+  "createdAt": 2026-03-24T16:19:03.163Z,
+  "updatedAt": 2026-03-24T16:19:03.163Z,
+} satisfies CreateTeamResponseDto
+
+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 CreateTeamResponseDto
+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/CreateVenueDto.md

@@ -0,0 +1,40 @@
+
+# CreateVenueDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`playingSurface` | string
+`address` | [AddressDto](AddressDto.md)
+`coordinates` | [CoordinatesDto](CoordinatesDto.md)
+
+## Example
+
+```typescript
+import type { CreateVenueDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": Lincoln Financial Field,
+  "playingSurface": Natural Grass,
+  "address": null,
+  "coordinates": null,
+} satisfies CreateVenueDto
+
+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 CreateVenueDto
+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/DefenseSectionDto.md

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

@@ -0,0 +1,52 @@
+
+# DefenseStatsDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`playerName` | string
+`jerseyNumber` | number
+`playerId` | string
+`totalTackles` | number
+`soloTackles` | number
+`sacks` | number
+`tacklesForLoss` | number
+`passesDefended` | number
+`qbHits` | number
+`defensiveTouchdowns` | number
+
+## Example
+
+```typescript
+import type { DefenseStatsDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "playerName": Quay Walker,
+  "jerseyNumber": 7,
+  "playerId": lb7,
+  "totalTackles": 8,
+  "soloTackles": 4,
+  "sacks": 0.5,
+  "tacklesForLoss": 0,
+  "passesDefended": 0,
+  "qbHits": 1,
+  "defensiveTouchdowns": 0,
+} satisfies DefenseStatsDto
+
+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 DefenseStatsDto
+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/DefenseTotalsDto.md

@@ -0,0 +1,46 @@
+
+# DefenseTotalsDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`totalTackles` | number
+`soloTackles` | number
+`sacks` | number
+`tacklesForLoss` | number
+`passesDefended` | number
+`qbHits` | number
+`defensiveTouchdowns` | number
+
+## Example
+
+```typescript
+import type { DefenseTotalsDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "totalTackles": 8,
+  "soloTackles": 4,
+  "sacks": 0.5,
+  "tacklesForLoss": 0,
+  "passesDefended": 0,
+  "qbHits": 1,
+  "defensiveTouchdowns": 0,
+} satisfies DefenseTotalsDto
+
+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 DefenseTotalsDto
+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/DeleteResponseDto.md

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

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

@@ -0,0 +1,52 @@
+
+# FetchTeamResponseDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`shortName` | string
+`sport` | string
+`city` | string
+`state` | string
+`mascots` | [Mascot](Mascot.md)
+`classification` | [Array<Classification>](Classification.md)
+`createdAt` | string
+`updatedAt` | string
+
+## Example
+
+```typescript
+import type { FetchTeamResponseDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": 69c0bf178817c85a7d11b716,
+  "name": JAK,
+  "shortName": JA,
+  "sport": FOOTBALL,
+  "city": Kathmandu,
+  "state": Alaska,
+  "mascots": {"_id":"69bce3618817c85a7d1118f2","name":"ra"},
+  "classification": [{"_id":"69b13dc5172b65400e926b31","name":"GRANT_CLS_315"}],
+  "createdAt": 2026-03-23T04:18:31.588Z,
+  "updatedAt": 2026-03-23T04:18:31.588Z,
+} satisfies FetchTeamResponseDto
+
+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 FetchTeamResponseDto
+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/FumbleSectionDto.md

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