Class: ESI::MarketApi

Inherits:
Object
  • Object
show all
Defined in:
lib/esi-client-bvv/api/market_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MarketApi

Returns a new instance of MarketApi.



19
20
21
 
# File 'lib/esi-client-bvv/api/market_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/esi-client-bvv/api/market_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_characters_character_id_orders(character_id, opts = {}) ⇒ Array<GetCharactersCharacterIdOrders200Ok>

List open orders from a character List open market orders placed by a character — This route is cached for up to 1200 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

  • :token (String) —

    Access token to use if unable to set a header

Returns:



31
32
33
34
 
# File 'lib/esi-client-bvv/api/market_api.rb', line 31

def get_characters_character_id_orders(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_orders_with_http_info(character_id, opts)
  return data
end

#get_characters_character_id_orders_history(character_id, opts = {}) ⇒ Array<GetCharactersCharacterIdOrdersHistory200Ok>

List historical orders by a character List cancelled and expired market orders placed by a character up to 90 days in the past. — 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)

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



103
104
105
106
 
# File 'lib/esi-client-bvv/api/market_api.rb', line 103

def get_characters_character_id_orders_history(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_orders_history_with_http_info(character_id, opts)
  return data
end

#get_characters_character_id_orders_history_with_http_info(character_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdOrdersHistory200Ok>, Fixnum, Hash)>

List historical orders by a character List cancelled and expired market orders placed by a character up to 90 days in the past. — 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

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



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

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

  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling MarketApi.get_characters_character_id_orders_history, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = "/v1/characters/{character_id}/orders/history/".sub('{' + 'character_id' + '}', character_id.to_s)

  # query parameters
  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 = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].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<GetCharactersCharacterIdOrdersHistory200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MarketApi#get_characters_character_id_orders_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_characters_character_id_orders_with_http_info(character_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdOrders200Ok>, Fixnum, Hash)>

List open orders from a character List open market orders placed by a character — This route is cached for up to 1200 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

  • :token (String) —

    Access token to use if unable to set a header

Returns:



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
 
# File 'lib/esi-client-bvv/api/market_api.rb', line 44

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

  if @api_client.config.client_side_validation && 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 = "/v2/characters/{character_id}/orders/".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?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].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<GetCharactersCharacterIdOrders200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MarketApi#get_characters_character_id_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_corporations_corporation_id_orders(corporation_id, opts = {}) ⇒ Array<GetCorporationsCorporationIdOrders200Ok>

List open orders from a corporation List open market orders placed on behalf of a corporation — This route is cached for up to 1200 seconds — Requires one of the following EVE corporation role(s): Accountant, Trader

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:



181
182
183
184
 
# File 'lib/esi-client-bvv/api/market_api.rb', line 181

def get_corporations_corporation_id_orders(corporation_id, opts = {})
  data, _status_code, _headers = get_corporations_corporation_id_orders_with_http_info(corporation_id, opts)
  return data
end

#get_corporations_corporation_id_orders_history(corporation_id, opts = {}) ⇒ Array<GetCorporationsCorporationIdOrdersHistory200Ok>

List historical orders from a corporation List cancelled and expired market orders placed on behalf of a corporation up to 90 days in the past. — This route is cached for up to 3600 seconds — Requires one of the following EVE corporation role(s): Accountant, Trader

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:



259
260
261
262
 
# File 'lib/esi-client-bvv/api/market_api.rb', line 259

def get_corporations_corporation_id_orders_history(corporation_id, opts = {})
  data, _status_code, _headers = get_corporations_corporation_id_orders_history_with_http_info(corporation_id, opts)
  return data
end

#get_corporations_corporation_id_orders_history_with_http_info(corporation_id, opts = {}) ⇒ Array<(Array<GetCorporationsCorporationIdOrdersHistory200Ok>, Fixnum, Hash)>

List historical orders from a corporation List cancelled and expired market orders placed on behalf of a corporation up to 90 days in the past. — This route is cached for up to 3600 seconds — Requires one of the following EVE corporation role(s): Accountant, Trader

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:



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
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/esi-client-bvv/api/market_api.rb', line 273

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

  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling MarketApi.get_corporations_corporation_id_orders_history, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = "/v2/corporations/{corporation_id}/orders/history/".sub('{' + 'corporation_id' + '}', corporation_id.to_s)

  # query parameters
  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 = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].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<GetCorporationsCorporationIdOrdersHistory200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MarketApi#get_corporations_corporation_id_orders_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_corporations_corporation_id_orders_with_http_info(corporation_id, opts = {}) ⇒ Array<(Array<GetCorporationsCorporationIdOrders200Ok>, Fixnum, Hash)>

