vericred_client 0.0.4 → 0.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (81) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +31 -18
  3. data/docs/Applicant.md +3 -3
  4. data/docs/Carrier.md +1 -1
  5. data/docs/County.md +3 -3
  6. data/docs/Drug.md +3 -3
  7. data/docs/DrugCoverage.md +4 -4
  8. data/docs/DrugCoverageResponse.md +3 -1
  9. data/docs/DrugPackage.md +1 -1
  10. data/docs/DrugSearchResponse.md +2 -1
  11. data/docs/DrugsApi.md +71 -10
  12. data/docs/Meta.md +1 -1
  13. data/docs/Network.md +9 -0
  14. data/docs/NetworkSearchResponse.md +9 -0
  15. data/docs/NetworksApi.md +58 -0
  16. data/docs/Plan.md +10 -10
  17. data/docs/PlanCounty.md +1 -1
  18. data/docs/PlanCountyBulk.md +1 -1
  19. data/docs/{PlanFindResponse.md → PlanSearchResponse.md} +2 -1
  20. data/docs/PlanSearchResult.md +14 -14
  21. data/docs/PlansApi.md +69 -6
  22. data/docs/Provider.md +7 -6
  23. data/docs/ProvidersApi.md +39 -30
  24. data/docs/{ProviderResponse.md → ProvidersSearchResponse.md} +1 -1
  25. data/docs/RequestPlanFind.md +3 -2
  26. data/docs/RequestPlanFindApplicant.md +8 -0
  27. data/docs/RequestPlanFindProvider.md +8 -0
  28. data/docs/RequestProvidersSearch.md +17 -0
  29. data/docs/State.md +4 -4
  30. data/docs/ZipCountiesApi.md +11 -4
  31. data/docs/ZipCountiesResponse.md +11 -0
  32. data/docs/ZipCountyBulk.md +1 -1
  33. data/docs/ZipCountyResponse.md +2 -1
  34. data/lib/vericred_client/api/drugs_api.rb +86 -14
  35. data/lib/vericred_client/api/networks_api.rb +198 -0
  36. data/lib/vericred_client/api/plans_api.rb +134 -14
  37. data/lib/vericred_client/api/providers_api.rb +65 -59
  38. data/lib/vericred_client/api/zip_counties_api.rb +8 -5
  39. data/lib/vericred_client/api_client.rb +1 -1
  40. data/lib/vericred_client/api_error.rb +1 -1
  41. data/lib/vericred_client/models/applicant.rb +13 -15
  42. data/lib/vericred_client/models/base.rb +1 -1
  43. data/lib/vericred_client/models/carrier.rb +15 -15
  44. data/lib/vericred_client/models/carrier_subsidiary.rb +1 -1
  45. data/lib/vericred_client/models/county.rb +12 -16
  46. data/lib/vericred_client/models/county_bulk.rb +1 -1
  47. data/lib/vericred_client/models/drug.rb +26 -26
  48. data/lib/vericred_client/models/drug_coverage.rb +32 -38
  49. data/lib/vericred_client/models/drug_coverage_response.rb +40 -16
  50. data/lib/vericred_client/models/drug_package.rb +15 -15
  51. data/lib/vericred_client/models/drug_search_response.rb +21 -9
  52. data/lib/vericred_client/models/meta.rb +8 -8
  53. data/lib/vericred_client/models/network.rb +308 -0
  54. data/lib/vericred_client/models/{plan_find_response.rb → network_search_response.rb} +11 -11
  55. data/lib/vericred_client/models/plan.rb +62 -72
  56. data/lib/vericred_client/models/plan_county.rb +15 -15
  57. data/lib/vericred_client/models/plan_county_bulk.rb +15 -15
  58. data/lib/vericred_client/models/plan_search_response.rb +322 -0
  59. data/lib/vericred_client/models/plan_search_result.rb +102 -112
  60. data/lib/vericred_client/models/pricing.rb +1 -1
  61. data/lib/vericred_client/models/provider.rb +24 -22
  62. data/lib/vericred_client/models/{provider_response.rb → providers_search_response.rb} +2 -2
  63. data/lib/vericred_client/models/rating_area.rb +1 -1
  64. data/lib/vericred_client/models/request_plan_find.rb +16 -4
  65. data/lib/vericred_client/models/request_plan_find_applicant.rb +298 -0
  66. data/lib/vericred_client/models/request_plan_find_provider.rb +298 -0
  67. data/lib/vericred_client/models/request_providers_search.rb +372 -0
  68. data/lib/vericred_client/models/state.rb +25 -29
  69. data/lib/vericred_client/models/zip_code.rb +1 -1
  70. data/lib/vericred_client/models/zip_counties_response.rb +336 -0
  71. data/lib/vericred_client/models/zip_county.rb +1 -1
  72. data/lib/vericred_client/models/zip_county_bulk.rb +12 -12
  73. data/lib/vericred_client/models/zip_county_response.rb +21 -11
  74. data/lib/vericred_client/version.rb +2 -2
  75. data/lib/vericred_client.rb +10 -3
  76. data/spec/api/drugs_api_spec.rb +26 -5
  77. data/spec/api/networks_api_spec.rb +166 -0
  78. data/spec/api/plans_api_spec.rb +66 -6
  79. data/spec/api/providers_api_spec.rb +27 -19
  80. data/spec/api/zip_counties_api_spec.rb +4 -3
  81. metadata +22 -6
