victorycode-sdk 1.0.0__py3-none-any.whl

victorycode_sdk/exceptions.py

@@ -0,0 +1,218 @@
+"""
+    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
+
+
+from typing import Any, Optional
+from typing_extensions import Self
+
+class OpenApiException(Exception):
+    """The base exception class for all OpenAPIExceptions"""
+
+
+class ApiTypeError(OpenApiException, TypeError):
+    def __init__(self, msg, path_to_item=None, valid_classes=None,
+                 key_type=None) -> None:
+        """ Raises an exception for TypeErrors
+
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (list): a list of keys an indices to get to the
+                                 current_item
+                                 None if unset
+            valid_classes (tuple): the primitive classes that current item
+                                   should be an instance of
+                                   None if unset
+            key_type (bool): False if our value is a value in a dict
+                             True if it is a key in a dict
+                             False if our item is an item in a list
+                             None if unset
+        """
+        self.path_to_item = path_to_item
+        self.valid_classes = valid_classes
+        self.key_type = key_type
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiTypeError, self).__init__(full_msg)
+
+
+class ApiValueError(OpenApiException, ValueError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (list) the path to the exception in the
+                received_data dict. None if unset
+        """
+
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiValueError, self).__init__(full_msg)
+
+
+class ApiAttributeError(OpenApiException, AttributeError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Raised when an attribute reference or assignment fails.
+
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (None/list) the path to the exception in the
+                received_data dict
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiAttributeError, self).__init__(full_msg)
+
+
+class ApiKeyError(OpenApiException, KeyError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (None/list) the path to the exception in the
+                received_data dict
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiKeyError, self).__init__(full_msg)
+
+
+class ApiException(OpenApiException):
+
+    def __init__(
+        self, 
+        status=None, 
+        reason=None, 
+        http_resp=None,
+        *,
+        body: Optional[str] = None,
+        data: Optional[Any] = None,
+    ) -> None:
+        self.status = status
+        self.reason = reason
+        self.body = body
+        self.data = data
+        self.headers = None
+
+        if http_resp:
+            if self.status is None:
+                self.status = http_resp.status
+            if self.reason is None:
+                self.reason = http_resp.reason
+            if self.body is None:
+                try:
+                    self.body = http_resp.data.decode('utf-8')
+                except Exception:
+                    pass
+            self.headers = http_resp.headers
+
+    @classmethod
+    def from_response(
+        cls, 
+        *, 
+        http_resp, 
+        body: Optional[str], 
+        data: Optional[Any],
+    ) -> Self:
+        if http_resp.status == 400:
+            raise BadRequestException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 401:
+            raise UnauthorizedException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 403:
+            raise ForbiddenException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 404:
+            raise NotFoundException(http_resp=http_resp, body=body, data=data)
+
+        # Added new conditions for 409 and 422
+        if http_resp.status == 409:
+            raise ConflictException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 422:
+            raise UnprocessableEntityException(http_resp=http_resp, body=body, data=data)
+
+        if 500 <= http_resp.status <= 599:
+            raise ServiceException(http_resp=http_resp, body=body, data=data)
+        raise ApiException(http_resp=http_resp, body=body, data=data)
+
+    def __str__(self):
+        """Custom error messages for exception"""
+        error_message = "({0})\n"\
+                        "Reason: {1}\n".format(self.status, self.reason)
+        if self.headers:
+            error_message += "HTTP response headers: {0}\n".format(
+                self.headers)
+
+        if self.body:
+            error_message += "HTTP response body: {0}\n".format(self.body)
+
+        if self.data:
+            error_message += "HTTP response data: {0}\n".format(self.data)
+
+        return error_message
+
+
+class BadRequestException(ApiException):
+    pass
+
+
+class NotFoundException(ApiException):
+    pass
+
+
+class UnauthorizedException(ApiException):
+    pass
+
+
+class ForbiddenException(ApiException):
+    pass
+
+
+class ServiceException(ApiException):
+    pass
+
+
+class ConflictException(ApiException):
+    """Exception for HTTP 409 Conflict."""
+    pass
+
+
+class UnprocessableEntityException(ApiException):
+    """Exception for HTTP 422 Unprocessable Entity."""
+    pass
+
+
+def render_path(path_to_item):
+    """Returns a string representation of a path"""
+    result = ""
+    for pth in path_to_item:
+        if isinstance(pth, int):
+            result += "[{0}]".format(pth)
+        else:
+            result += "['{0}']".format(pth)
+    return result

