Class: ESI::FleetsApi

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



19
20
21
 
# File 'lib/esi-client-bvv/api/fleets_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/esi-client-bvv/api/fleets_api.rb', line 17

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 —

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

Returns:

  • (nil) 


31
32
33
34
 
# File 'lib/esi-client-bvv/api/fleets_api.rb', line 31

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 —

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

Returns:

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

    nil, response status code and response headers



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

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
  if @api_client.config.client_side_validation && fleet_id.nil?
    fail ArgumentError, "Missing the required parameter 'fleet_id' when calling FleetsApi.delete_fleets_fleet_id_members_member_id"
  end
  # verify the required parameter 'member_id' is set
  if @api_client.config.client_side_validation && member_id.nil?
    fail ArgumentError, "Missing the required parameter 'member_id' when calling FleetsApi.delete_fleets_fleet_id_members_member_id"
  end
  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/v1/fleets/{fleet_id}/members/{member_id}/".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?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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 —

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

Returns:

  • (nil) 


100
101
102
103
 
# File 'lib/esi-client-bvv/api/fleets_api.rb', line 100

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 —

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

Returns:

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

    nil, response status code and response headers



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

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
  if @api_client.config.client_side_validation && fleet_id.nil?
    fail ArgumentError, "Missing the required parameter 'fleet_id' when calling FleetsApi.delete_fleets_fleet_id_squads_squad_id"
  end
  # verify the required parameter 'squad_id' is set
  if @api_client.config.client_side_validation && squad_id.nil?
    fail ArgumentError, "Missing the required parameter 'squad_id' when calling FleetsApi.delete_fleets_fleet_id_squads_squad_id"
  end
  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/v1/fleets/{fleet_id}/squads/{squad_id}/".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?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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 —

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

Returns:

  • (nil) 


169
170
171
172
 
# File 'lib/esi-client-bvv/api/fleets_api.rb', line 169

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 —

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

Returns:

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

    nil, response status code and response headers



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

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
  if @api_client.config.client_side_validation && fleet_id.nil?
    fail ArgumentError, "Missing the required parameter 'fleet_id' when calling FleetsApi.delete_fleets_fleet_id_wings_wing_id"
  end
  # verify the required parameter 'wing_id' is set
  if @api_client.config.client_side_validation && wing_id.nil?
    fail ArgumentError, "Missing the required parameter 'wing_id' when calling FleetsApi.delete_fleets_fleet_id_wings_wing_id"
  end
  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/v1/fleets/{fleet_id}/wings/{wing_id}/".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?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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_characters_character_id_fleet(character_id, opts = {}) ⇒ GetCharactersCharacterIdFleetOk

Get character fleet info Return the fleet ID the character is in, if any. — This route is cached for up to 60 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)

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :token (String) —

    Access token to use if unable to set a header

Returns:



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

def get_characters_character_id_fleet(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_fleet_with_http_info(character_id, opts)
  return data
end

#get_characters_character_id_fleet_with_http_info(character_id, opts = {}) ⇒ Array<(GetCharactersCharacterIdFleetOk, Fixnum, Hash)>

Get character fleet info Return the fleet ID the character is in, if any. — This route is cached for up to 60 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

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :token (String) —

    Access token to use if unable to set a header

Returns:



251
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
294
295
296
297
298
299
 
# File 'lib/esi-client-bvv/api/fleets_api.rb', line 251

def get_characters_character_id_fleet_with_http_info(character_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FleetsApi.get_characters_character_id_fleet ..."
  end
  # verify the required parameter 'character_id' is set
  if @api_client.config.client_side_validation && character_id.nil?
    fail ArgumentError, "Missing the required parameter 'character_id' when calling FleetsApi.get_characters_character_id_fleet"
  end
  if @api_client.config.client_side_validation && character_id < 1
    fail ArgumentError, 'invalid value for "character_id" when calling FleetsApi.get_characters_character_id_fleet, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/v1/characters/{character_id}/fleet/".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?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].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 => 'GetCharactersCharacterIdFleetOk')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FleetsApi#get_characters_character_id_fleet\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 — 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)

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :token (String) —

    Access token to use if unable to set a header

Returns:



309
310
311
312
 
# File 'lib/esi-client-bvv/api/fleets_api.rb', line 309

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 — 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):

  • :accept_language (String) —

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

  • :datasource (String) —

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

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :language (String) —

    Language to use in the response, takes precedence over Accept-Language (default to en-us)

  • :token (String) —

    Access token to use if unable to set a header

Returns:



378
379
380
381
 
# File 'lib/esi-client-bvv/api/fleets_api.rb', line 378

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 — 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):

  • :accept_language (String) —

    Language to use in the response

  • :datasource (String) —

    The server name you would like data from

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :language (String) —

    Language to use in the response, takes precedence over Accept-Language

  • :token (String) —

    Access token to use if unable to set a header

