Skip to content

Banner

thingiverse.api.banner

Contains endpoint functions for accessing the API

get_banner

asyncio(*, client, location, query=UNSET, category_id=UNSET, type_=UNSET, search=UNSET) async

Get a banner (ad)

Parameters:

Name Type Description Default
location GetBannerLocation
required
query str | Unset

Example: 3D.

 UNSET
category_id int | Unset

Example: 63.

 UNSET
type_ GetBannerType | Unset
UNSET
search str | Unset

Example: q=test&page=1&type=things&sort=relevant.

 UNSET

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
BannerSchema | GetBannerResponse401 | GetBannerResponse403 | GetBannerResponse404 | None

BannerSchema | GetBannerResponse401 | GetBannerResponse403 | GetBannerResponse404
Source code in thingiverse/api/banner/get_banner.py 
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
async def asyncio(
    *,
    client: AuthenticatedClient,
    location: GetBannerLocation,
    query: str | Unset = UNSET,
    category_id: int | Unset = UNSET,
    type_: GetBannerType | Unset = UNSET,
    search: str | Unset = UNSET,
) -> BannerSchema | GetBannerResponse401 | GetBannerResponse403 | GetBannerResponse404 | None:
    """Get a banner (ad)

    Args:
        location (GetBannerLocation):
        query (str | Unset):  Example: 3D.
        category_id (int | Unset):  Example: 63.
        type_ (GetBannerType | Unset):
        search (str | Unset):  Example: q=test&page=1&type=things&sort=relevant.

    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:
        BannerSchema | GetBannerResponse401 | GetBannerResponse403 | GetBannerResponse404
    """

    return (
        await asyncio_detailed(
            client=client,
            location=location,
            query=query,
            category_id=category_id,
            type_=type_,
            search=search,
        )
    ).parsed

asyncio_detailed(*, client, location, query=UNSET, category_id=UNSET, type_=UNSET, search=UNSET) async

Get a banner (ad)

Parameters:

Name Type Description Default
location GetBannerLocation
required
query str | Unset

Example: 3D.

 UNSET
category_id int | Unset

Example: 63.

 UNSET
type_ GetBannerType | Unset
UNSET
search str | Unset

Example: q=test&page=1&type=things&sort=relevant.

 UNSET

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[BannerSchema | GetBannerResponse401 | GetBannerResponse403 | GetBannerResponse404]

Response[BannerSchema | GetBannerResponse401 | GetBannerResponse403 | GetBannerResponse404]
Source code in thingiverse/api/banner/get_banner.py 
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
async def asyncio_detailed(
    *,
    client: AuthenticatedClient,
    location: GetBannerLocation,
    query: str | Unset = UNSET,
    category_id: int | Unset = UNSET,
    type_: GetBannerType | Unset = UNSET,
    search: str | Unset = UNSET,
) -> Response[BannerSchema | GetBannerResponse401 | GetBannerResponse403 | GetBannerResponse404]:
    """Get a banner (ad)

    Args:
        location (GetBannerLocation):
        query (str | Unset):  Example: 3D.
        category_id (int | Unset):  Example: 63.
        type_ (GetBannerType | Unset):
        search (str | Unset):  Example: q=test&page=1&type=things&sort=relevant.

    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[BannerSchema | GetBannerResponse401 | GetBannerResponse403 | GetBannerResponse404]
    """

    kwargs = _get_kwargs(
        location=location,
        query=query,
        category_id=category_id,
        type_=type_,
        search=search,
    )

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

    return _build_response(client=client, response=response)

sync(*, client, location, query=UNSET, category_id=UNSET, type_=UNSET, search=UNSET)

Get a banner (ad)

Parameters:

Name Type Description Default
location GetBannerLocation
required
query str | Unset

Example: 3D.

 UNSET
category_id int | Unset

Example: 63.

 UNSET
type_ GetBannerType | Unset
UNSET
search str | Unset

Example: q=test&page=1&type=things&sort=relevant.

 UNSET

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
BannerSchema | GetBannerResponse401 | GetBannerResponse403 | GetBannerResponse404 | None

BannerSchema | GetBannerResponse401 | GetBannerResponse403 | GetBannerResponse404
Source code in thingiverse/api/banner/get_banner.py 
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
def sync(
    *,
    client: AuthenticatedClient,
    location: GetBannerLocation,
    query: str | Unset = UNSET,
    category_id: int | Unset = UNSET,
    type_: GetBannerType | Unset = UNSET,
    search: str | Unset = UNSET,
) -> BannerSchema | GetBannerResponse401 | GetBannerResponse403 | GetBannerResponse404 | None:
    """Get a banner (ad)

    Args:
        location (GetBannerLocation):
        query (str | Unset):  Example: 3D.
        category_id (int | Unset):  Example: 63.
        type_ (GetBannerType | Unset):
        search (str | Unset):  Example: q=test&page=1&type=things&sort=relevant.

    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:
        BannerSchema | GetBannerResponse401 | GetBannerResponse403 | GetBannerResponse404
    """

    return sync_detailed(
        client=client,
        location=location,
        query=query,
        category_id=category_id,
        type_=type_,
        search=search,
    ).parsed

