Class: EsiClient::FleetsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FleetsApi

Returns a new instance of FleetsApi.



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

def api_client
  @api_client
end

Instance Method Details

#delete_fleets_fleet_id_members_member_id(fleet_id, member_id, opts = {}) ⇒ nil

Kick fleet member Kick a fleet member — Alternate route: ‘/v1/fleets/fleet_id/members/member_id/` Alternate route: `/legacy/fleets/fleet_id/members/member_id/` Alternate route: `/dev/fleets/fleet_id/members/member_id/`

Parameters:

  • fleet_id —

    ID for a fleet

  • member_id —

    The character ID of a member in this fleet

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

  • (nil) 


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

def delete_fleets_fleet_id_members_member_id(fleet_id, member_id, opts = {})
  delete_fleets_fleet_id_members_member_id_with_http_info(fleet_id, member_id, opts)
  return nil
end

#delete_fleets_fleet_id_members_member_id_with_http_info(fleet_id, member_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Kick fleet member Kick a fleet member — Alternate route: &#x60;/v1/fleets/fleet_id/members/member_id/&#x60; Alternate route: &#x60;/legacy/fleets/fleet_id/members/member_id/&#x60; Alternate route: &#x60;/dev/fleets/fleet_id/members/member_id/&#x60;

Parameters:

  • fleet_id —

    ID for a fleet

  • member_id —

    The character ID of a member in this fleet

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

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

    nil, response status code and response headers



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

def delete_fleets_fleet_id_members_member_id_with_http_info(fleet_id, member_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FleetsApi.delete_fleets_fleet_id_members_member_id ..."
  end
  # verify the required parameter 'fleet_id' is set
  fail ArgumentError, "Missing the required parameter 'fleet_id' when calling FleetsApi.delete_fleets_fleet_id_members_member_id" if fleet_id.nil?
  # verify the required parameter 'member_id' is set
  fail ArgumentError, "Missing the required parameter 'member_id' when calling FleetsApi.delete_fleets_fleet_id_members_member_id" if member_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 = "/fleets/{fleet_id}/members/{member_id}/".sub('{format}','json').sub('{' + 'fleet_id' + '}', fleet_id.to_s).sub('{' + 'member_id' + '}', member_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(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FleetsApi#delete_fleets_fleet_id_members_member_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_fleets_fleet_id_squads_squad_id(fleet_id, squad_id, opts = {}) ⇒ nil

Delete fleet squad Delete a fleet squad, only empty squads can be deleted — Alternate route: ‘/v1/fleets/fleet_id/squads/squad_id/` Alternate route: `/legacy/fleets/fleet_id/squads/squad_id/` Alternate route: `/dev/fleets/fleet_id/squads/squad_id/`

Parameters:

  • fleet_id —

    ID for a fleet

  • squad_id —

    The squad to delete

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

  • (nil) 


101
102
103
104
 
# File 'lib/esi-ruby/api/fleets_api.rb', line 101

def delete_fleets_fleet_id_squads_squad_id(fleet_id, squad_id, opts = {})
  delete_fleets_fleet_id_squads_squad_id_with_http_info(fleet_id, squad_id, opts)
  return nil
end

#delete_fleets_fleet_id_squads_squad_id_with_http_info(fleet_id, squad_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete fleet squad Delete a fleet squad, only empty squads can be deleted — Alternate route: &#x60;/v1/fleets/fleet_id/squads/squad_id/&#x60; Alternate route: &#x60;/legacy/fleets/fleet_id/squads/squad_id/&#x60; Alternate route: &#x60;/dev/fleets/fleet_id/squads/squad_id/&#x60;

Parameters:

  • fleet_id —

    ID for a fleet

  • squad_id —

    The squad to delete

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

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

    nil, response status code and response headers



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
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/esi-ruby/api/fleets_api.rb', line 116

