Class: ESI::PlanetaryInteractionApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PlanetaryInteractionApi

Returns a new instance of PlanetaryInteractionApi.



19
20
21
 
# File 'lib/ruby-esi/api/planetary_interaction_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/ruby-esi/api/planetary_interaction_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_characters_character_id_planets(character_id, opts = {}) ⇒ Array<GetCharactersCharacterIdPlanets200Ok>

Get colonies Returns a list of all planetary colonies owned by a character. — Alternate route: ‘/dev/characters/character_id/planets/` Alternate route: `/legacy/characters/character_id/planets/` Alternate route: `/v1/characters/character_id/planets/` — This route is cached for up to 600 seconds

Parameters:

  • An EVE character ID

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



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

def get_characters_character_id_planets(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_planets_with_http_info(character_id, opts)
  data
end

#get_characters_character_id_planets_planet_id(character_id, planet_id, opts = {}) ⇒ GetCharactersCharacterIdPlanetsPlanetIdOk

Get colony layout Returns full details on the layout of a single planetary colony, including links, pins and routes. Note: Planetary information is only recalculated when the colony is viewed through the client. Information will not update until this criteria is met. — Alternate route: ‘/dev/characters/character_id/planets/planet_id/` Alternate route: `/v3/characters/character_id/planets/planet_id/`

Parameters:

  • An EVE character ID

  • Planet id of the target planet

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



110
111
112
113
 
# File 'lib/ruby-esi/api/planetary_interaction_api.rb', line 110

def get_characters_character_id_planets_planet_id(character_id, planet_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_planets_planet_id_with_http_info(character_id, planet_id, opts)
  data
end

#get_characters_character_id_planets_planet_id_with_http_info(character_id, planet_id, opts = {}) ⇒ Array<(GetCharactersCharacterIdPlanetsPlanetIdOk, Integer, Hash)>

Get colony layout Returns full details on the layout of a single planetary colony, including links, pins and routes. Note: Planetary information is only recalculated when the colony is viewed through the client. Information will not update until this criteria is met. — Alternate route: &#x60;/dev/characters/character_id/planets/planet_id/&#x60; Alternate route: &#x60;/v3/characters/character_id/planets/planet_id/&#x60;

Parameters:

  • An EVE character ID

  • Planet id of the target planet

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

  • GetCharactersCharacterIdPlanetsPlanetIdOk data, response status code and response headers



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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/ruby-esi/api/planetary_interaction_api.rb', line 123

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

  # verify the required parameter 'planet_id' is set
  if @api_client.config.client_side_validation && planet_id.nil?
    fail ArgumentError, "Missing the required parameter 'planet_id' when calling PlanetaryInteractionApi.get_characters_character_id_planets_planet_id"
  end
  allowable_values = ["tranquility"]
  if @api_client.config.client_side_validation && opts[:'datasource'] && !allowable_values.include?(opts[:'datasource'])
    fail ArgumentError, "invalid value for \"datasource\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/characters/{character_id}/planets/{planet_id}/'.sub('{' + 'character_id' + '}', CGI.escape(character_id.to_s)).sub('{' + 'planet_id' + '}', CGI.escape(planet_id.to_s))

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

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'GetCharactersCharacterIdPlanetsPlanetIdOk'

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

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

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

#get_characters_character_id_planets_with_http_info(character_id, opts = {}) ⇒ Array<(Array<GetCharactersCharacterIdPlanets200Ok>, Integer, Hash)>

Get colonies Returns a list of all planetary colonies owned by a character. — Alternate route: &#x60;/dev/characters/character_id/planets/&#x60; Alternate route: &#x60;/legacy/characters/character_id/planets/&#x60; Alternate route: &#x60;/v1/characters/character_id/planets/&#x60; — This route is cached for up to 600 seconds

Parameters:

  • An EVE character ID

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

  • Array<GetCharactersCharacterIdPlanets200Ok> data, response status code and response headers



43
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
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/ruby-esi/api/planetary_interaction_api.rb', line 43

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

  allowable_values = ["tranquility"]
  if @api_client.config.client_side_validation && opts[:'datasource'] && !allowable_values.include?(opts[:'datasource'])
    fail ArgumentError, "invalid value for \"datasource\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/characters/{character_id}/planets/'.sub('{' + 'character_id' + '}', CGI.escape(character_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<GetCharactersCharacterIdPlanets200Ok>'

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

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

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

#get_corporations_corporation_id_customs_offices(corporation_id, opts = {}) ⇒ Array<GetCorporationsCorporationIdCustomsOffices200Ok>

List corporation customs offices List customs offices owned by a corporation — Alternate route: ‘/dev/corporations/corporation_id/customs_offices/` Alternate route: `/legacy/corporations/corporation_id/customs_offices/` Alternate route: `/v1/corporations/corporation_id/customs_offices/` — This route is cached for up to 3600 seconds — Requires one of the following EVE corporation role(s): Director

Parameters:

  • An EVE corporation ID

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

  • :page (Integer) —

    Which page of results to return (default to 1)

  • :token (String) —

    Access token to use if unable to set a header

Returns:



194
195
196
197
 
# File 'lib/ruby-esi/api/planetary_interaction_api.rb', line 194

def get_corporations_corporation_id_customs_offices(corporation_id, opts = {})
  data, _status_code, _headers = get_corporations_corporation_id_customs_offices_with_http_info(corporation_id, opts)
  data
end

#get_corporations_corporation_id_customs_offices_with_http_info(corporation_id, opts = {}) ⇒ Array<(Array<GetCorporationsCorporationIdCustomsOffices200Ok>, Integer, Hash)>

List corporation customs offices List customs offices owned by a corporation — Alternate route: &#x60;/dev/corporations/corporation_id/customs_offices/&#x60; Alternate route: &#x60;/legacy/corporations/corporation_id/customs_offices/&#x60; Alternate route: &#x60;/v1/corporations/corporation_id/customs_offices/&#x60; — This route is cached for up to 3600 seconds — Requires one of the following EVE corporation role(s): Director

Parameters:

  • An EVE corporation ID

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

  • :page (Integer) —

    Which page of results to return (default to 1)

  • :token (String) —

    Access token to use if unable to set a header

Returns:

  • Array<GetCorporationsCorporationIdCustomsOffices200Ok> data, response status code and response headers



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/ruby-esi/api/planetary_interaction_api.rb', line 208

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

  allowable_values = ["tranquility"]
  if @api_client.config.client_side_validation && opts[:'datasource'] && !allowable_values.include?(opts[:'datasource'])
    fail ArgumentError, "invalid value for \"datasource\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling PlanetaryInteractionApi.get_corporations_corporation_id_customs_offices, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/corporations/{corporation_id}/customs_offices/'.sub('{' + 'corporation_id' + '}', CGI.escape(corporation_id.to_s))

  # query parameters
  query_params = opts[: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?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Array<GetCorporationsCorporationIdCustomsOffices200Ok>'

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

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

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

#get_universe_schematics_schematic_id(schematic_id, opts = {}) ⇒ GetUniverseSchematicsSchematicIdOk

Get schematic information Get information on a planetary factory schematic — Alternate route: ‘/dev/universe/schematics/schematic_id/` Alternate route: `/legacy/universe/schematics/schematic_id/` Alternate route: `/v1/universe/schematics/schematic_id/` — This route is cached for up to 3600 seconds

Parameters:

  • A PI schematic ID

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

Returns:



279
280
281
282
 
# File 'lib/ruby-esi/api/planetary_interaction_api.rb', line 279

def get_universe_schematics_schematic_id(schematic_id, opts = {})
  data, _status_code, _headers = get_universe_schematics_schematic_id_with_http_info(schematic_id, opts)
  data
end

#get_universe_schematics_schematic_id_with_http_info(schematic_id, opts = {}) ⇒ Array<(GetUniverseSchematicsSchematicIdOk, Integer, Hash)>

Get schematic information Get information on a planetary factory schematic — Alternate route: &#x60;/dev/universe/schematics/schematic_id/&#x60; Alternate route: &#x60;/legacy/universe/schematics/schematic_id/&#x60; Alternate route: &#x60;/v1/universe/schematics/schematic_id/&#x60; — This route is cached for up to 3600 seconds

Parameters:

  • A PI schematic ID

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

Returns:

  • GetUniverseSchematicsSchematicIdOk data, response status code and response headers



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/ruby-esi/api/planetary_interaction_api.rb', line 291

def get_universe_schematics_schematic_id_with_http_info(schematic_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PlanetaryInteractionApi.get_universe_schematics_schematic_id ...'
  end
  # verify the required parameter 'schematic_id' is set
  if @api_client.config.client_side_validation && schematic_id.nil?
    fail ArgumentError, "Missing the required parameter 'schematic_id' when calling PlanetaryInteractionApi.get_universe_schematics_schematic_id"
  end
  allowable_values = ["tranquility"]
  if @api_client.config.client_side_validation && opts[:'datasource'] && !allowable_values.include?(opts[:'datasource'])
    fail ArgumentError, "invalid value for \"datasource\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/universe/schematics/{schematic_id}/'.sub('{' + 'schematic_id' + '}', CGI.escape(schematic_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if !opts[:'if_none_match'].nil?

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'GetUniverseSchematicsSchematicIdOk'

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

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

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