Class: VericredClient::ZipCountiesApi
- Inherits:
-
Object
- Object
- VericredClient::ZipCountiesApi
- Defined in:
- lib/vericred_client/api/zip_counties_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#get_zip_counties(zip_prefix, opts = {}) ⇒ ZipCountyResponse
Search for Zip Counties Our ‘Plan` endpoints require a zip code and a fips (county) code.
-
#get_zip_counties_with_http_info(zip_prefix, opts = {}) ⇒ Array<(ZipCountyResponse, Fixnum, Hash)>
Search for Zip Counties Our `Plan` endpoints require a zip code and a fips (county) code.
-
#initialize(api_client = ApiClient.default) ⇒ ZipCountiesApi
constructor
A new instance of ZipCountiesApi.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ ZipCountiesApi
Returns a new instance of ZipCountiesApi.
132 133 134 |
# File 'lib/vericred_client/api/zip_counties_api.rb', line 132 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
130 131 132 |
# File 'lib/vericred_client/api/zip_counties_api.rb', line 130 def api_client @api_client end |
Instance Method Details
#get_zip_counties(zip_prefix, opts = {}) ⇒ ZipCountyResponse
Search for Zip Counties Our ‘Plan` endpoints require a zip code and a fips (county) code. This is because plan pricing requires both of these elements. Users are unlikely to know their fips code, so we provide this endpoint to look up a `ZipCounty` by zip code and return both the selected zip and fips codes.
142 143 144 145 |
# File 'lib/vericred_client/api/zip_counties_api.rb', line 142 def get_zip_counties(zip_prefix, opts = {}) data, _status_code, _headers = get_zip_counties_with_http_info(zip_prefix, opts) return data end |
#get_zip_counties_with_http_info(zip_prefix, opts = {}) ⇒ Array<(ZipCountyResponse, Fixnum, Hash)>
Search for Zip Counties Our `Plan` endpoints require a zip code and a fips (county) code. This is because plan pricing requires both of these elements. Users are unlikely to know their fips code, so we provide this endpoint to look up a `ZipCounty` by zip code and return both the selected zip and fips codes.
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 |
# File 'lib/vericred_client/api/zip_counties_api.rb', line 153 def get_zip_counties_with_http_info(zip_prefix, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: ZipCountiesApi.get_zip_counties ..." end # verify the required parameter 'zip_prefix' is set fail ArgumentError, "Missing the required parameter 'zip_prefix' when calling ZipCountiesApi.get_zip_counties" if zip_prefix.nil? # resource path local_var_path = "/zip_counties".sub('{format}','json') # query parameters query_params = {} query_params[:'zip_prefix'] = zip_prefix # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = [] 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 = [] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) header_params[:'Vericred-Api-Key'] = opts[:'vericred_api_key'] if opts[:'vericred_api_key'] # 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 => 'ZipCountyResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: ZipCountiesApi#get_zip_counties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |