Metadata-Version: 2.4
Name: victorycode_sdk
Version: 1.0.0
Summary: Victory Code Client API
Home-page: https://github.com/victory-code-ai/victorycode-sdks
Author: Victory Code
License-Expression: MIT
Project-URL: Repository, https://github.com/victory-code-ai/victorycode-sdks
Keywords: OpenAPI,OpenAPI-Generator,Victory Code Client API
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: urllib3<3.0.0,>=2.7.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2.11
Requires-Dist: typing-extensions>=4.7.1
Dynamic: home-page
Dynamic: license-file

# victorycode-sdk
Client APIs for Tactix partners: authenticate, upload game video, and retrieve games, plays, game recaps and team metadata.

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0
- Package version: 1.0.0
- Generator version: 7.25.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.10+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/victory-code-ai/victorycode-sdks.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/victory-code-ai/victorycode-sdks.git`)

Then import the package:
```python
import victorycode_sdk
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import victorycode_sdk
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import victorycode_sdk
from victorycode_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://sandbox.api.tactixai.com
# See configuration.py for a list of all supported configuration parameters.
configuration = victorycode_sdk.Configuration(
    host = "https://sandbox.api.tactixai.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: AppSecret
configuration.api_key['AppSecret'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['AppSecret'] = 'Bearer'

# Configure API key authorization: Client-App-Id
configuration.api_key['Client-App-Id'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Client-App-Id'] = 'Bearer'


# Enter a context with an instance of the API client
with victorycode_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = victorycode_sdk.AuthenticationApi(api_client)

    try:
        # Get Access Token
        api_response = api_instance.get_access_token()
        print("The response of AuthenticationApi->get_access_token:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AuthenticationApi->get_access_token: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://sandbox.api.tactixai.com*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AuthenticationApi* | [**get_access_token**](docs/AuthenticationApi.md#get_access_token) | **GET** /api/v1/client/auth/token | Get Access Token
*ClassificationApi* | [**create_classification**](docs/ClassificationApi.md#create_classification) | **POST** /api/v1/client/classifications | Create a new classification
*ClassificationApi* | [**delete_classification**](docs/ClassificationApi.md#delete_classification) | **DELETE** /api/v1/client/classifications/{id} | Delete a classification
*ClassificationApi* | [**get_classifications**](docs/ClassificationApi.md#get_classifications) | **GET** /api/v1/client/classifications | Get all classifications
*ClassificationApi* | [**update_classification**](docs/ClassificationApi.md#update_classification) | **PATCH** /api/v1/client/classifications/{id} | Update a classification
*GameRecapApi* | [**get_game_recap_game_box_score**](docs/GameRecapApi.md#get_game_recap_game_box_score) | **GET** /api/v1/client/game-recap/{videoId}/game-box-score | Get the Game Recap Game Box Score for a specific Game.
*GameRecapApi* | [**get_game_recap_score**](docs/GameRecapApi.md#get_game_recap_score) | **GET** /api/v1/client/game-recap/{videoId}/score | Get the Game Recap Score for a specific Game.
*GameRecapApi* | [**get_game_recap_scoring_summary**](docs/GameRecapApi.md#get_game_recap_scoring_summary) | **GET** /api/v1/client/game-recap/{videoId}/scoring-summary | Get the Game Recap Scoring Summary for a specific Game.
*GameRecapApi* | [**get_game_recap_scoring_summary_pro**](docs/GameRecapApi.md#get_game_recap_scoring_summary_pro) | **GET** /api/v1/client/game-recap/{videoId}/scoring-summary-pro | Get the Game Recap Scoring Summary Pro for a specific Game.
*GameRecapApi* | [**get_game_recap_team_stats**](docs/GameRecapApi.md#get_game_recap_team_stats) | **GET** /api/v1/client/game-recap/{videoId}/team-stats | Get the Game Recap Team Stats for a specific Game.
*GamesApi* | [**add_video_to_game**](docs/GamesApi.md#add_video_to_game) | **POST** /api/v1/client/games/{gameId}/video | Add new video to a game
*GamesApi* | [**create_game_with_video_url**](docs/GamesApi.md#create_game_with_video_url) | **POST** /api/v1/client/games | Create a new Game with Video URL
*GamesApi* | [**get_game_details**](docs/GamesApi.md#get_game_details) | **GET** /api/v1/client/games/{gameId} | Get a Single Game.
*GamesApi* | [**get_games**](docs/GamesApi.md#get_games) | **GET** /api/v1/client/games | List and Filter Games.
*GamesApi* | [**get_videos_of_game**](docs/GamesApi.md#get_videos_of_game) | **GET** /api/v1/client/games/{gameId}/videos | Get a list of videos of a game
*MascotApi* | [**create_mascot**](docs/MascotApi.md#create_mascot) | **POST** /api/v1/client/mascots | Create a new mascot
*MascotApi* | [**delete_mascot**](docs/MascotApi.md#delete_mascot) | **DELETE** /api/v1/client/mascots/{id} | Delete a mascot
*MascotApi* | [**get_mascots**](docs/MascotApi.md#get_mascots) | **GET** /api/v1/client/mascots | Get all mascots
*MascotApi* | [**update_mascot**](docs/MascotApi.md#update_mascot) | **PATCH** /api/v1/client/mascots/{id} | Update a mascot
*PlaysEventsApi* | [**get_play_by_id**](docs/PlaysEventsApi.md#get_play_by_id) | **GET** /api/v1/client/plays/{playId} | Get the single Play Clip
*PlaysEventsApi* | [**get_plays_of_game**](docs/PlaysEventsApi.md#get_plays_of_game) | **GET** /api/v1/client/game/{gameId}/plays | Get a list of all plays for a game
*PlaysEventsApi* | [**get_plays_of_video**](docs/PlaysEventsApi.md#get_plays_of_video) | **GET** /api/v1/client/videos/{videoId}/plays | Get a list of play clips for a video
*TeamsApi* | [**create_team**](docs/TeamsApi.md#create_team) | **POST** /api/v1/client/teams | Create a new team
*TeamsApi* | [**delete_team**](docs/TeamsApi.md#delete_team) | **DELETE** /api/v1/client/teams/{id} | Delete a team
*TeamsApi* | [**get_teams**](docs/TeamsApi.md#get_teams) | **GET** /api/v1/client/teams | Get teams
*TeamsApi* | [**update_team**](docs/TeamsApi.md#update_team) | **PATCH** /api/v1/client/teams/{id} | Update a team
*UploadsApi* | [**complete_multipart_upload**](docs/UploadsApi.md#complete_multipart_upload) | **POST** /api/v1/client/complete-upload | Complete a multipart upload to S3
*UploadsApi* | [**get_presigned_url**](docs/UploadsApi.md#get_presigned_url) | **GET** /api/v1/client/upload-presigned-url | Get a presigned URL for a specific part of a multipart upload
*UploadsApi* | [**initiate_upload**](docs/UploadsApi.md#initiate_upload) | **POST** /api/v1/client/initiate-upload | Initiate a multipart upload to S3 for a large file
*VenueApi* | [**create_venue**](docs/VenueApi.md#create_venue) | **POST** /api/v1/client/venue | Create a new venue
*VenueApi* | [**delete_venue**](docs/VenueApi.md#delete_venue) | **DELETE** /api/v1/client/venue/{id} | Delete a venue
*VenueApi* | [**get_venues**](docs/VenueApi.md#get_venues) | **GET** /api/v1/client/venues | Get all venues
*VenueApi* | [**update_venue**](docs/VenueApi.md#update_venue) | **PATCH** /api/v1/client/venue/{id} | Update a venue


## Documentation For Models

 - [AddVideoToGameWithS3LinkDto](docs/AddVideoToGameWithS3LinkDto.md)
 - [Address](docs/Address.md)
 - [AddressDto](docs/AddressDto.md)
 - [BadRequestErrorResponseDto](docs/BadRequestErrorResponseDto.md)
 - [Classification](docs/Classification.md)
 - [ClientCreateGameWithVideoUrlDto](docs/ClientCreateGameWithVideoUrlDto.md)
 - [CompleteMultipartUploadDto](docs/CompleteMultipartUploadDto.md)
 - [CompleteMultipartUploadResponse](docs/CompleteMultipartUploadResponse.md)
 - [CompleteMultipartUploadResponseDto](docs/CompleteMultipartUploadResponseDto.md)
 - [CompletedPartDto](docs/CompletedPartDto.md)
 - [ConflictErrorResponseDto](docs/ConflictErrorResponseDto.md)
 - [Coordinates](docs/Coordinates.md)
 - [CoordinatesDto](docs/CoordinatesDto.md)
 - [CreateClassificationDto](docs/CreateClassificationDto.md)
 - [CreateMascotDto](docs/CreateMascotDto.md)
 - [CreateTeamDto](docs/CreateTeamDto.md)
 - [CreateTeamResponseDto](docs/CreateTeamResponseDto.md)
 - [CreateVenueDto](docs/CreateVenueDto.md)
 - [DefenseSectionDto](docs/DefenseSectionDto.md)
 - [DefenseStatsDto](docs/DefenseStatsDto.md)
 - [DefenseTotalsDto](docs/DefenseTotalsDto.md)
 - [DeleteResponseDto](docs/DeleteResponseDto.md)
 - [DownEfficiencyDto](docs/DownEfficiencyDto.md)
 - [FetchTeamResponseDto](docs/FetchTeamResponseDto.md)
 - [FumbleSectionDto](docs/FumbleSectionDto.md)
 - [FumbleStatsDto](docs/FumbleStatsDto.md)
 - [FumbleTotalsDto](docs/FumbleTotalsDto.md)
 - [GameAllPlayListItemDto](docs/GameAllPlayListItemDto.md)
 - [GameBoxScoreMetaDto](docs/GameBoxScoreMetaDto.md)
 - [GameBoxScoreResponseDto](docs/GameBoxScoreResponseDto.md)
 - [GameBoxScoreTeamsDto](docs/GameBoxScoreTeamsDto.md)
 - [GameDetailsResponse](docs/GameDetailsResponse.md)
 - [GameRecapScoringSummaryProResponse](docs/GameRecapScoringSummaryProResponse.md)
 - [GameRecapScoringSummaryResponse](docs/GameRecapScoringSummaryResponse.md)
 - [GameRecapTeamStatsResponse](docs/GameRecapTeamStatsResponse.md)
 - [GameScoreResponse](docs/GameScoreResponse.md)
 - [GameScoringSummaryDataDto](docs/GameScoringSummaryDataDto.md)
 - [GetPartsPresignUrlResponse](docs/GetPartsPresignUrlResponse.md)
 - [GetPartsPresignUrlResponseDto](docs/GetPartsPresignUrlResponseDto.md)
 - [InitiateMultipartUploadDto](docs/InitiateMultipartUploadDto.md)
 - [InitiateMultipartUploadResponse](docs/InitiateMultipartUploadResponse.md)
 - [InitiateMultipartUploadResponseDto](docs/InitiateMultipartUploadResponseDto.md)
 - [InterceptionSectionDto](docs/InterceptionSectionDto.md)
 - [InterceptionStatsDto](docs/InterceptionStatsDto.md)
 - [InterceptionTotalsDto](docs/InterceptionTotalsDto.md)
 - [KickingSectionDto](docs/KickingSectionDto.md)
 - [KickingStatsDto](docs/KickingStatsDto.md)
 - [KickingTotalsDto](docs/KickingTotalsDto.md)
 - [LineOfScrimmageDto](docs/LineOfScrimmageDto.md)
 - [ListClassificationPaginatedResponseDto](docs/ListClassificationPaginatedResponseDto.md)
 - [ListGameAllPlaysResponseDto](docs/ListGameAllPlaysResponseDto.md)
 - [ListGamesPaginatedResponseDto](docs/ListGamesPaginatedResponseDto.md)
 - [ListMascotPaginatedResponseDto](docs/ListMascotPaginatedResponseDto.md)
 - [ListPlayClipsResponseDto](docs/ListPlayClipsResponseDto.md)
 - [ListTeamPaginatedResponseDto](docs/ListTeamPaginatedResponseDto.md)
 - [ListVenuePaginatedResponseDto](docs/ListVenuePaginatedResponseDto.md)
 - [ListVideoPaginatedResponseDto](docs/ListVideoPaginatedResponseDto.md)
 - [Mascot](docs/Mascot.md)
 - [MascotResponseDto](docs/MascotResponseDto.md)
 - [NotFoundErrorResponseDto](docs/NotFoundErrorResponseDto.md)
 - [OffenseDto](docs/OffenseDto.md)
 - [PassingDto](docs/PassingDto.md)
 - [PassingSectionDto](docs/PassingSectionDto.md)
 - [PassingStatsDto](docs/PassingStatsDto.md)
 - [PassingTotalsDto](docs/PassingTotalsDto.md)
 - [PeriodScoreDto](docs/PeriodScoreDto.md)
 - [PlayAttributesListDto](docs/PlayAttributesListDto.md)
 - [PlayClipListDetailsDto](docs/PlayClipListDetailsDto.md)
 - [PlayClipListItemDto](docs/PlayClipListItemDto.md)
 - [ProScoringPlayDto](docs/ProScoringPlayDto.md)
 - [ReceivingSectionDto](docs/ReceivingSectionDto.md)
 - [ReceivingStatsDto](docs/ReceivingStatsDto.md)
 - [ReceivingTotalsDto](docs/ReceivingTotalsDto.md)
 - [RedZoneDto](docs/RedZoneDto.md)
 - [RushingDto](docs/RushingDto.md)
 - [RushingSectionDto](docs/RushingSectionDto.md)
 - [RushingStatsDto](docs/RushingStatsDto.md)
 - [RushingTotalsDto](docs/RushingTotalsDto.md)
 - [ScoringPlayPlayerInvolvedDto](docs/ScoringPlayPlayerInvolvedDto.md)
 - [ScoringSummaryProTeamDto](docs/ScoringSummaryProTeamDto.md)
 - [SingleClassificationResponseDto](docs/SingleClassificationResponseDto.md)
 - [SingleMascotResponseDto](docs/SingleMascotResponseDto.md)
 - [SingleTeamResponseDto](docs/SingleTeamResponseDto.md)
 - [SingleVenueResponseDto](docs/SingleVenueResponseDto.md)
 - [SingleVideoResponseDto](docs/SingleVideoResponseDto.md)
 - [TeamBasicInfoDto](docs/TeamBasicInfoDto.md)
 - [TeamBoxScoreDto](docs/TeamBoxScoreDto.md)
 - [TeamScoreDto](docs/TeamScoreDto.md)
 - [TeamStatsDto](docs/TeamStatsDto.md)
 - [TokenResponse](docs/TokenResponse.md)
 - [TurnoversDto](docs/TurnoversDto.md)
 - [UnauthorizedErrorResponseDto](docs/UnauthorizedErrorResponseDto.md)
 - [UpdateClassificationDto](docs/UpdateClassificationDto.md)
 - [UpdateMascotDto](docs/UpdateMascotDto.md)
 - [UpdateTeamDto](docs/UpdateTeamDto.md)
 - [UpdateVenueDto](docs/UpdateVenueDto.md)
 - [Venue](docs/Venue.md)
 - [VideoListItemDto](docs/VideoListItemDto.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="Client-App-Id"></a>
### Client-App-Id

- **Type**: API key
- **API key parameter name**: App-Id
- **Location**: HTTP header

<a id="Client-App-Token"></a>
### Client-App-Token

- **Type**: Bearer authentication (JWT)

<a id="AppSecret"></a>
### AppSecret

- **Type**: API key
- **API key parameter name**: App-Secret
- **Location**: HTTP header


## Author