sync_detailed(*, client, location, query=UNSET, category_id=UNSET, type_=UNSET, search=UNSET)

Get a banner (ad)

Parameters:

Name Type Description Default
location GetBannerLocation
required
query str | Unset

Example: 3D.

 UNSET
category_id int | Unset

Example: 63.

 UNSET
type_ GetBannerType | Unset
UNSET
search str | Unset

Example: q=test&page=1&type=things&sort=relevant.

 UNSET

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[BannerSchema | GetBannerResponse401 | GetBannerResponse403 | GetBannerResponse404]

Response[BannerSchema | GetBannerResponse401 | GetBannerResponse403 | GetBannerResponse404]
Source code in thingiverse/api/banner/get_banner.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
def sync_detailed(
    *,
    client: AuthenticatedClient,
    location: GetBannerLocation,
    query: str | Unset = UNSET,
    category_id: int | Unset = UNSET,
    type_: GetBannerType | Unset = UNSET,
    search: str | Unset = UNSET,
) -> Response[BannerSchema | GetBannerResponse401 | GetBannerResponse403 | GetBannerResponse404]:
    """Get a banner (ad)

    Args:
        location (GetBannerLocation):
        query (str | Unset):  Example: 3D.
        category_id (int | Unset):  Example: 63.
        type_ (GetBannerType | Unset):
        search (str | Unset):  Example: q=test&page=1&type=things&sort=relevant.

    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[BannerSchema | GetBannerResponse401 | GetBannerResponse403 | GetBannerResponse404]
    """

    kwargs = _get_kwargs(
        location=location,
        query=query,
        category_id=category_id,
        type_=type_,
        search=search,
    )

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

    return _build_response(client=client, response=response)

get_banner_0_page_ad

asyncio(*, client, location, query=UNSET, category_id=UNSET, type_=UNSET, search=UNSET) async

Get banner (ad) for a certain page

Parameters:

Name Type Description Default
location GetBanner0PageAdLocation
required
query str | Unset

Example: 3D.

 UNSET
category_id int | Unset

Example: 63.

 UNSET
type_ GetBanner0PageAdType | Unset
UNSET
search str | Unset

Example: q=test&page=1&type=things&sort=relevant.

 UNSET

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
GetBanner0PageAdResponse200 | GetBanner0PageAdResponse401 | GetBanner0PageAdResponse403 | GetBanner0PageAdResponse404 | None

GetBanner0PageAdResponse200 | GetBanner0PageAdResponse401 | GetBanner0PageAdResponse403 | GetBanner0PageAdResponse404
Source code in thingiverse/api/banner/get_banner_0_page_ad.py 
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
async def asyncio(
    *,
    client: AuthenticatedClient,
    location: GetBanner0PageAdLocation,
    query: str | Unset = UNSET,
    category_id: int | Unset = UNSET,
    type_: GetBanner0PageAdType | Unset = UNSET,
    search: str | Unset = UNSET,
) -> (
    GetBanner0PageAdResponse200
    | GetBanner0PageAdResponse401
    | GetBanner0PageAdResponse403
    | GetBanner0PageAdResponse404
    | None
):
    """Get banner (ad) for a certain page

    Args:
        location (GetBanner0PageAdLocation):
        query (str | Unset):  Example: 3D.
        category_id (int | Unset):  Example: 63.
        type_ (GetBanner0PageAdType | Unset):
        search (str | Unset):  Example: q=test&page=1&type=things&sort=relevant.

    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:
        GetBanner0PageAdResponse200 | GetBanner0PageAdResponse401 | GetBanner0PageAdResponse403 | GetBanner0PageAdResponse404
    """

    return (
        await asyncio_detailed(
            client=client,
            location=location,
            query=query,
            category_id=category_id,
            type_=type_,
            search=search,
        )
    ).parsed

asyncio_detailed(*, client, location, query=UNSET, category_id=UNSET, type_=UNSET, search=UNSET) async

Get banner (ad) for a certain page

Parameters:

Name Type Description Default
location GetBanner0PageAdLocation
required
query str | Unset

Example: 3D.

 UNSET
category_id int | Unset

Example: 63.

 UNSET
type_ GetBanner0PageAdType | Unset
UNSET
search str | Unset

Example: q=test&page=1&type=things&sort=relevant.

 UNSET

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[GetBanner0PageAdResponse200 | GetBanner0PageAdResponse401 | GetBanner0PageAdResponse403 | GetBanner0PageAdResponse404]

