Resource UpgradeResource

UpgradeResource (client.upgrade)

Endpoints: • upgrade.getUpgradeByTypeAndEntity

.get()

Get an upgrade by type and the entity it belongs to.

Exactly one of region_id, company_id, or mu_id must be provided depending on the upgrade type: • Region upgrades (bunker, base, pacificationCenter, storage): region_id • Company upgrades (automatedEngine, breakRoom): company_id • MU upgrades (headquarters, dormitories): mu_id

Args: upgrade_type: The upgrade type. Use the UpgradeType enum. region_id: Region the upgrade belongs to. company_id: Company the upgrade belongs to. mu_id: Military unit the upgrade belongs to.

Signature

await client.upgrade.get(upgrade_type: 'UpgradeType | str', *, region_id: 'str | None' = None, company_id: 'str | None' = None, mu_id: 'str | None' = None) -> 'Upgrade'

Parameters

Name	Type	Default
upgrade_type	UpgradeType | str	Required
region_id	str	None
company_id	str	None
mu_id	str	None

Return Models

Upgrade

Field	Type	Required
_id	string	Optional
__v	integer	Optional
upgradeType	string	Optional
level	integer	Optional
status	string	Optional
statusChangedAt	string	Optional
region	string	Optional
company	string	Optional
mu	string	Optional
investedMoney	number	Optional
investedConcrete	number	Optional
investedSteel	number	Optional
dependantUsersCount	integer	Optional
lastUpgradeAt	string	Optional
lastDowngradeAt	string	Optional
willBeActiveAt	string	Optional
createdAt	string	Optional
updatedAt	string	Optional

---

.invalidate_cache()

Clear the SWR cache for all resources.

Signature

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

---