class VericredClient::ZipCountiesApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/vericred_client/api/zip_counties_api.rb, line 1018
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

get_zip_counties(zip_prefix, opts = {}) click to toggle source

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. @param zip_prefix Partial five-digit Zip @param [Hash] opts the optional parameters @return [ZipCountiesResponse]

# File lib/vericred_client/api/zip_counties_api.rb, line 1027
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 = {}) click to toggle source

Search for Zip Counties Our &#x60;Plan&#x60; 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 &#x60;ZipCounty&#x60; by zip code and return both the selected zip and fips codes. @param zip_prefix Partial five-digit Zip @param [Hash] opts the optional parameters @return [Array<(ZipCountiesResponse, Fixnum, Hash)>] ZipCountiesResponse data, response status code and response headers

# File lib/vericred_client/api/zip_counties_api.rb, line 1037
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)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['Vericred-Api-Key']
  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 => 'ZipCountiesResponse')
  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
show_zip_county(id, opts = {}) click to toggle source

Show an individual ZipCounty 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 returns the details for a `ZipCounty` by zip code and return both the selected zip and fips codes. @param id Unique ID for ZipCounty @param [Hash] opts the optional parameters @return [ZipCountyResponse]

# File lib/vericred_client/api/zip_counties_api.rb, line 1085
def show_zip_county(id, opts = {})
  data, _status_code, _headers = show_zip_county_with_http_info(id, opts)
  return data
end
show_zip_county_with_http_info(id, opts = {}) click to toggle source

Show an individual ZipCounty Our &#x60;Plan&#x60; 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 returns the details for a &#x60;ZipCounty&#x60; by zip code and return both the selected zip and fips codes. @param id Unique ID for ZipCounty @param [Hash] opts the optional parameters @return [Array<(ZipCountyResponse, Fixnum, Hash)>] ZipCountyResponse data, response status code and response headers

# File lib/vericred_client/api/zip_counties_api.rb, line 1095
def show_zip_county_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ZipCountiesApi.show_zip_county ..."
  end
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling ZipCountiesApi.show_zip_county" if id.nil?
  # resource path
  local_var_path = "/zip_counties/{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 = []
  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)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['Vericred-Api-Key']
  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#show_zip_county\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end