WarResource (client.war)¶
Endpoints: • war.getById
.get()¶
Get a war by its ID.
Signature¶
await client.war.get(war_id: 'str') -> 'War'
Parameters¶
| Name | Type | Default |
|---|---|---|
war_id |
str |
Required |
Return Models¶
War¶
War model.
| Field | Type | Required |
|---|---|---|
_id |
string |
Optional |
__v |
integer |
Optional |
attacker |
WarSide |
Optional |
defender |
WarSide |
Optional |
battles |
array[any] |
Optional |
isActive |
boolean |
Optional |
priority |
string |
Optional |
priorityEndAt |
string |
Optional |
createdAt |
string |
Optional |
updatedAt |
string |
Optional |
WarSide¶
| Field | Type | Required |
|---|---|---|
_id |
string |
Optional |
__v |
integer |
Optional |
country |
string |
Optional |
damages |
integer |
Optional |
wonBattlesCount |
integer |
Optional |
wonRoundsCount |
integer |
Optional |
.invalidate_cache()¶
Clear the SWR cache for all resources.
Signature¶
await client.war.invalidate_cache() -> 'None'