class EsiClient::CharacterApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/esi-ruby/api/character_api.rb, line 18
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

get_characters_character_id(character_id, opts = {}) click to toggle source

Get character's public information Public information about a character — Alternate route: `/v4/characters/{character_id}/` Alternate route: `/dev/characters/{character_id}/` — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [GetCharactersCharacterIdOk]

# File lib/esi-ruby/api/character_api.rb, line 30
def get_characters_character_id(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_with_http_info(character_id, opts)
  return data
end
get_characters_character_id_agents_research(character_id, opts = {}) click to toggle source

Get agents research Return a list of agents research information for a character. The formula for finding the current research points with an agent is: currentPoints = remainderPoints + pointsPerDay * days(currentTime - researchStartDate) — Alternate route: `/v1/characters/{character_id}/agents_research/` Alternate route: `/legacy/characters/{character_id}/agents_research/` Alternate route: `/dev/characters/{character_id}/agents_research/` — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<GetCharactersCharacterIdAgentsResearch200Ok>]

# File lib/esi-ruby/api/character_api.rb, line 94
def get_characters_character_id_agents_research(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_agents_research_with_http_info(character_id, opts)
  return data
end
get_characters_character_id_agents_research_with_http_info(character_id, opts = {}) click to toggle source

Get agents research Return a list of agents research information for a character. The formula for finding the current research points with an agent is: currentPoints &#x3D; remainderPoints + pointsPerDay * days(currentTime - researchStartDate) — Alternate route: &#x60;/v1/characters/{character_id}/agents_research/&#x60; Alternate route: &#x60;/legacy/characters/{character_id}/agents_research/&#x60; Alternate route: &#x60;/dev/characters/{character_id}/agents_research/&#x60; — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(Array<GetCharactersCharacterIdAgentsResearch200Ok>, Fixnum, Hash)>] Array<GetCharactersCharacterIdAgentsResearch200Ok> data, response status code and response headers

# File lib/esi-ruby/api/character_api.rb, line 108
def get_characters_character_id_agents_research_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CharacterApi.get_characters_character_id_agents_research ..."
  end
  # verify the required parameter 'character_id' is set
  fail ArgumentError, "Missing the required parameter 'character_id' when calling CharacterApi.get_characters_character_id_agents_research" if character_id.nil?
  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/characters/{character_id}/agents_research/".sub('{format}','json').sub('{' + 'character_id' + '}', character_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil?
  query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['evesso']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<GetCharactersCharacterIdAgentsResearch200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CharacterApi#get_characters_character_id_agents_research\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_characters_character_id_blueprints(character_id, opts = {}) click to toggle source

Get blueprints Return a list of blueprints the character has — Alternate route: `/v1/characters/{character_id}/blueprints/` Alternate route: `/legacy/characters/{character_id}/blueprints/` Alternate route: `/dev/characters/{character_id}/blueprints/` — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<GetCharactersCharacterIdBlueprints200Ok>]

# File lib/esi-ruby/api/character_api.rb, line 160
def get_characters_character_id_blueprints(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_blueprints_with_http_info(character_id, opts)
  return data
end
get_characters_character_id_blueprints_with_http_info(character_id, opts = {}) click to toggle source

Get blueprints Return a list of blueprints the character has — Alternate route: &#x60;/v1/characters/{character_id}/blueprints/&#x60; Alternate route: &#x60;/legacy/characters/{character_id}/blueprints/&#x60; Alternate route: &#x60;/dev/characters/{character_id}/blueprints/&#x60; — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(Array<GetCharactersCharacterIdBlueprints200Ok>, Fixnum, Hash)>] Array<GetCharactersCharacterIdBlueprints200Ok> data, response status code and response headers

# File lib/esi-ruby/api/character_api.rb, line 174
def get_characters_character_id_blueprints_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CharacterApi.get_characters_character_id_blueprints ..."
  end
  # verify the required parameter 'character_id' is set
  fail ArgumentError, "Missing the required parameter 'character_id' when calling CharacterApi.get_characters_character_id_blueprints" if character_id.nil?
  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/characters/{character_id}/blueprints/".sub('{format}','json').sub('{' + 'character_id' + '}', character_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil?
  query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['evesso']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<GetCharactersCharacterIdBlueprints200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CharacterApi#get_characters_character_id_blueprints\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_characters_character_id_chat_channels(character_id, opts = {}) click to toggle source

Get chat channels Return chat channels that a character is the owner or an operator of — Alternate route: `/v1/characters/{character_id}/chat_channels/` Alternate route: `/legacy/characters/{character_id}/chat_channels/` Alternate route: `/dev/characters/{character_id}/chat_channels/` — This route is cached for up to 300 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<GetCharactersCharacterIdChatChannels200Ok>]

# File lib/esi-ruby/api/character_api.rb, line 226
def get_characters_character_id_chat_channels(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_chat_channels_with_http_info(character_id, opts)
  return data
end
get_characters_character_id_chat_channels_with_http_info(character_id, opts = {}) click to toggle source

Get chat channels Return chat channels that a character is the owner or an operator of — Alternate route: &#x60;/v1/characters/{character_id}/chat_channels/&#x60; Alternate route: &#x60;/legacy/characters/{character_id}/chat_channels/&#x60; Alternate route: &#x60;/dev/characters/{character_id}/chat_channels/&#x60; — This route is cached for up to 300 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(Array<GetCharactersCharacterIdChatChannels200Ok>, Fixnum, Hash)>] Array<GetCharactersCharacterIdChatChannels200Ok> data, response status code and response headers

# File lib/esi-ruby/api/character_api.rb, line 240
def get_characters_character_id_chat_channels_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CharacterApi.get_characters_character_id_chat_channels ..."
  end
  # verify the required parameter 'character_id' is set
  fail ArgumentError, "Missing the required parameter 'character_id' when calling CharacterApi.get_characters_character_id_chat_channels" if character_id.nil?
  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/characters/{character_id}/chat_channels/".sub('{format}','json').sub('{' + 'character_id' + '}', character_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil?
  query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['evesso']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<GetCharactersCharacterIdChatChannels200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CharacterApi#get_characters_character_id_chat_channels\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_characters_character_id_corporationhistory(character_id, opts = {}) click to toggle source

Get corporation history Get a list of all the corporations a character has been a member of — Alternate route: `/v1/characters/{character_id}/corporationhistory/` Alternate route: `/legacy/characters/{character_id}/corporationhistory/` Alternate route: `/dev/characters/{character_id}/corporationhistory/` — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<GetCharactersCharacterIdCorporationhistory200Ok>]

# File lib/esi-ruby/api/character_api.rb, line 291
def get_characters_character_id_corporationhistory(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_corporationhistory_with_http_info(character_id, opts)
  return data
end
get_characters_character_id_corporationhistory_with_http_info(character_id, opts = {}) click to toggle source

Get corporation history Get a list of all the corporations a character has been a member of — Alternate route: &#x60;/v1/characters/{character_id}/corporationhistory/&#x60; Alternate route: &#x60;/legacy/characters/{character_id}/corporationhistory/&#x60; Alternate route: &#x60;/dev/characters/{character_id}/corporationhistory/&#x60; — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(Array<GetCharactersCharacterIdCorporationhistory200Ok>, Fixnum, Hash)>] Array<GetCharactersCharacterIdCorporationhistory200Ok> data, response status code and response headers

# File lib/esi-ruby/api/character_api.rb, line 304
def get_characters_character_id_corporationhistory_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CharacterApi.get_characters_character_id_corporationhistory ..."
  end
  # verify the required parameter 'character_id' is set
  fail ArgumentError, "Missing the required parameter 'character_id' when calling CharacterApi.get_characters_character_id_corporationhistory" if character_id.nil?
  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/characters/{character_id}/corporationhistory/".sub('{format}','json').sub('{' + 'character_id' + '}', character_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<GetCharactersCharacterIdCorporationhistory200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CharacterApi#get_characters_character_id_corporationhistory\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_characters_character_id_medals(character_id, opts = {}) click to toggle source

Get medals Return a list of medals the character has — Alternate route: `/v1/characters/{character_id}/medals/` Alternate route: `/legacy/characters/{character_id}/medals/` Alternate route: `/dev/characters/{character_id}/medals/` — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<GetCharactersCharacterIdMedals200Ok>]