List open orders from a corporation List open market orders placed on behalf of a corporation — This route is cached for up to 1200 seconds — Requires one of the following EVE corporation role(s): Accountant, Trader

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:



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

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

  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling MarketApi.get_corporations_corporation_id_orders, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = "/v3/corporations/{corporation_id}/orders/".sub('{' + 'corporation_id' + '}', corporation_id.to_s)

  # query parameters
  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 = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].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<GetCorporationsCorporationIdOrders200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MarketApi#get_corporations_corporation_id_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get item groups Get a list of item groups — This route expires daily at 11:05

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

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

  • :if_none_match (String) —

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

Returns:

  • (Array<Integer>) 


334
335
336
337
 
# File 'lib/esi-client-bvv/api/market_api.rb', line 334

def get_markets_groups(opts = {})
  data, _status_code, _headers = get_markets_groups_with_http_info(opts)
  return data
end

#get_markets_groups_market_group_id(market_group_id, opts = {}) ⇒ GetMarketsGroupsMarketGroupIdOk

Get item group information Get information on an item group — This route expires daily at 11:05

Parameters:

  • market_group_id —

    An Eve item group ID

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    Language to use in the response (default to en-us)

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

  • :language (String) —

    Language to use in the response, takes precedence over Accept-Language (default to en-us)

Returns:



395
396
397
398
 
# File 'lib/esi-client-bvv/api/market_api.rb', line 395

def get_markets_groups_market_group_id(market_group_id, opts = {})
  data, _status_code, _headers = get_markets_groups_market_group_id_with_http_info(market_group_id, opts)
  return data
end

#get_markets_groups_market_group_id_with_http_info(market_group_id, opts = {}) ⇒ Array<(GetMarketsGroupsMarketGroupIdOk, Fixnum, Hash)>

Get item group information Get information on an item group — This route expires daily at 11:05

Parameters:

  • market_group_id —

    An Eve item group ID

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    Language to use in the response

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

  • :language (String) —

    Language to use in the response, takes precedence over Accept-Language

Returns:



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
452
453
454
455
456
457
458
459
460
 
# File 'lib/esi-client-bvv/api/market_api.rb', line 409

def get_markets_groups_market_group_id_with_http_info(market_group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MarketApi.get_markets_groups_market_group_id ..."
  end
  # verify the required parameter 'market_group_id' is set
  if @api_client.config.client_side_validation && market_group_id.nil?
    fail ArgumentError, "Missing the required parameter 'market_group_id' when calling MarketApi.get_markets_groups_market_group_id"
  end
  if @api_client.config.client_side_validation && opts[:'accept_language'] && !['de', 'en-us', 'fr', 'ja', 'ru', 'zh'].include?(opts[:'accept_language'])
    fail ArgumentError, 'invalid value for "accept_language", must be one of de, en-us, fr, ja, ru, zh'
  end
  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  if @api_client.config.client_side_validation && opts[:'language'] && !['de', 'en-us', 'fr', 'ja', 'ru', 'zh'].include?(opts[:'language'])
    fail ArgumentError, 'invalid value for "language", must be one of de, en-us, fr, ja, ru, zh'
  end
  # resource path
  local_var_path = "/v1/markets/groups/{market_group_id}/".sub('{' + 'market_group_id' + '}', market_group_id.to_s)

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  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 => 'GetMarketsGroupsMarketGroupIdOk')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MarketApi#get_markets_groups_market_group_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get item groups Get a list of item groups — This route expires daily at 11:05

Parameters:

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

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

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



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/esi-client-bvv/api/market_api.rb', line 345

def get_markets_groups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MarketApi.get_markets_groups ..."
  end
  if @api_client.config.client_side_validation && 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 = "/v1/markets/groups/"

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  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 => 'Array<Integer>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MarketApi#get_markets_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_markets_prices(opts = {}) ⇒ Array<GetMarketsPrices200Ok>

List market prices Return a list of prices — This route is cached for up to 3600 seconds

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

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

  • :if_none_match (String) —

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

Returns:



468
469
470
471
 
# File 'lib/esi-client-bvv/api/market_api.rb', line 468