def delete_fleets_fleet_id_squads_squad_id_with_http_info(fleet_id, squad_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FleetsApi.delete_fleets_fleet_id_squads_squad_id ..."
  end
  # verify the required parameter 'fleet_id' is set
  fail ArgumentError, "Missing the required parameter 'fleet_id' when calling FleetsApi.delete_fleets_fleet_id_squads_squad_id" if fleet_id.nil?
  # verify the required parameter 'squad_id' is set
  fail ArgumentError, "Missing the required parameter 'squad_id' when calling FleetsApi.delete_fleets_fleet_id_squads_squad_id" if squad_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 = "/fleets/{fleet_id}/squads/{squad_id}/".sub('{format}','json').sub('{' + 'fleet_id' + '}', fleet_id.to_s).sub('{' + 'squad_id' + '}', squad_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(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FleetsApi#delete_fleets_fleet_id_squads_squad_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_fleets_fleet_id_wings_wing_id(fleet_id, wing_id, opts = {}) ⇒ nil

Delete fleet wing Delete a fleet wing, only empty wings can be deleted. The wing may contain squads, but the squads must be empty — Alternate route: ‘/v1/fleets/fleet_id/wings/wing_id/` Alternate route: `/legacy/fleets/fleet_id/wings/wing_id/` Alternate route: `/dev/fleets/fleet_id/wings/wing_id/`

Parameters:

  • fleet_id —

    ID for a fleet

  • wing_id —

    The wing to delete

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

  • (nil) 


170
171
172
173
 
# File 'lib/esi-ruby/api/fleets_api.rb', line 170

def delete_fleets_fleet_id_wings_wing_id(fleet_id, wing_id, opts = {})
  delete_fleets_fleet_id_wings_wing_id_with_http_info(fleet_id, wing_id, opts)
  return nil
end

#delete_fleets_fleet_id_wings_wing_id_with_http_info(fleet_id, wing_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete fleet wing Delete a fleet wing, only empty wings can be deleted. The wing may contain squads, but the squads must be empty — Alternate route: &#x60;/v1/fleets/fleet_id/wings/wing_id/&#x60; Alternate route: &#x60;/legacy/fleets/fleet_id/wings/wing_id/&#x60; Alternate route: &#x60;/dev/fleets/fleet_id/wings/wing_id/&#x60;

Parameters:

  • fleet_id —

    ID for a fleet

  • wing_id —

    The wing to delete

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

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

    nil, response status code and response headers



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
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/esi-ruby/api/fleets_api.rb', line 185

def delete_fleets_fleet_id_wings_wing_id_with_http_info(fleet_id, wing_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FleetsApi.delete_fleets_fleet_id_wings_wing_id ..."
  end
  # verify the required parameter 'fleet_id' is set
  fail ArgumentError, "Missing the required parameter 'fleet_id' when calling FleetsApi.delete_fleets_fleet_id_wings_wing_id" if fleet_id.nil?
  # verify the required parameter 'wing_id' is set
  fail ArgumentError, "Missing the required parameter 'wing_id' when calling FleetsApi.delete_fleets_fleet_id_wings_wing_id" if wing_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 = "/fleets/{fleet_id}/wings/{wing_id}/".sub('{format}','json').sub('{' + 'fleet_id' + '}', fleet_id.to_s).sub('{' + 'wing_id' + '}', wing_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(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FleetsApi#delete_fleets_fleet_id_wings_wing_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_fleets_fleet_id(fleet_id, opts = {}) ⇒ GetFleetsFleetIdOk

Get fleet information Return details about a fleet — Alternate route: ‘/v1/fleets/fleet_id/` Alternate route: `/legacy/fleets/fleet_id/` Alternate route: `/dev/fleets/fleet_id/` — This route is cached for up to 5 seconds

Parameters:

  • fleet_id —

    ID for a fleet

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



238
239
240
241
 
# File 'lib/esi-ruby/api/fleets_api.rb', line 238

def get_fleets_fleet_id(fleet_id, opts = {})
  data, _status_code, _headers = get_fleets_fleet_id_with_http_info(fleet_id, opts)
  return data
end

#get_fleets_fleet_id_members(fleet_id, opts = {}) ⇒ Array<GetFleetsFleetIdMembers200Ok>

Get fleet members Return information about fleet members — Alternate route: ‘/v1/fleets/fleet_id/members/` Alternate route: `/legacy/fleets/fleet_id/members/` Alternate route: `/dev/fleets/fleet_id/members/` — This route is cached for up to 5 seconds

Parameters:

  • fleet_id —

    ID for a fleet

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

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



305
306
307
308
 
# File 'lib/esi-ruby/api/fleets_api.rb', line 305

def get_fleets_fleet_id_members(fleet_id, opts = {})
  data, _status_code, _headers = get_fleets_fleet_id_members_with_http_info(fleet_id, opts)
  return data
end

#get_fleets_fleet_id_members_with_http_info(fleet_id, opts = {}) ⇒ Array<(Array<GetFleetsFleetIdMembers200Ok>, Fixnum, Hash)>

Get fleet members Return information about fleet members — Alternate route: &#x60;/v1/fleets/fleet_id/members/&#x60; Alternate route: &#x60;/legacy/fleets/fleet_id/members/&#x60; Alternate route: &#x60;/dev/fleets/fleet_id/members/&#x60; — This route is cached for up to 5 seconds

Parameters:

  • fleet_id —

    ID for a fleet

  • 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

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

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

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



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/esi-ruby/api/fleets_api.rb', line 320

def get_fleets_fleet_id_members_with_http_info(fleet_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FleetsApi.get_fleets_fleet_id_members ..."
  end
  # verify the required parameter 'fleet_id' is set
  fail ArgumentError, "Missing the required parameter 'fleet_id' when calling FleetsApi.get_fleets_fleet_id_members" if fleet_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 = "/fleets/{fleet_id}/members/".sub('{format}','json').sub('{' + 'fleet_id' + '}', fleet_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[:'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<GetFleetsFleetIdMembers200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FleetsApi#get_fleets_fleet_id_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_fleets_fleet_id_wings(fleet_id, opts = {}) ⇒ Array<GetFleetsFleetIdWings200Ok>

Get fleet wings Return information about wings in a fleet — Alternate route: ‘/v1/fleets/fleet_id/wings/` Alternate route: `/legacy/fleets/fleet_id/wings/` Alternate route: `/dev/fleets/fleet_id/wings/` — This route is cached for up to 5 seconds

Parameters:

  • fleet_id —

    ID for a fleet

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

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



377
378
379
380
 
# File 'lib/esi-ruby/api/fleets_api.rb', line 377

def get_fleets_fleet_id_wings(fleet_id, opts = {})
  data, _status_code, _headers = get_fleets_fleet_id_wings_with_http_info(fleet_id, opts)
  return data
end

#get_fleets_fleet_id_wings_with_http_info(fleet_id, opts = {}) ⇒ Array<(Array<GetFleetsFleetIdWings200Ok>, Fixnum, Hash)>

Get fleet wings Return information about wings in a fleet — Alternate route: &#x60;/v1/fleets/fleet_id/wings/&#x60; Alternate route: &#x60;/legacy/fleets/fleet_id/wings/&#x60; Alternate route: &#x60;/dev/fleets/fleet_id/wings/&#x60; — This route is cached for up to 5 seconds

Parameters:

  • fleet_id —

    ID for a fleet

  • 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

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

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

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



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
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/esi-ruby/api/fleets_api.rb', line 392

def get_fleets_fleet_id_wings_with_http_info(fleet_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FleetsApi.get_fleets_fleet_id_wings ..."
  end
  # verify the required parameter 'fleet_id' is set
  fail ArgumentError, "Missing the required parameter 'fleet_id' when calling FleetsApi.get_fleets_fleet_id_wings" if fleet_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 = "/fleets/{fleet_id}/wings/".sub('{format}','json').sub('{' + 'fleet_id' + '}', fleet_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[:'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<GetFleetsFleetIdWings200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FleetsApi#get_fleets_fleet_id_wings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_fleets_fleet_id_with_http_info(fleet_id, opts = {}) ⇒ Array<(GetFleetsFleetIdOk, Fixnum, Hash)>

Get fleet information Return details about a fleet — Alternate route: &#x60;/v1/fleets/fleet_id/&#x60; Alternate route: &#x60;/legacy/fleets/fleet_id/&#x60; Alternate route: &#x60;/dev/fleets/fleet_id/&#x60; — This route is cached for up to 5 seconds

Parameters:

  • fleet_id —

    ID for a fleet

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

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

    GetFleetsFleetIdOk data, response status code and response headers



252
253
254
255
256
257
258
259
260
261
262
263
264
265
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
 
# File 'lib/esi-ruby/api/fleets_api.rb', line 252

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

#post_fleets_fleet_id_members(fleet_id, invitation, opts = {}) ⇒ nil

Create fleet invitation Invite a character into the fleet, if a character has a CSPA charge set, it is not possible to invite them to the fleet using ESI — Alternate route: ‘/v1/fleets/fleet_id/members/` Alternate route: `/legacy/fleets/fleet_id/members/` Alternate route: `/dev/fleets/fleet_id/members/`

Parameters:

  • fleet_id —

    ID for a fleet

  • invitation —

    Details of the invitation

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

  • (nil) 


449
450
451
452
 
# File 'lib/esi-ruby/api/fleets_api.rb', line 449

def post_fleets_fleet_id_members(fleet_id, invitation, opts = {})
  post_fleets_fleet_id_members_with_http_info(fleet_id, invitation, opts)
  return nil
end

#post_fleets_fleet_id_members_with_http_info(fleet_id, invitation, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Create fleet invitation Invite a character into the fleet, if a character has a CSPA charge set, it is not possible to invite them to the fleet using ESI — Alternate route: &#x60;/v1/fleets/fleet_id/members/&#x60; Alternate route: &#x60;/legacy/fleets/fleet_id/members/&#x60; Alternate route: &#x60;/dev/fleets/fleet_id/members/&#x60;

Parameters:

  • fleet_id —

    ID for a fleet

  • invitation —

    Details of the invitation

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

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

    nil, response status code and response headers



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
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/esi-ruby/api/fleets_api.rb', line 464

def post_fleets_fleet_id_members_with_http_info(fleet_id, invitation, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FleetsApi.post_fleets_fleet_id_members ..."
  end
  # verify the required parameter 'fleet_id' is set
  fail ArgumentError, "Missing the required parameter 'fleet_id' when calling FleetsApi.post_fleets_fleet_id_members" if fleet_id.nil?
  # verify the required parameter 'invitation' is set
  fail ArgumentError, "Missing the required parameter 'invitation' when calling FleetsApi.post_fleets_fleet_id_members" if invitation.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 = "/fleets/{fleet_id}/members/".sub('{format}','json').sub('{' + 'fleet_id' + '}', fleet_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 = @api_client.object_to_http_body(invitation)
  auth_names = ['evesso']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FleetsApi#post_fleets_fleet_id_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_fleets_fleet_id_wings(fleet_id, opts = {}) ⇒ PostFleetsFleetIdWingsCreated

Create fleet wing Create a new wing in a fleet — Alternate route: ‘/v1/fleets/fleet_id/wings/` Alternate route: `/legacy/fleets/fleet_id/wings/` Alternate route: `/dev/fleets/fleet_id/wings/`

Parameters:

  • fleet_id —

    ID for a fleet

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



517
518
519
520
 
# File 'lib/esi-ruby/api/fleets_api.rb', line 517

def post_fleets_fleet_id_wings(fleet_id, opts = {})
  data, _status_code, _headers = post_fleets_fleet_id_wings_with_http_info(fleet_id, opts)
  return data
end

#post_fleets_fleet_id_wings_wing_id_squads(fleet_id, wing_id, opts = {}) ⇒ PostFleetsFleetIdWingsWingIdSquadsCreated

Create fleet squad Create a new squad in a fleet — Alternate route: ‘/v1/fleets/fleet_id/wings/wing_id/squads/` Alternate route: `/legacy/fleets/fleet_id/wings/wing_id/squads/` Alternate route: `/dev/fleets/fleet_id/wings/wing_id/squads/`

Parameters:

  • fleet_id —

    ID for a fleet

  • wing_id —

    The wing_id to create squad in

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



584
585
586
587
 
# File 'lib/esi-ruby/api/fleets_api.rb', line 584

def post_fleets_fleet_id_wings_wing_id_squads(fleet_id, wing_id, opts = {})
  data, _status_code, _headers = post_fleets_fleet_id_wings_wing_id_squads_with_http_info(fleet_id, wing_id, opts)
  return data
end

#post_fleets_fleet_id_wings_wing_id_squads_with_http_info(fleet_id, wing_id, opts = {}) ⇒ Array<(PostFleetsFleetIdWingsWingIdSquadsCreated, Fixnum, Hash)>

Create fleet squad Create a new squad in a fleet — Alternate route: &#x60;/v1/fleets/fleet_id/wings/wing_id/squads/&#x60; Alternate route: &#x60;/legacy/fleets/fleet_id/wings/wing_id/squads/&#x60; Alternate route: &#x60;/dev/fleets/fleet_id/wings/wing_id/squads/&#x60;

Parameters:

  • fleet_id —

    ID for a fleet

  • wing_id —

    The wing_id to create squad in

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



599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
 
# File 'lib/esi-ruby/api/fleets_api.rb', line 599

def post_fleets_fleet_id_wings_wing_id_squads_with_http_info(fleet_id, wing_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FleetsApi.post_fleets_fleet_id_wings_wing_id_squads ..."
  end
  # verify the required parameter 'fleet_id' is set
  fail ArgumentError, "Missing the required parameter 'fleet_id' when calling FleetsApi.post_fleets_fleet_id_wings_wing_id_squads" if fleet_id.nil?
  # verify the required parameter 'wing_id' is set
  fail ArgumentError, "Missing the required parameter 'wing_id' when calling FleetsApi.post_fleets_fleet_id_wings_wing_id_squads" if wing_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 = "/fleets/{fleet_id}/wings/{wing_id}/squads/".sub('{format}','json').sub('{' + 'fleet_id' + '}', fleet_id.to_s).sub('{' + 'wing_id' + '}', wing_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(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PostFleetsFleetIdWingsWingIdSquadsCreated')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FleetsApi#post_fleets_fleet_id_wings_wing_id_squads\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_fleets_fleet_id_wings_with_http_info(fleet_id, opts = {}) ⇒ Array<(PostFleetsFleetIdWingsCreated, Fixnum, Hash)>

Create fleet wing Create a new wing in a fleet — Alternate route: &#x60;/v1/fleets/fleet_id/wings/&#x60; Alternate route: &#x60;/legacy/fleets/fleet_id/wings/&#x60; Alternate route: &#x60;/dev/fleets/fleet_id/wings/&#x60;

Parameters:

  • fleet_id —

    ID for a fleet

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



531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
 
# File 'lib/esi-ruby/api/fleets_api.rb', line 531

def post_fleets_fleet_id_wings_with_http_info(fleet_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FleetsApi.post_fleets_fleet_id_wings ..."
  end
  # verify the required parameter 'fleet_id' is set
  fail ArgumentError, "Missing the required parameter 'fleet_id' when calling FleetsApi.post_fleets_fleet_id_wings" if fleet_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 = "/fleets/{fleet_id}/wings/".sub('{format}','json').sub('{' + 'fleet_id' + '}', fleet_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(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'PostFleetsFleetIdWingsCreated')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FleetsApi#post_fleets_fleet_id_wings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_fleets_fleet_id(fleet_id, new_settings, opts = {}) ⇒ nil

Update fleet Update settings about a fleet — Alternate route: ‘/v1/fleets/fleet_id/` Alternate route: `/legacy/fleets/fleet_id/` Alternate route: `/dev/fleets/fleet_id/`

Parameters:

  • fleet_id —

    ID for a fleet

  • new_settings —

    What to update for this fleet

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

  • (nil) 


654
655
656
657
 
# File 'lib/esi-ruby/api/fleets_api.rb', line 654

def put_fleets_fleet_id(fleet_id, new_settings, opts = {})
  put_fleets_fleet_id_with_http_info(fleet_id, new_settings, opts)
  return nil
end

#put_fleets_fleet_id_members_member_id(fleet_id, member_id, movement, opts = {}) ⇒ nil

Move fleet member Move a fleet member around — Alternate route: ‘/v1/fleets/fleet_id/members/member_id/` Alternate route: `/legacy/fleets/fleet_id/members/member_id/` Alternate route: `/dev/fleets/fleet_id/members/member_id/`

Parameters:

  • fleet_id —

    ID for a fleet

  • member_id —

    The character ID of a member in this fleet

  • movement —

    Details of the invitation

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

  • (nil) 


724
725
726
727
 
# File 'lib/esi-ruby/api/fleets_api.rb', line 724

def put_fleets_fleet_id_members_member_id(fleet_id, member_id, movement, opts = {})
  put_fleets_fleet_id_members_member_id_with_http_info(fleet_id, member_id, movement, opts)
  return nil
end

#put_fleets_fleet_id_members_member_id_with_http_info(fleet_id, member_id, movement, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Move fleet member Move a fleet member around — Alternate route: &#x60;/v1/fleets/fleet_id/members/member_id/&#x60; Alternate route: &#x60;/legacy/fleets/fleet_id/members/member_id/&#x60; Alternate route: &#x60;/dev/fleets/fleet_id/members/member_id/&#x60;

Parameters:

  • fleet_id —

    ID for a fleet

  • member_id —

    The character ID of a member in this fleet

  • movement —

    Details of the invitation

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

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

    nil, response status code and response headers



740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
 
# File 'lib/esi-ruby/api/fleets_api.rb', line 740

def put_fleets_fleet_id_members_member_id_with_http_info(fleet_id, member_id, movement, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FleetsApi.put_fleets_fleet_id_members_member_id ..."
  end
  # verify the required parameter 'fleet_id' is set
  fail ArgumentError, "Missing the required parameter 'fleet_id' when calling FleetsApi.put_fleets_fleet_id_members_member_id" if fleet_id.nil?
  # verify the required parameter 'member_id' is set
  fail ArgumentError, "Missing the required parameter 'member_id' when calling FleetsApi.put_fleets_fleet_id_members_member_id" if member_id.nil?
  # verify the required parameter 'movement' is set
  fail ArgumentError, "Missing the required parameter 'movement' when calling FleetsApi.put_fleets_fleet_id_members_member_id" if movement.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 = "/fleets/{fleet_id}/members/{member_id}/".sub('{format}','json').sub('{' + 'fleet_id' + '}', fleet_id.to_s).sub('{' + 'member_id' + '}', member_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 = @api_client.object_to_http_body(movement)
  auth_names = ['evesso']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FleetsApi#put_fleets_fleet_id_members_member_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_fleets_fleet_id_squads_squad_id(fleet_id, naming, squad_id, opts = {}) ⇒ nil

Rename fleet squad Rename a fleet squad — Alternate route: ‘/v1/fleets/fleet_id/squads/squad_id/` Alternate route: `/legacy/fleets/fleet_id/squads/squad_id/` Alternate route: `/dev/fleets/fleet_id/squads/squad_id/`

Parameters:

  • fleet_id —

    ID for a fleet

  • naming —

    New name of the squad

  • squad_id —

    The squad to rename

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

  • (nil) 


797
798
799
800
 
# File 'lib/esi-ruby/api/fleets_api.rb', line 797

def put_fleets_fleet_id_squads_squad_id(fleet_id, naming, squad_id, opts = {})
  put_fleets_fleet_id_squads_squad_id_with_http_info(fleet_id, naming, squad_id, opts)
  return nil
end

#put_fleets_fleet_id_squads_squad_id_with_http_info(fleet_id, naming, squad_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Rename fleet squad Rename a fleet squad — Alternate route: &#x60;/v1/fleets/fleet_id/squads/squad_id/&#x60; Alternate route: &#x60;/legacy/fleets/fleet_id/squads/squad_id/&#x60; Alternate route: &#x60;/dev/fleets/fleet_id/squads/squad_id/&#x60;

Parameters:

  • fleet_id —

    ID for a fleet

  • naming —

    New name of the squad

  • squad_id —

    The squad to rename

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

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

    nil, response status code and response headers



813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
 
# File 'lib/esi-ruby/api/fleets_api.rb', line 813

def put_fleets_fleet_id_squads_squad_id_with_http_info(fleet_id, naming, squad_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FleetsApi.put_fleets_fleet_id_squads_squad_id ..."
  end
  # verify the required parameter 'fleet_id' is set
  fail ArgumentError, "Missing the required parameter 'fleet_id' when calling FleetsApi.put_fleets_fleet_id_squads_squad_id" if fleet_id.nil?
  # verify the required parameter 'naming' is set
  fail ArgumentError, "Missing the required parameter 'naming' when calling FleetsApi.put_fleets_fleet_id_squads_squad_id" if naming.nil?
  # verify the required parameter 'squad_id' is set
  fail ArgumentError, "Missing the required parameter 'squad_id' when calling FleetsApi.put_fleets_fleet_id_squads_squad_id" if squad_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 = "/fleets/{fleet_id}/squads/{squad_id}/".sub('{format}','json').sub('{' + 'fleet_id' + '}', fleet_id.to_s).sub('{' + 'squad_id' + '}', squad_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 = @api_client.object_to_http_body(naming)
  auth_names = ['evesso']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FleetsApi#put_fleets_fleet_id_squads_squad_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_fleets_fleet_id_wings_wing_id(fleet_id, naming, wing_id, opts = {}) ⇒ nil

Rename fleet wing Rename a fleet wing — Alternate route: ‘/v1/fleets/fleet_id/wings/wing_id/` Alternate route: `/legacy/fleets/fleet_id/wings/wing_id/` Alternate route: `/dev/fleets/fleet_id/wings/wing_id/`

Parameters:

  • fleet_id —

    ID for a fleet

  • naming —

    New name of the wing

  • wing_id —

    The wing to rename

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

  • (nil) 


870
871
872
873
 
# File 'lib/esi-ruby/api/fleets_api.rb', line 870

def put_fleets_fleet_id_wings_wing_id(fleet_id, naming, wing_id, opts = {})
  put_fleets_fleet_id_wings_wing_id_with_http_info(fleet_id, naming, wing_id, opts)
  return nil
end

#put_fleets_fleet_id_wings_wing_id_with_http_info(fleet_id, naming, wing_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Rename fleet wing Rename a fleet wing — Alternate route: &#x60;/v1/fleets/fleet_id/wings/wing_id/&#x60; Alternate route: &#x60;/legacy/fleets/fleet_id/wings/wing_id/&#x60; Alternate route: &#x60;/dev/fleets/fleet_id/wings/wing_id/&#x60;

Parameters:

  • fleet_id —

    ID for a fleet

  • naming —

    New name of the wing

  • wing_id —

    The wing to rename

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

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

    nil, response status code and response headers



886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
 
# File 'lib/esi-ruby/api/fleets_api.rb', line 886

def put_fleets_fleet_id_wings_wing_id_with_http_info(fleet_id, naming, wing_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FleetsApi.put_fleets_fleet_id_wings_wing_id ..."
  end
  # verify the required parameter 'fleet_id' is set
  fail ArgumentError, "Missing the required parameter 'fleet_id' when calling FleetsApi.put_fleets_fleet_id_wings_wing_id" if fleet_id.nil?
  # verify the required parameter 'naming' is set
  fail ArgumentError, "Missing the required parameter 'naming' when calling FleetsApi.put_fleets_fleet_id_wings_wing_id" if naming.nil?
  # verify the required parameter 'wing_id' is set
  fail ArgumentError, "Missing the required parameter 'wing_id' when calling FleetsApi.put_fleets_fleet_id_wings_wing_id" if wing_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 = "/fleets/{fleet_id}/wings/{wing_id}/".sub('{format}','json').sub('{' + 'fleet_id' + '}', fleet_id.to_s).sub('{' + 'wing_id' + '}', wing_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 = @api_client.object_to_http_body(naming)
  auth_names = ['evesso']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FleetsApi#put_fleets_fleet_id_wings_wing_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_fleets_fleet_id_with_http_info(fleet_id, new_settings, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update fleet Update settings about a fleet — Alternate route: &#x60;/v1/fleets/fleet_id/&#x60; Alternate route: &#x60;/legacy/fleets/fleet_id/&#x60; Alternate route: &#x60;/dev/fleets/fleet_id/&#x60;

Parameters:

  • fleet_id —

    ID for a fleet

  • new_settings —

    What to update for this fleet

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

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

    nil, response status code and response headers



669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'lib/esi-ruby/api/fleets_api.rb', line 669

def put_fleets_fleet_id_with_http_info(fleet_id, new_settings, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FleetsApi.put_fleets_fleet_id ..."
  end
  # verify the required parameter 'fleet_id' is set
  fail ArgumentError, "Missing the required parameter 'fleet_id' when calling FleetsApi.put_fleets_fleet_id" if fleet_id.nil?
  # verify the required parameter 'new_settings' is set
  fail ArgumentError, "Missing the required parameter 'new_settings' when calling FleetsApi.put_fleets_fleet_id" if new_settings.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 = "/fleets/{fleet_id}/".sub('{format}','json').sub('{' + 'fleet_id' + '}', fleet_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 = @api_client.object_to_http_body(new_settings)
  auth_names = ['evesso']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FleetsApi#put_fleets_fleet_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end