Class: ESI::InsuranceApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InsuranceApi 



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

def api_client
  @api_client
end

Instance Method Details

#get_insurance_prices(x_compatibility_date, opts = {}) ⇒ Array<InsurancePricesGetInner>

List insurance levels Return available insurance levels for all ship types

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.



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

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

#get_insurance_prices_with_http_info(x_compatibility_date, opts = {}) ⇒ Array<(Array<InsurancePricesGetInner>, Integer, Hash)>

List insurance levels Return available insurance levels for all ship types

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.



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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/ruby-esi/api/insurance_api.rb', line 45

def get_insurance_prices_with_http_info(x_compatibility_date, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InsuranceApi.get_insurance_prices ...'
  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 InsuranceApi.get_insurance_prices"
  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 = '/insurance/prices'

  # 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] || 'Array<InsurancePricesGetInner>'

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

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