endpoints/fleet
Types
pub type CargoPurchased {
CargoPurchased(
cargo: ship_cargo.ShipCargo,
transaction: market_transaction.MarketTransaction,
agent: agent.Agent,
)
}
Constructors
-
CargoPurchased( cargo: ship_cargo.ShipCargo, transaction: market_transaction.MarketTransaction, agent: agent.Agent, )
pub type CargoSold {
CargoSold(
cargo: ship_cargo.ShipCargo,
transaction: market_transaction.MarketTransaction,
agent: agent.Agent,
)
}
Constructors
-
CargoSold( cargo: ship_cargo.ShipCargo, transaction: market_transaction.MarketTransaction, agent: agent.Agent, )
pub type CargoTransferred {
CargoTransferred(
cargo: ship_cargo.ShipCargo,
target_cargo: ship_cargo.ShipCargo,
)
}
Constructors
-
CargoTransferred( cargo: ship_cargo.ShipCargo, target_cargo: ship_cargo.ShipCargo, )
pub type ChartCreated {
ChartCreated(
chart: chart.Chart,
waypoint: waypoint.Waypoint,
transaction: chart_transaction.ChartTransaction,
agent: agent.Agent,
)
}
Constructors
-
ChartCreated( chart: chart.Chart, waypoint: waypoint.Waypoint, transaction: chart_transaction.ChartTransaction, agent: agent.Agent, )
pub type ResourcesExtracted {
ResourcesExtracted(
extraction: extraction.Extraction,
cooldown: cooldown.Cooldown,
cargo: ship_cargo.ShipCargo,
modifiers: List(waypoint_modifier.WaypointModifier),
events: List(ship_condition_event.ShipConditionEvent),
)
}
Constructors
-
ResourcesExtracted( extraction: extraction.Extraction, cooldown: cooldown.Cooldown, cargo: ship_cargo.ShipCargo, modifiers: List(waypoint_modifier.WaypointModifier), events: List(ship_condition_event.ShipConditionEvent), )
pub type ResourcesSiphoned {
ResourcesSiphoned(
siphon: siphon.Siphon,
cooldown: cooldown.Cooldown,
cargo: ship_cargo.ShipCargo,
events: List(ship_condition_event.ShipConditionEvent),
)
}
Constructors
-
ResourcesSiphoned( siphon: siphon.Siphon, cooldown: cooldown.Cooldown, cargo: ship_cargo.ShipCargo, events: List(ship_condition_event.ShipConditionEvent), )
pub type Scan(data) {
Scan(cooldown: cooldown.Cooldown, data: List(data))
}
Constructors
-
Scan(cooldown: cooldown.Cooldown, data: List(data))
pub type ShipJumped {
ShipJumped(
nav: ship_nav.ShipNav,
cooldown: cooldown.Cooldown,
transaction: market_transaction.MarketTransaction,
agent: agent.Agent,
)
}
Constructors
-
ShipJumped( nav: ship_nav.ShipNav, cooldown: cooldown.Cooldown, transaction: market_transaction.MarketTransaction, agent: agent.Agent, )
pub type ShipModuleInstalled {
ShipModuleInstalled(
agent: agent.Agent,
modules: List(ship_module.ShipModule),
cargo: ship_cargo.ShipCargo,
transaction: ship_modification_transaction.ShipModificationTransaction,
)
}
Constructors
-
ShipModuleInstalled( agent: agent.Agent, modules: List(ship_module.ShipModule), cargo: ship_cargo.ShipCargo, transaction: ship_modification_transaction.ShipModificationTransaction, )
pub type ShipModuleRemoved {
ShipModuleRemoved(
agent: agent.Agent,
modules: List(ship_module.ShipModule),
cargo: ship_cargo.ShipCargo,
transaction: ship_modification_transaction.ShipModificationTransaction,
)
}
Constructors
-
ShipModuleRemoved( agent: agent.Agent, modules: List(ship_module.ShipModule), cargo: ship_cargo.ShipCargo, transaction: ship_modification_transaction.ShipModificationTransaction, )
pub type ShipMountInstalled {
ShipMountInstalled(
agent: agent.Agent,
mounts: List(ship_mount.ShipMount),
cargo: ship_cargo.ShipCargo,
transaction: ship_modification_transaction.ShipModificationTransaction,
)
}
Constructors
-
ShipMountInstalled( agent: agent.Agent, mounts: List(ship_mount.ShipMount), cargo: ship_cargo.ShipCargo, transaction: ship_modification_transaction.ShipModificationTransaction, )
pub type ShipMountRemoved {
ShipMountRemoved(
agent: agent.Agent,
mounts: List(ship_mount.ShipMount),
cargo: ship_cargo.ShipCargo,
transaction: ship_modification_transaction.ShipModificationTransaction,
)
}
Constructors
-
ShipMountRemoved( agent: agent.Agent, mounts: List(ship_mount.ShipMount), cargo: ship_cargo.ShipCargo, transaction: ship_modification_transaction.ShipModificationTransaction, )
pub type ShipNavPatched {
ShipNavPatched(
nav: ship_nav.ShipNav,
fuel: ship_fuel.ShipFuel,
events: List(ship_condition_event.ShipConditionEvent),
)
}
Constructors
-
ShipNavPatched( nav: ship_nav.ShipNav, fuel: ship_fuel.ShipFuel, events: List(ship_condition_event.ShipConditionEvent), )
pub type ShipNavigated {
ShipNavigated(
nav: ship_nav.ShipNav,
fuel: ship_fuel.ShipFuel,
events: List(ship_condition_event.ShipConditionEvent),
)
}
Constructors
-
ShipNavigated( nav: ship_nav.ShipNav, fuel: ship_fuel.ShipFuel, events: List(ship_condition_event.ShipConditionEvent), )
pub type ShipPurchased {
ShipPurchased(
ship: ship.Ship,
agent: agent.Agent,
transaction: shipyard_transaction.ShipyardTransaction,
)
}
Constructors
-
ShipPurchased( ship: ship.Ship, agent: agent.Agent, transaction: shipyard_transaction.ShipyardTransaction, )
pub type ShipRefined {
ShipRefined(
cargo: ship_cargo.ShipCargo,
cooldown: cooldown.Cooldown,
produced: List(refinement_yield.RefinementYield),
consumed: List(refinement_yield.RefinementYield),
)
}
Constructors
-
ShipRefined( cargo: ship_cargo.ShipCargo, cooldown: cooldown.Cooldown, produced: List(refinement_yield.RefinementYield), consumed: List(refinement_yield.RefinementYield), )
pub type ShipRefueled {
ShipRefueled(
agent: agent.Agent,
fuel: ship_fuel.ShipFuel,
cargo: ship_cargo.ShipCargo,
transaction: market_transaction.MarketTransaction,
)
}
Constructors
-
ShipRefueled( agent: agent.Agent, fuel: ship_fuel.ShipFuel, cargo: ship_cargo.ShipCargo, transaction: market_transaction.MarketTransaction, )
pub type ShipRepaired {
ShipRepaired(
agent: agent.Agent,
ship: ship.Ship,
transaction: repair_transaction.RepairTransaction,
)
}
Constructors
-
ShipRepaired( agent: agent.Agent, ship: ship.Ship, transaction: repair_transaction.RepairTransaction, )
pub type ShipScrapped {
ShipScrapped(
agent: agent.Agent,
transaction: scrap_transaction.ScrapTransaction,
)
}
Constructors
-
ShipScrapped( agent: agent.Agent, transaction: scrap_transaction.ScrapTransaction, )
pub type ShipWarped {
ShipWarped(
nav: ship_nav.ShipNav,
fuel: ship_fuel.ShipFuel,
events: List(ship_condition_event.ShipConditionEvent),
)
}
Constructors
-
ShipWarped( nav: ship_nav.ShipNav, fuel: ship_fuel.ShipFuel, events: List(ship_condition_event.ShipConditionEvent), )
pub type SurveyCreated {
SurveyCreated(
cooldown: cooldown.Cooldown,
surveys: List(survey.Survey),
)
}
Constructors
-
SurveyCreated( cooldown: cooldown.Cooldown, surveys: List(survey.Survey), )
Values
pub fn create_chart(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(ChartCreated, api.ApiError)
pub fn create_survey(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(SurveyCreated, api.ApiError)
pub fn dock_ship(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(ship_nav.ShipNav, api.ApiError)
pub fn extract_resources(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(ResourcesExtracted, api.ApiError)
pub fn extract_resources_with_survey(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
survey: survey.Survey,
) -> Result(ResourcesExtracted, api.ApiError)
pub fn get_repair_ship(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(repair_transaction.RepairTransaction, api.ApiError)
pub fn get_scrap_ship(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(scrap_transaction.ScrapTransaction, api.ApiError)
pub fn get_ship(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(ship.Ship, api.ApiError)
pub fn get_ship_cargo(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(ship_cargo.ShipCargo, api.ApiError)
pub fn get_ship_cooldown(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(option.Option(cooldown.Cooldown), api.ApiError)
pub fn get_ship_modules(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(List(ship_module.ShipModule), api.ApiError)
pub fn get_ship_mounts(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(List(ship_mount.ShipMount), api.ApiError)
pub fn get_ship_nav(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(ship_nav.ShipNav, api.ApiError)
pub fn install_ship_module(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
module_symbol: module_symbol.ModuleSymbol,
) -> Result(ShipModuleInstalled, api.ApiError)
pub fn install_ship_mount(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
mount_symbol: mount_symbol.MountSymbol,
) -> Result(ShipMountInstalled, api.ApiError)
pub fn jettison_cargo(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
trade_symbol: trade_symbol.TradeSymbol,
units: Int,
) -> Result(ship_cargo.ShipCargo, api.ApiError)
pub fn jump_ship(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
waypoint_symbol: waypoint_symbol.WaypointSymbol,
) -> Result(ShipJumped, api.ApiError)
pub fn list_ships(
token: auth.AgentToken,
page: option.Option(Int),
limit: option.Option(Int),
) -> Result(api.PagedData(List(ship.Ship)), api.ApiError)
pub fn navigate_ship(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
waypoint_symbol: waypoint_symbol.WaypointSymbol,
) -> Result(ShipNavigated, api.ApiError)
pub fn negotiate_contract(
token: auth.AgentToken,
ship_symbol: String,
) -> Result(contract.Contract, api.ApiError)
pub fn orbit_ship(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(ship_nav.ShipNav, api.ApiError)
pub fn patch_ship_nav(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
flight_mode: ship_nav_flight_mode.ShipNavFlightMode,
) -> Result(ShipNavPatched, api.ApiError)
pub fn purchase_cargo(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
trade_symbol: trade_symbol.TradeSymbol,
) -> Result(CargoPurchased, api.ApiError)
pub fn purchase_ship(
token: auth.AgentToken,
ship_type: ship_type.ShipType,
waypoint_symbol: waypoint_symbol.WaypointSymbol,
) -> Result(ShipPurchased, api.ApiError)
pub fn refine_ship(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
produce: refinement_produce.RefinementProduce,
) -> Result(ShipRefined, api.ApiError)
pub fn refuel_ship(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
units: option.Option(Int),
from_cargo: option.Option(Bool),
) -> Result(ShipRefueled, api.ApiError)
pub fn remove_ship_module(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
module_symbol: module_symbol.ModuleSymbol,
) -> Result(ShipModuleRemoved, api.ApiError)
pub fn remove_ship_mount(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
mount_symbol: mount_symbol.MountSymbol,
) -> Result(ShipMountRemoved, api.ApiError)
pub fn repair_ship(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(ShipRepaired, api.ApiError)
pub fn scan_ships(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(Scan(scanned_ship.ScannedShip), api.ApiError)
pub fn scan_systems(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(Scan(scanned_system.ScannedSystem), api.ApiError)
pub fn scan_waypoints(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(Scan(scanned_waypoint.ScannedWaypoint), api.ApiError)
pub fn scrap_ship(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(ShipScrapped, api.ApiError)
pub fn sell_cargo(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
trade_symbol: trade_symbol.TradeSymbol,
units: Int,
) -> Result(CargoSold, api.ApiError)
pub fn siphon_resources(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(ResourcesSiphoned, api.ApiError)
pub fn transfer_cargo(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
trade_symbol: trade_symbol.TradeSymbol,
units: Int,
target_ship_symbol: ship_symbol.ShipSymbol,
) -> Result(CargoTransferred, api.ApiError)
pub fn warp_ship(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
waypoint_symbol: waypoint_symbol.WaypointSymbol,
) -> Result(ShipWarped, api.ApiError)