data/docs/PlansApi.md CHANGED
@@ -4,12 +4,74 @@ All URIs are relative to *https://api.vericred.com/*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**post_plans_find**](PlansApi.md#post_plans_find) | **POST** /plans/find |
7
+ [**find_plans**](PlansApi.md#find_plans) | **POST** /plans/search | Find Plans
8
8
 
9
9
 
10
- # **post_plans_find**
11
- > PlanFindResponse post_plans_find(opts)
10
+ # **find_plans**
11
+ > PlanSearchResponse find_plans(opts)
12
12
 
13
+ Find Plans
14
+
15
+ ### Location Information
16
+
17
+ Searching for a set of plans requires a `zip_code` and `fips_code`
18
+ code. These are used to determine pricing and availabity
19
+ of health plans.
20
+
21
+ Optionally, you may provide a list of Applicants or Providers
22
+
23
+ ### Applicants
24
+
25
+ This is a list of people who will be covered by the plan. We
26
+ use this list to calculate the premium. You must include `age`
27
+ and can include `smoker`, which also factors into pricing in some
28
+ states.
29
+
30
+ Applicants *must* include an age. If smoker is omitted, its value is assumed
31
+ to be false.
32
+
33
+ #### Multiple Applicants
34
+ To get pricing for multiple applicants, just append multiple sets
35
+ of data to the URL with the age and smoking status of each applicant
36
+ next to each other.
37
+
38
+ For example, given two applicants - one age 32 and a non-smoker and one
39
+ age 29 and a smoker, you could use the following request
40
+
41
+ `GET /plans?zip_code=07451&fips_code=33025&applicants[][age]=32&applicants[][age]=29&applicants[][smoker]=true`
42
+
43
+ It would also be acceptible to include `applicants[][smoker]=false` after the
44
+ first applicant's age.
45
+
46
+ ### Providers
47
+
48
+ We identify Providers (Doctors) by their National Practitioner
49
+ Index number (NPI). If you pass a list of Providers, keyed by
50
+ their NPI number, we will return a list of which Providers are
51
+ in and out of network for each plan returned.
52
+
53
+ For example, if we had two providers with the NPI numbers `12345` and `23456`
54
+ you would make the following request
55
+
56
+ `GET /plans?zip_code=07451&fips_code=33025&providers[][npi]=12345&providers[][npi]=23456`
57
+
58
+ ### Enrollment Date
59
+
60
+ To calculate plan pricing and availability, we default to the current date
61
+ as the enrollment date. To specify a date in the future (or the past), pass
62
+ a string with the format `YYYY-MM-DD` in the `enrollment_date` parameter.
63
+
64
+ `GET /plans?zip_code=07451&fips_code=33025&enrollment_date=2016-01-01`
65
+
66
+ ### Subsidy
67
+
68
+ On-marketplace plans are eligible for a subsidy based on the
69
+ `household_size` and `household_income` of the applicants. If you
70
+ pass those values, we will calculate the `subsidized_premium`
71
+ and return it for each plan. If no values are provided, the
72
+ `subsidized_premium` will be the same as the `premium`
73
+
74
+ `GET /plans?zip_code=07451&fips_code=33025&household_size=4&household_income=40000`
13
75
 
14
76
 
15
77
  ### Example
@@ -24,10 +86,11 @@ opts = {
24
86
  }
25
87
 
26
88
  begin
27
- result = api_instance.post_plans_find(opts)
89
+ #Find Plans
90
+ result = api_instance.find_plans(opts)
28
91
  p result
29
92
  rescue VericredClient::ApiError => e
30
- puts "Exception when calling PlansApi->post_plans_find: #{e}"
93
+ puts "Exception when calling PlansApi->find_plans: #{e}"
31
94
  end
32
95
  ```
33
96
 
@@ -39,7 +102,7 @@ Name | Type | Description | Notes
39
102
 
40
103
  ### Return type
41
104
 
42
- [**PlanFindResponse**](PlanFindResponse.md)
105
+ [**PlanSearchResponse**](PlanSearchResponse.md)
43
106
 
44
107
  ### Authorization
45
108
 
data/docs/Provider.md CHANGED
@@ -3,21 +3,22 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **accepting_change_of_payor_patients** | **BOOLEAN** | Is this provider accepting patients with a change of insurance? | [optional] [default to false]
7
- **accepting_medicaid_patients** | **BOOLEAN** | Is this provider accepting new Medicaid patients? | [optional] [default to false]
8
- **accepting_medicare_patients** | **BOOLEAN** | Is this provider accepting new Medicare patients? | [optional] [default to false]
9
- **accepting_private_patients** | **BOOLEAN** | Is this provider accepting new patients with private insurance? | [optional] [default to false]
10
- **accepting_referral_patients** | **BOOLEAN** | Is this provider accepting new patients via referrals? | [optional] [default to false]
6
+ **accepting_change_of_payor_patients** | **BOOLEAN** | Is this provider accepting patients with a change of insurance? | [optional]
7
+ **accepting_medicaid_patients** | **BOOLEAN** | Is this provider accepting new Medicaid patients? | [optional]
8
+ **accepting_medicare_patients** | **BOOLEAN** | Is this provider accepting new Medicare patients? | [optional]
9
+ **accepting_private_patients** | **BOOLEAN** | Is this provider accepting new patients with private insurance? | [optional]
10
+ **accepting_referral_patients** | **BOOLEAN** | Is this provider accepting new patients via referrals? | [optional]
11
11
  **city** | **String** | City name (e.g. Springfield). | [optional]
12
12
  **email** | **String** | Primary email address to contact the provider. | [optional]
13
- **first_name** | **String** | Given name for the provider. | [optional]
14
13
  **gender** | **String** | Provider's gender (M or F) | [optional]
14
+ **first_name** | **String** | Given name for the provider. | [optional]
15
15
  **hios_ids** | **Array<String>** | List of HIOS ids for this provider | [optional]
16
16
  **id** | **Integer** | National Provider Index (NPI) number | [optional]
17
17
  **last_name** | **String** | Family name for the provider. | [optional]
18
18
  **latitude** | **Float** | Latitude of provider | [optional]
19
19
  **longitude** | **Float** | Longitude of provider | [optional]
20
20
  **middle_name** | **String** | Middle name for the provider. | [optional]
21
+ **network_ids** | **Array<Integer>** | Array of network ids | [optional]
21
22
  **personal_phone** | **String** | Personal contact phone for the provider. | [optional]
22
23
  **phone** | **String** | Office phone for the provider | [optional]
23
24
  **presentation_name** | **String** | Preferred name for display (e.g. Dr. Francis White may prefer Dr. Frank White) | [optional]
data/docs/ProvidersApi.md CHANGED
@@ -4,14 +4,16 @@ All URIs are relative to *https://api.vericred.com/*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**get_providers**](ProvidersApi.md#get_providers) | **GET** /providers |
8
- [**get_providers_npi**](ProvidersApi.md#get_providers_npi) | **GET** /providers/{npi} |
7
+ [**get_provider**](ProvidersApi.md#get_provider) | **GET** /providers/{npi} | Find a Provider
8
+ [**get_providers**](ProvidersApi.md#get_providers) | **POST** /providers/search | Find Providers
9
9
 
10
10
 
11
- # **get_providers**
12
- > ProviderResponse get_providers(search_term, zip_code, opts)
11
+ # **get_provider**
12
+ > Provider get_provider(npi, opts)
13
13
 
14
+ Find a Provider
14
15
 
16
+ To retrieve a specific provider, just perform a GET using his NPI number
15
17
 
16
18
  ### Example
17
19
  ```ruby
@@ -20,23 +22,18 @@ require 'vericred_client'
20
22
 
21
23
  api_instance = VericredClient::ProvidersApi.new
22
24
 
23
- search_term = "search_term_example" # String | String to search by
24
-
25
- zip_code = "zip_code_example" # String | Zip Code to search near
25
+ npi = "1234567890" # String | NPI number
26
26
 
27
27
  opts = {
28
- accepts_insurance: "accepts_insurance_example", # String | Limit results to Providers who accept at least one insurance plan. Note that the inverse of this filter is not supported and any value will evaluate to true
29
- page: "page_example", # String | Page number
30
- per_page: "per_page_example", # String | Number of records to return per page
31
- radius: "radius_example", # String | Radius (in miles) to use to limit results
32
- type: "type_example" # String | Either organization or individual
28
+ vericred_api_key: "api-doc-key" # String | API Key
33
29
  }
34
30
 
35
31
  begin
36
- result = api_instance.get_providers(search_term, zip_code, opts)
32
+ #Find a Provider
33
+ result = api_instance.get_provider(npi, opts)
37
34
  p result
38
35
  rescue VericredClient::ApiError => e
39
- puts "Exception when calling ProvidersApi->get_providers: #{e}"
36
+ puts "Exception when calling ProvidersApi->get_provider: #{e}"
40
37
  end
41
38
  ```
42
39
 
@@ -44,17 +41,12 @@ end
44
41
 
45
42
  Name | Type | Description | Notes
46
43
  ------------- | ------------- | ------------- | -------------
47
- **search_term** | **String**| String to search by |
48
- **zip_code** | **String**| Zip Code to search near |
49
- **accepts_insurance** | **String**| Limit results to Providers who accept at least one insurance plan. Note that the inverse of this filter is not supported and any value will evaluate to true | [optional]
50
- **page** | **String**| Page number | [optional]
51
- **per_page** | **String**| Number of records to return per page | [optional]
52
- **radius** | **String**| Radius (in miles) to use to limit results | [optional]
53
- **type** | **String**| Either organization or individual | [optional]
44
+ **npi** | **String**| NPI number |
45
+ **vericred_api_key** | **String**| API Key | [optional]
54
46
 
55
47
  ### Return type
56
48
 
57
- [**ProviderResponse**](ProviderResponse.md)
49
+ [**Provider**](Provider.md)
58
50
 
59
51
  ### Authorization
60
52
 
@@ -67,9 +59,24 @@ No authorization required
67
59
 
68
60
 
69
61
 
70
- # **get_providers_npi**
71
- > ProviderResponse get_providers_npi(npi)
62
+ # **get_providers**
63
+ > ProvidersSearchResponse get_providers(opts)
64
+
65
+ Find Providers
66
+
67
+ All `Provider` searches require a `zip_code`, which we use for weighting
68
+ the search results to favor `Provider`s that are near the user. For example,
69
+ we would want "Dr. John Smith" who is 5 miles away to appear before
70
+ "Dr. John Smith" who is 100 miles away.
72
71
 
72
+ The weighting also allows for non-exact matches. In our prior example, we
73
+ would want "Dr. Jon Smith" who is 2 miles away to appear before the exact
74
+ match "Dr. John Smith" who is 100 miles away because it is more likely that
75
+ the user just entered an incorrect name.
76
+
77
+ The free text search also supports Specialty name search and "body part"
78
+ Specialty name search. So, searching "John Smith nose" would return
79
+ "Dr. John Smith", the ENT Specialist before "Dr. John Smith" the Internist.
73
80
 
74
81
 
75
82
  ### Example
@@ -79,14 +86,16 @@ require 'vericred_client'
79
86
 
80
87
  api_instance = VericredClient::ProvidersApi.new
81
88
 
82
- npi = "npi_example" # String | NPI number
83
-
89
+ opts = {
90
+ body: VericredClient::RequestProvidersSearch.new # RequestProvidersSearch |
91
+ }
84
92
 
85
93
  begin
86
- result = api_instance.get_providers_npi(npi)
94
+ #Find Providers
95
+ result = api_instance.get_providers(opts)
87
96
  p result
88
97
  rescue VericredClient::ApiError => e
89
- puts "Exception when calling ProvidersApi->get_providers_npi: #{e}"
98
+ puts "Exception when calling ProvidersApi->get_providers: #{e}"
90
99
  end
91
100
  ```
92
101
 
@@ -94,11 +103,11 @@ end
94
103
 
95
104
  Name | Type | Description | Notes
96
105
  ------------- | ------------- | ------------- | -------------
97
- **npi** | **String**| NPI number |
106
+ **body** | [**RequestProvidersSearch**](RequestProvidersSearch.md)| | [optional]
98
107
 
99
108
  ### Return type
100
109
 
101
- [**ProviderResponse**](ProviderResponse.md)
110
+ [**ProvidersSearchResponse**](ProvidersSearchResponse.md)
102
111
 
103
112
  ### Authorization
104
113
 
@@ -1,4 +1,4 @@
1
- # VericredClient::ProviderResponse
1
+ # VericredClient::ProvidersSearchResponse
2
2
 
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
@@ -3,13 +3,14 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **applicants** | [**Array<Applicant>**](Applicant.md) | Applicants for desired plans. | [optional]
6
+ **applicants** | [**Array<RequestPlanFindApplicant>**](RequestPlanFindApplicant.md) | Applicants for desired plans. | [optional]
7
7
  **enrollment_date** | **String** | Date of enrollment | [optional]
8
+ **drug_packages** | [**Array<DrugPackage>**](DrugPackage.md) | National Drug Code Package Id | [optional]
8
9
  **fips_code** | **String** | County code to determine eligibility | [optional]
9
10
  **household_income** | **Integer** | Total household income. | [optional]
10
11
  **household_size** | **Integer** | Number of people living in household. | [optional]
11
12
  **market** | **String** | Type of plan to search for. | [optional]
12
- **providers** | [**Array<Provider>**](Provider.md) | List of providers to search for. | [optional]
13
+ **providers** | [**Array<RequestPlanFindProvider>**](RequestPlanFindProvider.md) | List of providers to search for. | [optional]
13
14
  **zip_code** | **String** | 5-digit zip code - this helps determine pricing. | [optional]
14
15
 
15
16
 
@@ -0,0 +1,8 @@
1
+ # VericredClient::RequestPlanFindApplicant
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **age** | **Integer** | Age of applicant to search for | [optional]
7
+
8
+
@@ -0,0 +1,8 @@
1
+ # VericredClient::RequestPlanFindProvider
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **npi** | **Integer** | NPI of provider to search for | [optional]
7
+
8
+
@@ -0,0 +1,17 @@
1
+ # VericredClient::RequestProvidersSearch
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **accepts_insurance** | **BOOLEAN** | Limit results to Providers who accept at least one insurance
7
+ plan. Note that the inverse of this filter is not supported and
8
+ any value will evaluate to true | [optional]
9
+ **hios_ids** | **Array<String>** | List of HIOS ids | [optional]
10
+ **page** | **Integer** | Page number | [optional]
11
+ **per_page** | **Integer** | Number of records to return per page | [optional]
12
+ **radius** | **Integer** | Radius (in miles) to use to limit results | [optional]
13
+ **search_term** | **String** | String to search by | [optional]
14
+ **zip_code** | **String** | Zip Code to search near | [optional]
15
+ **type** | **String** | Either organization or individual | [optional]
16
+
17
+
data/docs/State.md CHANGED
@@ -3,13 +3,13 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
+ **id** | **Integer** | Primary Key of State | [optional]
7
+ **name** | **String** | Name of state | [optional]
6
8
  **code** | **String** | 2 letter code for state | [optional]
7
9
  **fips_number** | **String** | National FIPs number | [optional]
8
- **id** | **Integer** | Primary Key of State | [optional]
9
10
  **last_date_for_individual** | **Date** | Last date this state is live for individuals | [optional]
10
11
  **last_date_for_shop** | **Date** | Last date this state is live for shop | [optional]
11
- **live_for_business** | **BOOLEAN** | Is this State available for businesses | [optional] [default to false]
12
- **live_for_consumers** | **BOOLEAN** | Is this State available for individuals | [optional] [default to false]
13
- **name** | **String** | Name of state | [optional]
12
+ **live_for_business** | **BOOLEAN** | Is this State available for businesses | [optional]
13
+ **live_for_consumers** | **BOOLEAN** | Is this State available for individuals | [optional]
14
14
 
15
15
 
@@ -4,13 +4,15 @@ All URIs are relative to *https://api.vericred.com/*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**get_zip_counties**](ZipCountiesApi.md#get_zip_counties) | **GET** /zip_counties |
7
+ [**get_zip_counties**](ZipCountiesApi.md#get_zip_counties) | **GET** /zip_counties | Search for Zip Counties
8
8
 
9
9
 
10
10
  # **get_zip_counties**
11
- > ZipCountyResponse get_zip_counties(zip_prefix)
11
+ > ZipCountyResponse get_zip_counties(zip_prefix, opts)
12
12
 
13
+ Search for Zip Counties
13
14
 
15
+ 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.
14
16
 
15
17
  ### Example
16
18
  ```ruby
@@ -19,11 +21,15 @@ require 'vericred_client'
19
21
 
20
22
  api_instance = VericredClient::ZipCountiesApi.new
21
23
 
22
- zip_prefix = "zip_prefix_example" # String | Partial five-digit Zip
24
+ zip_prefix = "1002" # String | Partial five-digit Zip
23
25
 
26
+ opts = {
27
+ vericred_api_key: "api-doc-key" # String | API Key
28
+ }
24
29
 
25
30
  begin
26
- result = api_instance.get_zip_counties(zip_prefix)
31
+ #Search for Zip Counties
32
+ result = api_instance.get_zip_counties(zip_prefix, opts)
27
33
  p result
28
34
  rescue VericredClient::ApiError => e
29
35
  puts "Exception when calling ZipCountiesApi->get_zip_counties: #{e}"
@@ -35,6 +41,7 @@ end
35
41
  Name | Type | Description | Notes
36
42
  ------------- | ------------- | ------------- | -------------
37
43
  **zip_prefix** | **String**| Partial five-digit Zip |
44
+ **vericred_api_key** | **String**| API Key | [optional]
38
45
 
39
46
  ### Return type
40
47
 
@@ -0,0 +1,11 @@
1
+ # VericredClient::ZipCountiesResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **counties** | [**Array<County>**](County.md) | Counties that exist in the provided zip prefix. | [optional]
7
+ **states** | [**Array<State>**](State.md) | States that exist in the provided zip prefix. | [optional]
8
+ **zip_counties** | [**Array<ZipCounty>**](ZipCounty.md) | ZipCounties that exist in the provided zip prefix. | [optional]
9
+ **zip_codes** | [**Array<ZipCode>**](ZipCode.md) | ZipCodes that exist in the provided zip prefix. | [optional]
10
+
11
+
@@ -3,9 +3,9 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **county_id** | **String** | Foreign key for county (fips code) | [optional]
7
6
  **id** | **Integer** | Primary key | [optional]
8
7
  **rating_area_id** | **String** | Foreign key for rating area | [optional]
8
+ **county_id** | **String** | Foreign key for county (fips code) | [optional]
9
9
  **zip_code_id** | **String** | Foreign key for zip code (zip code) | [optional]
10
10
 
11
11
 
@@ -4,7 +4,8 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **counties** | [**Array<County>**](County.md) | Counties that exist in the provided zip prefix. | [optional]
7
+ **states** | [**Array<State>**](State.md) | States that exist in the provided zip prefix. | [optional]
7
8
  **zip_codes** | [**Array<ZipCode>**](ZipCode.md) | ZipCodes that exist in the provided zip prefix. | [optional]
8
- **zip_counties** | [**Array<ZipCounty>**](ZipCounty.md) | ZipCounties that exist in the provided zip prefix. | [optional]
9
+ **zip_county** | [**ZipCounty**](ZipCounty.md) | ZipCounty data | [optional]
9
10
 
10
11
 
@@ -6,7 +6,7 @@ accepts.
6
6
 
7
7
  ## Getting Started
8
8
 
9
- Visit our [Developer Portal](https://vericred.3scale.net/access_code?access_code=vericred&cms_token=3545ca52af07bde85b7c0c3aa9d1985e) to
9
+ Visit our [Developer Portal](https://vericred.3scale.net) to
10
10
  create an account.
11
11
 
12
12
  Once you have created an account, you can create one Application for
@@ -133,37 +133,47 @@ module VericredClient
133
133
  @api_client = api_client
134
134
  end
135
135
 
136
- # Drug Coverages are the specific tier level, quantity limit, prior authorization and step therapy for a given Drug/Plan
137
- # Drug Coverages are the specific tier level, quantity limit, prior authorization and step therapy for a given Drug/Plan combination. This endpoint returns all DrugCoverages for a given Drug
136
+ # Search for DrugCoverages
137
+ # Drug Coverages are the specific tier level, quantity limit, prior
138
+ authorization and step therapy for a given Drug/Plan combination. This endpoint
139
+ returns all DrugCoverages for a given Drug
138
140
  # @param ndc_package_code NDC package code
141
+ # @param audience Two-character state code
139
142
  # @param state_code Two-character state code
140
143
  # @param [Hash] opts the optional parameters
144
+ # @option opts [String] :vericred_api_key API Key
141
145
  # @return [DrugCoverageResponse]
142
- def get_drugs_coverages_ndc(ndc_package_code, state_code, opts = {})
143
- data, _status_code, _headers = get_drugs_coverages_ndc_with_http_info(ndc_package_code, state_code, opts)
146
+ def get_drug_coverages(ndc_package_code, audience, state_code, opts = {})
147
+ data, _status_code, _headers = get_drug_coverages_with_http_info(ndc_package_code, audience, state_code, opts)
144
148
  return data
145
149
  end
146
150
 
147
- # Drug Coverages are the specific tier level, quantity limit, prior authorization and step therapy for a given Drug/Plan
148
- # Drug Coverages are the specific tier level, quantity limit, prior authorization and step therapy for a given Drug/Plan combination. This endpoint returns all DrugCoverages for a given Drug
151
+ # Search for DrugCoverages
152
+ # Drug Coverages are the specific tier level, quantity limit, prior
153
+ authorization and step therapy for a given Drug/Plan combination. This endpoint
154
+ returns all DrugCoverages for a given Drug
149
155
  # @param ndc_package_code NDC package code
156
+ # @param audience Two-character state code
150
157
  # @param state_code Two-character state code
151
158
  # @param [Hash] opts the optional parameters
159
+ # @option opts [String] :vericred_api_key API Key
152
160
  # @return [Array<(DrugCoverageResponse, Fixnum, Hash)>] DrugCoverageResponse data, response status code and response headers
153
- def get_drugs_coverages_ndc_with_http_info(ndc_package_code, state_code, opts = {})
161
+ def get_drug_coverages_with_http_info(ndc_package_code, audience, state_code, opts = {})
154
162
  if @api_client.config.debugging
155
- @api_client.config.logger.debug "Calling API: DrugsApi.get_drugs_coverages_ndc ..."
163
+ @api_client.config.logger.debug "Calling API: DrugsApi.get_drug_coverages ..."
156
164
  end
157
165
  # verify the required parameter 'ndc_package_code' is set
158
- fail ArgumentError, "Missing the required parameter 'ndc_package_code' when calling DrugsApi.get_drugs_coverages_ndc" if ndc_package_code.nil?
166
+ fail ArgumentError, "Missing the required parameter 'ndc_package_code' when calling DrugsApi.get_drug_coverages" if ndc_package_code.nil?
167
+ # verify the required parameter 'audience' is set
168
+ fail ArgumentError, "Missing the required parameter 'audience' when calling DrugsApi.get_drug_coverages" if audience.nil?
159
169
  # verify the required parameter 'state_code' is set
160
- fail ArgumentError, "Missing the required parameter 'state_code' when calling DrugsApi.get_drugs_coverages_ndc" if state_code.nil?
170
+ fail ArgumentError, "Missing the required parameter 'state_code' when calling DrugsApi.get_drug_coverages" if state_code.nil?
161
171
  # resource path
162
- local_var_path = "/drugs/coverages".sub('{format}','json')
172
+ local_var_path = "/drug_packages/{ndc_package_code}/coverages".sub('{format}','json').sub('{' + 'ndc_package_code' + '}', ndc_package_code.to_s)
163
173
 
164
174
  # query parameters
165
175
  query_params = {}
166
- query_params[:'ndc_package_code'] = ndc_package_code
176
+ query_params[:'audience'] = audience
167
177
  query_params[:'state_code'] = state_code
168
178
 
169
179
  # header parameters
@@ -176,6 +186,7 @@ module VericredClient
176
186
  # HTTP header 'Content-Type'
177
187
  local_header_content_type = []
178
188
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
189
+ header_params[:'Vericred-Api-Key'] = opts[:'vericred_api_key'] if opts[:'vericred_api_key']
179
190
 
180
191
  # form parameters
181
192
  form_params = {}
@@ -191,7 +202,68 @@ module VericredClient
191
202
  :auth_names => auth_names,
192
203
  :return_type => 'DrugCoverageResponse')
193
204
  if @api_client.config.debugging
194
- @api_client.config.logger.debug "API called: DrugsApi#get_drugs_coverages_ndc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
205
+ @api_client.config.logger.debug "API called: DrugsApi#get_drug_coverages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
206
+ end
207
+ return data, status_code, headers
208
+ end
209
+
210
+ # Drug Search
211
+ # Search for drugs by proprietary name
212
+ # @param search_term Full or partial proprietary name of drug
213
+ # @param [Hash] opts the optional parameters
214
+ # @option opts [String] :vericred_api_key API Key
215
+ # @return [DrugSearchResponse]
216
+ def list_drugs(search_term, opts = {})
217
+ data, _status_code, _headers = list_drugs_with_http_info(search_term, opts)
218
+ return data
219
+ end
220
+
221
+ # Drug Search
222
+ # Search for drugs by proprietary name
223
+ # @param search_term Full or partial proprietary name of drug
224
+ # @param [Hash] opts the optional parameters
225
+ # @option opts [String] :vericred_api_key API Key
226
+ # @return [Array<(DrugSearchResponse, Fixnum, Hash)>] DrugSearchResponse data, response status code and response headers
227
+ def list_drugs_with_http_info(search_term, opts = {})
228
+ if @api_client.config.debugging
229
+ @api_client.config.logger.debug "Calling API: DrugsApi.list_drugs ..."
230
+ end
231
+ # verify the required parameter 'search_term' is set
232
+ fail ArgumentError, "Missing the required parameter 'search_term' when calling DrugsApi.list_drugs" if search_term.nil?
233
+ # resource path
234
+ local_var_path = "/drugs".sub('{format}','json')
235
+
236
+ # query parameters
237
+ query_params = {}
238
+ query_params[:'search_term'] = search_term
239
+
240
+ # header parameters
241
+ header_params = {}
242
+
243
+ # HTTP header 'Accept' (if needed)
244
+ local_header_accept = ['application/json']
245
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
246
+
247
+ # HTTP header 'Content-Type'
248
+ local_header_content_type = ['application/json']
249
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
250
+ header_params[:'Vericred-Api-Key'] = opts[:'vericred_api_key'] if opts[:'vericred_api_key']
251
+
252
+ # form parameters
253
+ form_params = {}
254
+
255
+ # http body (model)
256
+ post_body = nil
257
+ auth_names = []
258
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
259
+ :header_params => header_params,
260
+ :query_params => query_params,
261
+ :form_params => form_params,
262
+ :body => post_body,
263
+ :auth_names => auth_names,
264
+ :return_type => 'DrugSearchResponse')
265
+ if @api_client.config.debugging
266
+ @api_client.config.logger.debug "API called: DrugsApi#list_drugs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
195
267
  end
196
268
  return data, status_code, headers
197
269
  end