Response[GetBanner0PageAdResponse200 | GetBanner0PageAdResponse401 | GetBanner0PageAdResponse403 | GetBanner0PageAdResponse404]
Source code in thingiverse/api/banner/get_banner_0_page_ad.py 
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
async def asyncio_detailed(
    *,
    client: AuthenticatedClient,
    location: GetBanner0PageAdLocation,
    query: str | Unset = UNSET,
    category_id: int | Unset = UNSET,
    type_: GetBanner0PageAdType | Unset = UNSET,
    search: str | Unset = UNSET,
) -> Response[
    GetBanner0PageAdResponse200
    | GetBanner0PageAdResponse401
    | GetBanner0PageAdResponse403
    | GetBanner0PageAdResponse404
]:
    """Get banner (ad) for a certain page

    Args:
        location (GetBanner0PageAdLocation):
        query (str | Unset):  Example: 3D.
        category_id (int | Unset):  Example: 63.
        type_ (GetBanner0PageAdType | Unset):
        search (str | Unset):  Example: q=test&page=1&type=things&sort=relevant.

    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[GetBanner0PageAdResponse200 | GetBanner0PageAdResponse401 | GetBanner0PageAdResponse403 | GetBanner0PageAdResponse404]
    """

    kwargs = _get_kwargs(
        location=location,
        query=query,
        category_id=category_id,
        type_=type_,
        search=search,
    )

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

    return _build_response(client=client, response=response)

sync(*, client, location, query=UNSET, category_id=UNSET, type_=UNSET, search=UNSET)

Get banner (ad) for a certain page

Parameters:

Name Type Description Default
location GetBanner0PageAdLocation
required
query str | Unset

Example: 3D.

 UNSET
category_id int | Unset

Example: 63.

 UNSET
type_ GetBanner0PageAdType | Unset
UNSET
search str | Unset

Example: q=test&page=1&type=things&sort=relevant.

 UNSET

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
GetBanner0PageAdResponse200 | GetBanner0PageAdResponse401 | GetBanner0PageAdResponse403 | GetBanner0PageAdResponse404 | None

GetBanner0PageAdResponse200 | GetBanner0PageAdResponse401 | GetBanner0PageAdResponse403 | GetBanner0PageAdResponse404
Source code in thingiverse/api/banner/get_banner_0_page_ad.py 
150
151
152
153
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
179
180
181
182
183
184
185
186
187
188
189
def sync(
    *,
    client: AuthenticatedClient,
    location: GetBanner0PageAdLocation,
    query: str | Unset = UNSET,
    category_id: int | Unset = UNSET,
    type_: GetBanner0PageAdType | Unset = UNSET,
    search: str | Unset = UNSET,
) -> (
    GetBanner0PageAdResponse200
    | GetBanner0PageAdResponse401
    | GetBanner0PageAdResponse403
    | GetBanner0PageAdResponse404
    | None
):
    """Get banner (ad) for a certain page

    Args:
        location (GetBanner0PageAdLocation):
        query (str | Unset):  Example: 3D.
        category_id (int | Unset):  Example: 63.
        type_ (GetBanner0PageAdType | Unset):
        search (str | Unset):  Example: q=test&page=1&type=things&sort=relevant.

    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:
        GetBanner0PageAdResponse200 | GetBanner0PageAdResponse401 | GetBanner0PageAdResponse403 | GetBanner0PageAdResponse404
    """

    return sync_detailed(
        client=client,
        location=location,
        query=query,
        category_id=category_id,
        type_=type_,
        search=search,
    ).parsed

sync_detailed(*, client, location, query=UNSET, category_id=UNSET, type_=UNSET, search=UNSET)

Get banner (ad) for a certain page

Parameters:

Name Type Description Default
location GetBanner0PageAdLocation
required
query str | Unset

Example: 3D.

 UNSET
category_id int | Unset

Example: 63.

 UNSET
type_ GetBanner0PageAdType | Unset
UNSET
search str | Unset

Example: q=test&page=1&type=things&sort=relevant.

 UNSET

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[GetBanner0PageAdResponse200 | GetBanner0PageAdResponse401 | GetBanner0PageAdResponse403 | GetBanner0PageAdResponse404]

Response[GetBanner0PageAdResponse200 | GetBanner0PageAdResponse401 | GetBanner0PageAdResponse403 | GetBanner0PageAdResponse404]
Source code in thingiverse/api/banner/get_banner_0_page_ad.py 
104
105
106
107
108
109
110
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
141
142
143
144
145
146
147
def sync_detailed(
    *,
    client: AuthenticatedClient,
    location: GetBanner0PageAdLocation,
    query: str | Unset = UNSET,
    category_id: int | Unset = UNSET,
    type_: GetBanner0PageAdType | Unset = UNSET,
    search: str | Unset = UNSET,
) -> Response[
    GetBanner0PageAdResponse200
    | GetBanner0PageAdResponse401
    | GetBanner0PageAdResponse403
    | GetBanner0PageAdResponse404
]:
    """Get banner (ad) for a certain page

    Args:
        location (GetBanner0PageAdLocation):
        query (str | Unset):  Example: 3D.
        category_id (int | Unset):  Example: 63.
        type_ (GetBanner0PageAdType | Unset):
        search (str | Unset):  Example: q=test&page=1&type=things&sort=relevant.

    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[GetBanner0PageAdResponse200 | GetBanner0PageAdResponse401 | GetBanner0PageAdResponse403 | GetBanner0PageAdResponse404]
    """

    kwargs = _get_kwargs(
        location=location,
        query=query,
        category_id=category_id,
        type_=type_,
        search=search,
    )

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

    return _build_response(client=client, response=response)