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 Optional
__v integer Optional
type string Optional The type.
countryId string Optional The country id.
countries array[string] Optional The countries.
priority string | integer Optional The priority.
data object Optional The data.
createdAt string Optional The timestamp when this record was created.
updatedAt string Optional The timestamp when this record was last modified.
message string Optional The message.

.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
country_id str None
event_types list[EventType | str] None
auto_items bool False
max_pages int | float inf
cursor_end str None

Return Models

CursorPage[Event]

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

Event

Field Type Required Description
_id string Optional
__v integer Optional
type string Optional The type.
countryId string Optional The country id.
countries array[string] Optional The countries.
priority string | integer Optional The priority.
data object Optional The data.
createdAt string Optional The timestamp when this record was created.
updatedAt string Optional The timestamp when this record was last modified.
message string Optional The message.

.invalidate_cache()

Clear the SWR cache for all resources.

Signature

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

Clone this wiki locally