def get_markets_prices(opts = {})
  data, _status_code, _headers = get_markets_prices_with_http_info(opts)
  return data
end

#get_markets_prices_with_http_info(opts = {}) ⇒ Array<(Array<GetMarketsPrices200Ok>, Fixnum, Hash)>

List market prices Return a list of prices — This route is cached for up to 3600 seconds

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :if_none_match (String) —

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

Returns:

  • (Array<(Array<GetMarketsPrices200Ok>, Fixnum, Hash)>) —

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



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
 
# File 'lib/esi-client-bvv/api/market_api.rb', line 479

def get_markets_prices_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MarketApi.get_markets_prices ..."
  end
  if @api_client.config.client_side_validation && 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 = "/v1/markets/prices/"

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  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 => 'Array<GetMarketsPrices200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MarketApi#get_markets_prices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_markets_region_id_history(region_id, type_id, opts = {}) ⇒ Array<GetMarketsRegionIdHistory200Ok>

List historical market statistics in a region Return a list of historical market statistics for the specified type in a region — This route expires daily at 11:05

Parameters:

  • region_id —

    Return statistics in this region

  • type_id —

    Return statistics for this type

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



528
529
530
531
 
# File 'lib/esi-client-bvv/api/market_api.rb', line 528

def get_markets_region_id_history(region_id, type_id, opts = {})
  data, _status_code, _headers = get_markets_region_id_history_with_http_info(region_id, type_id, opts)
  return data
end

#get_markets_region_id_history_with_http_info(region_id, type_id, opts = {}) ⇒ Array<(Array<GetMarketsRegionIdHistory200Ok>, Fixnum, Hash)>

List historical market statistics in a region Return a list of historical market statistics for the specified type in a region — This route expires daily at 11:05

Parameters:

  • region_id —

    Return statistics in this region

  • type_id —

    Return statistics for this type

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

  • (Array<(Array<GetMarketsRegionIdHistory200Ok>, Fixnum, Hash)>) —

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



541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
 
# File 'lib/esi-client-bvv/api/market_api.rb', line 541

