Class: ESI::WalletApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby-esi/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.



19
20
21
# File 'lib/ruby-esi/api/wallet_api.rb', line 19

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

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.



17
18
19
# File 'lib/ruby-esi/api/wallet_api.rb', line 17

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: ‘/legacy/characters/character_id/wallet/` Alternate route: `/v1/characters/character_id/wallet/` — This route is cached for up to 120 seconds — [Diff of the upcoming changes](esi.evetech.net/diff/latest/dev/#GET-/characters/character_id/wallet/)

Parameters:

  • character_id (Integer)

    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

  • :token (String)

    Access token to use if unable to set a header

Returns:

  • (Float)


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

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

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

Get character wallet journal Retrieve the given character’s wallet journal going 30 days back — Alternate route: ‘/dev/characters/character_id/wallet/journal/` Alternate route: `/legacy/characters/character_id/wallet/journal/` Alternate route: `/v5/characters/character_id/wallet/journal/` Alternate route: `/v6/characters/character_id/wallet/journal/` — This route is cached for up to 3600 seconds

Parameters:

  • character_id (Integer)

    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:



111
112
113
114
# File 'lib/ruby-esi/api/wallet_api.rb', line 111

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

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

Get character wallet journal Retrieve the given character&#39;s wallet journal going 30 days back — Alternate route: &#x60;/dev/characters/character_id/wallet/journal/&#x60; Alternate route: &#x60;/legacy/characters/character_id/wallet/journal/&#x60; Alternate route: &#x60;/v5/characters/character_id/wallet/journal/&#x60; Alternate route: &#x60;/v6/characters/character_id/wallet/journal/&#x60; — This route is cached for up to 3600 seconds

