Class: ESIClient::IndustryApi

Inherits:
Object
  • Object
show all
Defined in:
lib/esi_client/api/industry_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IndustryApi

Returns a new instance of IndustryApi.



19
20
21
 
# File 'lib/esi_client/api/industry_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/api/industry_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_characters_character_id_industry_jobs(character_id, opts = {}) ⇒ Array<GetCharactersCharacterIdIndustryJobs200Ok>

List character industry jobs List industry jobs placed by a character — This route is cached for up to 300 seconds

Parameters:

  • character_id —

    An EVE character ID

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

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

  • :include_completed (BOOLEAN) —

    Whether retrieve completed character industry jobs as well

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



32
33
34
35
 
# File 'lib/esi_client/api/industry_api.rb', line 32

def get_characters_character_id_industry_jobs(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_industry_jobs_with_http_info(character_id, opts)
  data
end

#get_characters_character_id_industry_jobs_with_http_info(character_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdIndustryJobs200Ok>, Fixnum, Hash)>

List character industry jobs List industry jobs placed by a character — This route is cached for up to 300 seconds

Parameters:

  • character_id —

    An EVE character ID

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :include_completed (BOOLEAN) —

    Whether retrieve completed character industry jobs as well

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



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
 
# File 'lib/esi_client/api/industry_api.rb', line 47

def get_characters_character_id_industry_jobs_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IndustryApi.get_characters_character_id_industry_jobs ...'
  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 IndustryApi.get_characters_character_id_industry_jobs"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling IndustryApi.get_characters_character_id_industry_jobs, 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 = '/v1/characters/{character_id}/industry/jobs/'.sub('{' + 'character_id' + '}', character_id.to_s)

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

#get_characters_character_id_mining(character_id, opts = {}) ⇒ Array<GetCharactersCharacterIdMining200Ok>

Character mining ledger Paginated record of all mining done by a character for the past 30 days — This route is cached for up to 600 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)

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



106
107
108
109
 
# File 'lib/esi_client/api/industry_api.rb', line 106

def get_characters_character_id_mining(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_mining_with_http_info(character_id, opts)
  data
end

#get_characters_character_id_mining_with_http_info(character_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdMining200Ok>, Fixnum, Hash)>

Character mining ledger Paginated record of all mining done by a character for the past 30 days — This route is cached for up to 600 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

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



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
 
# File 'lib/esi_client/api/industry_api.rb', line 121

def get_characters_character_id_mining_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IndustryApi.get_characters_character_id_mining ...'
  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 IndustryApi.get_characters_character_id_mining"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling IndustryApi.get_characters_character_id_mining, 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 = '/v1/characters/{character_id}/mining/'.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?
  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<GetCharactersCharacterIdMining200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IndustryApi#get_characters_character_id_mining\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_corporation_corporation_id_mining_extractions(corporation_id, opts = {}) ⇒ Array<GetCorporationCorporationIdMiningExtractions200Ok>

Moon extraction timers Extraction timers for all moon chunks being extracted by refineries belonging to a corporation. — This route is cached for up to 1800 seconds — Requires one of the following EVE corporation role(s): Structure_manager

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)

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



179
180
181
182
 
# File 'lib/esi_client/api/industry_api.rb', line 179

def get_corporation_corporation_id_mining_extractions(corporation_id, opts = {})
  data, _status_code, _headers = get_corporation_corporation_id_mining_extractions_with_http_info(corporation_id, opts)
  data
end

#get_corporation_corporation_id_mining_extractions_with_http_info(corporation_id, opts = {}) ⇒ Array<(Array<GetCorporationCorporationIdMiningExtractions200Ok>, Fixnum, Hash)>

Moon extraction timers Extraction timers for all moon chunks being extracted by refineries belonging to a corporation. — This route is cached for up to 1800 seconds — Requires one of the following EVE corporation role(s): Structure_manager

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

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



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/esi_client/api/industry_api.rb', line 193

