esi v0.1.1 ESI.API.Fleet

create_members_opt ::
  {:invitation, [character_id: integer, role: :fleet_commander | :wing_commander | :squad_commander | :squad_member, squad_id: nil | integer, wing_id: nil | integer]} |
  {:token, nil | String.t}

create_members_opts()

create_members_opts() :: [create_members_opt]

Options for Fleet.create_members/2.

:invitation (REQUIRED) — Details of the invitation
:token — Access token to use if unable to set a header

create_squads_opt()

create_squads_opt() :: {:token, nil | String.t}

create_squads_opts()

create_squads_opts() :: [create_squads_opt]

Options for Fleet.create_squads/3.

:token — Access token to use if unable to set a header

create_wings_opt()

create_wings_opt() :: {:token, nil | String.t}

create_wings_opts()

create_wings_opts() :: [create_wings_opt]

Options for Fleet.create_wings/2.

:token — Access token to use if unable to set a header

delete_member_opt()

delete_member_opt() :: {:token, nil | String.t}

delete_member_opts()

delete_member_opts() :: [delete_member_opt]

Options for Fleet.delete_member/3.

:token — Access token to use if unable to set a header

delete_squad_opt()

delete_squad_opt() :: {:token, nil | String.t}

delete_squad_opts()

delete_squad_opts() :: [delete_squad_opt]

Options for Fleet.delete_squad/3.

:token — Access token to use if unable to set a header

delete_wing_opt()

delete_wing_opt() :: {:token, nil | String.t}

delete_wing_opts()

delete_wing_opts() :: [delete_wing_opt]

Options for Fleet.delete_wing/3.

:token — Access token to use if unable to set a header

fleet_opt()

fleet_opt() :: {:token, nil | String.t}

fleet_opts()

fleet_opts() :: [fleet_opt]

Options for Fleet.fleet/2.

:token — Access token to use if unable to set a header

members_opt()

members_opt ::
  {:language, nil | :de | :"en-us" | :fr | :ja | :ru | :zh} |
  {:token, nil | String.t}

members_opts()

members_opts() :: [members_opt]

Options for Fleet.members/2.

:language (DEFAULT: :"en-us") — Language to use in the response
:token — Access token to use if unable to set a header

update_fleet_opt()

update_fleet_opt ::
  {:new_settings, [is_free_move: nil | boolean, motd: nil | String.t]} |
  {:token, nil | String.t}

update_fleet_opts()

update_fleet_opts() :: [update_fleet_opt]

Options for Fleet.update_fleet/2.

:new_settings (REQUIRED) — What to update for this fleet
:token — Access token to use if unable to set a header

update_member_opt()

update_member_opt ::
  {:movement, [role: :fleet_commander | :wing_commander | :squad_commander | :squad_member, squad_id: nil | integer, wing_id: nil | integer]} |
  {:token, nil | String.t}

update_member_opts()

update_member_opts() :: [update_member_opt]

Options for Fleet.update_member/3.

:movement (REQUIRED) — Details of the invitation
:token — Access token to use if unable to set a header

update_squad_opt()

update_squad_opt ::
  {:naming, [{:name, String.t}]} |
  {:token, nil | String.t}

update_squad_opts()

update_squad_opts() :: [update_squad_opt]

Options for Fleet.update_squad/3.

:naming (REQUIRED) — New name of the squad
:token — Access token to use if unable to set a header

update_wing_opt()

update_wing_opt ::
  {:naming, [{:name, String.t}]} |
  {:token, nil | String.t}

update_wing_opts()

update_wing_opts() :: [update_wing_opt]

Options for Fleet.update_wing/3.

:naming (REQUIRED) — New name of the wing
:token — Access token to use if unable to set a header

wings_opt()

wings_opt ::
  {:language, nil | :de | :"en-us" | :fr | :ja | :ru | :zh} |
  {:token, nil | String.t}

wings_opts()

wings_opts() :: [wings_opt]

Options for Fleet.wings/2.

:language (DEFAULT: :"en-us") — Language to use in the response
:token — Access token to use if unable to set a header

Functions

create_members(fleet_id, opts \\ [])

create_members(fleet_id :: integer, opts :: create_members_opts) :: ESI.Request.t

Invite a character into the fleet. If a character has a CSPA charge set it is not possible to invite them to the fleet using ESI.

Response Example

No example available.

Swagger Source

This function was generated from the following Swagger operation:

operationId — post_fleets_fleet_id_members
path — /fleets/{fleet_id}/members/

View on ESI Site

create_squads(fleet_id, wing_id, opts \\ [])

create_squads(fleet_id :: integer, wing_id :: integer, opts :: create_squads_opts) :: ESI.Request.t

Create a new squad in a fleet.

Response Example

Squad created:

%{"squad_id" => 123}

Swagger Source

This function was generated from the following Swagger operation:

operationId — post_fleets_fleet_id_wings_wing_id_squads
path — /fleets/{fleet_id}/wings/{wing_id}/squads/

View on ESI Site

create_wings(fleet_id, opts \\ [])

create_wings(fleet_id :: integer, opts :: create_wings_opts) :: ESI.Request.t

