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 project:

• API version: 1.0
• Package version: 1.0.1
• 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:

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:

import victorycode_sdk

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import victorycode_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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

Documentation For Models

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

Documentation For Authorization

Authentication schemes defined for the API:

Client-App-Id

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

Client-App-Token

• Type: Bearer authentication (JWT)

AppSecret

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

Author