endpoints/fleet
Types
pub type CreateChartResponse {
CreateChartResponse(
chart: chart.Chart,
waypoint: waypoint.Waypoint,
transaction: chart_transaction.ChartTransaction,
agent: agent.Agent,
)
}
Constructors
-
CreateChartResponse( chart: chart.Chart, waypoint: waypoint.Waypoint, transaction: chart_transaction.ChartTransaction, agent: agent.Agent, )
pub type CreateSurveyResponse {
CreateSurveyResponse(
cooldown: cooldown.Cooldown,
surveys: List(survey.Survey),
)
}
Constructors
-
CreateSurveyResponse( cooldown: cooldown.Cooldown, surveys: List(survey.Survey), )
pub type DockShipResponse {
DockShipResponse(nav: ship_nav.ShipNav)
}
Constructors
-
DockShipResponse(nav: ship_nav.ShipNav)
pub type ExtractResourcesResponse {
ExtractResourcesResponse(
extraction: extraction.Extraction,
cooldown: cooldown.Cooldown,
cargo: ship_cargo.ShipCargo,
modifiers: List(waypoint_modifier.WaypointModifier),
events: List(ship_condition_event.ShipConditionEvent),
)
}
Constructors
-
ExtractResourcesResponse( extraction: extraction.Extraction, cooldown: cooldown.Cooldown, cargo: ship_cargo.ShipCargo, modifiers: List(waypoint_modifier.WaypointModifier), events: List(ship_condition_event.ShipConditionEvent), )
pub type ExtractResourcesWithSurveyResponse {
ExtractResourcesWithSurveyResponse(
extraction: extraction.Extraction,
cooldown: cooldown.Cooldown,
cargo: ship_cargo.ShipCargo,
modifiers: List(waypoint_modifier.WaypointModifier),
events: List(ship_condition_event.ShipConditionEvent),
)
}
Constructors
-
ExtractResourcesWithSurveyResponse( extraction: extraction.Extraction, cooldown: cooldown.Cooldown, cargo: ship_cargo.ShipCargo, modifiers: List(waypoint_modifier.WaypointModifier), events: List(ship_condition_event.ShipConditionEvent), )
pub type GetRepairShipResponse {
GetRepairShipResponse(
transaction: repair_transaction.RepairTransaction,
)
}
Constructors
-
GetRepairShipResponse( transaction: repair_transaction.RepairTransaction, )
pub type GetScrapShipResponse {
GetScrapShipResponse(
transaction: scrap_transaction.ScrapTransaction,
)
}
Constructors
-
GetScrapShipResponse( transaction: scrap_transaction.ScrapTransaction, )
pub type GetShipCargoResponse {
GetShipCargoResponse(cargo: ship_cargo.ShipCargo)
}
Constructors
-
GetShipCargoResponse(cargo: ship_cargo.ShipCargo)
pub type GetShipCooldownResponse {
GetShipCooldownResponse(
cooldown: option.Option(cooldown.Cooldown),
)
}
Constructors
-
GetShipCooldownResponse( cooldown: option.Option(cooldown.Cooldown), )
pub type GetShipModulesResponse {
GetShipModulesResponse(modules: List(ship_module.ShipModule))
}
Constructors
-
GetShipModulesResponse(modules: List(ship_module.ShipModule))
pub type GetShipMountsResponse {
GetShipMountsResponse(mounts: List(ship_mount.ShipMount))
}
Constructors
-
GetShipMountsResponse(mounts: List(ship_mount.ShipMount))
pub type GetShipNavResponse {
GetShipNavResponse(nav: ship_nav.ShipNav)
}
Constructors
-
GetShipNavResponse(nav: ship_nav.ShipNav)
pub type InstallShipModuleResponse {
InstallShipModuleResponse(
agent: agent.Agent,
modules: List(ship_module.ShipModule),
cargo: ship_cargo.ShipCargo,
transaction: ship_modification_transaction.ShipModificationTransaction,
)
}
Constructors
-
InstallShipModuleResponse( agent: agent.Agent, modules: List(ship_module.ShipModule), cargo: ship_cargo.ShipCargo, transaction: ship_modification_transaction.ShipModificationTransaction, )
pub type InstallShipMountResponse {
InstallShipMountResponse(
agent: agent.Agent,
mounts: List(ship_mount.ShipMount),
cargo: ship_cargo.ShipCargo,
transaction: ship_modification_transaction.ShipModificationTransaction,
)
}
Constructors
-
InstallShipMountResponse( agent: agent.Agent, mounts: List(ship_mount.ShipMount), cargo: ship_cargo.ShipCargo, transaction: ship_modification_transaction.ShipModificationTransaction, )
pub type JettisonCargoResponse {
JettisonCargoResponse(cargo: ship_cargo.ShipCargo)
}
Constructors
-
JettisonCargoResponse(cargo: ship_cargo.ShipCargo)
pub type JumpShipResponse {
JumpShipResponse(
nav: ship_nav.ShipNav,
cooldown: cooldown.Cooldown,
transaction: market_transaction.MarketTransaction,
agent: agent.Agent,
)
}
Constructors
-
JumpShipResponse( nav: ship_nav.ShipNav, cooldown: cooldown.Cooldown, transaction: market_transaction.MarketTransaction, agent: agent.Agent, )
pub type NavigateShipResponse {
NavigateShipResponse(
nav: ship_nav.ShipNav,
fuel: ship_fuel.ShipFuel,
events: List(ship_condition_event.ShipConditionEvent),
)
}
Constructors
-
NavigateShipResponse( nav: ship_nav.ShipNav, fuel: ship_fuel.ShipFuel, events: List(ship_condition_event.ShipConditionEvent), )
pub type NegotiateContractResponse {
NegotiateContractResponse(contract: contract.Contract)
}
Constructors
-
NegotiateContractResponse(contract: contract.Contract)
pub type OrbitShipResponse {
OrbitShipResponse(nav: ship_nav.ShipNav)
}
Constructors
-
OrbitShipResponse(nav: ship_nav.ShipNav)
pub type PatchShipNavResponse {
PatchShipNavResponse(
nav: ship_nav.ShipNav,
fuel: ship_fuel.ShipFuel,
events: List(ship_condition_event.ShipConditionEvent),
)
}
Constructors
-
PatchShipNavResponse( nav: ship_nav.ShipNav, fuel: ship_fuel.ShipFuel, events: List(ship_condition_event.ShipConditionEvent), )
pub type PurchaseCargoResponse {
PurchaseCargoResponse(
cargo: ship_cargo.ShipCargo,
transaction: market_transaction.MarketTransaction,
agent: agent.Agent,
)
}
Constructors
-
PurchaseCargoResponse( cargo: ship_cargo.ShipCargo, transaction: market_transaction.MarketTransaction, agent: agent.Agent, )
pub type PurchaseShipResponse {
PurchaseShipResponse(
ship: ship.Ship,
agent: agent.Agent,
transaction: shipyard_transaction.ShipyardTransaction,
)
}
Constructors
-
PurchaseShipResponse( ship: ship.Ship, agent: agent.Agent, transaction: shipyard_transaction.ShipyardTransaction, )
pub type RefineShipResponse {
RefineShipResponse(
cargo: ship_cargo.ShipCargo,
cooldown: cooldown.Cooldown,
produced: List(refinement_yield.RefinementYield),
consumed: List(refinement_yield.RefinementYield),
)
}
Constructors
-
RefineShipResponse( cargo: ship_cargo.ShipCargo, cooldown: cooldown.Cooldown, produced: List(refinement_yield.RefinementYield), consumed: List(refinement_yield.RefinementYield), )
pub type RefuelShipResponse {
RefuelShipResponse(
agent: agent.Agent,
fuel: ship_fuel.ShipFuel,
cargo: ship_cargo.ShipCargo,
transaction: market_transaction.MarketTransaction,
)
}
Constructors
-
RefuelShipResponse( agent: agent.Agent, fuel: ship_fuel.ShipFuel, cargo: ship_cargo.ShipCargo, transaction: market_transaction.MarketTransaction, )
pub type RemoveShipModuleResponse {
RemoveShipModuleResponse(
agent: agent.Agent,
modules: List(ship_module.ShipModule),
cargo: ship_cargo.ShipCargo,
transaction: ship_modification_transaction.ShipModificationTransaction,
)
}
Constructors
-
RemoveShipModuleResponse( agent: agent.Agent, modules: List(ship_module.ShipModule), cargo: ship_cargo.ShipCargo, transaction: ship_modification_transaction.ShipModificationTransaction, )
pub type RemoveShipMountResponse {
RemoveShipMountResponse(
agent: agent.Agent,
mounts: List(ship_mount.ShipMount),
cargo: ship_cargo.ShipCargo,
transaction: ship_modification_transaction.ShipModificationTransaction,
)
}
Constructors
-
RemoveShipMountResponse( agent: agent.Agent, mounts: List(ship_mount.ShipMount), cargo: ship_cargo.ShipCargo, transaction: ship_modification_transaction.ShipModificationTransaction, )
pub type RepairShipResponse {
RepairShipResponse(
agent: agent.Agent,
ship: ship.Ship,
transaction: repair_transaction.RepairTransaction,
)
}
Constructors
-
RepairShipResponse( agent: agent.Agent, ship: ship.Ship, transaction: repair_transaction.RepairTransaction, )
pub type ScanShipsResponse {
ScanShipsResponse(
cooldown: cooldown.Cooldown,
ships: List(scanned_ship.ScannedShip),
)
}
Constructors
-
ScanShipsResponse( cooldown: cooldown.Cooldown, ships: List(scanned_ship.ScannedShip), )
pub type ScanSystemsResponse {
ScanSystemsResponse(
cooldown: cooldown.Cooldown,
systems: List(scanned_system.ScannedSystem),
)
}
Constructors
-
ScanSystemsResponse( cooldown: cooldown.Cooldown, systems: List(scanned_system.ScannedSystem), )
pub type ScanWaypointsResponse {
ScanWaypointsResponse(
cooldown: cooldown.Cooldown,
waypoints: List(scanned_waypoint.ScannedWaypoint),
)
}
Constructors
-
ScanWaypointsResponse( cooldown: cooldown.Cooldown, waypoints: List(scanned_waypoint.ScannedWaypoint), )
pub type ScrapShipResponse {
ScrapShipResponse(
agent: agent.Agent,
transaction: scrap_transaction.ScrapTransaction,
)
}
Constructors
-
ScrapShipResponse( agent: agent.Agent, transaction: scrap_transaction.ScrapTransaction, )
pub type SellCargoResponse {
SellCargoResponse(
cargo: ship_cargo.ShipCargo,
transaction: market_transaction.MarketTransaction,
agent: agent.Agent,
)
}
Constructors
-
SellCargoResponse( cargo: ship_cargo.ShipCargo, transaction: market_transaction.MarketTransaction, agent: agent.Agent, )
pub type SiphonResourcesResponse {
SiphonResourcesResponse(
siphon: siphon.Siphon,
cooldown: cooldown.Cooldown,
cargo: ship_cargo.ShipCargo,
events: List(ship_condition_event.ShipConditionEvent),
)
}
Constructors
-
SiphonResourcesResponse( siphon: siphon.Siphon, cooldown: cooldown.Cooldown, cargo: ship_cargo.ShipCargo, events: List(ship_condition_event.ShipConditionEvent), )
pub type TransferCargoResponse {
TransferCargoResponse(
cargo: ship_cargo.ShipCargo,
target_cargo: ship_cargo.ShipCargo,
)
}
Constructors
-
TransferCargoResponse( cargo: ship_cargo.ShipCargo, target_cargo: ship_cargo.ShipCargo, )
pub type WarpShipResponse {
WarpShipResponse(
nav: ship_nav.ShipNav,
fuel: ship_fuel.ShipFuel,
events: List(ship_condition_event.ShipConditionEvent),
)
}
Constructors
-
WarpShipResponse( nav: ship_nav.ShipNav, fuel: ship_fuel.ShipFuel, events: List(ship_condition_event.ShipConditionEvent), )
Values
pub fn create_chart(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(CreateChartResponse, api.ApiError)
pub fn create_chart_response_decoder(
,
) -> decode.Decoder(CreateChartResponse)
pub fn create_survey(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(CreateSurveyResponse, api.ApiError)
pub fn create_survey_response_decoder(
,
) -> decode.Decoder(CreateSurveyResponse)
pub fn dock_ship(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(DockShipResponse, api.ApiError)
pub fn extract_resources(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(ExtractResourcesResponse, api.ApiError)
pub fn extract_resources_with_survey(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
survey: survey.Survey,
) -> Result(ExtractResourcesWithSurveyResponse, api.ApiError)
pub fn get_repair_ship(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(GetRepairShipResponse, api.ApiError)
pub fn get_repair_ship_response_decoder(
,
) -> decode.Decoder(GetRepairShipResponse)
pub fn get_scrap_ship(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(GetScrapShipResponse, api.ApiError)
pub fn get_ship(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(GetShipResponse, api.ApiError)
pub fn get_ship_cargo(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(GetShipCargoResponse, api.ApiError)
pub fn get_ship_cargo_response_decoder(
,
) -> decode.Decoder(GetShipCargoResponse)
pub fn get_ship_cooldown(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(GetShipCooldownResponse, api.ApiError)
pub fn get_ship_decoder() -> decode.Decoder(GetShipResponse)
pub fn get_ship_modules(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(GetShipModulesResponse, api.ApiError)
pub fn get_ship_modules_response_decoder(
,
) -> decode.Decoder(GetShipModulesResponse)
pub fn get_ship_mounts(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(GetShipMountsResponse, api.ApiError)
pub fn get_ship_mounts_response_decoder(
,
) -> decode.Decoder(GetShipMountsResponse)
pub fn get_ship_nav(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(GetShipNavResponse, api.ApiError)
pub fn get_ship_nav_response_decoder(
,
) -> decode.Decoder(GetShipNavResponse)
pub fn install_ship_module(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
module_symbol: module_symbol.ModuleSymbol,
) -> Result(InstallShipModuleResponse, api.ApiError)
pub fn install_ship_module_response_decoder(
,
) -> decode.Decoder(InstallShipModuleResponse)
pub fn install_ship_mount(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
mount_symbol: mount_symbol.MountSymbol,
) -> Result(InstallShipMountResponse, api.ApiError)
pub fn install_ship_mount_response_decoder(
,
) -> decode.Decoder(InstallShipMountResponse)
pub fn jettison_cargo(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
trade_symbol: trade_symbol.TradeSymbol,
units: Int,
) -> Result(JettisonCargoResponse, api.ApiError)
pub fn jump_ship(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
waypoint_symbol: waypoint_symbol.WaypointSymbol,
) -> Result(JumpShipResponse, api.ApiError)
pub fn list_ships(
token: auth.AgentToken,
page: option.Option(Int),
limit: option.Option(Int),
) -> Result(api.PagedData(ListShipsResponse), api.ApiError)
pub fn list_ships_decoder() -> decode.Decoder(ListShipsResponse)
pub fn navigate_ship(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
waypoint_symbol: waypoint_symbol.WaypointSymbol,
) -> Result(NavigateShipResponse, api.ApiError)
pub fn negotiate_contract(
token: auth.AgentToken,
ship_symbol: String,
) -> Result(NegotiateContractResponse, api.ApiError)
pub fn orbit_ship(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(OrbitShipResponse, api.ApiError)
pub fn patch_ship_nav(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
flight_mode: ship_nav_flight_mode.ShipNavFlightMode,
) -> Result(PatchShipNavResponse, api.ApiError)
pub fn patch_ship_nav_response_decoder(
,
) -> decode.Decoder(PatchShipNavResponse)
pub fn purchase_cargo(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
trade_symbol: trade_symbol.TradeSymbol,
) -> Result(PurchaseCargoResponse, api.ApiError)
pub fn purchase_ship(
token: auth.AgentToken,
ship_type: ship_type.ShipType,
waypoint_symbol: waypoint_symbol.WaypointSymbol,
) -> Result(PurchaseShipResponse, api.ApiError)
pub fn purchase_ship_decoder(
,
) -> decode.Decoder(PurchaseShipResponse)
pub fn refine_ship(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
produce: refinement_produce.RefinementProduce,
) -> Result(RefineShipResponse, api.ApiError)
pub fn refuel_ship(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
units: option.Option(Int),
from_cargo: option.Option(Bool),
) -> Result(RefuelShipResponse, api.ApiError)
pub fn refuel_ship_response_decoder(
,
) -> decode.Decoder(RefuelShipResponse)
pub fn remove_ship_module(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
module_symbol: module_symbol.ModuleSymbol,
) -> Result(RemoveShipModuleResponse, api.ApiError)
pub fn remove_ship_module_response_decoder(
,
) -> decode.Decoder(RemoveShipModuleResponse)
pub fn remove_ship_mount(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
mount_symbol: mount_symbol.MountSymbol,
) -> Result(RemoveShipMountResponse, api.ApiError)
pub fn remove_ship_mount_response_decoder(
,
) -> decode.Decoder(RemoveShipMountResponse)
pub fn repair_ship(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(RepairShipResponse, api.ApiError)
pub fn repair_ship_response_decoder(
,
) -> decode.Decoder(RepairShipResponse)
pub fn scan_ships(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(ScanShipsResponse, api.ApiError)
pub fn scan_systems(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(ScanSystemsResponse, api.ApiError)
pub fn scan_waypoints(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(ScanWaypointsResponse, api.ApiError)
pub fn scrap_ship(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(ScrapShipResponse, api.ApiError)
pub fn sell_cargo(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
trade_symbol: trade_symbol.TradeSymbol,
units: Int,
) -> Result(SellCargoResponse, api.ApiError)
pub fn sell_cargo_response_decoder(
,
) -> decode.Decoder(SellCargoResponse)
pub fn siphon_resources(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
) -> Result(SiphonResourcesResponse, api.ApiError)
pub fn siphon_resources_response_decoder(
,
) -> decode.Decoder(SiphonResourcesResponse)
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(TransferCargoResponse, api.ApiError)
pub fn transfer_cargo_response_decoder(
,
) -> decode.Decoder(TransferCargoResponse)
pub fn warp_ship(
token: auth.AgentToken,
ship_symbol: ship_symbol.ShipSymbol,
waypoint_symbol: waypoint_symbol.WaypointSymbol,
) -> Result(WarpShipResponse, api.ApiError)