Skip to content

Home Banner

thingiverse.api.home_banner

Contains endpoint functions for accessing the API

get_homebanner

asyncio(*, client) async

Get the banner on the home page

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
GetHomebannerResponse401 | GetHomebannerResponse403 | GetHomebannerResponse404 | HomebannerSchema | None

GetHomebannerResponse401 | GetHomebannerResponse403 | GetHomebannerResponse404 | HomebannerSchema
Source code in thingiverse/api/home_banner/get_homebanner.py 
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
async def asyncio(
    *,
    client: AuthenticatedClient,
) -> (
    GetHomebannerResponse401
    | GetHomebannerResponse403
    | GetHomebannerResponse404
    | HomebannerSchema
    | None
):
    """Get the banner on the home page

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        GetHomebannerResponse401 | GetHomebannerResponse403 | GetHomebannerResponse404 | HomebannerSchema
    """

    return (
        await asyncio_detailed(
            client=client,
        )
    ).parsed

asyncio_detailed(*, client) async

Get the banner on the home page

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Response[GetHomebannerResponse401 | GetHomebannerResponse403 | GetHomebannerResponse404 | HomebannerSchema]

Response[GetHomebannerResponse401 | GetHomebannerResponse403 | GetHomebannerResponse404 | HomebannerSchema]
Source code in thingiverse/api/home_banner/get_homebanner.py 
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
async def asyncio_detailed(
    *,
    client: AuthenticatedClient,
) -> Response[
    GetHomebannerResponse401
    | GetHomebannerResponse403
    | GetHomebannerResponse404
    | HomebannerSchema
]:
    """Get the banner on the home page

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        Response[GetHomebannerResponse401 | GetHomebannerResponse403 | GetHomebannerResponse404 | HomebannerSchema]
    """

    kwargs = _get_kwargs()

    response = await client.get_async_httpx_client().request(**kwargs)

    return _build_response(client=client, response=response)

sync(*, client)

Get the banner on the home page

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
GetHomebannerResponse401 | GetHomebannerResponse403 | GetHomebannerResponse404 | HomebannerSchema | None

GetHomebannerResponse401 | GetHomebannerResponse403 | GetHomebannerResponse404 | HomebannerSchema
Source code in thingiverse/api/home_banner/get_homebanner.py 
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
def sync(
    *,
    client: AuthenticatedClient,
) -> (
    GetHomebannerResponse401
    | GetHomebannerResponse403
    | GetHomebannerResponse404
    | HomebannerSchema
    | None
):
    """Get the banner on the home page

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        GetHomebannerResponse401 | GetHomebannerResponse403 | GetHomebannerResponse404 | HomebannerSchema
    """

    return sync_detailed(
        client=client,
    ).parsed

sync_detailed(*, client)

Get the banner on the home page

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Response[GetHomebannerResponse401 | GetHomebannerResponse403 | GetHomebannerResponse404 | HomebannerSchema]

Response[GetHomebannerResponse401 | GetHomebannerResponse403 | GetHomebannerResponse404 | HomebannerSchema]
Source code in thingiverse/api/home_banner/get_homebanner.py 
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
def sync_detailed(
    *,
    client: AuthenticatedClient,
) -> Response[
    GetHomebannerResponse401
    | GetHomebannerResponse403
    | GetHomebannerResponse404
    | HomebannerSchema
]:
    """Get the banner on the home page

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        Response[GetHomebannerResponse401 | GetHomebannerResponse403 | GetHomebannerResponse404 | HomebannerSchema]
    """

    kwargs = _get_kwargs()

    response = client.get_httpx_client().request(
        **kwargs,
    )

    return _build_response(client=client, response=response)