@victorycode/sdk 0.0.0-stage → 1.0.0

package/docs/AddressDto.md

@@ -0,0 +1,42 @@
+
+# AddressDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`street` | string
+`city` | string
+`state` | string
+`postalCode` | string
+`country` | string
+
+## Example
+
+```typescript
+import type { AddressDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "street": 1 Lincoln Financial Field Way,
+  "city": Philadelphia,
+  "state": PA,
+  "postalCode": 19148,
+  "country": US,
+} satisfies AddressDto
+
+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 AddressDto
+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/AuthenticationApi.md

@@ -0,0 +1,75 @@
+# AuthenticationApi
+
+All URIs are relative to *https://sandbox.api.tactixai.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getAccessToken**](AuthenticationApi.md#getaccesstoken) | **GET** /api/v1/client/auth/token | Get Access Token |
+
+
+
+## getAccessToken
+
+> TokenResponse getAccessToken()
+
+Get Access Token
+
+Exchanges client credentials for a temporary bearer token.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AuthenticationApi,
+} from '@victorycode/sdk';
+import type { GetAccessTokenRequest } from '@victorycode/sdk';
+
+async function example() {
+  console.log("🚀 Testing @victorycode/sdk SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: AppSecret
+    apiKey: "YOUR API KEY",
+    // To configure API key authorization: Client-App-Id
+    apiKey: "YOUR API KEY",
+  });
+  const api = new AuthenticationApi(config);
+
+  try {
+    const data = await api.getAccessToken();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**TokenResponse**](TokenResponse.md)
+
+### Authorization
+
+[AppSecret](../README.md#AppSecret), [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** | Authentication successful. |  -  |
+| **401** | Authentication failed due to invalid appId or appSecret. |  -  |
+
+[[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/BadRequestErrorResponseDto.md

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

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

@@ -0,0 +1,325 @@
+# ClassificationApi
+
+All URIs are relative to *https://sandbox.api.tactixai.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createClassification**](ClassificationApi.md#createclassification) | **POST** /api/v1/client/classifications | Create a new classification |
+| [**deleteClassification**](ClassificationApi.md#deleteclassification) | **DELETE** /api/v1/client/classifications/{id} | Delete a classification |
+| [**getClassifications**](ClassificationApi.md#getclassifications) | **GET** /api/v1/client/classifications | Get all classifications |
+| [**updateClassification**](ClassificationApi.md#updateclassification) | **PATCH** /api/v1/client/classifications/{id} | Update a classification |
+
+
+
+## createClassification
+
+> SingleClassificationResponseDto createClassification(createClassificationDto)
+
+Create a new classification
+
+Creates a new classification entry for categorizing teams.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClassificationApi,
+} from '@victorycode/sdk';
+import type { CreateClassificationRequest } 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 ClassificationApi(config);
+
+  const body = {
+    // CreateClassificationDto
+    createClassificationDto: ...,
+  } satisfies CreateClassificationRequest;
+
+  try {
+    const data = await api.createClassification(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createClassificationDto** | [CreateClassificationDto](CreateClassificationDto.md) |  | |
+
+### Return type
+
+[**SingleClassificationResponseDto**](SingleClassificationResponseDto.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** | Classification 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)
+
+
+## deleteClassification
+
+> DeleteResponseDto deleteClassification(id)
+
+Delete a classification
+
+Permanently deletes a team classification from the system.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClassificationApi,
+} from '@victorycode/sdk';
+import type { DeleteClassificationRequest } 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 ClassificationApi(config);
+
+  const body = {
+    // string
+    id: id_example,
+  } satisfies DeleteClassificationRequest;
+
+  try {
+    const data = await api.deleteClassification(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** | Classification 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)
+
+
+## getClassifications
+
+> ListClassificationPaginatedResponseDto getClassifications(limit, page, search)
+
+Get all classifications
+
+Retrieves a paginated list of all team classifications available in the system.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClassificationApi,
+} from '@victorycode/sdk';
+import type { GetClassificationsRequest } 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 ClassificationApi(config);
+
+  const body = {
+    // number (optional)
+    limit: 8.14,
+    // number (optional)
+    page: 8.14,
+    // string (optional)
+    search: search_example,
+  } satisfies GetClassificationsRequest;
+
+  try {
+    const data = await api.getClassifications(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
+
+[**ListClassificationPaginatedResponseDto**](ListClassificationPaginatedResponseDto.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 classifications 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)
+
+
+## updateClassification
+
+> SingleClassificationResponseDto updateClassification(id, updateClassificationDto)
+
+Update a classification
+
+Updates an existing team classification entry identified by its ID.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ClassificationApi,
+} from '@victorycode/sdk';
+import type { UpdateClassificationRequest } 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 ClassificationApi(config);
+
+  const body = {
+    // string
+    id: id_example,
+    // UpdateClassificationDto
+    updateClassificationDto: ...,
+  } satisfies UpdateClassificationRequest;
+
+  try {
+    const data = await api.updateClassification(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`] |
+| **updateClassificationDto** | [UpdateClassificationDto](UpdateClassificationDto.md) |  | |
+
+### Return type
+
+[**SingleClassificationResponseDto**](SingleClassificationResponseDto.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** | Classification 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/ClientCreateGameWithVideoUrlDto.md

@@ -0,0 +1,56 @@
+
+# ClientCreateGameWithVideoUrlDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`sourceGameId` | string
+`s3Link` | string
+`homeTeam` | string
+`awayTeam` | string
+`venue` | string
+`season` | string
+`week` | number
+`competitionLevel` | string
+`gameStatus` | string
+`gameDateTime` | string
+`uploadId` | string
+
+## Example
+
+```typescript
+import type { ClientCreateGameWithVideoUrlDto } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": Winning Strategy,
+  "sourceGameId": Game2026#15,
+  "s3Link": https://tactix-bucket.s3.amazonaws.com/games/2023/week5/game-video.mp4,
+  "homeTeam": 64c8882b9b1df9b17324aabe,
+  "awayTeam": 64c8882b9b1df9b17324aabe,
+  "venue": 64c8882b9b1df9b17324aabe,
+  "season": 2026,
+  "week": 5,
+  "competitionLevel": HIGH_SCHOOL,
+  "gameStatus": FINAL,
+  "gameDateTime": 2023-11-15,
+  "uploadId": multipart-  upload-id-123,
+} satisfies ClientCreateGameWithVideoUrlDto
+
+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 ClientCreateGameWithVideoUrlDto
+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/CompleteMultipartUploadDto.md

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

@@ -0,0 +1,36 @@
+
+# CompleteMultipartUploadResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`s3Url` | string
+`s3Key` | string
+
+## Example
+
+```typescript
+import type { CompleteMultipartUploadResponse } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "s3Url": s3 url,
+  "s3Key": s3 key,
+} satisfies CompleteMultipartUploadResponse
+
+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 CompleteMultipartUploadResponse
+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/CompleteMultipartUploadResponseDto.md

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