Class: VericredClient::ZipCountiesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/vericred_client/api/zip_counties_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ZipCountiesApi

Returns a new instance of ZipCountiesApi.



990
991
992
 
# File 'lib/vericred_client/api/zip_counties_api.rb', line 990

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



988
989
990
 
# File 'lib/vericred_client/api/zip_counties_api.rb', line 988

def api_client
  @api_client
end

Instance Method Details

#get_zip_counties(zip_prefix, opts = {}) ⇒ ZipCountiesResponse

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.

Parameters:

  • zip_prefix —

    Partial five-digit Zip

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

    the optional parameters

Returns:



999
1000
1001
1002
 
# File 'lib/vericred_client/api/zip_counties_api.rb', line 999

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<(ZipCountiesResponse, Fixnum, Hash)>

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.

Parameters:

  • zip_prefix —

    Partial five-digit Zip

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

    the optional parameters

Returns:

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

    ZipCountiesResponse data, response status code and response headers



1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
 
# File 'lib/vericred_client/api/zip_counties_api.rb', line 1009

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 = {}) ⇒ ZipCountyResponse

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.

Parameters:

  • id —

    Unique ID for ZipCounty

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

    the optional parameters

Returns:



1057
1058
1059
1060
 
# File 'lib/vericred_client/api/zip_counties_api.rb', line 1057

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 = {}) ⇒ Array<(ZipCountyResponse, Fixnum, Hash)>

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.

Parameters:

  • id —

    Unique ID for ZipCounty

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

    the optional parameters

Returns:

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

    ZipCountyResponse data, response status code and response headers



1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
 
# File 'lib/vericred_client/api/zip_counties_api.rb', line 1067

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