def get_corporation_corporation_id_mining_extractions_with_http_info(corporation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IndustryApi.get_corporation_corporation_id_mining_extractions ...'
  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 IndustryApi.get_corporation_corporation_id_mining_extractions"
  end
  if @api_client.config.client_side_validation && corporation_id < 1
    fail ArgumentError, 'invalid value for "corporation_id" when calling IndustryApi.get_corporation_corporation_id_mining_extractions, 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 = '/v1/corporation/{corporation_id}/mining/extractions/'.sub('{' + 'corporation_id' + '}', corporation_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<GetCorporationCorporationIdMiningExtractions200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IndustryApi#get_corporation_corporation_id_mining_extractions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_corporation_corporation_id_mining_observers(corporation_id, opts = {}) ⇒ Array<GetCorporationCorporationIdMiningObservers200Ok>

Corporation mining observers Paginated list of all entities capable of observing and recording mining for a corporation — This route is cached for up to 3600 seconds — Requires one of the following EVE corporation role(s): Accountant

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)

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



251
252
253
254
 
# File 'lib/esi_client/api/industry_api.rb', line 251

def get_corporation_corporation_id_mining_observers(corporation_id, opts = {})
  data, _status_code, _headers = get_corporation_corporation_id_mining_observers_with_http_info(corporation_id, opts)
  data
end

#get_corporation_corporation_id_mining_observers_observer_id(corporation_id, observer_id, opts = {}) ⇒ Array<GetCorporationCorporationIdMiningObserversObserverId200Ok>

Observed corporation mining Paginated record of all mining seen by an observer — This route is cached for up to 3600 seconds — Requires one of the following EVE corporation role(s): Accountant

Parameters:

  • corporation_id —

    An EVE corporation ID

  • observer_id —

    A mining observer id

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



326
327
328
329
 
# File 'lib/esi_client/api/industry_api.rb', line 326

def get_corporation_corporation_id_mining_observers_observer_id(corporation_id, observer_id, opts = {})
  data, _status_code, _headers = get_corporation_corporation_id_mining_observers_observer_id_with_http_info(corporation_id, observer_id, opts)
  data
end

#get_corporation_corporation_id_mining_observers_observer_id_with_http_info(corporation_id, observer_id, opts = {}) ⇒ Array<(Array<GetCorporationCorporationIdMiningObserversObserverId200Ok>, Fixnum, Hash)>

Observed corporation mining Paginated record of all mining seen by an observer — This route is cached for up to 3600 seconds — Requires one of the following EVE corporation role(s): Accountant

Parameters:

  • corporation_id —

    An EVE corporation ID

  • observer_id —

    A mining observer id

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