Create a new wing in a fleet.

Response Example

Wing created:

%{"wing_id" => 123}

Swagger Source

This function was generated from the following Swagger operation:

operationId — post_fleets_fleet_id_wings
path — /fleets/{fleet_id}/wings/

View on ESI Site

delete_member(fleet_id, member_id, opts \\ [])

delete_member(fleet_id :: integer, member_id :: integer, opts :: delete_member_opts) :: ESI.Request.t

Kick a fleet member.

Response Example

No example available.

Swagger Source

This function was generated from the following Swagger operation:

operationId — delete_fleets_fleet_id_members_member_id
path — /fleets/{fleet_id}/members/{member_id}/

View on ESI Site

delete_squad(fleet_id, squad_id, opts \\ [])

delete_squad(fleet_id :: integer, squad_id :: integer, opts :: delete_squad_opts) :: ESI.Request.t

Delete a fleet squad, only empty squads can be deleted.

Response Example

No example available.

Swagger Source

This function was generated from the following Swagger operation:

operationId — delete_fleets_fleet_id_squads_squad_id
path — /fleets/{fleet_id}/squads/{squad_id}/

View on ESI Site

delete_wing(fleet_id, wing_id, opts \\ [])

delete_wing(fleet_id :: integer, wing_id :: integer, opts :: delete_wing_opts) :: ESI.Request.t

Delete a fleet wing, only empty wings can be deleted. The wing may contain squads, but the squads must be empty.

Response Example

No example available.

Swagger Source

This function was generated from the following Swagger operation:

operationId — delete_fleets_fleet_id_wings_wing_id
path — /fleets/{fleet_id}/wings/{wing_id}/

View on ESI Site

fleet(fleet_id, opts \\ [])

fleet(fleet_id :: integer, opts :: fleet_opts) :: ESI.Request.t

Return details about a fleet.

Response Example

Details about a fleet:

%{"is_free_move" => false, "is_registered" => false,
  "is_voice_enabled" => false, "motd" => "This is an <b>awesome</b> fleet!"}

Swagger Source

This function was generated from the following Swagger operation:

operationId — get_fleets_fleet_id
path — /fleets/{fleet_id}/

View on ESI Site

members(fleet_id, opts \\ [])

members(fleet_id :: integer, opts :: members_opts) :: ESI.Request.t

Return information about fleet members.

Response Example

A list of fleet members:

[%{"character_id" => 93265215, "join_time" => "2016-04-29T12:34:56Z",
   "role" => "squad_commander", "role_name" => "Squad Commander (Boss)",
   "ship_type_id" => 33328, "solar_system_id" => 30003729,
   "squad_id" => 3129411261968, "station_id" => 61000180,
   "takes_fleet_warp" => true, "wing_id" => 2073711261968}]

Swagger Source

This function was generated from the following Swagger operation:

operationId — get_fleets_fleet_id_members
path — /fleets/{fleet_id}/members/

View on ESI Site

update_fleet(fleet_id, opts \\ [])

update_fleet(fleet_id :: integer, opts :: update_fleet_opts) :: ESI.Request.t

Update settings about a fleet.

Response Example

No example available.

Swagger Source

This function was generated from the following Swagger operation:

operationId — put_fleets_fleet_id
path — /fleets/{fleet_id}/

View on ESI Site

update_member(fleet_id, member_id, opts \\ [])

update_member(fleet_id :: integer, member_id :: integer, opts :: update_member_opts) :: ESI.Request.t

Move a fleet member around.

Response Example

No example available.

Swagger Source

This function was generated from the following Swagger operation:

operationId — put_fleets_fleet_id_members_member_id
path — /fleets/{fleet_id}/members/{member_id}/

View on ESI Site

update_squad(fleet_id, squad_id, opts \\ [])

update_squad(fleet_id :: integer, squad_id :: integer, opts :: update_squad_opts) :: ESI.Request.t

Rename a fleet squad.

Response Example

No example available.

Swagger Source

This function was generated from the following Swagger operation:

operationId — put_fleets_fleet_id_squads_squad_id
path — /fleets/{fleet_id}/squads/{squad_id}/

View on ESI Site

update_wing(fleet_id, wing_id, opts \\ [])

update_wing(fleet_id :: integer, wing_id :: integer, opts :: update_wing_opts) :: ESI.Request.t

Rename a fleet wing.

Response Example

No example available.

Swagger Source

This function was generated from the following Swagger operation:

operationId — put_fleets_fleet_id_wings_wing_id
path — /fleets/{fleet_id}/wings/{wing_id}/

View on ESI Site

wings(fleet_id, opts \\ [])

wings(fleet_id :: integer, opts :: wings_opts) :: ESI.Request.t

Return information about wings in a fleet.

Response Example

A list of fleet wings:

[%{"id" => 2073711261968, "name" => "Wing 1",
   "squads" => [%{"id" => 3129411261968, "name" => "Squad 1"}]}]

Swagger Source

This function was generated from the following Swagger operation:

operationId — get_fleets_fleet_id_wings
path — /fleets/{fleet_id}/wings/

View on ESI Site