Class: AgridClient::CitiesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CitiesApi

Returns a new instance of CitiesApi.



5
6
7
 
# File 'lib/agrid_client/api/cities_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/cities_api.rb', line 3

def api_client
  @api_client
end

Instance Method Details

#cities_get(opts = {}) ⇒ Array<CityWithFullState>

Returns all cities supported by at least one company

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :state (String) —

    State acronym to filter cities by state

Returns:



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

def cities_get(opts = {})
  data, _status_code, _headers = cities_get_with_http_info(opts)
  return data
end

#cities_get_with_http_info(opts = {}) ⇒ Array<(Array<CityWithFullState>, Fixnum, Hash)>

Returns all cities supported by at least one company

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :state (String) —

    State acronym to filter cities by state

Returns:

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

    Array<CityWithFullState> 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
 
# File 'lib/agrid_client/api/cities_api.rb', line 24

def cities_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CitiesApi#cities_get ..."
  end

  # resource path
  local_var_path = "/cities".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'state'] = opts[:'state'] if opts[:'state']

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