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_clientObject

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)

  • :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/character_api.rb', line 31

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

#get_characters_character_id_agents_research(character_id, opts = {}) ⇒ 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)

  • :token (String)

    Access token to use if unable to set 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/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)
  return 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

  • :token (String)

    Access token to use if unable to set 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
153
154
# File 'lib/esi_client/api/character_api.rb', line 111

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 && 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?
  query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil?

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

  # form parameters
  form_params = {}

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

#get_characters_character_id_blueprints(character_id, opts = {}) ⇒ 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)

  • :page (Integer)

    Which page of results to return (default to 1)

  • :token (String)

    Access token to use if unable to set a header

  • :user_agent (String)

    Client identifier, takes precedence over headers

  • :x_user_agent (String)

    Client identifier, takes precedence over User-Agent

Returns:



166
167
168
169
# File 'lib/esi_client/api/character_api.rb', line 166

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

#get_characters_character_id_blueprints_with_http_info(character_id, opts = {}) ⇒ 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

  • :page (Integer)

    Which page of results to return

  • :token (String)

    Access token to use if unable to set a header

  • :user_agent (String)

    Client identifier, takes precedence over headers

  • :x_user_agent (String)

    Client identifier, takes precedence over User-Agent

Returns:



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

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 && 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}/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?
  query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil?

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

  # form parameters
  form_params = {}

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

#get_characters_character_id_chat_channels(character_id, opts = {}) ⇒ Array<GetCharactersCharacterIdChatChannels200Ok>

Get chat channels Return chat channels that a character is the owner or operator of — 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)

  • :token (String)

    Access token to use if unable to set a header

  • :user_agent (String)

    Client identifier, takes precedence over headers

  • :x_user_agent (String)

    Client identifier, takes precedence over User-Agent

Returns:



236
237
238
239
# File 'lib/esi_client/api/character_api.rb', line 236

def get_characters_character_id_chat_channels(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_chat_channels_with_http_info(character_id, opts)
  return data
end

#get_characters_character_id_chat_channels_with_http_info(character_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdChatChannels200Ok>, Fixnum, Hash)>

Get chat channels Return chat channels that a character is the owner or operator of — 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

  • :token (String)

    Access token to use if unable to set a header

  • :user_agent (String)

    Client identifier, takes precedence over headers

  • :x_user_agent (String)

    Client identifier, takes precedence over User-Agent

Returns:



250
251
252
253
254
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
# File 'lib/esi_client/api/character_api.rb', line 250

def get_characters_character_id_chat_channels_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CharacterApi.get_characters_character_id_chat_channels ..."
  end
  # verify the required parameter 'character_id' is set
  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_chat_channels"
  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}/chat_channels/".sub('{' + 'character_id' + '}', character_id.to_s)

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

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

  # form parameters
  form_params = {}

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

#get_characters_character_id_corporationhistory(character_id, opts = {}) ⇒ 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)

  • :user_agent (String)

    Client identifier, takes precedence over headers

  • :x_user_agent (String)

    Client identifier, takes precedence over User-Agent

Returns:



303
304
305
306
# File 'lib/esi_client/api/character_api.rb', line 303

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

#get_characters_character_id_corporationhistory_with_http_info(character_id, opts = {}) ⇒ 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

  • :user_agent (String)

    Client identifier, takes precedence over headers

  • :x_user_agent (String)

    Client identifier, takes precedence over User-Agent

Returns:



316
317
318
319
320
321
322
323
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
# File 'lib/esi_client/api/character_api.rb', line 316

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 && 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?
  query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil?

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

  # form parameters
  form_params = {}

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

#get_characters_character_id_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)

  • :token (String)

    Access token to use if unable to set a header

  • :user_agent (String)

    Client identifier, takes precedence over headers

  • :x_user_agent (String)

    Client identifier, takes precedence over User-Agent

Returns:



369
370
371
372
# File 'lib/esi_client/api/character_api.rb', line 369