victorycode_sdk/models/__init__.py

@@ -0,0 +1,114 @@
+# coding: utf-8
+
+# flake8: noqa
+"""
+    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 models into model package
+from victorycode_sdk.models.add_video_to_game_with_s3_link_dto import AddVideoToGameWithS3LinkDto
+from victorycode_sdk.models.address import Address
+from victorycode_sdk.models.address_dto import AddressDto
+from victorycode_sdk.models.bad_request_error_response_dto import BadRequestErrorResponseDto
+from victorycode_sdk.models.classification import Classification
+from victorycode_sdk.models.client_create_game_with_video_url_dto import ClientCreateGameWithVideoUrlDto
+from victorycode_sdk.models.complete_multipart_upload_dto import CompleteMultipartUploadDto
+from victorycode_sdk.models.complete_multipart_upload_response import CompleteMultipartUploadResponse
+from victorycode_sdk.models.complete_multipart_upload_response_dto import CompleteMultipartUploadResponseDto
+from victorycode_sdk.models.completed_part_dto import CompletedPartDto
+from victorycode_sdk.models.conflict_error_response_dto import ConflictErrorResponseDto
+from victorycode_sdk.models.coordinates import Coordinates
+from victorycode_sdk.models.coordinates_dto import CoordinatesDto
+from victorycode_sdk.models.create_classification_dto import CreateClassificationDto
+from victorycode_sdk.models.create_mascot_dto import CreateMascotDto
+from victorycode_sdk.models.create_team_dto import CreateTeamDto
+from victorycode_sdk.models.create_team_response_dto import CreateTeamResponseDto
+from victorycode_sdk.models.create_venue_dto import CreateVenueDto
+from victorycode_sdk.models.defense_section_dto import DefenseSectionDto
+from victorycode_sdk.models.defense_stats_dto import DefenseStatsDto
+from victorycode_sdk.models.defense_totals_dto import DefenseTotalsDto
+from victorycode_sdk.models.delete_response_dto import DeleteResponseDto
+from victorycode_sdk.models.down_efficiency_dto import DownEfficiencyDto
+from victorycode_sdk.models.fetch_team_response_dto import FetchTeamResponseDto
+from victorycode_sdk.models.fumble_section_dto import FumbleSectionDto
+from victorycode_sdk.models.fumble_stats_dto import FumbleStatsDto
+from victorycode_sdk.models.fumble_totals_dto import FumbleTotalsDto
+from victorycode_sdk.models.game_all_play_list_item_dto import GameAllPlayListItemDto
+from victorycode_sdk.models.game_box_score_meta_dto import GameBoxScoreMetaDto
+from victorycode_sdk.models.game_box_score_response_dto import GameBoxScoreResponseDto
+from victorycode_sdk.models.game_box_score_teams_dto import GameBoxScoreTeamsDto
+from victorycode_sdk.models.game_details_response import GameDetailsResponse
+from victorycode_sdk.models.game_recap_scoring_summary_pro_response import GameRecapScoringSummaryProResponse
+from victorycode_sdk.models.game_recap_scoring_summary_response import GameRecapScoringSummaryResponse
+from victorycode_sdk.models.game_recap_team_stats_response import GameRecapTeamStatsResponse
+from victorycode_sdk.models.game_score_response import GameScoreResponse
+from victorycode_sdk.models.game_scoring_summary_data_dto import GameScoringSummaryDataDto
+from victorycode_sdk.models.get_parts_presign_url_response import GetPartsPresignUrlResponse
+from victorycode_sdk.models.get_parts_presign_url_response_dto import GetPartsPresignUrlResponseDto
+from victorycode_sdk.models.initiate_multipart_upload_dto import InitiateMultipartUploadDto
+from victorycode_sdk.models.initiate_multipart_upload_response import InitiateMultipartUploadResponse
+from victorycode_sdk.models.initiate_multipart_upload_response_dto import InitiateMultipartUploadResponseDto
+from victorycode_sdk.models.interception_section_dto import InterceptionSectionDto
+from victorycode_sdk.models.interception_stats_dto import InterceptionStatsDto
+from victorycode_sdk.models.interception_totals_dto import InterceptionTotalsDto
+from victorycode_sdk.models.kicking_section_dto import KickingSectionDto
+from victorycode_sdk.models.kicking_stats_dto import KickingStatsDto
+from victorycode_sdk.models.kicking_totals_dto import KickingTotalsDto
+from victorycode_sdk.models.line_of_scrimmage_dto import LineOfScrimmageDto
+from victorycode_sdk.models.list_classification_paginated_response_dto import ListClassificationPaginatedResponseDto
+from victorycode_sdk.models.list_game_all_plays_response_dto import ListGameAllPlaysResponseDto
+from victorycode_sdk.models.list_games_paginated_response_dto import ListGamesPaginatedResponseDto
+from victorycode_sdk.models.list_mascot_paginated_response_dto import ListMascotPaginatedResponseDto
+from victorycode_sdk.models.list_play_clips_response_dto import ListPlayClipsResponseDto
+from victorycode_sdk.models.list_team_paginated_response_dto import ListTeamPaginatedResponseDto
+from victorycode_sdk.models.list_venue_paginated_response_dto import ListVenuePaginatedResponseDto
+from victorycode_sdk.models.list_video_paginated_response_dto import ListVideoPaginatedResponseDto
+from victorycode_sdk.models.mascot import Mascot
+from victorycode_sdk.models.mascot_response_dto import MascotResponseDto
+from victorycode_sdk.models.not_found_error_response_dto import NotFoundErrorResponseDto
+from victorycode_sdk.models.offense_dto import OffenseDto
+from victorycode_sdk.models.passing_dto import PassingDto
+from victorycode_sdk.models.passing_section_dto import PassingSectionDto
+from victorycode_sdk.models.passing_stats_dto import PassingStatsDto
+from victorycode_sdk.models.passing_totals_dto import PassingTotalsDto
+from victorycode_sdk.models.period_score_dto import PeriodScoreDto
+from victorycode_sdk.models.play_attributes_list_dto import PlayAttributesListDto
+from victorycode_sdk.models.play_clip_list_details_dto import PlayClipListDetailsDto
+from victorycode_sdk.models.play_clip_list_item_dto import PlayClipListItemDto
+from victorycode_sdk.models.pro_scoring_play_dto import ProScoringPlayDto
+from victorycode_sdk.models.receiving_section_dto import ReceivingSectionDto
+from victorycode_sdk.models.receiving_stats_dto import ReceivingStatsDto
+from victorycode_sdk.models.receiving_totals_dto import ReceivingTotalsDto
+from victorycode_sdk.models.red_zone_dto import RedZoneDto
+from victorycode_sdk.models.rushing_dto import RushingDto
+from victorycode_sdk.models.rushing_section_dto import RushingSectionDto
+from victorycode_sdk.models.rushing_stats_dto import RushingStatsDto
+from victorycode_sdk.models.rushing_totals_dto import RushingTotalsDto
+from victorycode_sdk.models.scoring_play_player_involved_dto import ScoringPlayPlayerInvolvedDto
+from victorycode_sdk.models.scoring_summary_pro_team_dto import ScoringSummaryProTeamDto
+from victorycode_sdk.models.single_classification_response_dto import SingleClassificationResponseDto
+from victorycode_sdk.models.single_mascot_response_dto import SingleMascotResponseDto
+from victorycode_sdk.models.single_team_response_dto import SingleTeamResponseDto
+from victorycode_sdk.models.single_venue_response_dto import SingleVenueResponseDto
+from victorycode_sdk.models.single_video_response_dto import SingleVideoResponseDto
+from victorycode_sdk.models.team_basic_info_dto import TeamBasicInfoDto
+from victorycode_sdk.models.team_box_score_dto import TeamBoxScoreDto
+from victorycode_sdk.models.team_score_dto import TeamScoreDto
+from victorycode_sdk.models.team_stats_dto import TeamStatsDto
+from victorycode_sdk.models.token_response import TokenResponse
+from victorycode_sdk.models.turnovers_dto import TurnoversDto
+from victorycode_sdk.models.unauthorized_error_response_dto import UnauthorizedErrorResponseDto
+from victorycode_sdk.models.update_classification_dto import UpdateClassificationDto
+from victorycode_sdk.models.update_mascot_dto import UpdateMascotDto
+from victorycode_sdk.models.update_team_dto import UpdateTeamDto
+from victorycode_sdk.models.update_venue_dto import UpdateVenueDto
+from victorycode_sdk.models.venue import Venue
+from victorycode_sdk.models.video_list_item_dto import VideoListItemDto
+

victorycode_sdk/models/add_video_to_game_with_s3_link_dto.py

@@ -0,0 +1,90 @@
+# 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
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class AddVideoToGameWithS3LinkDto(BaseModel):
+    """
+    AddVideoToGameWithS3LinkDto
+    """ # noqa: E501
+    view_type: StrictStr = Field(alias="viewType", json_schema_extra={"examples": ["Broadcast Wide"]})
+    s3_link: StrictStr = Field(alias="s3Link", json_schema_extra={"examples": ["https://tactix-bucket.s3.amazonaws.com/games/2023/week5/game-video.mp4"]})
+    __properties: ClassVar[List[str]] = ["viewType", "s3Link"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of AddVideoToGameWithS3LinkDto from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AddVideoToGameWithS3LinkDto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "viewType": obj.get("viewType"),
+            "s3Link": obj.get("s3Link")
+        })
+        return _obj
+
+

victorycode_sdk/models/address.py

@@ -0,0 +1,96 @@
+# 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
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class Address(BaseModel):
+    """
+    Address
+    """ # noqa: E501
+    street: StrictStr = Field(json_schema_extra={"examples": ["1 Lincoln Financial Field Way"]})
+    city: StrictStr = Field(json_schema_extra={"examples": ["Philadelphia"]})
+    state: StrictStr = Field(json_schema_extra={"examples": ["PA"]})
+    postal_code: StrictStr = Field(alias="postalCode", json_schema_extra={"examples": ["19148"]})
+    country: StrictStr = Field(json_schema_extra={"examples": ["US"]})
+    __properties: ClassVar[List[str]] = ["street", "city", "state", "postalCode", "country"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of Address from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Address from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "street": obj.get("street"),
+            "city": obj.get("city"),
+            "state": obj.get("state"),
+            "postalCode": obj.get("postalCode"),
+            "country": obj.get("country")
+        })
+        return _obj
+
+

victorycode_sdk/models/address_dto.py

@@ -0,0 +1,96 @@
+# 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
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class AddressDto(BaseModel):
+    """
+    AddressDto
+    """ # noqa: E501
+    street: StrictStr = Field(json_schema_extra={"examples": ["1 Lincoln Financial Field Way"]})
+    city: StrictStr = Field(json_schema_extra={"examples": ["Philadelphia"]})
+    state: StrictStr = Field(json_schema_extra={"examples": ["PA"]})
+    postal_code: StrictStr = Field(alias="postalCode", json_schema_extra={"examples": ["19148"]})
+    country: StrictStr = Field(json_schema_extra={"examples": ["US"]})
+    __properties: ClassVar[List[str]] = ["street", "city", "state", "postalCode", "country"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of AddressDto from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AddressDto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "street": obj.get("street"),
+            "city": obj.get("city"),
+            "state": obj.get("state"),
+            "postalCode": obj.get("postalCode"),
+            "country": obj.get("country")
+        })
+        return _obj
+
+