Class: ESIClient::CharacterApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CharacterApi

Returns a new instance of CharacterApi.



19
20
21
 
# File 'lib/esi_client/api/character_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/esi_client/api/character_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_characters_character_id(character_id, opts = {}) ⇒ GetCharactersCharacterIdOk

Get character’s public information Public information about a character — This route is cached for up to 3600 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)

  • :if_none_match (String) —

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

Returns:



29
30
31
32
 
# File 'lib/esi_client/api/character_api.rb', line 29

def get_characters_character_id(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_with_http_info(character_id, opts)
  data
end

#get_characters_character_id_agents_research(character_id, opts = {}) ⇒ Array<GetCharactersCharacterIdAgentsResearch200Ok>

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) — This route is cached for up to 3600 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)

  • :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:



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

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)
  data
end

#get_characters_character_id_agents_research_with_http_info(character_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdAgentsResearch200Ok>, Fixnum, Hash)>

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) — This route is cached for up to 3600 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

  • :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
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
153
154
155
156
157
158
 
# File 'lib/esi_client/api/character_api.rb', line 110

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
  if @api_client.config.client_side_validation && character_id.nil?
    fail ArgumentError, "Missing the required parameter 'character_id' when calling CharacterApi.get_characters_character_id_agents_research"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling CharacterApi.get_characters_character_id_agents_research, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && 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}/agents_research/'.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 => '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 = {}) ⇒ Array<GetCharactersCharacterIdBlueprints200Ok>

Get blueprints Return a list of blueprints the character owns — This route is cached for up to 3600 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)

  • :if_none_match (String) —

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

  • :page (Integer) —

    Which page of results to return (default to 1)

  • :token (String) —

    Access token to use if unable to set a header

Returns:



168
169
170
171
 
# File 'lib/esi_client/api/character_api.rb', line 168

def get_characters_character_id_blueprints(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_blueprints_with_http_info(character_id, opts)
  data
end

#get_characters_character_id_blueprints_with_http_info(character_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdBlueprints200Ok>, Fixnum, Hash)>

Get blueprints Return a list of blueprints the character owns — This route is cached for up to 3600 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

  • :if_none_match (String) —

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

    Access token to use if unable to set a header

Returns:



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
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
 
# File 'lib/esi_client/api/character_api.rb', line 182

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
  if @api_client.config.client_side_validation && character_id.nil?
    fail ArgumentError, "Missing the required parameter 'character_id' when calling CharacterApi.get_characters_character_id_blueprints"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling CharacterApi.get_characters_character_id_blueprints, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling CharacterApi.get_characters_character_id_blueprints, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v2/characters/{character_id}/blueprints/'.sub('{' + 'character_id' + '}', character_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].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 => '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_corporationhistory(character_id, opts = {}) ⇒ Array<GetCharactersCharacterIdCorporationhistory200Ok>

Get corporation history Get a list of all the corporations a character has been a member of — This route is cached for up to 3600 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)

  • :if_none_match (String) —

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

Returns:



243
244
245
246
 
# File 'lib/esi_client/api/character_api.rb', line 243

def get_characters_character_id_corporationhistory(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_corporationhistory_with_http_info(character_id, opts)
  data
end

#get_characters_character_id_corporationhistory_with_http_info(character_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdCorporationhistory200Ok>, Fixnum, Hash)>

Get corporation history Get a list of all the corporations a character has been a member of — This route is cached for up to 3600 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

  • :if_none_match (String) —

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

Returns:



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/esi_client/api/character_api.rb', line 255

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
  if @api_client.config.client_side_validation && character_id.nil?
    fail ArgumentError, "Missing the required parameter 'character_id' when calling CharacterApi.get_characters_character_id_corporationhistory"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling CharacterApi.get_characters_character_id_corporationhistory, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && 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}/corporationhistory/'.sub('{' + 'character_id' + '}', character_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].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 = []
  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_fatigue(character_id, opts = {}) ⇒ GetCharactersCharacterIdFatigueOk

Get jump fatigue Return a character’s jump activation and fatigue information — This route is cached for up to 300 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)

  • :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:



311
312
313
314
 
# File 'lib/esi_client/api/character_api.rb', line 311

