Class: ESI::LocationApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LocationApi

Returns a new instance of LocationApi.



19
20
21
 
# File 'lib/ruby-esi/api/location_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/location_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_characters_character_id_location(character_id, x_compatibility_date, opts = {}) ⇒ CharactersCharacterIdLocationGet

Get character location Information about the characters current location. Returns the current solar system id, and also the current station or structure ID if applicable

Parameters:

  • character_id (Integer) —

    The ID of the character

  • x_compatibility_date (Date) —

    The compatibility date for the request.

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    The language to use for the response. (default to 'en')

  • :if_none_match (String) —

    The ETag of the previous request. A 304 will be returned if this matches the current ETag.

  • :x_tenant (String) —

    The tenant ID for the request. (default to 'tranquility')

  • :if_modified_since (String) —

    The date the resource was last modified. A 304 will be returned if the resource has not been modified since this date.

Returns:



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

def get_characters_character_id_location(character_id, x_compatibility_date, opts = {})
  data, _status_code, _headers = get_characters_character_id_location_with_http_info(character_id, x_compatibility_date, opts)
  data
end

#get_characters_character_id_location_with_http_info(character_id, x_compatibility_date, opts = {}) ⇒ Array<(CharactersCharacterIdLocationGet, Integer, Hash)>

Get character location Information about the characters current location. Returns the current solar system id, and also the current station or structure ID if applicable

Parameters:

  • character_id (Integer) —

    The ID of the character

  • x_compatibility_date (Date) —

    The compatibility date for the request.

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    The language to use for the response. (default to 'en')

  • :if_none_match (String) —

    The ETag of the previous request. A 304 will be returned if this matches the current ETag.

  • :x_tenant (String) —

    The tenant ID for the request. (default to 'tranquility')

  • :if_modified_since (String) —

    The date the resource was last modified. A 304 will be returned if the resource has not been modified since this date.

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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/ruby-esi/api/location_api.rb', line 47