Returns:

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

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



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
438
439
440
441
442
443
444
445
 
# File 'lib/esi-client-bvv/api/fleets_api.rb', line 393

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
  if @api_client.config.client_side_validation && fleet_id.nil?
    fail ArgumentError, "Missing the required parameter 'fleet_id' when calling FleetsApi.get_fleets_fleet_id_members"
  end
  if @api_client.config.client_side_validation && opts[:'accept_language'] && !['de', 'en-us', 'fr', 'ja', 'ru', 'zh'].include?(opts[:'accept_language'])
    fail ArgumentError, 'invalid value for "accept_language", must be one of de, en-us, fr, ja, ru, zh'
  end
  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  if @api_client.config.client_side_validation && 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 = "/v1/fleets/{fleet_id}/members/".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?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil?
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].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 — 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):

  • :accept_language (String) —

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

  • :datasource (String) —

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

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :language (String) —

    Language to use in the response, takes precedence over Accept-Language (default to en-us)

  • :token (String) —

    Access token to use if unable to set a header

Returns:



457
458
459
460
 
# File 'lib/esi-client-bvv/api/fleets_api.rb', line 457

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 — 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):

  • :accept_language (String) —

    Language to use in the response

  • :datasource (String) —

    The server name you would like data from

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :language (String) —

    Language to use in the response, takes precedence over Accept-Language

  • :token (String) —

    Access token to use if unable to set a header

Returns:

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

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



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
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
 
# File 'lib/esi-client-bvv/api/fleets_api.rb', line 472

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
  if @api_client.config.client_side_validation && fleet_id.nil?
    fail ArgumentError, "Missing the required parameter 'fleet_id' when calling FleetsApi.get_fleets_fleet_id_wings"
  end
  if @api_client.config.client_side_validation && opts[:'accept_language'] && !['de', 'en-us', 'fr', 'ja', 'ru', 'zh'].include?(opts[:'accept_language'])
    fail ArgumentError, 'invalid value for "accept_language", must be one of de, en-us, fr, ja, ru, zh'
  end
  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  if @api_client.config.client_side_validation && 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 = "/v1/fleets/{fleet_id}/wings/".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?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil?
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].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 — 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

  • :if_none_match (String) —

    ETag from a previous request. A 304 will be returned if this matches the current ETag

  • :token (String) —

    Access token to use if unable to set a header

Returns:

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

    GetFleetsFleetIdOk data, response status code and response headers



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
366
 
# File 'lib/esi-client-bvv/api/fleets_api.rb', line 322

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
  if @api_client.config.client_side_validation && fleet_id.nil?
    fail ArgumentError, "Missing the required parameter 'fleet_id' when calling FleetsApi.get_fleets_fleet_id"
  end
  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/v1/fleets/{fleet_id}/".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?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].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 —

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

Returns:

  • (nil) 


534
535
536
537
 
# File 'lib/esi-client-bvv/api/fleets_api.rb', line 534

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 —

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

Returns:

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

    nil, response status code and response headers



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
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
 
# File 'lib/esi-client-bvv/api/fleets_api.rb', line 547

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
  if @api_client.config.client_side_validation && fleet_id.nil?
    fail ArgumentError, "Missing the required parameter 'fleet_id' when calling FleetsApi.post_fleets_fleet_id_members"
  end
  # verify the required parameter 'invitation' is set
  if @api_client.config.client_side_validation && invitation.nil?
    fail ArgumentError, "Missing the required parameter 'invitation' when calling FleetsApi.post_fleets_fleet_id_members"
  end
  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/v1/fleets/{fleet_id}/members/".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?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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 —

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

Returns:



602
603
604
605
 
# File 'lib/esi-client-bvv/api/fleets_api.rb', line 602

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 —

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

Returns:



667
668
669
670
 
# File 'lib/esi-client-bvv/api/fleets_api.rb', line 667

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 —

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

Returns:



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
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
 
# File 'lib/esi-client-bvv/api/fleets_api.rb', line 680

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
  if @api_client.config.client_side_validation && fleet_id.nil?
    fail ArgumentError, "Missing the required parameter 'fleet_id' when calling FleetsApi.post_fleets_fleet_id_wings_wing_id_squads"
  end
  # verify the required parameter 'wing_id' is set
  if @api_client.config.client_side_validation && wing_id.nil?
    fail ArgumentError, "Missing the required parameter 'wing_id' when calling FleetsApi.post_fleets_fleet_id_wings_wing_id_squads"
  end
  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/v1/fleets/{fleet_id}/wings/{wing_id}/squads/".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?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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 —

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

