Class: EsiClient::WalletApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WalletApi

Returns a new instance of WalletApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_characters_character_id_wallet(character_id, opts = {}) ⇒ Float

Get a character’s wallet balance Returns a character’s wallet balance — Alternate route: ‘/v1/characters/character_id/wallet/` Alternate route: `/legacy/characters/character_id/wallet/` Alternate route: `/dev/characters/character_id/wallet/` — This route is cached for up to 120 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)

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

  • (Float) 


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

def get_characters_character_id_wallet(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_wallet_with_http_info(character_id, opts)
  return data
end

#get_characters_character_id_wallet_journal(character_id, opts = {}) ⇒ Array<GetCharactersCharacterIdWalletJournal200Ok>

Get character wallet journal Retrieve character wallet journal — Alternate route: ‘/v1/characters/character_id/wallet/journal/` Alternate route: `/legacy/characters/character_id/wallet/journal/` — This route is cached for up to 3600 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)

  • :from_id (Integer) —

    Only show journal entries happened before the transaction referenced by this id

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



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

def get_characters_character_id_wallet_journal(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_wallet_journal_with_http_info(character_id, opts)
  return data
end

#get_characters_character_id_wallet_journal_with_http_info(character_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdWalletJournal200Ok>, Fixnum, Hash)>

Get character wallet journal Retrieve character wallet journal — Alternate route: &#x60;/v1/characters/character_id/wallet/journal/&#x60; Alternate route: &#x60;/legacy/characters/character_id/wallet/journal/&#x60; — This route is cached for up to 3600 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

  • :from_id (Integer) —

    Only show journal entries happened before the transaction referenced by this id

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



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

def get_characters_character_id_wallet_journal_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WalletApi.get_characters_character_id_wallet_journal ..."
  end
  # verify the required parameter 'character_id' is set
  fail ArgumentError, "Missing the required parameter 'character_id' when calling WalletApi.get_characters_character_id_wallet_journal" if character_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 = "/characters/{character_id}/wallet/journal/".sub('{format}','json').sub('{' + 'character_id' + '}', character_id.to_s)

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

#get_characters_character_id_wallet_transactions(character_id, opts = {}) ⇒ Array<GetCharactersCharacterIdWalletTransactions200Ok>

Get wallet transactions Get wallet transactions of a character — Alternate route: ‘/v1/characters/character_id/wallet/transactions/` Alternate route: `/legacy/characters/character_id/wallet/transactions/` Alternate route: `/dev/characters/character_id/wallet/transactions/` — This route is cached for up to 3600 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)

  • :from_id (Integer) —

    Only show transactions happened before the one referenced by this id

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



167
168
169
170
 
# File 'lib/esi-ruby/api/wallet_api.rb', line 167

def get_characters_character_id_wallet_transactions(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_wallet_transactions_with_http_info(character_id, opts)
  return data
end

#get_characters_character_id_wallet_transactions_with_http_info(character_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdWalletTransactions200Ok>, Fixnum, Hash)>

Get wallet transactions Get wallet transactions of a character — Alternate route: &#x60;/v1/characters/character_id/wallet/transactions/&#x60; Alternate route: &#x60;/legacy/characters/character_id/wallet/transactions/&#x60; Alternate route: &#x60;/dev/characters/character_id/wallet/transactions/&#x60; — This route is cached for up to 3600 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

  • :from_id (Integer) —

    Only show transactions happened before the one referenced by this id

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



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

def get_characters_character_id_wallet_transactions_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WalletApi.get_characters_character_id_wallet_transactions ..."
  end
  # verify the required parameter 'character_id' is set
  fail ArgumentError, "Missing the required parameter 'character_id' when calling WalletApi.get_characters_character_id_wallet_transactions" if character_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 = "/characters/{character_id}/wallet/transactions/".sub('{format}','json').sub('{' + 'character_id' + '}', character_id.to_s)

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

#get_characters_character_id_wallet_with_http_info(character_id, opts = {}) ⇒ Array<(Float, Fixnum, Hash)>

Get a character&#39;s wallet balance Returns a character&#39;s wallet balance — Alternate route: &#x60;/v1/characters/character_id/wallet/&#x60; Alternate route: &#x60;/legacy/characters/character_id/wallet/&#x60; Alternate route: &#x60;/dev/characters/character_id/wallet/&#x60; — This route is cached for up to 120 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

  • :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<(Float, Fixnum, Hash)>) —

    Float data, response status code and response headers



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

def get_characters_character_id_wallet_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WalletApi.get_characters_character_id_wallet ..."
  end
  # verify the required parameter 'character_id' is set
  fail ArgumentError, "Missing the required parameter 'character_id' when calling WalletApi.get_characters_character_id_wallet" if character_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 = "/characters/{character_id}/wallet/".sub('{format}','json').sub('{' + 'character_id' + '}', character_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 => 'Float')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WalletApi#get_characters_character_id_wallet\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_characters_character_id_wallets(character_id, opts = {}) ⇒ Array<GetCharactersCharacterIdWallets200Ok>

List wallets and balances List your wallets and their balances. Characters typically have only one wallet, with wallet_id 1000 being the master wallet. — Alternate route: ‘/v1/characters/character_id/wallets/` Alternate route: `/legacy/characters/character_id/wallets/` — This route is cached for up to 120 seconds — Warning: Since a character has only 1 wallet, this route will be moved to /characters/character_id/wallet, this route will be removed on 2017-07-31.

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)

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



