Class: ESI::LocationApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby-esi/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.



19
20
21
 
# File 'lib/ruby-esi/api/location_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/ruby-esi/api/location_api.rb', line 17

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 — 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

Parameters:

  • character_id (Integer) —

    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’)

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :token (String) —

    Access token to use if unable to set a header

Returns:



30
31
32
33
 
# 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 = {}) ⇒ Array<(GetCharactersCharacterIdLocationOk, Integer, 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 — 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

Parameters:

  • character_id (Integer) —

    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’)

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :token (String) —

    Access token to use if unable to set a header

Returns:



43
44
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# 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

  allowable_values = ["tranquility"]
  if @api_client.config.client_side_validation && opts[:'datasource'] && !allowable_values.include?(opts[:'datasource'])
    fail ArgumentError, "invalid value for \"datasource\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/characters/{character_id}/location/'.sub('{' + 'character_id' + '}', CGI.escape(character_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetCharactersCharacterIdLocationOk'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['evesso']

  new_options = opts.merge(
    :operation => :"LocationApi.get_characters_character_id_location",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  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 = {}) ⇒ GetCharactersCharacterIdOnlineOk

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

Parameters:

  • character_id (Integer) —

    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’)

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :token (String) —

    Access token to use if unable to set a header

Returns:



110
111
112
113
 
# File 'lib/ruby-esi/api/location_api.rb', line 110

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 = {}) ⇒ Array<(GetCharactersCharacterIdOnlineOk, Integer, Hash)>

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

Parameters:

  • character_id (Integer) —

    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’)

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :token (String) —

    Access token to use if unable to set a header

Returns:



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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/ruby-esi/api/location_api.rb', line 123

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

  allowable_values = ["tranquility"]
  if @api_client.config.client_side_validation && opts[:'datasource'] && !allowable_values.include?(opts[:'datasource'])
    fail ArgumentError, "invalid value for \"datasource\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/characters/{character_id}/online/'.sub('{' + 'character_id' + '}', CGI.escape(character_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetCharactersCharacterIdOnlineOk'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['evesso']

  new_options = opts.merge(
    :operation => :"LocationApi.get_characters_character_id_online",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  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 = {}) ⇒ GetCharactersCharacterIdShipOk

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

Parameters:

  • character_id (Integer) —

    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’)

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :token (String) —

    Access token to use if unable to set a header

Returns:



190
191
192
193
 
# File 'lib/ruby-esi/api/location_api.rb', line 190

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 = {}) ⇒ Array<(GetCharactersCharacterIdShipOk, Integer, Hash)>

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

Parameters:

  • character_id (Integer) —

    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’)

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :token (String) —

    Access token to use if unable to set a header

Returns:



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/ruby-esi/api/location_api.rb', line 203

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

  allowable_values = ["tranquility"]
  if @api_client.config.client_side_validation && opts[:'datasource'] && !allowable_values.include?(opts[:'datasource'])
    fail ArgumentError, "invalid value for \"datasource\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/characters/{character_id}/ship/'.sub('{' + 'character_id' + '}', CGI.escape(character_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetCharactersCharacterIdShipOk'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['evesso']

  new_options = opts.merge(
    :operation => :"LocationApi.get_characters_character_id_ship",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  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