spacetraders_api

Types

AgentRegistered

pub type AgentRegistered {
  AgentRegistered(
    token: spacetraders_models.AgentToken,
    agent: spacetraders_models.Agent,
    faction: spacetraders_models.Faction,
    contract: spacetraders_models.Contract,
    ships: List(spacetraders_models.Ship),
  )
}

Constructors

AgentRegistered(
  token: spacetraders_models.AgentToken,
  agent: spacetraders_models.Agent,
  faction: spacetraders_models.Faction,
  contract: spacetraders_models.Contract,
  ships: List(spacetraders_models.Ship),
)

ApiError

</>

pub type ApiError {
  JsonDecodeError(json.DecodeError)
  RequestError(
    code: Int,
    message: String,
    data: option.Option(dynamic.Dynamic),
    request_id: option.Option(String),
  )
}

Constructors

```
JsonDecodeError(json.DecodeError)
```

RequestError(
  code: Int,
  message: String,
  data: option.Option(dynamic.Dynamic),
  request_id: option.Option(String),
)

AuthMethod

</>

pub type AuthMethod {
  AccountAuth(spacetraders_models.AccountToken)
  AgentAuth(spacetraders_models.AgentToken)
  NoAuth
}

Constructors

AccountAuth(spacetraders_models.AccountToken)

AgentAuth(spacetraders_models.AgentToken)

```
NoAuth
```

CargoPurchased

</>

pub type CargoPurchased {
  CargoPurchased(
    cargo: spacetraders_models.ShipCargo,
    transaction: spacetraders_models.MarketTransaction,
    agent: spacetraders_models.Agent,
  )
}

Constructors

CargoPurchased(
  cargo: spacetraders_models.ShipCargo,
  transaction: spacetraders_models.MarketTransaction,
  agent: spacetraders_models.Agent,
)

CargoSold

</>

pub type CargoSold {
  CargoSold(
    cargo: spacetraders_models.ShipCargo,
    transaction: spacetraders_models.MarketTransaction,
    agent: spacetraders_models.Agent,
  )
}

Constructors

CargoSold(
  cargo: spacetraders_models.ShipCargo,
  transaction: spacetraders_models.MarketTransaction,
  agent: spacetraders_models.Agent,
)

CargoTransferred

</>

pub type CargoTransferred {
  CargoTransferred(
    cargo: spacetraders_models.ShipCargo,
    target_cargo: spacetraders_models.ShipCargo,
  )
}

Constructors

CargoTransferred(
  cargo: spacetraders_models.ShipCargo,
  target_cargo: spacetraders_models.ShipCargo,
)

ChartCreated

</>

pub type ChartCreated {
  ChartCreated(
    chart: spacetraders_models.Chart,
    waypoint: spacetraders_models.Waypoint,
    transaction: spacetraders_models.ChartTransaction,
    agent: spacetraders_models.Agent,
  )
}

Constructors

ChartCreated(
  chart: spacetraders_models.Chart,
  waypoint: spacetraders_models.Waypoint,
  transaction: spacetraders_models.ChartTransaction,
  agent: spacetraders_models.Agent,
)

ConstructionSiteSupplied

</>

pub type ConstructionSiteSupplied {
  ConstructionSiteSupplied(
    construction: spacetraders_models.WaypointConstruction,
    cargo: spacetraders_models.ShipCargo,
  )
}

Constructors

ConstructionSiteSupplied(
  construction: spacetraders_models.WaypointConstruction,
  cargo: spacetraders_models.ShipCargo,
)

ContractAccepted

</>

pub type ContractAccepted {
  ContractAccepted(
    contract: spacetraders_models.Contract,
    agent: spacetraders_models.Agent,
  )
}

Constructors

ContractAccepted(
  contract: spacetraders_models.Contract,
  agent: spacetraders_models.Agent,
)

ContractCargoDelivered

</>

pub type ContractCargoDelivered {
  ContractCargoDelivered(
    contract: spacetraders_models.Contract,
    cargo: spacetraders_models.ShipCargo,
  )
}

Constructors

ContractCargoDelivered(
  contract: spacetraders_models.Contract,
  cargo: spacetraders_models.ShipCargo,
)

ContractFulfilled

</>

pub type ContractFulfilled {
  ContractFulfilled(
    contract: spacetraders_models.Contract,
    agent: spacetraders_models.Agent,
  )
}

Constructors

ContractFulfilled(
  contract: spacetraders_models.Contract,
  agent: spacetraders_models.Agent,
)

ErrorCode

</>

pub type ErrorCode {
  ErrorCode(code: Int, name: String)
}

Constructors

```
ErrorCode(code: Int, name: String)
```

ExportToImportMap

</>

pub type ExportToImportMap =
  dict.Dict(
    spacetraders_models.TradeSymbol,
    List(spacetraders_models.TradeSymbol),
  )

