spb_curate.abstract.api package

Submodules

spb_curate.abstract.api.resource module

class spb_curate.abstract.api.resource.APIResource(id=None, access_key=None, team_name=None, **params)

Bases: SuperbAIObject

classmethod fetch(*, access_key=None, team_name=None, endpoint_params=None, headers=None, params=None)

Raises:

ValidationError – When endpoint_params contains None or empty strings.

Return type:

SuperbAIObject

refresh(*, access_key=None, team_name=None, endpoint_params=None, headers=None, params=None)

Return type:

None

class spb_curate.abstract.api.resource.CreateResource(id=None, access_key=None, team_name=None, **params)

Bases: APIResource

classmethod create(*, access_key=None, team_name=None, endpoint_params=None, headers=None, params=None)

Raises:

ValidationError – When endpoint_params contains None or empty strings.

Return type:

SuperbAIObject

class spb_curate.abstract.api.resource.DeleteResource(id=None, access_key=None, team_name=None, **params)

Bases: APIResource

delete(*, access_key=None, team_name=None, endpoint_params=None, headers=None, params=None)

Raises:

ValidationError – When endpoint_params contains None or empty strings.

Return type:

None

class spb_curate.abstract.api.resource.ModifyResource(id=None, access_key=None, team_name=None, **params)

Bases: APIResource

modify(*, access_key=None, team_name=None, endpoint_params=None, headers=None, params=None)

Raises:

ValidationError – When endpoint_params contains None or empty strings.

Return type:

SuperbAIObject

class spb_curate.abstract.api.resource.PaginateResource(id=None, access_key=None, team_name=None, **params)

Bases: APIResource

classmethod fetch_all(*, access_key=None, team_name=None, endpoint_params=None, headers=None, params=None)

Raises:

ValidationError – When endpoint_params contains None or empty strings.

Return type:

List[SuperbAIObject]

classmethod fetch_all_iter(*, access_key=None, team_name=None, endpoint_params=None, headers=None, params=None)

Return type:

Iterator[SuperbAIObject]

classmethod fetch_page(*, access_key=None, team_name=None, endpoint_params=None, headers=None, params)

Raises:

ValidationError – When endpoint_params contains None or empty strings.

Return type:

Dict[str, Union[int, List[SuperbAIObject], str]]

classmethod fetch_page_iter(*, access_key=None, team_name=None, endpoint_params=None, headers=None, params)

Return type:

Iterator[Dict[str, Union[int, List[SuperbAIObject], str]]]

Module contents