Class: ESI::KillmailsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ KillmailsApi

Returns a new instance of KillmailsApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_characters_character_id_killmails_recent(character_id, x_compatibility_date, opts = {}) ⇒ Array<CharactersCharacterIdKillmailsRecentGetInner>

Get a character’s recent kills and losses Return a list of a character’s kills and losses going back 90 days

Parameters:

  • character_id (Integer) —

    The ID of the character

  • x_compatibility_date (Date) —

    The compatibility date for the request.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :accept_language (String) —

    The language to use for the response. (default to ‘en’)

  • :if_none_match (String) —

    The ETag of the previous request. A 304 will be returned if this matches the current ETag.

  • :x_tenant (String) —

    The tenant ID for the request. (default to ‘tranquility’)

  • :if_modified_since (String) —

    The date the resource was last modified. A 304 will be returned if the resource has not been modified since this date.

Returns:



33
34
35
36
 
# File 'lib/ruby-esi/api/killmails_api.rb', line 33

def get_characters_character_id_killmails_recent(character_id, x_compatibility_date, opts = {})
  data, _status_code, _headers = get_characters_character_id_killmails_recent_with_http_info(character_id, x_compatibility_date, opts)
  data
end

#get_characters_character_id_killmails_recent_with_http_info(character_id, x_compatibility_date, opts = {}) ⇒ Array<(Array<CharactersCharacterIdKillmailsRecentGetInner>, Integer, Hash)>

Get a character&#39;s recent kills and losses Return a list of a character&#39;s kills and losses going back 90 days

Parameters:

  • character_id (Integer) —

    The ID of the character

  • x_compatibility_date (Date) —

    The compatibility date for the request.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :accept_language (String) —

    The language to use for the response. (default to ‘en’)

  • :if_none_match (String) —

    The ETag of the previous request. A 304 will be returned if this matches the current ETag.

  • :x_tenant (String) —

    The tenant ID for the request. (default to ‘tranquility’)

  • :if_modified_since (String) —

    The date the resource was last modified. A 304 will be returned if the resource has not been modified since this date.

Returns:



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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/ruby-esi/api/killmails_api.rb', line 49

