EveESI.Api.Assets (EveESI v1.0.0)

API calls for all endpoints tagged Assets.

Summary

Functions

get_characters_character_id_assets(connection, character_id, opts \\ [])

Get character assets Return a list of the characters assets --- Alternate route: /dev/characters/{character_id}/assets/ Alternate route: /v5/characters/{character_id}/assets/ --- This route is cached for up to 3600 seconds

get_corporations_corporation_id_assets(connection, corporation_id, opts \\ [])

Get corporation assets Return a list of the corporation assets --- Alternate route: /dev/corporations/{corporation_id}/assets/ Alternate route: /v5/corporations/{corporation_id}/assets/ --- This route is cached for up to 3600 seconds --- Requires one of the following EVE corporation role(s): Director

post_characters_character_id_assets_locations(connection, character_id, item_ids, opts \\ [])

Get character asset locations Return locations for a set of item ids, which you can get from character assets endpoint. Coordinates for items in hangars or stations are set to (0,0,0) --- Alternate route: /dev/characters/{character_id}/assets/locations/ Alternate route: /v2/characters/{character_id}/assets/locations/

post_characters_character_id_assets_names(connection, character_id, item_ids, opts \\ [])

Get character asset names Return names for a set of item ids, which you can get from character assets endpoint. Typically used for items that can customize names, like containers or ships. --- Alternate route: /dev/characters/{character_id}/assets/names/ Alternate route: /legacy/characters/{character_id}/assets/names/ Alternate route: /v1/characters/{character_id}/assets/names/

post_corporations_corporation_id_assets_locations(connection, corporation_id, item_ids, opts \\ [])

Get corporation asset locations Return locations for a set of item ids, which you can get from corporation assets endpoint. Coordinates for items in hangars or stations are set to (0,0,0) --- Alternate route: /dev/corporations/{corporation_id}/assets/locations/ Alternate route: /v2/corporations/{corporation_id}/assets/locations/ --- Requires one of the following EVE corporation role(s): Director

post_corporations_corporation_id_assets_names(connection, corporation_id, item_ids, opts \\ [])

Get corporation asset names Return names for a set of item ids, which you can get from corporation assets endpoint. Only valid for items that can customize names, like containers or ships --- Alternate route: /dev/corporations/{corporation_id}/assets/names/ Alternate route: /legacy/corporations/{corporation_id}/assets/names/ Alternate route: /v1/corporations/{corporation_id}/assets/names/ --- Requires one of the following EVE corporation role(s): Director

Functions

get_characters_character_id_assets(connection, character_id, opts \\ [])

@spec get_characters_character_id_assets(Tesla.Env.client(), integer(), keyword()) ::
  {:ok, [EveESI.Model.GetCharactersCharacterIdAssets200Ok.t()]}
  | {: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.GetCharactersCharacterIdAssetsNotFound.t()}
  | {:ok, EveESI.Model.GatewayTimeout.t()}
  | {:error, Tesla.Env.t()}

Parameters

connection (EveESI.Connection): Connection to server
character_id (integer()): An EVE character ID
opts (keyword): Optional parameters
- :datasource (String.t): The server name you would like data from
- :"If-None-Match" (String.t): ETag from a previous request. A 304 will be returned if this matches the current ETag
- :page (integer()): Which page of results to return
- :token (String.t): Access token to use if unable to set a header

Returns

{:ok, [%GetCharactersCharacterIdAssets200Ok{}, ...]} on success
{:error, Tesla.Env.t} on failure

get_corporations_corporation_id_assets(connection, corporation_id, opts \\ [])

@spec get_corporations_corporation_id_assets(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.GetCorporationsCorporationIdAssets200Ok.t()]}
  | {:ok, EveESI.Model.GatewayTimeout.t()}
  | {:error, Tesla.Env.t()}

Parameters

connection (EveESI.Connection): Connection to server
corporation_id (integer()): An EVE corporation ID
opts (keyword): Optional parameters
- :datasource (String.t): The server name you would like data from
- :"If-None-Match" (String.t): ETag from a previous request. A 304 will be returned if this matches the current ETag
- :page (integer()): Which page of results to return
- :token (String.t): Access token to use if unable to set a header

