Class: EsiClient::RoutesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RoutesApi

Returns a new instance of RoutesApi.



18
19
20
 
# File 'lib/esi-ruby/api/routes_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/routes_api.rb', line 16

def api_client
  @api_client
end

Instance Method Details

#get_route_origin_destination(destination, origin, opts = {}) ⇒ Array<Integer>

Get route Get the systems between origin and destination — Alternate route: ‘/legacy/route/origin/destination/` Alternate route: `/dev/route/origin/destination/` Alternate route: `/v1/route/origin/destination/` — This route is cached for up to 86400 seconds

Parameters:

  • destination —

    destination solar system ID

  • origin —

    origin solar system ID

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

    the optional parameters

Options Hash (opts):

  • :avoid (Array<Integer>) —

    avoid solar system ID(s)

  • :connections (Array<Array<Integer>>) —

    connected solar system pairs

  • :datasource (String) —

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

  • :flag (String) —

    route security preference (default to shortest)

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:

  • (Array<Integer>) 


34
35
36
37
 
# File 'lib/esi-ruby/api/routes_api.rb', line 34

def get_route_origin_destination(destination, origin, opts = {})
  data, _status_code, _headers = get_route_origin_destination_with_http_info(destination, origin, opts)
  return data
end

#get_route_origin_destination_with_http_info(destination, origin, opts = {}) ⇒ Array<(Array<Integer>, Fixnum, Hash)>

Get route Get the systems between origin and destination — Alternate route: &#x60;/legacy/route/origin/destination/&#x60; Alternate route: &#x60;/dev/route/origin/destination/&#x60; Alternate route: &#x60;/v1/route/origin/destination/&#x60; — This route is cached for up to 86400 seconds

Parameters:

  • destination —

    destination solar system ID

  • origin —

    origin solar system ID

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

    the optional parameters

Options Hash (opts):

  • :avoid (Array<Integer>) —

    avoid solar system ID(s)

  • :connections (Array<Array<Integer>>) —

    connected solar system pairs

  • :datasource (String) —

    The server name you would like data from

  • :flag (String) —

    route security preference

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:

  • (Array<(Array<Integer>, Fixnum, Hash)>) —

    Array<Integer> data, response status code and response headers



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

def get_route_origin_destination_with_http_info(destination, origin, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutesApi.get_route_origin_destination ..."
  end
  # verify the required parameter 'destination' is set
  fail ArgumentError, "Missing the required parameter 'destination' when calling RoutesApi.get_route_origin_destination" if destination.nil?
  # verify the required parameter 'origin' is set
  fail ArgumentError, "Missing the required parameter 'origin' when calling RoutesApi.get_route_origin_destination" if origin.nil?
  if !opts[:'avoid'].nil? && opts[:'avoid'].length > 100
    fail ArgumentError, 'invalid value for "opts[:"avoid"]" when calling RoutesApi.get_route_origin_destination, number of items must be less than or equal to 100.'
  end

  if !opts[:'connections'].nil? && opts[:'connections'].length > 100
    fail ArgumentError, 'invalid value for "opts[:"connections"]" when calling RoutesApi.get_route_origin_destination, number of items must be less than or equal to 100.'
  end

  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  if opts[:'flag'] && !['shortest', 'secure', 'insecure'].include?(opts[:'flag'])
    fail ArgumentError, 'invalid value for "flag", must be one of shortest, secure, insecure'
  end
  # resource path
  local_var_path = "/route/{origin}/{destination}/".sub('{format}','json').sub('{' + 'destination' + '}', destination.to_s).sub('{' + 'origin' + '}', origin.to_s)

  # query parameters
  query_params = {}
  query_params[:'avoid'] = @api_client.build_collection_param(opts[:'avoid'], :csv) if !opts[:'avoid'].nil?
  query_params[:'connections'] = @api_client.build_collection_param(opts[:'connections'], :csv) if !opts[:'connections'].nil?
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'flag'] = opts[:'flag'] if !opts[:'flag'].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 => 'Array<Integer>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutesApi#get_route_origin_destination\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end