Category
thingiverse.api.category
Contains endpoint functions for accessing the API
get_categories
asyncio(*, client, page=UNSET, per_page=UNSET)
async
List of root categories. Does not list any sub categories.
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 |
|---|---|
GetCategoriesResponse401 | GetCategoriesResponse403 | GetCategoriesResponse404 | list[GetCategoriesResponse200Item] | None
|
GetCategoriesResponse401 | GetCategoriesResponse403 | GetCategoriesResponse404 | list[GetCategoriesResponse200Item] |
Source code in thingiverse/api/category/get_categories.py
asyncio_detailed(*, client, page=UNSET, per_page=UNSET)
async
List of root categories. Does not list any sub categories.
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[GetCategoriesResponse401 | GetCategoriesResponse403 | GetCategoriesResponse404 | list[GetCategoriesResponse200Item]]
|
Response[GetCategoriesResponse401 | GetCategoriesResponse403 | GetCategoriesResponse404 | list[GetCategoriesResponse200Item]] |
Source code in thingiverse/api/category/get_categories.py
sync(*, client, page=UNSET, per_page=UNSET)
List of root categories. Does not list any sub categories.
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 |
|---|---|
GetCategoriesResponse401 | GetCategoriesResponse403 | GetCategoriesResponse404 | list[GetCategoriesResponse200Item] | None
|
GetCategoriesResponse401 | GetCategoriesResponse403 | GetCategoriesResponse404 | list[GetCategoriesResponse200Item] |
Source code in thingiverse/api/category/get_categories.py
sync_detailed(*, client, page=UNSET, per_page=UNSET)
List of root categories. Does not list any sub categories.
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[GetCategoriesResponse401 | GetCategoriesResponse403 | GetCategoriesResponse404 | list[GetCategoriesResponse200Item]]
|
Response[GetCategoriesResponse401 | GetCategoriesResponse403 | GetCategoriesResponse404 | list[GetCategoriesResponse200Item]] |
Source code in thingiverse/api/category/get_categories.py
get_categories_slug
asyncio(slug, *, client)
async
Get category by slug
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
slug
|
str
|
Example: art. |
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 |
|---|---|
GetCategoriesSlugResponse200 | GetCategoriesSlugResponse401 | GetCategoriesSlugResponse403 | GetCategoriesSlugResponse404 | None
|
GetCategoriesSlugResponse200 | GetCategoriesSlugResponse401 | GetCategoriesSlugResponse403 | GetCategoriesSlugResponse404 |
Source code in thingiverse/api/category/get_categories_slug.py
asyncio_detailed(slug, *, client)
async
Get category by slug
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
slug
|
str
|
Example: art. |
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[GetCategoriesSlugResponse200 | GetCategoriesSlugResponse401 | GetCategoriesSlugResponse403 | GetCategoriesSlugResponse404]
|
Response[GetCategoriesSlugResponse200 | GetCategoriesSlugResponse401 | GetCategoriesSlugResponse403 | GetCategoriesSlugResponse404] |
Source code in thingiverse/api/category/get_categories_slug.py
sync(slug, *, client)
Get category by slug
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
slug
|
str
|
Example: art. |
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 |
|---|---|
GetCategoriesSlugResponse200 | GetCategoriesSlugResponse401 | GetCategoriesSlugResponse403 | GetCategoriesSlugResponse404 | None
|
GetCategoriesSlugResponse200 | GetCategoriesSlugResponse401 | GetCategoriesSlugResponse403 | GetCategoriesSlugResponse404 |
Source code in thingiverse/api/category/get_categories_slug.py
sync_detailed(slug, *, client)
Get category by slug
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
slug
|
str
|
Example: art. |
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[GetCategoriesSlugResponse200 | GetCategoriesSlugResponse401 | GetCategoriesSlugResponse403 | GetCategoriesSlugResponse404]
|
Response[GetCategoriesSlugResponse200 | GetCategoriesSlugResponse401 | GetCategoriesSlugResponse403 | GetCategoriesSlugResponse404] |
Source code in thingiverse/api/category/get_categories_slug.py
get_categories_slug_things
asyncio(slug, *, client, page=UNSET, per_page=UNSET)
async
Get list of things of the corresponding category by slug
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
slug
|
str
|
Example: art. |
required |
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 |
|---|---|
GetCategoriesSlugThingsResponse401 | GetCategoriesSlugThingsResponse403 | GetCategoriesSlugThingsResponse404 | list[ThingSchema] | None
|
GetCategoriesSlugThingsResponse401 | GetCategoriesSlugThingsResponse403 | GetCategoriesSlugThingsResponse404 | list[ThingSchema] |
Source code in thingiverse/api/category/get_categories_slug_things.py
asyncio_detailed(slug, *, client, page=UNSET, per_page=UNSET)
async
Get list of things of the corresponding category by slug
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
slug
|
str
|
Example: art. |
required |
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[GetCategoriesSlugThingsResponse401 | GetCategoriesSlugThingsResponse403 | GetCategoriesSlugThingsResponse404 | list[ThingSchema]]
|
Response[GetCategoriesSlugThingsResponse401 | GetCategoriesSlugThingsResponse403 | GetCategoriesSlugThingsResponse404 | list[ThingSchema]] |
Source code in thingiverse/api/category/get_categories_slug_things.py
sync(slug, *, client, page=UNSET, per_page=UNSET)
Get list of things of the corresponding category by slug
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
slug
|
str
|
Example: art. |
required |
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 |
|---|---|
GetCategoriesSlugThingsResponse401 | GetCategoriesSlugThingsResponse403 | GetCategoriesSlugThingsResponse404 | list[ThingSchema] | None
|
GetCategoriesSlugThingsResponse401 | GetCategoriesSlugThingsResponse403 | GetCategoriesSlugThingsResponse404 | list[ThingSchema] |
Source code in thingiverse/api/category/get_categories_slug_things.py
sync_detailed(slug, *, client, page=UNSET, per_page=UNSET)
Get list of things of the corresponding category by slug
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
slug
|
str
|
Example: art. |
required |
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[GetCategoriesSlugThingsResponse401 | GetCategoriesSlugThingsResponse403 | GetCategoriesSlugThingsResponse404 | list[ThingSchema]]
|
Response[GetCategoriesSlugThingsResponse401 | GetCategoriesSlugThingsResponse403 | GetCategoriesSlugThingsResponse404 | list[ThingSchema]] |
Source code in thingiverse/api/category/get_categories_slug_things.py
get_categoriesreturncomplete
asyncio(*, client, page=UNSET, per_page=UNSET)
async
List of root categories and their nested children.
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 |
|---|---|
GetCategoriesreturncompleteResponse401 | GetCategoriesreturncompleteResponse403 | GetCategoriesreturncompleteResponse404 | list[GetCategoriesreturncompleteResponse200Item] | None
|
GetCategoriesreturncompleteResponse401 | GetCategoriesreturncompleteResponse403 | GetCategoriesreturncompleteResponse404 | list[GetCategoriesreturncompleteResponse200Item] |
Source code in thingiverse/api/category/get_categoriesreturncomplete.py
asyncio_detailed(*, client, page=UNSET, per_page=UNSET)
async
List of root categories and their nested children.
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[GetCategoriesreturncompleteResponse401 | GetCategoriesreturncompleteResponse403 | GetCategoriesreturncompleteResponse404 | list[GetCategoriesreturncompleteResponse200Item]]
|
Response[GetCategoriesreturncompleteResponse401 | GetCategoriesreturncompleteResponse403 | GetCategoriesreturncompleteResponse404 | list[GetCategoriesreturncompleteResponse200Item]] |
Source code in thingiverse/api/category/get_categoriesreturncomplete.py
sync(*, client, page=UNSET, per_page=UNSET)
List of root categories and their nested children.
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 |
|---|---|
GetCategoriesreturncompleteResponse401 | GetCategoriesreturncompleteResponse403 | GetCategoriesreturncompleteResponse404 | list[GetCategoriesreturncompleteResponse200Item] | None
|
GetCategoriesreturncompleteResponse401 | GetCategoriesreturncompleteResponse403 | GetCategoriesreturncompleteResponse404 | list[GetCategoriesreturncompleteResponse200Item] |
Source code in thingiverse/api/category/get_categoriesreturncomplete.py
sync_detailed(*, client, page=UNSET, per_page=UNSET)
List of root categories and their nested children.
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[GetCategoriesreturncompleteResponse401 | GetCategoriesreturncompleteResponse403 | GetCategoriesreturncompleteResponse404 | list[GetCategoriesreturncompleteResponse200Item]]
|
Response[GetCategoriesreturncompleteResponse401 | GetCategoriesreturncompleteResponse403 | GetCategoriesreturncompleteResponse404 | list[GetCategoriesreturncompleteResponse200Item]] |