Skip to content

Event

thingiverse.api.event

Contains endpoint functions for accessing the API

get_events

asyncio(*, client, page=UNSET, per_page=UNSET) async

List of events

Parameters:

Name Type Description Default
page int | Unset

Example: 1.

UNSET
per_page int | Unset

Example: 30.

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
GetEventsResponse401 | GetEventsResponse403 | GetEventsResponse404 | list[EventSchema] | None

GetEventsResponse401 | GetEventsResponse403 | GetEventsResponse404 | list[EventSchema]

Source code in thingiverse/api/event/get_events.py
async def asyncio(
    *,
    client: AuthenticatedClient,
    page: int | Unset = UNSET,
    per_page: int | Unset = UNSET,
) -> GetEventsResponse401 | GetEventsResponse403 | GetEventsResponse404 | list[EventSchema] | None:
    """List of events

    Args:
        page (int | Unset):  Example: 1.
        per_page (int | Unset):  Example: 30.

    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:
        GetEventsResponse401 | GetEventsResponse403 | GetEventsResponse404 | list[EventSchema]
    """

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

asyncio_detailed(*, client, page=UNSET, per_page=UNSET) async

List of events

Parameters:

Name Type Description Default
page int | Unset

Example: 1.

UNSET
per_page int | Unset

Example: 30.

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[GetEventsResponse401 | GetEventsResponse403 | GetEventsResponse404 | list[EventSchema]]

Response[GetEventsResponse401 | GetEventsResponse403 | GetEventsResponse404 | list[EventSchema]]

Source code in thingiverse/api/event/get_events.py
async def asyncio_detailed(
    *,
    client: AuthenticatedClient,
    page: int | Unset = UNSET,
    per_page: int | Unset = UNSET,
) -> Response[
    GetEventsResponse401 | GetEventsResponse403 | GetEventsResponse404 | list[EventSchema]
]:
    """List of events

    Args:
        page (int | Unset):  Example: 1.
        per_page (int | Unset):  Example: 30.

    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[GetEventsResponse401 | GetEventsResponse403 | GetEventsResponse404 | list[EventSchema]]
    """

    kwargs = _get_kwargs(
        page=page,
        per_page=per_page,
    )

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

    return _build_response(client=client, response=response)

sync(*, client, page=UNSET, per_page=UNSET)

List of events

Parameters:

Name Type Description Default
page int | Unset

Example: 1.

UNSET
per_page int | Unset

Example: 30.

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
GetEventsResponse401 | GetEventsResponse403 | GetEventsResponse404 | list[EventSchema] | None

GetEventsResponse401 | GetEventsResponse403 | GetEventsResponse404 | list[EventSchema]

Source code in thingiverse/api/event/get_events.py
def sync(
    *,
    client: AuthenticatedClient,
    page: int | Unset = UNSET,
    per_page: int | Unset = UNSET,
) -> GetEventsResponse401 | GetEventsResponse403 | GetEventsResponse404 | list[EventSchema] | None:
    """List of events

    Args:
        page (int | Unset):  Example: 1.
        per_page (int | Unset):  Example: 30.

    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:
        GetEventsResponse401 | GetEventsResponse403 | GetEventsResponse404 | list[EventSchema]
    """

    return sync_detailed(
        client=client,
        page=page,
        per_page=per_page,
    ).parsed

sync_detailed(*, client, page=UNSET, per_page=UNSET)

List of events

Parameters:

Name Type Description Default
page int | Unset

Example: 1.

UNSET
per_page int | Unset

Example: 30.

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[GetEventsResponse401 | GetEventsResponse403 | GetEventsResponse404 | list[EventSchema]]

Response[GetEventsResponse401 | GetEventsResponse403 | GetEventsResponse404 | list[EventSchema]]

