WorldEventPage

class WorldEventPage(events, metadata=None, bare=False, events_field='events')

Bases: object

Iterable World event page that retains all endpoint metadata.

Parameters:
  • events (List[WorldEvent])

  • metadata (Dict[str, Any] | None)

  • bare (bool)

  • events_field (str)

classmethod from_dict(data)

Parse an event page envelope or bare event list.

Parameters:

data (Dict[str, Any] | List[Dict[str, Any]]) – World endpoint response.

Returns:

Parsed event page.

Return type:

WorldEventPage

to_dict()

Convert the page to its lossless source representation.

Returns:

World endpoint response payload.

Parameters:

self (WorldEventPage)

Return type:

Dict[str, Any] | List[Dict[str, Any]]