Class: EsiClient::CorporationApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CorporationApi

Returns a new instance of CorporationApi.



18
19
20
 
# File 'lib/esi-ruby/api/corporation_api.rb', line 18

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



16
17
18
 
# File 'lib/esi-ruby/api/corporation_api.rb', line 16

def api_client
  @api_client
end

Instance Method Details

#get_corporations_corporation_id(corporation_id, opts = {}) ⇒ GetCorporationsCorporationIdOk

Get corporation information Public information about a corporation — Alternate route: ‘/v3/corporations/corporation_id/` Alternate route: `/dev/corporations/corporation_id/` — This route is cached for up to 3600 seconds

Parameters:

  • corporation_id —

    An EVE corporation 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:



30
31
32
33
 
# File 'lib/esi-ruby/api/corporation_api.rb', line 30

def get_corporations_corporation_id(corporation_id, opts = {})
  data, _status_code, _headers = get_corporations_corporation_id_with_http_info(corporation_id, opts)
  return data
end

#get_corporations_corporation_id_alliancehistory(corporation_id, opts = {}) ⇒ Array<GetCorporationsCorporationIdAlliancehistory200Ok>

Get alliance history Get a list of all the alliances a corporation has been a member of — Alternate route: ‘/v1/corporations/corporation_id/alliancehistory/` Alternate route: `/legacy/corporations/corporation_id/alliancehistory/` — This route is cached for up to 3600 seconds

Parameters:

  • corporation_id —

    An EVE corporation 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:



93
94
95
96
 
# File 'lib/esi-ruby/api/corporation_api.rb', line 93

def get_corporations_corporation_id_alliancehistory(corporation_id, opts = {})
  data, _status_code, _headers = get_corporations_corporation_id_alliancehistory_with_http_info(corporation_id, opts)
  return data
end

#get_corporations_corporation_id_alliancehistory_with_http_info(corporation_id, opts = {}) ⇒ Array<(Array<GetCorporationsCorporationIdAlliancehistory200Ok>, Fixnum, Hash)>

Get alliance history Get a list of all the alliances a corporation has been a member of — Alternate route: &#x60;/v1/corporations/corporation_id/alliancehistory/&#x60; Alternate route: &#x60;/legacy/corporations/corporation_id/alliancehistory/&#x60; — This route is cached for up to 3600 seconds

Parameters:

  • corporation_id —

    An EVE corporation 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:



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/esi-ruby/api/corporation_api.rb', line 106

