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 



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

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/ruby-esi/api/location_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#get_characters_character_id_location(character_id, opts = {}) ⇒ GetCharactersCharacterIdLocationOk

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

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



27
28
29
30
 
# File 'lib/ruby-esi/api/location_api.rb', line 27

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

#get_characters_character_id_location_with_http_info(character_id, opts = {}) ⇒ Array<(GetCharactersCharacterIdLocationOk, 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 — Alternate route: &#x60;/dev/characters/character_id/location/&#x60; Alternate route: &#x60;/legacy/characters/character_id/location/&#x60; Alternate route: &#x60;/v1/characters/character_id/location/&#x60; Alternate route: &#x60;/v2/characters/character_id/location/&#x60; — This route is cached for up to 5 seconds

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



40
41
42
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
 
# File 'lib/ruby-esi/api/location_api.rb', line 40

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

  return_type = opts[:return_type] || 'GetCharactersCharacterIdLocationOk' 

  auth_names = opts[: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 => return_type)

  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, opts = {}) ⇒ GetCharactersCharacterIdOnlineOk

Get character online Checks if the character is currently online — Alternate route: ‘/dev/characters/character_id/online/` Alternate route: `/v2/characters/character_id/online/` Alternate route: `/v3/characters/character_id/online/` — This route is cached for up to 60 seconds

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



95
96
97
98
 
# File 'lib/ruby-esi/api/location_api.rb', line 95

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

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

Get character online Checks if the character is currently online — Alternate route: &#x60;/dev/characters/character_id/online/&#x60; Alternate route: &#x60;/v2/characters/character_id/online/&#x60; Alternate route: &#x60;/v3/characters/character_id/online/&#x60; — This route is cached for up to 60 seconds

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



108
109
110
111
112
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
 
# File 'lib/ruby-esi/api/location_api.rb', line 108

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

  return_type = opts[:return_type] || 'GetCharactersCharacterIdOnlineOk' 

  auth_names = opts[: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 => return_type)

  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, opts = {}) ⇒ GetCharactersCharacterIdShipOk

Get current ship Get the current ship type, name and id — Alternate route: ‘/dev/characters/character_id/ship/` Alternate route: `/legacy/characters/character_id/ship/` Alternate route: `/v1/characters/character_id/ship/` Alternate route: `/v2/characters/character_id/ship/` — This route is cached for up to 5 seconds

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



163
164
165
166
 
# File 'lib/ruby-esi/api/location_api.rb', line 163

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

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

Get current ship Get the current ship type, name and id — Alternate route: &#x60;/dev/characters/character_id/ship/&#x60; Alternate route: &#x60;/legacy/characters/character_id/ship/&#x60; Alternate route: &#x60;/v1/characters/character_id/ship/&#x60; Alternate route: &#x60;/v2/characters/character_id/ship/&#x60; — This route is cached for up to 5 seconds

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



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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/ruby-esi/api/location_api.rb', line 176

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

  return_type = opts[:return_type] || 'GetCharactersCharacterIdShipOk' 

  auth_names = opts[: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 => return_type)

  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