Class: ESI::UserInterfaceApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UserInterfaceApi 



19
20
21
 
# File 'lib/ruby-esi/api/user_interface_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/ruby-esi/api/user_interface_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#post_ui_autopilot_waypoint(add_to_beginning, clear_other_waypoints, destination_id, opts = {}) ⇒ nil

Set Autopilot Waypoint Set a solar system as autopilot waypoint — Alternate route: ‘/dev/ui/autopilot/waypoint/` Alternate route: `/legacy/ui/autopilot/waypoint/` Alternate route: `/v2/ui/autopilot/waypoint/`

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



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

def post_ui_autopilot_waypoint(add_to_beginning, clear_other_waypoints, destination_id, opts = {})
  post_ui_autopilot_waypoint_with_http_info(add_to_beginning, clear_other_waypoints, destination_id, opts)
  nil
end

#post_ui_autopilot_waypoint_with_http_info(add_to_beginning, clear_other_waypoints, destination_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Set Autopilot Waypoint Set a solar system as autopilot waypoint — Alternate route: &#x60;/dev/ui/autopilot/waypoint/&#x60; Alternate route: &#x60;/legacy/ui/autopilot/waypoint/&#x60; Alternate route: &#x60;/v2/ui/autopilot/waypoint/&#x60;

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



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/ruby-esi/api/user_interface_api.rb', line 45

def post_ui_autopilot_waypoint_with_http_info(add_to_beginning, clear_other_waypoints, destination_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserInterfaceApi.post_ui_autopilot_waypoint ...'
  end
  # verify the required parameter 'add_to_beginning' is set
  if @api_client.config.client_side_validation && add_to_beginning.nil?
    fail ArgumentError, "Missing the required parameter 'add_to_beginning' when calling UserInterfaceApi.post_ui_autopilot_waypoint"
  end
  # verify the required parameter 'clear_other_waypoints' is set
  if @api_client.config.client_side_validation && clear_other_waypoints.nil?
    fail ArgumentError, "Missing the required parameter 'clear_other_waypoints' when calling UserInterfaceApi.post_ui_autopilot_waypoint"
  end
  # verify the required parameter 'destination_id' is set
  if @api_client.config.client_side_validation && destination_id.nil?
    fail ArgumentError, "Missing the required parameter 'destination_id' when calling UserInterfaceApi.post_ui_autopilot_waypoint"
  end
  allowable_values = ["tranquility"]
  if @api_client.config.client_side_validation && opts[:'datasource'] && !allowable_values.include?(opts[:'datasource'])
    fail ArgumentError, "invalid value for \"datasource\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/ui/autopilot/waypoint/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'add_to_beginning'] = add_to_beginning
  query_params[:'clear_other_waypoints'] = clear_other_waypoints
  query_params[:'destination_id'] = destination_id
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"UserInterfaceApi.post_ui_autopilot_waypoint",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserInterfaceApi#post_ui_autopilot_waypoint\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_ui_openwindow_contract(contract_id, opts = {}) ⇒ nil

Open Contract Window Open the contract window inside the client — Alternate route: ‘/dev/ui/openwindow/contract/` Alternate route: `/legacy/ui/openwindow/contract/` Alternate route: `/v1/ui/openwindow/contract/`

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



117
118
119
120
 
# File 'lib/ruby-esi/api/user_interface_api.rb', line 117

def post_ui_openwindow_contract(contract_id, opts = {})
  post_ui_openwindow_contract_with_http_info(contract_id, opts)
  nil
end

#post_ui_openwindow_contract_with_http_info(contract_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Open Contract Window Open the contract window inside the client — Alternate route: &#x60;/dev/ui/openwindow/contract/&#x60; Alternate route: &#x60;/legacy/ui/openwindow/contract/&#x60; Alternate route: &#x60;/v1/ui/openwindow/contract/&#x60;

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



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/ruby-esi/api/user_interface_api.rb', line 129

