EveESI.Api.UserInterface (EveESI v1.0.0)

API calls for all endpoints tagged UserInterface.

Summary

Functions

post_ui_autopilot_waypoint(connection, add_to_beginning, clear_other_waypoints, destination_id, opts \\ [])

Set Autopilot Waypoint Set a solar system as autopilot waypoint --- Alternate route: /dev/ui/autopilot/waypoint/ Alternate route: /legacy/ui/autopilot/waypoint/ Alternate route: /v2/ui/autopilot/waypoint/

post_ui_openwindow_contract(connection, contract_id, opts \\ [])

Open Contract Window Open the contract window inside the client --- Alternate route: /dev/ui/openwindow/contract/ Alternate route: /legacy/ui/openwindow/contract/ Alternate route: /v1/ui/openwindow/contract/

post_ui_openwindow_information(connection, target_id, opts \\ [])

Open Information Window Open the information window for a character, corporation or alliance inside the client --- Alternate route: /dev/ui/openwindow/information/ Alternate route: /legacy/ui/openwindow/information/ Alternate route: /v1/ui/openwindow/information/

post_ui_openwindow_marketdetails(connection, type_id, opts \\ [])

Open Market Details Open the market details window for a specific typeID inside the client --- Alternate route: /dev/ui/openwindow/marketdetails/ Alternate route: /legacy/ui/openwindow/marketdetails/ Alternate route: /v1/ui/openwindow/marketdetails/

post_ui_openwindow_newmail(connection, new_mail, opts \\ [])

Open New Mail Window Open the New Mail window, according to settings from the request if applicable --- Alternate route: /dev/ui/openwindow/newmail/ Alternate route: /legacy/ui/openwindow/newmail/ Alternate route: /v1/ui/openwindow/newmail/

Functions

post_ui_autopilot_waypoint(connection, add_to_beginning, clear_other_waypoints, destination_id, opts \\ [])

@spec post_ui_autopilot_waypoint(
  Tesla.Env.client(),
  boolean(),
  boolean(),
  integer(),
  keyword()
) ::
  {:ok, nil}
  | {:ok, EveESI.Model.ErrorLimited.t()}
  | {:ok, EveESI.Model.InternalServerError.t()}
  | {:ok, EveESI.Model.ServiceUnavailable.t()}
  | {:ok, EveESI.Model.Unauthorized.t()}
  | {:ok, EveESI.Model.Forbidden.t()}
  | {:ok, EveESI.Model.BadRequest.t()}
  | {:ok, EveESI.Model.GatewayTimeout.t()}
  | {:error, Tesla.Env.t()}

Parameters

connection (EveESI.Connection): Connection to server
add_to_beginning (boolean()): Whether this solar system should be added to the beginning of all waypoints
clear_other_waypoints (boolean()): Whether clean other waypoints beforing adding this one
destination_id (integer()): The destination to travel to, can be solar system, station or structure's id
opts (keyword): Optional parameters
- :datasource (String.t): The server name you would like data from
- :token (String.t): Access token to use if unable to set a header

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

post_ui_openwindow_contract(connection, contract_id, opts \\ [])

@spec post_ui_openwindow_contract(Tesla.Env.client(), integer(), keyword()) ::
  {:ok, nil}
  | {:ok, EveESI.Model.ErrorLimited.t()}
  | {:ok, EveESI.Model.InternalServerError.t()}
  | {:ok, EveESI.Model.ServiceUnavailable.t()}
  | {:ok, EveESI.Model.Unauthorized.t()}
  | {:ok, EveESI.Model.Forbidden.t()}
  | {:ok, EveESI.Model.BadRequest.t()}
  | {:ok, EveESI.Model.GatewayTimeout.t()}
  | {:error, Tesla.Env.t()}

Parameters

connection (EveESI.Connection): Connection to server
contract_id (integer()): The contract to open
opts (keyword): Optional parameters
- :datasource (String.t): The server name you would like data from
- :token (String.t): Access token to use if unable to set a header

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

post_ui_openwindow_information(connection, target_id, opts \\ [])

@spec post_ui_openwindow_information(Tesla.Env.client(), integer(), keyword()) ::
  {:ok, nil}
  | {:ok, EveESI.Model.ErrorLimited.t()}
  | {:ok, EveESI.Model.InternalServerError.t()}
  | {:ok, EveESI.Model.ServiceUnavailable.t()}
  | {:ok, EveESI.Model.Unauthorized.t()}
  | {:ok, EveESI.Model.Forbidden.t()}
  | {:ok, EveESI.Model.BadRequest.t()}
  | {:ok, EveESI.Model.GatewayTimeout.t()}
  | {:error, Tesla.Env.t()}

Parameters

connection (EveESI.Connection): Connection to server
target_id (integer()): The target to open
opts (keyword): Optional parameters
- :datasource (String.t): The server name you would like data from
- :token (String.t): Access token to use if unable to set a header

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

post_ui_openwindow_marketdetails(connection, type_id, opts \\ [])

@spec post_ui_openwindow_marketdetails(Tesla.Env.client(), integer(), keyword()) ::
  {:ok, nil}
  | {:ok, EveESI.Model.ErrorLimited.t()}
  | {:ok, EveESI.Model.InternalServerError.t()}
  | {:ok, EveESI.Model.ServiceUnavailable.t()}
  | {:ok, EveESI.Model.Unauthorized.t()}
  | {:ok, EveESI.Model.Forbidden.t()}
  | {:ok, EveESI.Model.BadRequest.t()}
  | {:ok, EveESI.Model.GatewayTimeout.t()}
  | {:error, Tesla.Env.t()}

Parameters

connection (EveESI.Connection): Connection to server
type_id (integer()): The item type to open in market window
opts (keyword): Optional parameters
- :datasource (String.t): The server name you would like data from
- :token (String.t): Access token to use if unable to set a header

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

post_ui_openwindow_newmail(connection, new_mail, opts \\ [])

@spec post_ui_openwindow_newmail(
  Tesla.Env.client(),
  EveESI.Model.PostUiOpenwindowNewmailNewMail.t(),
  keyword()
) ::
  {:ok, nil}
  | {:ok, EveESI.Model.ErrorLimited.t()}
  | {:ok, EveESI.Model.InternalServerError.t()}
  | {:ok, EveESI.Model.ServiceUnavailable.t()}
  | {:ok, EveESI.Model.Unauthorized.t()}
  | {:ok, EveESI.Model.Forbidden.t()}
  | {:ok, EveESI.Model.PostUiOpenwindowNewmailUnprocessableEntity.t()}
  | {:ok, EveESI.Model.BadRequest.t()}
  | {:ok, EveESI.Model.GatewayTimeout.t()}
  | {:error, Tesla.Env.t()}

Parameters

connection (EveESI.Connection): Connection to server
new_mail (PostUiOpenwindowNewmailNewMail): The details of mail to create
opts (keyword): Optional parameters
- :datasource (String.t): The server name you would like data from
- :token (String.t): Access token to use if unable to set a header

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure