class ESI::LocationApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

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

Get character location Information about the characters current location. Returns the current solar system id, and also the current station or structure ID if applicable — Alternate route: `/dev/characters/{character_id}/location/` Alternate route: `/legacy/characters/{character_id}/location/` Alternate route: `/v1/characters/{character_id}/location/` Alternate route: `/v2/characters/{character_id}/location/` — This route is cached for up to 5 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] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @option opts [String] :token Access token to use if unable to set a header @return [GetCharactersCharacterIdLocationOk]

# File lib/ruby-esi/api/location_api.rb, line 30
def get_characters_character_id_location(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_location_with_http_info(character_id, opts)
  data
end
get_characters_character_id_location_with_http_info(character_id, opts = {}) click to toggle source

Get character location Information about the characters current location. Returns the current solar system id, and also the current station or structure ID if applicable — Alternate route: &#x60;/dev/characters/{character_id}/location/&#x60; Alternate route: &#x60;/legacy/characters/{character_id}/location/&#x60; Alternate route: &#x60;/v1/characters/{character_id}/location/&#x60; Alternate route: &#x60;/v2/characters/{character_id}/location/&#x60; — This route is cached for up to 5 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] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @option opts [String] :token Access token to use if unable to set a header @return [Array<(GetCharactersCharacterIdLocationOk, Fixnum, Hash)>] GetCharactersCharacterIdLocationOk data, response status code and response headers

# File lib/ruby-esi/api/location_api.rb, line 43
def get_characters_character_id_location_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LocationApi.get_characters_character_id_location ...'
  end
  # verify the required parameter 'character_id' is set
  if @api_client.config.client_side_validation && character_id.nil?
    fail ArgumentError, "Missing the required parameter 'character_id' when calling LocationApi.get_characters_character_id_location"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling LocationApi.get_characters_character_id_location, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility'
  end
  # resource path
  local_var_path = '/characters/{character_id}/location/'.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?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].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 => 'GetCharactersCharacterIdLocationOk')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LocationApi#get_characters_character_id_location\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_characters_character_id_online(character_id, opts = {}) click to toggle source

Get character online Checks if the character is currently online — Alternate route: `/dev/characters/{character_id}/online/` Alternate route: `/v2/characters/{character_id}/online/` Alternate route: `/v3/characters/{character_id}/online/` — This route is cached for up to 60 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] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @option opts [String] :token Access token to use if unable to set a header @return [GetCharactersCharacterIdOnlineOk]

# File lib/ruby-esi/api/location_api.rb, line 100
def get_characters_character_id_online(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_online_with_http_info(character_id, opts)
  data
end
get_characters_character_id_online_with_http_info(character_id, opts = {}) click to toggle source

Get character online Checks if the character is currently online — Alternate route: &#x60;/dev/characters/{character_id}/online/&#x60; Alternate route: &#x60;/v2/characters/{character_id}/online/&#x60; Alternate route: &#x60;/v3/characters/{character_id}/online/&#x60; — This route is cached for up to 60 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] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @option opts [String] :token Access token to use if unable to set a header @return [Array<(GetCharactersCharacterIdOnlineOk, Fixnum, Hash)>] GetCharactersCharacterIdOnlineOk data, response status code and response headers

# File lib/ruby-esi/api/location_api.rb, line 113
def get_characters_character_id_online_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LocationApi.get_characters_character_id_online ...'
  end
  # verify the required parameter 'character_id' is set
  if @api_client.config.client_side_validation && character_id.nil?
    fail ArgumentError, "Missing the required parameter 'character_id' when calling LocationApi.get_characters_character_id_online"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling LocationApi.get_characters_character_id_online, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility'
  end
  # resource path
  local_var_path = '/characters/{character_id}/online/'.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?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].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 => 'GetCharactersCharacterIdOnlineOk')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LocationApi#get_characters_character_id_online\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_characters_character_id_ship(character_id, opts = {}) click to toggle source

Get current ship Get the current ship type, name and id — Alternate route: `/dev/characters/{character_id}/ship/` Alternate route: `/legacy/characters/{character_id}/ship/` Alternate route: `/v1/characters/{character_id}/ship/` Alternate route: `/v2/characters/{character_id}/ship/` — This route is cached for up to 5 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] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @option opts [String] :token Access token to use if unable to set a header @return [GetCharactersCharacterIdShipOk]

# File lib/ruby-esi/api/location_api.rb, line 170
def get_characters_character_id_ship(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_ship_with_http_info(character_id, opts)
  data
end
get_characters_character_id_ship_with_http_info(character_id, opts = {}) click to toggle source

Get current ship Get the current ship type, name and id — Alternate route: &#x60;/dev/characters/{character_id}/ship/&#x60; Alternate route: &#x60;/legacy/characters/{character_id}/ship/&#x60; Alternate route: &#x60;/v1/characters/{character_id}/ship/&#x60; Alternate route: &#x60;/v2/characters/{character_id}/ship/&#x60; — This route is cached for up to 5 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] :if_none_match ETag from a previous request. A 304 will be returned if this matches the current ETag @option opts [String] :token Access token to use if unable to set a header @return [Array<(GetCharactersCharacterIdShipOk, Fixnum, Hash)>] GetCharactersCharacterIdShipOk data, response status code and response headers

# File lib/ruby-esi/api/location_api.rb, line 183
def get_characters_character_id_ship_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LocationApi.get_characters_character_id_ship ...'
  end
  # verify the required parameter 'character_id' is set
  if @api_client.config.client_side_validation && character_id.nil?
    fail ArgumentError, "Missing the required parameter 'character_id' when calling LocationApi.get_characters_character_id_ship"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling LocationApi.get_characters_character_id_ship, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility'
  end
  # resource path
  local_var_path = '/characters/{character_id}/ship/'.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?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].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 => 'GetCharactersCharacterIdShipOk')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LocationApi#get_characters_character_id_ship\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end