Skip to content

Get Players Team Roster Op

griddy / nfl / models / requests / get_players_team_roster_op**

get_players_team_roster_op

Classes

GetPlayersTeamRosterRequestTypedDict

Bases: TypedDict


              flowchart TD
              griddy.nfl.models.requests.get_players_team_roster_op.GetPlayersTeamRosterRequestTypedDict[GetPlayersTeamRosterRequestTypedDict]

              

              click griddy.nfl.models.requests.get_players_team_roster_op.GetPlayersTeamRosterRequestTypedDict href "" "griddy.nfl.models.requests.get_players_team_roster_op.GetPlayersTeamRosterRequestTypedDict"
Attributes
team_id instance-attribute 
team_id: str

Team identifier (UUID)

season instance-attribute 
season: int

Season year

include_stats instance-attribute 
include_stats: NotRequired[bool]

Include current season statistics

GetPlayersTeamRosterRequest

Bases: BaseModel


              flowchart TD
              griddy.nfl.models.requests.get_players_team_roster_op.GetPlayersTeamRosterRequest[GetPlayersTeamRosterRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.requests.get_players_team_roster_op.GetPlayersTeamRosterRequest
                


              click griddy.nfl.models.requests.get_players_team_roster_op.GetPlayersTeamRosterRequest href "" "griddy.nfl.models.requests.get_players_team_roster_op.GetPlayersTeamRosterRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
Attributes
team_id instance-attribute 
team_id: Annotated[
    str,
    Field(alias="teamId"),
    FieldMetadata(
        path=PathParamMetadata(
            style="simple", explode=False
        )
    ),
]

Team identifier (UUID)

season instance-attribute 
season: Annotated[
    int,
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
]

Season year

include_stats class-attribute instance-attribute 
include_stats: Annotated[
    Optional[bool],
    Field(alias="includeStats"),
    FieldMetadata(
        query=QueryParamMetadata(style="form", explode=True)
    ),
] = False

Include current season statistics