Group

GroupAdmin

Bases: BaseModel

GroupAdminUserName instance-attribute

GroupAdminUserName

GroupUser

Bases: BaseModel

GroupUserName instance-attribute

GroupUserName

Group

Bases: BaseModel

GroupAdmins instance-attribute

GroupAdmins

GroupUsers instance-attribute

GroupUsers

GroupModelId instance-attribute

GroupModelId

GroupOwner instance-attribute

GroupOwner

GroupName instance-attribute

GroupName

users

users()

Source code in fio_wrapper/models/group_models.py

def users(self) -> List[str]:
    return [user.GroupUserName.upper() for user in self.GroupUsers]

GroupList

Bases: RootModel

root instance-attribute

root

ids

ids()

Returns a list of Group IDs from all Groups in the List

Returns:

Type	Description
List[int]	List[int]: List of GroupModelId

Source code in fio_wrapper/models/group_models.py

def ids(self) -> List[int]:
    """Returns a list of Group IDs from all Groups in the List

    Returns:
        List[int]: List of GroupModelId
    """
    return [group.GroupModelId for group in self.root]

GroupMembership

Bases: BaseModel

GroupName instance-attribute

GroupName

GroupId instance-attribute

GroupId

GroupMembershipList

Bases: RootModel

root instance-attribute

root

ids

ids()

Returns a list of Group IDs from all Group Memberships

Returns:

Type	Description
List[int]	List[int]: List of GroupIDs

Source code in fio_wrapper/models/group_models.py

def ids(self) -> List[int]:
    """Returns a list of Group IDs from all Group Memberships

    Returns:
        List[int]: List of GroupIDs
    """
    return [membership.GroupId for membership in self.root]

StorageItem

Bases: BaseModel

MaterialTicker class-attribute instance-attribute

MaterialTicker = Field(max_length=3)

MaterialName instance-attribute

MaterialName

MaterialCategoryName instance-attribute

MaterialCategoryName

Units instance-attribute

Units

PlayerCXWarehouses

Bases: BaseModel

PlayerName instance-attribute

PlayerName

StorageType instance-attribute

StorageType

Items instance-attribute

Items

CXWarehouse

Bases: BaseModel

WarehouseLocationName instance-attribute

WarehouseLocationName

WarehouseLocationNaturalId instance-attribute

WarehouseLocationNaturalId

PlayerCXWarehouses instance-attribute

PlayerCXWarehouses

RepairMaterial

Bases: BaseModel

MaterialTicker class-attribute instance-attribute

MaterialTicker = Field(max_length=3)

Amount instance-attribute

Amount

AddressLine

Bases: BaseModel

LineId class-attribute instance-attribute

LineId = Field(min_length=32)

LineType instance-attribute

LineType

NaturalId instance-attribute

NaturalId

Name instance-attribute

Name

AddressLineFlight

Bases: BaseModel

LineId class-attribute instance-attribute

LineId = Field(min_length=32)

Type instance-attribute

Type

LineNaturalId instance-attribute

LineNaturalId

LineName instance-attribute

LineName

ShipFuel

Bases: BaseModel

CurrentSF instance-attribute

CurrentSF

MaxSF instance-attribute

MaxSF

CurrentFF instance-attribute

CurrentFF

MaxFF instance-attribute

MaxFF

ShipCargo

Bases: BaseModel

PlayerName instance-attribute

PlayerName

StorageType instance-attribute

StorageType

Items instance-attribute

Items

LastUpdated instance-attribute

LastUpdated

ShipFlightSegment

Bases: BaseModel

OriginLines instance-attribute

OriginLines

DestinationLines instance-attribute

DestinationLines

Type instance-attribute

Type

DepartureTimeEpochMs instance-attribute

DepartureTimeEpochMs

ArrivalTimeEpochMs instance-attribute

ArrivalTimeEpochMs

StlDistance instance-attribute

StlDistance

StlFuelConsumption instance-attribute

StlFuelConsumption

FtlDistance instance-attribute

FtlDistance

FtlFuelConsumption instance-attribute

FtlFuelConsumption

Origin instance-attribute

Origin

Destination instance-attribute

Destination

ShipFlight

Bases: BaseModel

Segments instance-attribute

Segments

FlightId class-attribute instance-attribute

FlightId = Field(min_length=32)

ShipId class-attribute instance-attribute

ShipId = Field(min_length=32)

Origin instance-attribute

Origin

Destination instance-attribute

Destination

DepartureTimeEpochMs instance-attribute

DepartureTimeEpochMs

ArrivalTimeEpochMs instance-attribute

ArrivalTimeEpochMs

CurrentSegmentIndex instance-attribute

CurrentSegmentIndex