FactionReputation

</>

pub type FactionReputation {
  FactionReputation(
    symbol: spacetraders_models.FactionSymbol,
    reputation: Int,
  )
}

Constructors

FactionReputation(
  symbol: spacetraders_models.FactionSymbol,
  reputation: Int,
)

PagedData

</>

pub type PagedData(data) {
  PagedData(data: data, meta: Meta)
}

Constructors

```
PagedData(data: data, meta: Meta)
```

ResourcesExtracted

</>

pub type ResourcesExtracted {
  ResourcesExtracted(
    extraction: spacetraders_models.Extraction,
    cooldown: spacetraders_models.ShipCooldown,
    cargo: spacetraders_models.ShipCargo,
    modifiers: List(spacetraders_models.WaypointModifier),
    events: List(spacetraders_models.ShipConditionEvent),
  )
}

Constructors

ResourcesExtracted(
  extraction: spacetraders_models.Extraction,
  cooldown: spacetraders_models.ShipCooldown,
  cargo: spacetraders_models.ShipCargo,
  modifiers: List(spacetraders_models.WaypointModifier),
  events: List(spacetraders_models.ShipConditionEvent),
)

ResourcesSiphoned

</>

pub type ResourcesSiphoned {
  ResourcesSiphoned(
    siphon: spacetraders_models.Siphon,
    cooldown: spacetraders_models.ShipCooldown,
    cargo: spacetraders_models.ShipCargo,
    events: List(spacetraders_models.ShipConditionEvent),
  )
}

Constructors

ResourcesSiphoned(
  siphon: spacetraders_models.Siphon,
  cooldown: spacetraders_models.ShipCooldown,
  cargo: spacetraders_models.ShipCargo,
  events: List(spacetraders_models.ShipConditionEvent),
)

ServerAnnouncement

</>

pub type ServerAnnouncement {
  ServerAnnouncement(title: String, body: String)
}

Constructors

ServerAnnouncement(title: String, body: String)

ServerChartLeaderboardEntry

</>

pub type ServerChartLeaderboardEntry {
  ServerChartLeaderboardEntry(
    agent_symbol: spacetraders_models.AgentSymbol,
    chart_count: Int,
  )
}

Constructors

ServerChartLeaderboardEntry(
  agent_symbol: spacetraders_models.AgentSymbol,
  chart_count: Int,
)

ServerCreditLeaderboardEntry

</>

pub type ServerCreditLeaderboardEntry {
  ServerCreditLeaderboardEntry(
    agent_symbol: spacetraders_models.AgentSymbol,
    credits: Int,
  )
}

Constructors

ServerCreditLeaderboardEntry(
  agent_symbol: spacetraders_models.AgentSymbol,
  credits: Int,
)

ServerHealth

</>

pub type ServerHealth {
  ServerHealth(
    last_market_update: option.Option(timestamp.Timestamp),
  )
}

Constructors

ServerHealth(
  last_market_update: option.Option(timestamp.Timestamp),
)

ServerLeaderboards

</>

pub type ServerLeaderboards {
  ServerLeaderboards(
    most_credits: List(ServerCreditLeaderboardEntry),
    most_submitted_charts: List(ServerChartLeaderboardEntry),
  )
}

Constructors

ServerLeaderboards(
  most_credits: List(ServerCreditLeaderboardEntry),
  most_submitted_charts: List(ServerChartLeaderboardEntry),
)

ServerLink

</>

pub type ServerLink {
  ServerLink(name: String, url: uri.Uri)
}

Constructors

```
ServerLink(name: String, url: uri.Uri)
```

ServerResets

</>

pub type ServerResets {
  ServerResets(next: timestamp.Timestamp, frequency: String)
}

Constructors

ServerResets(next: timestamp.Timestamp, frequency: String)

ServerStats

</>

pub type ServerStats {
  ServerStats(
    accounts: option.Option(Int),
    agents: Int,
    ships: Int,
    systems: Int,
    waypoints: Int,
  )
}

Constructors

ServerStats(
  accounts: option.Option(Int),
  agents: Int,
  ships: Int,
  systems: Int,
  waypoints: Int,
)

ServerStatus

</>

pub type ServerStatus {
  ServerStatus(
    status: String,
    version: String,
    reset_date: calendar.Date,
    description: String,
    stats: ServerStats,
    health: ServerHealth,
    leaderboards: ServerLeaderboards,
    server_resets: ServerResets,
    announcements: List(ServerAnnouncement),
    links: List(ServerLink),
  )
}

Constructors

ServerStatus(
  status: String,
  version: String,
  reset_date: calendar.Date,
  description: String,
  stats: ServerStats,
  health: ServerHealth,
  leaderboards: ServerLeaderboards,
  server_resets: ServerResets,
  announcements: List(ServerAnnouncement),
  links: List(ServerLink),
)

