@victorycode/sdk 0.0.0-stage → 1.0.0

package/docs/ListVideoPaginatedResponseDto.md

@@ -0,0 +1,42 @@
+
+# ListVideoPaginatedResponseDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`total` | number
+`limit` | number
+`offset` | number
+`gameId` | string
+`data` | [Array<VideoListItemDto>](VideoListItemDto.md)
+
+## Example
+
+```typescript
+import type { ListVideoPaginatedResponseDto } 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 ListVideoPaginatedResponseDto
+
+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 ListVideoPaginatedResponseDto
+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/Mascot.md

@@ -0,0 +1,36 @@
+
+# Mascot
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+
+## Example
+
+```typescript
+import type { Mascot } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": 69bce3618817c85a7d1118f2,
+  "name": ra,
+} satisfies Mascot
+
+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 Mascot
+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/MascotApi.md

@@ -0,0 +1,325 @@
+# MascotApi
+
+All URIs are relative to *https://sandbox.api.tactixai.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createMascot**](MascotApi.md#createmascot) | **POST** /api/v1/client/mascots | Create a new mascot |
+| [**deleteMascot**](MascotApi.md#deletemascot) | **DELETE** /api/v1/client/mascots/{id} | Delete a mascot |
+| [**getMascots**](MascotApi.md#getmascots) | **GET** /api/v1/client/mascots | Get all mascots |
+| [**updateMascot**](MascotApi.md#updatemascot) | **PATCH** /api/v1/client/mascots/{id} | Update a mascot |
+
+
+
+## createMascot
+
+> SingleMascotResponseDto createMascot(createMascotDto)
+
+Create a new mascot
+
+Creates a new mascot record with a name and description. An optional mascot image can be uploaded as part of the multipart form data.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MascotApi,
+} from '@victorycode/sdk';
+import type { CreateMascotRequest } 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 MascotApi(config);
+
+  const body = {
+    // CreateMascotDto
+    createMascotDto: ...,
+  } satisfies CreateMascotRequest;
+
+  try {
+    const data = await api.createMascot(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createMascotDto** | [CreateMascotDto](CreateMascotDto.md) |  | |
+
+### Return type
+
+[**SingleMascotResponseDto**](SingleMascotResponseDto.md)
+
+### Authorization
+
+[Client-App-Token](../README.md#Client-App-Token), [Client-App-Id](../README.md#Client-App-Id)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Mascot created successfully. |  -  |
+| **400** |  |  -  |
+| **401** |  |  -  |
+| **409** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## deleteMascot
+
+> DeleteResponseDto deleteMascot(id)
+
+Delete a mascot
+
+Permanently deletes a mascot record from the system.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MascotApi,
+} from '@victorycode/sdk';
+import type { DeleteMascotRequest } 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 MascotApi(config);
+
+  const body = {
+    // string
+    id: id_example,
+  } satisfies DeleteMascotRequest;
+
+  try {
+    const data = await api.deleteMascot(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**DeleteResponseDto**](DeleteResponseDto.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** | Mascot deleted successfully. |  -  |
+| **400** |  |  -  |
+| **401** |  |  -  |
+| **404** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getMascots
+
+> ListMascotPaginatedResponseDto getMascots(limit, page, search)
+
+Get all mascots
+
+Retrieves a paginated list of all mascots. Supports searching by name and pagination through query parameters.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MascotApi,
+} from '@victorycode/sdk';
+import type { GetMascotsRequest } 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 MascotApi(config);
+
+  const body = {
+    // number (optional)
+    limit: 8.14,
+    // number (optional)
+    page: 8.14,
+    // string (optional)
+    search: search_example,
+  } satisfies GetMascotsRequest;
+
+  try {
+    const data = await api.getMascots(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **limit** | `number` |  | [Optional] [Defaults to `10`] |
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **search** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**ListMascotPaginatedResponseDto**](ListMascotPaginatedResponseDto.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** | List of mascots retrieved successfully. |  -  |
+| **400** |  |  -  |
+| **401** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## updateMascot
+
+> SingleMascotResponseDto updateMascot(id, updateMascotDto)
+
+Update a mascot
+
+Updates the details of an existing mascot identified by its ID. Allows updating the name, description, and mascot image.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  MascotApi,
+} from '@victorycode/sdk';
+import type { UpdateMascotRequest } 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 MascotApi(config);
+
+  const body = {
+    // string
+    id: id_example,
+    // UpdateMascotDto
+    updateMascotDto: ...,
+  } satisfies UpdateMascotRequest;
+
+  try {
+    const data = await api.updateMascot(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+| **updateMascotDto** | [UpdateMascotDto](UpdateMascotDto.md) |  | |
+
+### Return type
+
+[**SingleMascotResponseDto**](SingleMascotResponseDto.md)
+
+### Authorization
+
+[Client-App-Token](../README.md#Client-App-Token), [Client-App-Id](../README.md#Client-App-Id)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Mascot updated successfully. |  -  |
+| **400** |  |  -  |
+| **401** |  |  -  |
+| **404** |  |  -  |
+| **409** |  |  -  |
+
+[[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/MascotResponseDto.md

@@ -0,0 +1,42 @@
+
+# MascotResponseDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`description` | string
+`createdAt` | string
+`updatedAt` | string
+
+## Example
+
+```typescript
+import type { MascotResponseDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": 693586358345834583458345,
+  "name": Tiger,
+  "description": A fierce tiger ready to pounce on the opponent.,
+  "createdAt": 2022-01-01T00:00:00.000Z,
+  "updatedAt": 2022-01-01T00:00:00.000Z,
+} satisfies MascotResponseDto
+
+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 MascotResponseDto
+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/NotFoundErrorResponseDto.md

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

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

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

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

@@ -0,0 +1,58 @@
+
+# PassingStatsDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`playerName` | string
+`jerseyNumber` | number
+`playerId` | string
+`completions` | number
+`attempts` | number
+`yards` | number
+`avg` | number
+`touchdowns` | number
+`interceptions` | number
+`sacks` | number
+`sackYardsLost` | number
+`qbr` | number
+`passerRating` | number
+
+## Example
+
+```typescript
+import type { PassingStatsDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "playerName": Jalen Hurts,
+  "jerseyNumber": 1,
+  "playerId": qb15,
+  "completions": 13,
+  "attempts": 21,
+  "yards": 131,
+  "avg": 6.2,
+  "touchdowns": 2,
+  "interceptions": 0,
+  "sacks": 2,
+  "sackYardsLost": 10,
+  "qbr": 59.2,
+  "passerRating": 111.4,
+} satisfies PassingStatsDto
+
+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 PassingStatsDto
+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/PassingTotalsDto.md

@@ -0,0 +1,52 @@
+
+# PassingTotalsDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`completions` | number
+`attempts` | number
+`yards` | number
+`avg` | number
+`touchdowns` | number
+`interceptions` | number
+`sacks` | number
+`sackYardsLost` | number
+`qbr` | number
+`passerRating` | number
+
+## Example
+
+```typescript
+import type { PassingTotalsDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "completions": 13,
+  "attempts": 21,
+  "yards": 131,
+  "avg": 6.2,
+  "touchdowns": 2,
+  "interceptions": 0,
+  "sacks": 2,
+  "sackYardsLost": 10,
+  "qbr": 59.2,
+  "passerRating": 111.4,
+} satisfies PassingTotalsDto
+
+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 PassingTotalsDto
+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)
+
+