def get_characters_character_id_killmails_recent_with_http_info(character_id, x_compatibility_date, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KillmailsApi.get_characters_character_id_killmails_recent ...'
  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 KillmailsApi.get_characters_character_id_killmails_recent"
  end
  # verify the required parameter 'x_compatibility_date' is set
  if @api_client.config.client_side_validation && x_compatibility_date.nil?
    fail ArgumentError, "Missing the required parameter 'x_compatibility_date' when calling KillmailsApi.get_characters_character_id_killmails_recent"
  end
  # verify enum value
  allowable_values = ["2020-01-01"]
  if @api_client.config.client_side_validation && !allowable_values.include?(x_compatibility_date)
    fail ArgumentError, "invalid value for \"x_compatibility_date\", 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 KillmailsApi.get_characters_character_id_killmails_recent, must be greater than or equal to 1.'
  end

  allowable_values = ["en", "de", "fr", "ja", "ru", "zh", "ko", "es"]
  if @api_client.config.client_side_validation && opts[:'accept_language'] && !allowable_values.include?(opts[:'accept_language'])
    fail ArgumentError, "invalid value for \"accept_language\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/characters/{character_id}/killmails/recent'.sub('{' + 'character_id' + '}', CGI.escape(character_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  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[:'X-Compatibility-Date'] = x_compatibility_date
  header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil?
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?
  header_params[:'X-Tenant'] = opts[:'x_tenant'] if !opts[:'x_tenant'].nil?
  header_params[:'If-Modified-Since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].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<CharactersCharacterIdKillmailsRecentGetInner>'

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

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

#get_corporations_corporation_id_killmails_recent(corporation_id, x_compatibility_date, opts = {}) ⇒ Array<CharactersCharacterIdKillmailsRecentGetInner>

Get a corporation’s recent kills and losses Get a list of a corporation’s kills and losses going back 90 days

Parameters:

  • corporation_id (Integer) —

    The ID of the corporation

  • x_compatibility_date (Date) —

    The compatibility date for the request.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :accept_language (String) —

    The language to use for the response. (default to ‘en’)

  • :if_none_match (String) —

    The ETag of the previous request. A 304 will be returned if this matches the current ETag.

  • :x_tenant (String) —

    The tenant ID for the request. (default to ‘tranquility’)

  • :if_modified_since (String) —

    The date the resource was last modified. A 304 will be returned if the resource has not been modified since this date.

Returns:



131
132
133
134
 
# File 'lib/ruby-esi/api/killmails_api.rb', line 131

def get_corporations_corporation_id_killmails_recent(corporation_id, x_compatibility_date, opts = {})
  data, _status_code, _headers = get_corporations_corporation_id_killmails_recent_with_http_info(corporation_id, x_compatibility_date, opts)
  data
end

#get_corporations_corporation_id_killmails_recent_with_http_info(corporation_id, x_compatibility_date, opts = {}) ⇒ Array<(Array<CharactersCharacterIdKillmailsRecentGetInner>, Integer, Hash)>

Get a corporation&#39;s recent kills and losses Get a list of a corporation&#39;s kills and losses going back 90 days

Parameters:

  • corporation_id (Integer) —

    The ID of the corporation

  • x_compatibility_date (Date) —

    The compatibility date for the request.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :accept_language (String) —

    The language to use for the response. (default to ‘en’)

  • :if_none_match (String) —

    The ETag of the previous request. A 304 will be returned if this matches the current ETag.

  • :x_tenant (String) —

    The tenant ID for the request. (default to ‘tranquility’)

  • :if_modified_since (String) —

    The date the resource was last modified. A 304 will be returned if the resource has not been modified since this date.

Returns:



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
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
210
211
212
213
214
215
216
 
# File 'lib/ruby-esi/api/killmails_api.rb', line 147

def get_corporations_corporation_id_killmails_recent_with_http_info(corporation_id, x_compatibility_date, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KillmailsApi.get_corporations_corporation_id_killmails_recent ...'
  end
  # verify the required parameter 'corporation_id' is set
  if @api_client.config.client_side_validation && corporation_id.nil?
    fail ArgumentError, "Missing the required parameter 'corporation_id' when calling KillmailsApi.get_corporations_corporation_id_killmails_recent"
  end
  # verify the required parameter 'x_compatibility_date' is set
  if @api_client.config.client_side_validation && x_compatibility_date.nil?
    fail ArgumentError, "Missing the required parameter 'x_compatibility_date' when calling KillmailsApi.get_corporations_corporation_id_killmails_recent"
  end
  # verify enum value
  allowable_values = ["2020-01-01"]
  if @api_client.config.client_side_validation && !allowable_values.include?(x_compatibility_date)
    fail ArgumentError, "invalid value for \"x_compatibility_date\", 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 KillmailsApi.get_corporations_corporation_id_killmails_recent, must be greater than or equal to 1.'
  end

  allowable_values = ["en", "de", "fr", "ja", "ru", "zh", "ko", "es"]
  if @api_client.config.client_side_validation && opts[:'accept_language'] && !allowable_values.include?(opts[:'accept_language'])
    fail ArgumentError, "invalid value for \"accept_language\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/corporations/{corporation_id}/killmails/recent'.sub('{' + 'corporation_id' + '}', CGI.escape(corporation_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  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[:'X-Compatibility-Date'] = x_compatibility_date
  header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil?
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?
  header_params[:'X-Tenant'] = opts[:'x_tenant'] if !opts[:'x_tenant'].nil?
  header_params[:'If-Modified-Since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].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<CharactersCharacterIdKillmailsRecentGetInner>'

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

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

#get_killmails_killmail_id_killmail_hash(killmail_hash, killmail_id, x_compatibility_date, opts = {}) ⇒ KillmailsKillmailIdKillmailHashGet

Get a single killmail Return a single killmail from its ID and hash

Parameters:

  • killmail_hash (String)
  • killmail_id (Integer)
  • x_compatibility_date (Date) —

    The compatibility date for the request.

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    The language to use for the response. (default to ‘en’)

  • :if_none_match (String) —

    The ETag of the previous request. A 304 will be returned if this matches the current ETag.

  • :x_tenant (String) —

    The tenant ID for the request. (default to ‘tranquility’)

  • :if_modified_since (String) —

    The date the resource was last modified. A 304 will be returned if the resource has not been modified since this date.

Returns:



229
230
231
232
 
# File 'lib/ruby-esi/api/killmails_api.rb', line 229

def get_killmails_killmail_id_killmail_hash(killmail_hash, killmail_id, x_compatibility_date, opts = {})
  data, _status_code, _headers = get_killmails_killmail_id_killmail_hash_with_http_info(killmail_hash, killmail_id, x_compatibility_date, opts)
  data
end

#get_killmails_killmail_id_killmail_hash_with_http_info(killmail_hash, killmail_id, x_compatibility_date, opts = {}) ⇒ Array<(KillmailsKillmailIdKillmailHashGet, Integer, Hash)>

Get a single killmail Return a single killmail from its ID and hash

Parameters:

  • killmail_hash (String)
  • killmail_id (Integer)
  • x_compatibility_date (Date) —

    The compatibility date for the request.

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    The language to use for the response. (default to ‘en’)

  • :if_none_match (String) —

    The ETag of the previous request. A 304 will be returned if this matches the current ETag.

  • :x_tenant (String) —

    The tenant ID for the request. (default to ‘tranquility’)

  • :if_modified_since (String) —

    The date the resource was last modified. A 304 will be returned if the resource has not been modified since this date.

Returns:



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
276
277
278
279
280
281
282
283
284
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
 
# File 'lib/ruby-esi/api/killmails_api.rb', line 245

def get_killmails_killmail_id_killmail_hash_with_http_info(killmail_hash, killmail_id, x_compatibility_date, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: KillmailsApi.get_killmails_killmail_id_killmail_hash ...'
  end
  # verify the required parameter 'killmail_hash' is set
  if @api_client.config.client_side_validation && killmail_hash.nil?
    fail ArgumentError, "Missing the required parameter 'killmail_hash' when calling KillmailsApi.get_killmails_killmail_id_killmail_hash"
  end
  # verify the required parameter 'killmail_id' is set
  if @api_client.config.client_side_validation && killmail_id.nil?
    fail ArgumentError, "Missing the required parameter 'killmail_id' when calling KillmailsApi.get_killmails_killmail_id_killmail_hash"
  end
  # verify the required parameter 'x_compatibility_date' is set
  if @api_client.config.client_side_validation && x_compatibility_date.nil?
    fail ArgumentError, "Missing the required parameter 'x_compatibility_date' when calling KillmailsApi.get_killmails_killmail_id_killmail_hash"
  end
  # verify enum value
  allowable_values = ["2020-01-01"]
  if @api_client.config.client_side_validation && !allowable_values.include?(x_compatibility_date)
    fail ArgumentError, "invalid value for \"x_compatibility_date\", must be one of #{allowable_values}"
  end
  allowable_values = ["en", "de", "fr", "ja", "ru", "zh", "ko", "es"]
  if @api_client.config.client_side_validation && opts[:'accept_language'] && !allowable_values.include?(opts[:'accept_language'])
    fail ArgumentError, "invalid value for \"accept_language\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/killmails/{killmail_id}/{killmail_hash}'.sub('{' + 'killmail_hash' + '}', CGI.escape(killmail_hash.to_s)).sub('{' + 'killmail_id' + '}', CGI.escape(killmail_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # 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[:'X-Compatibility-Date'] = x_compatibility_date
  header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil?
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?
  header_params[:'X-Tenant'] = opts[:'x_tenant'] if !opts[:'x_tenant'].nil?
  header_params[:'If-Modified-Since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].nil?

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

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

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

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

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