edutap.wallet_google.api.listing#

edutap.wallet_google.api.listing(name: str, *, resource_id: str | None = None, issuer_id: str | None = None, result_per_page: int = 0, next_page_token: str | None = None) → Generator[GoogleWalletModel | str, None, None]#

Lists wallet related resources.

It is possible to list all classes of an issuer. Parameter ‘name’ has to end with ‘Class’, all objects of a registered object type by it’s classes resource id, Parameter ‘name’ has to end with ‘Object’. To get all issuers, parameter ‘name’ has to be ‘Issuer’ and no further parameters are allowed.

Parameters:

  • name – Registered name to base the listing on.

  • resource_id – Id of the class to list objects of. Only for object listings` Mutually exclusive with issuer_id.

  • issuer_id – Identifier of the issuer to list classes of. Only for class listings. If no resource_id is given and issuer_id is None, it will be fetched from the environment variable EDUTAP_WALLET_GOOGLE_ISSUER_ID. Mutually exclusive with resource_id.

  • result_per_page – Number of results per page to fetch. If omitted all results will be fetched and provided by the generator.

  • next_page_token – Token to get the next page of results.

Raises:

  • ValueError – When input was invalid.

  • LookupError – When the resource was not found (404)

  • Exception – When the response status code is not 200 or 404

Returns:

Generator of the data as model-instances based on the data returned by the Restful API. When result_per_page is given, the generator will return a next_page_token after the last model-instance result.