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.
- checksums.yaml +4 -4
- data/README.md +31 -18
- data/docs/Applicant.md +3 -3
- data/docs/Carrier.md +1 -1
- data/docs/County.md +3 -3
- data/docs/Drug.md +3 -3
- data/docs/DrugCoverage.md +4 -4
- data/docs/DrugCoverageResponse.md +3 -1
- data/docs/DrugPackage.md +1 -1
- data/docs/DrugSearchResponse.md +2 -1
- data/docs/DrugsApi.md +71 -10
- data/docs/Meta.md +1 -1
- data/docs/Network.md +9 -0
- data/docs/NetworkSearchResponse.md +9 -0
- data/docs/NetworksApi.md +58 -0
- data/docs/Plan.md +10 -10
- data/docs/PlanCounty.md +1 -1
- data/docs/PlanCountyBulk.md +1 -1
- data/docs/{PlanFindResponse.md → PlanSearchResponse.md} +2 -1
- data/docs/PlanSearchResult.md +14 -14
- data/docs/PlansApi.md +69 -6
- data/docs/Provider.md +7 -6
- data/docs/ProvidersApi.md +39 -30
- data/docs/{ProviderResponse.md → ProvidersSearchResponse.md} +1 -1
- data/docs/RequestPlanFind.md +3 -2
- data/docs/RequestPlanFindApplicant.md +8 -0
- data/docs/RequestPlanFindProvider.md +8 -0
- data/docs/RequestProvidersSearch.md +17 -0
- data/docs/State.md +4 -4
- data/docs/ZipCountiesApi.md +11 -4
- data/docs/ZipCountiesResponse.md +11 -0
- data/docs/ZipCountyBulk.md +1 -1
- data/docs/ZipCountyResponse.md +2 -1
- data/lib/vericred_client/api/drugs_api.rb +86 -14
- data/lib/vericred_client/api/networks_api.rb +198 -0
- data/lib/vericred_client/api/plans_api.rb +134 -14
- data/lib/vericred_client/api/providers_api.rb +65 -59
- data/lib/vericred_client/api/zip_counties_api.rb +8 -5
- data/lib/vericred_client/api_client.rb +1 -1
- data/lib/vericred_client/api_error.rb +1 -1
- data/lib/vericred_client/models/applicant.rb +13 -15
- data/lib/vericred_client/models/base.rb +1 -1
- data/lib/vericred_client/models/carrier.rb +15 -15
- data/lib/vericred_client/models/carrier_subsidiary.rb +1 -1
- data/lib/vericred_client/models/county.rb +12 -16
- data/lib/vericred_client/models/county_bulk.rb +1 -1
- data/lib/vericred_client/models/drug.rb +26 -26
- data/lib/vericred_client/models/drug_coverage.rb +32 -38
- data/lib/vericred_client/models/drug_coverage_response.rb +40 -16
- data/lib/vericred_client/models/drug_package.rb +15 -15
- data/lib/vericred_client/models/drug_search_response.rb +21 -9
- data/lib/vericred_client/models/meta.rb +8 -8
- data/lib/vericred_client/models/network.rb +308 -0
- data/lib/vericred_client/models/{plan_find_response.rb → network_search_response.rb} +11 -11
- data/lib/vericred_client/models/plan.rb +62 -72
- data/lib/vericred_client/models/plan_county.rb +15 -15
- data/lib/vericred_client/models/plan_county_bulk.rb +15 -15
- data/lib/vericred_client/models/plan_search_response.rb +322 -0
- data/lib/vericred_client/models/plan_search_result.rb +102 -112
- data/lib/vericred_client/models/pricing.rb +1 -1
- data/lib/vericred_client/models/provider.rb +24 -22
- data/lib/vericred_client/models/{provider_response.rb → providers_search_response.rb} +2 -2
- data/lib/vericred_client/models/rating_area.rb +1 -1
- data/lib/vericred_client/models/request_plan_find.rb +16 -4
- data/lib/vericred_client/models/request_plan_find_applicant.rb +298 -0
- data/lib/vericred_client/models/request_plan_find_provider.rb +298 -0
- data/lib/vericred_client/models/request_providers_search.rb +372 -0
- data/lib/vericred_client/models/state.rb +25 -29
- data/lib/vericred_client/models/zip_code.rb +1 -1
- data/lib/vericred_client/models/zip_counties_response.rb +336 -0
- data/lib/vericred_client/models/zip_county.rb +1 -1
- data/lib/vericred_client/models/zip_county_bulk.rb +12 -12
- data/lib/vericred_client/models/zip_county_response.rb +21 -11
- data/lib/vericred_client/version.rb +2 -2
- data/lib/vericred_client.rb +10 -3
- data/spec/api/drugs_api_spec.rb +26 -5
- data/spec/api/networks_api_spec.rb +166 -0
- data/spec/api/plans_api_spec.rb +66 -6
- data/spec/api/providers_api_spec.rb +27 -19
- data/spec/api/zip_counties_api_spec.rb +4 -3
- metadata +22 -6
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9dfa77f224ef3e3817ea7102b5defed6eb4ff72e
|
4
|
+
data.tar.gz: a3dfd8d3d191fd6f72f9f044489b46c99a9a81f5
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e4bf3e8ccddf768b8d45216bc639b25bab4bff70942f53ea9d89ff132feb8f388e593bcc3b550515f0c214167c0ced0cb6cc9864f72d45b6de81586721febd7f
|
7
|
+
data.tar.gz: b31143c1abf1cb1d29b70409bab2330eb743504a941c037470fec0efcd4699efa7f48edb1659b1cf0faae33b0117e55fd1617f86a3f807521b106bb8734a6546
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ accepts.
|
|
7
7
|
|
8
8
|
## Getting Started
|
9
9
|
|
10
|
-
Visit our [Developer Portal](https://vericred.3scale.net
|
10
|
+
Visit our [Developer Portal](https://vericred.3scale.net) to
|
11
11
|
create an account.
|
12
12
|
|
13
13
|
Once you have created an account, you can create one Application for
|
@@ -120,8 +120,8 @@ The response would be
|
|
120
120
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
121
121
|
|
122
122
|
- API version: 1.0.0
|
123
|
-
- Package version: 0.0.
|
124
|
-
- Build date: 2016-05-
|
123
|
+
- Package version: 0.0.5
|
124
|
+
- Build date: 2016-05-31T09:28:47.149-04:00
|
125
125
|
- Build package: class io.swagger.codegen.languages.RubyClientCodegen
|
126
126
|
|
127
127
|
## Installation
|
@@ -137,15 +137,15 @@ gem build vericred_client.gemspec
|
|
137
137
|
Then either install the gem locally:
|
138
138
|
|
139
139
|
```shell
|
140
|
-
gem install ./vericred_client-0.0.
|
140
|
+
gem install ./vericred_client-0.0.5.gem
|
141
141
|
```
|
142
|
-
(for development, run `gem install --dev ./vericred_client-0.0.
|
142
|
+
(for development, run `gem install --dev ./vericred_client-0.0.5.gem` to install the development dependencies)
|
143
143
|
|
144
144
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
145
145
|
|
146
146
|
Finally add this to the Gemfile:
|
147
147
|
|
148
|
-
gem 'vericred_client', '~> 0.0.
|
148
|
+
gem 'vericred_client', '~> 0.0.5'
|
149
149
|
|
150
150
|
### Install from Git
|
151
151
|
|
@@ -170,17 +170,22 @@ require 'vericred_client'
|
|
170
170
|
|
171
171
|
api_instance = VericredClient::DrugsApi.new
|
172
172
|
|
173
|
-
ndc_package_code = "
|
173
|
+
ndc_package_code = "12345-4321-11" # String | NDC package code
|
174
174
|
|
175
|
-
|
175
|
+
audience = "individual" # String | Two-character state code
|
176
176
|
|
177
|
+
state_code = "NY" # String | Two-character state code
|
178
|
+
|
179
|
+
opts = {
|
180
|
+
vericred_api_key: "api-doc-key" # String | API Key
|
181
|
+
}
|
177
182
|
|
178
183
|
begin
|
179
|
-
#
|
180
|
-
result = api_instance.
|
184
|
+
#Search for DrugCoverages
|
185
|
+
result = api_instance.get_drug_coverages(ndc_package_code, audience, state_code, opts)
|
181
186
|
p result
|
182
187
|
rescue VericredClient::ApiError => e
|
183
|
-
puts "Exception when calling DrugsApi->
|
188
|
+
puts "Exception when calling DrugsApi->get_drug_coverages: #{e}"
|
184
189
|
end
|
185
190
|
|
186
191
|
```
|
@@ -191,11 +196,13 @@ All URIs are relative to *https://api.vericred.com/*
|
|
191
196
|
|
192
197
|
Class | Method | HTTP request | Description
|
193
198
|
------------ | ------------- | ------------- | -------------
|
194
|
-
*VericredClient::DrugsApi* | [**
|
195
|
-
*VericredClient::
|
196
|
-
*VericredClient::
|
197
|
-
*VericredClient::
|
198
|
-
*VericredClient::
|
199
|
+
*VericredClient::DrugsApi* | [**get_drug_coverages**](docs/DrugsApi.md#get_drug_coverages) | **GET** /drug_packages/{ndc_package_code}/coverages | Search for DrugCoverages
|
200
|
+
*VericredClient::DrugsApi* | [**list_drugs**](docs/DrugsApi.md#list_drugs) | **GET** /drugs | Drug Search
|
201
|
+
*VericredClient::NetworksApi* | [**list_networks**](docs/NetworksApi.md#list_networks) | **GET** /networks | Networks
|
202
|
+
*VericredClient::PlansApi* | [**find_plans**](docs/PlansApi.md#find_plans) | **POST** /plans/search | Find Plans
|
203
|
+
*VericredClient::ProvidersApi* | [**get_provider**](docs/ProvidersApi.md#get_provider) | **GET** /providers/{npi} | Find a Provider
|
204
|
+
*VericredClient::ProvidersApi* | [**get_providers**](docs/ProvidersApi.md#get_providers) | **POST** /providers/search | Find Providers
|
205
|
+
*VericredClient::ZipCountiesApi* | [**get_zip_counties**](docs/ZipCountiesApi.md#get_zip_counties) | **GET** /zip_counties | Search for Zip Counties
|
199
206
|
|
200
207
|
|
201
208
|
## Documentation for Models
|
@@ -212,18 +219,24 @@ Class | Method | HTTP request | Description
|
|
212
219
|
- [VericredClient::DrugPackage](docs/DrugPackage.md)
|
213
220
|
- [VericredClient::DrugSearchResponse](docs/DrugSearchResponse.md)
|
214
221
|
- [VericredClient::Meta](docs/Meta.md)
|
222
|
+
- [VericredClient::Network](docs/Network.md)
|
223
|
+
- [VericredClient::NetworkSearchResponse](docs/NetworkSearchResponse.md)
|
215
224
|
- [VericredClient::Plan](docs/Plan.md)
|
216
225
|
- [VericredClient::PlanCounty](docs/PlanCounty.md)
|
217
226
|
- [VericredClient::PlanCountyBulk](docs/PlanCountyBulk.md)
|
218
|
-
- [VericredClient::
|
227
|
+
- [VericredClient::PlanSearchResponse](docs/PlanSearchResponse.md)
|
219
228
|
- [VericredClient::PlanSearchResult](docs/PlanSearchResult.md)
|
220
229
|
- [VericredClient::Pricing](docs/Pricing.md)
|
221
230
|
- [VericredClient::Provider](docs/Provider.md)
|
222
|
-
- [VericredClient::
|
231
|
+
- [VericredClient::ProvidersSearchResponse](docs/ProvidersSearchResponse.md)
|
223
232
|
- [VericredClient::RatingArea](docs/RatingArea.md)
|
224
233
|
- [VericredClient::RequestPlanFind](docs/RequestPlanFind.md)
|
234
|
+
- [VericredClient::RequestPlanFindApplicant](docs/RequestPlanFindApplicant.md)
|
235
|
+
- [VericredClient::RequestPlanFindProvider](docs/RequestPlanFindProvider.md)
|
236
|
+
- [VericredClient::RequestProvidersSearch](docs/RequestProvidersSearch.md)
|
225
237
|
- [VericredClient::State](docs/State.md)
|
226
238
|
- [VericredClient::ZipCode](docs/ZipCode.md)
|
239
|
+
- [VericredClient::ZipCountiesResponse](docs/ZipCountiesResponse.md)
|
227
240
|
- [VericredClient::ZipCounty](docs/ZipCounty.md)
|
228
241
|
- [VericredClient::ZipCountyBulk](docs/ZipCountyBulk.md)
|
229
242
|
- [VericredClient::ZipCountyResponse](docs/ZipCountyResponse.md)
|
data/docs/Applicant.md
CHANGED
@@ -3,12 +3,12 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**dob** | **Date** | Date of Birth | [optional]
|
7
6
|
**id** | **Integer** | Primary key | [optional]
|
8
|
-
**
|
7
|
+
**dob** | **Date** | Date of Birth | [optional]
|
8
|
+
**member_id** | **String** | Member token | [optional]
|
9
9
|
**name** | **String** | Full name of the Applicant | [optional]
|
10
10
|
**relationship** | **String** | Relationship of the Applicant to the Member | [optional]
|
11
|
-
**smoker** | **BOOLEAN** | Does the Applicant smoke? | [optional]
|
11
|
+
**smoker** | **BOOLEAN** | Does the Applicant smoke? | [optional]
|
12
12
|
**ssn** | **String** | Applicant's Social Security Number | [optional]
|
13
13
|
|
14
14
|
|
data/docs/Carrier.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**id** | **Integer** | Primary key | [optional]
|
7
|
-
**logo_path** | **String** | URL for the Carrier's logo | [optional]
|
8
7
|
**name** | **String** | Name of the Carrier | [optional]
|
8
|
+
**logo_path** | **String** | URL for the Carrier's logo | [optional]
|
9
9
|
|
10
10
|
|
data/docs/County.md
CHANGED
@@ -3,12 +3,12 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**fips_code** | **String** | State FIPS code | [optional]
|
7
6
|
**id** | **Integer** | Primary key | [optional]
|
7
|
+
**fips_code** | **String** | State FIPS code | [optional]
|
8
8
|
**name** | **String** | Human-readable name | [optional]
|
9
9
|
**state_code** | **String** | Two-character state code | [optional]
|
10
10
|
**state_id** | **Integer** | state relationship | [optional]
|
11
|
-
**state_live** | **BOOLEAN** | Is the state containing this county active for consumers?(deprecated in favor of last_date_for_individual) | [optional]
|
12
|
-
**state_live_for_business** | **BOOLEAN** | Is the state containing this county active for business?(deprecated in favor of last_date_for_shop) | [optional]
|
11
|
+
**state_live** | **BOOLEAN** | Is the state containing this county active for consumers?(deprecated in favor of last_date_for_individual) | [optional]
|
12
|
+
**state_live_for_business** | **BOOLEAN** | Is the state containing this county active for business?(deprecated in favor of last_date_for_shop) | [optional]
|
13
13
|
|
14
14
|
|
data/docs/Drug.md
CHANGED
@@ -3,9 +3,9 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**
|
7
|
-
**non_proprietary_name** | **String** | Non-proprietary name of drug | [optional]
|
8
|
-
**packages** | [**Array<DrugPackage>**](DrugPackage.md) | Available retail/prescription packages for this drug | [optional]
|
6
|
+
**id** | **String** | National Drug Code ID | [optional]
|
9
7
|
**proprietary_name** | **String** | Proprietary name of drug | [optional]
|
8
|
+
**non_proprietary_name** | **String** | Non-proprietary name of drug | [optional]
|
9
|
+
**drug_package_ids** | **Array<String>** | Array of drug package Ids | [optional]
|
10
10
|
|
11
11
|
|
data/docs/DrugCoverage.md
CHANGED
@@ -3,11 +3,11 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**ndc_package_code** | **String** | NDC package code | [optional]
|
7
6
|
**plan_id** | **String** | Health Insurance Oversight System id | [optional]
|
8
|
-
**
|
9
|
-
**quantity_limit** | **BOOLEAN** | Quantity limit exists | [optional] [default to false]
|
10
|
-
**step_therapy** | **BOOLEAN** | Step Treatment required | [optional] [default to false]
|
7
|
+
**drug_package_id** | **String** | NDC package code | [optional]
|
11
8
|
**tier** | **String** | Tier Name | [optional]
|
9
|
+
**quantity_limit** | **BOOLEAN** | Quantity limit exists | [optional]
|
10
|
+
**prior_authorization** | **BOOLEAN** | Prior authorization required | [optional]
|
11
|
+
**step_therapy** | **BOOLEAN** | Step Treatment required | [optional]
|
12
12
|
|
13
13
|
|
@@ -3,7 +3,9 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**coverages** | [**Array<DrugCoverage>**](DrugCoverage.md) | DrugCoverage search results | [optional]
|
7
6
|
**meta** | [**Meta**](Meta.md) | Metadata for query | [optional]
|
7
|
+
**drug_coverages** | [**Array<DrugCoverage>**](DrugCoverage.md) | DrugCoverage search results | [optional]
|
8
|
+
**drugs** | [**Array<Drug>**](Drug.md) | Drug | [optional]
|
9
|
+
**drug_packages** | [**Array<DrugPackage>**](DrugPackage.md) | Drug Packages | [optional]
|
8
10
|
|
9
11
|
|
data/docs/DrugPackage.md
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | National Drug Code ID (Package) | [optional]
|
6
7
|
**description** | **String** | Package description | [optional]
|
7
|
-
**ndc_package_code** | **String** | National Drug Code ID (Package) | [optional]
|
8
8
|
|
9
9
|
|
data/docs/DrugSearchResponse.md
CHANGED
@@ -3,7 +3,8 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**drugs** | [**Array<Drug>**](Drug.md) | Drugs found in query | [optional]
|
7
6
|
**meta** | [**Meta**](Meta.md) | Metadata for query | [optional]
|
7
|
+
**drugs** | [**Array<Drug>**](Drug.md) | Drugs found in query | [optional]
|
8
|
+
**drug_packages** | [**Array<DrugPackage>**](DrugPackage.md) | DrugPackages | [optional]
|
8
9
|
|
9
10
|
|
data/docs/DrugsApi.md
CHANGED
@@ -4,15 +4,18 @@ All URIs are relative to *https://api.vericred.com/*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**
|
7
|
+
[**get_drug_coverages**](DrugsApi.md#get_drug_coverages) | **GET** /drug_packages/{ndc_package_code}/coverages | Search for DrugCoverages
|
8
|
+
[**list_drugs**](DrugsApi.md#list_drugs) | **GET** /drugs | Drug Search
|
8
9
|
|
9
10
|
|
10
|
-
# **
|
11
|
-
> DrugCoverageResponse
|
11
|
+
# **get_drug_coverages**
|
12
|
+
> DrugCoverageResponse get_drug_coverages(ndc_package_code, audience, state_code, opts)
|
12
13
|
|
13
|
-
|
14
|
+
Search for DrugCoverages
|
14
15
|
|
15
|
-
Drug Coverages are the specific tier level, quantity limit, prior
|
16
|
+
Drug Coverages are the specific tier level, quantity limit, prior
|
17
|
+
authorization and step therapy for a given Drug/Plan combination. This endpoint
|
18
|
+
returns all DrugCoverages for a given Drug
|
16
19
|
|
17
20
|
### Example
|
18
21
|
```ruby
|
@@ -21,17 +24,22 @@ require 'vericred_client'
|
|
21
24
|
|
22
25
|
api_instance = VericredClient::DrugsApi.new
|
23
26
|
|
24
|
-
ndc_package_code = "
|
27
|
+
ndc_package_code = "12345-4321-11" # String | NDC package code
|
25
28
|
|
26
|
-
|
29
|
+
audience = "individual" # String | Two-character state code
|
27
30
|
|
31
|
+
state_code = "NY" # String | Two-character state code
|
32
|
+
|
33
|
+
opts = {
|
34
|
+
vericred_api_key: "api-doc-key" # String | API Key
|
35
|
+
}
|
28
36
|
|
29
37
|
begin
|
30
|
-
#
|
31
|
-
result = api_instance.
|
38
|
+
#Search for DrugCoverages
|
39
|
+
result = api_instance.get_drug_coverages(ndc_package_code, audience, state_code, opts)
|
32
40
|
p result
|
33
41
|
rescue VericredClient::ApiError => e
|
34
|
-
puts "Exception when calling DrugsApi->
|
42
|
+
puts "Exception when calling DrugsApi->get_drug_coverages: #{e}"
|
35
43
|
end
|
36
44
|
```
|
37
45
|
|
@@ -40,7 +48,9 @@ end
|
|
40
48
|
Name | Type | Description | Notes
|
41
49
|
------------- | ------------- | ------------- | -------------
|
42
50
|
**ndc_package_code** | **String**| NDC package code |
|
51
|
+
**audience** | **String**| Two-character state code |
|
43
52
|
**state_code** | **String**| Two-character state code |
|
53
|
+
**vericred_api_key** | **String**| API Key | [optional]
|
44
54
|
|
45
55
|
### Return type
|
46
56
|
|
@@ -57,3 +67,54 @@ No authorization required
|
|
57
67
|
|
58
68
|
|
59
69
|
|
70
|
+
# **list_drugs**
|
71
|
+
> DrugSearchResponse list_drugs(search_term, opts)
|
72
|
+
|
73
|
+
Drug Search
|
74
|
+
|
75
|
+
Search for drugs by proprietary name
|
76
|
+
|
77
|
+
### Example
|
78
|
+
```ruby
|
79
|
+
# load the gem
|
80
|
+
require 'vericred_client'
|
81
|
+
|
82
|
+
api_instance = VericredClient::DrugsApi.new
|
83
|
+
|
84
|
+
search_term = "Zyrtec" # String | Full or partial proprietary name of drug
|
85
|
+
|
86
|
+
opts = {
|
87
|
+
vericred_api_key: "api-doc-key" # String | API Key
|
88
|
+
}
|
89
|
+
|
90
|
+
begin
|
91
|
+
#Drug Search
|
92
|
+
result = api_instance.list_drugs(search_term, opts)
|
93
|
+
p result
|
94
|
+
rescue VericredClient::ApiError => e
|
95
|
+
puts "Exception when calling DrugsApi->list_drugs: #{e}"
|
96
|
+
end
|
97
|
+
```
|
98
|
+
|
99
|
+
### Parameters
|
100
|
+
|
101
|
+
Name | Type | Description | Notes
|
102
|
+
------------- | ------------- | ------------- | -------------
|
103
|
+
**search_term** | **String**| Full or partial proprietary name of drug |
|
104
|
+
**vericred_api_key** | **String**| API Key | [optional]
|
105
|
+
|
106
|
+
### Return type
|
107
|
+
|
108
|
+
[**DrugSearchResponse**](DrugSearchResponse.md)
|
109
|
+
|
110
|
+
### Authorization
|
111
|
+
|
112
|
+
No authorization required
|
113
|
+
|
114
|
+
### HTTP request headers
|
115
|
+
|
116
|
+
- **Content-Type**: application/json
|
117
|
+
- **Accept**: application/json
|
118
|
+
|
119
|
+
|
120
|
+
|
data/docs/Meta.md
CHANGED
data/docs/Network.md
ADDED
@@ -0,0 +1,9 @@
|
|
1
|
+
# VericredClient::NetworkSearchResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**meta** | [**Meta**](Meta.md) | Metadata for query | [optional]
|
7
|
+
**networks** | [**Array<Network>**](Network.md) | Networks that fit the requested criterion. | [optional]
|
8
|
+
|
9
|
+
|
data/docs/NetworksApi.md
ADDED
@@ -0,0 +1,58 @@
|
|
1
|
+
# VericredClient::NetworksApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.vericred.com/*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**list_networks**](NetworksApi.md#list_networks) | **GET** /networks | Networks
|
8
|
+
|
9
|
+
|
10
|
+
# **list_networks**
|
11
|
+
> NetworkSearchResponse list_networks(carrier_id)
|
12
|
+
|
13
|
+
Networks
|
14
|
+
|
15
|
+
A network is a list of the doctors, other health care providers,
|
16
|
+
and hospitals that a plan has contracted with to provide medical care to
|
17
|
+
its members.
|
18
|
+
|
19
|
+
### Example
|
20
|
+
```ruby
|
21
|
+
# load the gem
|
22
|
+
require 'vericred_client'
|
23
|
+
|
24
|
+
api_instance = VericredClient::NetworksApi.new
|
25
|
+
|
26
|
+
carrier_id = "33333" # String | Carrier HIOS Issuer ID
|
27
|
+
|
28
|
+
|
29
|
+
begin
|
30
|
+
#Networks
|
31
|
+
result = api_instance.list_networks(carrier_id)
|
32
|
+
p result
|
33
|
+
rescue VericredClient::ApiError => e
|
34
|
+
puts "Exception when calling NetworksApi->list_networks: #{e}"
|
35
|
+
end
|
36
|
+
```
|
37
|
+
|
38
|
+
### Parameters
|
39
|
+
|
40
|
+
Name | Type | Description | Notes
|
41
|
+
------------- | ------------- | ------------- | -------------
|
42
|
+
**carrier_id** | **String**| Carrier HIOS Issuer ID |
|
43
|
+
|
44
|
+
### Return type
|
45
|
+
|
46
|
+
[**NetworkSearchResponse**](NetworkSearchResponse.md)
|
47
|
+
|
48
|
+
### Authorization
|
49
|
+
|
50
|
+
No authorization required
|
51
|
+
|
52
|
+
### HTTP request headers
|
53
|
+
|
54
|
+
- **Content-Type**: application/json
|
55
|
+
- **Accept**: application/json
|
56
|
+
|
57
|
+
|
58
|
+
|
data/docs/Plan.md
CHANGED
@@ -3,21 +3,21 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**adult_dental** | **BOOLEAN** | Does the plan provide dental coverage for adults? | [optional]
|
6
|
+
**adult_dental** | **BOOLEAN** | Does the plan provide dental coverage for adults? | [optional]
|
7
7
|
**ambulance** | **String** | Benefits string for ambulance coverage | [optional]
|
8
8
|
**benefits_summary_url** | **String** | Link to the summary of benefits and coverage (SBC) document. | [optional]
|
9
9
|
**buy_link** | **String** | Link to a location to purchase the plan. | [optional]
|
10
10
|
**carrier_name** | **String** | Name of the insurance carrier | [optional]
|
11
|
-
**child_dental** | **BOOLEAN** | Does the plan provide dental coverage for children? | [optional]
|
12
|
-
**child_eye_exam** | **String** | Child eye exam benefits summary | [optional]
|
11
|
+
**child_dental** | **BOOLEAN** | Does the plan provide dental coverage for children? | [optional]
|
13
12
|
**child_eyewear** | **String** | Child eyewear benefits summary | [optional]
|
13
|
+
**child_eye_exam** | **String** | Child eye exam benefits summary | [optional]
|
14
14
|
**customer_service_phone_number** | **String** | Phone number to contact the insurance carrier | [optional]
|
15
|
+
**durable_medical_equipment** | **String** | Benefits summary for durable medical equipment | [optional]
|
15
16
|
**diagnostic_test** | **String** | Diagnostic tests benefit summary | [optional]
|
16
17
|
**drug_formulary_url** | **String** | Link to the summary of drug benefits for the plan | [optional]
|
17
|
-
**durable_medical_equipment** | **String** | Benefits summary for durable medical equipment | [optional]
|
18
18
|
**effective_date** | **String** | Effective date of coverage. | [optional]
|
19
|
-
**emergency_room** | **String** | Description of costs when visiting the ER | [optional]
|
20
19
|
**expiration_date** | **String** | Expiration date of coverage. | [optional]
|
20
|
+
**emergency_room** | **String** | Description of costs when visiting the ER | [optional]
|
21
21
|
**family_drug_deductible** | **String** | Deductible for drugs when a family is on the plan. | [optional]
|
22
22
|
**family_drug_moop** | **String** | Maximum out-of-pocket for drugs when a family is on the plan | [optional]
|
23
23
|
**family_medical_deductible** | **String** | Deductible when a family is on the plan | [optional]
|
@@ -44,9 +44,9 @@ Name | Type | Description | Notes
|
|
44
44
|
**name** | **String** | Marketing name of the plan | [optional]
|
45
45
|
**network_size** | **Integer** | Total number of Providers in network | [optional]
|
46
46
|
**non_preferred_brand_drugs** | **String** | Cost under the plan for non-preferred brand drugs | [optional]
|
47
|
-
**
|
48
|
-
**
|
49
|
-
**out_of_network_coverage** | **BOOLEAN** | Does this plan provide any out of network coverage? | [optional]
|
47
|
+
**on_market** | **BOOLEAN** | Is the plan on-market? | [optional]
|
48
|
+
**off_market** | **BOOLEAN** | Is the plan off-market? | [optional]
|
49
|
+
**out_of_network_coverage** | **BOOLEAN** | Does this plan provide any out of network coverage? | [optional]
|
50
50
|
**out_of_network_ids** | **Array<Integer>** | List of NPI numbers for Providers passed in who do not accept this Plan | [optional]
|
51
51
|
**outpatient_facility** | **String** | Benefits summary for outpatient facility coverage | [optional]
|
52
52
|
**outpatient_mental_health** | **String** | Benefits summary for outpatient mental health coverage | [optional]
|
@@ -55,10 +55,10 @@ Name | Type | Description | Notes
|
|
55
55
|
**plan_market** | **String** | Market in which the plan is offered (on_marketplace, shop, etc) | [optional]
|
56
56
|
**plan_type** | **String** | Category of the plan (e.g. EPO, HMO, PPO, POS, Indemnity) | [optional]
|
57
57
|
**preferred_brand_drugs** | **String** | Cost under the plan for perferred brand drugs | [optional]
|
58
|
-
**premium** | **Float** | Cumulative premium amount | [optional]
|
59
|
-
**premium_subsidized** | **Float** | Cumulative premium amount after subsidy | [optional]
|
60
58
|
**prenatal_postnatal_care** | **String** | Inpatient substance abuse benefits summary | [optional]
|
61
59
|
**preventative_care** | **String** | Benefits summary for preventative care | [optional]
|
60
|
+
**premium_subsidized** | **Float** | Cumulative premium amount after subsidy | [optional]
|
61
|
+
**premium** | **Float** | Cumulative premium amount | [optional]
|
62
62
|
**primary_care_physician** | **String** | Cost under the plan to visit a Primary Care Physician | [optional]
|
63
63
|
**rehabilitation_services** | **String** | Benefits summary for rehabilitation services | [optional]
|
64
64
|
**skilled_nursing** | **String** | Benefits summary for skilled nursing services | [optional]
|
data/docs/PlanCounty.md
CHANGED
@@ -3,8 +3,8 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**county_id** | **Integer** | Foreign key to county | [optional]
|
7
6
|
**id** | **Integer** | Primary key | [optional]
|
8
7
|
**plan_id** | **Integer** | Foreign key to plan | [optional]
|
8
|
+
**county_id** | **Integer** | Foreign key to county | [optional]
|
9
9
|
|
10
10
|
|
data/docs/PlanCountyBulk.md
CHANGED
@@ -3,8 +3,8 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**county_id** | **Integer** | Foreign key to county | [optional]
|
7
6
|
**id** | **Integer** | Primary key | [optional]
|
8
7
|
**plan_id** | **Integer** | Foreign key to plan | [optional]
|
8
|
+
**county_id** | **Integer** | Foreign key to county | [optional]
|
9
9
|
|
10
10
|
|
@@ -1,9 +1,10 @@
|
|
1
|
-
# VericredClient::
|
1
|
+
# VericredClient::PlanSearchResponse
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**meta** | [**Meta**](Meta.md) | Metadata for query | [optional]
|
7
7
|
**plans** | [**Array<Plan>**](Plan.md) | Plan search results | [optional]
|
8
|
+
**coverages** | [**Array<Drug>**](Drug.md) | null | [optional]
|
8
9
|
|
9
10
|
|
data/docs/PlanSearchResult.md
CHANGED
@@ -3,23 +3,21 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**adult_dental** | **BOOLEAN** | Does the plan provide dental coverage for adults? | [optional]
|
6
|
+
**adult_dental** | **BOOLEAN** | Does the plan provide dental coverage for adults? | [optional]
|
7
7
|
**ambulance** | **String** | Benefits string for ambulance coverage | [optional]
|
8
8
|
**benefits_summary_url** | **String** | Link to the summary of benefits and coverage (SBC) document. | [optional]
|
9
9
|
**buy_link** | **String** | Link to a location to purchase the plan. | [optional]
|
10
10
|
**carrier_name** | **String** | Name of the insurance carrier | [optional]
|
11
|
-
**child_dental** | **BOOLEAN** | Does the plan provide dental coverage for children? | [optional]
|
12
|
-
**child_eye_exam** | **String** | Child eye exam benefits summary | [optional]
|
11
|
+
**child_dental** | **BOOLEAN** | Does the plan provide dental coverage for children? | [optional]
|
13
12
|
**child_eyewear** | **String** | Child eyewear benefits summary | [optional]
|
13
|
+
**child_eye_exam** | **String** | Child eye exam benefits summary | [optional]
|
14
14
|
**customer_service_phone_number** | **String** | Phone number to contact the insurance carrier | [optional]
|
15
|
-
**
|
15
|
+
**durable_medical_equipment** | **String** | Benefits summary for durable medical equipment | [optional]
|
16
16
|
**diagnostic_test** | **String** | Diagnostic tests benefit summary | [optional]
|
17
17
|
**drug_formulary_url** | **String** | Link to the summary of drug benefits for the plan | [optional]
|
18
|
-
**durable_medical_equipment** | **String** | Benefits summary for durable medical equipment | [optional]
|
19
18
|
**effective_date** | **String** | Effective date of coverage. | [optional]
|
20
|
-
**emergency_room** | **String** | Description of costs when visiting the ER | [optional]
|
21
|
-
**employee_premium** | **Float** | Cumulative premium amount for employees | [optional]
|
22
19
|
**expiration_date** | **String** | Expiration date of coverage. | [optional]
|
20
|
+
**emergency_room** | **String** | Description of costs when visiting the ER | [optional]
|
23
21
|
**family_drug_deductible** | **String** | Deductible for drugs when a family is on the plan. | [optional]
|
24
22
|
**family_drug_moop** | **String** | Maximum out-of-pocket for drugs when a family is on the plan | [optional]
|
25
23
|
**family_medical_deductible** | **String** | Deductible when a family is on the plan | [optional]
|
@@ -43,30 +41,32 @@ Name | Type | Description | Notes
|
|
43
41
|
**inpatient_substance** | **String** | Inpatient substance abuse benefits summary | [optional]
|
44
42
|
**level** | **String** | Plan metal grouping (e.g. platinum, gold, silver, etc) | [optional]
|
45
43
|
**logo_url** | **String** | Link to a copy of the insurance carrier's logo | [optional]
|
46
|
-
**match_percentage** | **Integer** | Percentage of doctors who matched this Plan | [optional]
|
47
44
|
**name** | **String** | Marketing name of the plan | [optional]
|
48
45
|
**non_preferred_brand_drugs** | **String** | Cost under the plan for non-preferred brand drugs | [optional]
|
49
|
-
**
|
50
|
-
**
|
51
|
-
**out_of_network_coverage** | **BOOLEAN** | Does this plan provide any out of network coverage? | [optional]
|
46
|
+
**on_market** | **BOOLEAN** | Is the plan on-market? | [optional]
|
47
|
+
**off_market** | **BOOLEAN** | Is the plan off-market? | [optional]
|
48
|
+
**out_of_network_coverage** | **BOOLEAN** | Does this plan provide any out of network coverage? | [optional]
|
52
49
|
**out_of_network_ids** | **Array<Integer>** | List of NPI numbers for Providers passed in who do not accept this Plan | [optional]
|
53
50
|
**outpatient_facility** | **String** | Benefits summary for outpatient facility coverage | [optional]
|
54
51
|
**outpatient_mental_health** | **String** | Benefits summary for outpatient mental health coverage | [optional]
|
55
52
|
**outpatient_physician** | **String** | Benefits summary for outpatient physician coverage | [optional]
|
56
53
|
**outpatient_substance** | **String** | Outpatient substance abuse benefits summary | [optional]
|
57
|
-
**perfect_match_percentage** | **Integer** | Percentage of employees with 100% match | [optional]
|
58
54
|
**plan_market** | **String** | Market in which the plan is offered (on_marketplace, shop, etc) | [optional]
|
59
55
|
**plan_type** | **String** | Category of the plan (e.g. EPO, HMO, PPO, POS, Indemnity) | [optional]
|
60
56
|
**preferred_brand_drugs** | **String** | Cost under the plan for perferred brand drugs | [optional]
|
61
|
-
**premium** | **Float** | Cumulative premium amount | [optional]
|
62
|
-
**premium_subsidized** | **Float** | Cumulative premium amount after subsidy | [optional]
|
63
57
|
**prenatal_postnatal_care** | **String** | Inpatient substance abuse benefits summary | [optional]
|
64
58
|
**preventative_care** | **String** | Benefits summary for preventative care | [optional]
|
59
|
+
**premium_subsidized** | **Float** | Cumulative premium amount after subsidy | [optional]
|
60
|
+
**premium** | **Float** | Cumulative premium amount | [optional]
|
65
61
|
**primary_care_physician** | **String** | Cost under the plan to visit a Primary Care Physician | [optional]
|
66
62
|
**rehabilitation_services** | **String** | Benefits summary for rehabilitation services | [optional]
|
67
63
|
**skilled_nursing** | **String** | Benefits summary for skilled nursing services | [optional]
|
68
64
|
**specialist** | **String** | Cost under the plan to visit a specialist | [optional]
|
69
65
|
**specialty_drugs** | **String** | Cost under the plan for specialty drugs | [optional]
|
70
66
|
**urgent_care** | **String** | Benefits summary for urgent care | [optional]
|
67
|
+
**match_percentage** | **Integer** | Percentage of doctors who matched this Plan | [optional]
|
68
|
+
**perfect_match_percentage** | **Integer** | Percentage of employees with 100% match | [optional]
|
69
|
+
**employee_premium** | **Float** | Cumulative premium amount for employees | [optional]
|
70
|
+
**dependent_premium** | **Float** | Cumulative premium amount for dependents | [optional]
|
71
71
|
|
72
72
|
|