StlDistance instance-attribute

StlDistance

FtlDistance instance-attribute

FtlDistance

IsAborted instance-attribute

IsAborted

Timestamp instance-attribute

Timestamp

PlayerShip

Bases: BaseModel

PlayerName instance-attribute

PlayerName

ShipName instance-attribute

ShipName

ShipRegistration instance-attribute

ShipRegistration

Location instance-attribute

Location

Destination instance-attribute

Destination

LocationETA instance-attribute

LocationETA

LocationETALocalTime instance-attribute

LocationETALocalTime

Condition instance-attribute

Condition

RepairMaterials instance-attribute

RepairMaterials

AddressLines instance-attribute

AddressLines

Flight instance-attribute

Flight

Fuel instance-attribute

Fuel

Cargo instance-attribute

Cargo

LastUpdated instance-attribute

LastUpdated

Currency

Bases: BaseModel

CurrencyName instance-attribute

CurrencyName

Amount instance-attribute

Amount

LastUpdated instance-attribute

LastUpdated

Material

Bases: BaseModel

MaterialTicker class-attribute instance-attribute

MaterialTicker = Field(max_length=3)

MaterialName instance-attribute

MaterialName

MaterialCategoryName instance-attribute

MaterialCategoryName

Units instance-attribute

Units

ProductionLine

Bases: BaseModel

Started instance-attribute

Started

Halted instance-attribute

Halted

Recurring instance-attribute

Recurring

OrderDuration instance-attribute

OrderDuration

TimeCompletion instance-attribute

TimeCompletion

Inputs instance-attribute

Inputs

Outputs instance-attribute

Outputs

LastUpdated instance-attribute

LastUpdated

BuildingName instance-attribute

BuildingName

BuildingTicker class-attribute instance-attribute

BuildingTicker = Field(max_length=3)

Capacity instance-attribute

Capacity

Efficiency instance-attribute

Efficiency

Condition instance-attribute

Condition

Building

Bases: BaseModel

BuildingName instance-attribute

BuildingName

BuildingTicker class-attribute instance-attribute

BuildingTicker = Field(max_length=3)

Condition instance-attribute

Condition

RepairMaterials instance-attribute

RepairMaterials

ReclaimableMaterials instance-attribute

ReclaimableMaterials

ProductionLiness instance-attribute

ProductionLiness

Storage

Bases: BaseModel

PlayerName instance-attribute

PlayerName

StorageType instance-attribute

StorageType

Items instance-attribute

Items

LastUpdated instance-attribute

LastUpdated

Location

Bases: BaseModel

LocationIdentifier instance-attribute

LocationIdentifier

LocationName instance-attribute

LocationName

Buildings instance-attribute

Buildings

BaseStorage instance-attribute

BaseStorage

WarehouseStorage instance-attribute

WarehouseStorage

StationaryPlayerShips instance-attribute

StationaryPlayerShips

PlayerModel

Bases: BaseModel

Username instance-attribute

Username

Currencies instance-attribute

Currencies

Locations instance-attribute

Locations

GroupHub

Bases: BaseModel

GroupName instance-attribute

GroupName

CXWarehouses instance-attribute

CXWarehouses

PlayerShipsInFlight instance-attribute

PlayerShipsInFlight

PlayerStationaryShips instance-attribute

PlayerStationaryShips

Failures instance-attribute

Failures

Inventory

Bases: BaseModel

MaterialId class-attribute instance-attribute

MaterialId = Field(min_length=32)

MaterialTicker class-attribute instance-attribute

MaterialTicker = Field(max_length=3)

MaterialAmount instance-attribute

MaterialAmount

Consumption

Bases: BaseModel

MaterialId class-attribute instance-attribute

MaterialId = Field(min_length=32)

MaterialTicker class-attribute instance-attribute

MaterialTicker = Field(max_length=3)

DailyAmount instance-attribute

DailyAmount

Burn

Bases: BaseModel

RequesterUserName instance-attribute

RequesterUserName

UserName instance-attribute

UserName

Error instance-attribute

Error

PlanetId class-attribute instance-attribute

PlanetId = Field(min_length=32)

PlanetName instance-attribute

PlanetName

PlanetNaturalId instance-attribute

PlanetNaturalId

PlanetConsumptionTime instance-attribute

PlanetConsumptionTime

LastUpdate instance-attribute

LastUpdate

LastUpdateCause instance-attribute

LastUpdateCause

Inventory instance-attribute

Inventory

WorkforceConsumption instance-attribute

WorkforceConsumption

OrderConsumption instance-attribute

OrderConsumption

OrderProduction instance-attribute

OrderProduction

BurnList

Bases: RootModel

root instance-attribute

root