342
343
344
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
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/esi_client/api/industry_api.rb', line 342

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

  # verify the required parameter 'observer_id' is set
  if @api_client.config.client_side_validation && observer_id.nil?
    fail ArgumentError, "Missing the required parameter 'observer_id' when calling IndustryApi.get_corporation_corporation_id_mining_observers_observer_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
  # resource path
  local_var_path = '/v1/corporation/{corporation_id}/mining/observers/{observer_id}/'.sub('{' + 'corporation_id' + '}', corporation_id.to_s).sub('{' + 'observer_id' + '}', observer_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<GetCorporationCorporationIdMiningObserversObserverId200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IndustryApi#get_corporation_corporation_id_mining_observers_observer_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_corporation_corporation_id_mining_observers_with_http_info(corporation_id, opts = {}) ⇒ Array<(Array<GetCorporationCorporationIdMiningObservers200Ok>, Fixnum, Hash)>

Corporation mining observers Paginated list of all entities capable of observing and recording mining for a corporation — This route is cached for up to 3600 seconds — Requires one of the following EVE corporation role(s): Accountant

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

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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/esi_client/api/industry_api.rb', line 266

def get_corporation_corporation_id_mining_observers_with_http_info(corporation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IndustryApi.get_corporation_corporation_id_mining_observers ...'
  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 IndustryApi.get_corporation_corporation_id_mining_observers"
  end
  if @api_client.config.client_side_validation && corporation_id < 1
    fail ArgumentError, 'invalid value for "corporation_id" when calling IndustryApi.get_corporation_corporation_id_mining_observers, 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 = '/v1/corporation/{corporation_id}/mining/observers/'.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?
  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<GetCorporationCorporationIdMiningObservers200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IndustryApi#get_corporation_corporation_id_mining_observers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_corporations_corporation_id_industry_jobs(corporation_id, opts = {}) ⇒ Array<GetCorporationsCorporationIdIndustryJobs200Ok>

List corporation industry jobs List industry jobs run by a corporation — This route is cached for up to 300 seconds — Requires one of the following EVE corporation role(s): FactoryManager

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)

  • :include_completed (BOOLEAN) —

    Whether retrieve completed industry jobs as well (default to false)

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



406
407
408
409
 
# File 'lib/esi_client/api/industry_api.rb', line 406

def get_corporations_corporation_id_industry_jobs(corporation_id, opts = {})
  data, _status_code, _headers = get_corporations_corporation_id_industry_jobs_with_http_info(corporation_id, opts)
  data
end

#get_corporations_corporation_id_industry_jobs_with_http_info(corporation_id, opts = {}) ⇒ Array<(Array<GetCorporationsCorporationIdIndustryJobs200Ok>, Fixnum, Hash)>

List corporation industry jobs List industry jobs run by a corporation — This route is cached for up to 300 seconds — Requires one of the following EVE corporation role(s): FactoryManager

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

  • :include_completed (BOOLEAN) —

    Whether retrieve completed industry jobs as well

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



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
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/esi_client/api/industry_api.rb', line 422

def get_corporations_corporation_id_industry_jobs_with_http_info(corporation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IndustryApi.get_corporations_corporation_id_industry_jobs ...'
  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 IndustryApi.get_corporations_corporation_id_industry_jobs"
  end
  if @api_client.config.client_side_validation && corporation_id < 1
    fail ArgumentError, 'invalid value for "corporation_id" when calling IndustryApi.get_corporations_corporation_id_industry_jobs, 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 = '/v1/corporations/{corporation_id}/industry/jobs/'.sub('{' + 'corporation_id' + '}', corporation_id.to_s)

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

#get_industry_facilities(opts = {}) ⇒ Array<GetIndustryFacilities200Ok>

List industry facilities Return a list of industry facilities — 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:



479
480
481
482
 
# File 'lib/esi_client/api/industry_api.rb', line 479

def get_industry_facilities(opts = {})
  data, _status_code, _headers = get_industry_facilities_with_http_info(opts)
  data
end

#get_industry_facilities_with_http_info(opts = {}) ⇒ Array<(Array<GetIndustryFacilities200Ok>, Fixnum, Hash)>

List industry facilities Return a list of industry facilities — 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<GetIndustryFacilities200Ok>, Fixnum, Hash)>) —

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



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
 
# File 'lib/esi_client/api/industry_api.rb', line 491

def get_industry_facilities_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IndustryApi.get_industry_facilities ...'
  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/industry/facilities/'

  # 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<GetIndustryFacilities200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IndustryApi#get_industry_facilities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_industry_systems(opts = {}) ⇒ Array<GetIndustrySystems200Ok>

List solar system cost indices Return cost indices for solar systems — 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:



537
538
539
540
 
# File 'lib/esi_client/api/industry_api.rb', line 537

def get_industry_systems(opts = {})
  data, _status_code, _headers = get_industry_systems_with_http_info(opts)
  data
end

#get_industry_systems_with_http_info(opts = {}) ⇒ Array<(Array<GetIndustrySystems200Ok>, Fixnum, Hash)>

List solar system cost indices Return cost indices for solar systems — 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<GetIndustrySystems200Ok>, Fixnum, Hash)>) —

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



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
 
# File 'lib/esi_client/api/industry_api.rb', line 549

def get_industry_systems_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IndustryApi.get_industry_systems ...'
  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/industry/systems/'

  # 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<GetIndustrySystems200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IndustryApi#get_industry_systems\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end