spacetraders_api_httpc - v2.0.0

spacetraders_api_httpc

Types

HttpcApiError

</> 
pub type HttpcApiError {
  ClientError(httpc.HttpError)
  JsonDecodeError(json.DecodeError)
  RequestError(
    code: Int,
    message: String,
    data: option.Option(dynamic.Dynamic),
    request_id: option.Option(String),
  )
}

Constructors

Values

accept_contract

</> 
pub fn accept_contract(
  token: spacetraders_models.AgentToken,
  contract_id: spacetraders_models.ContractId,
) -> Result(spacetraders_api.ContractAccepted, HttpcApiError)

create_chart

</> 
pub fn create_chart(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> Result(spacetraders_api.ChartCreated, HttpcApiError)

create_survey

</> 
pub fn create_survey(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> Result(spacetraders_api.SurveyCreated, HttpcApiError)

deliver_contract_cargo

</> 
pub fn deliver_contract_cargo(
  token: spacetraders_models.AgentToken,
  contract_id: spacetraders_models.ContractId,
  ship_symbol: spacetraders_models.ShipSymbol,
  trade_symbol: spacetraders_models.TradeSymbol,
  units: Int,
) -> Result(
  spacetraders_api.ContractCargoDelivered,
  HttpcApiError,
)

dock_ship

</> 
pub fn dock_ship(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> Result(spacetraders_models.ShipNav, HttpcApiError)

extract_resources

</> 
pub fn extract_resources(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> Result(spacetraders_api.ResourcesExtracted, HttpcApiError)

extract_resources_with_survey

</> 
pub fn extract_resources_with_survey(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
  survey: spacetraders_models.Survey,
) -> Result(spacetraders_api.ResourcesExtracted, HttpcApiError)

fulfill_contract

</> 
pub fn fulfill_contract(
  token: spacetraders_models.AgentToken,
  contract_id: spacetraders_models.ContractId,
) -> Result(spacetraders_api.ContractFulfilled, HttpcApiError)

get_account

</> 
pub fn get_account(
  token: spacetraders_models.AgentToken,
) -> Result(spacetraders_models.Account, HttpcApiError)

get_agent

</> 
pub fn get_agent(
  token: spacetraders_models.AgentToken,
) -> Result(spacetraders_models.Agent, HttpcApiError)

get_agent_events

</> 
pub fn get_agent_events(
  token: spacetraders_models.AgentToken,
) -> Result(List(spacetraders_models.AgentEvent), HttpcApiError)

get_construction_site

</> 
pub fn get_construction_site(
  system_symbol: spacetraders_models.SystemSymbol,
  waypoint_symbol: spacetraders_models.WaypointSymbol,
) -> Result(
  spacetraders_models.WaypointConstruction,
  HttpcApiError,
)

get_contract

</> 
pub fn get_contract(
  token: spacetraders_models.AgentToken,
  contract_id: spacetraders_models.ContractId,
) -> Result(spacetraders_models.Contract, HttpcApiError)

get_faction

</> 
pub fn get_faction(
  symbol: spacetraders_models.FactionSymbol,
) -> Result(spacetraders_models.Faction, HttpcApiError)

get_jump_gate

</> 
pub fn get_jump_gate(
  system_symbol: spacetraders_models.SystemSymbol,
  waypoint_symbol: spacetraders_models.WaypointSymbol,
) -> Result(spacetraders_models.JumpGate, HttpcApiError)

get_market

</> 
pub fn get_market(
  system_symbol: spacetraders_models.SystemSymbol,
  waypoint_symbol: spacetraders_models.WaypointSymbol,
) -> Result(spacetraders_models.Market, HttpcApiError)

get_my_factions

</> 
pub fn get_my_factions(
  token: spacetraders_models.AgentToken,
  page: option.Option(Int),
  limit: option.Option(Int),
) -> Result(
  spacetraders_api.PagedData(
    List(spacetraders_api.FactionReputation),
  ),
  HttpcApiError,
)

get_public_agent

</> 
pub fn get_public_agent(
  agent_symbol: spacetraders_models.AgentSymbol,
) -> Result(spacetraders_models.PublicAgent, HttpcApiError)

get_repair_ship

</> 
pub fn get_repair_ship(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> Result(
  spacetraders_models.ShipRepairTransaction,
  HttpcApiError,
)

get_scrap_ship

</> 
pub fn get_scrap_ship(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> Result(
  spacetraders_models.ShipScrapTransaction,
  HttpcApiError,
)

get_server_status

</> 
pub fn get_server_status() -> Result(
  spacetraders_api.ServerStatus,
  HttpcApiError,
)

get_ship

</> 
pub fn get_ship(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> Result(spacetraders_models.Ship, HttpcApiError)

get_ship_cargo

</> 
pub fn get_ship_cargo(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> Result(spacetraders_models.ShipCargo, HttpcApiError)

get_ship_cooldown

</> 
pub fn get_ship_cooldown(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> Result(
  option.Option(spacetraders_models.ShipCooldown),
  HttpcApiError,
)

get_ship_modules

</> 
pub fn get_ship_modules(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> Result(List(spacetraders_models.ShipModule), HttpcApiError)

get_ship_mounts

</> 
pub fn get_ship_mounts(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> Result(List(spacetraders_models.ShipMount), HttpcApiError)

get_ship_nav

</> 
pub fn get_ship_nav(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> Result(spacetraders_models.ShipNav, HttpcApiError)

get_shipyard

</> 
pub fn get_shipyard(
  system_symbol: spacetraders_models.SystemSymbol,
  waypoint_symbol: spacetraders_models.WaypointSymbol,
) -> Result(spacetraders_models.Shipyard, HttpcApiError)

get_supply_chain

</> 
pub fn get_supply_chain() -> Result(
  dict.Dict(
    spacetraders_models.TradeSymbol,
    List(spacetraders_models.TradeSymbol),
  ),
  HttpcApiError,
)

get_system

</> 
pub fn get_system(
  system_symbol: spacetraders_models.SystemSymbol,
) -> Result(spacetraders_models.System, HttpcApiError)

get_waypoint

</> 
pub fn get_waypoint(
  system_symbol: spacetraders_models.SystemSymbol,
  waypoint_symbol: spacetraders_models.WaypointSymbol,
) -> Result(spacetraders_models.Waypoint, HttpcApiError)

install_ship_module

</> 
pub fn install_ship_module(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
  module_symbol: spacetraders_models.ShipModuleSymbol,
) -> Result(spacetraders_api.ShipModuleInstalled, HttpcApiError)

install_ship_mount

</> 
pub fn install_ship_mount(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
  mount_symbol: spacetraders_models.ShipMountSymbol,
) -> Result(spacetraders_api.ShipMountInstalled, HttpcApiError)

jettison_cargo

</> 
pub fn jettison_cargo(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
  trade_symbol: spacetraders_models.TradeSymbol,
  units: Int,
) -> Result(spacetraders_models.ShipCargo, HttpcApiError)

jump_ship

</> 
pub fn jump_ship(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
  waypoint_symbol: spacetraders_models.WaypointSymbol,
) -> Result(spacetraders_api.ShipJumped, HttpcApiError)

list_contracts

</> 
pub fn list_contracts(
  token: spacetraders_models.AgentToken,
  page: option.Option(Int),
  limit: option.Option(Int),
) -> Result(
  spacetraders_api.PagedData(List(spacetraders_models.Contract)),
  HttpcApiError,
)

list_error_codes

</> 
pub fn list_error_codes() -> Result(
  List(spacetraders_api.ErrorCode),
  HttpcApiError,
)

list_factions

</> 
pub fn list_factions(
  page: option.Option(Int),
  limit: option.Option(Int),
) -> Result(
  spacetraders_api.PagedData(List(spacetraders_models.Faction)),
  HttpcApiError,
)

list_public_agents

</> 
pub fn list_public_agents(
  page: option.Option(Int),
  limit: option.Option(Int),
) -> Result(
  spacetraders_api.PagedData(
    List(spacetraders_models.PublicAgent),
  ),
  HttpcApiError,
)

list_ships

</> 
pub fn list_ships(
  token: spacetraders_models.AgentToken,
  page: option.Option(Int),
  limit: option.Option(Int),
) -> Result(
  spacetraders_api.PagedData(List(spacetraders_models.Ship)),
  HttpcApiError,
)

list_system_waypoints

</> 
pub fn list_system_waypoints(
  system_symbol: spacetraders_models.SystemSymbol,
  page: option.Option(Int),
  limit: option.Option(Int),
  type_: option.Option(spacetraders_models.WaypointType),
  traits: List(spacetraders_models.WaypointTraitSymbol),
) -> Result(
  spacetraders_api.PagedData(List(spacetraders_models.Waypoint)),
  HttpcApiError,
)

list_systems

</> 
pub fn list_systems(
  page: option.Option(Int),
  limit: option.Option(Int),
) -> Result(
  spacetraders_api.PagedData(List(spacetraders_models.System)),
  HttpcApiError,
)
</> 
pub fn navigate_ship(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
  waypoint_symbol: spacetraders_models.WaypointSymbol,
) -> Result(spacetraders_api.ShipNavigated, HttpcApiError)

negotiate_contract

</> 
pub fn negotiate_contract(
  token: spacetraders_models.AgentToken,
  ship_symbol: String,
) -> Result(spacetraders_models.Contract, HttpcApiError)

orbit_ship

</> 
pub fn orbit_ship(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> Result(spacetraders_models.ShipNav, HttpcApiError)

patch_ship_nav

</> 
pub fn patch_ship_nav(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
  flight_mode: spacetraders_models.ShipNavFlightMode,
) -> Result(spacetraders_api.ShipNavPatched, HttpcApiError)

purchase_cargo

</> 
pub fn purchase_cargo(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
  trade_symbol: spacetraders_models.TradeSymbol,
) -> Result(spacetraders_api.CargoPurchased, HttpcApiError)

purchase_ship

</> 
pub fn purchase_ship(
  token: spacetraders_models.AgentToken,
  ship_type: spacetraders_models.ShipType,
  waypoint_symbol: spacetraders_models.WaypointSymbol,
) -> Result(spacetraders_api.ShipPurchased, HttpcApiError)

refine_ship

</> 
pub fn refine_ship(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
  produce: spacetraders_models.ShipRefinementProduce,
) -> Result(spacetraders_api.ShipRefined, HttpcApiError)

refuel_ship

</> 
pub fn refuel_ship(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
  units: option.Option(Int),
  from_cargo: option.Option(Bool),
) -> Result(spacetraders_api.ShipRefueled, HttpcApiError)

register_new_agent

</> 
pub fn register_new_agent(
  token: spacetraders_models.AccountToken,
  agent_symbol: spacetraders_models.AgentSymbol,
  faction_symbol: spacetraders_models.FactionSymbol,
) -> Result(spacetraders_api.AgentRegistered, HttpcApiError)

remove_ship_module

</> 
pub fn remove_ship_module(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
  module_symbol: spacetraders_models.ShipModuleSymbol,
) -> Result(spacetraders_api.ShipModuleRemoved, HttpcApiError)

remove_ship_mount

</> 
pub fn remove_ship_mount(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
  mount_symbol: spacetraders_models.ShipMountSymbol,
) -> Result(spacetraders_api.ShipMountRemoved, HttpcApiError)

repair_ship

</> 
pub fn repair_ship(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> Result(spacetraders_api.ShipRepaired, HttpcApiError)

scan_ships

</> 
pub fn scan_ships(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> Result(spacetraders_api.ShipsScan, HttpcApiError)

scan_systems

</> 
pub fn scan_systems(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> Result(spacetraders_api.SystemsScan, HttpcApiError)

scan_waypoints

</> 
pub fn scan_waypoints(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> Result(spacetraders_api.WaypointsScan, HttpcApiError)

scrap_ship

</> 
pub fn scrap_ship(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> Result(spacetraders_api.ShipScrapped, HttpcApiError)

sell_cargo

</> 
pub fn sell_cargo(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
  trade_symbol: spacetraders_models.TradeSymbol,
  units: Int,
) -> Result(spacetraders_api.CargoSold, HttpcApiError)

siphon_resources

</> 
pub fn siphon_resources(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> Result(spacetraders_api.ResourcesSiphoned, HttpcApiError)

supply_construction_site

</> 
pub fn supply_construction_site(
  token: spacetraders_models.AgentToken,
  system_symbol: spacetraders_models.SystemSymbol,
  waypoint_symbol: spacetraders_models.WaypointSymbol,
  ship_symbol: spacetraders_models.ShipSymbol,
  trade_symbol: spacetraders_models.TradeSymbol,
  units: Int,
) -> Result(
  spacetraders_api.ConstructionSiteSupplied,
  HttpcApiError,
)

transfer_cargo

</> 
pub fn transfer_cargo(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
  trade_symbol: spacetraders_models.TradeSymbol,
  units: Int,
  target_ship_symbol: spacetraders_models.ShipSymbol,
) -> Result(spacetraders_api.CargoTransferred, HttpcApiError)

warp_ship

</> 
pub fn warp_ship(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
  waypoint_symbol: spacetraders_models.WaypointSymbol,
) -> Result(spacetraders_api.ShipWarped, HttpcApiError)
✨ Search Document