Skip to content

Film Card

griddy / nfl / models / entities / film_card**

film_card

Classes

LinkParamsTypedDict

Bases: TypedDict


              flowchart TD
              griddy.nfl.models.entities.film_card.LinkParamsTypedDict[LinkParamsTypedDict]

              

              click griddy.nfl.models.entities.film_card.LinkParamsTypedDict href "" "griddy.nfl.models.entities.film_card.LinkParamsTypedDict"

Parameters for constructing film room link

Attributes
dropback instance-attribute 
dropback: NotRequired[int]

Dropback indicator (1 for yes)

nfl_id instance-attribute 
nfl_id: NotRequired[str]

NFL player identifier

passer_id instance-attribute 
passer_id: NotRequired[str]

Passer ID for QB film

rusher_id instance-attribute 
rusher_id: NotRequired[str]

Rusher ID for RB film

season instance-attribute 
season: NotRequired[str]

Season year

target_id instance-attribute 
target_id: NotRequired[str]

Target ID for receiver film

week_slug instance-attribute 
week_slug: NotRequired[str]

Week identifier

LinkParams

Bases: BaseModel


              flowchart TD
              griddy.nfl.models.entities.film_card.LinkParams[LinkParams]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.entities.film_card.LinkParams
                


              click griddy.nfl.models.entities.film_card.LinkParams href "" "griddy.nfl.models.entities.film_card.LinkParams"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"

Parameters for constructing film room link

Attributes
dropback class-attribute instance-attribute 
dropback: Optional[int] = None

Dropback indicator (1 for yes)

nfl_id class-attribute instance-attribute 
nfl_id: Annotated[Optional[str], Field(alias="nflId")] = (
    None
)

NFL player identifier

passer_id class-attribute instance-attribute 
passer_id: Annotated[
    Optional[str], Field(alias="passerId")
] = None

Passer ID for QB film

rusher_id class-attribute instance-attribute 
rusher_id: Annotated[
    Optional[str], Field(alias="rusherId")
] = None

Rusher ID for RB film

season class-attribute instance-attribute 
season: Optional[str] = None

Season year

target_id class-attribute instance-attribute 
target_id: Annotated[
    Optional[str], Field(alias="targetId")
] = None

Target ID for receiver film

week_slug class-attribute instance-attribute 
week_slug: Annotated[
    Optional[str], Field(alias="weekSlug")
] = None

Week identifier

FilmCardTypedDict

Bases: TypedDict


              flowchart TD
              griddy.nfl.models.entities.film_card.FilmCardTypedDict[FilmCardTypedDict]

              

              click griddy.nfl.models.entities.film_card.FilmCardTypedDict href "" "griddy.nfl.models.entities.film_card.FilmCardTypedDict"
Attributes
link_params: LinkParamsTypedDict

Parameters for constructing film room link

team_id instance-attribute 
team_id: str

Team identifier

title instance-attribute 
title: str

Title of the film content

FilmCard

Bases: BaseModel


              flowchart TD
              griddy.nfl.models.entities.film_card.FilmCard[FilmCard]
              griddy.nfl.types.basemodel.BaseModel[BaseModel]

                              griddy.nfl.types.basemodel.BaseModel --> griddy.nfl.models.entities.film_card.FilmCard
                


              click griddy.nfl.models.entities.film_card.FilmCard href "" "griddy.nfl.models.entities.film_card.FilmCard"
              click griddy.nfl.types.basemodel.BaseModel href "" "griddy.nfl.types.basemodel.BaseModel"
Attributes
link_params: Annotated[
    LinkParams, Field(alias="linkParams")
]

Parameters for constructing film room link

team_id instance-attribute 
team_id: Annotated[str, Field(alias='teamId')]

Team identifier

title instance-attribute 
title: str

Title of the film content