Returns

{:ok, [%GetCorporationsCorporationIdAssets200Ok{}, ...]} on success
{:error, Tesla.Env.t} on failure

post_characters_character_id_assets_locations(connection, character_id, item_ids, opts \\ [])

@spec post_characters_character_id_assets_locations(
  Tesla.Env.client(),
  integer(),
  [integer()],
  keyword()
) ::
  {:ok, EveESI.Model.ErrorLimited.t()}
  | {:ok, EveESI.Model.InternalServerError.t()}
  | {:ok, EveESI.Model.ServiceUnavailable.t()}
  | {:ok, [EveESI.Model.PostCharactersCharacterIdAssetsLocations200Ok.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
character_id (integer()): An EVE character ID
item_ids ([integer()]): A list of item ids
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, [%PostCharactersCharacterIdAssetsLocations200Ok{}, ...]} on success
{:error, Tesla.Env.t} on failure

post_characters_character_id_assets_names(connection, character_id, item_ids, opts \\ [])

@spec post_characters_character_id_assets_names(
  Tesla.Env.client(),
  integer(),
  [integer()],
  keyword()
) ::
  {:ok, [EveESI.Model.PostCharactersCharacterIdAssetsNames200Ok.t()]}
  | {: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
character_id (integer()): An EVE character ID
item_ids ([integer()]): A list of item ids
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, [%PostCharactersCharacterIdAssetsNames200Ok{}, ...]} on success
{:error, Tesla.Env.t} on failure

post_corporations_corporation_id_assets_locations(connection, corporation_id, item_ids, opts \\ [])

@spec post_corporations_corporation_id_assets_locations(
  Tesla.Env.client(),
  integer(),
  [integer()],
  keyword()
) ::
  {:ok, EveESI.Model.ErrorLimited.t()}
  | {:ok, EveESI.Model.InternalServerError.t()}
  | {:ok, EveESI.Model.ServiceUnavailable.t()}
  | {:ok, [EveESI.Model.PostCorporationsCorporationIdAssetsLocations200Ok.t()]}
  | {:ok, EveESI.Model.Unauthorized.t()}
  | {:ok, EveESI.Model.Forbidden.t()}
  | {:ok, EveESI.Model.PostCorporationsCorporationIdAssetsLocationsNotFound.t()}
  | {:ok, EveESI.Model.BadRequest.t()}
  | {:ok, EveESI.Model.GatewayTimeout.t()}
  | {:error, Tesla.Env.t()}

Parameters

connection (EveESI.Connection): Connection to server
corporation_id (integer()): An EVE corporation ID
item_ids ([integer()]): A list of item ids
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, [%PostCorporationsCorporationIdAssetsLocations200Ok{}, ...]} on success
{:error, Tesla.Env.t} on failure

post_corporations_corporation_id_assets_names(connection, corporation_id, item_ids, opts \\ [])

@spec post_corporations_corporation_id_assets_names(
  Tesla.Env.client(),
  integer(),
  [integer()],
  keyword()
) ::
  {:ok, EveESI.Model.ErrorLimited.t()}
  | {:ok, EveESI.Model.InternalServerError.t()}
  | {:ok, EveESI.Model.ServiceUnavailable.t()}
  | {:ok, [EveESI.Model.PostCorporationsCorporationIdAssetsNames200Ok.t()]}
  | {:ok, EveESI.Model.Unauthorized.t()}
  | {:ok, EveESI.Model.Forbidden.t()}
  | {:ok, EveESI.Model.BadRequest.t()}
  | {:ok, EveESI.Model.PostCorporationsCorporationIdAssetsNamesNotFound.t()}
  | {:ok, EveESI.Model.GatewayTimeout.t()}
  | {:error, Tesla.Env.t()}

Parameters

connection (EveESI.Connection): Connection to server
corporation_id (integer()): An EVE corporation ID
item_ids ([integer()]): A list of item ids
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, [%PostCorporationsCorporationIdAssetsNames200Ok{}, ...]} on success
{:error, Tesla.Env.t} on failure