def post_ui_openwindow_contract_with_http_info(contract_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserInterfaceApi.post_ui_openwindow_contract ...'
  end
  # verify the required parameter 'contract_id' is set
  if @api_client.config.client_side_validation && contract_id.nil?
    fail ArgumentError, "Missing the required parameter 'contract_id' when calling UserInterfaceApi.post_ui_openwindow_contract"
  end
  allowable_values = ["tranquility"]
  if @api_client.config.client_side_validation && opts[:'datasource'] && !allowable_values.include?(opts[:'datasource'])
    fail ArgumentError, "invalid value for \"datasource\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/ui/openwindow/contract/'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"UserInterfaceApi.post_ui_openwindow_contract",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserInterfaceApi#post_ui_openwindow_contract\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_ui_openwindow_information(target_id, opts = {}) ⇒ nil

Open Information Window Open the information window for a character, corporation or alliance inside the client — Alternate route: ‘/dev/ui/openwindow/information/` Alternate route: `/legacy/ui/openwindow/information/` Alternate route: `/v1/ui/openwindow/information/`

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



191
192
193
194
 
# File 'lib/ruby-esi/api/user_interface_api.rb', line 191

def post_ui_openwindow_information(target_id, opts = {})
  post_ui_openwindow_information_with_http_info(target_id, opts)
  nil
end

#post_ui_openwindow_information_with_http_info(target_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Open Information Window Open the information window for a character, corporation or alliance inside the client — Alternate route: &#x60;/dev/ui/openwindow/information/&#x60; Alternate route: &#x60;/legacy/ui/openwindow/information/&#x60; Alternate route: &#x60;/v1/ui/openwindow/information/&#x60;

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



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
249
250
251
252
253
254
255
256
 
# File 'lib/ruby-esi/api/user_interface_api.rb', line 203

def post_ui_openwindow_information_with_http_info(target_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserInterfaceApi.post_ui_openwindow_information ...'
  end
  # verify the required parameter 'target_id' is set
  if @api_client.config.client_side_validation && target_id.nil?
    fail ArgumentError, "Missing the required parameter 'target_id' when calling UserInterfaceApi.post_ui_openwindow_information"
  end
  allowable_values = ["tranquility"]
  if @api_client.config.client_side_validation && opts[:'datasource'] && !allowable_values.include?(opts[:'datasource'])
    fail ArgumentError, "invalid value for \"datasource\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/ui/openwindow/information/'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"UserInterfaceApi.post_ui_openwindow_information",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserInterfaceApi#post_ui_openwindow_information\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_ui_openwindow_marketdetails(type_id, opts = {}) ⇒ nil

Open Market Details Open the market details window for a specific typeID inside the client — Alternate route: ‘/dev/ui/openwindow/marketdetails/` Alternate route: `/legacy/ui/openwindow/marketdetails/` Alternate route: `/v1/ui/openwindow/marketdetails/`

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



265
266
267
268
 
# File 'lib/ruby-esi/api/user_interface_api.rb', line 265

def post_ui_openwindow_marketdetails(type_id, opts = {})
  post_ui_openwindow_marketdetails_with_http_info(type_id, opts)
  nil
end

#post_ui_openwindow_marketdetails_with_http_info(type_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Open Market Details Open the market details window for a specific typeID inside the client — Alternate route: &#x60;/dev/ui/openwindow/marketdetails/&#x60; Alternate route: &#x60;/legacy/ui/openwindow/marketdetails/&#x60; Alternate route: &#x60;/v1/ui/openwindow/marketdetails/&#x60;

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



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
327
328
329
330
 
# File 'lib/ruby-esi/api/user_interface_api.rb', line 277

def post_ui_openwindow_marketdetails_with_http_info(type_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserInterfaceApi.post_ui_openwindow_marketdetails ...'
  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 UserInterfaceApi.post_ui_openwindow_marketdetails"
  end
  allowable_values = ["tranquility"]
  if @api_client.config.client_side_validation && opts[:'datasource'] && !allowable_values.include?(opts[:'datasource'])
    fail ArgumentError, "invalid value for \"datasource\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/ui/openwindow/marketdetails/'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"UserInterfaceApi.post_ui_openwindow_marketdetails",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserInterfaceApi#post_ui_openwindow_marketdetails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_ui_openwindow_newmail(new_mail, opts = {}) ⇒ nil

Open New Mail Window Open the New Mail window, according to settings from the request if applicable — Alternate route: ‘/dev/ui/openwindow/newmail/` Alternate route: `/legacy/ui/openwindow/newmail/` Alternate route: `/v1/ui/openwindow/newmail/`

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



339
340
341
342
 
# File 'lib/ruby-esi/api/user_interface_api.rb', line 339

def post_ui_openwindow_newmail(new_mail, opts = {})
  post_ui_openwindow_newmail_with_http_info(new_mail, opts)
  nil
end

#post_ui_openwindow_newmail_with_http_info(new_mail, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Open New Mail Window Open the New Mail window, according to settings from the request if applicable — Alternate route: &#x60;/dev/ui/openwindow/newmail/&#x60; Alternate route: &#x60;/legacy/ui/openwindow/newmail/&#x60; Alternate route: &#x60;/v1/ui/openwindow/newmail/&#x60;

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



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
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/ruby-esi/api/user_interface_api.rb', line 351

def post_ui_openwindow_newmail_with_http_info(new_mail, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserInterfaceApi.post_ui_openwindow_newmail ...'
  end
  # verify the required parameter 'new_mail' is set
  if @api_client.config.client_side_validation && new_mail.nil?
    fail ArgumentError, "Missing the required parameter 'new_mail' when calling UserInterfaceApi.post_ui_openwindow_newmail"
  end
  allowable_values = ["tranquility"]
  if @api_client.config.client_side_validation && opts[:'datasource'] && !allowable_values.include?(opts[:'datasource'])
    fail ArgumentError, "invalid value for \"datasource\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/ui/openwindow/newmail/'

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

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(new_mail)

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"UserInterfaceApi.post_ui_openwindow_newmail",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserInterfaceApi#post_ui_openwindow_newmail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end