Resource ElectionResource

ElectionResource (client.election)

Endpoints: • election.getElections (cursor-paginated)

.collect_all()

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

Signature

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

Parameters

Name	Type	Default
kwargs	Any	*Required*

Return Models

Election

An election event in a country.

Field	Type	Required	Description
_id	`string	null`	No
__v	`integer	null`	No
country	`string	null`	No
electedCandidates	`array	null`	No
isActive	`boolean	null`	No
type	`string	null`	No
candidates	`array	null`	No
votesStartAt	`string	null`	No
votesEndAt	`string	null`	No
votesCount	`integer	null`	No
electedCount	`integer	null`	No
createdAt	`string	null`	No
status	`string	null`	No
votes	`object	null`	No

ElectionCandidate

A candidate in an election.

Field	Type	Required	Description
user	`string	null`	No
voteCount	`integer	null`	No
article	`string	null`	No
party	`string	null`	No
isElected	`boolean	null`	No

---

.get_by_country()

Convenience: fetch all elections in a given country.

Signature

await client.election.get_by_country(country_id: 'str') -> 'list[Election]'

Parameters

Name	Type	Default
country_id	str	*Required*

Return Models

Election

An election event in a country.

Field	Type	Required	Description
_id	`string	null`	No
__v	`integer	null`	No
country	`string	null`	No
electedCandidates	`array	null`	No
isActive	`boolean	null`	No
type	`string	null`	No
candidates	`array	null`	No
votesStartAt	`string	null`	No
votesEndAt	`string	null`	No
votesCount	`integer	null`	No
electedCount	`integer	null`	No
createdAt	`string	null`	No
status	`string	null`	No
votes	`object	null`	No

ElectionCandidate

A candidate in an election.

Field	Type	Required	Description
user	`string	null`	No
voteCount	`integer	null`	No
article	`string	null`	No
party	`string	null`	No
isElected	`boolean	null`	No

---

.get_paginated()

Get elections (cursor-paginated), optionally filtered by country.

Args: country_id: Filter to elections in this country. direction: "forward" (default) or "backward" pagination.

Signature

await client.election.get_paginated(*, country_id: 'str | None' = None, limit: 'int' = 20, cursor: 'str | None' = None, direction: 'str | None' = None, auto_items: 'bool' = False, max_pages: 'int | float' = inf, cursor_end: 'str | None' = None) -> 'CursorPage[Election] | AsyncIterator[Election]'

Parameters

Name	Type	Default
country_id	`str	None`
limit	int	20
cursor	`str	None`
direction	`str	None`
auto_items	bool	False
max_pages	`int	float`
cursor_end	`str	None`

Return Models

CursorPage[Election]

Field	Type	Required	Description
_id	`string	null`	No
__v	`integer	null`	No
items	array	Yes
nextCursor	`string	null`	No
hasMore	boolean	No

Election

An election event in a country.

Field	Type	Required	Description
_id	`string	null`	No
__v	`integer	null`	No
country	`string	null`	No
electedCandidates	`array	null`	No
isActive	`boolean	null`	No
type	`string	null`	No
candidates	`array	null`	No
votesStartAt	`string	null`	No
votesEndAt	`string	null`	No
votesCount	`integer	null`	No
electedCount	`integer	null`	No
createdAt	`string	null`	No
status	`string	null`	No
votes	`object	null`	No

ElectionCandidate

A candidate in an election.

Field	Type	Required	Description
user	`string	null`	No
voteCount	`integer	null`	No
article	`string	null`	No
party	`string	null`	No
isElected	`boolean	null`	No

---

.invalidate_cache()

Clear the SWR cache for all resources.

Signature

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

---