@victorycode/sdk 0.0.0-stage → 1.0.0

package/docs/TeamsApi.md

@@ -0,0 +1,328 @@
+# TeamsApi
+
+All URIs are relative to *https://sandbox.api.tactixai.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**createTeam**](TeamsApi.md#createteam) | **POST** /api/v1/client/teams | Create a new team |
+| [**deleteTeam**](TeamsApi.md#deleteteam) | **DELETE** /api/v1/client/teams/{id} | Delete a team |
+| [**getTeams**](TeamsApi.md#getteams) | **GET** /api/v1/client/teams | Get teams |
+| [**updateTeam**](TeamsApi.md#updateteam) | **PATCH** /api/v1/client/teams/{id} | Update a team |
+
+
+
+## createTeam
+
+> SingleTeamResponseDto createTeam(createTeamDto)
+
+Create a new team
+
+Registers a new team in the system, including its name, short name, sport, mascots, classification.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TeamsApi,
+} from '@victorycode/sdk';
+import type { CreateTeamRequest } 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 TeamsApi(config);
+
+  const body = {
+    // CreateTeamDto
+    createTeamDto: ...,
+  } satisfies CreateTeamRequest;
+
+  try {
+    const data = await api.createTeam(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createTeamDto** | [CreateTeamDto](CreateTeamDto.md) |  | |
+
+### Return type
+
+[**SingleTeamResponseDto**](SingleTeamResponseDto.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** | Team 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)
+
+
+## deleteTeam
+
+> DeleteResponseDto deleteTeam(id)
+
+Delete a team
+
+Permanently deletes a team record from the system.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TeamsApi,
+} from '@victorycode/sdk';
+import type { DeleteTeamRequest } 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 TeamsApi(config);
+
+  const body = {
+    // string
+    id: id_example,
+  } satisfies DeleteTeamRequest;
+
+  try {
+    const data = await api.deleteTeam(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** | Team 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)
+
+
+## getTeams
+
+> ListTeamPaginatedResponseDto getTeams(limit, offset, search, state)
+
+Get teams
+
+Retrieves a paginated list of all teams belonging to the client. Supports filters for search, sport, and state.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TeamsApi,
+} from '@victorycode/sdk';
+import type { GetTeamsRequest } 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 TeamsApi(config);
+
+  const body = {
+    // number | The number of results to return per page. (optional)
+    limit: 8.14,
+    // number | The number of results to skip for pagination. (optional)
+    offset: 8.14,
+    // string (optional)
+    search: search_example,
+    // string (optional)
+    state: state_example,
+  } satisfies GetTeamsRequest;
+
+  try {
+    const data = await api.getTeams(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **limit** | `number` | The number of results to return per page. | [Optional] [Defaults to `50`] |
+| **offset** | `number` | The number of results to skip for pagination. | [Optional] [Defaults to `0`] |
+| **search** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **state** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**ListTeamPaginatedResponseDto**](ListTeamPaginatedResponseDto.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 teams 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)
+
+
+## updateTeam
+
+> SingleTeamResponseDto updateTeam(id, updateTeamDto)
+
+Update a team
+
+Updates the details of an existing team identified by its ID. Allows updating the name, short name, coach, logo, and other details.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TeamsApi,
+} from '@victorycode/sdk';
+import type { UpdateTeamRequest } 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 TeamsApi(config);
+
+  const body = {
+    // string
+    id: id_example,
+    // UpdateTeamDto
+    updateTeamDto: ...,
+  } satisfies UpdateTeamRequest;
+
+  try {
+    const data = await api.updateTeam(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`] |
+| **updateTeamDto** | [UpdateTeamDto](UpdateTeamDto.md) |  | |
+
+### Return type
+
+[**SingleTeamResponseDto**](SingleTeamResponseDto.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** | Team 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/TokenResponse.md

@@ -0,0 +1,38 @@
+
+# TokenResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`accessToken` | string
+`tokenType` | string
+`expiresIn` | number
+
+## Example
+
+```typescript
+import type { TokenResponse } from '@victorycode/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "accessToken": eyJhbGciOiJIUzI1Ni...,
+  "tokenType": Bearer,
+  "expiresIn": 3600,
+} satisfies TokenResponse
+
+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 TokenResponse
+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/TurnoversDto.md

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

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

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

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

@@ -0,0 +1,44 @@
+
+# UpdateTeamDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`shortName` | string
+`city` | string
+`state` | string
+`mascots` | Array<string>
+`classification` | string
+
+## Example
+
+```typescript
+import type { UpdateTeamDto } 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 UpdateTeamDto
+
+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 UpdateTeamDto
+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/UpdateVenueDto.md

@@ -0,0 +1,40 @@
+
+# UpdateVenueDto
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`playingSurface` | string
+`address` | [AddressDto](AddressDto.md)
+`coordinates` | [CoordinatesDto](CoordinatesDto.md)
+
+## Example
+
+```typescript
+import type { UpdateVenueDto } 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 UpdateVenueDto
+
+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 UpdateVenueDto
+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)
+
+