class AgridClient::CitiesApi
Attributes
api_client[RW]
Public Class Methods
new(api_client = ApiClient.default)
click to toggle source
# File lib/agrid_client/api/cities_api.rb, line 5 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
cities_get(opts = {})
click to toggle source
Returns all cities supported by at least one company @param [Hash] opts the optional parameters @option opts [String] :state State
acronym to filter cities by state @return [Array<CityWithFullState>]
# 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 = {})
click to toggle source
Returns all cities supported by at least one company @param [Hash] opts the optional parameters @option opts [String] :state State
acronym to filter cities by state @return [Array<(Array<CityWithFullState>, Fixnum, Hash)>] Array<CityWithFullState> data, response status code and response headers
# 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