"""List collections"""
from http import HTTPStatus
from typing import Any
from typing import Dict
from typing import List
from typing import Union
import httpx
from ... import errors
from ...client import AuthenticatedClient
from ...client import Client
from ...models.collection_access_level import CollectionAccessLevel
from ...models.collections_get_collections_collection_list import (
CollectionsGetCollectionsCollectionList,
)
from ...models.collections_get_collections_sort import CollectionsGetCollectionsSort
from ...models.collections_get_collections_sort_dir import (
CollectionsGetCollectionsSortDir,
)
from ...models.collections_get_collections_version import (
CollectionsGetCollectionsVersion,
)
from ...models.server_error import ServerError
from ...types import Response
from ...types import UNSET
from ...types import Unset
def _get_kwargs(
*,
id: Union[Unset, str] = UNSET,
id_prefix: Union[Unset, str] = UNSET,
name: Union[Unset, str] = UNSET,
account_id: Union[Unset, str] = UNSET,
not_account_id: Union[Unset, str] = UNSET,
meta: Union[Unset, str] = UNSET,
bmeta: Union[Unset, str] = UNSET,
version: Union[Unset, CollectionsGetCollectionsVersion] = UNSET,
version_suffix: Union[Unset, str] = UNSET,
public: Union[Unset, bool] = UNSET,
shared_with: Union[Unset, str] = UNSET,
editable: Union[Unset, bool] = UNSET,
starred: Union[Unset, bool] = UNSET,
access_level: Union[Unset, CollectionAccessLevel] = UNSET,
de: Union[Unset, List[str]] = UNSET,
sort: Union[Unset, CollectionsGetCollectionsSort] = UNSET,
sort_dir: Union[Unset, CollectionsGetCollectionsSortDir] = UNSET,
page_size: Union[Unset, int] = 50,
) -> Dict[str, Any]:
params: Dict[str, Any] = {}
params["id"] = id
params["id_prefix"] = id_prefix
params["name"] = name
params["account_id"] = account_id
params["not_account_id"] = not_account_id
params["meta"] = meta
params["bmeta"] = bmeta
json_version: Union[Unset, str] = UNSET
if not isinstance(version, Unset):
json_version = version.value
params["version"] = json_version
params["version_suffix"] = version_suffix
params["public"] = public
params["shared_with"] = shared_with
params["editable"] = editable
params["starred"] = starred
json_access_level: Union[Unset, str] = UNSET
if not isinstance(access_level, Unset):
json_access_level = access_level.value
params["access_level"] = json_access_level
json_de: Union[Unset, List[str]] = UNSET
if not isinstance(de, Unset):
json_de = de
params["de"] = json_de
json_sort: Union[Unset, str] = UNSET
if not isinstance(sort, Unset):
json_sort = sort.value
params["sort"] = json_sort
json_sort_dir: Union[Unset, str] = UNSET
if not isinstance(sort_dir, Unset):
json_sort_dir = sort_dir.value
params["sort_dir"] = json_sort_dir
params["page_size"] = page_size
params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
_kwargs: Dict[str, Any] = {
"method": "get",
"url": "/collections",
"params": params,
}
return _kwargs
def _parse_response(
*, client: Union[AuthenticatedClient, Client], response: httpx.Response
) -> Union[CollectionsGetCollectionsCollectionList, ServerError]:
if response.status_code == HTTPStatus.OK:
response_200 = CollectionsGetCollectionsCollectionList.from_dict(
response.json()
)
return response_200
if response.status_code == HTTPStatus.INTERNAL_SERVER_ERROR:
response_500 = ServerError.from_dict(response.json())
return response_500
raise errors.UnexpectedStatus(response.status_code, response.content)
def _build_response(
*, client: Union[AuthenticatedClient, Client], response: httpx.Response
) -> Response[Union[CollectionsGetCollectionsCollectionList, ServerError]]:
return Response(
status_code=HTTPStatus(response.status_code),
content=response.content,
headers=response.headers,
parsed=_parse_response(client=client, response=response),
)
[docs]
def sync_detailed(
*,
client: AuthenticatedClient,
id: Union[Unset, str] = UNSET,
id_prefix: Union[Unset, str] = UNSET,
name: Union[Unset, str] = UNSET,
account_id: Union[Unset, str] = UNSET,
not_account_id: Union[Unset, str] = UNSET,
meta: Union[Unset, str] = UNSET,
bmeta: Union[Unset, str] = UNSET,
version: Union[Unset, CollectionsGetCollectionsVersion] = UNSET,
version_suffix: Union[Unset, str] = UNSET,
public: Union[Unset, bool] = UNSET,
shared_with: Union[Unset, str] = UNSET,
editable: Union[Unset, bool] = UNSET,
starred: Union[Unset, bool] = UNSET,
access_level: Union[Unset, CollectionAccessLevel] = UNSET,
de: Union[Unset, List[str]] = UNSET,
sort: Union[Unset, CollectionsGetCollectionsSort] = UNSET,
sort_dir: Union[Unset, CollectionsGetCollectionsSortDir] = UNSET,
page_size: Union[Unset, int] = 50,
) -> Response[Union[CollectionsGetCollectionsCollectionList, ServerError]]:
"""List collections
List all collections that are visible to the current user,
whether logged in or not.
Args:
id (Union[Unset, str]):
id_prefix (Union[Unset, str]):
name (Union[Unset, str]):
account_id (Union[Unset, str]):
not_account_id (Union[Unset, str]):
meta (Union[Unset, str]):
bmeta (Union[Unset, str]):
version (Union[Unset, CollectionsGetCollectionsVersion]):
version_suffix (Union[Unset, str]):
public (Union[Unset, bool]):
shared_with (Union[Unset, str]):
editable (Union[Unset, bool]):
starred (Union[Unset, bool]):
access_level (Union[Unset, CollectionAccessLevel]):
de (Union[Unset, List[str]]):
sort (Union[Unset, CollectionsGetCollectionsSort]):
sort_dir (Union[Unset, CollectionsGetCollectionsSortDir]):
page_size (Union[Unset, int]): Default: 50.
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[Union[CollectionsGetCollectionsCollectionList, ServerError]]
"""
kwargs = _get_kwargs(
id=id,
id_prefix=id_prefix,
name=name,
account_id=account_id,
not_account_id=not_account_id,
meta=meta,
bmeta=bmeta,
version=version,
version_suffix=version_suffix,
public=public,
shared_with=shared_with,
editable=editable,
starred=starred,
access_level=access_level,
de=de,
sort=sort,
sort_dir=sort_dir,
page_size=page_size,
)
response = client.get_httpx_client().request(
**kwargs,
)
return _build_response(client=client, response=response)
[docs]
def sync(
*,
client: AuthenticatedClient,
id: Union[Unset, str] = UNSET,
id_prefix: Union[Unset, str] = UNSET,
name: Union[Unset, str] = UNSET,
account_id: Union[Unset, str] = UNSET,
not_account_id: Union[Unset, str] = UNSET,
meta: Union[Unset, str] = UNSET,
bmeta: Union[Unset, str] = UNSET,
version: Union[Unset, CollectionsGetCollectionsVersion] = UNSET,
version_suffix: Union[Unset, str] = UNSET,
public: Union[Unset, bool] = UNSET,
shared_with: Union[Unset, str] = UNSET,
editable: Union[Unset, bool] = UNSET,
starred: Union[Unset, bool] = UNSET,
access_level: Union[Unset, CollectionAccessLevel] = UNSET,
de: Union[Unset, List[str]] = UNSET,
sort: Union[Unset, CollectionsGetCollectionsSort] = UNSET,
sort_dir: Union[Unset, CollectionsGetCollectionsSortDir] = UNSET,
page_size: Union[Unset, int] = 50,
) -> Union[CollectionsGetCollectionsCollectionList]:
"""List collections
List all collections that are visible to the current user,
whether logged in or not.
Args:
id (Union[Unset, str]):
id_prefix (Union[Unset, str]):
name (Union[Unset, str]):
account_id (Union[Unset, str]):
not_account_id (Union[Unset, str]):
meta (Union[Unset, str]):
bmeta (Union[Unset, str]):
version (Union[Unset, CollectionsGetCollectionsVersion]):
version_suffix (Union[Unset, str]):
public (Union[Unset, bool]):
shared_with (Union[Unset, str]):
editable (Union[Unset, bool]):
starred (Union[Unset, bool]):
access_level (Union[Unset, CollectionAccessLevel]):
de (Union[Unset, List[str]]):
sort (Union[Unset, CollectionsGetCollectionsSort]):
sort_dir (Union[Unset, CollectionsGetCollectionsSortDir]):
page_size (Union[Unset, int]): Default: 50.
Raises:
errors.UnexpectedStatus: If the server returns a status code greater than or equal to 300.
httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:
Union[CollectionsGetCollectionsCollectionList]
"""
response = sync_detailed(
client=client,
id=id,
id_prefix=id_prefix,
name=name,
account_id=account_id,
not_account_id=not_account_id,
meta=meta,
bmeta=bmeta,
version=version,
version_suffix=version_suffix,
public=public,
shared_with=shared_with,
editable=editable,
starred=starred,
access_level=access_level,
de=de,
sort=sort,
sort_dir=sort_dir,
page_size=page_size,
)
if isinstance(response.parsed, ServerError):
raise errors.UnexpectedStatus(response.status_code, response.content)
return response.parsed
[docs]
async def asyncio_detailed(
*,
client: AuthenticatedClient,
id: Union[Unset, str] = UNSET,
id_prefix: Union[Unset, str] = UNSET,
name: Union[Unset, str] = UNSET,
account_id: Union[Unset, str] = UNSET,
not_account_id: Union[Unset, str] = UNSET,
meta: Union[Unset, str] = UNSET,
bmeta: Union[Unset, str] = UNSET,
version: Union[Unset, CollectionsGetCollectionsVersion] = UNSET,
version_suffix: Union[Unset, str] = UNSET,
public: Union[Unset, bool] = UNSET,
shared_with: Union[Unset, str] = UNSET,
editable: Union[Unset, bool] = UNSET,
starred: Union[Unset, bool] = UNSET,
access_level: Union[Unset, CollectionAccessLevel] = UNSET,
de: Union[Unset, List[str]] = UNSET,
sort: Union[Unset, CollectionsGetCollectionsSort] = UNSET,
sort_dir: Union[Unset, CollectionsGetCollectionsSortDir] = UNSET,
page_size: Union[Unset, int] = 50,
) -> Response[Union[CollectionsGetCollectionsCollectionList, ServerError]]:
"""List collections
List all collections that are visible to the current user,
whether logged in or not.
Args:
id (Union[Unset, str]):
id_prefix (Union[Unset, str]):
name (Union[Unset, str]):
account_id (Union[Unset, str]):
not_account_id (Union[Unset, str]):
meta (Union[Unset, str]):
bmeta (Union[Unset, str]):
version (Union[Unset, CollectionsGetCollectionsVersion]):
version_suffix (Union[Unset, str]):
public (Union[Unset, bool]):
shared_with (Union[Unset, str]):
editable (Union[Unset, bool]):
starred (Union[Unset, bool]):
access_level (Union[Unset, CollectionAccessLevel]):
de (Union[Unset, List[str]]):
sort (Union[Unset, CollectionsGetCollectionsSort]):
sort_dir (Union[Unset, CollectionsGetCollectionsSortDir]):
page_size (Union[Unset, int]): Default: 50.
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[Union[CollectionsGetCollectionsCollectionList, ServerError]]
"""
kwargs = _get_kwargs(
id=id,
id_prefix=id_prefix,
name=name,
account_id=account_id,
not_account_id=not_account_id,
meta=meta,
bmeta=bmeta,
version=version,
version_suffix=version_suffix,
public=public,
shared_with=shared_with,
editable=editable,
starred=starred,
access_level=access_level,
de=de,
sort=sort,
sort_dir=sort_dir,
page_size=page_size,
)
response = await client.get_async_httpx_client().request(**kwargs)
return _build_response(client=client, response=response)
[docs]
async def asyncio(
*,
client: AuthenticatedClient,
id: Union[Unset, str] = UNSET,
id_prefix: Union[Unset, str] = UNSET,
name: Union[Unset, str] = UNSET,
account_id: Union[Unset, str] = UNSET,
not_account_id: Union[Unset, str] = UNSET,
meta: Union[Unset, str] = UNSET,
bmeta: Union[Unset, str] = UNSET,
version: Union[Unset, CollectionsGetCollectionsVersion] = UNSET,
version_suffix: Union[Unset, str] = UNSET,
public: Union[Unset, bool] = UNSET,
shared_with: Union[Unset, str] = UNSET,
editable: Union[Unset, bool] = UNSET,
starred: Union[Unset, bool] = UNSET,
access_level: Union[Unset, CollectionAccessLevel] = UNSET,
de: Union[Unset, List[str]] = UNSET,
sort: Union[Unset, CollectionsGetCollectionsSort] = UNSET,
sort_dir: Union[Unset, CollectionsGetCollectionsSortDir] = UNSET,
page_size: Union[Unset, int] = 50,
) -> Union[CollectionsGetCollectionsCollectionList]:
"""List collections
List all collections that are visible to the current user,
whether logged in or not.
Args:
id (Union[Unset, str]):
id_prefix (Union[Unset, str]):
name (Union[Unset, str]):
account_id (Union[Unset, str]):
not_account_id (Union[Unset, str]):
meta (Union[Unset, str]):
bmeta (Union[Unset, str]):
version (Union[Unset, CollectionsGetCollectionsVersion]):
version_suffix (Union[Unset, str]):
public (Union[Unset, bool]):
shared_with (Union[Unset, str]):
editable (Union[Unset, bool]):
starred (Union[Unset, bool]):
access_level (Union[Unset, CollectionAccessLevel]):
de (Union[Unset, List[str]]):
sort (Union[Unset, CollectionsGetCollectionsSort]):
sort_dir (Union[Unset, CollectionsGetCollectionsSortDir]):
page_size (Union[Unset, int]): Default: 50.
Raises:
errors.UnexpectedStatus: If the server returns a status code greater than or equal to 300.
httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns:
Union[CollectionsGetCollectionsCollectionList]
"""
response = await asyncio_detailed(
client=client,
id=id,
id_prefix=id_prefix,
name=name,
account_id=account_id,
not_account_id=not_account_id,
meta=meta,
bmeta=bmeta,
version=version,
version_suffix=version_suffix,
public=public,
shared_with=shared_with,
editable=editable,
starred=starred,
access_level=access_level,
de=de,
sort=sort,
sort_dir=sort_dir,
page_size=page_size,
)
if isinstance(response.parsed, ServerError):
raise errors.UnexpectedStatus(response.status_code, response.content)
return response.parsed