Source code in thingiverse/api/event/get_events.py
def sync_detailed(
    *,
    client: AuthenticatedClient,
    page: int | Unset = UNSET,
    per_page: int | Unset = UNSET,
) -> Response[
    GetEventsResponse401 | GetEventsResponse403 | GetEventsResponse404 | list[EventSchema]
]:
    """List of events

    Args:
        page (int | Unset):  Example: 1.
        per_page (int | Unset):  Example: 30.

    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[GetEventsResponse401 | GetEventsResponse403 | GetEventsResponse404 | list[EventSchema]]
    """

    kwargs = _get_kwargs(
        page=page,
        per_page=per_page,
    )

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

    return _build_response(client=client, response=response)

get_events_id

asyncio(id, *, client) async

Get event by id

Parameters:

Name Type Description Default
id int

Example: 99.

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
EventSchema | GetEventsIdResponse401 | GetEventsIdResponse403 | GetEventsIdResponse404 | None

EventSchema | GetEventsIdResponse401 | GetEventsIdResponse403 | GetEventsIdResponse404

Source code in thingiverse/api/event/get_events_id.py
async def asyncio(
    id: int,
    *,
    client: AuthenticatedClient,
) -> EventSchema | GetEventsIdResponse401 | GetEventsIdResponse403 | GetEventsIdResponse404 | None:
    """Get event by id

    Args:
        id (int):  Example: 99.

    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:
        EventSchema | GetEventsIdResponse401 | GetEventsIdResponse403 | GetEventsIdResponse404
    """

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

asyncio_detailed(id, *, client) async

Get event by id

Parameters:

Name Type Description Default
id int

Example: 99.

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[EventSchema | GetEventsIdResponse401 | GetEventsIdResponse403 | GetEventsIdResponse404]

Response[EventSchema | GetEventsIdResponse401 | GetEventsIdResponse403 | GetEventsIdResponse404]

Source code in thingiverse/api/event/get_events_id.py
async def asyncio_detailed(
    id: int,
    *,
    client: AuthenticatedClient,
) -> Response[
    EventSchema | GetEventsIdResponse401 | GetEventsIdResponse403 | GetEventsIdResponse404
]:
    """Get event by id

    Args:
        id (int):  Example: 99.

    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[EventSchema | GetEventsIdResponse401 | GetEventsIdResponse403 | GetEventsIdResponse404]
    """

    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 event by id

Parameters:

Name Type Description Default
id int

Example: 99.

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
EventSchema | GetEventsIdResponse401 | GetEventsIdResponse403 | GetEventsIdResponse404 | None

EventSchema | GetEventsIdResponse401 | GetEventsIdResponse403 | GetEventsIdResponse404

Source code in thingiverse/api/event/get_events_id.py
def sync(
    id: int,
    *,
    client: AuthenticatedClient,
) -> EventSchema | GetEventsIdResponse401 | GetEventsIdResponse403 | GetEventsIdResponse404 | None:
    """Get event by id

    Args:
        id (int):  Example: 99.

    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:
        EventSchema | GetEventsIdResponse401 | GetEventsIdResponse403 | GetEventsIdResponse404
    """

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

sync_detailed(id, *, client)

Get event by id

Parameters:

Name Type Description Default
id int

Example: 99.

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[EventSchema | GetEventsIdResponse401 | GetEventsIdResponse403 | GetEventsIdResponse404]

Response[EventSchema | GetEventsIdResponse401 | GetEventsIdResponse403 | GetEventsIdResponse404]

Source code in thingiverse/api/event/get_events_id.py
def sync_detailed(
    id: int,
    *,
    client: AuthenticatedClient,
) -> Response[
    EventSchema | GetEventsIdResponse401 | GetEventsIdResponse403 | GetEventsIdResponse404
]:
    """Get event by id

    Args:
        id (int):  Example: 99.

    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[EventSchema | GetEventsIdResponse401 | GetEventsIdResponse403 | GetEventsIdResponse404]
    """

    kwargs = _get_kwargs(
        id=id,
    )

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

    return _build_response(client=client, response=response)