235
236
237
238
 
# File 'lib/esi-ruby/api/wallet_api.rb', line 235

def get_characters_character_id_wallets(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_wallets_with_http_info(character_id, opts)
  return data
end

#get_characters_character_id_wallets_journal(character_id, opts = {}) ⇒ Array<GetCharactersCharacterIdWalletsJournal200Ok>

Get character wallet journal Retrieve character wallet journal — Alternate route: ‘/v1/characters/character_id/wallets/journal/` Alternate route: `/legacy/characters/character_id/wallets/journal/` — This route is cached for up to 3600 seconds — Warning: Since a character has only 1 wallet, this route will be moved to /characters/character_id/wallet/journal, this route will be removed on 2017-07-31.

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)

  • :from_id (Integer) —

    Only show journal entries happened before the transaction referenced by this id

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



302
303
304
305
 
# File 'lib/esi-ruby/api/wallet_api.rb', line 302

def get_characters_character_id_wallets_journal(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_wallets_journal_with_http_info(character_id, opts)
  return data
end

#get_characters_character_id_wallets_journal_with_http_info(character_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdWalletsJournal200Ok>, Fixnum, Hash)>

Get character wallet journal Retrieve character wallet journal — Alternate route: &#x60;/v1/characters/character_id/wallets/journal/&#x60; Alternate route: &#x60;/legacy/characters/character_id/wallets/journal/&#x60; — This route is cached for up to 3600 seconds — Warning: Since a character has only 1 wallet, this route will be moved to /characters/character_id/wallet/journal, this route will be removed on 2017-07-31.

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

  • :from_id (Integer) —

    Only show journal entries happened before the transaction referenced by this id

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



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
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/esi-ruby/api/wallet_api.rb', line 317

def get_characters_character_id_wallets_journal_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WalletApi.get_characters_character_id_wallets_journal ..."
  end
  # verify the required parameter 'character_id' is set
  fail ArgumentError, "Missing the required parameter 'character_id' when calling WalletApi.get_characters_character_id_wallets_journal" if character_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 = "/characters/{character_id}/wallets/journal/".sub('{format}','json').sub('{' + 'character_id' + '}', character_id.to_s)

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

#get_characters_character_id_wallets_with_http_info(character_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdWallets200Ok>, Fixnum, Hash)>

List wallets and balances List your wallets and their balances. Characters typically have only one wallet, with wallet_id 1000 being the master wallet. — Alternate route: &#x60;/v1/characters/character_id/wallets/&#x60; Alternate route: &#x60;/legacy/characters/character_id/wallets/&#x60; — This route is cached for up to 120 seconds — Warning: Since a character has only 1 wallet, this route will be moved to /characters/character_id/wallet, this route will be removed on 2017-07-31.

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

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



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

def get_characters_character_id_wallets_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: WalletApi.get_characters_character_id_wallets ..."
  end
  # verify the required parameter 'character_id' is set
  fail ArgumentError, "Missing the required parameter 'character_id' when calling WalletApi.get_characters_character_id_wallets" if character_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 = "/characters/{character_id}/wallets/".sub('{format}','json').sub('{' + 'character_id' + '}', character_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<GetCharactersCharacterIdWallets200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WalletApi#get_characters_character_id_wallets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end