Class: EsiClient::PlanetaryInteractionApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PlanetaryInteractionApi 



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

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



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

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: ‘/v1/characters/character_id/planets/` Alternate route: `/legacy/characters/character_id/planets/` Alternate route: `/dev/characters/character_id/planets/` — This route is cached for up to 600 seconds

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



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

def get_characters_character_id_planets(character_id, opts = {})
  data, _status_code, _headers = get_characters_character_id_planets_with_http_info(character_id, opts)
  return 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: ‘/v2/characters/character_id/planets/planet_id/` — This route is cached for up to 600 seconds

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



98
99
100
101
 
# File 'lib/esi-ruby/api/planetary_interaction_api.rb', line 98

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)
  return data
end

#get_characters_character_id_planets_planet_id_with_http_info(character_id, planet_id, opts = {}) ⇒ Array<(GetCharactersCharacterIdPlanetsPlanetIdOk, Fixnum, 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;/v2/characters/character_id/planets/planet_id/&#x60; — This route is cached for up to 600 seconds

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



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

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
  fail ArgumentError, "Missing the required parameter 'character_id' when calling PlanetaryInteractionApi.get_characters_character_id_planets_planet_id" if character_id.nil?
  # verify the required parameter 'planet_id' is set
  fail ArgumentError, "Missing the required parameter 'planet_id' when calling PlanetaryInteractionApi.get_characters_character_id_planets_planet_id" if planet_id.nil?
  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/characters/{character_id}/planets/{planet_id}/".sub('{format}','json').sub('{' + 'character_id' + '}', character_id.to_s).sub('{' + 'planet_id' + '}', planet_id.to_s)

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['evesso']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GetCharactersCharacterIdPlanetsPlanetIdOk')
  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>, Fixnum, Hash)>

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

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



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

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
  fail ArgumentError, "Missing the required parameter 'character_id' when calling PlanetaryInteractionApi.get_characters_character_id_planets" if character_id.nil?
  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/characters/{character_id}/planets/".sub('{format}','json').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 = 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<GetCharactersCharacterIdPlanets200Ok>')
  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_universe_schematics_schematic_id(schematic_id, opts = {}) ⇒ GetUniverseSchematicsSchematicIdOk

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

Options Hash (opts):

  • :datasource (String) —

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

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent



166
167
168
169
 
# File 'lib/esi-ruby/api/planetary_interaction_api.rb', line 166

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

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

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

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent



179
180
181
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
 
# File 'lib/esi-ruby/api/planetary_interaction_api.rb', line 179

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
  fail ArgumentError, "Missing the required parameter 'schematic_id' when calling PlanetaryInteractionApi.get_universe_schematics_schematic_id" if schematic_id.nil?
  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  # resource path
  local_var_path = "/universe/schematics/{schematic_id}/".sub('{format}','json').sub('{' + 'schematic_id' + '}', schematic_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].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 = []
  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 => 'GetUniverseSchematicsSchematicIdOk')
  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