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	None
company_id	str | None	None
mu_id	str | None	None

Return Models

Upgrade

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

---

.invalidate_cache()

Clear the SWR cache for all resources.

Signature

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

---