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.



19
20
21
 
# File 'lib/vericred_client/api/zip_counties_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/vericred_client/api/zip_counties_api.rb', line 17

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:



28
29
30
31
 
# File 'lib/vericred_client/api/zip_counties_api.rb', line 28

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



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
65
66
67
68
69
70
71
72
73
 
# File 'lib/vericred_client/api/zip_counties_api.rb', line 38

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
  if @api_client.config.client_side_validation && zip_prefix.nil?
    fail ArgumentError, "Missing the required parameter 'zip_prefix' when calling ZipCountiesApi.get_zip_counties"
  end
  # resource path
  local_var_path = "/zip_counties"

  # query parameters
  query_params = {}
  query_params[:'zip_prefix'] = zip_prefix

  # header parameters
  header_params = {}

  # 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:



80
81
82
83
 
# File 'lib/vericred_client/api/zip_counties_api.rb', line 80

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



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/vericred_client/api/zip_counties_api.rb', line 90

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
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ZipCountiesApi.show_zip_county"
  end
  # resource path
  local_var_path = "/zip_counties/{id}".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # 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