BattleOrderResource (client.battle_order)¶
Endpoints: • battleOrder.getByBattle
.get_by_battle()¶
Get active battle orders for a specific battle and side.
Args: battle_id: The unique identifier of the battle. side: Which side — attacker or defender.
Signature¶
await client.battle_order.get_by_battle(battle_id: 'str', side: 'BattleOrderSide | str') -> 'list[BattleOrder]'
Parameters¶
| Name | Type | Default |
|---|---|---|
battle_id |
str |
Required |
side |
BattleOrderSide | str |
Required |
Return Models¶
BattleOrder¶
A battle order placed by a military unit for a specific battle and side.
| Field | Type | Required |
|---|---|---|
_id |
string |
Optional |
__v |
integer |
Optional |
battleId |
string |
Optional |
side |
string |
Optional |
muId |
string |
Optional |
muName |
string |
Optional |
countryId |
string |
Optional |
details |
object |
Optional |
.invalidate_cache()¶
Clear the SWR cache for all resources.
Signature¶
await client.battle_order.invalidate_cache() -> 'None'