Class: ESI::WarsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WarsApi

Returns a new instance of WarsApi.



19
20
21
 
# File 'lib/ruby-esi/api/wars_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/wars_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

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

List wars Return a list of wars — Alternate route: /dev/wars/ Alternate route: /legacy/wars/ Alternate route: /v1/wars/ — 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’)

  • :if_none_match (String) —

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

  • :max_war_id (Integer) —

    Only return wars with ID smaller than this

Returns:

  • (Array<Integer>) 


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

def get_wars(opts = {})
  data, _status_code, _headers = get_wars_with_http_info(opts)
  data
end

#get_wars_war_id(war_id, opts = {}) ⇒ GetWarsWarIdOk

Get war information Return details about a war — Alternate route: ‘/dev/wars/war_id/` Alternate route: `/legacy/wars/war_id/` Alternate route: `/v1/wars/war_id/` — This route is cached for up to 3600 seconds

Parameters:

  • war_id (Integer) —

    ID for a war

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

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

  • :if_none_match (String) —

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

Returns:



99
100
101
102
 
# File 'lib/ruby-esi/api/wars_api.rb', line 99

def get_wars_war_id(war_id, opts = {})
  data, _status_code, _headers = get_wars_war_id_with_http_info(war_id, opts)
  data
end

#get_wars_war_id_killmails(war_id, opts = {}) ⇒ Array<GetWarsWarIdKillmails200Ok>

List kills for a war Return a list of kills related to a war — Alternate route: ‘/dev/wars/war_id/killmails/` Alternate route: `/legacy/wars/war_id/killmails/` Alternate route: `/v1/wars/war_id/killmails/` — This route is cached for up to 3600 seconds

Parameters:

  • war_id (Integer) —

    A valid war ID

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

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

  • :if_none_match (String) —

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

  • :page (Integer) —

    Which page of results to return (default to 1)

Returns:



177
178
179
180
 
# File 'lib/ruby-esi/api/wars_api.rb', line 177

def get_wars_war_id_killmails(war_id, opts = {})
  data, _status_code, _headers = get_wars_war_id_killmails_with_http_info(war_id, opts)
  data
end

#get_wars_war_id_killmails_with_http_info(war_id, opts = {}) ⇒ Array<(Array<GetWarsWarIdKillmails200Ok>, Integer, Hash)>

List kills for a war Return a list of kills related to a war — Alternate route: &#x60;/dev/wars/war_id/killmails/&#x60; Alternate route: &#x60;/legacy/wars/war_id/killmails/&#x60; Alternate route: &#x60;/v1/wars/war_id/killmails/&#x60; — This route is cached for up to 3600 seconds

Parameters:

  • war_id (Integer) —

    A valid war ID

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

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

  • :if_none_match (String) —

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

  • :page (Integer) —

    Which page of results to return (default to 1)

Returns:

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

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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/ruby-esi/api/wars_api.rb', line 190

def get_wars_war_id_killmails_with_http_info(war_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WarsApi.get_wars_war_id_killmails ...'
  end
  # verify the required parameter 'war_id' is set
  if @api_client.config.client_side_validation && war_id.nil?
    fail ArgumentError, "Missing the required parameter 'war_id' when calling WarsApi.get_wars_war_id_killmails"
  end
  if @api_client.config.client_side_validation && war_id < 1
    fail ArgumentError, 'invalid value for "war_id" when calling WarsApi.get_wars_war_id_killmails, 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 WarsApi.get_wars_war_id_killmails, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/wars/{war_id}/killmails/'.sub('{' + 'war_id' + '}', CGI.escape(war_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?

  # 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<GetWarsWarIdKillmails200Ok>'

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

  new_options = opts.merge(
    :operation => :"WarsApi.get_wars_war_id_killmails",
    :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: WarsApi#get_wars_war_id_killmails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_wars_war_id_with_http_info(war_id, opts = {}) ⇒ Array<(GetWarsWarIdOk, Integer, Hash)>

Get war information Return details about a war — Alternate route: &#x60;/dev/wars/war_id/&#x60; Alternate route: &#x60;/legacy/wars/war_id/&#x60; Alternate route: &#x60;/v1/wars/war_id/&#x60; — This route is cached for up to 3600 seconds

Parameters:

  • war_id (Integer) —

    ID for a war

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

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

  • :if_none_match (String) —

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

Returns:

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

    GetWarsWarIdOk data, response status code and response headers



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/ruby-esi/api/wars_api.rb', line 111

def get_wars_war_id_with_http_info(war_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WarsApi.get_wars_war_id ...'
  end
  # verify the required parameter 'war_id' is set
  if @api_client.config.client_side_validation && war_id.nil?
    fail ArgumentError, "Missing the required parameter 'war_id' when calling WarsApi.get_wars_war_id"
  end
  if @api_client.config.client_side_validation && war_id < 1
    fail ArgumentError, 'invalid value for "war_id" when calling WarsApi.get_wars_war_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 = '/wars/{war_id}/'.sub('{' + 'war_id' + '}', CGI.escape(war_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] || 'GetWarsWarIdOk'

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

  new_options = opts.merge(
    :operation => :"WarsApi.get_wars_war_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: WarsApi#get_wars_war_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

List wars Return a list of wars — Alternate route: &#x60;/dev/wars/&#x60; Alternate route: &#x60;/legacy/wars/&#x60; Alternate route: &#x60;/v1/wars/&#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 (default to ‘tranquility’)

  • :if_none_match (String) —

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

  • :max_war_id (Integer) —

    Only return wars with ID smaller than this

Returns:

  • (Array<(Array<Integer>, Integer, 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
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/ruby-esi/api/wars_api.rb', line 41

def get_wars_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WarsApi.get_wars ...'
  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 = '/wars/'

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

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

  new_options = opts.merge(
    :operation => :"WarsApi.get_wars",
    :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: WarsApi#get_wars\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end