psnawp_api.models.listing package

Submodules

psnawp_api.models.listing.listing_generator module

class ListingGenerator(*, request_builder: RequestBuilder, url: str, listing_name: str, params: dict[str, str | int])

Bases: Iterator[Dict[str, Any]]

Iterator class for generating a list of items from an endpoint.

__init__(*, request_builder: RequestBuilder, url: str, listing_name: str, params: dict[str, str | int])

Initialize the ListingGenerator.

Parameters:

• request_builder (RequestBuilder) – An instance of RequestBuilder for making API requests.

• url (str) – The URL of the endpoint.

• params (dict[str, str | int]) – Dictionary of parameters to be passed in the API request.

set_offset(offset: int) → None

Set the offset parameter for the API request.

Parameters:

offset (int) – The offset value to set.

set_page_size(page_size: int) → None

Set the page size (limit) parameter for the API request.

Parameters:

page_size (int) – The page size value to set.

psnawp_api.models.listing.pagination_arguments module

class PaginationArguments(*, total_limit: int | None, page_size: int, offset: int, limit: int = 0)

Bases: object

total_limit: int | None

page_size: int

offset: int

limit: int

get_params_dict() → dict[str, int]

__init__(*, total_limit: int | None, page_size: int, offset: int, limit: int = 0) → None

Method generated by attrs for class PaginationArguments.

Module contents