def get_characters_character_id_location_with_http_info(character_id, x_compatibility_date, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LocationApi.get_characters_character_id_location ...'
  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 LocationApi.get_characters_character_id_location"
  end
  # verify the required parameter 'x_compatibility_date' is set
  if @api_client.config.client_side_validation && x_compatibility_date.nil?
    fail ArgumentError, "Missing the required parameter 'x_compatibility_date' when calling LocationApi.get_characters_character_id_location"
  end
  # verify enum value
  allowable_values = ["2020-01-01"]
  if @api_client.config.client_side_validation && !allowable_values.include?(x_compatibility_date)
    fail ArgumentError, "invalid value for \"x_compatibility_date\", must be one of #{allowable_values}"
  end
  allowable_values = ["en", "de", "fr", "ja", "ru", "zh", "ko", "es"]
  if @api_client.config.client_side_validation && opts[:'accept_language'] && !allowable_values.include?(opts[:'accept_language'])
    fail ArgumentError, "invalid value for \"accept_language\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/characters/{character_id}/location'.sub('{' + 'character_id' + '}', CGI.escape(character_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # 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[:'X-Compatibility-Date'] = x_compatibility_date
  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?
  header_params[:'X-Tenant'] = opts[:'x_tenant'] if !opts[:'x_tenant'].nil?
  header_params[:'If-Modified-Since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"LocationApi.get_characters_character_id_location",
    :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: LocationApi#get_characters_character_id_location\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_characters_character_id_online(character_id, x_compatibility_date, opts = {}) ⇒ CharactersCharacterIdOnlineGet

Get character online Checks if the character is currently online

Parameters:

  • character_id (Integer) —

    The ID of the character

  • x_compatibility_date (Date) —

    The compatibility date for the request.

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    The language to use for the response. (default to 'en')

  • :if_none_match (String) —

    The ETag of the previous request. A 304 will be returned if this matches the current ETag.

  • :x_tenant (String) —

    The tenant ID for the request. (default to 'tranquility')

  • :if_modified_since (String) —

    The date the resource was last modified. A 304 will be returned if the resource has not been modified since this date.

Returns:



123
124
125
126
 
# File 'lib/ruby-esi/api/location_api.rb', line 123

def get_characters_character_id_online(character_id, x_compatibility_date, opts = {})
  data, _status_code, _headers = get_characters_character_id_online_with_http_info(character_id, x_compatibility_date, opts)
  data
end

#get_characters_character_id_online_with_http_info(character_id, x_compatibility_date, opts = {}) ⇒ Array<(CharactersCharacterIdOnlineGet, Integer, Hash)>

Get character online Checks if the character is currently online

Parameters:

  • character_id (Integer) —

    The ID of the character

  • x_compatibility_date (Date) —

    The compatibility date for the request.

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    The language to use for the response. (default to 'en')

  • :if_none_match (String) —

    The ETag of the previous request. A 304 will be returned if this matches the current ETag.

  • :x_tenant (String) —

    The tenant ID for the request. (default to 'tranquility')

  • :if_modified_since (String) —

    The date the resource was last modified. A 304 will be returned if the resource has not been modified since this date.

Returns:



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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/ruby-esi/api/location_api.rb', line 138

def get_characters_character_id_online_with_http_info(character_id, x_compatibility_date, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LocationApi.get_characters_character_id_online ...'
  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 LocationApi.get_characters_character_id_online"
  end
  # verify the required parameter 'x_compatibility_date' is set
  if @api_client.config.client_side_validation && x_compatibility_date.nil?
    fail ArgumentError, "Missing the required parameter 'x_compatibility_date' when calling LocationApi.get_characters_character_id_online"
  end
  # verify enum value
  allowable_values = ["2020-01-01"]
  if @api_client.config.client_side_validation && !allowable_values.include?(x_compatibility_date)
    fail ArgumentError, "invalid value for \"x_compatibility_date\", must be one of #{allowable_values}"
  end
  allowable_values = ["en", "de", "fr", "ja", "ru", "zh", "ko", "es"]
  if @api_client.config.client_side_validation && opts[:'accept_language'] && !allowable_values.include?(opts[:'accept_language'])
    fail ArgumentError, "invalid value for \"accept_language\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/characters/{character_id}/online'.sub('{' + 'character_id' + '}', CGI.escape(character_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # 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[:'X-Compatibility-Date'] = x_compatibility_date
  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?
  header_params[:'X-Tenant'] = opts[:'x_tenant'] if !opts[:'x_tenant'].nil?
  header_params[:'If-Modified-Since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"LocationApi.get_characters_character_id_online",
    :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: LocationApi#get_characters_character_id_online\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_characters_character_id_ship(character_id, x_compatibility_date, opts = {}) ⇒ CharactersCharacterIdShipGet

Get current ship Get the current ship type, name and id

Parameters:

  • character_id (Integer) —

    The ID of the character

  • x_compatibility_date (Date) —

    The compatibility date for the request.

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    The language to use for the response. (default to 'en')

  • :if_none_match (String) —

    The ETag of the previous request. A 304 will be returned if this matches the current ETag.

  • :x_tenant (String) —

    The tenant ID for the request. (default to 'tranquility')

  • :if_modified_since (String) —

    The date the resource was last modified. A 304 will be returned if the resource has not been modified since this date.

Returns:



214
215
216
217
 
# File 'lib/ruby-esi/api/location_api.rb', line 214

def get_characters_character_id_ship(character_id, x_compatibility_date, opts = {})
  data, _status_code, _headers = get_characters_character_id_ship_with_http_info(character_id, x_compatibility_date, opts)
  data
end

#get_characters_character_id_ship_with_http_info(character_id, x_compatibility_date, opts = {}) ⇒ Array<(CharactersCharacterIdShipGet, Integer, Hash)>

Get current ship Get the current ship type, name and id

Parameters:

  • character_id (Integer) —

    The ID of the character

  • x_compatibility_date (Date) —

    The compatibility date for the request.

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String) —

    The language to use for the response. (default to 'en')

  • :if_none_match (String) —

    The ETag of the previous request. A 304 will be returned if this matches the current ETag.

  • :x_tenant (String) —

    The tenant ID for the request. (default to 'tranquility')

  • :if_modified_since (String) —

    The date the resource was last modified. A 304 will be returned if the resource has not been modified since this date.

Returns:



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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/ruby-esi/api/location_api.rb', line 229

def get_characters_character_id_ship_with_http_info(character_id, x_compatibility_date, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LocationApi.get_characters_character_id_ship ...'
  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 LocationApi.get_characters_character_id_ship"
  end
  # verify the required parameter 'x_compatibility_date' is set
  if @api_client.config.client_side_validation && x_compatibility_date.nil?
    fail ArgumentError, "Missing the required parameter 'x_compatibility_date' when calling LocationApi.get_characters_character_id_ship"
  end
  # verify enum value
  allowable_values = ["2020-01-01"]
  if @api_client.config.client_side_validation && !allowable_values.include?(x_compatibility_date)
    fail ArgumentError, "invalid value for \"x_compatibility_date\", must be one of #{allowable_values}"
  end
  allowable_values = ["en", "de", "fr", "ja", "ru", "zh", "ko", "es"]
  if @api_client.config.client_side_validation && opts[:'accept_language'] && !allowable_values.include?(opts[:'accept_language'])
    fail ArgumentError, "invalid value for \"accept_language\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/characters/{character_id}/ship'.sub('{' + 'character_id' + '}', CGI.escape(character_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # 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[:'X-Compatibility-Date'] = x_compatibility_date
  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?
  header_params[:'X-Tenant'] = opts[:'x_tenant'] if !opts[:'x_tenant'].nil?
  header_params[:'If-Modified-Since'] = opts[:'if_modified_since'] if !opts[:'if_modified_since'].nil?

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

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

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

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

  new_options = opts.merge(
    :operation => :"LocationApi.get_characters_character_id_ship",
    :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: LocationApi#get_characters_character_id_ship\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end