Skip to content

Get Football Games Op

griddy / nfl / models / requests / get_football_games_op**

get_football_games_op

Attributes

Classes

GetFootballGamesRequestTypedDict

Bases: TypedDict


              flowchart TD
              griddy.nfl.models.requests.get_football_games_op.GetFootballGamesRequestTypedDict[GetFootballGamesRequestTypedDict]

              

              click griddy.nfl.models.requests.get_football_games_op.GetFootballGamesRequestTypedDict href "" "griddy.nfl.models.requests.get_football_games_op.GetFootballGamesRequestTypedDict"
Attributes
season instance-attribute 
season: int

Season year

season_type instance-attribute 
season_type: SeasonTypeEnum

Type of season

week instance-attribute 
week: int

Week number

with_external_ids instance-attribute 
with_external_ids: NotRequired[bool]

Include external IDs in response

GetFootballGamesRequest

Bases: BaseModel


              flowchart TD
              griddy.nfl.models.requests.get_football_games_op.GetFootballGamesRequest[GetFootballGamesRequest]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.requests.get_football_games_op.GetFootballGamesRequest
                


              click griddy.nfl.models.requests.get_football_games_op.GetFootballGamesRequest href "" "griddy.nfl.models.requests.get_football_games_op.GetFootballGamesRequest"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
Attributes
season instance-attribute 
season: Annotated[
    int,
    FieldMetadata(
        path=PathParamMetadata(
            style="simple", explode=False
        )
    ),
]

Season year

season_type instance-attribute 
season_type: Annotated[
    SeasonTypeEnum,
    Field(alias="seasonType"),
    FieldMetadata(
        path=PathParamMetadata(
            style="simple", explode=False
        )
    ),
]

Type of season

week instance-attribute 
week: Annotated[
    int,
    FieldMetadata(
        path=PathParamMetadata(
            style="simple", explode=False
        )
    ),
]

Week number

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

Include external IDs in response