def get_characters_character_id_fatigue(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_fatigue_with_http_info(character_id, opts)
  return 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

  • :token (String)

    Access token to use if unable to set a header

  • :user_agent (String)

    Client identifier, takes precedence over headers

  • :x_user_agent (String)

    Client identifier, takes precedence over User-Agent

Returns:



383
384
385
386
387
388
389
390
391
392
393
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
# File 'lib/esi_client/api/character_api.rb', line 383

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 && 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?
  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 => '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)

  • :token (String)

    Access token to use if unable to set a header

  • :user_agent (String)

    Client identifier, takes precedence over headers

  • :x_user_agent (String)

    Client identifier, takes precedence over User-Agent

Returns:



437
438
439
440
# File 'lib/esi_client/api/character_api.rb', line 437

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

#get_characters_character_id_medals_with_http_info(character_id, opts = {}) ⇒ 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

  • :token (String)

    Access token to use if unable to set a header

  • :user_agent (String)

    Client identifier, takes precedence over headers

  • :x_user_agent (String)

    Client identifier, takes precedence over User-Agent

Returns:



451
452
453
454
455
456
457
458
459
460
461
462
463
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
# File 'lib/esi_client/api/character_api.rb', line 451

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 && 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?
  query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil?

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

  # form parameters
  form_params = {}

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

#get_characters_character_id_notifications(character_id, opts = {}) ⇒ Array<GetCharactersCharacterIdNotifications200Ok>

Get character notifications Return character notifications — 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)

  • :token (String)

    Access token to use if unable to set a header

  • :user_agent (String)

    Client identifier, takes precedence over headers

  • :x_user_agent (String)

    Client identifier, takes precedence over User-Agent

Returns:



505
506
507
508
# File 'lib/esi_client/api/character_api.rb', line 505

def get_characters_character_id_notifications(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_notifications_with_http_info(character_id, opts)
  return 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)

  • :token (String)

    Access token to use if unable to set a header

  • :user_agent (String)

    Client identifier, takes precedence over headers

  • :x_user_agent (String)

    Client identifier, takes precedence over User-Agent

Returns:



573
574
575
576
# File 'lib/esi_client/api/character_api.rb', line 573

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

  • :token (String)

    Access token to use if unable to set a header

  • :user_agent (String)

    Client identifier, takes precedence over headers

  • :x_user_agent (String)

    Client identifier, takes precedence over User-Agent

Returns:



587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
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
# File 'lib/esi_client/api/character_api.rb', line 587

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 && 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?
  query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['evesso']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<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

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

  • :user_agent (String)

    Client identifier, takes precedence over headers

  • :x_user_agent (String)

    Client identifier, takes precedence over User-Agent

Returns:



519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
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
# File 'lib/esi_client/api/character_api.rb', line 519

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 && 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/".sub('{' + 'character_id' + '}', character_id.to_s)

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['evesso']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<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)

  • :user_agent (String)

    Client identifier, takes precedence over headers

  • :x_user_agent (String)

    Client identifier, takes precedence over User-Agent

Returns:



640
641
642
643
# File 'lib/esi_client/api/character_api.rb', line 640

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

#get_characters_character_id_portrait_with_http_info(character_id, opts = {}) ⇒ 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

  • :user_agent (String)

    Client identifier, takes precedence over headers

  • :x_user_agent (String)

    Client identifier, takes precedence over User-Agent

Returns:



653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
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
# File 'lib/esi_client/api/character_api.rb', line 653

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 && 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?
  query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil?

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

  # form parameters
  form_params = {}

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

#get_characters_character_id_roles(character_id, opts = {}) ⇒ Array<String>

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)

  • :token (String)

    Access token to use if unable to set a header

  • :user_agent (String)

    Client identifier, takes precedence over headers

  • :x_user_agent (String)

    Client identifier, takes precedence over User-Agent

Returns:

  • (Array<String>)


706
707
708
709
# File 'lib/esi_client/api/character_api.rb', line 706

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

#get_characters_character_id_roles_with_http_info(character_id, opts = {}) ⇒ Array<(Array<String>, 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

  • :token (String)

    Access token to use if unable to set a header

  • :user_agent (String)

    Client identifier, takes precedence over headers

  • :x_user_agent (String)

    Client identifier, takes precedence over User-Agent

Returns:

  • (Array<(Array<String>, Fixnum, Hash)>)

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



720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
# File 'lib/esi_client/api/character_api.rb', line 720

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 && 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}/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?
  query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil?

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

  # form parameters
  form_params = {}

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

#get_characters_character_id_standings(character_id, opts = {}) ⇒ 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)

  • :token (String)

    Access token to use if unable to set a header

  • :user_agent (String)

    Client identifier, takes precedence over headers

  • :x_user_agent (String)

    Client identifier, takes precedence over User-Agent

Returns:



774
775
776
777
# File 'lib/esi_client/api/character_api.rb', line 774

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

#get_characters_character_id_standings_with_http_info(character_id, opts = {}) ⇒ 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

  • :token (String)

    Access token to use if unable to set a header

  • :user_agent (String)

    Client identifier, takes precedence over headers

  • :x_user_agent (String)

    Client identifier, takes precedence over User-Agent

Returns:



788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
# File 'lib/esi_client/api/character_api.rb', line 788

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 && 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?
  query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil?

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

  # form parameters
  form_params = {}

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

#get_characters_character_id_with_http_info(character_id, opts = {}) ⇒ 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

  • :user_agent (String)

    Client identifier, takes precedence over headers

  • :x_user_agent (String)

    Client identifier, takes precedence over User-Agent

Returns:

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

    GetCharactersCharacterIdOk data, response status code and response headers



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

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 && 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?
  query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil?

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

  # form parameters
  form_params = {}

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

#get_characters_names(character_ids, opts = {}) ⇒ Array<GetCharactersNames200Ok>

Get character names Resolve a set of character IDs to character names — This route is cached for up to 3600 seconds

Parameters:

  • character_ids

    A comma separated list of character IDs

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

    the optional parameters

Options Hash (opts):

  • :datasource (String)

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

  • :user_agent (String)

    Client identifier, takes precedence over headers

  • :x_user_agent (String)

    Client identifier, takes precedence over User-Agent

Returns:



841
842
843
844
# File 'lib/esi_client/api/character_api.rb', line 841

def get_characters_names(character_ids, opts = {})
  data, _status_code, _headers = get_characters_names_with_http_info(character_ids, opts)
  return data
end

#get_characters_names_with_http_info(character_ids, opts = {}) ⇒ Array<(Array<GetCharactersNames200Ok>, Fixnum, Hash)>

Get character names Resolve a set of character IDs to character names — This route is cached for up to 3600 seconds

Parameters:

  • character_ids

    A comma separated list of character IDs

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

    the optional parameters

Options Hash (opts):

  • :datasource (String)

    The server name you would like data from

  • :user_agent (String)

    Client identifier, takes precedence over headers

  • :x_user_agent (String)

    Client identifier, takes precedence over User-Agent

Returns:

  • (Array<(Array<GetCharactersNames200Ok>, Fixnum, Hash)>)

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



854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
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
# File 'lib/esi_client/api/character_api.rb', line 854

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

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

  if @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/names/"

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

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

  # form parameters
  form_params = {}

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

#post_characters_affiliation(characters, opts = {}) ⇒ 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)

  • :user_agent (String)

    Client identifier, takes precedence over headers

  • :x_user_agent (String)

    Client identifier, takes precedence over User-Agent

Returns:



915
916
917
918
# File 'lib/esi_client/api/character_api.rb', line 915

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

#post_characters_affiliation_with_http_info(characters, opts = {}) ⇒ 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

  • :user_agent (String)

    Client identifier, takes precedence over headers

  • :x_user_agent (String)

    Client identifier, takes precedence over User-Agent

Returns:

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

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



928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
# File 'lib/esi_client/api/character_api.rb', line 928

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?
  query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil?

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

  # form parameters
  form_params = {}

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

#post_characters_character_id_cspa(character_id, characters, opts = {}) ⇒ PostCharactersCharacterIdCspaCreated

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

  • :user_agent (String)

    Client identifier, takes precedence over headers

  • :x_user_agent (String)

    Client identifier, takes precedence over User-Agent

Returns:



982
983
984
985
# File 'lib/esi_client/api/character_api.rb', line 982

def post_characters_character_id_cspa(character_id, characters, opts = {})
  data, _status_code, _headers = post_characters_character_id_cspa_with_http_info(character_id, characters, opts)
  return data
end

#post_characters_character_id_cspa_with_http_info(character_id, characters, opts = {}) ⇒ Array<(PostCharactersCharacterIdCspaCreated, 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

  • :user_agent (String)

    Client identifier, takes precedence over headers

  • :x_user_agent (String)

    Client identifier, takes precedence over User-Agent

Returns:



997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
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
# File 'lib/esi_client/api/character_api.rb', line 997

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
  # 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 = "/v3/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?
  query_params[:'user_agent'] = opts[:'user_agent'] if !opts[:'user_agent'].nil?

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

  # form parameters
  form_params = {}

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