ShipJumped

</>

pub type ShipJumped {
  ShipJumped(
    nav: spacetraders_models.ShipNav,
    cooldown: spacetraders_models.ShipCooldown,
    transaction: spacetraders_models.MarketTransaction,
    agent: spacetraders_models.Agent,
  )
}

Constructors

ShipJumped(
  nav: spacetraders_models.ShipNav,
  cooldown: spacetraders_models.ShipCooldown,
  transaction: spacetraders_models.MarketTransaction,
  agent: spacetraders_models.Agent,
)

ShipModuleInstalled

</>

pub type ShipModuleInstalled {
  ShipModuleInstalled(
    agent: spacetraders_models.Agent,
    modules: List(spacetraders_models.ShipModule),
    cargo: spacetraders_models.ShipCargo,
    transaction: spacetraders_models.ShipModificationTransaction,
  )
}

Constructors

ShipModuleInstalled(
  agent: spacetraders_models.Agent,
  modules: List(spacetraders_models.ShipModule),
  cargo: spacetraders_models.ShipCargo,
  transaction: spacetraders_models.ShipModificationTransaction,
)

ShipModuleRemoved

</>

pub type ShipModuleRemoved {
  ShipModuleRemoved(
    agent: spacetraders_models.Agent,
    modules: List(spacetraders_models.ShipModule),
    cargo: spacetraders_models.ShipCargo,
    transaction: spacetraders_models.ShipModificationTransaction,
  )
}

Constructors

ShipModuleRemoved(
  agent: spacetraders_models.Agent,
  modules: List(spacetraders_models.ShipModule),
  cargo: spacetraders_models.ShipCargo,
  transaction: spacetraders_models.ShipModificationTransaction,
)

ShipMountInstalled

</>

pub type ShipMountInstalled {
  ShipMountInstalled(
    agent: spacetraders_models.Agent,
    mounts: List(spacetraders_models.ShipMount),
    cargo: spacetraders_models.ShipCargo,
    transaction: spacetraders_models.ShipModificationTransaction,
  )
}

Constructors

ShipMountInstalled(
  agent: spacetraders_models.Agent,
  mounts: List(spacetraders_models.ShipMount),
  cargo: spacetraders_models.ShipCargo,
  transaction: spacetraders_models.ShipModificationTransaction,
)

ShipMountRemoved

</>

pub type ShipMountRemoved {
  ShipMountRemoved(
    agent: spacetraders_models.Agent,
    mounts: List(spacetraders_models.ShipMount),
    cargo: spacetraders_models.ShipCargo,
    transaction: spacetraders_models.ShipModificationTransaction,
  )
}

Constructors

ShipMountRemoved(
  agent: spacetraders_models.Agent,
  mounts: List(spacetraders_models.ShipMount),
  cargo: spacetraders_models.ShipCargo,
  transaction: spacetraders_models.ShipModificationTransaction,
)

ShipNavPatched

</>

pub type ShipNavPatched {
  ShipNavPatched(
    nav: spacetraders_models.ShipNav,
    fuel: spacetraders_models.ShipFuel,
    events: List(spacetraders_models.ShipConditionEvent),
  )
}

Constructors

ShipNavPatched(
  nav: spacetraders_models.ShipNav,
  fuel: spacetraders_models.ShipFuel,
  events: List(spacetraders_models.ShipConditionEvent),
)

ShipNavigated

</>

pub type ShipNavigated {
  ShipNavigated(
    nav: spacetraders_models.ShipNav,
    fuel: spacetraders_models.ShipFuel,
    events: List(spacetraders_models.ShipConditionEvent),
  )
}

Constructors

ShipNavigated(
  nav: spacetraders_models.ShipNav,
  fuel: spacetraders_models.ShipFuel,
  events: List(spacetraders_models.ShipConditionEvent),
)

ShipPurchased

</>

pub type ShipPurchased {
  ShipPurchased(
    ship: spacetraders_models.Ship,
    agent: spacetraders_models.Agent,
    transaction: spacetraders_models.ShipyardTransaction,
  )
}

Constructors

ShipPurchased(
  ship: spacetraders_models.Ship,
  agent: spacetraders_models.Agent,
  transaction: spacetraders_models.ShipyardTransaction,
)

ShipRefined

</>

pub type ShipRefined {
  ShipRefined(
    cargo: spacetraders_models.ShipCargo,
    cooldown: spacetraders_models.ShipCooldown,
    produced: List(spacetraders_models.ShipRefinementYield),
    consumed: List(spacetraders_models.ShipRefinementYield),
  )
}

Constructors

