Skip to content

Weeks

griddy / nfl / endpoints / regular / football / weeks**

weeks

Classes

Weeks 

Weeks(
    sdk_config: SDKConfiguration,
    parent_ref: Optional[object] = None,
)

Bases: BaseSDK


              flowchart TD
              griddy.nfl.endpoints.regular.football.weeks.Weeks[Weeks]
              griddy.nfl.basesdk.BaseSDK[BaseSDK]

                              griddy.nfl.basesdk.BaseSDK --> griddy.nfl.endpoints.regular.football.weeks.Weeks
                


              click griddy.nfl.endpoints.regular.football.weeks.Weeks href "" "griddy.nfl.endpoints.regular.football.weeks.Weeks"
              click griddy.nfl.basesdk.BaseSDK href "" "griddy.nfl.basesdk.BaseSDK"
Source code in griddy/nfl/basesdk.py 
79
80
81
82
83
84
85
def __init__(
    self,
    sdk_config: SDKConfiguration,
    parent_ref: Optional[object] = None,
) -> None:
    self.sdk_configuration = sdk_config
    self.parent_ref = parent_ref
Functions
get_week_of_date 
get_week_of_date(
    *,
    date: str,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> Week

Get Week for Date

:param date: YYYY-MM-DD :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds :param http_headers: Additional headers to set or replace on requests.

Source code in griddy/nfl/endpoints/regular/football/weeks.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
def get_week_of_date(
    self,
    *,
    date: str,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.Week:
    r"""Get Week for Date

    :param date: YYYY-MM-DD
    :param retries: Override the default retry configuration for this method
    :param server_url: Override the default server URL for this method
    :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
    :param http_headers: Additional headers to set or replace on requests.
    """
    config = self._get_week_of_date_config(
        date=date,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return self._execute_endpoint(config)
get_week_of_date_async async 
get_week_of_date_async(
    *,
    date: str,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> WeeksResponse

Get Week for Date

Source code in griddy/nfl/endpoints/regular/football/weeks.py 
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
async def get_week_of_date_async(
    self,
    *,
    date: str,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.WeeksResponse:
    r"""Get Week for Date"""
    config = self._get_week_of_date_config(
        date=date,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return await self._execute_endpoint_async(config)
get_season_weeks 
get_season_weeks(
    *,
    season: int,
    limit: Optional[int] = 20,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> WeeksResponse

Get Season Weeks

Retrieves all weeks for a specific season including preseason, regular season, and postseason.

:param season: Season year :param limit: Maximum number of weeks to return :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method :param timeout_ms: Override the default request timeout configuration for this method in milliseconds :param http_headers: Additional headers to set or replace on requests.

Source code in griddy/nfl/endpoints/regular/football/weeks.py 
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
def get_season_weeks(
    self,
    *,
    season: int,
    limit: Optional[int] = 20,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.WeeksResponse:
    r"""Get Season Weeks

    Retrieves all weeks for a specific season including preseason, regular season, and postseason.

    :param season: Season year
    :param limit: Maximum number of weeks to return
    :param retries: Override the default retry configuration for this method
    :param server_url: Override the default server URL for this method
    :param timeout_ms: Override the default request timeout configuration for this method in milliseconds
    :param http_headers: Additional headers to set or replace on requests.
    """
    config = self._get_season_weeks_config(
        season=season,
        limit=limit,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return self._execute_endpoint(config)
get_season_weeks_async async 
get_season_weeks_async(
    *,
    season: int,
    limit: Optional[int] = 20,
    retries: OptionalNullable[RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None
) -> WeeksResponse

Get Season Weeks

Source code in griddy/nfl/endpoints/regular/football/weeks.py 
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
async def get_season_weeks_async(
    self,
    *,
    season: int,
    limit: Optional[int] = 20,
    retries: OptionalNullable[utils.RetryConfig] = UNSET,
    server_url: Optional[str] = None,
    timeout_ms: Optional[int] = None,
    http_headers: Optional[Mapping[str, str]] = None,
) -> models.WeeksResponse:
    r"""Get Season Weeks"""
    config = self._get_season_weeks_config(
        season=season,
        limit=limit,
        retries=retries,
        server_url=server_url,
        timeout_ms=timeout_ms,
        http_headers=http_headers,
    )
    return await self._execute_endpoint_async(config)