Class: AgridClient::QuotesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/agrid_client/api/quotes_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ QuotesApi

Returns a new instance of QuotesApi.



5
6
7
 
# File 'lib/agrid_client/api/quotes_api.rb', line 5

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



3
4
5
 
# File 'lib/agrid_client/api/quotes_api.rb', line 3

def api_client
  @api_client
end

Instance Method Details

#quotes_get(service_id, opts = {}) ⇒ PaginatedQuotes

Returns a set of quotes.

Parameters:

  • service_id —

    Param to filter quotes by service

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

    the optional parameters

Options Hash (opts):

  • :company_id (String) —

    Param to filter quotes by company

  • :city_id (String) —

    Param to filter quotes by city

  • :limit (Integer) —

    Limit number of quotes on response(default is 12)

  • :offset (Integer) —

    Number to skip rows before beginning to return quotes

  • :filter_categories (Array<String>) —

    Example: &lt;br&gt; filter_categories[]&#x3D;:filter_category_id&amp;filter_categories[]&#x3D;:filter_category_id &lt;br&gt;&lt;br&gt; :filter_id is the id of filter&lt;br&gt; :filter_category_id is the id of filter category

  • :min_price (Float) —

    Param to filter quotes with price is at least equal to :min_price

  • :max_price (Float) —

    Param to filter quotes with price is at most equal to :max_price

Returns:



80
81
82
83
 
# File 'lib/agrid_client/api/quotes_api.rb', line 80

def quotes_get(service_id, opts = {})
  data, _status_code, _headers = quotes_get_with_http_info(service_id, opts)
  return data
end

#quotes_get_with_http_info(service_id, opts = {}) ⇒ Array<(PaginatedQuotes, Fixnum, Hash)>

Returns a set of quotes.

Parameters:

  • service_id —

    Param to filter quotes by service

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

    the optional parameters

Options Hash (opts):

  • :company_id (String) —

    Param to filter quotes by company

  • :city_id (String) —

    Param to filter quotes by city

  • :limit (Integer) —

    Limit number of quotes on response(default is 12)

  • :offset (Integer) —

    Number to skip rows before beginning to return quotes

  • :filter_categories (Array<String>) —

    Example: &lt;br&gt; filter_categories[]&#x3D;:filter_category_id&amp;filter_categories[]&#x3D;:filter_category_id &lt;br&gt;&lt;br&gt; :filter_id is the id of filter&lt;br&gt; :filter_category_id is the id of filter category

  • :min_price (Float) —

    Param to filter quotes with price is at least equal to :min_price

  • :max_price (Float) —

    Param to filter quotes with price is at most equal to :max_price

Returns:

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

    PaginatedQuotes data, response status code and response headers



97
98
99
100
101
102
103
104
105
106
107
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
 
# File 'lib/agrid_client/api/quotes_api.rb', line 97

def quotes_get_with_http_info(service_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QuotesApi#quotes_get ..."
  end

  # verify the required parameter 'service_id' is set
  fail "Missing the required parameter 'service_id' when calling quotes_get" if service_id.nil?

  # resource path
  local_var_path = "/services/{service_id}/quotes".sub('{format}','json').sub('{' + 'service_id' + '}', service_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'company_id'] = opts[:'company_id'] if opts[:'company_id']
  query_params[:'city_id'] = opts[:'city_id'] if opts[:'city_id']
  query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
  query_params[:'offset'] = opts[:'offset'] if opts[:'offset']
  query_params[:'filter_categories'] = @api_client.build_collection_param(opts[:'filter_categories'], :csv) if opts[:'filter_categories']
  query_params[:'min_price'] = opts[:'min_price'] if opts[:'min_price']
  query_params[:'max_price'] = opts[:'max_price'] if opts[:'max_price']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # 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 => 'PaginatedQuotes')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QuotesApi#quotes_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#quotes_id_get(id, opts = {}) ⇒ Quote

Returns a specific quote

Parameters:

  • id —

    Param to filter company using id

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

    the optional parameters

Returns:



14
15
16
17
 
# File 'lib/agrid_client/api/quotes_api.rb', line 14

def quotes_id_get(id, opts = {})
  data, _status_code, _headers = quotes_id_get_with_http_info(id, opts)
  return data
end

#quotes_id_get_with_http_info(id, opts = {}) ⇒ Array<(Quote, Fixnum, Hash)>

Returns a specific quote

Parameters:

  • id —

    Param to filter company using id

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

    the optional parameters

Returns:

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

    Quote data, response status code and response headers



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
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
 
# File 'lib/agrid_client/api/quotes_api.rb', line 24

def quotes_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: QuotesApi#quotes_id_get ..."
  end

  # verify the required parameter 'id' is set
  fail "Missing the required parameter 'id' when calling quotes_id_get" if id.nil?

  # resource path
  local_var_path = "/quotes/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # 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 => 'Quote')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: QuotesApi#quotes_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end