endpoints/global

Types

Announcement

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

Constructors

Announcement(title: String, body: String)

ChartLeaderboardEntry

</>

pub type ChartLeaderboardEntry {
  ChartLeaderboardEntry(agent_symbol: String, chart_count: Int)
}

Constructors

ChartLeaderboardEntry(agent_symbol: String, chart_count: Int)

CreditLeaderboardEntry

</>

pub type CreditLeaderboardEntry {
  CreditLeaderboardEntry(agent_symbol: String, credits: Int)
}

Constructors

CreditLeaderboardEntry(agent_symbol: String, credits: Int)

ErrorCode

</>

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

Constructors

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

GetServerStatusResponse

</>

pub type GetServerStatusResponse {
  GetServerStatusResponse(
    status: String,
    version: String,
    reset_date: String,
    description: String,
    stats: Stats,
    health: Health,
    leaderboards: Leaderboards,
    server_resets: ServerResets,
    announcements: List(Announcement),
    links: List(Link),
  )
}

Constructors

GetServerStatusResponse(
  status: String,
  version: String,
  reset_date: String,
  description: String,
  stats: Stats,
  health: Health,
  leaderboards: Leaderboards,
  server_resets: ServerResets,
  announcements: List(Announcement),
  links: List(Link),
)

Health

</>

pub type Health {
  Health(last_market_update: option.Option(String))
}

Constructors

Health(last_market_update: option.Option(String))

Leaderboards

</>

pub type Leaderboards {
  Leaderboards(
    most_credits: List(CreditLeaderboardEntry),
    most_submitted_charts: List(ChartLeaderboardEntry),
  )
}

Constructors

Leaderboards(
  most_credits: List(CreditLeaderboardEntry),
  most_submitted_charts: List(ChartLeaderboardEntry),
)

Link

</>

pub type Link {
  Link(name: String, url: String)
}

Constructors

```
Link(name: String, url: String)
```

ListErrorCodesResponse

</>

pub type ListErrorCodesResponse {
  ListErrorCodesResponse(error_codes: List(ErrorCode))
}

Constructors

ListErrorCodesResponse(error_codes: List(ErrorCode))

ServerResets

</>

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

Constructors

ServerResets(next: String, frequency: String)

Stats

</>

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

Constructors

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

Values

get_server_status

</>

pub fn get_server_status(
  ,
) -> Result(GetServerStatusResponse, api.ApiError)

list_error_codes

</>

pub fn list_error_codes(
  ,
) -> Result(ListErrorCodesResponse, api.ApiError)