Parameters:

  • character_id (Integer)

    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:



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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
# File 'lib/ruby-esi/api/wallet_api.rb', line 125

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
  if @api_client.config.client_side_validation && character_id.nil?
    fail ArgumentError, "Missing the required parameter 'character_id' when calling WalletApi.get_characters_character_id_wallet_journal"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling WalletApi.get_characters_character_id_wallet_journal, 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 WalletApi.get_characters_character_id_wallet_journal, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/characters/{character_id}/wallet/journal/'.sub('{' + 'character_id' + '}', CGI.escape(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']) 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<GetCharactersCharacterIdWalletJournal200Ok>'

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

  new_options = opts.merge(
    :operation => :"WalletApi.get_characters_character_id_wallet_journal",
    :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: 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: ‘/dev/characters/character_id/wallet/transactions/` Alternate route: `/legacy/characters/character_id/wallet/transactions/` Alternate route: `/v1/characters/character_id/wallet/transactions/` — This route is cached for up to 3600 seconds

Parameters:

  • character_id (Integer)

    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

  • :if_none_match (String)

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

  • :token (String)

    Access token to use if unable to set a header

Returns:



198
199
200
201
# File 'lib/ruby-esi/api/wallet_api.rb', line 198

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

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

Get wallet transactions Get wallet transactions of a character — Alternate route: &#x60;/dev/characters/character_id/wallet/transactions/&#x60; Alternate route: &#x60;/legacy/characters/character_id/wallet/transactions/&#x60; Alternate route: &#x60;/v1/characters/character_id/wallet/transactions/&#x60; — This route is cached for up to 3600 seconds

Parameters:

  • character_id (Integer)

    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

  • :if_none_match (String)

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

  • :token (String)

    Access token to use if unable to set a header

Returns:



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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
# File 'lib/ruby-esi/api/wallet_api.rb', line 212

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
  if @api_client.config.client_side_validation && character_id.nil?
    fail ArgumentError, "Missing the required parameter 'character_id' when calling WalletApi.get_characters_character_id_wallet_transactions"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling WalletApi.get_characters_character_id_wallet_transactions, 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 = '/characters/{character_id}/wallet/transactions/'.sub('{' + 'character_id' + '}', CGI.escape(character_id.to_s))

  # query parameters
  query_params = opts[: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?

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

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

  new_options = opts.merge(
    :operation => :"WalletApi.get_characters_character_id_wallet_transactions",
    :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: 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, Integer, Hash)>

Get a character&#39;s wallet balance Returns a character&#39;s wallet balance — Alternate route: &#x60;/legacy/characters/character_id/wallet/&#x60; Alternate route: &#x60;/v1/characters/character_id/wallet/&#x60; — This route is cached for up to 120 seconds — [Diff of the upcoming changes](esi.evetech.net/diff/latest/dev/#GET-/characters/character_id/wallet/)

Parameters:

  • character_id (Integer)

    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

  • :token (String)

    Access token to use if unable to set a header

Returns:

  • (Array<(Float, Integer, Hash)>)

    Float data, response status code and response headers



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
91
92
93
94
95
96
97
98
99
100
# File 'lib/ruby-esi/api/wallet_api.rb', line 43

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
  if @api_client.config.client_side_validation && character_id.nil?
    fail ArgumentError, "Missing the required parameter 'character_id' when calling WalletApi.get_characters_character_id_wallet"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling WalletApi.get_characters_character_id_wallet, 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 = '/characters/{character_id}/wallet/'.sub('{' + 'character_id' + '}', CGI.escape(character_id.to_s))

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

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

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

#get_corporations_corporation_id_wallets(corporation_id, opts = {}) ⇒ Array<GetCorporationsCorporationIdWallets200Ok>

Returns a corporation’s wallet balance Get a corporation’s wallets — Alternate route: ‘/dev/corporations/corporation_id/wallets/` Alternate route: `/legacy/corporations/corporation_id/wallets/` Alternate route: `/v1/corporations/corporation_id/wallets/` — This route is cached for up to 300 seconds — Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant

Parameters:

  • corporation_id (Integer)

    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

  • :token (String)

    Access token to use if unable to set a header

Returns:



280
281
282
283
# File 'lib/ruby-esi/api/wallet_api.rb', line 280

def get_corporations_corporation_id_wallets(corporation_id, opts = {})
  data, _status_code, _headers = get_corporations_corporation_id_wallets_with_http_info(corporation_id, opts)
  data
end

#get_corporations_corporation_id_wallets_division_journal(corporation_id, division, opts = {}) ⇒ Array<GetCorporationsCorporationIdWalletsDivisionJournal200Ok>

Get corporation wallet journal Retrieve the given corporation’s wallet journal for the given division going 30 days back — Alternate route: ‘/dev/corporations/corporation_id/wallets/division/journal/` Alternate route: `/legacy/corporations/corporation_id/wallets/division/journal/` Alternate route: `/v3/corporations/corporation_id/wallets/division/journal/` Alternate route: `/v4/corporations/corporation_id/wallets/division/journal/` — This route is cached for up to 3600 seconds — Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant

Parameters:

  • corporation_id (Integer)

    An EVE corporation ID

  • division (Integer)

    Wallet key of the division to fetch journals from

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



362
363
364
365
# File 'lib/ruby-esi/api/wallet_api.rb', line 362

def get_corporations_corporation_id_wallets_division_journal(corporation_id, division, opts = {})
  data, _status_code, _headers = get_corporations_corporation_id_wallets_division_journal_with_http_info(corporation_id, division, opts)
  data
end

#get_corporations_corporation_id_wallets_division_journal_with_http_info(corporation_id, division, opts = {}) ⇒ Array<(Array<GetCorporationsCorporationIdWalletsDivisionJournal200Ok>, Integer, Hash)>

Get corporation wallet journal Retrieve the given corporation&#39;s wallet journal for the given division going 30 days back — Alternate route: &#x60;/dev/corporations/corporation_id/wallets/division/journal/&#x60; Alternate route: &#x60;/legacy/corporations/corporation_id/wallets/division/journal/&#x60; Alternate route: &#x60;/v3/corporations/corporation_id/wallets/division/journal/&#x60; Alternate route: &#x60;/v4/corporations/corporation_id/wallets/division/journal/&#x60; — This route is cached for up to 3600 seconds — Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant

Parameters:

  • corporation_id (Integer)

    An EVE corporation ID

  • division (Integer)

    Wallet key of the division to fetch journals from

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



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
# File 'lib/ruby-esi/api/wallet_api.rb', line 377

def get_corporations_corporation_id_wallets_division_journal_with_http_info(corporation_id, division, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WalletApi.get_corporations_corporation_id_wallets_division_journal ...'
  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 WalletApi.get_corporations_corporation_id_wallets_division_journal"
  end
  if @api_client.config.client_side_validation && corporation_id < 1
    fail ArgumentError, 'invalid value for "corporation_id" when calling WalletApi.get_corporations_corporation_id_wallets_division_journal, must be greater than or equal to 1.'
  end

  # verify the required parameter 'division' is set
  if @api_client.config.client_side_validation && division.nil?
    fail ArgumentError, "Missing the required parameter 'division' when calling WalletApi.get_corporations_corporation_id_wallets_division_journal"
  end
  if @api_client.config.client_side_validation && division > 7
    fail ArgumentError, 'invalid value for "division" when calling WalletApi.get_corporations_corporation_id_wallets_division_journal, must be smaller than or equal to 7.'
  end

  if @api_client.config.client_side_validation && division < 1
    fail ArgumentError, 'invalid value for "division" when calling WalletApi.get_corporations_corporation_id_wallets_division_journal, 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 WalletApi.get_corporations_corporation_id_wallets_division_journal, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/corporations/{corporation_id}/wallets/{division}/journal/'.sub('{' + 'corporation_id' + '}', CGI.escape(corporation_id.to_s)).sub('{' + 'division' + '}', CGI.escape(division.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']) 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<GetCorporationsCorporationIdWalletsDivisionJournal200Ok>'

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

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

#get_corporations_corporation_id_wallets_division_transactions(corporation_id, division, opts = {}) ⇒ Array<GetCorporationsCorporationIdWalletsDivisionTransactions200Ok>

Get corporation wallet transactions Get wallet transactions of a corporation — Alternate route: ‘/dev/corporations/corporation_id/wallets/division/transactions/` Alternate route: `/legacy/corporations/corporation_id/wallets/division/transactions/` Alternate route: `/v1/corporations/corporation_id/wallets/division/transactions/` — This route is cached for up to 3600 seconds — Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant

Parameters:

  • corporation_id (Integer)

    An EVE corporation ID

  • division (Integer)

    Wallet key of the division to fetch journals from

  • 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

  • :if_none_match (String)

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

  • :token (String)

    Access token to use if unable to set a header

Returns:



463
464
465
466
# File 'lib/ruby-esi/api/wallet_api.rb', line 463

def get_corporations_corporation_id_wallets_division_transactions(corporation_id, division, opts = {})
  data, _status_code, _headers = get_corporations_corporation_id_wallets_division_transactions_with_http_info(corporation_id, division, opts)
  data
end

#get_corporations_corporation_id_wallets_division_transactions_with_http_info(corporation_id, division, opts = {}) ⇒ Array<(Array<GetCorporationsCorporationIdWalletsDivisionTransactions200Ok>, Integer, Hash)>

Get corporation wallet transactions Get wallet transactions of a corporation — Alternate route: &#x60;/dev/corporations/corporation_id/wallets/division/transactions/&#x60; Alternate route: &#x60;/legacy/corporations/corporation_id/wallets/division/transactions/&#x60; Alternate route: &#x60;/v1/corporations/corporation_id/wallets/division/transactions/&#x60; — This route is cached for up to 3600 seconds — Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant

Parameters:

  • corporation_id (Integer)

    An EVE corporation ID

  • division (Integer)

    Wallet key of the division to fetch journals from

  • 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

  • :if_none_match (String)

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

  • :token (String)

    Access token to use if unable to set a header

Returns:



478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
# File 'lib/ruby-esi/api/wallet_api.rb', line 478

def get_corporations_corporation_id_wallets_division_transactions_with_http_info(corporation_id, division, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WalletApi.get_corporations_corporation_id_wallets_division_transactions ...'
  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 WalletApi.get_corporations_corporation_id_wallets_division_transactions"
  end
  if @api_client.config.client_side_validation && corporation_id < 1
    fail ArgumentError, 'invalid value for "corporation_id" when calling WalletApi.get_corporations_corporation_id_wallets_division_transactions, must be greater than or equal to 1.'
  end

  # verify the required parameter 'division' is set
  if @api_client.config.client_side_validation && division.nil?
    fail ArgumentError, "Missing the required parameter 'division' when calling WalletApi.get_corporations_corporation_id_wallets_division_transactions"
  end
  if @api_client.config.client_side_validation && division > 7
    fail ArgumentError, 'invalid value for "division" when calling WalletApi.get_corporations_corporation_id_wallets_division_transactions, must be smaller than or equal to 7.'
  end

  if @api_client.config.client_side_validation && division < 1
    fail ArgumentError, 'invalid value for "division" when calling WalletApi.get_corporations_corporation_id_wallets_division_transactions, 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 = '/corporations/{corporation_id}/wallets/{division}/transactions/'.sub('{' + 'corporation_id' + '}', CGI.escape(corporation_id.to_s)).sub('{' + 'division' + '}', CGI.escape(division.to_s))

  # query parameters
  query_params = opts[: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?

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

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

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

#get_corporations_corporation_id_wallets_with_http_info(corporation_id, opts = {}) ⇒ Array<(Array<GetCorporationsCorporationIdWallets200Ok>, Integer, Hash)>

Returns a corporation&#39;s wallet balance Get a corporation&#39;s wallets — Alternate route: &#x60;/dev/corporations/corporation_id/wallets/&#x60; Alternate route: &#x60;/legacy/corporations/corporation_id/wallets/&#x60; Alternate route: &#x60;/v1/corporations/corporation_id/wallets/&#x60; — This route is cached for up to 300 seconds — Requires one of the following EVE corporation role(s): Accountant, Junior_Accountant

Parameters:

  • corporation_id (Integer)

    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

  • :token (String)

    Access token to use if unable to set a header

Returns:



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
341
342
343
344
345
346
347
348
349
350
# File 'lib/ruby-esi/api/wallet_api.rb', line 293

def get_corporations_corporation_id_wallets_with_http_info(corporation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WalletApi.get_corporations_corporation_id_wallets ...'
  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 WalletApi.get_corporations_corporation_id_wallets"
  end
  if @api_client.config.client_side_validation && corporation_id < 1
    fail ArgumentError, 'invalid value for "corporation_id" when calling WalletApi.get_corporations_corporation_id_wallets, 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 = '/corporations/{corporation_id}/wallets/'.sub('{' + 'corporation_id' + '}', CGI.escape(corporation_id.to_s))

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

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

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