ShipRefined(
  cargo: spacetraders_models.ShipCargo,
  cooldown: spacetraders_models.ShipCooldown,
  produced: List(spacetraders_models.ShipRefinementYield),
  consumed: List(spacetraders_models.ShipRefinementYield),
)

ShipRefueled

</>

pub type ShipRefueled {
  ShipRefueled(
    agent: spacetraders_models.Agent,
    fuel: spacetraders_models.ShipFuel,
    cargo: spacetraders_models.ShipCargo,
    transaction: spacetraders_models.MarketTransaction,
  )
}

Constructors

ShipRefueled(
  agent: spacetraders_models.Agent,
  fuel: spacetraders_models.ShipFuel,
  cargo: spacetraders_models.ShipCargo,
  transaction: spacetraders_models.MarketTransaction,
)

ShipRepaired

</>

pub type ShipRepaired {
  ShipRepaired(
    agent: spacetraders_models.Agent,
    ship: spacetraders_models.Ship,
    transaction: spacetraders_models.ShipRepairTransaction,
  )
}

Constructors

ShipRepaired(
  agent: spacetraders_models.Agent,
  ship: spacetraders_models.Ship,
  transaction: spacetraders_models.ShipRepairTransaction,
)

ShipScrapped

</>

pub type ShipScrapped {
  ShipScrapped(
    agent: spacetraders_models.Agent,
    transaction: spacetraders_models.ShipScrapTransaction,
  )
}

Constructors

ShipScrapped(
  agent: spacetraders_models.Agent,
  transaction: spacetraders_models.ShipScrapTransaction,
)

ShipWarped

</>

pub type ShipWarped {
  ShipWarped(
    nav: spacetraders_models.ShipNav,
    fuel: spacetraders_models.ShipFuel,
    events: List(spacetraders_models.ShipConditionEvent),
  )
}

Constructors

ShipWarped(
  nav: spacetraders_models.ShipNav,
  fuel: spacetraders_models.ShipFuel,
  events: List(spacetraders_models.ShipConditionEvent),
)

ShipsScan

</>

pub type ShipsScan {
  ShipsScan(
    cooldown: spacetraders_models.ShipCooldown,
    ships: List(spacetraders_models.ScannedShip),
  )
}

Constructors

ShipsScan(
  cooldown: spacetraders_models.ShipCooldown,
  ships: List(spacetraders_models.ScannedShip),
)

SurveyCreated

</>

pub type SurveyCreated {
  SurveyCreated(
    cooldown: spacetraders_models.ShipCooldown,
    surveys: List(spacetraders_models.Survey),
  )
}

Constructors

SurveyCreated(
  cooldown: spacetraders_models.ShipCooldown,
  surveys: List(spacetraders_models.Survey),
)

SystemsScan

</>

pub type SystemsScan {
  SystemsScan(
    cooldown: spacetraders_models.ShipCooldown,
    systems: List(spacetraders_models.ScannedSystem),
  )
}

Constructors

SystemsScan(
  cooldown: spacetraders_models.ShipCooldown,
  systems: List(spacetraders_models.ScannedSystem),
)

WaypointsScan

</>

pub type WaypointsScan {
  WaypointsScan(
    cooldown: spacetraders_models.ShipCooldown,
    waypoints: List(spacetraders_models.ScannedWaypoint),
  )
}

Constructors

WaypointsScan(
  cooldown: spacetraders_models.ShipCooldown,
  waypoints: List(spacetraders_models.ScannedWaypoint),
)

Values

accept_contract_request

</>

pub fn accept_contract_request(
  token: spacetraders_models.AgentToken,
  contract_id: spacetraders_models.ContractId,
) -> request.Request(BitArray)

accept_contract_response

</>

pub fn accept_contract_response(
  response: response.Response(BitArray),
) -> Result(ContractAccepted, ApiError)

create_chart_request

</>