def get_markets_region_id_history_with_http_info(region_id, type_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MarketApi.get_markets_region_id_history ..."
  end
  # verify the required parameter 'region_id' is set
  if @api_client.config.client_side_validation && region_id.nil?
    fail ArgumentError, "Missing the required parameter 'region_id' when calling MarketApi.get_markets_region_id_history"
  end
  # verify the required parameter 'type_id' is set
  if @api_client.config.client_side_validation && type_id.nil?
    fail ArgumentError, "Missing the required parameter 'type_id' when calling MarketApi.get_markets_region_id_history"
  end
  if @api_client.config.client_side_validation && 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 = "/v1/markets/{region_id}/history/".sub('{' + 'region_id' + '}', region_id.to_s)

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  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 => 'Array<GetMarketsRegionIdHistory200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MarketApi#get_markets_region_id_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_markets_region_id_orders(order_type, region_id, opts = {}) ⇒ Array<GetMarketsRegionIdOrders200Ok>

List orders in a region Return a list of orders in a region — This route is cached for up to 300 seconds

Parameters:

  • order_type —

    Filter buy/sell orders, return all orders by default. If you query without type_id, we always return both buy and sell orders

  • region_id —

    Return orders in this region

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

  • :type_id (Integer) —

    Return orders only for this type

Returns:



601
602
603
604
 
# File 'lib/esi-client-bvv/api/market_api.rb', line 601

def get_markets_region_id_orders(order_type, region_id, opts = {})
  data, _status_code, _headers = get_markets_region_id_orders_with_http_info(order_type, region_id, opts)
  return data
end

#get_markets_region_id_orders_with_http_info(order_type, region_id, opts = {}) ⇒ Array<(Array<GetMarketsRegionIdOrders200Ok>, Fixnum, Hash)>

List orders in a region Return a list of orders in a region — This route is cached for up to 300 seconds

Parameters:

  • order_type —

    Filter buy/sell orders, return all orders by default. If you query without type_id, we always return both buy and sell orders

  • region_id —

    Return orders in this region

  • 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

  • :type_id (Integer) —

    Return orders only for this type

Returns:

  • (Array<(Array<GetMarketsRegionIdOrders200Ok>, Fixnum, Hash)>) —

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



616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
 
# File 'lib/esi-client-bvv/api/market_api.rb', line 616

def get_markets_region_id_orders_with_http_info(order_type, region_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MarketApi.get_markets_region_id_orders ..."
  end
  # verify the required parameter 'order_type' is set
  if @api_client.config.client_side_validation && order_type.nil?
    fail ArgumentError, "Missing the required parameter 'order_type' when calling MarketApi.get_markets_region_id_orders"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['buy', 'sell', 'all'].include?(order_type)
    fail ArgumentError, "invalid value for 'order_type', must be one of buy, sell, all"
  end
  # verify the required parameter 'region_id' is set
  if @api_client.config.client_side_validation && region_id.nil?
    fail ArgumentError, "Missing the required parameter 'region_id' when calling MarketApi.get_markets_region_id_orders"
  end
  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling MarketApi.get_markets_region_id_orders, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = "/v1/markets/{region_id}/orders/".sub('{' + 'region_id' + '}', region_id.to_s)

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  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 => 'Array<GetMarketsRegionIdOrders200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MarketApi#get_markets_region_id_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_markets_region_id_types(region_id, opts = {}) ⇒ Array<Integer>

List type IDs relevant to a market Return a list of type IDs that have active orders in the region, for efficient market indexing. — This route is cached for up to 600 seconds

Parameters:

  • region_id —

    Return statistics in this region

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

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

  • :if_none_match (String) —

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

  • :page (Integer) —

    Which page of results to return (default to 1)

Returns:

  • (Array<Integer>) 


684
685
686
687
 
# File 'lib/esi-client-bvv/api/market_api.rb', line 684

def get_markets_region_id_types(region_id, opts = {})
  data, _status_code, _headers = get_markets_region_id_types_with_http_info(region_id, opts)
  return data
end

#get_markets_region_id_types_with_http_info(region_id, opts = {}) ⇒ Array<(Array<Integer>, Fixnum, Hash)>

List type IDs relevant to a market Return a list of type IDs that have active orders in the region, for efficient market indexing. — This route is cached for up to 600 seconds

Parameters:

  • region_id —

    Return statistics in this region

  • 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

Returns:

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

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



697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
 
# File 'lib/esi-client-bvv/api/market_api.rb', line 697

def get_markets_region_id_types_with_http_info(region_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MarketApi.get_markets_region_id_types ..."
  end
  # verify the required parameter 'region_id' is set
  if @api_client.config.client_side_validation && region_id.nil?
    fail ArgumentError, "Missing the required parameter 'region_id' when calling MarketApi.get_markets_region_id_types"
  end
  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling MarketApi.get_markets_region_id_types, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = "/v1/markets/{region_id}/types/".sub('{' + 'region_id' + '}', region_id.to_s)

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  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 => 'Array<Integer>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MarketApi#get_markets_region_id_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_markets_structures_structure_id(structure_id, opts = {}) ⇒ Array<GetMarketsStructuresStructureId200Ok>

List orders in a structure Return all orders in a structure — This route is cached for up to 300 seconds

Parameters:

  • structure_id —

    Return orders in this structure

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



756
757
758
759
 
# File 'lib/esi-client-bvv/api/market_api.rb', line 756

def get_markets_structures_structure_id(structure_id, opts = {})
  data, _status_code, _headers = get_markets_structures_structure_id_with_http_info(structure_id, opts)
  return data
end

#get_markets_structures_structure_id_with_http_info(structure_id, opts = {}) ⇒ Array<(Array<GetMarketsStructuresStructureId200Ok>, Fixnum, Hash)>

List orders in a structure Return all orders in a structure — This route is cached for up to 300 seconds

Parameters:

  • structure_id —

    Return orders in this structure

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



770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
 
# File 'lib/esi-client-bvv/api/market_api.rb', line 770

def get_markets_structures_structure_id_with_http_info(structure_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MarketApi.get_markets_structures_structure_id ..."
  end
  # verify the required parameter 'structure_id' is set
  if @api_client.config.client_side_validation && structure_id.nil?
    fail ArgumentError, "Missing the required parameter 'structure_id' when calling MarketApi.get_markets_structures_structure_id"
  end
  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling MarketApi.get_markets_structures_structure_id, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = "/v1/markets/structures/{structure_id}/".sub('{' + 'structure_id' + '}', structure_id.to_s)

  # query parameters
  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 = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].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<GetMarketsStructuresStructureId200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MarketApi#get_markets_structures_structure_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end