collections_get_collections

List collections

Functions

async pydelfini.delfini_core.api.collections.collections_get_collections.asyncio(*, client, id=Unset, id_prefix=Unset, name=Unset, account_id=Unset, not_account_id=Unset, meta=Unset, bmeta=Unset, version=Unset, version_suffix=Unset, public=Unset, shared_with=Unset, editable=Unset, starred=Unset, access_level=Unset, de=Unset, sort=Unset, sort_dir=Unset, page_size=50)

List collections

List all collections that are visible to the current user, whether logged in or not.

Parameters:

• 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.

• client (AuthenticatedClient)

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]

Return type:

CollectionsGetCollectionsCollectionList

async pydelfini.delfini_core.api.collections.collections_get_collections.asyncio_detailed(*, client, id=Unset, id_prefix=Unset, name=Unset, account_id=Unset, not_account_id=Unset, meta=Unset, bmeta=Unset, version=Unset, version_suffix=Unset, public=Unset, shared_with=Unset, editable=Unset, starred=Unset, access_level=Unset, de=Unset, sort=Unset, sort_dir=Unset, page_size=50)

List collections

List all collections that are visible to the current user, whether logged in or not.

Parameters:

• 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.

• client (AuthenticatedClient)

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]]

Return type:

Response[CollectionsGetCollectionsCollectionList | ServerError]

pydelfini.delfini_core.api.collections.collections_get_collections.sync(*, client, id=Unset, id_prefix=Unset, name=Unset, account_id=Unset, not_account_id=Unset, meta=Unset, bmeta=Unset, version=Unset, version_suffix=Unset, public=Unset, shared_with=Unset, editable=Unset, starred=Unset, access_level=Unset, de=Unset, sort=Unset, sort_dir=Unset, page_size=50)

List collections

List all collections that are visible to the current user, whether logged in or not.

Parameters:

• 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.

• client (AuthenticatedClient)

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]

Return type:

CollectionsGetCollectionsCollectionList

pydelfini.delfini_core.api.collections.collections_get_collections.sync_detailed(*, client, id=Unset, id_prefix=Unset, name=Unset, account_id=Unset, not_account_id=Unset, meta=Unset, bmeta=Unset, version=Unset, version_suffix=Unset, public=Unset, shared_with=Unset, editable=Unset, starred=Unset, access_level=Unset, de=Unset, sort=Unset, sort_dir=Unset, page_size=50)

List collections

List all collections that are visible to the current user, whether logged in or not.

Parameters:

• 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.

• client (AuthenticatedClient)

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]]

Return type:

Response[CollectionsGetCollectionsCollectionList | ServerError]