Class: ESI::CharacterApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby-esi/api/character_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CharacterApi 



19
20
21
 
# File 'lib/ruby-esi/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/ruby-esi/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 — Alternate route: ‘/dev/characters/character_id/` Alternate route: `/legacy/characters/character_id/` Alternate route: `/v5/characters/character_id/` — This route is cached for up to 604800 seconds

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



29
30
31
32
 
# File 'lib/ruby-esi/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) — Alternate route: ‘/dev/characters/character_id/agents_research/` Alternate route: `/legacy/characters/character_id/agents_research/` Alternate route: `/v1/characters/character_id/agents_research/` Alternate route: `/v2/characters/character_id/agents_research/` — This route is cached for up to 3600 seconds

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



107
108
109
110
 
# File 'lib/ruby-esi/api/character_api.rb', line 107

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>, Integer, 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) — Alternate route: &#x60;/dev/characters/character_id/agents_research/&#x60; Alternate route: &#x60;/legacy/characters/character_id/agents_research/&#x60; Alternate route: &#x60;/v1/characters/character_id/agents_research/&#x60; Alternate route: &#x60;/v2/characters/character_id/agents_research/&#x60; — This route is cached for up to 3600 seconds

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



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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/ruby-esi/api/character_api.rb', line 120

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

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

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<GetCharactersCharacterIdAgentsResearch200Ok>'

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

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

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: 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 — Alternate route: ‘/dev/characters/character_id/blueprints/` Alternate route: `/legacy/characters/character_id/blueprints/` Alternate route: `/v2/characters/character_id/blueprints/` Alternate route: `/v3/characters/character_id/blueprints/` — This route is cached for up to 3600 seconds

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



188
189
190
191
 
# File 'lib/ruby-esi/api/character_api.rb', line 188

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>, Integer, Hash)>

Get blueprints Return a list of blueprints the character owns — Alternate route: &#x60;/dev/characters/character_id/blueprints/&#x60; Alternate route: &#x60;/legacy/characters/character_id/blueprints/&#x60; Alternate route: &#x60;/v2/characters/character_id/blueprints/&#x60; Alternate route: &#x60;/v3/characters/character_id/blueprints/&#x60; — This route is cached for up to 3600 seconds

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



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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/ruby-esi/api/character_api.rb', line 202

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

  allowable_values = ["tranquility"]
  if @api_client.config.client_side_validation && opts[:'datasource'] && !allowable_values.include?(opts[:'datasource'])
    fail ArgumentError, "invalid value for \"datasource\", must be one of #{allowable_values}"
  end
  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 = '/characters/{character_id}/blueprints/'.sub('{' + 'character_id' + '}', CGI.escape(character_id.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<GetCharactersCharacterIdBlueprints200Ok>'

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

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

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: 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 — Alternate route: ‘/dev/characters/character_id/corporationhistory/` Alternate route: `/legacy/characters/character_id/corporationhistory/` Alternate route: `/v1/characters/character_id/corporationhistory/` Alternate route: `/v2/characters/character_id/corporationhistory/` — This route is cached for up to 86400 seconds

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



273
274
275
276
 
# File 'lib/ruby-esi/api/character_api.rb', line 273

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>, Integer, Hash)>

Get corporation history Get a list of all the corporations a character has been a member of — Alternate route: &#x60;/dev/characters/character_id/corporationhistory/&#x60; Alternate route: &#x60;/legacy/characters/character_id/corporationhistory/&#x60; Alternate route: &#x60;/v1/characters/character_id/corporationhistory/&#x60; Alternate route: &#x60;/v2/characters/character_id/corporationhistory/&#x60; — This route is cached for up to 86400 seconds

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



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
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
 
# File 'lib/ruby-esi/api/character_api.rb', line 285

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

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

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<GetCharactersCharacterIdCorporationhistory200Ok>'

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

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

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: 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 — Alternate route: ‘/dev/characters/character_id/fatigue/` Alternate route: `/legacy/characters/character_id/fatigue/` Alternate route: `/v1/characters/character_id/fatigue/` Alternate route: `/v2/characters/character_id/fatigue/` — This route is cached for up to 300 seconds

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



351
352
353
354
 
# File 'lib/ruby-esi/api/character_api.rb', line 351

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, Integer, Hash)>

Get jump fatigue Return a character&#39;s jump activation and fatigue information — Alternate route: &#x60;/dev/characters/character_id/fatigue/&#x60; Alternate route: &#x60;/legacy/characters/character_id/fatigue/&#x60; Alternate route: &#x60;/v1/characters/character_id/fatigue/&#x60; Alternate route: &#x60;/v2/characters/character_id/fatigue/&#x60; — This route is cached for up to 300 seconds

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



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
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
 
# File 'lib/ruby-esi/api/character_api.rb', line 364

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

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

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

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

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

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

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

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

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

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: 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 — Alternate route: ‘/dev/characters/character_id/medals/` Alternate route: `/legacy/characters/character_id/medals/` Alternate route: `/v1/characters/character_id/medals/` Alternate route: `/v2/characters/character_id/medals/` — This route is cached for up to 3600 seconds

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



