Skip to content

Resource EventResource

CrucifiedPain edited this page Jun 26, 2026 · 10 revisions

EventResource (client.event)

Endpoints: • event.getEventsPaginated (cursor-paginated)

.collect_all()

Fetch all items across all pages concurrently using parallel time-slicing.

Signature

await client.event.collect_all(**kwargs: 'typing.Any') -> 'list[Event]'

Parameters

Name Type Default
kwargs Any *Required*

Return Models

Event

Field Type Required Description
_id string \| null
__v integer \| null
type string \| null
countryId string \| null
countries array[string] \| null
priority string \| integer \| null
data object \| null
createdAt string \| null
updatedAt string \| null
message string \| null

.get_paginated()

Get game events, optionally filtered by country and/or event type.

Signature

await client.event.get_paginated(*, limit: 'int' = 10, cursor: 'str | None' = None, country_id: 'str | None' = None, event_types: 'list[EventType | str] | None' = None, auto_items: 'bool' = False, max_pages: 'int | float' = inf, cursor_end: 'str | None' = None) -> 'CursorPage[Event] | AsyncIterator[Event]'

Parameters

Name Type Default
limit int 10
cursor str | None None
country_id str | None None
event_types list[EventType | str] | None None
auto_items bool False
max_pages int | float inf
cursor_end str | None None

Return Models

CursorPage[Event]

Field Type Required Description
_id string \| null
__v integer \| null
items array[Event]
nextCursor string \| null
hasMore boolean

Event

Field Type Required Description
_id string \| null
__v integer \| null
type string \| null
countryId string \| null
countries array[string] \| null
priority string \| integer \| null
data object \| null
createdAt string \| null
updatedAt string \| null
message string \| null

.invalidate_cache()

Clear the SWR cache for all resources.

Signature

await client.event.invalidate_cache() -> 'None'

Clone this wiki locally