victorycode-sdk 1.0.0__py3-none-any.whl

victorycode_sdk/rest.py

@@ -0,0 +1,334 @@
+# coding: utf-8
+
+"""
+    Victory Code Client API
+
+    Client APIs for Tactix partners: authenticate, upload game video, and retrieve games, plays, game recaps and team metadata.
+
+    The version of the OpenAPI document: 1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import ipaddress
+import io
+import json
+import re
+import ssl
+from urllib.parse import urlparse
+
+import urllib3
+
+from victorycode_sdk.exceptions import ApiException, ApiValueError
+
+SUPPORTED_SOCKS_PROXIES = {"socks5", "socks5h", "socks4", "socks4a"}
+RESTResponseType = urllib3.HTTPResponse
+
+
+def is_socks_proxy_url(url):
+    if url is None:
+        return False
+    split_section = url.split("://")
+    if len(split_section) < 2:
+        return False
+    else:
+        return split_section[0].lower() in SUPPORTED_SOCKS_PROXIES
+
+def contenttype_matches(contenttype, maintype, subtype):
+    """Matches the given contenttype against the given type and subtype
+
+    :param contenttype: the content type to match
+    :param maintype: the expected maintype
+    :param subtype: the expected subtype
+    :return: `true` when the given content type matches the given type and subtype,
+        regardless of the presence of mime type parameters, otherwise returns `false`.
+    :rtype: bool
+    """
+    pattern = '{type}/(?:[^+;]+\\+)?{subtype}(?:[ \t]*;.*)?'.format(
+        type = re.escape(maintype),
+        subtype = re.escape(subtype),
+    )
+    return re.fullmatch(pattern, contenttype, re.IGNORECASE) is not None
+
+def should_bypass_proxies(url: str, no_proxy: str) -> bool:
+    """Return whether ``url`` matches the comma-separated ``no_proxy`` rules."""
+    parsed_url = urlparse(url)
+    if not parsed_url.hostname:
+        return True
+
+    host = parsed_url.hostname.lower()
+    host_and_port = parsed_url.netloc.lower()
+    try:
+        host_ip = ipaddress.ip_address(host)
+    except ValueError:
+        host_ip = None
+
+    for entry in (entry.strip().lower() for entry in no_proxy.split(',')):
+        if not entry:
+            continue
+        if entry == '*':
+            return True
+
+        if host_ip is not None:
+            try:
+                if host_ip in ipaddress.ip_network(entry, strict=False):
+                    return True
+            except ValueError:
+                pass
+
+        entry = entry.lstrip('.')
+        if (
+            host == entry
+            or host.endswith('.' + entry)
+            or host_and_port == entry
+            or host_and_port.endswith('.' + entry)
+        ):
+            return True
+
+    return False
+
+
+class RESTResponse(io.IOBase):
+
+    def __init__(self, resp) -> None:
+        self.response = resp
+        self.status = resp.status
+        self.reason = resp.reason
+        self.data = None
+
+    def read(self):
+        if self.data is None:
+            self.data = self.response.data
+        return self.data
+
+    @property
+    def headers(self):
+        """Returns a dictionary of response headers."""
+        return self.response.headers
+
+    def getheaders(self):
+        """Returns a dictionary of the response headers; use ``headers`` instead."""
+        return self.response.headers
+
+    def getheader(self, name, default=None):
+        """Returns a given response header; use ``headers.get()`` instead."""
+        return self.response.headers.get(name, default)
+
+
+class RESTClientObject:
+
+    def __init__(self, configuration) -> None:
+        # urllib3.PoolManager will pass all kw parameters to connectionpool
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75  # noqa: E501
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680  # noqa: E501
+        # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html  # noqa: E501
+
+        # cert_reqs
+        if configuration.verify_ssl:
+            cert_reqs = ssl.CERT_REQUIRED
+        else:
+            cert_reqs = ssl.CERT_NONE
+
+        pool_args = {
+            "cert_reqs": cert_reqs,
+            "ca_certs": configuration.ssl_ca_cert,
+            "cert_file": configuration.cert_file,
+            "key_file": configuration.key_file,
+            "ca_cert_data": configuration.ca_cert_data,
+        }
+        if configuration.assert_hostname is not None:
+            pool_args['assert_hostname'] = (
+                configuration.assert_hostname
+            )
+
+        if configuration.retries is not None:
+            pool_args['retries'] = configuration.retries
+
+        if configuration.tls_server_name:
+            pool_args['server_hostname'] = configuration.tls_server_name
+
+
+        if configuration.socket_options is not None:
+            pool_args['socket_options'] = configuration.socket_options
+
+        if configuration.connection_pool_maxsize is not None:
+            pool_args['maxsize'] = configuration.connection_pool_maxsize
+
+        # https pool manager
+        self.pool_manager: urllib3.PoolManager
+
+        if configuration.proxy and not should_bypass_proxies(
+            configuration.host, configuration.no_proxy or ''
+        ):
+            if is_socks_proxy_url(configuration.proxy):
+                from urllib3.contrib.socks import SOCKSProxyManager
+                pool_args["proxy_url"] = configuration.proxy
+                pool_args["headers"] = configuration.proxy_headers
+                self.pool_manager = SOCKSProxyManager(**pool_args)
+            else:
+                pool_args["proxy_url"] = configuration.proxy
+                pool_args["proxy_headers"] = configuration.proxy_headers
+                if configuration.proxy_ssl_context is not None:
+                    pool_args["proxy_ssl_context"] = configuration.proxy_ssl_context
+                self.pool_manager = urllib3.ProxyManager(**pool_args)
+        else:
+            self.pool_manager = urllib3.PoolManager(**pool_args)
+
+    def request(
+        self,
+        method,
+        url,
+        headers=None,
+        body=None,
+        post_params=None,
+        _request_timeout=None
+    ):
+        """Perform requests.
+
+        :param method: http request method
+        :param url: http request url
+        :param headers: http request headers
+        :param body: request json body, for `application/json`
+        :param post_params: request post parameters,
+                            `application/x-www-form-urlencoded`
+                            and `multipart/form-data`
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        """
+        method = method.upper()
+        assert method in [
+            'GET',
+            'HEAD',
+            'DELETE',
+            'POST',
+            'PUT',
+            'PATCH',
+            'OPTIONS'
+        ]
+
+        if post_params and body:
+            raise ApiValueError(
+                "body parameter cannot be used with post_params parameter."
+            )
+
+        post_params = post_params or {}
+        headers = headers or {}
+
+        timeout = None
+        if _request_timeout:
+            if isinstance(_request_timeout, (int, float)):
+                timeout = urllib3.Timeout(total=_request_timeout)
+            elif (
+                    isinstance(_request_timeout, tuple)
+                    and len(_request_timeout) == 2
+                ):
+                timeout = urllib3.Timeout(
+                    connect=_request_timeout[0],
+                    read=_request_timeout[1]
+                )
+
+        try:
+            # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
+            if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']:
+
+                content_type = headers.get('Content-Type')
+                is_json = (
+                    not content_type
+                    or contenttype_matches(content_type, 'application', 'json')
+                )
+                # JSON is valid YAML 1.2, so structured YAML bodies can use
+                # the existing JSON serializer:
+                # https://yaml.org/spec/1.2.2/#13-relation-to-json
+                is_structured_yaml = (
+                    content_type
+                    and (
+                        contenttype_matches(content_type, 'application', 'yaml')
+                        or contenttype_matches(content_type, 'text', 'yaml')
+                        or contenttype_matches(content_type, 'text', 'x-yaml')
+                    )
+                    and not isinstance(body, (str, bytes))
+                )
+                if is_json or is_structured_yaml:
+                    request_body = None
+                    if body is not None:
+                        request_body = json.dumps(body)
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=request_body,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif contenttype_matches(content_type, 'application', 'x-www-form-urlencoded'):
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        fields=post_params,
+                        encode_multipart=False,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif contenttype_matches(content_type, 'multipart', 'form-data'):
+                    # must del headers['Content-Type'], or the correct
+                    # Content-Type which generated by urllib3 will be
+                    # overwritten.
+                    del headers['Content-Type']
+                    # Ensures that dict objects are serialized
+                    post_params = [(a, json.dumps(b)) if isinstance(b, dict) else (a,b) for a, b in post_params]
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        fields=post_params,
+                        encode_multipart=True,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                # Pass a `string` parameter directly in the body to support
+                # other content types than JSON when `body` argument is
+                # provided in serialized form.
+                elif isinstance(body, str) or isinstance(body, bytes):
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=body,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif content_type.startswith('text/') and isinstance(body, bool):
+                    request_body = "true" if body else "false"
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=request_body,
+                        preload_content=False,
+                        timeout=timeout,
+                        headers=headers)
+                else:
+                    # Cannot generate the request from given parameters
+                    msg = """Cannot prepare a request message for provided
+                             arguments. Please check that your arguments match
+                             declared content type."""
+                    raise ApiException(status=0, reason=msg)
+            # For `GET`, `HEAD`
+            else:
+                r = self.pool_manager.request(
+                    method,
+                    url,
+                    fields={},
+                    timeout=timeout,
+                    headers=headers,
+                    preload_content=False
+                )
+        except urllib3.exceptions.SSLError as e:
+            msg = "\n".join([type(e).__name__, str(e)])
+            raise ApiException(status=0, reason=msg)
+
+        return RESTResponse(r)

victorycode_sdk-1.0.0.dist-info/METADATA

@@ -0,0 +1,288 @@
+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
+
+
+
+