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.



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

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/ruby-esi/api/killmails_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

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

Get a character’s recent kills and losses Return a list of a character’s kills and losses going back 90 days — Alternate route: ‘/dev/characters/character_id/killmails/recent/` Alternate route: `/legacy/characters/character_id/killmails/recent/` Alternate route: `/v1/characters/character_id/killmails/recent/` — This route is cached for up to 300 seconds

Parameters:

  • character_id —

    An EVE character 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)

  • :token (String) —

    Access token to use if unable to set a header

Returns:



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

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

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

Get a character&#x27;s recent kills and losses Return a list of a character&#x27;s kills and losses going back 90 days — Alternate route: &#x60;/dev/characters/character_id/killmails/recent/&#x60; Alternate route: &#x60;/legacy/characters/character_id/killmails/recent/&#x60; Alternate route: &#x60;/v1/characters/character_id/killmails/recent/&#x60; — This route is cached for up to 300 seconds

Parameters:

  • character_id —

    An EVE character ID

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

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

  • :token (String) —

    Access token to use if unable to set a header

Returns:



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

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

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  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[:body] 

  return_type = opts[:return_type] || 'Array<GetCharactersCharacterIdKillmailsRecent200Ok>' 

  auth_names = opts[: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 => return_type)

  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, opts = {}) ⇒ Array<GetCorporationsCorporationIdKillmailsRecent200Ok>

Get a corporation’s recent kills and losses Get a list of a corporation’s kills and losses going back 90 days — Alternate route: ‘/dev/corporations/corporation_id/killmails/recent/` Alternate route: `/legacy/corporations/corporation_id/killmails/recent/` Alternate route: `/v1/corporations/corporation_id/killmails/recent/` — This route is cached for up to 300 seconds — Requires one of the following EVE corporation role(s): Director

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)

  • :if_none_match (String) —

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

  • :page (Integer) —

    Which page of results to return (default to 1)

  • :token (String) —

    Access token to use if unable to set a header

Returns:



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

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

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

Get a corporation&#x27;s recent kills and losses Get a list of a corporation&#x27;s kills and losses going back 90 days — Alternate route: &#x60;/dev/corporations/corporation_id/killmails/recent/&#x60; Alternate route: &#x60;/legacy/corporations/corporation_id/killmails/recent/&#x60; Alternate route: &#x60;/v1/corporations/corporation_id/killmails/recent/&#x60; — This route is cached for up to 300 seconds — Requires one of the following EVE corporation role(s): Director

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

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

  • :token (String) —

    Access token to use if unable to set a header

Returns:



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

def get_corporations_corporation_id_killmails_recent_with_http_info(corporation_id, 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
  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility'
  end
  # resource path
  local_var_path = '/corporations/{corporation_id}/killmails/recent/'.sub('{' + 'corporation_id' + '}', corporation_id.to_s)

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  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[:body] 

  return_type = opts[:return_type] || 'Array<GetCorporationsCorporationIdKillmailsRecent200Ok>' 

  auth_names = opts[: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 => return_type)

  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, opts = {}) ⇒ GetKillmailsKillmailIdKillmailHashOk

Get a single killmail Return a single killmail from its ID and hash — Alternate route: ‘/dev/killmails/killmail_id/killmail_hash/` Alternate route: `/legacy/killmails/killmail_id/killmail_hash/` Alternate route: `/v1/killmails/killmail_id/killmail_hash/` — This route is cached for up to 30758400 seconds

Parameters:

  • killmail_hash —

    The killmail hash for verification

  • killmail_id —

    The killmail ID to be queried

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



169
170
171
172
 
# File 'lib/ruby-esi/api/killmails_api.rb', line 169

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

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

Get a single killmail Return a single killmail from its ID and hash — Alternate route: &#x60;/dev/killmails/killmail_id/killmail_hash/&#x60; Alternate route: &#x60;/legacy/killmails/killmail_id/killmail_hash/&#x60; Alternate route: &#x60;/v1/killmails/killmail_id/killmail_hash/&#x60; — This route is cached for up to 30758400 seconds

Parameters:

  • killmail_hash —

    The killmail hash for verification

  • killmail_id —

    The killmail ID to be queried

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :if_none_match (String) —

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

Returns:



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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/ruby-esi/api/killmails_api.rb', line 182

def get_killmails_killmail_id_killmail_hash_with_http_info(killmail_hash, killmail_id, 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
  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility'
  end
  # resource path
  local_var_path = '/killmails/{killmail_id}/{killmail_hash}/'.sub('{' + 'killmail_hash' + '}', killmail_hash.to_s).sub('{' + 'killmail_id' + '}', killmail_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'])
  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[:body] 

  return_type = opts[:return_type] || 'GetKillmailsKillmailIdKillmailHashOk' 

  auth_names = opts[: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 => return_type)

  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