Class: EsiClient::AllianceApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AllianceApi

Returns a new instance of AllianceApi.



18
19
20
 
# File 'lib/esi-ruby/api/alliance_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/alliance_api.rb', line 16

def api_client
  @api_client
end

Instance Method Details

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

List all alliances List all active player alliances — Alternate route: ‘/v1/alliances/` Alternate route: `/legacy/alliances/` Alternate route: `/dev/alliances/` — This route is cached for up to 3600 seconds

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


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

def get_alliances(opts = {})
  data, _status_code, _headers = get_alliances_with_http_info(opts)
  return data
end

#get_alliances_alliance_id(alliance_id, opts = {}) ⇒ GetAlliancesAllianceIdOk

Get alliance information Public information about an alliance — Alternate route: ‘/v2/alliances/alliance_id/` — This route is cached for up to 3600 seconds

Parameters:

  • alliance_id —

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



89
90
91
92
 
# File 'lib/esi-ruby/api/alliance_api.rb', line 89

def get_alliances_alliance_id(alliance_id, opts = {})
  data, _status_code, _headers = get_alliances_alliance_id_with_http_info(alliance_id, opts)
  return data
end

#get_alliances_alliance_id_corporations(alliance_id, opts = {}) ⇒ Array<Integer>

List alliance’s corporations List all current member corporations of an alliance — Alternate route: ‘/v1/alliances/alliance_id/corporations/` Alternate route: `/legacy/alliances/alliance_id/corporations/` Alternate route: `/dev/alliances/alliance_id/corporations/` — This route is cached for up to 3600 seconds

Parameters:

  • alliance_id —

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

  • (Array<Integer>) 


152
153
154
155
 
# File 'lib/esi-ruby/api/alliance_api.rb', line 152

def get_alliances_alliance_id_corporations(alliance_id, opts = {})
  data, _status_code, _headers = get_alliances_alliance_id_corporations_with_http_info(alliance_id, opts)
  return data
end

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

List alliance&#39;s corporations List all current member corporations of an alliance — Alternate route: &#x60;/v1/alliances/alliance_id/corporations/&#x60; Alternate route: &#x60;/legacy/alliances/alliance_id/corporations/&#x60; Alternate route: &#x60;/dev/alliances/alliance_id/corporations/&#x60; — This route is cached for up to 3600 seconds

Parameters:

  • alliance_id —

    An EVE alliance ID

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:

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

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



165
166
167
168
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
 
# File 'lib/esi-ruby/api/alliance_api.rb', line 165

def get_alliances_alliance_id_corporations_with_http_info(alliance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AllianceApi.get_alliances_alliance_id_corporations ..."
  end
  # verify the required parameter 'alliance_id' is set
  fail ArgumentError, "Missing the required parameter 'alliance_id' when calling AllianceApi.get_alliances_alliance_id_corporations" if alliance_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 = "/alliances/{alliance_id}/corporations/".sub('{format}','json').sub('{' + 'alliance_id' + '}', alliance_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<Integer>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AllianceApi#get_alliances_alliance_id_corporations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_alliances_alliance_id_icons(alliance_id, opts = {}) ⇒ GetAlliancesAllianceIdIconsOk

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

Parameters:

  • alliance_id —

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



215
216
217
218
 
# File 'lib/esi-ruby/api/alliance_api.rb', line 215

def get_alliances_alliance_id_icons(alliance_id, opts = {})
  data, _status_code, _headers = get_alliances_alliance_id_icons_with_http_info(alliance_id, opts)
  return data
end

#get_alliances_alliance_id_icons_with_http_info(alliance_id, opts = {}) ⇒ Array<(GetAlliancesAllianceIdIconsOk, Fixnum, Hash)>

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

Parameters:

  • alliance_id —

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



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
265
266
267
268
 
# File 'lib/esi-ruby/api/alliance_api.rb', line 228

def get_alliances_alliance_id_icons_with_http_info(alliance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AllianceApi.get_alliances_alliance_id_icons ..."
  end
  # verify the required parameter 'alliance_id' is set
  fail ArgumentError, "Missing the required parameter 'alliance_id' when calling AllianceApi.get_alliances_alliance_id_icons" if alliance_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 = "/alliances/{alliance_id}/icons/".sub('{format}','json').sub('{' + 'alliance_id' + '}', alliance_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 => 'GetAlliancesAllianceIdIconsOk')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AllianceApi#get_alliances_alliance_id_icons\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_alliances_alliance_id_with_http_info(alliance_id, opts = {}) ⇒ Array<(GetAlliancesAllianceIdOk, Fixnum, Hash)>

Get alliance information Public information about an alliance — Alternate route: &#x60;/v2/alliances/alliance_id/&#x60; — This route is cached for up to 3600 seconds

Parameters:

  • alliance_id —

    An EVE alliance ID

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:

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

    GetAlliancesAllianceIdOk data, response status code and response headers



102
103
104
105
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
 
# File 'lib/esi-ruby/api/alliance_api.rb', line 102

def get_alliances_alliance_id_with_http_info(alliance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AllianceApi.get_alliances_alliance_id ..."
  end
  # verify the required parameter 'alliance_id' is set
  fail ArgumentError, "Missing the required parameter 'alliance_id' when calling AllianceApi.get_alliances_alliance_id" if alliance_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 = "/alliances/{alliance_id}/".sub('{format}','json').sub('{' + 'alliance_id' + '}', alliance_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 => 'GetAlliancesAllianceIdOk')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AllianceApi#get_alliances_alliance_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_alliances_names(alliance_ids, opts = {}) ⇒ Array<GetAlliancesNames200Ok>

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

Parameters:

  • alliance_ids —

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



278
279
280
281
 
# File 'lib/esi-ruby/api/alliance_api.rb', line 278

def get_alliances_names(alliance_ids, opts = {})
  data, _status_code, _headers = get_alliances_names_with_http_info(alliance_ids, opts)
  return data
end

#get_alliances_names_with_http_info(alliance_ids, opts = {}) ⇒ Array<(Array<GetAlliancesNames200Ok>, Fixnum, Hash)>

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

Parameters:

  • alliance_ids —

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

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



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

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

  if alliance_ids.length < 1
    fail ArgumentError, 'invalid value for "alliance_ids" when calling AllianceApi.get_alliances_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 = "/alliances/names/".sub('{format}','json')

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

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

List all alliances List all active player alliances — Alternate route: &#x60;/v1/alliances/&#x60; Alternate route: &#x60;/legacy/alliances/&#x60; Alternate route: &#x60;/dev/alliances/&#x60; — This route is cached for up to 3600 seconds

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



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

def get_alliances_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AllianceApi.get_alliances ..."
  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 = "/alliances/".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: AllianceApi#get_alliances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end