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	Description
_id	string	Optional
__v	integer	Optional
upgradeType	string	Optional	The upgrade type.
level	integer	Optional	The current overall level of the entity.
status	string	Optional	The status.
statusChangedAt	string	Optional	The status changed at.
region	string	Optional
company	string	Optional
mu	string	Optional
investedMoney	number	Optional	The invested money.
investedConcrete	number	Optional	The invested concrete.
investedSteel	number	Optional	The invested steel.
dependantUsersCount	integer	Optional	The total number of dependant users.
lastUpgradeAt	string	Optional	The timestamp of the last upgrade event.
lastDowngradeAt	string	Optional	The timestamp of the last downgrade event.
willBeActiveAt	string	Optional	The will be active at.
createdAt	string	Optional	The timestamp when this record was created.
updatedAt	string	Optional	The timestamp when this record was last modified.

---

.invalidate_cache()

Clear the SWR cache for all resources.

Signature

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

---