Skip to content

Sitewide Notification

thingiverse.api.sitewidenotification

Contains endpoint functions for accessing the API

get_sitewidenotification

asyncio(*, client) async

Get a sitewidenotification

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
GetSitewidenotificationResponse401 | GetSitewidenotificationResponse403 | GetSitewidenotificationResponse404 | None | SitewidenotificationSchemaType0 | None

GetSitewidenotificationResponse401 | GetSitewidenotificationResponse403 | GetSitewidenotificationResponse404 | None | SitewidenotificationSchemaType0
Source code in thingiverse/api/sitewidenotification/get_sitewidenotification.py 
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
async def asyncio(
    *,
    client: AuthenticatedClient,
) -> (
    GetSitewidenotificationResponse401
    | GetSitewidenotificationResponse403
    | GetSitewidenotificationResponse404
    | None
    | SitewidenotificationSchemaType0
    | None
):
    """Get a sitewidenotification

    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:
        GetSitewidenotificationResponse401 | GetSitewidenotificationResponse403 | GetSitewidenotificationResponse404 | None | SitewidenotificationSchemaType0
    """

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

asyncio_detailed(*, client) async

Get a sitewidenotification

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[GetSitewidenotificationResponse401 | GetSitewidenotificationResponse403 | GetSitewidenotificationResponse404 | None | SitewidenotificationSchemaType0]

Response[GetSitewidenotificationResponse401 | GetSitewidenotificationResponse403 | GetSitewidenotificationResponse404 | None | SitewidenotificationSchemaType0]
Source code in thingiverse/api/sitewidenotification/get_sitewidenotification.py 
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
async def asyncio_detailed(
    *,
    client: AuthenticatedClient,
) -> Response[
    GetSitewidenotificationResponse401
    | GetSitewidenotificationResponse403
    | GetSitewidenotificationResponse404
    | None
    | SitewidenotificationSchemaType0
]:
    """Get a sitewidenotification

    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[GetSitewidenotificationResponse401 | GetSitewidenotificationResponse403 | GetSitewidenotificationResponse404 | None | SitewidenotificationSchemaType0]
    """

    kwargs = _get_kwargs()

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

    return _build_response(client=client, response=response)

sync(*, client)

Get a sitewidenotification

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
GetSitewidenotificationResponse401 | GetSitewidenotificationResponse403 | GetSitewidenotificationResponse404 | None | SitewidenotificationSchemaType0 | None

GetSitewidenotificationResponse401 | GetSitewidenotificationResponse403 | GetSitewidenotificationResponse404 | None | SitewidenotificationSchemaType0
Source code in thingiverse/api/sitewidenotification/get_sitewidenotification.py 
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
def sync(
    *,
    client: AuthenticatedClient,
) -> (
    GetSitewidenotificationResponse401
    | GetSitewidenotificationResponse403
    | GetSitewidenotificationResponse404
    | None
    | SitewidenotificationSchemaType0
    | None
):
    """Get a sitewidenotification

    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:
        GetSitewidenotificationResponse401 | GetSitewidenotificationResponse403 | GetSitewidenotificationResponse404 | None | SitewidenotificationSchemaType0
    """

    return sync_detailed(
        client=client,
    ).parsed

sync_detailed(*, client)

Get a sitewidenotification

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[GetSitewidenotificationResponse401 | GetSitewidenotificationResponse403 | GetSitewidenotificationResponse404 | None | SitewidenotificationSchemaType0]

Response[GetSitewidenotificationResponse401 | GetSitewidenotificationResponse403 | GetSitewidenotificationResponse404 | None | SitewidenotificationSchemaType0]
Source code in thingiverse/api/sitewidenotification/get_sitewidenotification.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
def sync_detailed(
    *,
    client: AuthenticatedClient,
) -> Response[
    GetSitewidenotificationResponse401
    | GetSitewidenotificationResponse403
    | GetSitewidenotificationResponse404
    | None
    | SitewidenotificationSchemaType0
]:
    """Get a sitewidenotification

    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[GetSitewidenotificationResponse401 | GetSitewidenotificationResponse403 | GetSitewidenotificationResponse404 | None | SitewidenotificationSchemaType0]
    """

    kwargs = _get_kwargs()

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

    return _build_response(client=client, response=response)

get_sitewidenotification_id

asyncio(id, *, client) async

Get a sitewidenotification by id

Parameters:

Name Type Description Default
id int

Example: 1.

 required

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
GetSitewidenotificationIdResponse401 | GetSitewidenotificationIdResponse403 | GetSitewidenotificationIdResponse404 | None | SitewidenotificationSchemaType0 | None