def get_characters_character_id_fatigue(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_fatigue_with_http_info(character_id, opts)
  data
end

#get_characters_character_id_fatigue_with_http_info(character_id, opts = {}) ⇒ Array<(GetCharactersCharacterIdFatigueOk, Fixnum, Hash)>

Get jump fatigue Return a character&#39;s jump activation and fatigue information — This route is cached for up to 300 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

  • :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:



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/esi_client/api/character_api.rb', line 324

def get_characters_character_id_fatigue_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CharacterApi.get_characters_character_id_fatigue ...'
  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 CharacterApi.get_characters_character_id_fatigue"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling CharacterApi.get_characters_character_id_fatigue, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && 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}/fatigue/'.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 => 'GetCharactersCharacterIdFatigueOk')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CharacterApi#get_characters_character_id_fatigue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_characters_character_id_medals(character_id, opts = {}) ⇒ Array<GetCharactersCharacterIdMedals200Ok>

Get medals Return a list of medals the character has — This route is cached for up to 3600 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)

  • :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:



381
382
383
384
 
# File 'lib/esi_client/api/character_api.rb', line 381

def get_characters_character_id_medals(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_medals_with_http_info(character_id, opts)
  data
end

#get_characters_character_id_medals_with_http_info(character_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdMedals200Ok>, Fixnum, Hash)>

Get medals Return a list of medals the character has — This route is cached for up to 3600 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

  • :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:



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'lib/esi_client/api/character_api.rb', line 394

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
  if @api_client.config.client_side_validation && character_id.nil?
    fail ArgumentError, "Missing the required parameter 'character_id' when calling CharacterApi.get_characters_character_id_medals"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling CharacterApi.get_characters_character_id_medals, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && 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}/medals/'.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 => '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_notifications(character_id, opts = {}) ⇒ Array<GetCharactersCharacterIdNotifications200Ok>

Get character notifications Return character notifications — This route is cached for up to 600 seconds — Warning: This route has an upgrade available. — [Diff of the upcoming changes](esi.evetech.net/diff/latest/dev/#GET-/characters/character_id/notifications/)

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)

  • :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:



451
452
453
454
 
# File 'lib/esi_client/api/character_api.rb', line 451

def get_characters_character_id_notifications(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_notifications_with_http_info(character_id, opts)
  data
end

#get_characters_character_id_notifications_contacts(character_id, opts = {}) ⇒ Array<GetCharactersCharacterIdNotificationsContacts200Ok>

Get new contact notifications Return notifications about having been added to someone’s contact list — This route is cached for up to 600 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)

  • :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:



521
522
523
524
 
# File 'lib/esi_client/api/character_api.rb', line 521

def get_characters_character_id_notifications_contacts(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_notifications_contacts_with_http_info(character_id, opts)
  data
end

#get_characters_character_id_notifications_contacts_with_http_info(character_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdNotificationsContacts200Ok>, Fixnum, Hash)>

Get new contact notifications Return notifications about having been added to someone&#39;s contact list — This route is cached for up to 600 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

  • :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:



534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'lib/esi_client/api/character_api.rb', line 534

def get_characters_character_id_notifications_contacts_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CharacterApi.get_characters_character_id_notifications_contacts ...'
  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 CharacterApi.get_characters_character_id_notifications_contacts"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling CharacterApi.get_characters_character_id_notifications_contacts, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && 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}/notifications/contacts/'.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 => 'Array<GetCharactersCharacterIdNotificationsContacts200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CharacterApi#get_characters_character_id_notifications_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_characters_character_id_notifications_with_http_info(character_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdNotifications200Ok>, Fixnum, Hash)>

Get character notifications Return character notifications — This route is cached for up to 600 seconds — Warning: This route has an upgrade available. — [Diff of the upcoming changes](esi.evetech.net/diff/latest/dev/#GET-/characters/character_id/notifications/)

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

  • :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:



464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/esi_client/api/character_api.rb', line 464

def get_characters_character_id_notifications_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CharacterApi.get_characters_character_id_notifications ...'
  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 CharacterApi.get_characters_character_id_notifications"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling CharacterApi.get_characters_character_id_notifications, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && 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 = '/v2/characters/{character_id}/notifications/'.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 => 'Array<GetCharactersCharacterIdNotifications200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CharacterApi#get_characters_character_id_notifications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_characters_character_id_portrait(character_id, opts = {}) ⇒ GetCharactersCharacterIdPortraitOk

Get character portraits Get portrait urls for a character — This route is cached for up to 3600 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)

  • :if_none_match (String) —

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

Returns:



590
591
592
593
 
# File 'lib/esi_client/api/character_api.rb', line 590

def get_characters_character_id_portrait(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_portrait_with_http_info(character_id, opts)
  data
end

#get_characters_character_id_portrait_with_http_info(character_id, opts = {}) ⇒ Array<(GetCharactersCharacterIdPortraitOk, Fixnum, Hash)>

Get character portraits Get portrait urls for a character — This route is cached for up to 3600 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

  • :if_none_match (String) —

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

Returns:



602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
 
# File 'lib/esi_client/api/character_api.rb', line 602

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
  if @api_client.config.client_side_validation && character_id.nil?
    fail ArgumentError, "Missing the required parameter 'character_id' when calling CharacterApi.get_characters_character_id_portrait"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling CharacterApi.get_characters_character_id_portrait, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && 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 = '/v2/characters/{character_id}/portrait/'.sub('{' + 'character_id' + '}', character_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].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 = []
  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 = {}) ⇒ GetCharactersCharacterIdRolesOk

Get character corporation roles Returns a character’s corporation roles — This route is cached for up to 3600 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)

  • :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:



658
659
660
661
 
# File 'lib/esi_client/api/character_api.rb', line 658

def get_characters_character_id_roles(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_roles_with_http_info(character_id, opts)
  data
end

#get_characters_character_id_roles_with_http_info(character_id, opts = {}) ⇒ Array<(GetCharactersCharacterIdRolesOk, Fixnum, Hash)>

Get character corporation roles Returns a character&#39;s corporation roles — This route is cached for up to 3600 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

  • :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:



671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
 
# File 'lib/esi_client/api/character_api.rb', line 671

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
  if @api_client.config.client_side_validation && character_id.nil?
    fail ArgumentError, "Missing the required parameter 'character_id' when calling CharacterApi.get_characters_character_id_roles"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling CharacterApi.get_characters_character_id_roles, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && 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 = '/v2/characters/{character_id}/roles/'.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 => 'GetCharactersCharacterIdRolesOk')
  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 = {}) ⇒ Array<GetCharactersCharacterIdStandings200Ok>

Get standings Return character standings from agents, NPC corporations, and factions — This route is cached for up to 3600 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)

  • :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:



728
729
730
731
 
# File 'lib/esi_client/api/character_api.rb', line 728

def get_characters_character_id_standings(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_standings_with_http_info(character_id, opts)
  data
end

#get_characters_character_id_standings_with_http_info(character_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdStandings200Ok>, Fixnum, Hash)>

Get standings Return character standings from agents, NPC corporations, and factions — This route is cached for up to 3600 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

  • :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:



741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
 
# File 'lib/esi_client/api/character_api.rb', line 741

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
  if @api_client.config.client_side_validation && character_id.nil?
    fail ArgumentError, "Missing the required parameter 'character_id' when calling CharacterApi.get_characters_character_id_standings"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling CharacterApi.get_characters_character_id_standings, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && 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}/standings/'.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 => '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_stats(character_id, opts = {}) ⇒ Array<GetCharactersCharacterIdStats200Ok>

Yearly aggregate stats Returns aggregate yearly stats for a character — This route is cached for up to 86400 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)

  • :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:



798
799
800
801
 
# File 'lib/esi_client/api/character_api.rb', line 798

def get_characters_character_id_stats(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_stats_with_http_info(character_id, opts)
  data
end

#get_characters_character_id_stats_with_http_info(character_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdStats200Ok>, Fixnum, Hash)>

Yearly aggregate stats Returns aggregate yearly stats for a character — This route is cached for up to 86400 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

  • :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:



811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
 
# File 'lib/esi_client/api/character_api.rb', line 811

def get_characters_character_id_stats_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CharacterApi.get_characters_character_id_stats ...'
  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 CharacterApi.get_characters_character_id_stats"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling CharacterApi.get_characters_character_id_stats, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && 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 = '/v2/characters/{character_id}/stats/'.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 => 'Array<GetCharactersCharacterIdStats200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CharacterApi#get_characters_character_id_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_characters_character_id_titles(character_id, opts = {}) ⇒ Array<GetCharactersCharacterIdTitles200Ok>

Get character corporation titles Returns a character’s titles — This route is cached for up to 3600 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)

  • :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:



868
869
870
871
 
# File 'lib/esi_client/api/character_api.rb', line 868

