Class: EsiClient::MarketApi

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



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

def api_client
  @api_client
end

Instance Method Details

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

List orders from a character List market orders placed by a character — Alternate route: ‘/v1/characters/character_id/orders/` Alternate route: `/legacy/characters/character_id/orders/` Alternate route: `/dev/characters/character_id/orders/` — 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)

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



31
32
33
34
 
# File 'lib/esi-ruby/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_with_http_info(character_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdOrders200Ok>, Fixnum, Hash)>

List orders from a character List market orders placed by a character — Alternate route: &#x60;/v1/characters/character_id/orders/&#x60; Alternate route: &#x60;/legacy/characters/character_id/orders/&#x60; Alternate route: &#x60;/dev/characters/character_id/orders/&#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

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



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/market_api.rb', line 45

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
  fail ArgumentError, "Missing the required parameter 'character_id' when calling MarketApi.get_characters_character_id_orders" 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}/orders/".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<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_markets_groups(opts = {}) ⇒ Array<Integer>

Get item groups Get a list of item groups — Alternate route: ‘/v1/markets/groups/` Alternate route: `/legacy/markets/groups/` Alternate route: `/dev/markets/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)

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:

  • (Array<Integer>) 


95
96
97
98
 
# File 'lib/esi-ruby/api/market_api.rb', line 95

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 — Alternate route: ‘/v1/markets/groups/market_group_id/` Alternate route: `/legacy/markets/groups/market_group_id/` Alternate route: `/dev/markets/groups/market_group_id/` — 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):

  • :datasource (String) —

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

  • :language (String) —

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

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:



156
157
158
159
 
# File 'lib/esi-ruby/api/market_api.rb', line 156

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 — Alternate route: &#x60;/v1/markets/groups/market_group_id/&#x60; Alternate route: &#x60;/legacy/markets/groups/market_group_id/&#x60; Alternate route: &#x60;/dev/markets/groups/market_group_id/&#x60; — 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):

  • :datasource (String) —

    The server name you would like data from

  • :language (String) —

    Language to use in the response

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/esi-ruby/api/market_api.rb', line 170

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
  fail ArgumentError, "Missing the required parameter 'market_group_id' when calling MarketApi.get_markets_groups_market_group_id" if market_group_id.nil?
  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  if 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 = "/markets/groups/{market_group_id}/".sub('{format}','json').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?
  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 = []
  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 — Alternate route: &#x60;/v1/markets/groups/&#x60; Alternate route: &#x60;/legacy/markets/groups/&#x60; Alternate route: &#x60;/dev/markets/groups/&#x60; — 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

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:

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

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



107
108
109
110
111
112
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
 
# File 'lib/esi-ruby/api/market_api.rb', line 107

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 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 = "/markets/groups/".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].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 = []
  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 — Alternate route: ‘/v1/markets/prices/` Alternate route: `/legacy/markets/prices/` Alternate route: `/dev/markets/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)

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:



223
224
225
226
 
# File 'lib/esi-ruby/api/market_api.rb', line 223

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 — Alternate route: &#x60;/v1/markets/prices/&#x60; Alternate route: &#x60;/legacy/markets/prices/&#x60; Alternate route: &#x60;/dev/markets/prices/&#x60; — 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

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:

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

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



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
271
272
273
 
# File 'lib/esi-ruby/api/market_api.rb', line 235

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 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 = "/markets/prices/".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].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 = []
  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 — Alternate route: ‘/v1/markets/region_id/history/` Alternate route: `/legacy/markets/region_id/history/` Alternate route: `/dev/markets/region_id/history/` — This route is cached for up to 3600 seconds

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)

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:



284
285
286
287
 
# File 'lib/esi-ruby/api/market_api.rb', line 284

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 — Alternate route: &#x60;/v1/markets/region_id/history/&#x60; Alternate route: &#x60;/legacy/markets/region_id/history/&#x60; Alternate route: &#x60;/dev/markets/region_id/history/&#x60; — This route is cached for up to 3600 seconds

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

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:

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

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



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

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
  fail ArgumentError, "Missing the required parameter 'region_id' when calling MarketApi.get_markets_region_id_history" if region_id.nil?
  # verify the required parameter 'type_id' is set
  fail ArgumentError, "Missing the required parameter 'type_id' when calling MarketApi.get_markets_region_id_history" if type_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 = "/markets/{region_id}/history/".sub('{format}','json').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?
  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 = []
  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 — Alternate route: ‘/v1/markets/region_id/orders/` Alternate route: `/legacy/markets/region_id/orders/` Alternate route: `/dev/markets/region_id/orders/` — 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)

  • :page (Integer) —

    Which page of results to return (default to 1)

  • :type_id (Integer) —

    Return orders only for this type

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:



354
355
356
357
 
# File 'lib/esi-ruby/api/market_api.rb', line 354

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 — Alternate route: &#x60;/v1/markets/region_id/orders/&#x60; Alternate route: &#x60;/legacy/markets/region_id/orders/&#x60; Alternate route: &#x60;/dev/markets/region_id/orders/&#x60; — 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

  • :page (Integer) —

    Which page of results to return

  • :type_id (Integer) —

    Return orders only for this type

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:

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

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



370
371
372
373
374
375
376
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
 
# File 'lib/esi-ruby/api/market_api.rb', line 370

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
  fail ArgumentError, "Missing the required parameter 'order_type' when calling MarketApi.get_markets_region_id_orders" if order_type.nil?
  # verify enum value
  unless ['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
  fail ArgumentError, "Missing the required parameter 'region_id' when calling MarketApi.get_markets_region_id_orders" if region_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 = "/markets/{region_id}/orders/".sub('{format}','json').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?
  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 = []
  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_structures_structure_id(structure_id, opts = {}) ⇒ Array<GetMarketsStructuresStructureId200Ok>

List orders in a structure Return all orders in a structure — Alternate route: ‘/v1/markets/structures/structure_id/` Alternate route: `/legacy/markets/structures/structure_id/` Alternate route: `/dev/markets/structures/structure_id/` — 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)

  • :page (Integer) —

    Which page of results to return (default to 1)

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



431
432
433
434
 
# File 'lib/esi-ruby/api/market_api.rb', line 431

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 — Alternate route: &#x60;/v1/markets/structures/structure_id/&#x60; Alternate route: &#x60;/legacy/markets/structures/structure_id/&#x60; Alternate route: &#x60;/dev/markets/structures/structure_id/&#x60; — 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

  • :page (Integer) —

    Which page of results to return

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



446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/esi-ruby/api/market_api.rb', line 446

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
  fail ArgumentError, "Missing the required parameter 'structure_id' when calling MarketApi.get_markets_structures_structure_id" if structure_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 = "/markets/structures/{structure_id}/".sub('{format}','json').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?
  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<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