431
432
433
434
 
# File 'lib/ruby-esi/api/character_api.rb', line 431

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>, Integer, Hash)>

Get medals Return a list of medals the character has — Alternate route: &#x60;/dev/characters/character_id/medals/&#x60; Alternate route: &#x60;/legacy/characters/character_id/medals/&#x60; Alternate route: &#x60;/v1/characters/character_id/medals/&#x60; Alternate route: &#x60;/v2/characters/character_id/medals/&#x60; — This route is cached for up to 3600 seconds

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



444
445
446
447
448
449
450
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
495
496
497
498
499
500
501
 
# File 'lib/ruby-esi/api/character_api.rb', line 444

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

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

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<GetCharactersCharacterIdMedals200Ok>'

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

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

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: 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 — Alternate route: ‘/dev/characters/character_id/notifications/` Alternate route: `/legacy/characters/character_id/notifications/` Alternate route: `/v4/characters/character_id/notifications/` Alternate route: `/v5/characters/character_id/notifications/` Alternate route: `/v6/characters/character_id/notifications/` — This route is cached for up to 600 seconds

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



511
512
513
514
 
# File 'lib/ruby-esi/api/character_api.rb', line 511

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 — Alternate route: ‘/dev/characters/character_id/notifications/contacts/` Alternate route: `/legacy/characters/character_id/notifications/contacts/` Alternate route: `/v1/characters/character_id/notifications/contacts/` Alternate route: `/v2/characters/character_id/notifications/contacts/` — This route is cached for up to 600 seconds

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



591
592
593
594
 
# File 'lib/ruby-esi/api/character_api.rb', line 591

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>, Integer, Hash)>

Get new contact notifications Return notifications about having been added to someone&#39;s contact list — Alternate route: &#x60;/dev/characters/character_id/notifications/contacts/&#x60; Alternate route: &#x60;/legacy/characters/character_id/notifications/contacts/&#x60; Alternate route: &#x60;/v1/characters/character_id/notifications/contacts/&#x60; Alternate route: &#x60;/v2/characters/character_id/notifications/contacts/&#x60; — This route is cached for up to 600 seconds

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



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
650
651
652
653
654
655
656
657
658
659
660
661
 
# File 'lib/ruby-esi/api/character_api.rb', line 604

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

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

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<GetCharactersCharacterIdNotificationsContacts200Ok>'

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

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

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: 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>, Integer, Hash)>

Get character notifications Return character notifications — Alternate route: &#x60;/dev/characters/character_id/notifications/&#x60; Alternate route: &#x60;/legacy/characters/character_id/notifications/&#x60; Alternate route: &#x60;/v4/characters/character_id/notifications/&#x60; Alternate route: &#x60;/v5/characters/character_id/notifications/&#x60; Alternate route: &#x60;/v6/characters/character_id/notifications/&#x60; — This route is cached for up to 600 seconds

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



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
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'lib/ruby-esi/api/character_api.rb', line 524

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

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

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<GetCharactersCharacterIdNotifications200Ok>'

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

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

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: 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 — Alternate route: ‘/dev/characters/character_id/portrait/` Alternate route: `/v2/characters/character_id/portrait/` Alternate route: `/v3/characters/character_id/portrait/` — This route expires daily at 11:05

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



670
671
672
673
 
# File 'lib/ruby-esi/api/character_api.rb', line 670

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, Integer, Hash)>

Get character portraits Get portrait urls for a character — Alternate route: &#x60;/dev/characters/character_id/portrait/&#x60; Alternate route: &#x60;/v2/characters/character_id/portrait/&#x60; Alternate route: &#x60;/v3/characters/character_id/portrait/&#x60; — This route expires daily at 11:05

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



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
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
 
# File 'lib/ruby-esi/api/character_api.rb', line 682

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

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

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

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

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

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

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

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

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

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: 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 — Alternate route: ‘/dev/characters/character_id/roles/` Alternate route: `/legacy/characters/character_id/roles/` Alternate route: `/v2/characters/character_id/roles/` Alternate route: `/v3/characters/character_id/roles/` — This route is cached for up to 3600 seconds

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



748
749
750
751
 
# File 'lib/ruby-esi/api/character_api.rb', line 748

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, Integer, Hash)>

Get character corporation roles Returns a character&#39;s corporation roles — Alternate route: &#x60;/dev/characters/character_id/roles/&#x60; Alternate route: &#x60;/legacy/characters/character_id/roles/&#x60; Alternate route: &#x60;/v2/characters/character_id/roles/&#x60; Alternate route: &#x60;/v3/characters/character_id/roles/&#x60; — This route is cached for up to 3600 seconds

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



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
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
 
