Class: ESIClient::LocationApi

Inherits:
Object
  • Object
show all
Defined in:
lib/esi_client/api/location_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LocationApi

Returns a new instance of LocationApi.



18
19
20
 
# File 'lib/esi_client/api/location_api.rb', line 18

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



16
17
18
 
# File 'lib/esi_client/api/location_api.rb', line 16

def api_client
  @api_client
end

Instance Method Details

#get_characters_character_id_location(character_id, opts = {}) ⇒ GetCharactersCharacterIdLocationOk

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. — This route is cached for up to 5 seconds

Parameters:

  • character_id —

    An EVE character ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from (default to tranquility)

  • :token (String) —

    Access token to use, if preferred over a header

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:



31
32
33
34
 
# File 'lib/esi_client/api/location_api.rb', line 31

def get_characters_character_id_location(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_location_with_http_info(character_id, opts)
  return data
end

#get_characters_character_id_location_with_http_info(character_id, opts = {}) ⇒ Array<(GetCharactersCharacterIdLocationOk, Fixnum, Hash)>

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. — This route is cached for up to 5 seconds

Parameters:

  • character_id —

    An EVE character ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :token (String) —

    Access token to use, if preferred over a header

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/esi_client/api/location_api.rb', line 45

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
  fail ArgumentError, "Missing the required parameter 'character_id' when calling LocationApi.get_characters_character_id_location" 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 = "/v1/characters/{character_id}/location/".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 => '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_ship(character_id, opts = {}) ⇒ GetCharactersCharacterIdShipOk

Get current ship Get the current ship type, name and id — This route is cached for up to 5 seconds

Parameters:

  • character_id —

    An EVE character ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from (default to tranquility)

  • :token (String) —

    Access token to use, if preferred over a header

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:



97
98
99
100
 
# File 'lib/esi_client/api/location_api.rb', line 97

def get_characters_character_id_ship(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_ship_with_http_info(character_id, opts)
  return data
end

#get_characters_character_id_ship_with_http_info(character_id, opts = {}) ⇒ Array<(GetCharactersCharacterIdShipOk, Fixnum, Hash)>

Get current ship Get the current ship type, name and id — This route is cached for up to 5 seconds

Parameters:

  • character_id —

    An EVE character ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :token (String) —

    Access token to use, if preferred over a header

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/esi_client/api/location_api.rb', line 111

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
  fail ArgumentError, "Missing the required parameter 'character_id' when calling LocationApi.get_characters_character_id_ship" 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 = "/v1/characters/{character_id}/ship/".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 => '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