Class: ESI::InsuranceApi

Inherits:
Object
  • Object
show all
Defined in:
lib/esi-client-bvv/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.



19
20
21
# File 'lib/esi-client-bvv/api/insurance_api.rb', line 19

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

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.



17
18
19
# File 'lib/esi-client-bvv/api/insurance_api.rb', line 17

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 — This route is cached for up to 3600 seconds

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String)

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

  • :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

  • :language (String)

    Language to use in the response, takes precedence over Accept-Language (default to en-us)

Returns:



31
32
33
34
# File 'lib/esi-client-bvv/api/insurance_api.rb', line 31

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 — This route is cached for up to 3600 seconds

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :accept_language (String)

    Language to use in the response

  • :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

  • :language (String)

    Language to use in the response, takes precedence over Accept-Language

Returns:

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

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



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
87
88
89
90
91
# File 'lib/esi-client-bvv/api/insurance_api.rb', line 44

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 @api_client.config.client_side_validation && opts[:'accept_language'] && !['de', 'en-us', 'fr', 'ja', 'ru', 'zh'].include?(opts[:'accept_language'])
    fail ArgumentError, 'invalid value for "accept_language", must be one of de, en-us, fr, ja, ru, zh'
  end
  if @api_client.config.client_side_validation && opts[:'datasource'] && !['tranquility', 'singularity'].include?(opts[:'datasource'])
    fail ArgumentError, 'invalid value for "datasource", must be one of tranquility, singularity'
  end
  if @api_client.config.client_side_validation && 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 = "/v1/insurance/prices/"

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  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?

  # 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