Class: ESIClient::AssetsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AssetsApi

Returns a new instance of AssetsApi.



19
20
21
 
# File 'lib/esi_client/api/assets_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/esi_client/api/assets_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_characters_character_id_assets(character_id, opts = {}) ⇒ Array<GetCharactersCharacterIdAssets200Ok>

Get character assets Return a list of the characters assets — This route is cached for up to 3600 seconds

Parameters:

  • character_id —

    An EVE character ID

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

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

  • :page (Integer) —

    Which page of results to return (default to 1)

  • :token (String) —

    Access token to use if unable to set a header

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:



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

def get_characters_character_id_assets(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_assets_with_http_info(character_id, opts)
  data
end

#get_characters_character_id_assets_with_http_info(character_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdAssets200Ok>, Fixnum, Hash)>

Get character assets Return a list of the characters assets — This route is cached for up to 3600 seconds

Parameters:

  • character_id —

    An EVE character ID

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :page (Integer) —

    Which page of results to return

  • :token (String) —

    Access token to use if unable to set a header

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/esi_client/api/assets_api.rb', line 47

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

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['evesso']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<GetCharactersCharacterIdAssets200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AssetsApi#get_characters_character_id_assets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_corporations_corporation_id_assets(corporation_id, opts = {}) ⇒ Array<GetCorporationsCorporationIdAssets200Ok>

Get corporation assets Return a list of the corporation assets — This route is cached for up to 3600 seconds — Requires one of the following EVE corporation role(s): Director — [This route has an available update](esi.tech.ccp.is/diff/latest/dev/#GET-/corporations/corporation_id/assets/)

Parameters:

  • corporation_id —

    An EVE corporation ID

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

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

  • :page (Integer) —

    Which page of results to return (default to 1)

  • :token (String) —

    Access token to use if unable to set a header

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:



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

def get_corporations_corporation_id_assets(corporation_id, opts = {})
  data, _status_code, _headers = get_corporations_corporation_id_assets_with_http_info(corporation_id, opts)
  data
end

#get_corporations_corporation_id_assets_with_http_info(corporation_id, opts = {}) ⇒ Array<(Array<GetCorporationsCorporationIdAssets200Ok>, Fixnum, Hash)>

Get corporation assets Return a list of the corporation assets — This route is cached for up to 3600 seconds — Requires one of the following EVE corporation role(s): Director — [This route has an available update](esi.tech.ccp.is/diff/latest/dev/#GET-/corporations/corporation_id/assets/)

Parameters:

  • corporation_id —

    An EVE corporation ID

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :page (Integer) —

    Which page of results to return

  • :token (String) —

    Access token to use if unable to set a header

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/esi_client/api/assets_api.rb', line 121

def get_corporations_corporation_id_assets_with_http_info(corporation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssetsApi.get_corporations_corporation_id_assets ...'
  end
  # verify the required parameter 'corporation_id' is set
  if @api_client.config.client_side_validation && corporation_id.nil?
    fail ArgumentError, "Missing the required parameter 'corporation_id' when calling AssetsApi.get_corporations_corporation_id_assets"
  end
  if @api_client.config.client_side_validation && corporation_id < 1
    fail ArgumentError, 'invalid value for "corporation_id" when calling AssetsApi.get_corporations_corporation_id_assets, 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 = '/v2/corporations/{corporation_id}/assets/'.sub('{' + 'corporation_id' + '}', corporation_id.to_s)

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['evesso']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<GetCorporationsCorporationIdAssets200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AssetsApi#get_corporations_corporation_id_assets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_characters_character_id_assets_locations(character_id, item_ids, opts = {}) ⇒ Array<PostCharactersCharacterIdAssetsLocations200Ok>

Get character asset locations Return locations for a set of item ids, which you can get from character assets endpoint. Coordinates for items in hangars or stations are set to (0,0,0) —

Parameters:

  • character_id —

    An EVE character ID

  • item_ids —

    A list of item ids

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



180
181
182
183
 
# File 'lib/esi_client/api/assets_api.rb', line 180

def post_characters_character_id_assets_locations(character_id, item_ids, opts = {})
  data, _status_code, _headers = post_characters_character_id_assets_locations_with_http_info(character_id, item_ids, opts)
  data
end

#post_characters_character_id_assets_locations_with_http_info(character_id, item_ids, opts = {}) ⇒ Array<(Array<PostCharactersCharacterIdAssetsLocations200Ok>, Fixnum, Hash)>

Get character asset locations Return locations for a set of item ids, which you can get from character assets endpoint. Coordinates for items in hangars or stations are set to (0,0,0) —

Parameters:

  • character_id —

    An EVE character ID

  • item_ids —

    A list of item ids

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



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

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

  # verify the required parameter 'item_ids' is set
  if @api_client.config.client_side_validation && item_ids.nil?
    fail ArgumentError, "Missing the required parameter 'item_ids' when calling AssetsApi.post_characters_character_id_assets_locations"
  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 = '/v2/characters/{character_id}/assets/locations/'.sub('{' + 'character_id' + '}', character_id.to_s)

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(item_ids)
  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 => 'Array<PostCharactersCharacterIdAssetsLocations200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AssetsApi#post_characters_character_id_assets_locations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_characters_character_id_assets_names(character_id, item_ids, opts = {}) ⇒ Array<PostCharactersCharacterIdAssetsNames200Ok>

Get character asset names Return names for a set of item ids, which you can get from character assets endpoint. Typically used for items that can customize names, like containers or ships. —

Parameters:

  • character_id —

    An EVE character ID

  • item_ids —

    A list of item ids

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



257
258
259
260
 
# File 'lib/esi_client/api/assets_api.rb', line 257

def post_characters_character_id_assets_names(character_id, item_ids, opts = {})
  data, _status_code, _headers = post_characters_character_id_assets_names_with_http_info(character_id, item_ids, opts)
  data
end

#post_characters_character_id_assets_names_with_http_info(character_id, item_ids, opts = {}) ⇒ Array<(Array<PostCharactersCharacterIdAssetsNames200Ok>, Fixnum, Hash)>

Get character asset names Return names for a set of item ids, which you can get from character assets endpoint. Typically used for items that can customize names, like containers or ships. —

Parameters:

  • character_id —

    An EVE character ID

  • item_ids —

    A list of item ids

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



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/esi_client/api/assets_api.rb', line 272

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

  # verify the required parameter 'item_ids' is set
  if @api_client.config.client_side_validation && item_ids.nil?
    fail ArgumentError, "Missing the required parameter 'item_ids' when calling AssetsApi.post_characters_character_id_assets_names"
  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}/assets/names/'.sub('{' + 'character_id' + '}', character_id.to_s)

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(item_ids)
  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 => 'Array<PostCharactersCharacterIdAssetsNames200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AssetsApi#post_characters_character_id_assets_names\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_corporations_corporation_id_assets_locations(corporation_id, item_ids, opts = {}) ⇒ Array<PostCorporationsCorporationIdAssetsLocations200Ok>

Get corporation asset locations Return locations for a set of item ids, which you can get from corporation assets endpoint. Coordinates for items in hangars or stations are set to (0,0,0) — Requires one of the following EVE corporation role(s): Director

Parameters:

  • corporation_id —

    An EVE corporation ID

  • item_ids —

    A list of item ids

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



334
335
336
337
 
# File 'lib/esi_client/api/assets_api.rb', line 334

def post_corporations_corporation_id_assets_locations(corporation_id, item_ids, opts = {})
  data, _status_code, _headers = post_corporations_corporation_id_assets_locations_with_http_info(corporation_id, item_ids, opts)
  data
end

#post_corporations_corporation_id_assets_locations_with_http_info(corporation_id, item_ids, opts = {}) ⇒ Array<(Array<PostCorporationsCorporationIdAssetsLocations200Ok>, Fixnum, Hash)>

Get corporation asset locations Return locations for a set of item ids, which you can get from corporation assets endpoint. Coordinates for items in hangars or stations are set to (0,0,0) — Requires one of the following EVE corporation role(s): Director

Parameters:

  • corporation_id —

    An EVE corporation ID

  • item_ids —

    A list of item ids

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



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/esi_client/api/assets_api.rb', line 349

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

  # verify the required parameter 'item_ids' is set
  if @api_client.config.client_side_validation && item_ids.nil?
    fail ArgumentError, "Missing the required parameter 'item_ids' when calling AssetsApi.post_corporations_corporation_id_assets_locations"
  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 = '/v2/corporations/{corporation_id}/assets/locations/'.sub('{' + 'corporation_id' + '}', corporation_id.to_s)

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(item_ids)
  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 => 'Array<PostCorporationsCorporationIdAssetsLocations200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AssetsApi#post_corporations_corporation_id_assets_locations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_corporations_corporation_id_assets_names(corporation_id, item_ids, opts = {}) ⇒ Array<PostCorporationsCorporationIdAssetsNames200Ok>

Get coporation asset names Return names for a set of item ids, which you can get from corporation assets endpoint. Only valid for items that can customize names, like containers or ships. — Requires one of the following EVE corporation role(s): Director

Parameters:

  • corporation_id —

    An EVE corporation ID

  • item_ids —

    A list of item ids

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



411
412
413
414
 
# File 'lib/esi_client/api/assets_api.rb', line 411

def post_corporations_corporation_id_assets_names(corporation_id, item_ids, opts = {})
  data, _status_code, _headers = post_corporations_corporation_id_assets_names_with_http_info(corporation_id, item_ids, opts)
  data
end

#post_corporations_corporation_id_assets_names_with_http_info(corporation_id, item_ids, opts = {}) ⇒ Array<(Array<PostCorporationsCorporationIdAssetsNames200Ok>, Fixnum, Hash)>

Get coporation asset names Return names for a set of item ids, which you can get from corporation assets endpoint. Only valid for items that can customize names, like containers or ships. — Requires one of the following EVE corporation role(s): Director

Parameters:

  • corporation_id —

    An EVE corporation ID

  • item_ids —

    A list of item ids

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



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/esi_client/api/assets_api.rb', line 426

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

  # verify the required parameter 'item_ids' is set
  if @api_client.config.client_side_validation && item_ids.nil?
    fail ArgumentError, "Missing the required parameter 'item_ids' when calling AssetsApi.post_corporations_corporation_id_assets_names"
  end
  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = '/v1/corporations/{corporation_id}/assets/names/'.sub('{' + 'corporation_id' + '}', corporation_id.to_s)

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-User-Agent'] = opts[:'x_user_agent'] if !opts[:'x_user_agent'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(item_ids)
  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 => 'Array<PostCorporationsCorporationIdAssetsNames200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AssetsApi#post_corporations_corporation_id_assets_names\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end