# File lib/esi-ruby/api/character_api.rb, line 355
def get_characters_character_id_medals(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_medals_with_http_info(character_id, opts)
  return data
end
get_characters_character_id_medals_with_http_info(character_id, opts = {}) click to toggle source

Get medals Return a list of medals the character has — Alternate route: &#x60;/v1/characters/{character_id}/medals/&#x60; Alternate route: &#x60;/legacy/characters/{character_id}/medals/&#x60; Alternate route: &#x60;/dev/characters/{character_id}/medals/&#x60; — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(Array<GetCharactersCharacterIdMedals200Ok>, Fixnum, Hash)>] Array<GetCharactersCharacterIdMedals200Ok> data, response status code and response headers

# File lib/esi-ruby/api/character_api.rb, line 369
def get_characters_character_id_medals_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CharacterApi.get_characters_character_id_medals ..."
  end
  # verify the required parameter 'character_id' is set
  fail ArgumentError, "Missing the required parameter 'character_id' when calling CharacterApi.get_characters_character_id_medals" if character_id.nil?
  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/characters/{character_id}/medals/".sub('{format}','json').sub('{' + 'character_id' + '}', character_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil?
  query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['evesso']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<GetCharactersCharacterIdMedals200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CharacterApi#get_characters_character_id_medals\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_characters_character_id_portrait(character_id, opts = {}) click to toggle source

Get character portraits Get portrait urls for a character — Alternate route: `/v2/characters/{character_id}/portrait/` Alternate route: `/dev/characters/{character_id}/portrait/` — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [GetCharactersCharacterIdPortraitOk]

# File lib/esi-ruby/api/character_api.rb, line 420
def get_characters_character_id_portrait(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_portrait_with_http_info(character_id, opts)
  return data
end
get_characters_character_id_portrait_with_http_info(character_id, opts = {}) click to toggle source

Get character portraits Get portrait urls for a character — Alternate route: &#x60;/v2/characters/{character_id}/portrait/&#x60; Alternate route: &#x60;/dev/characters/{character_id}/portrait/&#x60; — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(GetCharactersCharacterIdPortraitOk, Fixnum, Hash)>] GetCharactersCharacterIdPortraitOk data, response status code and response headers

# File lib/esi-ruby/api/character_api.rb, line 433
def get_characters_character_id_portrait_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CharacterApi.get_characters_character_id_portrait ..."
  end
  # verify the required parameter 'character_id' is set
  fail ArgumentError, "Missing the required parameter 'character_id' when calling CharacterApi.get_characters_character_id_portrait" if character_id.nil?
  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/characters/{character_id}/portrait/".sub('{format}','json').sub('{' + 'character_id' + '}', character_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GetCharactersCharacterIdPortraitOk')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CharacterApi#get_characters_character_id_portrait\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_characters_character_id_roles(character_id, opts = {}) click to toggle source

Get character corporation roles Returns a character's corporation roles — Alternate route: `/v1/characters/{character_id}/roles/` Alternate route: `/legacy/characters/{character_id}/roles/` Alternate route: `/dev/characters/{character_id}/roles/` — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<String>]

# File lib/esi-ruby/api/character_api.rb, line 484
def get_characters_character_id_roles(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_roles_with_http_info(character_id, opts)
  return data
end
get_characters_character_id_roles_with_http_info(character_id, opts = {}) click to toggle source

Get character corporation roles Returns a character&#39;s corporation roles — Alternate route: &#x60;/v1/characters/{character_id}/roles/&#x60; Alternate route: &#x60;/legacy/characters/{character_id}/roles/&#x60; Alternate route: &#x60;/dev/characters/{character_id}/roles/&#x60; — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(Array<String>, Fixnum, Hash)>] Array<String> data, response status code and response headers

# File lib/esi-ruby/api/character_api.rb, line 498
def get_characters_character_id_roles_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CharacterApi.get_characters_character_id_roles ..."
  end
  # verify the required parameter 'character_id' is set
  fail ArgumentError, "Missing the required parameter 'character_id' when calling CharacterApi.get_characters_character_id_roles" if character_id.nil?
  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/characters/{character_id}/roles/".sub('{format}','json').sub('{' + 'character_id' + '}', character_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil?
  query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['evesso']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<String>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CharacterApi#get_characters_character_id_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_characters_character_id_standings(character_id, opts = {}) click to toggle source

Get standings Return character standings from agents, NPC corporations, and factions — Alternate route: `/v1/characters/{character_id}/standings/` Alternate route: `/legacy/characters/{character_id}/standings/` Alternate route: `/dev/characters/{character_id}/standings/` — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<GetCharactersCharacterIdStandings200Ok>]

# File lib/esi-ruby/api/character_api.rb, line 550
def get_characters_character_id_standings(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_standings_with_http_info(character_id, opts)
  return data
end
get_characters_character_id_standings_with_http_info(character_id, opts = {}) click to toggle source

Get standings Return character standings from agents, NPC corporations, and factions — Alternate route: &#x60;/v1/characters/{character_id}/standings/&#x60; Alternate route: &#x60;/legacy/characters/{character_id}/standings/&#x60; Alternate route: &#x60;/dev/characters/{character_id}/standings/&#x60; — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(Array<GetCharactersCharacterIdStandings200Ok>, Fixnum, Hash)>] Array<GetCharactersCharacterIdStandings200Ok> data, response status code and response headers

# File lib/esi-ruby/api/character_api.rb, line 564
def get_characters_character_id_standings_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CharacterApi.get_characters_character_id_standings ..."
  end
  # verify the required parameter 'character_id' is set
  fail ArgumentError, "Missing the required parameter 'character_id' when calling CharacterApi.get_characters_character_id_standings" if character_id.nil?
  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/characters/{character_id}/standings/".sub('{format}','json').sub('{' + 'character_id' + '}', character_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil?
  query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['evesso']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<GetCharactersCharacterIdStandings200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CharacterApi#get_characters_character_id_standings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_characters_character_id_with_http_info(character_id, opts = {}) click to toggle source

Get character&#39;s public information Public information about a character — Alternate route: &#x60;/v4/characters/{character_id}/&#x60; Alternate route: &#x60;/dev/characters/{character_id}/&#x60; — This route is cached for up to 3600 seconds @param character_id An EVE character ID @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(GetCharactersCharacterIdOk, Fixnum, Hash)>] GetCharactersCharacterIdOk data, response status code and response headers

# File lib/esi-ruby/api/character_api.rb, line 43
def get_characters_character_id_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CharacterApi.get_characters_character_id ..."
  end
  # verify the required parameter 'character_id' is set
  fail ArgumentError, "Missing the required parameter 'character_id' when calling CharacterApi.get_characters_character_id" if character_id.nil?
  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/characters/{character_id}/".sub('{format}','json').sub('{' + 'character_id' + '}', character_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GetCharactersCharacterIdOk')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CharacterApi#get_characters_character_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_characters_names(character_ids, opts = {}) click to toggle source

Get character names Resolve a set of character IDs to character names — Alternate route: `/v1/characters/names/` Alternate route: `/legacy/characters/names/` Alternate route: `/dev/characters/names/` — This route is cached for up to 3600 seconds @param character_ids A comma separated list of character IDs @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<GetCharactersNames200Ok>]

# File lib/esi-ruby/api/character_api.rb, line 615
def get_characters_names(character_ids, opts = {})
  data, _status_code, _headers = get_characters_names_with_http_info(character_ids, opts)
  return data
end
get_characters_names_with_http_info(character_ids, opts = {}) click to toggle source

Get character names Resolve a set of character IDs to character names — Alternate route: &#x60;/v1/characters/names/&#x60; Alternate route: &#x60;/legacy/characters/names/&#x60; Alternate route: &#x60;/dev/characters/names/&#x60; — This route is cached for up to 3600 seconds @param character_ids A comma separated list of character IDs @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(Array<GetCharactersNames200Ok>, Fixnum, Hash)>] Array<GetCharactersNames200Ok> data, response status code and response headers

# File lib/esi-ruby/api/character_api.rb, line 628
def get_characters_names_with_http_info(character_ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CharacterApi.get_characters_names ..."
  end
  # verify the required parameter 'character_ids' is set
  fail ArgumentError, "Missing the required parameter 'character_ids' when calling CharacterApi.get_characters_names" if character_ids.nil?
  if character_ids.length > 1000
    fail ArgumentError, 'invalid value for "character_ids" when calling CharacterApi.get_characters_names, number of items must be less than or equal to 1000.'
  end

  if character_ids.length < 1
    fail ArgumentError, 'invalid value for "character_ids" when calling CharacterApi.get_characters_names, number of items must be greater than or equal to 1.'
  end

  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/characters/names/".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'character_ids'] = @api_client.build_collection_param(character_ids, :csv)
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<GetCharactersNames200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CharacterApi#get_characters_names\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_characters_affiliation(characters, opts = {}) click to toggle source

Character affiliation Bulk lookup of character IDs to corporation, alliance and faction — Alternate route: `/v1/characters/affiliation/` Alternate route: `/legacy/characters/affiliation/` Alternate route: `/dev/characters/affiliation/` — This route is cached for up to 3600 seconds @param characters The character IDs to fetch affiliations for @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<PostCharactersAffiliation200Ok>]

# File lib/esi-ruby/api/character_api.rb, line 687
def post_characters_affiliation(characters, opts = {})
  data, _status_code, _headers = post_characters_affiliation_with_http_info(characters, opts)
  return data
end
post_characters_affiliation_with_http_info(characters, opts = {}) click to toggle source

Character affiliation Bulk lookup of character IDs to corporation, alliance and faction — Alternate route: &#x60;/v1/characters/affiliation/&#x60; Alternate route: &#x60;/legacy/characters/affiliation/&#x60; Alternate route: &#x60;/dev/characters/affiliation/&#x60; — This route is cached for up to 3600 seconds @param characters The character IDs to fetch affiliations for @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(Array<PostCharactersAffiliation200Ok>, Fixnum, Hash)>] Array<PostCharactersAffiliation200Ok> data, response status code and response headers

# File lib/esi-ruby/api/character_api.rb, line 700
def post_characters_affiliation_with_http_info(characters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CharacterApi.post_characters_affiliation ..."
  end
  # verify the required parameter 'characters' is set
  fail ArgumentError, "Missing the required parameter 'characters' when calling CharacterApi.post_characters_affiliation" if characters.nil?
  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/characters/affiliation/".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(characters)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<PostCharactersAffiliation200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CharacterApi#post_characters_affiliation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_characters_character_id_cspa(character_id, characters, opts = {}) click to toggle source

Calculate a CSPA charge cost Takes a source character ID in the url and a set of target character ID's in the body, returns a CSPA charge cost — Alternate route: `/v3/characters/{character_id}/cspa/` Alternate route: `/legacy/characters/{character_id}/cspa/` Alternate route: `/dev/characters/{character_id}/cspa/` @param character_id An EVE character ID @param characters The target characters to calculate the charge for @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from (default to tranquility) @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [PostCharactersCharacterIdCspaCreated]

# File lib/esi-ruby/api/character_api.rb, line 752
def post_characters_character_id_cspa(character_id, characters, opts = {})
  data, _status_code, _headers = post_characters_character_id_cspa_with_http_info(character_id, characters, opts)
  return data
end
post_characters_character_id_cspa_with_http_info(character_id, characters, opts = {}) click to toggle source

Calculate a CSPA charge cost Takes a source character ID in the url and a set of target character ID&#39;s in the body, returns a CSPA charge cost — Alternate route: &#x60;/v3/characters/{character_id}/cspa/&#x60; Alternate route: &#x60;/legacy/characters/{character_id}/cspa/&#x60; Alternate route: &#x60;/dev/characters/{character_id}/cspa/&#x60; @param character_id An EVE character ID @param characters The target characters to calculate the charge for @param [Hash] opts the optional parameters @option opts [String] :datasource The server name you would like data from @option opts [String] :token Access token to use if unable to set a header @option opts [String] :user_agent Client identifier, takes precedence over headers @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent @return [Array<(PostCharactersCharacterIdCspaCreated, Fixnum, Hash)>] PostCharactersCharacterIdCspaCreated data, response status code and response headers

# File lib/esi-ruby/api/character_api.rb, line 767
def post_characters_character_id_cspa_with_http_info(character_id, characters, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CharacterApi.post_characters_character_id_cspa ..."
  end
  # verify the required parameter 'character_id' is set
  fail ArgumentError, "Missing the required parameter 'character_id' when calling CharacterApi.post_characters_character_id_cspa" if character_id.nil?
  # verify the required parameter 'characters' is set
  fail ArgumentError, "Missing the required parameter 'characters' when calling CharacterApi.post_characters_character_id_cspa" if characters.nil?
  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/characters/{character_id}/cspa/".sub('{format}','json').sub('{' + 'character_id' + '}', character_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil?
  query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(characters)
  auth_names = ['evesso']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PostCharactersCharacterIdCspaCreated')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CharacterApi#post_characters_character_id_cspa\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end