Skip to content

Resource DonationResource

CrucifiedPain edited this page Jun 26, 2026 · 10 revisions

DonationResource (client.donation)

Endpoints: • donation.getManyPaginated (cursor-paginated) • donation.getTotalDonations

.collect_all()

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

Signature

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

Parameters

Name Type Default
kwargs Any *Required*

Return Models

Donation

A donation made to a military unit, country, or party.

Field Type Required Description
_id `string null` No
__v `integer null` No
userId `string null` No
muId `string null` No
countryId `string null` No
partyId `string null` No
amount `number null` No
createdAt `string null` No
updatedAt `string null` No

.get_paginated()

Get donations (cursor-paginated), filtered by target entity.

At least one of mu_id, country_id, or party_id is recommended.

Args: direction: "forward" (default) or "backward" pagination.

Signature

await client.donation.get_paginated(*, mu_id: 'str | None' = None, country_id: 'str | None' = None, party_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[Donation] | AsyncIterator[Donation]'

Parameters

Name Type Default
mu_id `str None`
country_id `str None`
party_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[Donation]

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

Donation

A donation made to a military unit, country, or party.

Field Type Required Description
_id `string null` No
__v `integer null` No
userId `string null` No
muId `string null` No
countryId `string null` No
partyId `string null` No
amount `number null` No
createdAt `string null` No
updatedAt `string null` No

.get_totals()

Get aggregate donation totals (total amount and donor count) for a target.

Args: mu_id: Military unit to aggregate for. country_id: Country to aggregate for. party_id: Party to aggregate for.

Signature

await client.donation.get_totals(*, mu_id: 'str | None' = None, country_id: 'str | None' = None, party_id: 'str | None' = None) -> 'DonationTotals'

Parameters

Name Type Default
mu_id `str None`
country_id `str None`
party_id `str None`

Return Models

DonationTotals

Aggregate donation totals for a target.

Field Type Required Description
_id `string null` No
__v `integer null` No
totalAmount `number null` No
donorCount `integer null` No

.invalidate_cache()

Clear the SWR cache for all resources.

Signature

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

Clone this wiki locally