victorycode-sdk 1.0.0__py3-none-any.whl

victorycode_sdk/api/plays_events_api.py

@@ -0,0 +1,1057 @@
+"""
+    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 warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from pydantic import Field, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Optional, Union
+from typing_extensions import Annotated
+from victorycode_sdk.models.list_game_all_plays_response_dto import ListGameAllPlaysResponseDto
+from victorycode_sdk.models.list_play_clips_response_dto import ListPlayClipsResponseDto
+from victorycode_sdk.models.play_clip_list_item_dto import PlayClipListItemDto
+
+from victorycode_sdk.api_client import ApiClient, RequestSerialized
+from victorycode_sdk.api_response import ApiResponse
+from victorycode_sdk.rest import RESTResponseType
+
+
+class PlaysEventsApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+
+    @validate_call
+    def get_play_by_id(
+        self,
+        play_id: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> PlayClipListItemDto:
+        """Get the single Play Clip
+
+        Retrieves the complete metadata for a single play clip by its unique ID.
+
+        :param play_id: (required)
+        :type play_id: str
+        :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.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_play_by_id_serialize(
+            play_id=play_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PlayClipListItemDto",
+            '400': "BadRequestErrorResponseDto",
+            '401': "UnauthorizedErrorResponseDto",
+            '404': "NotFoundErrorResponseDto",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def get_play_by_id_with_http_info(
+        self,
+        play_id: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[PlayClipListItemDto]:
+        """Get the single Play Clip
+
+        Retrieves the complete metadata for a single play clip by its unique ID.
+
+        :param play_id: (required)
+        :type play_id: str
+        :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.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_play_by_id_serialize(
+            play_id=play_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PlayClipListItemDto",
+            '400': "BadRequestErrorResponseDto",
+            '401': "UnauthorizedErrorResponseDto",
+            '404': "NotFoundErrorResponseDto",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def get_play_by_id_without_preload_content(
+        self,
+        play_id: StrictStr,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Get the single Play Clip
+
+        Retrieves the complete metadata for a single play clip by its unique ID.
+
+        :param play_id: (required)
+        :type play_id: str
+        :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.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_play_by_id_serialize(
+            play_id=play_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PlayClipListItemDto",
+            '400': "BadRequestErrorResponseDto",
+            '401': "UnauthorizedErrorResponseDto",
+            '404': "NotFoundErrorResponseDto",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_play_by_id_serialize(
+        self,
+        play_id,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if play_id is not None:
+            _path_params['playId'] = play_id
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'Client-App-Token', 
+            'Client-App-Id'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/api/v1/client/plays/{playId}',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def get_plays_of_game(
+        self,
+        game_id: StrictStr,
+        limit: Annotated[Optional[Union[StrictFloat, StrictInt]], Field(description="The number of results to return per page.")] = None,
+        offset: Annotated[Optional[Union[StrictFloat, StrictInt]], Field(description="The number of results to skip for pagination.")] = None,
+        search: Optional[StrictStr] = None,
+        down: Annotated[Optional[StrictStr], Field(description="Filter by down number")] = None,
+        distance_zone: Annotated[Optional[StrictStr], Field(description="Filter by distance zone (yards to go)")] = None,
+        play_type: Annotated[Optional[StrictStr], Field(description="Filter by analyzed play type")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ListGameAllPlaysResponseDto:
+        """Get a list of all plays for a game
+
+        Retrieves a paginated list of all plays for a given game. The results can be filtered by various play attributes.
+
+        :param game_id: (required)
+        :type game_id: str
+        :param limit: The number of results to return per page.
+        :type limit: float
+        :param offset: The number of results to skip for pagination.
+        :type offset: float
+        :param search:
+        :type search: str
+        :param down: Filter by down number
+        :type down: str
+        :param distance_zone: Filter by distance zone (yards to go)
+        :type distance_zone: str
+        :param play_type: Filter by analyzed play type
+        :type play_type: str
+        :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.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_plays_of_game_serialize(
+            game_id=game_id,
+            limit=limit,
+            offset=offset,
+            search=search,
+            down=down,
+            distance_zone=distance_zone,
+            play_type=play_type,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ListGameAllPlaysResponseDto",
+            '400': "BadRequestErrorResponseDto",
+            '401': "UnauthorizedErrorResponseDto",
+            '404': "NotFoundErrorResponseDto",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def get_plays_of_game_with_http_info(
+        self,
+        game_id: StrictStr,
+        limit: Annotated[Optional[Union[StrictFloat, StrictInt]], Field(description="The number of results to return per page.")] = None,
+        offset: Annotated[Optional[Union[StrictFloat, StrictInt]], Field(description="The number of results to skip for pagination.")] = None,
+        search: Optional[StrictStr] = None,
+        down: Annotated[Optional[StrictStr], Field(description="Filter by down number")] = None,
+        distance_zone: Annotated[Optional[StrictStr], Field(description="Filter by distance zone (yards to go)")] = None,
+        play_type: Annotated[Optional[StrictStr], Field(description="Filter by analyzed play type")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[ListGameAllPlaysResponseDto]:
+        """Get a list of all plays for a game
+
+        Retrieves a paginated list of all plays for a given game. The results can be filtered by various play attributes.
+
+        :param game_id: (required)
+        :type game_id: str
+        :param limit: The number of results to return per page.
+        :type limit: float
+        :param offset: The number of results to skip for pagination.
+        :type offset: float
+        :param search:
+        :type search: str
+        :param down: Filter by down number
+        :type down: str
+        :param distance_zone: Filter by distance zone (yards to go)
+        :type distance_zone: str
+        :param play_type: Filter by analyzed play type
+        :type play_type: str
+        :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.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_plays_of_game_serialize(
+            game_id=game_id,
+            limit=limit,
+            offset=offset,
+            search=search,
+            down=down,
+            distance_zone=distance_zone,
+            play_type=play_type,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ListGameAllPlaysResponseDto",
+            '400': "BadRequestErrorResponseDto",
+            '401': "UnauthorizedErrorResponseDto",
+            '404': "NotFoundErrorResponseDto",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def get_plays_of_game_without_preload_content(
+        self,
+        game_id: StrictStr,
+        limit: Annotated[Optional[Union[StrictFloat, StrictInt]], Field(description="The number of results to return per page.")] = None,
+        offset: Annotated[Optional[Union[StrictFloat, StrictInt]], Field(description="The number of results to skip for pagination.")] = None,
+        search: Optional[StrictStr] = None,
+        down: Annotated[Optional[StrictStr], Field(description="Filter by down number")] = None,
+        distance_zone: Annotated[Optional[StrictStr], Field(description="Filter by distance zone (yards to go)")] = None,
+        play_type: Annotated[Optional[StrictStr], Field(description="Filter by analyzed play type")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Get a list of all plays for a game
+
+        Retrieves a paginated list of all plays for a given game. The results can be filtered by various play attributes.
+
+        :param game_id: (required)
+        :type game_id: str
+        :param limit: The number of results to return per page.
+        :type limit: float
+        :param offset: The number of results to skip for pagination.
+        :type offset: float
+        :param search:
+        :type search: str
+        :param down: Filter by down number
+        :type down: str
+        :param distance_zone: Filter by distance zone (yards to go)
+        :type distance_zone: str
+        :param play_type: Filter by analyzed play type
+        :type play_type: str
+        :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.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_plays_of_game_serialize(
+            game_id=game_id,
+            limit=limit,
+            offset=offset,
+            search=search,
+            down=down,
+            distance_zone=distance_zone,
+            play_type=play_type,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ListGameAllPlaysResponseDto",
+            '400': "BadRequestErrorResponseDto",
+            '401': "UnauthorizedErrorResponseDto",
+            '404': "NotFoundErrorResponseDto",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_plays_of_game_serialize(
+        self,
+        game_id,
+        limit,
+        offset,
+        search,
+        down,
+        distance_zone,
+        play_type,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if game_id is not None:
+            _path_params['gameId'] = game_id
+        # process the query parameters
+        if limit is not None:
+            
+            _query_params.append(('limit', limit))
+            
+        if offset is not None:
+            
+            _query_params.append(('offset', offset))
+            
+        if search is not None:
+            
+            _query_params.append(('search', search))
+            
+        if down is not None:
+            
+            _query_params.append(('down', down))
+            
+        if distance_zone is not None:
+            
+            _query_params.append(('distanceZone', distance_zone))
+            
+        if play_type is not None:
+            
+            _query_params.append(('playType', play_type))
+            
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'Client-App-Token', 
+            'Client-App-Id'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/api/v1/client/game/{gameId}/plays',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
+    @validate_call
+    def get_plays_of_video(
+        self,
+        video_id: StrictStr,
+        limit: Annotated[Optional[Union[StrictFloat, StrictInt]], Field(description="The number of results to return per page.")] = None,
+        offset: Annotated[Optional[Union[StrictFloat, StrictInt]], Field(description="The number of results to skip for pagination.")] = None,
+        search: Optional[StrictStr] = None,
+        down: Annotated[Optional[StrictStr], Field(description="Filter by down number")] = None,
+        distance_zone: Annotated[Optional[StrictStr], Field(description="Filter by distance zone (yards to go)")] = None,
+        play_type: Annotated[Optional[StrictStr], Field(description="Filter by analyzed play type")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ListPlayClipsResponseDto:
+        """Get a list of play clips for a video
+
+        Retrieves a paginated list of all play clips for a given video. The results can be filtered by various play attributes.
+
+        :param video_id: (required)
+        :type video_id: str
+        :param limit: The number of results to return per page.
+        :type limit: float
+        :param offset: The number of results to skip for pagination.
+        :type offset: float
+        :param search:
+        :type search: str
+        :param down: Filter by down number
+        :type down: str
+        :param distance_zone: Filter by distance zone (yards to go)
+        :type distance_zone: str
+        :param play_type: Filter by analyzed play type
+        :type play_type: str
+        :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.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_plays_of_video_serialize(
+            video_id=video_id,
+            limit=limit,
+            offset=offset,
+            search=search,
+            down=down,
+            distance_zone=distance_zone,
+            play_type=play_type,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ListPlayClipsResponseDto",
+            '400': "BadRequestErrorResponseDto",
+            '401': "UnauthorizedErrorResponseDto",
+            '404': "NotFoundErrorResponseDto",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def get_plays_of_video_with_http_info(
+        self,
+        video_id: StrictStr,
+        limit: Annotated[Optional[Union[StrictFloat, StrictInt]], Field(description="The number of results to return per page.")] = None,
+        offset: Annotated[Optional[Union[StrictFloat, StrictInt]], Field(description="The number of results to skip for pagination.")] = None,
+        search: Optional[StrictStr] = None,
+        down: Annotated[Optional[StrictStr], Field(description="Filter by down number")] = None,
+        distance_zone: Annotated[Optional[StrictStr], Field(description="Filter by distance zone (yards to go)")] = None,
+        play_type: Annotated[Optional[StrictStr], Field(description="Filter by analyzed play type")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[ListPlayClipsResponseDto]:
+        """Get a list of play clips for a video
+
+        Retrieves a paginated list of all play clips for a given video. The results can be filtered by various play attributes.
+
+        :param video_id: (required)
+        :type video_id: str
+        :param limit: The number of results to return per page.
+        :type limit: float
+        :param offset: The number of results to skip for pagination.
+        :type offset: float
+        :param search:
+        :type search: str
+        :param down: Filter by down number
+        :type down: str
+        :param distance_zone: Filter by distance zone (yards to go)
+        :type distance_zone: str
+        :param play_type: Filter by analyzed play type
+        :type play_type: str
+        :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.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_plays_of_video_serialize(
+            video_id=video_id,
+            limit=limit,
+            offset=offset,
+            search=search,
+            down=down,
+            distance_zone=distance_zone,
+            play_type=play_type,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ListPlayClipsResponseDto",
+            '400': "BadRequestErrorResponseDto",
+            '401': "UnauthorizedErrorResponseDto",
+            '404': "NotFoundErrorResponseDto",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def get_plays_of_video_without_preload_content(
+        self,
+        video_id: StrictStr,
+        limit: Annotated[Optional[Union[StrictFloat, StrictInt]], Field(description="The number of results to return per page.")] = None,
+        offset: Annotated[Optional[Union[StrictFloat, StrictInt]], Field(description="The number of results to skip for pagination.")] = None,
+        search: Optional[StrictStr] = None,
+        down: Annotated[Optional[StrictStr], Field(description="Filter by down number")] = None,
+        distance_zone: Annotated[Optional[StrictStr], Field(description="Filter by distance zone (yards to go)")] = None,
+        play_type: Annotated[Optional[StrictStr], Field(description="Filter by analyzed play type")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Get a list of play clips for a video
+
+        Retrieves a paginated list of all play clips for a given video. The results can be filtered by various play attributes.
+
+        :param video_id: (required)
+        :type video_id: str
+        :param limit: The number of results to return per page.
+        :type limit: float
+        :param offset: The number of results to skip for pagination.
+        :type offset: float
+        :param search:
+        :type search: str
+        :param down: Filter by down number
+        :type down: str
+        :param distance_zone: Filter by distance zone (yards to go)
+        :type distance_zone: str
+        :param play_type: Filter by analyzed play type
+        :type play_type: str
+        :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.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_plays_of_video_serialize(
+            video_id=video_id,
+            limit=limit,
+            offset=offset,
+            search=search,
+            down=down,
+            distance_zone=distance_zone,
+            play_type=play_type,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ListPlayClipsResponseDto",
+            '400': "BadRequestErrorResponseDto",
+            '401': "UnauthorizedErrorResponseDto",
+            '404': "NotFoundErrorResponseDto",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_plays_of_video_serialize(
+        self,
+        video_id,
+        limit,
+        offset,
+        search,
+        down,
+        distance_zone,
+        play_type,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if video_id is not None:
+            _path_params['videoId'] = video_id
+        # process the query parameters
+        if limit is not None:
+            
+            _query_params.append(('limit', limit))
+            
+        if offset is not None:
+            
+            _query_params.append(('offset', offset))
+            
+        if search is not None:
+            
+            _query_params.append(('search', search))
+            
+        if down is not None:
+            
+            _query_params.append(('down', down))
+            
+        if distance_zone is not None:
+            
+            _query_params.append(('distanceZone', distance_zone))
+            
+        if play_type is not None:
+            
+            _query_params.append(('playType', play_type))
+            
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'Client-App-Token', 
+            'Client-App-Id'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/api/v1/client/videos/{videoId}/plays',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+