GetSitewidenotificationIdResponse401 | GetSitewidenotificationIdResponse403 | GetSitewidenotificationIdResponse404 | None | SitewidenotificationSchemaType0
Source code in thingiverse/api/sitewidenotification/get_sitewidenotification_id.py 
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
async def asyncio(
    id: int,
    *,
    client: AuthenticatedClient,
) -> (
    GetSitewidenotificationIdResponse401
    | GetSitewidenotificationIdResponse403
    | GetSitewidenotificationIdResponse404
    | None
    | SitewidenotificationSchemaType0
    | None
):
    """Get a sitewidenotification by id

    Args:
        id (int):  Example: 1.

    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:
        GetSitewidenotificationIdResponse401 | GetSitewidenotificationIdResponse403 | GetSitewidenotificationIdResponse404 | None | SitewidenotificationSchemaType0
    """

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

asyncio_detailed(id, *, client) async

Get a sitewidenotification by id

Parameters:

Name Type Description Default
id int

Example: 1.

 required

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[GetSitewidenotificationIdResponse401 | GetSitewidenotificationIdResponse403 | GetSitewidenotificationIdResponse404 | None | SitewidenotificationSchemaType0]

Response[GetSitewidenotificationIdResponse401 | GetSitewidenotificationIdResponse403 | GetSitewidenotificationIdResponse404 | None | SitewidenotificationSchemaType0]
Source code in thingiverse/api/sitewidenotification/get_sitewidenotification_id.py 
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
190
191
192
193
194
async def asyncio_detailed(
    id: int,
    *,
    client: AuthenticatedClient,
) -> Response[
    GetSitewidenotificationIdResponse401
    | GetSitewidenotificationIdResponse403
    | GetSitewidenotificationIdResponse404
    | None
    | SitewidenotificationSchemaType0
]:
    """Get a sitewidenotification by id

    Args:
        id (int):  Example: 1.

    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[GetSitewidenotificationIdResponse401 | GetSitewidenotificationIdResponse403 | GetSitewidenotificationIdResponse404 | None | SitewidenotificationSchemaType0]
    """

    kwargs = _get_kwargs(
        id=id,
    )

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

    return _build_response(client=client, response=response)

sync(id, *, client)

Get a sitewidenotification by id

Parameters:

Name Type Description Default
id int

Example: 1.

 required

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
GetSitewidenotificationIdResponse401 | GetSitewidenotificationIdResponse403 | GetSitewidenotificationIdResponse404 | None | SitewidenotificationSchemaType0 | None

GetSitewidenotificationIdResponse401 | GetSitewidenotificationIdResponse403 | GetSitewidenotificationIdResponse404 | None | SitewidenotificationSchemaType0
Source code in thingiverse/api/sitewidenotification/get_sitewidenotification_id.py 
133
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
def sync(
    id: int,
    *,
    client: AuthenticatedClient,
) -> (
    GetSitewidenotificationIdResponse401
    | GetSitewidenotificationIdResponse403
    | GetSitewidenotificationIdResponse404
    | None
    | SitewidenotificationSchemaType0
    | None
):
    """Get a sitewidenotification by id

    Args:
        id (int):  Example: 1.

    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:
        GetSitewidenotificationIdResponse401 | GetSitewidenotificationIdResponse403 | GetSitewidenotificationIdResponse404 | None | SitewidenotificationSchemaType0
    """

    return sync_detailed(
        id=id,
        client=client,
    ).parsed

sync_detailed(id, *, client)

Get a sitewidenotification by id

Parameters:

Name Type Description Default
id int

Example: 1.

 required

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[GetSitewidenotificationIdResponse401 | GetSitewidenotificationIdResponse403 | GetSitewidenotificationIdResponse404 | None | SitewidenotificationSchemaType0]

Response[GetSitewidenotificationIdResponse401 | GetSitewidenotificationIdResponse403 | GetSitewidenotificationIdResponse404 | None | SitewidenotificationSchemaType0]
Source code in thingiverse/api/sitewidenotification/get_sitewidenotification_id.py 
 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
def sync_detailed(
    id: int,
    *,
    client: AuthenticatedClient,
) -> Response[
    GetSitewidenotificationIdResponse401
    | GetSitewidenotificationIdResponse403
    | GetSitewidenotificationIdResponse404
    | None
    | SitewidenotificationSchemaType0
]:
    """Get a sitewidenotification by id

    Args:
        id (int):  Example: 1.

    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[GetSitewidenotificationIdResponse401 | GetSitewidenotificationIdResponse403 | GetSitewidenotificationIdResponse404 | None | SitewidenotificationSchemaType0]
    """

    kwargs = _get_kwargs(
        id=id,
    )

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

    return _build_response(client=client, response=response)