Class: EsiClient::OpportunitiesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OpportunitiesApi

Returns a new instance of OpportunitiesApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_characters_character_id_opportunities(character_id, opts = {}) ⇒ Array<GetCharactersCharacterIdOpportunities200Ok>

Get a character’s completed tasks Return a list of tasks finished by a character — Alternate route: ‘/v1/characters/character_id/opportunities/` Alternate route: `/legacy/characters/character_id/opportunities/` Alternate route: `/dev/characters/character_id/opportunities/` — 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/opportunities_api.rb', line 31

def get_characters_character_id_opportunities(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_opportunities_with_http_info(character_id, opts)
  return data
end

#get_characters_character_id_opportunities_with_http_info(character_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdOpportunities200Ok>, Fixnum, Hash)>

Get a character&#39;s completed tasks Return a list of tasks finished by a character — Alternate route: &#x60;/v1/characters/character_id/opportunities/&#x60; Alternate route: &#x60;/legacy/characters/character_id/opportunities/&#x60; Alternate route: &#x60;/dev/characters/character_id/opportunities/&#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/opportunities_api.rb', line 45

def get_characters_character_id_opportunities_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OpportunitiesApi.get_characters_character_id_opportunities ..."
  end
  # verify the required parameter 'character_id' is set
  fail ArgumentError, "Missing the required parameter 'character_id' when calling OpportunitiesApi.get_characters_character_id_opportunities" 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}/opportunities/".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<GetCharactersCharacterIdOpportunities200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OpportunitiesApi#get_characters_character_id_opportunities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get opportunities groups Return a list of opportunities groups — Alternate route: ‘/v1/opportunities/groups/` Alternate route: `/legacy/opportunities/groups/` Alternate route: `/dev/opportunities/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/opportunities_api.rb', line 95

def get_opportunities_groups(opts = {})
  data, _status_code, _headers = get_opportunities_groups_with_http_info(opts)
  return data
end

#get_opportunities_groups_group_id(group_id, opts = {}) ⇒ GetOpportunitiesGroupsGroupIdOk

Get opportunities group Return information of an opportunities group — Alternate route: ‘/v1/opportunities/groups/group_id/` Alternate route: `/legacy/opportunities/groups/group_id/` Alternate route: `/dev/opportunities/groups/group_id/` — This route expires daily at 11:05

Parameters:

  • group_id —

    ID of an opportunities group

  • 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/opportunities_api.rb', line 156

def get_opportunities_groups_group_id(group_id, opts = {})
  data, _status_code, _headers = get_opportunities_groups_group_id_with_http_info(group_id, opts)
  return data
end

#get_opportunities_groups_group_id_with_http_info(group_id, opts = {}) ⇒ Array<(GetOpportunitiesGroupsGroupIdOk, Fixnum, Hash)>

Get opportunities group Return information of an opportunities group — Alternate route: &#x60;/v1/opportunities/groups/group_id/&#x60; Alternate route: &#x60;/legacy/opportunities/groups/group_id/&#x60; Alternate route: &#x60;/dev/opportunities/groups/group_id/&#x60; — This route expires daily at 11:05

Parameters:

  • group_id —

    ID of an opportunities group

  • 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/opportunities_api.rb', line 170

def get_opportunities_groups_group_id_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OpportunitiesApi.get_opportunities_groups_group_id ..."
  end
  # verify the required parameter 'group_id' is set
  fail ArgumentError, "Missing the required parameter 'group_id' when calling OpportunitiesApi.get_opportunities_groups_group_id" if 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 = "/opportunities/groups/{group_id}/".sub('{format}','json').sub('{' + 'group_id' + '}', 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 => 'GetOpportunitiesGroupsGroupIdOk')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OpportunitiesApi#get_opportunities_groups_group_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get opportunities groups Return a list of opportunities groups — Alternate route: &#x60;/v1/opportunities/groups/&#x60; Alternate route: &#x60;/legacy/opportunities/groups/&#x60; Alternate route: &#x60;/dev/opportunities/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/opportunities_api.rb', line 107

def get_opportunities_groups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OpportunitiesApi.get_opportunities_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 = "/opportunities/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: OpportunitiesApi#get_opportunities_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get opportunities tasks Return a list of opportunities tasks — Alternate route: ‘/v1/opportunities/tasks/` Alternate route: `/legacy/opportunities/tasks/` Alternate route: `/dev/opportunities/tasks/` — 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>) 


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

def get_opportunities_tasks(opts = {})
  data, _status_code, _headers = get_opportunities_tasks_with_http_info(opts)
  return data
end

#get_opportunities_tasks_task_id(task_id, opts = {}) ⇒ GetOpportunitiesTasksTaskIdOk

Get opportunities task Return information of an opportunities task — Alternate route: ‘/v1/opportunities/tasks/task_id/` Alternate route: `/legacy/opportunities/tasks/task_id/` Alternate route: `/dev/opportunities/tasks/task_id/` — This route expires daily at 11:05

Parameters:

  • task_id —

    ID of an opportunities task

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



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

def get_opportunities_tasks_task_id(task_id, opts = {})
  data, _status_code, _headers = get_opportunities_tasks_task_id_with_http_info(task_id, opts)
  return data
end

#get_opportunities_tasks_task_id_with_http_info(task_id, opts = {}) ⇒ Array<(GetOpportunitiesTasksTaskIdOk, Fixnum, Hash)>

Get opportunities task Return information of an opportunities task — Alternate route: &#x60;/v1/opportunities/tasks/task_id/&#x60; Alternate route: &#x60;/legacy/opportunities/tasks/task_id/&#x60; Alternate route: &#x60;/dev/opportunities/tasks/task_id/&#x60; — This route expires daily at 11:05

Parameters:

  • task_id —

    ID of an opportunities task

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



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/esi-ruby/api/opportunities_api.rb', line 296

def get_opportunities_tasks_task_id_with_http_info(task_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OpportunitiesApi.get_opportunities_tasks_task_id ..."
  end
  # verify the required parameter 'task_id' is set
  fail ArgumentError, "Missing the required parameter 'task_id' when calling OpportunitiesApi.get_opportunities_tasks_task_id" if task_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 = "/opportunities/tasks/{task_id}/".sub('{format}','json').sub('{' + 'task_id' + '}', task_id.to_s)

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

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

Get opportunities tasks Return a list of opportunities tasks — Alternate route: &#x60;/v1/opportunities/tasks/&#x60; Alternate route: &#x60;/legacy/opportunities/tasks/&#x60; Alternate route: &#x60;/dev/opportunities/tasks/&#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



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/opportunities_api.rb', line 235

def get_opportunities_tasks_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OpportunitiesApi.get_opportunities_tasks ..."
  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 = "/opportunities/tasks/".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: OpportunitiesApi#get_opportunities_tasks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end