pub fn create_chart_request(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> request.Request(BitArray)

create_chart_response

</>

pub fn create_chart_response(
  response: response.Response(BitArray),
) -> Result(ChartCreated, ApiError)

create_survey_request

</>

pub fn create_survey_request(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> request.Request(BitArray)

create_survey_response

</>

pub fn create_survey_response(
  response: response.Response(BitArray),
) -> Result(SurveyCreated, ApiError)

deliver_contract_cargo_request

</>

pub fn deliver_contract_cargo_request(
  token: spacetraders_models.AgentToken,
  contract_id: spacetraders_models.ContractId,
  ship_symbol: spacetraders_models.ShipSymbol,
  trade_symbol: spacetraders_models.TradeSymbol,
  units: Int,
) -> request.Request(BitArray)

deliver_contract_cargo_response

</>

pub fn deliver_contract_cargo_response(
  response: response.Response(BitArray),
) -> Result(ContractCargoDelivered, ApiError)

dock_ship_request

</>

pub fn dock_ship_request(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> request.Request(BitArray)

dock_ship_response

</>

pub fn dock_ship_response(
  response: response.Response(BitArray),
) -> Result(spacetraders_models.ShipNav, ApiError)

extract_resources_request

</>

pub fn extract_resources_request(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> request.Request(BitArray)

extract_resources_response

</>

pub fn extract_resources_response(
  response: response.Response(BitArray),
) -> Result(ResourcesExtracted, ApiError)

extract_resources_with_survey_request

</>

pub fn extract_resources_with_survey_request(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
  survey: spacetraders_models.Survey,
) -> request.Request(BitArray)

extract_resources_with_survey_response

</>

pub fn extract_resources_with_survey_response(
  response: response.Response(BitArray),
) -> Result(ResourcesExtracted, ApiError)

fulfill_contract_request

</>

pub fn fulfill_contract_request(
  token: spacetraders_models.AgentToken,
  contract_id: spacetraders_models.ContractId,
) -> request.Request(BitArray)

fulfill_contract_response

</>

pub fn fulfill_contract_response(
  response: response.Response(BitArray),
) -> Result(ContractFulfilled, ApiError)

get_account_request

</>

pub fn get_account_request(
  token: spacetraders_models.AgentToken,
) -> request.Request(BitArray)

get_account_response

</>

pub fn get_account_response(
  response: response.Response(BitArray),
) -> Result(spacetraders_models.Account, ApiError)

get_agent_events_request

</>

pub fn get_agent_events_request(
  token: spacetraders_models.AgentToken,
) -> request.Request(BitArray)

get_agent_events_response

</>

pub fn get_agent_events_response(
  response: response.Response(BitArray),
) -> Result(List(spacetraders_models.AgentEvent), ApiError)

get_agent_request

</>

pub fn get_agent_request(
  token: spacetraders_models.AgentToken,
) -> request.Request(BitArray)

get_agent_response

</>

pub fn get_agent_response(
  response: response.Response(BitArray),
) -> Result(spacetraders_models.Agent, ApiError)

get_construction_site_request

</>

pub fn get_construction_site_request(
  system_symbol: spacetraders_models.SystemSymbol,
  waypoint_symbol: spacetraders_models.WaypointSymbol,
) -> request.Request(BitArray)

get_construction_site_response

</>

pub fn get_construction_site_response(
  response: response.Response(BitArray),
) -> Result(spacetraders_models.WaypointConstruction, ApiError)

get_contract_request

</>

pub fn get_contract_request(
  token: spacetraders_models.AgentToken,
  contract_id: spacetraders_models.ContractId,
) -> request.Request(BitArray)

get_contract_response

</>

pub fn get_contract_response(
  response: response.Response(BitArray),
) -> Result(spacetraders_models.Contract, ApiError)

get_faction_request

</>

pub fn get_faction_request(
  symbol: spacetraders_models.FactionSymbol,
) -> request.Request(BitArray)

get_faction_response

</>

pub fn get_faction_response(
  response: response.Response(BitArray),
) -> Result(spacetraders_models.Faction, ApiError)

get_jump_gate_request

</>

pub fn get_jump_gate_request(
  system_symbol: spacetraders_models.SystemSymbol,
  waypoint_symbol: spacetraders_models.WaypointSymbol,
) -> request.Request(BitArray)

get_jump_gate_response

</>

pub fn get_jump_gate_response(
  response: response.Response(BitArray),
) -> Result(spacetraders_models.JumpGate, ApiError)

get_market_request

</>

pub fn get_market_request(
  system_symbol: spacetraders_models.SystemSymbol,
  waypoint_symbol: spacetraders_models.WaypointSymbol,
) -> request.Request(BitArray)

get_market_response

</>

pub fn get_market_response(
  response: response.Response(BitArray),
) -> Result(spacetraders_models.Market, ApiError)

get_my_factions_request

</>

pub fn get_my_factions_request(
  token: spacetraders_models.AgentToken,
  page: option.Option(Int),
  limit: option.Option(Int),
) -> request.Request(BitArray)

get_my_factions_response

</>

pub fn get_my_factions_response(
  response: response.Response(BitArray),
) -> Result(PagedData(List(FactionReputation)), ApiError)

get_public_agent_request

</>

pub fn get_public_agent_request(
  agent_symbol: spacetraders_models.AgentSymbol,
) -> request.Request(BitArray)

get_public_agent_response

</>

pub fn get_public_agent_response(
  response: response.Response(BitArray),
) -> Result(spacetraders_models.PublicAgent, ApiError)

get_repair_ship_request

</>

pub fn get_repair_ship_request(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> request.Request(BitArray)

get_repair_ship_response

</>

pub fn get_repair_ship_response(
  response: response.Response(BitArray),
) -> Result(spacetraders_models.ShipRepairTransaction, ApiError)

get_scrap_ship_request

</>

pub fn get_scrap_ship_request(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> request.Request(BitArray)

get_scrap_ship_response

</>

pub fn get_scrap_ship_response(
  response: response.Response(BitArray),
) -> Result(spacetraders_models.ShipScrapTransaction, ApiError)

get_server_status_request

</>

pub fn get_server_status_request() -> request.Request(BitArray)

get_server_status_response

</>

pub fn get_server_status_response(
  response: response.Response(BitArray),
) -> Result(ServerStatus, ApiError)

get_ship_cargo_request

</>

pub fn get_ship_cargo_request(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> request.Request(BitArray)

get_ship_cargo_response

</>

pub fn get_ship_cargo_response(
  response: response.Response(BitArray),
) -> Result(spacetraders_models.ShipCargo, ApiError)

get_ship_cooldown_request

</>

pub fn get_ship_cooldown_request(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> request.Request(BitArray)

get_ship_cooldown_response

</>

pub fn get_ship_cooldown_response(
  response: response.Response(BitArray),
) -> Result(
  option.Option(spacetraders_models.ShipCooldown),
  ApiError,
)

get_ship_modules_request

</>

pub fn get_ship_modules_request(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> request.Request(BitArray)

get_ship_modules_response

</>

pub fn get_ship_modules_response(
  response: response.Response(BitArray),
) -> Result(List(spacetraders_models.ShipModule), ApiError)

get_ship_mounts_request

</>

pub fn get_ship_mounts_request(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> request.Request(BitArray)

get_ship_mounts_response

</>

pub fn get_ship_mounts_response(
  response: response.Response(BitArray),
) -> Result(List(spacetraders_models.ShipMount), ApiError)

get_ship_nav_request

</>

pub fn get_ship_nav_request(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> request.Request(BitArray)

get_ship_nav_response

</>

pub fn get_ship_nav_response(
  response: response.Response(BitArray),
) -> Result(spacetraders_models.ShipNav, ApiError)

get_ship_request

</>

pub fn get_ship_request(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> request.Request(BitArray)

get_ship_response

</>

pub fn get_ship_response(
  response: response.Response(BitArray),
) -> Result(spacetraders_models.Ship, ApiError)

get_shipyard_request

</>

pub fn get_shipyard_request(
  system_symbol: spacetraders_models.SystemSymbol,
  waypoint_symbol: spacetraders_models.WaypointSymbol,
) -> request.Request(BitArray)

get_shipyard_response

</>

pub fn get_shipyard_response(
  response: response.Response(BitArray),
) -> Result(spacetraders_models.Shipyard, ApiError)

get_supply_chain_request

</>

pub fn get_supply_chain_request() -> request.Request(BitArray)

get_supply_chain_response

</>

pub fn get_supply_chain_response(
  response: response.Response(BitArray),
) -> Result(
  dict.Dict(
    spacetraders_models.TradeSymbol,
    List(spacetraders_models.TradeSymbol),
  ),
  ApiError,
)

get_system_request

</>

pub fn get_system_request(
  system_symbol: spacetraders_models.SystemSymbol,
) -> request.Request(BitArray)

get_system_response

</>

pub fn get_system_response(
  response: response.Response(BitArray),
) -> Result(spacetraders_models.System, ApiError)

get_waypoint_request

</>

pub fn get_waypoint_request(
  system_symbol: spacetraders_models.SystemSymbol,
  waypoint_symbol: spacetraders_models.WaypointSymbol,
) -> request.Request(BitArray)

get_waypoint_response

</>

pub fn get_waypoint_response(
  response: response.Response(BitArray),
) -> Result(spacetraders_models.Waypoint, ApiError)

install_ship_module_request

</>

pub fn install_ship_module_request(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
  ship_module_symbol: spacetraders_models.ShipModuleSymbol,
) -> request.Request(BitArray)

install_ship_module_response

</>

pub fn install_ship_module_response(
  response: response.Response(BitArray),
) -> Result(ShipModuleInstalled, ApiError)

install_ship_mount_request

</>

pub fn install_ship_mount_request(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
  ship_mount_symbol: spacetraders_models.ShipMountSymbol,
) -> request.Request(BitArray)

install_ship_mount_response

</>

pub fn install_ship_mount_response(
  response: response.Response(BitArray),
) -> Result(ShipMountInstalled, ApiError)

jettison_cargo_request

</>

pub fn jettison_cargo_request(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
  trade_symbol: spacetraders_models.TradeSymbol,
  units: Int,
) -> request.Request(BitArray)

jettison_cargo_response

</>

pub fn jettison_cargo_response(
  response: response.Response(BitArray),
) -> Result(spacetraders_models.ShipCargo, ApiError)

jump_ship_request

</>

pub fn jump_ship_request(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
  waypoint_symbol: spacetraders_models.WaypointSymbol,
) -> request.Request(BitArray)

jump_ship_response

</>

pub fn jump_ship_response(
  response: response.Response(BitArray),
) -> Result(ShipJumped, ApiError)

list_contracts_request

</>

pub fn list_contracts_request(
  token: spacetraders_models.AgentToken,
  page: option.Option(Int),
  limit: option.Option(Int),
) -> request.Request(BitArray)

list_contracts_response

</>

pub fn list_contracts_response(
  response: response.Response(BitArray),
) -> Result(
  PagedData(List(spacetraders_models.Contract)),
  ApiError,
)

list_error_codes_request

</>

pub fn list_error_codes_request() -> request.Request(BitArray)

list_error_codes_response

</>

pub fn list_error_codes_response(
  response: response.Response(BitArray),
) -> Result(List(ErrorCode), ApiError)

list_factions_request

</>

pub fn list_factions_request(
  page: option.Option(Int),
  limit: option.Option(Int),
) -> request.Request(BitArray)

list_factions_response

</>

pub fn list_factions_response(
  response: response.Response(BitArray),
) -> Result(
  PagedData(List(spacetraders_models.Faction)),
  ApiError,
)

list_public_agents_request

</>

pub fn list_public_agents_request(
  page: option.Option(Int),
  limit: option.Option(Int),
) -> request.Request(BitArray)

list_public_agents_response

</>

pub fn list_public_agents_response(
  response: response.Response(BitArray),
) -> Result(
  PagedData(List(spacetraders_models.PublicAgent)),
  ApiError,
)

list_ships_request

</>

pub fn list_ships_request(
  token: spacetraders_models.AgentToken,
  page: option.Option(Int),
  limit: option.Option(Int),
) -> request.Request(BitArray)

list_ships_response

</>

pub fn list_ships_response(
  response: response.Response(BitArray),
) -> Result(PagedData(List(spacetraders_models.Ship)), ApiError)

list_system_waypoints_request

</>

pub fn list_system_waypoints_request(
  system_symbol: spacetraders_models.SystemSymbol,
  page: option.Option(Int),
  limit: option.Option(Int),
  type_: option.Option(spacetraders_models.WaypointType),
  traits: List(spacetraders_models.WaypointTraitSymbol),
) -> request.Request(BitArray)

list_system_waypoints_response

</>

pub fn list_system_waypoints_response(
  response: response.Response(BitArray),
) -> Result(
  PagedData(List(spacetraders_models.Waypoint)),
  ApiError,
)

list_systems_request

</>

pub fn list_systems_request(
  page: option.Option(Int),
  limit: option.Option(Int),
) -> request.Request(BitArray)

list_systems_response

</>

pub fn list_systems_response(
  response: response.Response(BitArray),
) -> Result(PagedData(List(spacetraders_models.System)), ApiError)

navigate_ship_request

</>

pub fn navigate_ship_request(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
  waypoint_symbol: spacetraders_models.WaypointSymbol,
) -> request.Request(BitArray)

navigate_ship_response

</>

pub fn navigate_ship_response(
  response: response.Response(BitArray),
) -> Result(ShipNavigated, ApiError)

negotiate_contract_request

</>

pub fn negotiate_contract_request(
  token: spacetraders_models.AgentToken,
  ship_symbol: String,
) -> request.Request(BitArray)

negotiate_contract_response

</>

pub fn negotiate_contract_response(
  response: response.Response(BitArray),
) -> Result(spacetraders_models.Contract, ApiError)

orbit_ship_request

</>

pub fn orbit_ship_request(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> request.Request(BitArray)

orbit_ship_response

</>

pub fn orbit_ship_response(
  response: response.Response(BitArray),
) -> Result(spacetraders_models.ShipNav, ApiError)

patch_ship_nav_request

</>

pub fn patch_ship_nav_request(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
  flight_mode: spacetraders_models.ShipNavFlightMode,
) -> request.Request(BitArray)

patch_ship_nav_response

</>

pub fn patch_ship_nav_response(
  response: response.Response(BitArray),
) -> Result(ShipNavPatched, ApiError)

purchase_cargo_request

</>

pub fn purchase_cargo_request(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
  trade_symbol: spacetraders_models.TradeSymbol,
) -> request.Request(BitArray)

purchase_cargo_response

</>

pub fn purchase_cargo_response(
  response: response.Response(BitArray),
) -> Result(CargoPurchased, ApiError)

purchase_ship_request

</>

pub fn purchase_ship_request(
  token: spacetraders_models.AgentToken,
  ship_type: spacetraders_models.ShipType,
  waypoint_symbol: spacetraders_models.WaypointSymbol,
) -> request.Request(BitArray)

purchase_ship_response

</>

pub fn purchase_ship_response(
  response: response.Response(BitArray),
) -> Result(ShipPurchased, ApiError)

refine_ship_request

</>

pub fn refine_ship_request(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
  produce: spacetraders_models.ShipRefinementProduce,
) -> request.Request(BitArray)

refine_ship_response

</>

pub fn refine_ship_response(
  response: response.Response(BitArray),
) -> Result(ShipRefined, ApiError)

refuel_ship_request

</>

pub fn refuel_ship_request(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
  units: option.Option(Int),
  from_cargo: option.Option(Bool),
) -> request.Request(BitArray)

refuel_ship_response

</>

pub fn refuel_ship_response(
  response: response.Response(BitArray),
) -> Result(ShipRefueled, ApiError)

register_new_agent_request

</>

pub fn register_new_agent_request(
  token: spacetraders_models.AccountToken,
  agent_symbol: spacetraders_models.AgentSymbol,
  faction_symbol: spacetraders_models.FactionSymbol,
) -> request.Request(BitArray)

register_new_agent_response

</>

pub fn register_new_agent_response(
  response: response.Response(BitArray),
) -> Result(AgentRegistered, ApiError)

remove_ship_module_request

</>

pub fn remove_ship_module_request(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
  ship_module_symbol: spacetraders_models.ShipModuleSymbol,
) -> request.Request(BitArray)

remove_ship_module_response

</>

pub fn remove_ship_module_response(
  response: response.Response(BitArray),
) -> Result(ShipModuleRemoved, ApiError)

remove_ship_mount_request

</>

pub fn remove_ship_mount_request(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
  ship_mount_symbol: spacetraders_models.ShipMountSymbol,
) -> request.Request(BitArray)

remove_ship_mount_response

</>

pub fn remove_ship_mount_response(
  response: response.Response(BitArray),
) -> Result(ShipMountRemoved, ApiError)

repair_ship_request

</>

pub fn repair_ship_request(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> request.Request(BitArray)

repair_ship_response

</>

pub fn repair_ship_response(
  response: response.Response(BitArray),
) -> Result(ShipRepaired, ApiError)

scan_ships_request

</>

pub fn scan_ships_request(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> request.Request(BitArray)

scan_ships_response

</>

pub fn scan_ships_response(
  response: response.Response(BitArray),
) -> Result(ShipsScan, ApiError)

scan_systems_request

</>

pub fn scan_systems_request(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> request.Request(BitArray)

scan_systems_response

</>

pub fn scan_systems_response(
  response: response.Response(BitArray),
) -> Result(SystemsScan, ApiError)

scan_waypoints_request

</>

pub fn scan_waypoints_request(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> request.Request(BitArray)

scan_waypoints_response

</>

pub fn scan_waypoints_response(
  response: response.Response(BitArray),
) -> Result(WaypointsScan, ApiError)

scrap_ship_request

</>

pub fn scrap_ship_request(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> request.Request(BitArray)

scrap_ship_response

</>

pub fn scrap_ship_response(
  response: response.Response(BitArray),
) -> Result(ShipScrapped, ApiError)

sell_cargo_request

</>

pub fn sell_cargo_request(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
  trade_symbol: spacetraders_models.TradeSymbol,
  units: Int,
) -> request.Request(BitArray)

sell_cargo_response

</>

pub fn sell_cargo_response(
  response: response.Response(BitArray),
) -> Result(CargoSold, ApiError)

siphon_resources_request

</>

pub fn siphon_resources_request(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
) -> request.Request(BitArray)

siphon_resources_response

</>

pub fn siphon_resources_response(
  response: response.Response(BitArray),
) -> Result(ResourcesSiphoned, ApiError)

supply_construction_site_request

</>

pub fn supply_construction_site_request(
  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,
) -> request.Request(BitArray)

supply_construction_site_response

</>

pub fn supply_construction_site_response(
  response: response.Response(BitArray),
) -> Result(ConstructionSiteSupplied, ApiError)

transfer_cargo_request

</>

pub fn transfer_cargo_request(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
  trade_symbol: spacetraders_models.TradeSymbol,
  units: Int,
  target_ship_symbol: spacetraders_models.ShipSymbol,
) -> request.Request(BitArray)

transfer_cargo_response

</>

pub fn transfer_cargo_response(
  response: response.Response(BitArray),
) -> Result(CargoTransferred, ApiError)

warp_ship_request

</>

pub fn warp_ship_request(
  token: spacetraders_models.AgentToken,
  ship_symbol: spacetraders_models.ShipSymbol,
  waypoint_symbol: spacetraders_models.WaypointSymbol,
) -> request.Request(BitArray)

warp_ship_response

</>

pub fn warp_ship_response(
  response: response.Response(BitArray),
) -> Result(ShipWarped, ApiError)