def get_characters_character_id_titles(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_titles_with_http_info(character_id, opts)
  data
end

#get_characters_character_id_titles_with_http_info(character_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdTitles200Ok>, Fixnum, Hash)>

Get character corporation titles Returns a character&#39;s titles — This route is cached for up to 3600 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

  • :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:



881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
 
# File 'lib/esi_client/api/character_api.rb', line 881

def get_characters_character_id_titles_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CharacterApi.get_characters_character_id_titles ...'
  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 CharacterApi.get_characters_character_id_titles"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling CharacterApi.get_characters_character_id_titles, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && 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}/titles/'.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 => 'Array<GetCharactersCharacterIdTitles200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CharacterApi#get_characters_character_id_titles\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 = {}) ⇒ Array<(GetCharactersCharacterIdOk, Fixnum, Hash)>

Get character&#39;s public information Public information about a character — This route is cached for up to 3600 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

  • :if_none_match (String) —

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

Returns:

  • (Array<(GetCharactersCharacterIdOk, Fixnum, Hash)>) —

    GetCharactersCharacterIdOk data, response status code and response headers



41
42
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
 
# File 'lib/esi_client/api/character_api.rb', line 41

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
  if @api_client.config.client_side_validation && character_id.nil?
    fail ArgumentError, "Missing the required parameter 'character_id' when calling CharacterApi.get_characters_character_id"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling CharacterApi.get_characters_character_id, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && 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 = '/v4/characters/{character_id}/'.sub('{' + 'character_id' + '}', character_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].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 = []
  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

#post_characters_affiliation(characters, opts = {}) ⇒ Array<PostCharactersAffiliation200Ok>

Character affiliation Bulk lookup of character IDs to corporation, alliance and faction — This route is cached for up to 3600 seconds

Parameters:

  • characters —

    The character IDs to fetch affiliations for. All characters must exist, or none will be returned.

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

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

Returns:



936
937
938
939
 
# File 'lib/esi_client/api/character_api.rb', line 936

def post_characters_affiliation(characters, opts = {})
  data, _status_code, _headers = post_characters_affiliation_with_http_info(characters, opts)
  data
end

#post_characters_affiliation_with_http_info(characters, opts = {}) ⇒ Array<(Array<PostCharactersAffiliation200Ok>, Fixnum, Hash)>

Character affiliation Bulk lookup of character IDs to corporation, alliance and faction — This route is cached for up to 3600 seconds

Parameters:

  • characters —

    The character IDs to fetch affiliations for. All characters must exist, or none will be returned.

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

Returns:

  • (Array<(Array<PostCharactersAffiliation200Ok>, Fixnum, Hash)>) —

    Array<PostCharactersAffiliation200Ok> data, response status code and response headers



947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
 
# File 'lib/esi_client/api/character_api.rb', line 947

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
  if @api_client.config.client_side_validation && characters.nil?
    fail ArgumentError, "Missing the required parameter 'characters' when calling CharacterApi.post_characters_affiliation"
  end
  if @api_client.config.client_side_validation && 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/affiliation/'

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].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'])

  # 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 = {}) ⇒ Float

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 —

Parameters:

  • character_id —

    An EVE character ID

  • characters —

    The target characters to calculate the charge for

  • 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 unable to set a header

Returns:

  • (Float) 


998
999
1000
1001
 
# File 'lib/esi_client/api/character_api.rb', line 998

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)
  data
end

#post_characters_character_id_cspa_with_http_info(character_id, characters, opts = {}) ⇒ Array<(Float, Fixnum, Hash)>

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 —

Parameters:

  • character_id —

    An EVE character ID

  • characters —

    The target characters to calculate the charge for

  • 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 unable to set a header

Returns:

  • (Array<(Float, Fixnum, Hash)>) —

    Float data, response status code and response headers



1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
 
# File 'lib/esi_client/api/character_api.rb', line 1011

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
  if @api_client.config.client_side_validation && character_id.nil?
    fail ArgumentError, "Missing the required parameter 'character_id' when calling CharacterApi.post_characters_character_id_cspa"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling CharacterApi.post_characters_character_id_cspa, must be greater than or equal to 1.'
  end

  # verify the required parameter 'characters' is set
  if @api_client.config.client_side_validation && characters.nil?
    fail ArgumentError, "Missing the required parameter 'characters' when calling CharacterApi.post_characters_character_id_cspa"
  end
  if @api_client.config.client_side_validation && 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 = '/v4/characters/{character_id}/cspa/'.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'])

  # 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 => 'Float')
  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