Returns:



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
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
 
# File 'lib/esi-client-bvv/api/fleets_api.rb', line 614

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
  if @api_client.config.client_side_validation && fleet_id.nil?
    fail ArgumentError, "Missing the required parameter 'fleet_id' when calling FleetsApi.post_fleets_fleet_id_wings"
  end
  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/v1/fleets/{fleet_id}/wings/".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?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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 —

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

Returns:

  • (nil) 


737
738
739
740
 
# File 'lib/esi-client-bvv/api/fleets_api.rb', line 737

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 —

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

Returns:

  • (nil) 


807
808
809
810
 
# File 'lib/esi-client-bvv/api/fleets_api.rb', line 807

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 —

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

Returns:

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

    nil, response status code and response headers



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
858
859
860
861
862
863
864
865
866
867
868
869
870
871
 
# File 'lib/esi-client-bvv/api/fleets_api.rb', line 821

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
  if @api_client.config.client_side_validation && fleet_id.nil?
    fail ArgumentError, "Missing the required parameter 'fleet_id' when calling FleetsApi.put_fleets_fleet_id_members_member_id"
  end
  # verify the required parameter 'member_id' is set
  if @api_client.config.client_side_validation && member_id.nil?
    fail ArgumentError, "Missing the required parameter 'member_id' when calling FleetsApi.put_fleets_fleet_id_members_member_id"
  end
  # verify the required parameter 'movement' is set
  if @api_client.config.client_side_validation && movement.nil?
    fail ArgumentError, "Missing the required parameter 'movement' when calling FleetsApi.put_fleets_fleet_id_members_member_id"
  end
  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/v1/fleets/{fleet_id}/members/{member_id}/".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?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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 —

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

Returns:

  • (nil) 


882
883
884
885
 
# File 'lib/esi-client-bvv/api/fleets_api.rb', line 882

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 —

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

Returns:

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

    nil, response status code and response headers



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
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
 
# File 'lib/esi-client-bvv/api/fleets_api.rb', line 896

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
  if @api_client.config.client_side_validation && fleet_id.nil?
    fail ArgumentError, "Missing the required parameter 'fleet_id' when calling FleetsApi.put_fleets_fleet_id_squads_squad_id"
  end
  # verify the required parameter 'naming' is set
  if @api_client.config.client_side_validation && naming.nil?
    fail ArgumentError, "Missing the required parameter 'naming' when calling FleetsApi.put_fleets_fleet_id_squads_squad_id"
  end
  # verify the required parameter 'squad_id' is set
  if @api_client.config.client_side_validation && squad_id.nil?
    fail ArgumentError, "Missing the required parameter 'squad_id' when calling FleetsApi.put_fleets_fleet_id_squads_squad_id"
  end
  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/v1/fleets/{fleet_id}/squads/{squad_id}/".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?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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 —

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

Returns:

  • (nil) 


957
958
959
960
 
# File 'lib/esi-client-bvv/api/fleets_api.rb', line 957

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 —

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

Returns:

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

    nil, response status code and response headers



971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
 
# File 'lib/esi-client-bvv/api/fleets_api.rb', line 971

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
  if @api_client.config.client_side_validation && fleet_id.nil?
    fail ArgumentError, "Missing the required parameter 'fleet_id' when calling FleetsApi.put_fleets_fleet_id_wings_wing_id"
  end
  # verify the required parameter 'naming' is set
  if @api_client.config.client_side_validation && naming.nil?
    fail ArgumentError, "Missing the required parameter 'naming' when calling FleetsApi.put_fleets_fleet_id_wings_wing_id"
  end
  # verify the required parameter 'wing_id' is set
  if @api_client.config.client_side_validation && wing_id.nil?
    fail ArgumentError, "Missing the required parameter 'wing_id' when calling FleetsApi.put_fleets_fleet_id_wings_wing_id"
  end
  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/v1/fleets/{fleet_id}/wings/{wing_id}/".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?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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 —

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

Returns:

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

    nil, response status code and response headers



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
785
786
787
788
789
790
791
792
793
794
795
796
 
# File 'lib/esi-client-bvv/api/fleets_api.rb', line 750

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
  if @api_client.config.client_side_validation && fleet_id.nil?
    fail ArgumentError, "Missing the required parameter 'fleet_id' when calling FleetsApi.put_fleets_fleet_id"
  end
  # verify the required parameter 'new_settings' is set
  if @api_client.config.client_side_validation && new_settings.nil?
    fail ArgumentError, "Missing the required parameter 'new_settings' when calling FleetsApi.put_fleets_fleet_id"
  end
  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/v1/fleets/{fleet_id}/".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?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # 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