Skip to content

Resource PartyResource

CrucifiedPain edited this page Jun 26, 2026 · 10 revisions

PartyResource (client.party)

Endpoints: • party.getById • party.getManyPaginated (cursor-paginated)

.collect_all()

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

Signature

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

Parameters

Name Type Default
kwargs Any *Required*

Return Models

Party

A political party in WarEra.

Field Type Required Description
_id string \| null
__v integer \| null
name string \| null
description string \| null
country string \| null
region string \| null
leader string \| null
councilMembers array[string] \| null
members array[string] \| null
ethics PartyEthics \| null
avatarUrl string \| null
treasurer string \| null
primaryWinner string \| null
createdAt string \| null
updatedAt string \| null

PartyEthics

Ethics alignment values for a political party.

Field Type Required Description
_id string \| null
__v integer \| null
unethical boolean \| null
militarism number \| null
isolationism number \| null
imperialism number \| null
industrialism number \| null

.get()

Get a single political party by ID.

Signature

await client.party.get(party_id: 'str') -> 'Party'

Parameters

Name Type Default
party_id str *Required*

Return Models

Party

A political party in WarEra.

Field Type Required Description
_id string \| null
__v integer \| null
name string \| null
description string \| null
country string \| null
region string \| null
leader string \| null
councilMembers array[string] \| null
members array[string] \| null
ethics PartyEthics \| null
avatarUrl string \| null
treasurer string \| null
primaryWinner string \| null
createdAt string \| null
updatedAt string \| null

PartyEthics

Ethics alignment values for a political party.

Field Type Required Description
_id string \| null
__v integer \| null
unethical boolean \| null
militarism number \| null
isolationism number \| null
imperialism number \| null
industrialism number \| null

.get_by_country()

Convenience: fetch all parties in a given country.

Signature

await client.party.get_by_country(country_id: 'str') -> 'list[Party]'

Parameters

Name Type Default
country_id str *Required*

Return Models

Party

A political party in WarEra.

Field Type Required Description
_id string \| null
__v integer \| null
name string \| null
description string \| null
country string \| null
region string \| null
leader string \| null
councilMembers array[string] \| null
members array[string] \| null
ethics PartyEthics \| null
avatarUrl string \| null
treasurer string \| null
primaryWinner string \| null
createdAt string \| null
updatedAt string \| null

PartyEthics

Ethics alignment values for a political party.

Field Type Required Description
_id string \| null
__v integer \| null
unethical boolean \| null
militarism number \| null
isolationism number \| null
imperialism number \| null
industrialism number \| null

.get_paginated()

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

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

Signature

await client.party.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[Party] | AsyncIterator[Party]'

Parameters

Name Type Default
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

Return Models

CursorPage[Party]

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

Party

A political party in WarEra.

Field Type Required Description
_id string \| null
__v integer \| null
name string \| null
description string \| null
country string \| null
region string \| null
leader string \| null
councilMembers array[string] \| null
members array[string] \| null
ethics PartyEthics \| null
avatarUrl string \| null
treasurer string \| null
primaryWinner string \| null
createdAt string \| null
updatedAt string \| null

PartyEthics

Ethics alignment values for a political party.

Field Type Required Description
_id string \| null
__v integer \| null
unethical boolean \| null
militarism number \| null
isolationism number \| null
imperialism number \| null
industrialism number \| null

.invalidate_cache()

Clear the SWR cache for all resources.

Signature

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

Clone this wiki locally