zapi.infrastructure.http package

Submodules

zapi.infrastructure.http.auth module

zapi.infrastructure.http.auth.api_token_headers(email: str, api_token: str) → dict[str, str]

zapi.infrastructure.http.auth.oauth_headers(token: str) → dict[str, str]

zapi.infrastructure.http.client module

class zapi.infrastructure.http.client.HttpClient(base_url: str, headers: dict[str, str], timeout: float = 30.0)

Bases: object

delete(path: str) → None

get(path: str) → dict

post(path: str, json: dict) → dict

put(path: str, json: dict) → dict

zapi.infrastructure.http.pagination module

zapi.infrastructure.http.pagination.next_link(data: dict, base_url: str) → str | None

Zendesk style cursor link extractor. Accepts absolute or relative next links and returns a relative path.

zapi.infrastructure.http.pagination.yield_items(get_json, first_path: str, base_url: str, items_key: str) → Iterator[dict]

Convenience iterator that yields individual items from a list key.

zapi.infrastructure.http.pagination.yield_pages(get_json, first_path: str, base_url: str) → Iterator[dict]

Generic pager. get_json is a callable like http.get that returns a dict. Yields the full page payload dict so callers can choose the list key.

Module contents