def get_corporations_corporation_id_alliancehistory_with_http_info(corporation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CorporationApi.get_corporations_corporation_id_alliancehistory ..."
  end
  # verify the required parameter 'corporation_id' is set
  fail ArgumentError, "Missing the required parameter 'corporation_id' when calling CorporationApi.get_corporations_corporation_id_alliancehistory" if corporation_id.nil?
  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/corporations/{corporation_id}/alliancehistory/".sub('{format}','json').sub('{' + 'corporation_id' + '}', corporation_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<GetCorporationsCorporationIdAlliancehistory200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CorporationApi#get_corporations_corporation_id_alliancehistory\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_corporations_corporation_id_icons(corporation_id, opts = {}) ⇒ GetCorporationsCorporationIdIconsOk

Get corporation icon Get the icon urls for a corporation — Alternate route: ‘/v1/corporations/corporation_id/icons/` Alternate route: `/legacy/corporations/corporation_id/icons/` Alternate route: `/dev/corporations/corporation_id/icons/` — This route is cached for up to 3600 seconds

Parameters:

  • corporation_id —

    An EVE corporation 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:



156
157
158
159
 
# File 'lib/esi-ruby/api/corporation_api.rb', line 156

def get_corporations_corporation_id_icons(corporation_id, opts = {})
  data, _status_code, _headers = get_corporations_corporation_id_icons_with_http_info(corporation_id, opts)
  return data
end

#get_corporations_corporation_id_icons_with_http_info(corporation_id, opts = {}) ⇒ Array<(GetCorporationsCorporationIdIconsOk, Fixnum, Hash)>

Get corporation icon Get the icon urls for a corporation — Alternate route: &#x60;/v1/corporations/corporation_id/icons/&#x60; Alternate route: &#x60;/legacy/corporations/corporation_id/icons/&#x60; Alternate route: &#x60;/dev/corporations/corporation_id/icons/&#x60; — This route is cached for up to 3600 seconds

Parameters:

  • corporation_id —

    An EVE corporation 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:



169
170
171
172
173
174
175
176
177
178
179
180
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
 
# File 'lib/esi-ruby/api/corporation_api.rb', line 169

def get_corporations_corporation_id_icons_with_http_info(corporation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CorporationApi.get_corporations_corporation_id_icons ..."
  end
  # verify the required parameter 'corporation_id' is set
  fail ArgumentError, "Missing the required parameter 'corporation_id' when calling CorporationApi.get_corporations_corporation_id_icons" if corporation_id.nil?
  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/corporations/{corporation_id}/icons/".sub('{format}','json').sub('{' + 'corporation_id' + '}', corporation_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 => 'GetCorporationsCorporationIdIconsOk')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CorporationApi#get_corporations_corporation_id_icons\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_corporations_corporation_id_members(corporation_id, opts = {}) ⇒ Array<GetCorporationsCorporationIdMembers200Ok>

Get corporation members Read the current list of members if the calling character is a member. — Alternate route: ‘/v2/corporations/corporation_id/members/` Alternate route: `/legacy/corporations/corporation_id/members/` — This route is cached for up to 3600 seconds

Parameters:

  • corporation_id —

    An EVE corporation 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:



220
221
222
223
 
# File 'lib/esi-ruby/api/corporation_api.rb', line 220

def get_corporations_corporation_id_members(corporation_id, opts = {})
  data, _status_code, _headers = get_corporations_corporation_id_members_with_http_info(corporation_id, opts)
  return data
end

#get_corporations_corporation_id_members_with_http_info(corporation_id, opts = {}) ⇒ Array<(Array<GetCorporationsCorporationIdMembers200Ok>, Fixnum, Hash)>

Get corporation members Read the current list of members if the calling character is a member. — Alternate route: &#x60;/v2/corporations/corporation_id/members/&#x60; Alternate route: &#x60;/legacy/corporations/corporation_id/members/&#x60; — This route is cached for up to 3600 seconds

Parameters:

  • corporation_id —

    An EVE corporation 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:



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
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/esi-ruby/api/corporation_api.rb', line 234

def get_corporations_corporation_id_members_with_http_info(corporation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CorporationApi.get_corporations_corporation_id_members ..."
  end
  # verify the required parameter 'corporation_id' is set
  fail ArgumentError, "Missing the required parameter 'corporation_id' when calling CorporationApi.get_corporations_corporation_id_members" if corporation_id.nil?
  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/corporations/{corporation_id}/members/".sub('{format}','json').sub('{' + 'corporation_id' + '}', corporation_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<GetCorporationsCorporationIdMembers200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CorporationApi#get_corporations_corporation_id_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_corporations_corporation_id_roles(corporation_id, opts = {}) ⇒ Array<GetCorporationsCorporationIdRoles200Ok>

Get corporation member roles Return the roles of all members if the character has the personnel manager role or any grantable role. — Alternate route: ‘/v1/corporations/corporation_id/roles/` Alternate route: `/legacy/corporations/corporation_id/roles/` Alternate route: `/dev/corporations/corporation_id/roles/` — This route is cached for up to 3600 seconds

Parameters:

  • corporation_id —

    An EVE corporation 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:



286
287
288
289
 
# File 'lib/esi-ruby/api/corporation_api.rb', line 286

def get_corporations_corporation_id_roles(corporation_id, opts = {})
  data, _status_code, _headers = get_corporations_corporation_id_roles_with_http_info(corporation_id, opts)
  return data
end

#get_corporations_corporation_id_roles_with_http_info(corporation_id, opts = {}) ⇒ Array<(Array<GetCorporationsCorporationIdRoles200Ok>, Fixnum, Hash)>

Get corporation member roles Return the roles of all members if the character has the personnel manager role or any grantable role. — Alternate route: &#x60;/v1/corporations/corporation_id/roles/&#x60; Alternate route: &#x60;/legacy/corporations/corporation_id/roles/&#x60; Alternate route: &#x60;/dev/corporations/corporation_id/roles/&#x60; — This route is cached for up to 3600 seconds

Parameters:

  • corporation_id —

    An EVE corporation 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:



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/esi-ruby/api/corporation_api.rb', line 300

def get_corporations_corporation_id_roles_with_http_info(corporation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CorporationApi.get_corporations_corporation_id_roles ..."
  end
  # verify the required parameter 'corporation_id' is set
  fail ArgumentError, "Missing the required parameter 'corporation_id' when calling CorporationApi.get_corporations_corporation_id_roles" if corporation_id.nil?
  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/corporations/{corporation_id}/roles/".sub('{format}','json').sub('{' + 'corporation_id' + '}', corporation_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<GetCorporationsCorporationIdRoles200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CorporationApi#get_corporations_corporation_id_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_corporations_corporation_id_structures(corporation_id, opts = {}) ⇒ Array<GetCorporationsCorporationIdStructures200Ok>

Get corporation structures Get a list of corporation structures — Alternate route: ‘/v1/corporations/corporation_id/structures/` Alternate route: `/legacy/corporations/corporation_id/structures/` Alternate route: `/dev/corporations/corporation_id/structures/` — This route is cached for up to 3600 seconds

Parameters:

  • corporation_id —

    An EVE corporation ID

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

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

  • :language (String) —

    Language to use in the response (default to en-us)

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



354
355
356
357
 
# File 'lib/esi-ruby/api/corporation_api.rb', line 354

def get_corporations_corporation_id_structures(corporation_id, opts = {})
  data, _status_code, _headers = get_corporations_corporation_id_structures_with_http_info(corporation_id, opts)
  return data
end

#get_corporations_corporation_id_structures_with_http_info(corporation_id, opts = {}) ⇒ Array<(Array<GetCorporationsCorporationIdStructures200Ok>, Fixnum, Hash)>

Get corporation structures Get a list of corporation structures — Alternate route: &#x60;/v1/corporations/corporation_id/structures/&#x60; Alternate route: &#x60;/legacy/corporations/corporation_id/structures/&#x60; Alternate route: &#x60;/dev/corporations/corporation_id/structures/&#x60; — This route is cached for up to 3600 seconds

Parameters:

  • corporation_id —

    An EVE corporation ID

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :language (String) —

    Language to use in the response

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



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

def get_corporations_corporation_id_structures_with_http_info(corporation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CorporationApi.get_corporations_corporation_id_structures ..."
  end
  # verify the required parameter 'corporation_id' is set
  fail ArgumentError, "Missing the required parameter 'corporation_id' when calling CorporationApi.get_corporations_corporation_id_structures" if corporation_id.nil?
  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  if opts[:'language'] && !['de', 'en-us', 'fr', 'ja', 'ru', 'zh'].include?(opts[:'language'])
    fail ArgumentError, 'invalid value for "language", must be one of de, en-us, fr, ja, ru, zh'
  end
  # resource path
  local_var_path = "/corporations/{corporation_id}/structures/".sub('{format}','json').sub('{' + 'corporation_id' + '}', corporation_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'language'] = opts[:'language'] if !opts[:'language'].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<GetCorporationsCorporationIdStructures200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CorporationApi#get_corporations_corporation_id_structures\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_corporations_corporation_id_with_http_info(corporation_id, opts = {}) ⇒ Array<(GetCorporationsCorporationIdOk, Fixnum, Hash)>

Get corporation information Public information about a corporation — Alternate route: &#x60;/v3/corporations/corporation_id/&#x60; Alternate route: &#x60;/dev/corporations/corporation_id/&#x60; — This route is cached for up to 3600 seconds

Parameters:

  • corporation_id —

    An EVE corporation 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:



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

def get_corporations_corporation_id_with_http_info(corporation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CorporationApi.get_corporations_corporation_id ..."
  end
  # verify the required parameter 'corporation_id' is set
  fail ArgumentError, "Missing the required parameter 'corporation_id' when calling CorporationApi.get_corporations_corporation_id" if corporation_id.nil?
  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/corporations/{corporation_id}/".sub('{format}','json').sub('{' + 'corporation_id' + '}', corporation_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 => 'GetCorporationsCorporationIdOk')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CorporationApi#get_corporations_corporation_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_corporations_names(corporation_ids, opts = {}) ⇒ Array<GetCorporationsNames200Ok>

Get corporation names Resolve a set of corporation IDs to corporation names — Alternate route: ‘/v1/corporations/names/` Alternate route: `/legacy/corporations/names/` — This route is cached for up to 3600 seconds

Parameters:

  • corporation_ids —

    A comma separated list of corporation 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:



426
427
428
429
 
# File 'lib/esi-ruby/api/corporation_api.rb', line 426

def get_corporations_names(corporation_ids, opts = {})
  data, _status_code, _headers = get_corporations_names_with_http_info(corporation_ids, opts)
  return data
end

#get_corporations_names_with_http_info(corporation_ids, opts = {}) ⇒ Array<(Array<GetCorporationsNames200Ok>, Fixnum, Hash)>

Get corporation names Resolve a set of corporation IDs to corporation names — Alternate route: &#x60;/v1/corporations/names/&#x60; Alternate route: &#x60;/legacy/corporations/names/&#x60; — This route is cached for up to 3600 seconds

Parameters:

  • corporation_ids —

    A comma separated list of corporation 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<GetCorporationsNames200Ok>, Fixnum, Hash)>) —

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



439
440
441
442
443
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
 
# File 'lib/esi-ruby/api/corporation_api.rb', line 439

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

  if corporation_ids.length < 1
    fail ArgumentError, 'invalid value for "corporation_ids" when calling CorporationApi.get_corporations_names, number of items must be greater than or equal to 1.'
  end

  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/corporations/names/".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'corporation_ids'] = @api_client.build_collection_param(corporation_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<GetCorporationsNames200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CorporationApi#get_corporations_names\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_corporations_npccorps(opts = {}) ⇒ Array<Integer>

Get npc corporations Get a list of npc corporations — Alternate route: ‘/v1/corporations/npccorps/` Alternate route: `/legacy/corporations/npccorps/` Alternate route: `/dev/corporations/npccorps/` — This route expires daily at 11:05

Parameters:

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

  • (Array<Integer>) 


497
498
499
500
 
# File 'lib/esi-ruby/api/corporation_api.rb', line 497

def get_corporations_npccorps(opts = {})
  data, _status_code, _headers = get_corporations_npccorps_with_http_info(opts)
  return data
end

#get_corporations_npccorps_with_http_info(opts = {}) ⇒ Array<(Array<Integer>, Fixnum, Hash)>

Get npc corporations Get a list of npc corporations — Alternate route: &#x60;/v1/corporations/npccorps/&#x60; Alternate route: &#x60;/legacy/corporations/npccorps/&#x60; Alternate route: &#x60;/dev/corporations/npccorps/&#x60; — This route expires daily at 11:05

Parameters:

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

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



509
510
511
512
513
514
515
516
517
518
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
 
# File 'lib/esi-ruby/api/corporation_api.rb', line 509

def get_corporations_npccorps_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CorporationApi.get_corporations_npccorps ..."
  end
  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/corporations/npccorps/".sub('{format}','json')

  # 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<Integer>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CorporationApi#get_corporations_npccorps\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_corporations_corporation_id_structures_structure_id(corporation_id, new_schedule, structure_id, opts = {}) ⇒ nil

Update structure vulnerability schedule Update the vulnerability window schedule of a corporation structure — Alternate route: ‘/v1/corporations/corporation_id/structures/structure_id/` Alternate route: `/legacy/corporations/corporation_id/structures/structure_id/` Alternate route: `/dev/corporations/corporation_id/structures/structure_id/`

Parameters:

  • corporation_id —

    An EVE corporation ID

  • new_schedule —

    New vulnerability window schedule for the structure

  • structure_id —

    A structure 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:

  • (nil) 


560
561
562
563
 
# File 'lib/esi-ruby/api/corporation_api.rb', line 560

def put_corporations_corporation_id_structures_structure_id(corporation_id, new_schedule, structure_id, opts = {})
  put_corporations_corporation_id_structures_structure_id_with_http_info(corporation_id, new_schedule, structure_id, opts)
  return nil
end

#put_corporations_corporation_id_structures_structure_id_with_http_info(corporation_id, new_schedule, structure_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update structure vulnerability schedule Update the vulnerability window schedule of a corporation structure — Alternate route: &#x60;/v1/corporations/corporation_id/structures/structure_id/&#x60; Alternate route: &#x60;/legacy/corporations/corporation_id/structures/structure_id/&#x60; Alternate route: &#x60;/dev/corporations/corporation_id/structures/structure_id/&#x60;

Parameters:

  • corporation_id —

    An EVE corporation ID

  • new_schedule —

    New vulnerability window schedule for the structure

  • structure_id —

    A structure 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<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



576
577
578
579
580
581
582
583
584
585
586
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
 
# File 'lib/esi-ruby/api/corporation_api.rb', line 576

def put_corporations_corporation_id_structures_structure_id_with_http_info(corporation_id, new_schedule, structure_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CorporationApi.put_corporations_corporation_id_structures_structure_id ..."
  end
  # verify the required parameter 'corporation_id' is set
  fail ArgumentError, "Missing the required parameter 'corporation_id' when calling CorporationApi.put_corporations_corporation_id_structures_structure_id" if corporation_id.nil?
  # verify the required parameter 'new_schedule' is set
  fail ArgumentError, "Missing the required parameter 'new_schedule' when calling CorporationApi.put_corporations_corporation_id_structures_structure_id" if new_schedule.nil?
  # verify the required parameter 'structure_id' is set
  fail ArgumentError, "Missing the required parameter 'structure_id' when calling CorporationApi.put_corporations_corporation_id_structures_structure_id" if structure_id.nil?
  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/corporations/{corporation_id}/structures/{structure_id}/".sub('{format}','json').sub('{' + 'corporation_id' + '}', corporation_id.to_s).sub('{' + 'structure_id' + '}', structure_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(new_schedule)
  auth_names = ['evesso']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CorporationApi#put_corporations_corporation_id_structures_structure_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end