Class: EsiClient::InsuranceApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InsuranceApi

Returns a new instance of InsuranceApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_insurance_prices(opts = {}) ⇒ Array<GetInsurancePrices200Ok>

List insurance levels Return available insurance levels for all ship types — Alternate route: ‘/v1/insurance/prices/` Alternate route: `/legacy/insurance/prices/` Alternate route: `/dev/insurance/prices/` — This route is cached for up to 3600 seconds

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

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

  • :language (String) —

    Language to use in the response (default to en-us)

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:



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

def get_insurance_prices(opts = {})
  data, _status_code, _headers = get_insurance_prices_with_http_info(opts)
  return data
end

#get_insurance_prices_with_http_info(opts = {}) ⇒ Array<(Array<GetInsurancePrices200Ok>, Fixnum, Hash)>

List insurance levels Return available insurance levels for all ship types — Alternate route: &#x60;/v1/insurance/prices/&#x60; Alternate route: &#x60;/legacy/insurance/prices/&#x60; Alternate route: &#x60;/dev/insurance/prices/&#x60; — This route is cached for up to 3600 seconds

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :datasource (String) —

    The server name you would like data from

  • :language (String) —

    Language to use in the response

  • :user_agent (String) —

    Client identifier, takes precedence over headers

  • :x_user_agent (String) —

    Client identifier, takes precedence over User-Agent

Returns:

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

    Array<GetInsurancePrices200Ok> 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
 
# File 'lib/esi-ruby/api/insurance_api.rb', line 43

def get_insurance_prices_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: InsuranceApi.get_insurance_prices ..."
  end
  if opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  if opts[:'language'] && !['de', 'en-us', 'fr', 'ja', 'ru', 'zh'].include?(opts[:'language'])
    fail ArgumentError, 'invalid value for "language", must be one of de, en-us, fr, ja, ru, zh'
  end
  # resource path
  local_var_path = "/insurance/prices/".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'datasource'] = opts[:'datasource'] if !opts[:'datasource'].nil?
  query_params[:'language'] = opts[:'language'] if !opts[:'language'].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<GetInsurancePrices200Ok>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InsuranceApi#get_insurance_prices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end