# File 'lib/ruby-esi/api/character_api.rb', line 761

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

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

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

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

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

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

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

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

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

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: 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 — Alternate route: ‘/dev/characters/character_id/standings/` Alternate route: `/legacy/characters/character_id/standings/` Alternate route: `/v1/characters/character_id/standings/` Alternate route: `/v2/characters/character_id/standings/` — This route is cached for up to 3600 seconds

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



828
829
830
831
 
# File 'lib/ruby-esi/api/character_api.rb', line 828

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>, Integer, Hash)>

Get standings Return character standings from agents, NPC corporations, and factions — Alternate route: &#x60;/dev/characters/character_id/standings/&#x60; Alternate route: &#x60;/legacy/characters/character_id/standings/&#x60; Alternate route: &#x60;/v1/characters/character_id/standings/&#x60; Alternate route: &#x60;/v2/characters/character_id/standings/&#x60; — This route is cached for up to 3600 seconds

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



841
842
843
844
845
846
847
848
849
850
851
852
853
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
 
# File 'lib/ruby-esi/api/character_api.rb', line 841

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

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

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<GetCharactersCharacterIdStandings200Ok>'

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

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

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: 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_titles(character_id, opts = {}) ⇒ Array<GetCharactersCharacterIdTitles200Ok>

Get character corporation titles Returns a character’s titles — Alternate route: ‘/dev/characters/character_id/titles/` Alternate route: `/legacy/characters/character_id/titles/` Alternate route: `/v1/characters/character_id/titles/` Alternate route: `/v2/characters/character_id/titles/` — This route is cached for up to 3600 seconds

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



908
909
910
911
 
# File 'lib/ruby-esi/api/character_api.rb', line 908

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>, Integer, Hash)>

Get character corporation titles Returns a character&#39;s titles — Alternate route: &#x60;/dev/characters/character_id/titles/&#x60; Alternate route: &#x60;/legacy/characters/character_id/titles/&#x60; Alternate route: &#x60;/v1/characters/character_id/titles/&#x60; Alternate route: &#x60;/v2/characters/character_id/titles/&#x60; — This route is cached for up to 3600 seconds

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



921
922
923
924
925
926
927
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
971
972
973
974
975
976
977
978
 
# File 'lib/ruby-esi/api/character_api.rb', line 921

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

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

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<GetCharactersCharacterIdTitles200Ok>'

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

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

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: 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, Integer, Hash)>

Get character&#39;s public information Public information about a character — Alternate route: &#x60;/dev/characters/character_id/&#x60; Alternate route: &#x60;/legacy/characters/character_id/&#x60; Alternate route: &#x60;/v5/characters/character_id/&#x60; — This route is cached for up to 604800 seconds

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



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
89
90
91
92
93
94
95
96
97
 
# File 'lib/ruby-esi/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

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

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

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

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

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

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

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

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

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: 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 — Alternate route: /dev/characters/affiliation/ Alternate route: /legacy/characters/affiliation/ Alternate route: /v1/characters/affiliation/ Alternate route: /v2/characters/affiliation/ — This route is cached for up to 3600 seconds

Options Hash (opts):

  • :datasource (String) —

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



986
987
988
989
 
# File 'lib/ruby-esi/api/character_api.rb', line 986

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>, Integer, Hash)>

Character affiliation Bulk lookup of character IDs to corporation, alliance and faction — Alternate route: &#x60;/dev/characters/affiliation/&#x60; Alternate route: &#x60;/legacy/characters/affiliation/&#x60; Alternate route: &#x60;/v1/characters/affiliation/&#x60; Alternate route: &#x60;/v2/characters/affiliation/&#x60; — This route is cached for up to 3600 seconds

Options Hash (opts):

  • :datasource (String) —

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



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
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
 
# File 'lib/ruby-esi/api/character_api.rb', line 997

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 && characters.length > 1000
    fail ArgumentError, 'invalid value for "characters" when calling CharacterApi.post_characters_affiliation, number of items must be less than or equal to 1000.'
  end

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

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

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(characters)

  # return_type
  return_type = opts[:debug_return_type] || 'Array<PostCharactersAffiliation200Ok>'

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

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

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  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 — Alternate route: ‘/dev/characters/character_id/cspa/` Alternate route: `/legacy/characters/character_id/cspa/` Alternate route: `/v4/characters/character_id/cspa/` Alternate route: `/v5/characters/character_id/cspa/`

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



1071
1072
1073
1074
 
# File 'lib/ruby-esi/api/character_api.rb', line 1071

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, Integer, 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 — Alternate route: &#x60;/dev/characters/character_id/cspa/&#x60; Alternate route: &#x60;/legacy/characters/character_id/cspa/&#x60; Alternate route: &#x60;/v4/characters/character_id/cspa/&#x60; Alternate route: &#x60;/v5/characters/character_id/cspa/&#x60;

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



1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
 
# File 'lib/ruby-esi/api/character_api.rb', line 1084

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 && characters.length > 100
    fail ArgumentError, 'invalid value for "characters" when calling CharacterApi.post_characters_character_id_cspa, number of items must be less than or equal to 100.'
  end

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

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

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(characters)

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

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

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

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